Download as pdf or txt
Download as pdf or txt
You are on page 1of 914

APTRAAdvanceNDC

ReferenceManual

B0066180N000
Issue1
July2011

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

TheproductdescribedinthisbookisalicensedproductofNCRCorporation.
NCR,APTRAandSelfServaretrademarksofNCRCorporation.
Microsoft,Windows,WindowsXP,andActiveXareregisteredtrademarksofMicrosoftCorporationintheUnitedStates
and/orothercountries.
AdobeandReaderareeitherregisteredtrademarksortrademarksofAdobeSystemsIncorporatedintheUnitedStates
and/orothercountries.
Allotherbrandorproductnamesaretrademarksorregisteredtrademarksoftheirrespectivecompaniesororganisations.
ItisthepolicyofNCRCorporation(NCR)toimproveproductsasnewtechnology,components,software,andfirmware
becomeavailable.NCR,therefore,reservestherighttochangespecificationswithoutpriornotice.
Allfeatures,functions,andoperationsdescribedhereinmaynotbemarketedbyNCRinallpartsoftheworld.Insome
instances,photographsareofequipmentprototypes.Therefore,beforeusingthisdocument,consultwithyourNCR
representativeorNCRofficeforinformationthatisapplicableandcurrent.
Tomaintainthequalityofourpublications,weneedyourcommentsontheaccuracy,clarity,organization,andvalue
ofthisbook.
Addresscorrespondenceto:
NCRFinancialSolutionsGroupLtd
InformationSolutionsFeedback
DiscoveryCentre
3FultonRoad
Dundee,Scotland
DD24SW

20002011
ByNCRCorporation
Duluth,GeorgiaU.S.A.
AllRightsReserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Federal Communications Commission (FCC) Radio Frequency Interference Statement

FederalCommunications
Commission(FCC)RadioFrequency
InterferenceStatement
Note:Thisequipmenthasbeentestedandfoundtocomplywith
thelimitsforaClassAdigitaldevice,pursuanttoPart15ofthe
FCCRules.Theselimitsaredesignedtoprovidereasonable
protectionagainstharmfulinterferencewhentheequipmentis
operatedinacommercialenvironment.Thisequipment
generates,uses,andcanradiateradiofrequencyenergyand,ifnot
installedandusedinaccordancewiththeinstructionmanual,
maycauseharmfulinterferencetoradiocommunications.
Operationofthisequipmentinaresidentialareaislikelytocause
harmfulinterferenceinwhichcasetheuserwillberequiredto
correcttheinterferenceathisownexpense.

CanadianClassADevice
Declaration

ThisdigitalapparatusdoesnotexceedtheClassAlimitsforradio
noiseemissionsfromdigitalapparatussetoutintheRadio
InterferenceRegulationsoftheCanadianDepartmentof
Communications.
Leprsentappareilnumriquenmetpasdebruits
radiolectriquesdpassantleslimitesapplicablesauxappareils
numriquesdelaclasseAprescritesdansleRglementsurle
brouillageradiolectriquedictparleministredes
CommunicationsduCanada.
Thisequipmentmustbeinstalledandusedinstrictaccordancewith
themanufacturersinstructions.However,thereisnoguarantee
thatinterferencetoradiocommunicationswillnotoccurina
particularcommercialinstallation.Ifthisequipmentdoescause
interference,whichcanbedeterminedbyturningtheequipmentoff
andon,theuserisencouragedtoconsultanNCRservice
representativeimmediately.

InformationtoUser

Caution

NCRCorporationisnotresponsibleforanyradioortelevision
interferencecausedbyunauthorisedmodificationsofthis
equipmentorthesubstitutionorattachmentofconnectingcables
andequipmentotherthanthosespecifiedbyNCR.Such
unauthorizedmodifications,substitutions,orattachmentsmayvoid
theusersauthoritytooperatetheequipment.Thecorrectionof
interferencecausedbysuchunauthorizedmodifications,
substitutions,orattachmentswillbetheresponsibilityoftheuser.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

iii

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

iv

APTRA Advance NDC, Reference Manual

Revision Record

RevisionRecord

Date

Page

Jul2011

Description of Change

NewrevisionforAdvanceNDC4.01
242

AddedinformationaboutscreenU0088forcheque
ejectfailure

243

UpdatedtheClosestatefordirectdeposits

295,297, UpdatedtheCashAcceptstatefordirectdeposits
299,2101,
2102
295

Removedunsupportedstatementasselectionof
theAddMoreNotesFDKisnowjournaled

2101

ClarifiedtheCounterfeitNotesRetainedScreen
tableentryintheCashAcceptstate

2103

Updatedtheinformationabouttheconfirmation
screenintheCashAcceptstate

2117

Updatedfield7oftablez001BunchCheque
AcceptState

2148

UpdatedtheTimeOutstate

311

AddedreferencetoXFSonlinedocumentfor
controlsequencesforUSBprinters

713

Addedthatmorethan90notesmustbeacceptedif
theSSTisconfiguredfordirectdepositmode

717

ClarifiedthedescriptionofEnhanced
ConfigurationParameteroption76

720

ClarifiedOptionCode001and002ofOption83
ChequeProcessor

725

Updatedthedescriptionofthedefaultvalueof
timer63

726

Timer78updatedasitnowappliesonany
hardware

94

AddedtablenotecrossreferenceforFSpreceding
fieldsoandqinTransactionRequestMessage
Formattable

99

Updatedtheca3fieldoftheTransactionRequest
messagefordirectdeposits

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

931

BNAandCPM,addedcrossreferencestotable
noteexplainingwhentheirdetailsarereturnedin
configurationinformation

933

AddedproductclassesforSelfServ16,SelfServ42,
SelfServ4andSelfServ8

935

tablenoteaddedfordoublelengthrestrictedentry
mode

938

Addedsinglenoteacceptorvarianttothe
hardwareconfigurationsubfield

977

Amendeddetailsofthefieldsforinformation
identifierEinsolicitedEncryptorInitialisation
Datamessages

983

Addedfielde6inUnsolicitedStatus:Status
InformationFieldtable

9101

UpdatedinformationforSupervisormodeentry
andexitstatusmessages(P20andP21)

9109

UpdatedtheBunchNoteAcceptorstatusmessage
forECB6support

9112

Addedthatdepositednotesarereportedasescrow
countsregardlessoftheirphysicalposition.

1037

Addedthatthehostmustensurethatanyrequired
ExtendedEncryptionKeyChangemessagesare
sent

1059

Addedthatsmartcarddataotherthan
EMV/CAM2specificdatamaybereturnedinfield
at2

1072,1073 Updatedthecashacceptorterminalfunctionsfor
directdeposits
1080

Updatedfieldj1andaddedfieldj2intable
InteractiveTransactionResponse

1129

Addeddetailsoferrorifanattemptismadeto
importakeythatisalreadyloaded

A7,A8, UpdatedscreenstouseFOURTHinsteadofBOTTOM
A30,A46, incassettedescriptions
A50
A25

RemoveddetailsofscreenM03asithasbeen
replacedbyscreenm03.

A45

Addedscreenp64forSupervisormodechange
message

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

vi

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

A49,A54, Addedscreenss40,t09andt91for5thcassette
A58
handlingforTI
A55

Updatedthescreenjournaledwhentheescrow
becomesfull

A55

Updatedthescreenusedtorecordanerrorduring
acashintransaction

A55

Updatedthescreenusedtorecordthefailureofthe
notetypeconfiguration

A61

AddedscreenU0088forchequeejectfailure

A61

RemovedscreensU0104andU0105astheyareno
longerused

A62

Addedandupdatedthescreensusedtojournal
failedsignaturesundertheECB6regulations

A62

Updatedthescreensusedwhenreadingserial
numbersfromnotes

A64

Addedscreensusedtojournalpointsinacash
deposittransaction

A63

Addedscreenusedtojournaltheselectionofthe
AddMoreNotesFDK

A63

Addedscreenusedtojournalnotesdetectedinthe
cashacceptorduringtheClosestate

A63

Addedscreenusedtojournalthatnotesare
detectedattheexitduringAERoncashacceptors

A64

Addedscreenusedtojournalsuspendcondition
handlingforcashacceptors
Addedscreenstojournalnotesidentifiedas
counterfeitorsuspectundertheECB6regulations

A64

Addedscreensforjournalingtheinsertionand
removalofBNAcassettes

A64

Addedscreensusedincashinextendedjournaling

A70

Addedscreensi39andi41forconfigurationof
SSLoptionalparameters

A87

Updatedscreeni92

A95

Addedscreensforjournalingretractnotesin
recyclingmode

C1

SuppliedgraphicshavePNGformat.

D19

Updatedfieldat2tobemoregeneric

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

vii

Date

Page

Description of Change

E9

Addeddevicevariantforasinglenoteacceptor

Glossary3 Addeddirectdeposittotheglossary
Glossary4 Addedescrowdeposittotheglossary
Oct2010

NewrevisionforAdvanceNDC4.00
All

Replacedallreferencestodeviceidentification
graphicwithdeviceidentifiergraphicasthe
fullformofDIGandalignedusageofthetermand
acronym

Chapter 1 Restructuredfollowingtheremovalofconceptual
information,includingtherelocationof
informationonclearingpersistentmemoryand
SNMPtrapstotheDevelopersGuide
Chapter 2 StandardizedreferencestoEMVandEMV/CAM2
23

RemovedUfromthelistofreservedstatesasitis
nowusedfortheDeviceFitnessFlowControlState

25

AddedinformationontheuseofExtensionStates

27

Addedinformationabouterrorhandingwhena
cardjamoccurs

211

RemovedthenoteabouttouchFDKsclearingthe
PINbufferasitdoesnotapply

214

AddedthatAdvanceNDCdoesnotattemptto
dispenseenvelopesunlessenvelopesarepresentin
theenvelopedispenser

229

Addedexplanationofwhathappenswhengeneral
purposebufferBdataexceedsthelimitduringthe
InformationEntrystate

236

UpdateddescriptionofEMV/CAM2processing
flaganditsvalues

241

Addedautomaticerrorrecoveryinformationfor
cashacceptorrecovery

243

Addedthatacardholdercancellationoratimeout
duringatransactioninvolvingmorethanacash
depositisjournaledduringtheClosestate

266

AddeddetailsoftheDeviceFitnessFlowControl
State

296

AddedthatreservedscreenU0128isjournaled
whenAddMoreisselectedduringcashacceptance
(unsupportedinAdvanceNDC4.00)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

viii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

2100

RemovednotefromtheDeviceErrorNextState
tableentry,asallrelevantinformationisincluded
inthetable
AddednoteonfunctionalityifCancelisselected
afterAddMoreNotes

2103

Updatedthedescriptionofthebasicconfirmation
screensasreservedscreensarenolongerused

2117

UpdatedtheCancelNextStateNumberand
TimeoutNextStateNumberfieldsfortheBunch
ChequeState

2136

Addeddetailsofz008InsertCardState

2140

Addeddetailsofz009BufferValidationstate

311

NotedthatchangestothedefaultvalueofSetFirst
LinePositionmustbeamultipleof18

341,343

Addeddetailsofcontrolsfordynamicbuttonsand
dynamictextdefinition

344

Updateddetailsofsupportformultimediafile
formats

349

Updateddetailsofsupportforimagefiles

43

Addedthatabeepcanbeconfiguredforemulated
FDKs

45to47

UpdatedTable42toclarifythephysicallayout
andCENXFSliteralkeys.UpdatedTable43to
clarifyitisthekeycodewhichisaltered.Added
clarificationthatifakeyboarddoesnotenablethe
requirednumberofkeysthedefaultkeyboardis
used.CompletelyupdatedtheKeyboardMapping
examplestoshowthemessagecontentsandFDK
keysreassignments

414

Addeddetailsontheremappingofkeyboard
layoutsforsecurekeyentry

54,55

Amendeddetailsofdateformat

533

RemovedreferencetoTableNote17fromSetFirst
LinePositionControlCodeasthisinformationwas
incorrect

533

AddedthattheCHEQUEregistryentryisthesame
regardlessofprintertype

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

ix

Date

Page

Description of Change

79

Removedmentionofremotestatusindicatorand
remoterelaycontrolfromECPoption23asitonly
controlsthesendingofenvelopedispenser
messages

79

Updatedinformationforvalue002intable
Enhanced/TISensorStatusUnsolicitedMessage
Values

716

StandardisedreferencestoEMV/CAM2and
removeddetailsofenhancedconfigurationload
parameteroption70asitisnotsupportedin
AdvanceNDC

718

Clarifieduseofoption77

719

Addedthatforoption80,theEnhanced
ConfigurationLoadParametersmessageshouldbe
sentbeforetheStateTablesLoadmessage

723

Amendedusageoftimer05

724

Addedfurtherinformationabouttheuseoftimer
07

94

Addedcrossreferenceinfieldrandupdateddata
detailsforLastTransactionStatusData

911

Updatedfieldcg2andaddedatablenote
crossreference

913

Addedatablenotecrossreferenceforfieldso
andpandtheprecedingfieldseparator

913

Clarifieduseofthefieldseparator

915

Addeddetailstotablenoteofmessagefieldsent
whenallchequesaretobereturnedtothe
cardholder

917

Addednoteexplainingwhathappenswhen
generalpurposebufferBdataexceedsthelimit
duringaninteractivetransactionresponse

929

Amendedtablenoteonmessagemodeoptions

929

Addedthatthedeviceandmodulefitnessdata
returnedinsubfieldg3providesanoverallview
ofthestateoftheSST

931

Addedthatthejournalprinterwillbereportedas
fatalifitrunsoutofpaper,evenindualmode

935

AddedinformationonthereportingofRestricted
Mode

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

938,E9

AddednewvariantsfortheBNAandcheque
processorDIG

950

AddedasectionfortheEnhancedConfiguration
Datasolicitedmessagetoclarifythecontentwhen
commandcode7issentwithacommandmodifier
of6

971

Amendedthedescriptionofthestatusdataina
soliciteddevicefaultmessagereturnedforanEPP

974

UpdateddescriptionsforfieldsC,DandE.

976

AddedinformationonEPPVariableLengthSerial
NumberCapabilityandInformationIdentifierE.

990

Addedthatallcassettessupplystatusesare
reportedfollowingaretractoperation

992

Updatedfieldse3ande5oftableReceiptPrinter
Status

997

ClarifiedthatanH0messageissentwhenthe
journalprinterpaperrunsout

9102and Addedbyte19forUnsolicitedSensorsmessage
9102
andupdatedstatementaboutExtendedTamper
Indicationdata
984to
9122

Clarifiedwhensolicitedandunsolicitedmessages
aresenttoreportdevicestatus

Chapter 10 StandardisedreferencestoEMVandEMV/CAM2.
RemovedsectiononhosttoExitmessages
109and
1020

AddedadditionalTableNotestoexplainthe
relationshipbetweenStateTablesLoadand
EnhancedConfigurationParametersLoad
messages

1011

Removedrestrictiononkeyboarddefinition
numbersinfieldj1asAdvanceNDConly
recognisesFDKmappings

1040

AddedinformationonmodifierU.

1042

AddeddescriptionintablenoteformodifierS,
T,UandV.

1053to
1056and
1062

UpdatedTransactionReplydescriptionfieldsm,
qandrforvoicedatadescriptionandaddeda
tablenotereference.

1068

Updatednotefortimer05functionality

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xi

Date

Page

Description of Change

1070

Updatednumberoflinesforacompletepagein
tableCardBeforeParallelDispenseandPrint.

1083

Updatedfielddasitisnow
mandatory;updateddetailsofresendingthelastEJ
datablock.

1096

Removedrowintable1040forBNARetrieveNote
Definitionscommandasthisisprocessedasa
ConfigurationInformationRequestcommand

113

UpdatedEPPinformation.Addedcrossreferences
totheAPTRAAdvanceNDC,MultiVendorSupport
ReferenceforothervendorsEPPinformation

1110

AmendedtheMACverificationformat,whichis
alwaysASCII

1118

ClarifiedthatRSAinitialkeyloadingissupported
onallSSTsthatcanrunAdvanceNDC

124

StandardisedreferencestoEMVandEMV/CAM2

A13

AmendedmessageE1902fromUNKNOWN
ERRORtoPOSSIBLEJAM

A18

UpdatedscreenI06forEJlevel

A25

RemovedscreensM10,M11,M13andM14asthe
cashincomponentisnolongerusingthemasbasic
confirmationscreens

A28,A34 Updatedreservedscreensm02andm38
A34,A36 Addedreservedscreensm36,m37andm45
A43

AddedreservedscreenP97

A48

AddedreservedscreenS29

A47

AddedreservedscreenS29

A55

Updatedscreenst15fromresrvd.def

A58

Addedreservedscreent90

A60

UpdatedscreensU0057,U0058,andU0059from
resrvd.def

A62A64, UpdatedscreensusedbytheCashIncomponent
A96
A96

Addedreservedscreensj0020andj4032

A95

Addedreservedscreenj0021

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

B8

AmendedthepathfortheUniversalCharSets.txt
mappingfile

D6

Updateddescriptionoffieldcg2

D14

UpdateddescriptionsofmodifiersKandN,and
QtoV.

E3,E7

RemovedreferencestoBNAfromcashhandler
sectionoftable

E5

AddedBITs470(reservedalwayszero)

E6,E13, AddeddetailsofDIGXforthepassbookprinter
E21,E26
E19

UpdatedtableDeviceFitnessData;added
informationaboutDIGsandtheirfitnessdata.

E23

Updatedthemethodsusedtocalculatetheoverall
fitnessforacashacceptor

E27

Addedatablenoteonvalues010to020.

F2

Added25htothecodeconversiontable

Jun09

NewrevisionforAdvanceNDC3.04
All

ReplacedCPMwithchequeprocessorwhen
theinformationappliestoboththeCPMand
bunchchequeacceptordevices

lxxv,
Definedchequeprocessorasthecombinedname
Glossary2 forCPMandbunchchequedevices
222
256
276

AmountEntry,EnhancedAmountEntryandFDK
InformationEntrystates:addedtablenoteabout
wholeamountentrytotableentry9

232

RemovedalltablenotereferencestoNoPINmode
asitisnotsupportedinAdvanceNDC

235

UpdatedtheTransactionRequeststatetoallow
inclusionofBunchChequeDepositdata

234

Updatedtableentries5,6,8and9forcheque
processingandEMVprocessingofdynamic
currencyconversiontransactions

237

AddedsecondextensiontableforEMVprocessing

241

UpdatedtheCloseStatedetailsforbunchcheque
devices

294

UpdateddetailsofstatenumbersforBNA
extensionstates

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xiii

Date

Page

Description of Change

2101

Addednewtableentryforthecounterfeitnotes
screenintheCashAcceptstate
Updatedtableentry8ofthethirdextensiontothe
CashAcceptstate

2104

Addedtheenumeratedvaluesfordynamictext
definingwhynoteshavebeenrejected

2112

AddedzMasterExpansionstatedetails

2113

Addedz001BunchChequeAcceptstatedetails

2120

Addedz002BunchChequeHandingstatedetails

2124

Addedz003ChequeDetailDisplaystatedetails

2130

Addedz004ChequeSummaryDisplaystate
details

38

Removedinformationaboutconfiguringlinefeed
forforUSBPrintersasthisisnolongerrequired.

321

Addedcontrolsequencesforbunchcheque
devices,andincludingdynamictextanddatain
screenstoDisplaySpecialFeaturestable

327

Addedthatblinkingtextonatransparent
backgroundisnotsupportedinANDC

333to334 Updatedlocationofpicturefilesanddisplayimage
controlfilesasAdvanceNDCinstallationdoesnot
installfilestoc:\ssdsonSSTs
335

Addedthatthecodelineismaskedwithahalfinch
blacklinewhenachequeimageislifted

335to338 Addeddetailsofcontrolsequencesfordisplayof
bunchchequeimage.codeline,amount,andvalue
339

Addeddetailsofthedisplaydynamictext
dictionarycontrolsequence

511to514 Updatedlocationofgraphicsprintfilesasc:\ssdsis
nolongerusedfortheSSTruntime.
514

Updatedtheprintchequeinformationfor
formsbasedprintingofacardholderreceipt;
addedthatcodelinecontrolmustbesetto2for
PADSScompliance

525to527 Clarifiedprintdatainformationtohighlightsent
datafromcentral.Removedunnecessaryquote
marksfromexamples.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xiv

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

534

AddednotetoPrintChequeImageVariableData
tablethatcodeline controlmustbesetto2for
PADSScompliance

713

AddedthatOption44mustbesettojournalECB6
transactioncounts

717

Addednotetoexplainthatthehostapplication
cannotselectwhichdispensertouseforcash
dispensing

719

UpdatedOption83forbunchchequedevicesand
toallowthescanningofachequeafter
endorsement

726

Updatedtimer78forwhenretractenabled

911

UpdatedtheTransactionRequestmessageto
includebunchchequedepositinformation

924

Addedmissingspecificcommandrejectstatus
codestotable.

928

Addednotethatthebytesizelimitationforfieldg4
meanstheconfigurationforsomenewdevices
cannotbesent.

936

ClarifiedthattheTIBinsvalueisalwayssetto01
asANDCcannotdetermineifTIexists

984

AddedthatSSTcanbeconfiguredtoalwayssenda
messageaftercommsconnectionrestored.

995

Addednotetoindicateunsolicitedcodeis
suppressed.

997

Updatedunsolicitedmessagesequencesforoption
35(EJdualmode)tosaythatH0issentwhen
paperislowandH1sentwhentheprintis
unsuccessful

9100

IntableSensorsStatus,byte19isnowmarkedas
reserved.

9109

AddedthatBNAdevicesthathaveretract
capabilitiesreportsuspectandcounterfeitnotesas
goodnotesifinvalidnotesareinserted

9110

Addedstatuscodesidentifyingthedetectionof
counterfeitorsuspectnotesinaBNAstatus
message

9114

NotedthereportingofaGBNAthatalreadyhasa
statusoffatalfromaprevioustransactionanda
GBXXorBNAwithnotesdetectedatpowerup

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xv

Date

Page

Description of Change

9115

UpdatedtheCPMStatusmessageforbunch
chequeacceptors

1020

Addedtablenotetoclarifythefieldsthatcanbe
repeatedinEnhancedConfigurationParameters
Loadmessages.

1052

AddedFunctionIDcprocessmultiplechequesto
theTransactionReply

1059

UpdatedProcessMultipleChequesbufferbinthe
TransactionReply

1060

AddedTransactionreplyfieldbcforEMV
dynamiccurrencyconversion

1063

AddedProcessMultipleChequestotheTerminal
FunctionsforTransactionCompletionlist

1070

ClarifiedsequenceofoperationsforPlease wait
for cash and receiptscreeninCardBefore
ParallelDispenseandPrinttable.

1075

AddeddetailsoftheProcessMultipleCheques
terminalfunction

1087

Updatedspecificcommandrejectstatuscodes
table.

1092

AddedspecificcommandrejectforamissingDLL

123

AddedthatprocessingofaDASHcardreadercan
reverttomagneticstripeprocessingifachiperror
occurs.

A14to
A14

ErrormessagesE2100E2116addedforuser
accountsetup

A26

AddedscreensM60andM61forSMSstyledata
entryinSupervisor

A57

AddedSupervisorscreendefinitiont73for
consumerresourcerelinquished.

A96

AddedSupervisorscreendefinitionsj4000j4010
forprintheader

C2

Updatedlocationofcardholdergraphicsfilesas
AdvanceNDCinstallationdoesnotinstallfilesto
c:\ssdsonruntimeSSTs

D6

AddedthecgxfieldstotheTransactionRequest
message

E9

Updatedchequeprocessorhardwareconfiguration
data

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xvi

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

E8

Updatedchequeprocessorsuppliesdata

E8

Updatedchequeprocessorfitnessdata

E23

UpdatedBNAfitnessdataforintelligentcassettes

E27

Addedcashacceptortamperdata

Glossary3 AddedentryforDCC
Glossary3 Addeddefinitionfordynamiccondition
Glossary5 AddedentryforIQA
Glossary5 AddedentryforMICR
Oct08

NewrevisionforAdvanceNDC3.03
lxxii

Updatedchapter3descriptionforscreensC10C19

lxxv

ExplainedthatreferencestoUSBprintersreferto
devicesontheSelfServrangeofSSTsfromNCR.

12

Addedbriefdescriptionofoptionsforsending
SNMPtraps

22

Addedassociatedkeyboardsreferencetodetailsin
Chapter4

22,23

MovedNCameraControlStatetothetableof
supportedStandardStateTypes

28

Expandedthe28,tableandaddedaRead
ConditionFlowdiagramtoclarifytheread
conditions.

218,274
277

AddednoteaboutmappingFDKstonumerickeys
inavoiceguidedsession

220

Addednoteexplainingthatwhenmaximum
numberofFDKpressesentered,thenextFDK
pressclearsthebuffertorestartentry

224

GAmountCheckState:updatedtableentries6
and8asthenumberofdecimalplacesintable
entry6ischeckedwhentableentry8evaluatesto
000

228

Addedthatduringavoiceguidedsession,theSST
beepstoechokeyselectionwhenthedataisnot
displayedonscreen;andwhenFDKsandnumeric
keysarerequired,theFDKscannotbemappedto
thenumerickeys

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xvii

Date

Page

Description of Change

229to231 AddedexplanationofhowHInformationEntry
StatecansupportSMSstyleandPCkeyboardfor
alphanumericdataentry
239

Addedinformationonprocessingforcardless
transactions

241

UpdatedtheCPMReturn/Retaintableentryinthe
CloseStatetoincludeLeave
AddeddetailsofthesettingsfortheBNA
Return/Retain/LeavetableentryintheCloseState

243

AddednoteonthefailureoftheTransaction
Requestwhennotesaretoberetained

253to254 AddedNCameraControlState
255

Addednoteexplainingthatwhenmaximum
numberofFDKpressesentered,thenextFDK
pressclearsthebuffertorestartentry

287to288 Addedconsiderationsforavoiceguidedsessionin
themPINandLanguageSelectstate
293

ClarifiedthatallnotesarerefundedintheCash
Acceptstate

293to
2103

UpdatedtheCashAcceptstateforECB6support
andminoramendments

295

Updatedtableentry9oftheCashAcceptState
ExtensionState1
AmendedtosaythattheDepositKeyMasktable
entryisusedwhentheescrowisfull(notthe
EscrowFullKeyMasktableentry)

296

Updatedtableentry9oftheCashAcceptState
ExtensionState2

2106

Updatedthechequeentryretriesinformationin
theChequeAcceptState

2107

UpdatedtheChequeAcceptStatetoskipthe
furtherprocessingscreen

36

UpdatedforSupervisorsettlementscreensC10to
C19

37

AddedsectionforscreenC20

38

AddedScanBarcodescreen.

311

Addednotecontaininginformationaboutlpi
settingsforUSBprinters.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xviii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

313

RemovednoteaboutnotusingtheTABcharacter
inresrvd.defasrestrictionnolongerapplies

314

AddedfontdesignatorG

321to324 Updatedvoiceanddigitalaudioinformationfor
voiceguidancesupport
349

Removedcolourpaletteinformationasnolonger
applicableinAdvanceNDC

351to353 UpdatedSupervisorsettlementscreenstoinclude
screensC10C19
42

AddedassociatedkeyboardstoTheKeyboard
Interface

44

AddedAssociatingScreensandKeyboardsfor
FDKssection

46

AddedKeyboardMappingExamplessection

48

AddedstatetypelettertolistinStatesand
Keyboards,identifiedwhichonesdonotsupport
associatedkeyboardsandaddedAssociated
KeyboardsforFDKssection

52

NotedthatUSBprintersarethoseontheSelfServ
rangeofSSTsfromNCR
Addinformationaboutformsbasedandrawdata
printing

56

ReinstatedPrinterControlCharactersand
MaximumPrintedLinestables

510to512 Addedinformationaboutprintingdownloadable
bitimagesusingforms
512to514 Notedthatbarcodeprintingissupportedthrough
rawdataonly
Addedinformationaboutprintinggraphics
bitmapsusingforms.
518

Addedprintercontrolsequencefordefining
whethertoprintonthefrontorbackofthereceipt
orstatement

519

AddedrecommendationthatWindowsfontsare
usedforformsbasedprinting.

527

Updatedthenoteonformfeedcontrolsand
preprintscreens

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xix

Date

Page

Description of Change

533

Addedthatmonochromebitmapprintingis
supportedforbothformsbasedandrawdata
printing
Addedinformationthattheprintercontrol
sequenceforprintingachequeimagemustbe
within(notatthebeginningorendof)thePrinter
Datafieldforthereceiptprinter

72

MovedCameraControltoConfiguration
ParametersLoadMessagesection(fieldh)as
supportedexactlylikeenhancedconfiguration
parameterOption00
Addedoptiontoreporttransactionstatusdatain
ReadyBmessageintheSupplyMode,Ready
StatusandAmountBufferLengthparameter

74

Addedtimers61(EJacknowledgementtimeout)
63(hardwarefailurescreentimeout)tothetimer
summary
Removedtimers82and83asnotsupported

76

Addedoption00CameraControl

77

NotedthattheAutoVoiceoptionisautomatically
turnedoffifavoiceguidedsessionisselected

710

AddedEnhancedConfigurationParameterOption
32UnsolicitedReportingControl,asreportingfor
voiceguidanceandcameraisnowsupported

713

Addedthatrefundednotesarealsonowjournalled
ifoption44isset
Addednotethattheretractoptionisignoredif
automaticerrorrecoveryisonandthedeviceis
capableofretracting
AddednotethataBNAentersafatalstateifthe
retractoperationisprevented
Amendedoption45BNAMessageSettings

713to716 Amendedoption45BNAMessageSettingsto
providebitsettingsratherthanoptioncodes
Updatedoption45fortheinclusionofnote
reportingandrecyclingsettings
717

Addedoption71TimeOutStateentry;
Addedoption74CashDepositRetract
Destination

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xx

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

720

RemovedEnhancedConfigurationParameter
Option32ReportDASErrorsfromthelistof
unsupportedparameters,asitissupportedbut
calledUnsolicitedReportingControl;
Removedoption00CameraControlfromthe
unsupportedlist

722,723, NotedthatTimers00,01,04,05,07,08,09,95and
724,727 96canbeadjustedforavoiceguidedsession;
NotedthatTimer02mustbeusedforClosestate
processingofcardlesstransactions
725,726, UpdatedinformationonTimer63,asitisnow
727
supported
726

AmendedTimer78defaultsetting

94,96

UpdatedfieldrintheTransactionRequest
message

96

AmendedBNAnotecountstoreportthelast
transactioncountsnotthetotal

99

Updatedlengthofca3fieldintheTransaction
Requestmessagefromvariabletoeither2or3
digits

912

AddedvoiceguidancefieldstotheTransaction
Requestmessage

914

Addednoteabouttheinclusionofnotesunder
ECB6forfieldca3intheTransactionRequest
message

921

Addedinformationonthetransactionstatusdata
thatcanoptionallybeincludedwithaReadyB
message

930

Updatedhardwarefitnessbyte12forcamera
support

930

Updatedhardwarefitnessbyte32forvoice
guidancesupport

932

UpdatedProductClasslistinTable 914toinclude
28and30to3A.

934

Addedthedeviceidentifierusedinbyte4fora
cashhandlerwithrecyclingcapabilities

935

UpdatedtheSecurityCamerabyteinthe
HardwareConfigurationData,fieldg4

937

Updatedhardwareconfigurationbyte32forvoice
guidancesupport

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxi

Date

Page

Description of Change

938

Addedthedeviceidentifierusedinbyte34fora
BNAwithrecyclingcapabilities
Addedthedeviceidentifierusedinbyte34fora
GBXXwithoutrecyclingcapabilities
Updatedtablenotereferencesfordualcash
handlerstoincludeaGBRU

942

UpdatedProductClasslistinTable 917toinclude
28and30to3A.

951

AddedthatLocalOptionDigitscanbeentered
usingtheMessageModeoptionontheConfigure
menuinSupervisor

955

UpdatedtheSecurityCamerafieldg10ofthe
basicsendsupplycountersmessageasonlydigital
camerassupported

961

Amendedfieldg44oftheextendedsendsupply
countersmessage,astheBNAEmulationfieldsare
nowsupported

961

Addedfieldsg49tog55totheextendedsend
supplycountersmessagetosupportdual
dispensers

962

Addedfieldsg58tog63totheextendedsend
supplycountersmessagetosupportECB6
reporting

963

Addedthatfieldg40oftheextendedsendsupply
countersmessagecontainsallnotecategories
underECB6

986

AddedthatmultipleunsolicitedCardHandler
devicestatusmessagesaresentifacardjams
duringacaptureoperation
AddedasituationwhenCashHandlerdevice
statusmessageissent

990

Addedtablenoteexplainingwhatsuppliesstatus
isreportedforcassettesinrepeatedtransactions

993

Addednotethatknifestatusisalwaysreturnedin
unsolicitedstatusmessagesforthe40column
journalprinter,eventhoughnoknifeispresent.

999

Addedthedevicestatusmessageformatfor
camera

9107

Addedthedevicestatusmessageformatforvoice
guidanceerrors

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

9110

UpdatedthesituationsinwhichtheBNAstatus
messageissent
UpdatedtheBNAdevicestatusmessagefornote
reporting
Addedthatanerrorcodeof5intheBNAdevice
statusmessagecanbeunsolicited

9110

Addedthatanerrorcodeof5intheBNAdevice
statusmessagecanbeunsolicitedandadded
referencetoECB6
Removedreferencestodecimalvalues
Updatedthenumberofcharactersfrom2to1for
thetotalnumberofbillsinaBNAmessage

9112,9112 Addedcrossreferencesinerrorseverity(fieldg3)
andsuppliesstatus(fieldg5)forextendedBNA
messages
104

Amendedterminalcommandcodesforthesend
supplycountersmessage(commandcode4)

1011

Forj1field,addedreferencetokeyboard
interfacesection.
Forj3field,addedthatnestedkeyboardsarenot
supported

1012

Addedsectiononmanagingkeyboardlayoutsand
screen/keyboardassociations

1017

Addedoptioncode32,UnsolicitedReporting
Control,totheEnhancedConfiguration
ParametersLoadmessage

1018

Addedoptioncode71,controllingentrytothe
TimeOutstate,totheEnhancedConfiguration
ParametersLoadmessage
Addedoptioncode74,CashDepositRetract
Destination

1037

AddedthattheExtendedEncryptionKeyChange
messagecannowbeusedtochangetheMACKey
whenInService

1042

AddednotetoTableNote34,clarifyinguseofthe
EPPSerialNumber

1053to
1056

Updatedfieldsn,qandroftheTransaction
Replymessageforvoiceguidancesupport

1072

ClarifiedthatthetimeoutforBNARefundandSet
NextStateisTimer78

1077

Addedinformationonthetwoformatsthatcanbe
usedforfieldjoftheITRmessage

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxiii

Date

Page

Description of Change

1079,1080 UpdatedfieldshandjoftheITRmessagefor
voiceguidancesupport
122

UpdatedMotorisedReaderssectionasAdvance
NDCnowsupportsnonmagneticaccept

A3

UpdatedscreenA44forcamera

A4

Addednoteaboutapplicabilityofpassbookprinter
errors
AddederrorscreensE0010andE0011

A5

AddederrorscreenE0036

A9

AddedpassbookprintererrorscreensE1431to
E1432

A12

AddedscreensE1750toE1754forcamera

A13

AddedscreensE2000toE2014fortheBNA

A15

Addedscreene08fortheBNA

A21

UpdatedscreenI33;AddedscreenI40forcard
images

A24

Removed42FILLCAMERAfromthe
unsupportedoptions

A25

UpdatedscreenM07,SupervisorReplenish

A25

AddedscreenM13foracceptednotes

A26

AddedscreenM14foracceptednotes

A31

Addedscreensm19tom22fornotesignatures

A38

Addedscreensm62,m63forcamera

A41

AddedscreenP26fordriveselection

A42

AddedscreenP78forECB

A48

UpdatedscreensS86andS87
Updatedscreenss00tos02

A49

Addedscreenss30tos38fortheBNA

A62

AddedscreensU0106toU0120forthecashin
component

A86

Addedscreeni30fordateentry

A87

Addedscreeni76forfileordisk

A93to
A94

Addedscreensj0000toj0002andj0006toj0009for
cashreporting;addedscreenj0019forcardimages

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxiv

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

B4

Addedrecommendationtouseformsbased
printingonUSBprinters

B12

AddedmappingtableforISO8859charactersets
supportedbyAdvanceNDC

C9

Addedexamplegraphicforscanbarcode

D1toD20 UpdatedQuickReferencetoMessageTypesfor
allaffectedfields
E3

Addedthehardwareconfigurationdevice
identifierforacashhandlerwithrecycling
capabilities

E4

Addedhardwareconfigurationdeviceidentifier
codesforsecuritycamera

E7

Addedhardwareconfigurationdeviceidentifier
foraudiodevices

E9

Addedthehardwareconfigurationdevice
identifierforaBNAwithrecyclingcapabilities
Addedthehardwareconfigurationdevice
identifierforaGBXXwithoutrecyclingcapabilities

E11

Notedthatfor40columnjournalprinters,supplies
responsesdonotincludeavaluefortheknife
whereasunsolicitedstatusmessagesdo

E12

Addedsuppliesdeviceidentifierinformationfor
securitycamera

E16

Addedexplanationofsuppliesreportingforcash
acceptors,deviceidentifierw

E20

Addedfitnessdeviceidentifierinformationfor
securitycamera

E21

Addedfitnessdeviceidentifierforaudiodevices

E23

Addedexplanationoffitnessreportingforcash
acceptors

G6

RemovednoteastheXFSSimulatorforAPTRAis
nowareleasedproductandnolongersupplied
withAdvanceNDC

Glossary2 Addedentryforcodeline
Glossary4 Addedentryforescrow
Glossary5 AddedentriesforGIF,JPEGandMCR
Glossary6 AddedentriesforOpCodeandPCX

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxv

Date

Page

Description of Change

Glossary8 AddedentriesforTIFFandvault
Glossary9 Addedentryforvault
Feb08

UpdatedforAPTRAAdvanceNDC03.02.01
211

AddedthatatouchFDKcannotbeusedasthe
EnterkeyinthePINEntryState

214

ClarifiedhowStateCdiffersinAdvanceNDC
fromNDC+

230

RemovedminimumdatalengthfromBufferB

243

AddedthattheCloseStatemustusethesameBNA
NotesReturn/Retain/Leaveflagoption

250

RemovedsentenceonDieboldPINverificationas
AdvanceNDCdoesnotsupportDieboldPIN
verification

2110

Addednoteonchequeendorsement

333

Addedthatcompressedgraphicformatscanresult
indegradationofthedisplayperformance

531

Addedprintchequeimageprintercontrolcode

74
726

AddedGBXXtoTimer77

74
725
1064
1065

AddedTimer10descriptionanduses

713

AddedthattheBNAdoesnothaveTamper
Indication,butstatusmessagescanbeusedtotrack
cassetteinsertionandremoval

716

Addedthatarebootmustoccurbeforeany
changestooption46takeeffectatdevicelevel

727

RemovedTimer10fromlistofunsupportedtimers

85

ClarifiedthatISOFormat0isANSI
ClarifiedthePINverificationmethodsforPCKLN

82
84
810

AddedthatPAGDXisnotsupportedasLocal
DieboldPINverificationisnotsupported

811

AddedthatISOFormat0isANSIinPBFMT(PIN
BlockFormat)
RemovednotsupportedfromISOformat1

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxvi

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

94

UpdatedfieldroftheTransactionRequest
message

913

RemovedreferencetoDieboldemulationoptionas
itisnotsupportedbyAdvanceNDC

985

Addedthat,asinNDC+,itistheresponsibilityof
thehosttoputtheSSTintoOutofServicemodeif
theMCRWbecomesfatal

989

Updatedthedetailsofthesuppliesstatusinthe
CashHandlerdevicestatusmessage

995

Addedthatnomessageissenttothehostto
indicatethatthejournalisnotconfiguredifno
printerisattachedtotheSSTandtheEJisnot
activated

9103

AddedthatanR07indicatesonlythatthe
Diagnosticsmenuitemhasbeenselected,not
whetherentrytoDiagnosticshasbeensuccessful

1059

UpdateddetailsoftheChequeDestinationfieldin
theTransactionReplymessage

1063

AddednotethatEnvelopeispresentedinDeposit
andPrintsequenceonlyifithasnotalreadybeen
dispensedinStateC

E4

AddedoptionDforDoublelengthRestricted
modeintheEPPHardwareConfiguration

Glossary5 AddedJIFF(JPEGImageFileFormat)
July07

NewrevisionforAPTRAAdvanceNDC3.02,
includingrestructuringofthepublication
14

AddedthattheNCRSNMPinstallationsends
trapswheneverachangeinservicemodeoccurs

16

Updatedinformationondeletingfilesremotely;
addedthefilestodeleteforafreshstart

Chap.2
various
pages

Addedrangesforbase36(alphanumeric)state
numberstosupportupto46655statenumbers

23

AddedbarcodereaderStateTypetoTable21

214

UpdatedenvelopedispenserstateforMEI

234

AddedBarcodeBufferetoTable220

238

Updatedclosestateforreceiptprinterswithretract
UpdatedenvelopedispenserforMEI

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxvii

Date

Page

Description of Change

241

MoveddetailofjournallingBNAvaultednote
countsfromheretotheAPTRAAdvanceNDC,
SupervisorsGuide

293to
2101

UpdatedtheCashAcceptstate

2106

AmendedImageLiftinformation

2109

UpdatednoteonCPMprocessing

2110

AddednotesonCPMerrors

2145

AmendedTableNote48regardingnextstateexit

2143to
2145

AddednewtopicandstatetableforBarcode
ReaderState

2148

AddedreferencetoRedefiningReservedScreens

Chapter 3 Restructured,rewrittenandupdatedtoinclude:
theCardholder/EOPscreenlayout(wasCRT/EOP
screenlayoutinAppendixE);screendisplay
information(wasAppendixGScreenDisplay
Considerations);anddetailsoftheSupervisor
settlementtransactionsscreen(wasAppendixL,
Supervisor/SettlementTransactionsParameter
Screen)
33

Updatedmultilanguagescreendefinition

38to311 RemovedmentionofscreensK04,K05,andK06as
notsupported
316

AmendedtextforSOcontrol

334

Addedthatthepathcanbeincludedinthe
filenameinformationfortheDisplayImageFiles
control

348

RewroteRedefiningReservedScreens

351
56
122
B2
B7

Changedonlinedocumentationtitlefrom
SelfServiceSupporttoAPTRAXFS

Chapter 4 Restructured,rewrittenandupdatedforthe
CENXFSinterface;addedstandardkeyboard
layouts(wereinAppendixE)andhowtocalculate
fulltouchscreenpositions(wasAppendixI)
413

Updatedinformationonthedecisiontousesecure
keyentry

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxviii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

416

Updatednumberoftouchscreenareas

59

Addedinformationonprinterindependent
margincontrol

519

AddedintroductiontoUSBreceiptandUSB
journalcharactersetsupport

529

Addedprintercontrolsequencesandregistry
settings

64

Removedtableofscreensthatareeditedbythe
terminal;addedreferencetoAppendixA,
ReservedScreens

Chapter 7 Restructuredandrewrittentodeduplicate
information
72to75

Allconfigurationparameterloaddetailsmoved
herefromthemessageformattableonpage1014

74

AddedbarcodereadertimeouttotheSummaryof
Timerstable

76to727 Allenhancedconfigurationloaddetailsmoved
herefromthemessageformattableonpage1016
79

Addedvalue002forflexibleTI/SensorStatusto
enhancedconfigurationloadparameters

712

AddednotethataSupervisoroptionallowsoption
36tobeignoredifsentfromthehost;
UpdatedPrintTrack2toJournal001settingand
format

713

UpdatedOption44asitisnolongerusedinthe
CloseState;
UpdatedOption45descriptions;
AddednoteonusingGBRUdeviceswithOption
45settoacceptupto90notes

716

AddedOption48BarcodereadertotheEnhanced
ConfigurationParametersLoadmessagesection

717

AddedOption76CashHandlerstotheEnhanced
ConfigurationParametersinformation;
UpdatedOption77NextStateNumber,added
optioncodeforbase36(alphanumeric)state
numbers

718

AddedOption78GBRUmStatusandVariant
ReportingtotheEnhancedConfiguration
ParametersinformationandOption79Coin
DispensertotheEnhancedConfiguration
Parametersinformation

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxix

Date

Page

Description of Change

719

AddedOption80AlphanumericStateEntryand
Option83ChequeProcessingModule

722to727 MovedTimerDescriptionsherefromchapter10;
AddedtimeoutinformationforTimer04;
AddedTimer61tothetimerdescriptions;
Updatedreservedtimerslistanddetails
810

Addedthatthedelimiterisnotincludedinthe
offsetcountforFITdata;updatedindex
referencingexample

95

Updatedthelastcoinsdispensedinformationin
theTransactionRequestmessage

95

Addedsupportforsevencassettetypes

910

Addedfieldsforbarcodereaderandmorethan
fourhoppersintheTransactionRequestmessage

917

Updatedtheminimumbufferlengthto1bytefor
theGeneralPurposeBufferBintheInteractive
TransactionResponse

927
1078

Expandedintroductiontothesendconfiguration
informationandsendenhancedconfiguration
informationmessages

931

AddedCPMtoconfigurationmessage

931,941

AddedProductclassidentifiersfor5879,5889,and
Personas71

933,E2

AlignedconfigurationdataforMCRW

936

AddedByte24andByte29informationforcoin
dispenser

939

Addednoteondualcashhandlerrestrictions

948

Addedtamperindicationstatuscodes

949

AddednewExtendedTamperStatusfieldto
TamperandStatusDatamessage

953

AddednoteonBNA/GBNAnotereportingfor
largedenominations

954

Updatedfieldsg4g7oftheSendSupplyCounters
messagefordualcashhandlers

956

Updatedfieldsg60g62oftheSendSupply
Countersmessageforcoindispenserswithfour
hoppertypes

956

AddedCPMtoSendCountersmessage

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxx

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

957

Addedsendsupplycountersextendedmessage
format

969

Addedcoindispensertothesoliciteddevicefault
statusresponsetable

971

Addedcommentontheformatofthediagnostic
statusfieldforEPPencryptors

972

AddedmappingforreportingGBRUMStatusas
CDMMStatus

973

MovedEncryptorInitialisationDataand
UploadEJDataMessagesectionstoOther
SolicitedMessages

974to978 AddednewinformationtoEncryptor
InitialisationData
986

UpdatedCardReader/Writerstatusmessagefor
EMV

986

UpdatedtheCashHandlerdevicestatusmessage

9100
9102

Addedthevalueof6forbyte1oftheSensors
message

9102

AddedfurtherfieldstoSensorsmessageforwhen
byte1=5

9102

AddedanoteregardingtheOption24settingand
byte1oftheSensorsmessagesetto5or6

9109

UpdatedtheBNAdevicestatusmessage;supplies
statusnowvariableduetooption45

9111

UpdatedBNAdenominationtypetobe
hexadecimalvalues

9115to
9118

AddedCPMdevicestatusmessage

9119

Addeddetailsofcoindispenserresponsetoa
TransactionReplyCommandmessage

9122

Addeddetailsofbarcodereadersolicitedor
unsoliciteddevicestatusmessage

106to109 AddedtheNDCConfigurationCommand
information
108

Addedrangesforbase36(alphanumeric)state
numbers

1018

Addedinformationforoptions48,76,78,79,and
83

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxxi

Date

Page

Description of Change

1020

AddednotethataSupervisoroptionallowsoption
36tobeignoredifsentfromthehost

1023

AddednoteonwhenConfigIDissaved

1026

Addeddetailsofusingoffset16tocontrolwhether
bufferfisincluded

1027

AddedOffset51intheTransactionRequest
MessageforbarcodereaderdataIDfield

1028

UpdatedOffset5inTransactionReplyMessagefor
morethanfourhoppertypes

1030

AddednoteonOffset16andtheinclusionofbuffer
finMACgeneration

1038to
1042

Addedextendedencryptionkeyinformation

1039

AddedexplanationthatmodifierFwillfailifthe
encryptorhaspreviouslybeenusedinBAPEmode

1041

AddedinformationtoTableNote32onkeymode
supportforsecureandnonsecureEPP

1050

Addedrangesforbase36(alphanumeric)state
numbers
Updatedinformationonthenumberofnotesto
dispense;
Addedadditionalfieldsforadditionalhoppersin
thetransactionreply

1055
1056

UpdatedprinterflagaandbsupportforCPM

1061

Addednoteoninclusionofoneoftheprinterflags
aorbforCPM

1062

Addednoteonthemaximumnumberofcoinsthat
canbedispensed

1063to
1073

Updatedthetransactionsequencestoinclude
journaltodefinedlevel

1063
1067
1069
1070

Updatedthetransactionsequencestoincludecoin
dispense

1086

Updatedthemaximumdispenseinformation

1088

AddedspecificcommandrejectA06;
AddedspecificcommandrejectA09

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxxii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

1096

Updatednoteonprocessingofmessageswhilein
service

Chapter11 UpdatedtoincludePINblockformatsforDiebold
andISOformat1
Chapter 12 NewchapterEMVSmartCardHandling(was
AppendixN,SmartCardHandling)
Chapter13 NewchapterCCMVISA2DialupSystem(was
AppendixO)
Appendix Addedandupdatedthefollowingscreens:A90,
A
A91,A92,A93,A94,A95,A96,E0026,E1801,
E1802,E1803,e13,e17,e18,e19,e20,e21,e22,e23,
e24,e25,e26,e27,e28,e29,e30,e31,I06,I12I33,I37,
I42,I44,I45,I63,I66,M07,m02,m12,m24,m28,
m29,m30,m31,m32,m60,m90,m91,m,92,m93,
m94,m95,m96,P33,P36,P37,P93,P94,p34,p51,
p52,p53,s03,s04,s05,s06,s07,s08,T58,T59,T61,
T62,T63,T64,T76,t10,t11,t15,t22,t24,t26,t27,t28,
t29,t30,t35,t36,t37,t38,t39,t40,t41,t42,t43,t44,
t45,t46,t47,t48,t49,t50,t51,t52,t53,t54,t58,t59,
t60,t61,t62,t63,t64,t70,t71,t75,t76,t78,t79,t82,
t83,t84,t85,t86,t87,t94,t97,t98,t99,U0057,U0058,
U0059,U0067,U0068,U0069,U0070,U0071,U0072,
U0073,U0074,U0075,U0100,U0101,U0102,U0103,
i82,i83,i27,i88,i89,i90,j0003,j0004,j0010,d20,
d21,d22,d23,d24,d25,d26,d27,d28,d29,d30,
d31,d32,d33,d50,d51,d52,d53,d54,d60,d61,
d62,d63,d64,d65,d66,d67
Appendix Updatedcodepagesandcharactersets
B
B7

Addedinformationondownloadablecharacter
setsandUSBreceiptandjournalprinters

B8

Addedsectiononusingmappingfiles

D3

Updatedlimitofvariabledataforfieldrofthe
TransactionRequestmessage

D5

AddedfieldsinTransactionRequestmessagefor
coindispenserswithmorethanfourhoppers

D10

Addedmodifiersforcommandcodeof4in
TerminalCommands

D11

UpdatedCDMtoCoinDispenserandremoved
unsupportedstatement

D16

UpdatedprinterflagasupportforCPM

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxxiii

Date

Page

Description of Change

D18

Addedfieldsba1andba2forCPMtransaction
reply

E2

AmendeddetailsforMCRW,device09

E3

Addedmaximumdispenseinformationfor
extendedcassettes

E6

Addedcoindispenserdevicehardware
configurationdataidentifiers

E7

Addedcashhandler0andcashhandler1device
hardwareconfigurationdataidentifiers

E8

AddedbarcodereaderdeviceandCPMhardware
configurationdataidentifiers

E8

UpdatedDIGEforsuppliesinformationwith
extendedcassettesupport

E13

Addedcoindispenserdevicesuppliesdata
identifiers

E14

Addedcashhandler0andcashhandler1device
suppliesdataidentifiers

E8

AddedCPMtothesuppliesdatatable

E21

Addedcoindispenserdevicefitnessdata
identifiers;
addedcashhandlerdevicefitnessdataidentifiers

E22

Addedbarcodereaderdevicefitnessdata
identifiers;
AddedCPMtothefitnessdatatable

E25toE29 Addeddevicetamperdata
Appendix Updatedrelateddocumentationinformation
G
App.J

Appendixdeletedandmonitorburnin
informationmovedtotheAPTRAAuthor,Users
Guide

App.M

Appendixdeletedandfontdefinitioninformation
movedtotheAdvanceNDCDevelopersGuide

Glossary1 AddeddefinitionsforABA,BasicRemoteKey
to
Protocol,CDM,CoinHopper,CoinHopperType,
Glossary6 EnhancedRemoteKeyProtocol,StandardOutput
andUSB
May06

NewrevisionforAPTRAAdvanceNDC3.01

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxxiv

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

liv

Addedinformationonusingandnavigatingthis
publication;includinglocatingtablenotes

26
261
262
1019
N2
N3
N7

AddednoteonusingaDASHreaderasastandard
DIPreader

223

AddednotethattheAmountCheckStateis
unsupportedwithdualcashhandlers

2148

Addedtimer78

323

Addedinformationoncontrolsequenceforvoice

413

Addednoteregardingsecurekeyentry

52

AddedreferencetonewSupervisorfunctionfor
settingthemaximumstatementlength

64

Updatedautomaticscreeneditingtable

76

AddedEnhancedEJconfigurationloadparameters

710

Addedtimer78

943

AddeddetailsofBNAcounters

987

Updatedcashhandlerstatusforsolicitedretract
TransactionReplymessage

9110

UpdatedBNAdevicestatus,errorcode7isalways
unsolicited

9111

Addedinformationonenablingtheextended
messageformatthroughoption45

1011

Updatedthemaximumlengthofa
Screen/Keyboarddataloadmessage

1019

AddedinformationonTimer78

1018

Addedoptiondigit36

1023

Addedoption45valuestoenabletheextended
messageformat

1018

Addedoptiondigit77

1073

AmendedoperationdetailsforBNAencash,print
andsetnextstate

1129

Clarifieddoublelengthrestrictedkeyentrymode
information

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxxv

Date

Page

Description of Change

Appendix Updatedandaddedreservedscreens
A
E9

UpdatedBNAconfigurationinformation

H10

AddedextendedBNAsuppliesmessageformat

H13

AddedextendedBNAfitnessmessageformat

L3

Addedinformationoncustomisablesettlement
screens

N1

AddedreferencetoDevelopersGuidefor
informationonfatal/suspendhandlingforDAH
readers

O4

UpdatedinformationonBINandTerminalID
messagefields

Dec05

UpdatedforAPTRAAdvanceNDC3.00.02
213
252
88

Addednoteson4PINdigitminimumcheck

279

Addedinformationonoption45settingsaffecting
notemovementontimerexpiry

99

Updatedinformationonca1,ca2,andca3fieldsof
TransactionRequestMessage

945

Addedpartialcountsfortransportjam

A42

Addedmessagest19andt21tojournaltrace
ReservedScreens

G2

AddedPCXfiledistortionsolution

O5

AddedDialUpmessageformatforImAlive
Message

O7

AddedDialUpmessageformatforDisconnect
Message

O8

AddedDialUpmessageformatforNoOp
message

Glossary2 Addeddefinitionsforcurrencyanddenomination
Glossary5 Addeddefinitionfornotetype
Nov05

Fileupdate
220,228

Sep.05

RemovedreferencetoDieboldemulationmode.
UpdatedforAPTRAAdvanceNDC3.00.01.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxxvi

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

712

PrintTrack2toJournalisnowsupported.

941

Amendednoteabouttheinclusionofgroup
separatorsprecedingoptionalfields.

1019

AddeddescriptionofTimer69forthereceipt
printer.

1018

PrintTrack2toJournal:addedparametersfor
Option37.

1053

AddednotetoclarifythatAdvanceNDCworks
differentlyfromNDC+whenFunctionIDis1or7
asDieboldmodeisnotsupported.

A15

MarkedscreenI18asunavailableandadded
screenI19.

A19

UpdatedscreenI98tomatchresrvd.def.

A69

Addedscreensi93,i94andi95forSupervisor
Settlementfunctions.

L2

Addedheadingexplainingwhenrearsettlementis
notpossible;addedinformationaboutthe
customisablescreensavailableinresrvd.deffor
someofthesettlementfunctions.

Glossary2 AddedDAPI.
Jun.05

UpdatedforAPTRAAdvanceNDC3.00.
All

Addedheadingstoillustrationsandtables;added
listsoffiguresandtables;addedlinksfromtables
tonotes;removedreferencestopersonaSSSTDevice
SimulatorForWindowsNT,WindowsNT,and
BAPEemulationasnolongersupported;added
detailsofsupportfortheDASHcardreaderand
CCMVISA2dialupcommunications;addeddetails
oftheBNAretractoption.

16

Addeddetailsoftheprocessthatmustbestopped
beforepmdatacanbedeletedremotely.

23

AddedreferencetotheMultiVendorSupport
ReferenceManualforunsupportedstatetypeson
othervendorsSSTs.

211

RemovedreferencestoDieboldPINverification.

235

TransactionrequeststateI,tableentry6:added
detailsofuserdatafields.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxxvii

Date

Page

Description of Change

262

CardReadPINEntryInitiationState:added
informationtotableentry4fortimer72andthe
DASHcardreader.

280

AddedOperationsCodeextensiontabletostate
Y.

287

Newstatetypetableadded:mPIN&Language
SelectState.

295

Extension1toState>(BNA):intableentry4,
removedmentionoftotalsdisplayedonthe
confirmationscreen;intableentry8,addednew
screenforBNA.

2100

Extension3toState>(BNA),tableentry2:
removedreferencetopcbna.iniasnolongerused.

279

AddedthatBNAretractfunctionaryisconfigured
throughoption45.

33

AddedreferencetotheMultiVendorSupport
ReferenceManualforscreendataonothervendors
SSTs.

318

Addedrecommendationtouseaformfeedcontrol
characteratthestartofthescreenfollowinganidle
screen.

47

AddedreferencetotheMultiVendorSupport
ReferenceManualforkeyboardconfigurationon
othervendorsSSTs.

52

Statementprinternowsupportedthrough
CENXFSinterface.Addedreferencetothe
MultiVendorSupportReferenceManualforprinter
controlcodes.

61

AddedreferencetotheMultiVendorSupport
ReferenceManualforsizingSupervisorscreenson
othervendorsSSTs.

66

AddednewscreensfortheBNA.

713

HeadingBNAIncludeTransactionCounts
changedastheoptionisnowalsousedforretract
functionalityandreportingmorethan90notes.

925

SpecificCommandReject:addedstatus
informationfieldsB23toB29.

933

AddedmoresupportedMCRWdevices.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xxxviii

APTRA Advance NDC, Reference Manual

Date

Page

Description of Change

935

RemovednoteonBAPEemulationasnolonger
supported;amendedexampleofencryptor
configuration.

953

ForNotesDefinitionTable,updatedNoteto
explainresponsereturnedtoINITBNAifbins
removedandINITBNAfails.

964,972

Removedreferencetobna.iniasnolongerused;
changedRS232BNApropertypagetoplatform
configuration.

973

UpdatedfieldseandfintheEncryptor
InitialisationDatamessagetable,toinclude
modifiers1,25,and6.

961

Updatedlocationoftheelectronicjournallogfile,
ejdata.log.

979

UpdatedUploadEJDatamessageformat:Length
offieldjisavariablenumberofcharacters
dependingonvalueinfieldi.

993

RemovedreferencestoVBScriptsascontinuous
fatalprintjournalmessagesarealwaysenabled.

9111

Addedfieldse/g207e/g212forBNAdevicestatus
messages.

999

Addedunsolicitedmessagesequenceswhen
option35isset(dualmode).

104

Addedtwonewcommands(FDisconnectandG
NoOp)fordialupconnections.

1019

AddedTimer72fortheDASHcardreader.

1018

Addeddetailsofnewvaluesforoption45(fieldj
inEnhancedConfigurationParametersLoad
table).

1042

AddeddetailsofMACfieldforDCCMT.

1055

Transactionreplycommand:addedthatthesetting
forchequedestinationfieldisignoredunlessthe
transactionreplycontainsprintdata.

112

RemovednoteonBAPEemulationasnolonger
supported.

113

AddedsecurekeyentrythroughCENXFS.

A9

Addedscreennumbers:E1420,E1421,E1422for
statementprinter;E1600fornightsafe.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xxxix

Date

Page

Description of Change

A16

AddedscreenI29forkeymodeandI30forsecure
keyentry.

A51to
A62

Addedscreensi46toi86forCCMVISA2Dialup.

A67

Addedscreensi43andi91fortheBNA.

Appendix Addeddetailsofcharacterset6fortheeuro.
B
D2

RemovedreferencetoSMInstallationStatus
messageasnotsupportedinAdvanceNDC;added
referencetoExtendedEncryptionKeyChange
message.

E2

AddedmoresupportedMCRWdevices.

E4

RemovednoteonBAPEemulationasnolonger
supported.

M2

Updatedlocationofthefontdefinitionfile,
fontdefs.txt.

App.N

DASHcardreaderincludedinsmartcard
handling.

App.O

Newappendixfordialupconnections.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xl

APTRA Advance NDC, Reference Manual

Table of Contents

Contents

Preface
Audience .........................................................................................lxxi
HowtoUseThisPublication .............................................................lxxii
ContentsofthePublication .........................................................lxxii
RoadmaptothePublication ...................................................... lxxiv
NavigatingthePublication..........................................................lxxv
ConventionsandAbbreviationsUsedinthePublication.......lxxv
WhatElseShouldIRead?.......................................................... lxxvi
SupportInformation ........................................................................ lxxvii

Chapter 1
IntroducingtheAdvanceNDCSystem
Overview ................................................................................................11
HowtheSSTOperates ..........................................................................12
CreatingtheCustomisationData........................................................13
RoleoftheCentralControlApplication ............................................14

Chapter 2
StateTables
Overview ................................................................................................21
IntroductiontoStateTables .................................................................22
InvalidStateHandling ...................................................................22
CustomisingStates..........................................................................22
UnsupportedStateTypes ..............................................................22
ReservedStates................................................................................23
ExitStates .........................................................................................23
StandardStateTypes......................................................................23
StateNumbers .................................................................................24
ExtensionStates...............................................................................25
ACardReadState ...............................................................................26
ReadConditionValues ..................................................................28
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xli

Table of Contents

BPINEntryState...............................................................................211
CEnvelopeDispenserState.............................................................214
DPreSetOperationCodeBufferState ..........................................215
EFourFDKSelectionFunctionState .............................................218
FAmountEntryState .......................................................................220
GAmountCheckState .....................................................................223
HInformationEntryState................................................................228
DataEntry ......................................................................................228
ExitingtheInformationEntryState ...........................................228
ClearFunctionKeyandGeneralPurposeBuffers...................229
ITransactionRequestState..............................................................232
JCloseState ........................................................................................238
FunctionOperations .....................................................................238
KFITSwitchState .............................................................................245
_ExpandedFITSwitchState ...........................................................246
LCardWriteState.............................................................................248
MEnhancedPINEntryState...........................................................250
NCameraControlState ...................................................................253
REnhancedAmountEntryState ....................................................255
SLanguageCodeSwitchState ........................................................258
TCardReadPINEntryInitiationState .......................................261
DASHCardReader ......................................................................262
UDeviceFitnessFlowSelectState.................................................266
SupportedDevices ........................................................................268
VLanguageSelectFromCardState ...............................................272
WFDKSwitchState..........................................................................273
XFDKInformationEntryState .......................................................274
YEightFDKSelectionFunctionState ............................................277
bCustomerSelectablePINState.....................................................282
d...gandzExitStates ......................................................................285
kSmartFITCheckState ...................................................................286
mPIN&LanguageSelectState.......................................................287
>CashAcceptState ...........................................................................293
ConfirmationScreen ...................................................................2103
DynamicTextDefinitions ..........................................................2104
wChequeAcceptState...................................................................2105
zMasterExpansionState...............................................................2112
z001BunchChequeAcceptState .................................................2113
DefiningDynamicTextforChequeRejection ........................2118
DefiningDynamicTextforChequeRefusal ...........................2118
z002BunchChequeHandlingState.............................................2120
z003ChequeDetailDisplayState ................................................2124
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xlii

APTRA Advance NDC, Reference Manual

Table of Contents

DefiningDynamicDataforChequeDepositStatus ..............2129
z004DisplayChequeSummaryState..........................................2130
CurrentChequeIndex................................................................2131
z008InsertCardState ....................................................................2136
z009BufferValidationState..........................................................2140
DateValidationScenario ...........................................................2141
&BarcodeReadState .....................................................................2143
TimeOutState ...................................................................................2148

Chapter 3
ScreenData
Overview ................................................................................................31
TheScreenInterface ..............................................................................32
CustomerScreens............................................................................32
ReservedScreens.............................................................................33
TypesofReservedScreen.....................................................................35
CCardholderDisplay .................................................................36
GGraphicPictures.......................................................................38
KExtendedScreenControls.......................................................38
LLogos ........................................................................................312
MSupervisorMenus .................................................................312
EditingtheContentsofReservedScreens.................................313
FormattingRulesforCardholderDisplayScreens.........................314
CardholderScreen:DisplayCharacters.....................................314
OperatorInterfaceDisplayCharacters ......................................315
ControlCharacters........................................................................316
Track1NameDisplay..................................................................318
ControlCodesforSpecialFeatures ............................................320
InternationalCurrencyDisplayFormat ....................................344
MultiLanguageScreens .....................................................................347
RedefiningReservedScreens ......................................................348
DisplayingPictures .............................................................................349
PictureResolution.........................................................................349
GuidelinesforPictures.................................................................349
TouchScreenReset..............................................................................350
SupervisorSettlementScreens...........................................................351
UsingtheFrontorRearInterfaceforSettlement .....................351
SupervisorSettlementTransactions...........................................352
TransactionsParameterScreens(C09C19) ..............................353

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xliii

Table of Contents

Chapter 4
KeyboardDataandLayouts
Overview ................................................................................................41
TheKeyboardInterface ........................................................................42
PhysicalKeyboards.........................................................................42
TouchScreenKeyboards................................................................42
AssociatingScreensandKeyboardsforFDKs............................44
KeyboardMappingExamples ......................................................46
StatesandKeyboards............................................................................48
AssociatedKeyboardsforFDKs ...................................................49
SecurePINEntryandKeyboards.................................................49
KeyboardsinOperation.................................................................49
StandardKeyboardLayouts ..............................................................410
TransactionProcessing.................................................................410
FrontInterface:SupervisorMode...............................................412
EncryptionKeyEntry...................................................................413
SecureKeyEntry...........................................................................413
RearInterface:OperatorKeyboardLayout...............................414
DefiningFullTouchScreens ..............................................................416
TouchAreas ...................................................................................416
CalculatingFullTouchScreenPositions ...................................417

Chapter 5
PrinterData
Overview ................................................................................................51
PrinterTypesSupportedbyAdvanceNDC......................................52
PPDDefaultPrint ..................................................................................54
EightCharacterAmountBuffer ...................................................54
TwelveCharacterAmountBuffer ................................................55
PrinterControlCharacters ...................................................................56
EnhancedPrinterControlCodes ..................................................57
CharacterSets.......................................................................................519
StatementPrinterControls.................................................................522
LeftMarginControl......................................................................522
RightMarginControl ...................................................................522
MarginControlUse ......................................................................523
LinesPerInchControl..................................................................523
SimulatedPreprintedReceiptMessages.........................................524
SidewaysPrintingonReceipt ............................................................528
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xliv

APTRA Advance NDC, Reference Manual

Table of Contents

UnsupportedFunctions ...............................................................528
PrinterControlSequencesandRegistrySettings ...........................529

Chapter 6
SupervisorMessages
Overview ................................................................................................61
SupervisorMessages.............................................................................62
CharacterSets ..................................................................................62
ControlCodes..................................................................................62
ScreenSizeLimitations ..................................................................63
CardholderScreen/EnhancedOperatorInterfaceLayout .......63
PrinterLayout..................................................................................64
AutomaticScreenEditing..............................................................64
MediaStatusMessages ..................................................................64
TestCashReport .............................................................................64

Chapter 7
ConfigurationParameters
Overview ................................................................................................71
ConfigurationParametersLoadMessage..........................................72
CameraControl(Fieldh).............................................................72
SupplyMode,ReadyStatus&AmountBuffer
Length(Fieldm) .........................................................................72
LogicalUnitNumberLUNO(Fieldo)....................................73
TimerNumber(Fieldp)...............................................................73
MillisecondTicksperTimerField(Fieldq)..............................74
UnsupportedParameters...............................................................75
ReservedParameters ......................................................................75
EnhancedConfigurationParametersLoadMessage .......................76
Option00CameraControl .........................................................76
Option02AutoVoice ..................................................................77
Option03DateFormat................................................................77
Option04RollWidth ..................................................................77
Option05LeftPrintColumn......................................................77
Option07Track1 Format ..........................................................78
Option12SpecificCommandReject.........................................78
Option15TransactionStatusInformation ...............................78
Option16JournalPrinterBackupTime ...................................78
Option17JournalPrinterBackupPrintOperations...............78
Option23EnvelopeDispenserStatus.......................................79
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xlv

Table of Contents

Option24Enhanced/TISensorStatusUnsolicitedMessage .79
Option25MediaEntry/ExitIndicatorsFlashRate ...............710
Option27RemoteRelay ...........................................................710
Option30IncludePANinDCSData......................................710
Option32UnsolicitedReportingControl ..............................710
Option33SimulateSupervisorModeEntry/Exit..................711
Option34MCNRange..............................................................711
Option35ReportDualModeEJ&HardcopyB/UUnsolicited
Messages ......................................................................................712
Option36EnhancedEJBackup ...............................................712
Option37PrintTrack2toJournal...........................................712
Option44BNAJournalNotesCount......................................713
Option45BNASettings ............................................................713
Option46MCRWEnhancedCardDeviceSecurityJitter ....716
Option48BarcodeReader ........................................................716
Option69EMVSmartCardExtendedStatus........................716
Option70EMVSmartCard .....................................................716
Option71TimeOutStateEntry ..............................................716
Option74DestinationforCashDepositRetract ...................717
Option76CashHandlers..........................................................717
Option77NextStateNumber..................................................718
Option78GBRUMStatusReporting .....................................718
Option79CoinDispenser.........................................................719
Option80AlphanumericStateEntry......................................719
Option83ChequeProcessor ....................................................719
NumberofSecondsperTimerFieldFieldl.........................720
UnsupportedParameters.............................................................720
Timers....................................................................................................722
TimeUnitsforTimers ..................................................................722
TimerDescriptions........................................................................722
ReservedTimers............................................................................727
UnsupportedTimers ....................................................................727

Chapter 8
FinancialInstitutionTables
Overview ................................................................................................81
FITData...................................................................................................82
FITFields..........................................................................................83
LinkedFITs...........................................................................................813

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xlvi

APTRA Advance NDC, Reference Manual

Table of Contents

Chapter 9
TerminaltoCentralMessages
Overview ................................................................................................91
TransactionRequestMessages ............................................................92
TransactionRequestMessageFormat .........................................92
InteractiveTransactionResponse...............................................917
SolicitedStatusMessages ...................................................................918
ContentofSolicitedStatusMessages.........................................918
StatusInformation ........................................................................920
SolicitedDeviceFaultStatus..............................................................969
DeviceFaultStatusResponses....................................................969
DeviceFaultStatusInformationField .......................................970
OtherSolicitedMessages....................................................................973
EncryptorInitialisationData.......................................................973
UploadEJDataMessage..............................................................978
UnsolicitedStatusMessages ..............................................................981
ConditionsforSendingUnsolicitedMessages .........................981
UnsolicitedStatusInformationField .........................................982
DeviceStatusInformation..................................................................984
TimeOfDayClock(Unsolicited)...............................................984
PowerFailure(Unsolicited).........................................................984
CardReader/Writer(Solicited/Unsolicited)..............................985
CashHandler(Solicited/Unsolicited) ........................................986
Depository(Solicited/Unsolicited) .............................................991
ReceiptPrinter(Solicited/Unsolicited).......................................992
JournalPrinter(Unsolicited) .......................................................993
ElectronicJournalPrinter(Unsolicited).....................................995
NightSafeDepository(Solicited/Unsolicited)..........................998
Encryptor(Unsolicited)................................................................999
Camera(Unsolicited)....................................................................999
Sensors(Unsolicited) ..................................................................9100
TouchScreenKeyboard(Unsolicited) .....................................9103
SupervisorKeys(Unsolicited) ..................................................9103
CardholderDisplayAlarm(Unsolicited)................................9105
StatementPrinter(Solicited/Unsolicited) ................................9106
VoiceGuidance(Unsolicited) ...................................................9107
NoteAcceptor(Solicited/Unsolicited) .....................................9109
EnvelopeDispenser(Unsolicited) ............................................9114
ChequeProcessor(Solicited/Unsolicited) ...............................9115
CoinDispenser(Solicited/Unsolicited)....................................9119
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xlvii

Table of Contents

BarcodeReader(Unsolicited)....................................................9122

Chapter 10
CentraltoTerminalMessages
Overview ..............................................................................................101
EMVMessageClassSupport ......................................................101
UnsupportedCommands ............................................................101
TerminalCommands ..........................................................................102
CustomisationDataCommands .......................................................106
StateTablesLoad .................................................................................108
Screen/KeyboardDataLoad ............................................................1010
ManagingKeyboardsandAssociations ..................................1012
ConfigurationParametersLoad ......................................................1014
EnhancedConfigurationParametersLoad ...................................1016
FITDataLoad.....................................................................................1021
ConfigurationIDNumberLoad......................................................1023
MessageAuthenticationFieldSelectionLoad ..............................1025
DateandTimeLoad..........................................................................1032
EncryptionKeyChange....................................................................1033
ExtendedEncryptionKeyChange..................................................1036
DispenserCurrencyCassetteMappingTable...............................1043
XMLConfigurationDownload .......................................................1046
TransactionReplyCommand ..........................................................1049
TerminalFunctionsforTransactionCompletion ...................1062
InteractiveTransactionResponse....................................................1077
EJCommands.....................................................................................1081
EJOptionsandTimers ...............................................................1081
AcknowledgeEJUploadBlock .................................................1082
AcknowledgeandStopEJ .........................................................1083
ContinuousandBatchUploadMethods .................................1084
MessageValidation ...........................................................................1086
ValidMessageClasses................................................................1086
CommandRejectCauses............................................................1086
OtherInvalidParameters...........................................................1093
MessagesReceivedinWrongOperationalMode.........................1094
CustomisationDataCommands...............................................1094
TransactionReplyCommand ...................................................1095
TerminalCommands..................................................................1096

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

xlviii

APTRA Advance NDC, Reference Manual

Table of Contents

Chapter 11
SecurityFeatures
Overview ..............................................................................................111
BAPESecurity ......................................................................................112
EPPSecurity .........................................................................................113
RemotePINBlock................................................................................114
FITFields........................................................................................114
PINBlockFormats ........................................................................114
PINBlockEncryption...................................................................118
MessageAuthentication ...................................................................1110
MessageAuthenticationCode ..................................................1110
FullMessageAuthentication.....................................................1111
SelectiveMessageAuthentication ............................................1113
UsingSelectiveMessageAuthentication ................................1115
KeyVerificationValues ....................................................................1117
DeterminingEncryptorKeyStatus ..........................................1117
RSAInitialKeyLoading...................................................................1118
EPPAuthenticationProcess ......................................................1118
ChangingtheEncryptionKeyEntryMode ............................1123
LoadingDESKeys ......................................................................1124
RSAEncryptedDESKeyFormat..............................................1125
SignatureFormat.........................................................................1125
Base94EncodingandDecoding...............................................1126
DoubleLengthKeys .........................................................................1128
GeneralGuidelines .....................................................................1128
AdvanceNDCGuidelines .........................................................1128
DoubleLengthRestrictedKeyEntryMode..........................1129
JournalPrinterBackup .....................................................................1130

Chapter 12
EMVSmartCardHandling
Overview ..............................................................................................121
AcceptingandReadingCards...........................................................122
MotorisedReaders ........................................................................122
DIPReaders ...................................................................................122
ReadConditionsandFITMatch.................................................122
UsingEMV/CAM2ExitsforAdvanceNDC ...................................124
ExampleChipDataReadState ...................................................126
GuidelinesforHandlingSmartCardTransactions .................126
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

xlix

Table of Contents

Chapter 13
CCMVISA2DialupSystem
Overview ..............................................................................................131
DialupSystemSetup ...........................................................................132
BaudRate .......................................................................................132
DialupTimers ................................................................................132
PreDialandNormal ....................................................................133
EJUpload .......................................................................................133
DialupMessages:SSTtoCentral.......................................................134
ImAliveMessage.........................................................................135
TransactionCompletion...............................................................136
MessageonCP ..............................................................................136
MessageSuppression ...................................................................136
DialupMessages:CentraltoSST.......................................................137
DisconnectMessage......................................................................137
NoOpMessage.............................................................................138
GoOutofService(SupervisorMode)........................................139

Appendix A
ReservedScreens
Overview ...............................................................................................A1
ASupervisorAcknowledgements ...................................................A2
EErrorScreens....................................................................................A4
ISupervisorInformation .................................................................A17
MandmSupervisorMenus .........................................................A24
PSupervisorPrompts ......................................................................A40
SSupervisorInformationLines......................................................A46
TandtJournalTraceInformation ...............................................A50
UCheque,EMVSmartCardandBNA .........................................A60
dSupervisorDiagnosticScreens....................................................A66
iSupervisorTCP/IP..........................................................................A68
iSupervisorDialup ..........................................................................A71
iSupervisorBNA .............................................................................A84
iSupervisorSettlementScreens .....................................................A89
jSupervisorMiscellaneousScreens ...............................................A92

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents

Appendix B
CharacterSets
Overview ............................................................................................... B1
CharacterSets........................................................................................ B2
USBPrintersandDownloadableCharacterSets....................... B4
StatementCodeSets ...................................................................... B5
CodePages ............................................................................................ B7
OS/2CodePages ............................................................................ B7
USBReceiptandJournalCodePages ......................................... B7
MappingFiles ....................................................................................... B8
FontIDMappingTable ..................................................................... B12

Appendix C
CardholderScreenGraphics
Overview ............................................................................................... C1
CardholderExampleGraphics ........................................................... C2
InsertCard(g00.png)..................................................................... C3
PressKey(g01.png) ....................................................................... C4
MakeaDeposit(g03.png)............................................................. C5
TakeReceipt(g04.png).................................................................. C6
TakeCash(g05.png) ...................................................................... C7
TakeStatement(g06.png) ............................................................. C8
ScanBarcode(g10.png) ................................................................. C9

Appendix D
QuickReferencetoMessageTypes
Overview ...............................................................................................D1
QuickReferencetoMessageTypes ...................................................D2
TransactionRequest ......................................................................D3
UnsolicitedStatusMessages ........................................................D7
SolicitedStatusMessages .............................................................D8
EncryptorInitialisationData........................................................D9
UploadEJDataMessage...............................................................D9
TerminalCommands...................................................................D10
CustomisationDataCommands................................................D12
TransactionReply ........................................................................D14
AcknowledgeEJUploadBlockCommand ..............................D20
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

li

Table of Contents

AcknowledgeandStopEJCommand ......................................D20
EJOptionsandTimersCommand.............................................D20

Appendix E
DeviceIdentifiers
Overview ............................................................................................... E1
HardwareConfigurationData ........................................................... E2
SuppliesData ...................................................................................... E11
CashAcceptorSupplies(DIGw)............................................. E16
FitnessData ......................................................................................... E19
CashAcceptorFitness(DIGw)................................................ E23
TamperData........................................................................................ E25

Appendix F
ASCII/EBCDICConversionTable
Overview ................................................................................................F1
CodeConversionTable ........................................................................F2

Appendix G
RelatedDocumentation
Overview ...............................................................................................G1
AdvanceNDCDocumentation ..........................................................G2
APTRAAuthorDocumentation.........................................................G3
NDC+Documentation .........................................................................G5
OtherNCRDocumentation ................................................................G6
MiscellaneousDocumentation ...........................................................G7

Glossary
Glossary .................................................................................... Glossary1

Index
Index ................................................................................................Index1

UserFeedbackForm

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lii

APTRA Advance NDC, Reference Manual

List of Figures

ListofFigures

Chapter 2
StateTables
Figure 21

ReadConditionFlow...................................................210

Chapter 3
ScreenData
Figure 31

Cardholder/EOPScreenLayout...................................32

Chapter 4
KeyboardDataandLayouts
Figure 41
Figure 42

EmulatedFDKs:TouchAreas ......................................43
StandardKeyboardLayoutforCardholder
Transactions ................................................................410
Figure 43 SupervisorMode:KeyboardLayout .........................412
Figure 44 EncryptionKeyEntryKeyboardLayout ..................413
Figure 45 CardholderKeyboard:SecureKeyEntryLayout....413
Figure 46 OperatorKeyboardLayout ........................................414
Figure 47 UnaryCoordinates .....................................................417
Figure 48 FormatforFloatingPointNumbers ..........................417
Figure 49 CalculateExponent ......................................................419
Figure 410 CalculateMantissa .......................................................419
Figure 411 CalculateSign ...............................................................420
Figure 412 CalculateCoordinate..................................................420

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

liii

List of Figures

Chapter 5
PrinterData
Figure 51
Figure 52

ScreenTextInterlacing ................................................525
FinalSimulatedPreprintedReceipt .........................527

Chapter 11
SecurityFeatures
Figure 111
Figure 112
Figure 113
Figure 114
Figure 115
Figure 116
Figure 117
Figure 118
Figure 119
Figure 1110
Figure 1111
Figure 1112
Figure 1113

DieboldPINBlock........................................................115
ISOPINBlockFormat0 ..............................................115
ISOPINBlockFormat1 ..............................................116
ISOPINBlockFormat3 ..............................................116
BANKSYSPINBlock ...................................................117
PANBlock .....................................................................117
ObtainKeyStatusMessageExchange ....................1117
HSMEPPAkeymessageexchange......................1119
AuthenticationofEPP/HSMPublicKeys ...............1120
HSM/EPPKeyAuthentication/Exchange ...............1121
EPPAuthenticationMessageSequence ..................1122
KeyEntryModeRemoteChangeSequence...........1123
DESKeyLoadMessageSequence ...........................1124

Chapter 12
EMVSmartCardHandling
Figure 121 SmartCardHandling ..................................................125

Appendix B
CharacterSets
Figure B1
Figure B2

Alpha1............................................................................ B2
ExampleMappingFile ............................................... B11

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

liv

APTRA Advance NDC, Reference Manual

List of Figures

Appendix C
CardholderScreenGraphics
Figure C1
Figure C2
Figure C3
Figure C4
Figure C5
Figure C6
Figure C7

InsertCard(g00.png).................................................... C3
PressKey(g01.png) ...................................................... C4
MakeaDeposit(g03.png) ............................................ C5
TakeReceipt(g04.png) ................................................. C6
TakeCash(g05.png) ..................................................... C7
TakeStatement(g06.png) ............................................ C8
ScanBarcode(g10.png) ................................................ C9

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lv

List of Figures

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lvi

APTRA Advance NDC, Reference Manual

List of Tables

ListofTables

Preface
Table Pref1 NavigationAids ...........................................................lxxv
Table Pref2 AbbreviationsUsedinthePublication ................... lxxvi

Chapter 1
IntroducingtheAdvanceNDCSystem
Table 11
Table 12

CustomisationData .......................................................13
CentralControlCommandsandMessages................14

Chapter 2
StateTables
Table 21
Table 22
Table 23
Table 24
Table 25
Table 26
Table 27
Table 28
Table 29
Table 210
Table 211
Table 212
Table 213
Table 214
Table 215
Table 216
Table 217
Table 218

StateTableTypes............................................................23
BuffersInitialisedforStateA .......................................26
ACardReadState........................................................28
ReadConditionBitInformation ..................................28
BPinEntryState ........................................................211
CEnvelopeDispenserState .....................................214
DPresetOperationCodeBufferState ...................215
ExtensiontoStateD .....................................................216
EFourFDKSelectionFunctionState ......................219
FAmountEntryState................................................221
GAmountCheckState..............................................224
AmountCheckErrorState..........................................225
AmountCheckErrorStateDCCMT.....................226
HInformationEntryState ........................................230
ITransactionRequestState ......................................232
Track2DataSendModifier........................................233
Track1/3DataSendModifier.....................................233
TableEntry8forBufferA...........................................234

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lvii

List of Tables

Table 219
Table 220
Table 221
Table 222
Table 223
Table 224
Table 225
Table 226
Table 227
Table 228
Table 229
Table 230
Table 231
Table 232
Table 233
Table 234
Table 235
Table 236
Table 237
Table 238
Table 239
Table 240
Table 241
Table 242
Table 243
Table 244
Table 245
Table 246
Table 247
Table 248
Table 249
Table 250
Table 251
Table 252
Table 253
Table 254
Table 255
Table 256
Table 257
Table 258
Table 259
Table 260

Extension1toStateI....................................................234
Extension2toStateI....................................................237
JCloseState.................................................................239
ExtensiontoStateJ.......................................................241
ExtensionState2(JCloseState) ...............................244
KFITSwitchState......................................................245
_ExpandedFITSwitchState....................................246
ExtensiontoState_ ......................................................247
LCardWriteState......................................................249
MEnhancedPINEntryState ...................................251
SecurityCameraImageFilenameFormat ................253
NCameraControlState ............................................254
REnhancedAmountEntryState.............................255
ExtensiontoStateR......................................................256
SLanguageCodeSwitchState.................................258
ExtensiontoStateS ......................................................260
TCardReadPINEntryInitiationState................263
ExtensiontoStateT......................................................264
UDeviceFitnessFlowSelectState .........................266
StateUSupportedDevices.....................................268
CashHandlerFitnessExamples.................................271
VLanguageSelectfromCardState.........................272
WFDKSwitchState...................................................273
XFDKInformationEntryState................................274
ExtensiontoStateX......................................................276
YEightFDKSelectionFunctionState.....................278
Extension1toStateY...................................................280
Extension2toStateY...................................................281
bCustomerSelectablePINState .............................282
ExtensiontoStateb ......................................................284
kSmartFITCheckState ............................................286
mPIN&LanguageSelectState ...............................288
PIN&LanguageFDKActiveMask...........................290
Extension1toStatem..................................................290
Extension2toStatem..................................................291
Extension3toStatem..................................................292
>CashAcceptState....................................................294
Extension1toState>(CashAccept) .........................296
Extension2toState>(CashAccept) .........................298
Extension3toState>(CashAccept) .......................2100
Extension4toState>(CashAccept) .......................2102
RejectedNotesDynamicText...................................2104

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lviii

APTRA Advance NDC, Reference Manual

List of Tables

Table 261
Table 262
Table 263
Table 264
Table 265
Table 266
Table 267
Table 268
Table 269
Table 270
Table 271
Table 272
Table 273
Table 274
Table 275
Table 276
Table 277
Table 278
Table 279
Table 280
Table 281
Table 282
Table 283
Table 284
Table 285
Table 286
Table 287
Table 288
Table 289
Table 290

wChequeAcceptState ...........................................2105
Extension1toStatew................................................2108
Extension2toStatew................................................2110
zMasterExpansionState........................................2112
z001BunchChequeAcceptState ..........................2113
Extension1toStatez001 ...........................................2115
Extension2toStatez001 ...........................................2116
Extension3toStatez001 ...........................................2117
RejectedReasons ........................................................2118
RefusedReasons.........................................................2118
z002BunchChequeHandlingState......................2120
Extension1toStatez002 ...........................................2121
Extension2toStatez002 ...........................................2122
z003ChequeDetailDisplayState..........................2125
Extension1toStatez003 ...........................................2127
Extension2toStatez003 ...........................................2128
ChequeAcceptanceStates ........................................2129
z003ChequeDetailDisplayState..........................2131
Extension1toStatez004 ...........................................2132
Extension2toStatez004 ...........................................2133
Extension3toStatez004 ...........................................2134
z008InsertCardState.............................................2137
ExtensiontoStatez008 ..............................................2138
z009BufferValidationState ..................................2141
&BarcodeReaderState...........................................2143
Extension1toState& ................................................2145
Extensions28toState& ........................................2146
EntryConditionsfortheTimeOutState................2148
ActionTakenonSelectionofFDKBforEachEntry
Condition...................................................................2149
ActionTakenonSelectionoftheCancelKeyforEach
EntryCondition........................................................2150

Chapter 3
ScreenData
Table 31
Table 32
Table 33
Table 34
Table 35

KExtendedScreenControls:RestoringSettings....39
ScreenContentsK01 ....................................................39
ScreenContentsK09 ..................................................310
ScreenContentsK02 ..................................................310
ScreenContentsK010 ................................................310

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lix

List of Tables

Table 36
Table 37
Table 38
Table 39
Table 310
Table 311
Table 312
Table 313
Table 314
Table 315
Table 316
Table 317
Table 318
Table 319
Table 320
Table 321
Table 322
Table 323
Table 324
Table 325
Table 326
Table 327
Table 328
Table 329
Table 330
Table 331
Table 332
Table 333
Table 334
Table 335
Table 336
Table 337
Table 338
Table 339
Table 340
Table 341
Table 342

ScreenContentsK07 ..................................................310
ScreenContentsK08 ..................................................311
ScreenContentsK03 ..................................................311
CardholderScreen:CharacterSets ............................314
CharacterSetswithCustomerDefinedCharacters 315
EnhancedOperatorInterface:CharacterSet ............315
CardholderScreen:ControlCharacterFunctions ...316
Track1DataFormats...................................................318
ScreenDisplaySpecialFeatures.................................320
DigitalAudioControlinScreenDisplay..................322
DigitalAudioControlforVoiceGuidance...............323
ScreenBlinkingandColourControl .........................327
BlinkingCommands ....................................................327
ForegroundColourCommands.................................328
BackgroundColourCommands ................................328
DefaultForegroundColourCommands...................329
DefaultBackgroundColourCommands ..................329
ChangeDisplayWhileIdle .........................................330
SelectPrimaryCharacterSet ......................................331
SelectSecondaryCharacterSet ..................................331
SetLeftMarginPosition ..............................................332
SelectLogo.....................................................................333
PictureControlCommand..........................................334
DisplayImageFileCommand....................................334
DisplayLiftedChequeImageCommand.................335
BunchChequeImageDisplayControl .....................335
BunchChequeCodelineDisplayControl.................337
BunchChequeAmountDisplayControl..................337
BunchChequeValueDisplayControl ......................338
DisplayDynamicTextDictionaryControl...............339
DynamicButtonDefinition.........................................342
SyntaxofConditionalExpressions ............................343
DynamicTextDefinition .............................................343
VideoandAnimationFileFormats ...........................344
CurrencyEchoExample..............................................345
DefaultEchoDisplayFormat .....................................346
FieldDefinitionsforScreensC09C19 ......................353

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lx

APTRA Advance NDC, Reference Manual

List of Tables

Chapter 4
KeyboardDataandLayouts
Table 41
Table 42
Table 43
Table 44
Table 45
Table 46
Table 47
Table 48
Table 49
Table 410
Table 411

EmulatedFDKs:TouchAreaMeasurements.............43
FDKs,KeyCodesandCENXFSequivalents ............45
MappingCENXFSKeys...............................................45
MappingCENXFSExample........................................47
NumericAutoactivators(PIN)...................................411
NonNumericAutoactivators(PIN)..........................411
SupervisorModeAutoactivators(PIN) ....................412
EncryptionKeyEntryAutoactivators(PIN) ............413
EncryptionKeyEntryAutoactivators(TTU) ...........413
NonNumericAutoactivators(TTU).........................415
TouchAreaDefinition .................................................416

Chapter 5
PrinterData
Table 51
Table 52
Table 53
Table 54
Table 55
Table 56
Table 57
Table 58
Table 59
Table 510
Table 511
Table 512
Table 513
Table 514
Table 515
Table 516
Table 517
Table 518
Table 519
Table 520
Table 521

PrinterControlCharacters............................................56
MaximumPrintedLines ...............................................57
SetLeftMarginPosition................................................58
SetRightMarginPosition .............................................58
SelectOS/2CodePage ...................................................59
SelectInternationalCharacterSets ............................510
SelectArabicCharacterSets .......................................510
PrintDownloadableBitImage...................................511
PrintBarcode ................................................................512
PrintGraphics...............................................................513
PrintChequeImage .....................................................514
DefineDownloadableCharacterSet .........................515
DefineDownloadableBitImage ................................516
SelectHRICharacterPrintingPosition.....................517
SelectBarcodeWidth...................................................517
SelectBarcodeHorizontalHeight..............................518
SelectDualsidedPrinting ..........................................518
CharacterSetDesignators...........................................519
SelectPrimaryPrintPage............................................521
SelectSecondaryPrintPage........................................521
SetLeftMargin(StatementPrinter)...........................522

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxi

List of Tables

Table 522
Table 523
Table 524
Table 525
Table 526
Table 527
Table 528
Table 529
Table 530

SetRightMargin(StatementPrinter) ........................522
SwitchLinesPerInch(6/8)..........................................523
LineSpacingValues.....................................................523
InvalidControlSequencesforScreenR01................525
ScreenR00Data ............................................................526
ScreenR01DataandInterlacedDatafromCentral 526
PrinterControlSequencesandRegistrySettings ....529
PrintChequeImageVariableData ............................534
USBReceiptandJournalPrinter:BarcodeTypes,
Length,andData........................................................535

Chapter 6
SupervisorMessages
Table 61
Table 62

ScreenSizeLimits...........................................................63
DisplayPositions............................................................63

Chapter 7
ConfigurationParameters
Table 71
Table 72
Table 73
Table 74
Table 75
Table 76
Table 77
Table 78
Table 79
Table 710
Table 711
Table 712
Table 713
Table 714
Table 715
Table 716

ValuesforCameraControl ...........................................72
ValuesforSupplyMode,ReadyStatusandAmount
BufferLength ................................................................72
SummaryofTimers........................................................74
Option02:AutoVoiceValues ......................................77
Option03:DateFormats ...............................................77
Option07:Track1FormatValues ...............................78
Option12:SpecificCommandRejectValues .............78
Option15:TransactionStatusInformationValues ...78
Option23:EnvelopeDispenserStatusValues ...........79
Option24:Enhanced/TISensorStatusUnsolicited
MessageValues ............................................................79
Option24:MediaEntry/ExitIndicatorsFlashRate.710
Option27:RemoteRelay.............................................710
Option30:IncludePANinDCSdata........................710
Option32:UnsolicitedReportingControl................711
Option33:SimulateSupervisorModeEntry/Exit
Values ..........................................................................711
Option34:MCNRangeValues ..................................711

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxii

APTRA Advance NDC, Reference Manual

List of Tables

Table 717
Table 718
Table 719
Table 720
Table 721
Table 722
Table 723
Table 724
Table 725
Table 726
Table 727
Table 728
Table 729
Table 730
Table 731
Table 732
Table 733

Option35:ReportDualMode&HardcopyB/U
UnsolicitedMessageValues.....................................712
Option36:EnhancedEJBackupValues ...................712
Option37:PrintTrack2toJournal............................712
Option44:BNAJournalNotes
CountValues ..............................................................713
Option45:BNASettingsBitValues ..........................714
ExampleOption45:BNASettingsValues................715
Option46:MCRWEnhancedCardDeviceSecurity
JitterValues.................................................................716
Option48:BarcodeReaderValues ............................716
Option71:TimeOutStateEntry ...............................717
Option74:DestinationValuesforRetractedNotes
DuringCashDeposit .................................................717
Option76:CashHandlers...........................................717
Option77:NextStateNumberValues......................718
Option78:GBRUMStatusReporting ......................718
Option79:CoinDispenser..........................................719
Option80:AlphanumericStateEntry.......................719
Option83:ChequeProcessor .....................................720
UnsupportedParameters ............................................720

Chapter 8
FinancialInstitutionTables
Table 81
Table 82
Table 83
Table 84
Table 85
Table 86

FITFields .........................................................................82
PINBlockTypeSelection ..............................................85
PINPDBitEncodingSignificance ................................86
PINPDFirstDigitCoding .............................................87
PINDXIndexReferencePoint ....................................810
PINDXDigitAssignment............................................811

Chapter 9
TerminaltoCentralMessages
Table 91
Table 92
Table 93
Table 94

TransactionRequestMessageFormat.........................92
E13BCodelineEncoding.............................................915
CMC7CodelineEncoding ..........................................916
ReplytoInteractiveTransactionResponse ..............917

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxiii

List of Tables

Table 95
Table 96
Table 97
Table 98
Table 99
Table 910
Table 911
Table 912
Table 913
Table 914
Table 915
Table 916
Table 917
Table 918
Table 919
Table 920
Table 921
Table 922
Table 923
Table 924
Table 925
Table 926
Table 927
Table 928
Table 929
Table 930
Table 931
Table 932
Table 933
Table 934
Table 935
Table 936
Table 937
Table 938
Table 939
Table 940
Table 941
Table 942
Table 943
Table 944

SolicitedStatusMessageFormat................................919
Ready(B)StatusInformation.................................921
CashDeposit:RecycleData ........................................922
RecycleCassette:DispenseData ................................923
SpecificCommandRejectStatusInformation .......924
TerminalStateStatusInformationSubFieldg1 .927
SendConfigurationInformationResponse..............928
HardwareFitnessSubFieldg3................................929
HardwareFitnessSeverityValues.............................931
HardwareConfigurationData:SubFieldg4.........932
SuppliesStatusSubFieldg5 ....................................939
SuppliesStatusValues.................................................940
HardwareConfigurationDataResponse .................941
SuppliesDataResponse ..............................................944
FitnessDataResponse .................................................946
TamperandSensorDataResponse ...........................948
SoftwareIDandReleaseNumberDataResponse ..950
LocalConfigurationOptionDigitsResponse ..........951
NoteDefinitions(BNA)Response .............................951
SendSupplyCountersResponse ...............................954
SendSupplyCounters:ExtendedResponse ............957
SendTallyInformationResponse..............................965
SendErrorLogInformationResponse......................966
SendDate/TimeInformationResponse ....................967
SendConfigurationIDResponse...............................968
DeviceFaultStatusinResponsetoTransactionReply
Commands ..................................................................969
DeviceFaultStatusInformationField ......................970
EncryptorInitialisationDataResponse ....................973
FormatoftheUploadEJDataMessage ....................979
UnsolicitedStatus:MessageFormat..........................982
UnsolicitedStatus:StatusInformationField............983
TimeOfDayClockStatus ..........................................984
PowerFailureStatus ....................................................985
CardReader/WriterStatus..........................................985
CashHandlerStatus ....................................................987
DepositoryStatus .........................................................991
ReceiptPrinterStatus ..................................................992
JournalPrinterStatus...................................................993
ElectronicJournalPrinterStatus ................................995
UnsolicitedMessageSequencesforOption35(EJDual
Mode) ...........................................................................997

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxiv

APTRA Advance NDC, Reference Manual

List of Tables

Table 945
Table 946
Table 947
Table 948
Table 949
Table 950
Table 951
Table 952
Table 953
Table 954
Table 955
Table 956
Table 957
Table 958
Table 959

NightSafeDepositoryStatus .....................................998
EncryptorStatus ...........................................................999
CameraStatus .............................................................9100
SensorsStatus .............................................................9100
TouchScreenKeyboardStatus.................................9103
SupervisorKeysStatus..............................................9103
CardholderDisplayAlarmStatus ...........................9105
StatementPrinterStatus............................................9106
VoiceGuidanceStatus...............................................9108
BunchNoteAcceptorStatus.....................................9110
AdditionalCardholderData ....................................9113
EnvelopeDispenserStatus .......................................9114
ChequeProcessorStatus ...........................................9115
CoinDispenserStatus................................................9119
BarcodeReaderStatus ...............................................9122

Chapter 10
CentraltoTerminalMessages
Table 101
Table 102
Table 103
Table 104
Table 105
Table 106
Table 107
Table 108
Table 109
Table 1010
Table 1011
Table 1012
Table 1013
Table 1014
Table 1015
Table 1016
Table 1017
Table 1018
Table 1019
Table 1020
Table 1021
Table 1022

TerminalCommands ...................................................102
CustomisationDataCommands................................106
StateTablesLoad .........................................................108
Screen/keyboardDataLoad .....................................1010
ConfigurationParametersLoad...............................1014
EnhancedConfigurationParametersLoad ............1016
FITDataLoad .............................................................1021
ConfigurationIDNumberLoad ..............................1023
MessageAuthenticationFieldSelectionLoad .......1025
DataandTimeLoad ..................................................1032
EncryptionKeyChange ............................................1034
ExtendedEncryptionKeyChange ..........................1037
DispenserCurrencyCassetteMapping ..................1043
XMLConfigurationDownloadMessageFormat ..1047
TransactionReplyCommand:MessageFormat....1049
DepositandPrint .......................................................1063
DispenseandPrint.....................................................1064
DisplayandPrint .......................................................1065
PrintImmediate..........................................................1066
SetNextStateandPrint............................................1066
NightSafeDepositandPrint....................................1067
CardBeforeCash........................................................1067

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxv

List of Tables

Table 1023
Table 1024
Table 1025
Table 1026
Table 1027
Table 1028
Table 1029
Table 1030
Table 1031
Table 1032
Table 1033
Table 1034
Table 1035
Table 1036

ParallelEject/DispenseandPrint(FastCash) ........1069
CardBeforeParallelDispenseandPrint ................1070
PrintStatementandWait ..........................................1071
PrintStatementandSetNextState ..........................1071
CashAcceptorRefundandSetNextState .............1072
CashAcceptorEncash ...............................................1073
CashAcceptorEncash,PrintandSetNextState ...1073
ProcessCheque...........................................................1074
ProcessMultipleCheques.........................................1075
InteractiveTransactionResponse ............................1078
EJOptionsandTimers...............................................1081
AcknowledgeEJUploadBlock ................................1083
AcknowledgeandStopEJ.........................................1084
SpecificCommandRejectValue/Qualifier
Combinations............................................................1087
Table 1037 ActionsforCustomisationDataCommands .........1094
Table 1038 ActionsforTransactionReplyCommands ............1095
Table 1039 ActionsforTerminalCommands ............................1096

Chapter 11
SecurityFeatures
Table 111
Table 112
Table 113
Table 114
Table 115
Table 116
Table 117
Table 118
Table 119
Table 1110
Table 1111

PINPDFirstDigitBitSignificance .............................118
PINPDFITField ...........................................................118
MessageAuthenticationConfigurationFlag1 ......1112
MessageAuthenticationConfigurationFlag2 ......1112
MessageAuthenticationConfigurationFlag8 ......1112
MessageAuthenticationConfigurationFlag9 ......1112
MessageAuthenticationConfigurationFlag10 ....1112
MACFieldSelection:SolicitedStatusMessage .....1113
MACFieldSelectionOtherMessages...................1114
MACFieldSelectionTrack1,Track2,Track3....1114
MACFieldSelectionForEMVICCConfiguration
Messages....................................................................1115
Table 1112 SelectiveMACDefaultFieldValues .......................1115

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxvi

APTRA Advance NDC, Reference Manual

List of Tables

Chapter 12
EMVSmartCardHandling
Table 121

ChipDataReadState...................................................126

Chapter 13
CCMVISA2DialupSystem
Table 131
Table 132
Table 133
Table 134
Table 135
Table 136
Table 137

ModemTimers .............................................................132
ApplicationTimerSettingsforDialup......................133
SSTMessagesHeaderFormat ....................................134
ImAliveMessageFormat ..........................................135
CentralMessagesHeaderFormat..............................137
DisconnectMessageFormat .......................................137
NoOpMessageFormat ..............................................138

Appendix A
ReservedScreens
Table A1
Table A2
Table A3
Table A4
Table A5
Table A6
Table A7
Table A8
Table A9
Table A10
Table A11
Table A12
Table A13
Table A14

SupervisorAcknowledgementScreens .....................A2
ErrorScreens ..................................................................A4
SupervisorInformationScreens................................A17
SupervisorMenuScreens...........................................A24
SupervisorPromptsScreens ......................................A40
SupervisorInformationLinesScreens .....................A46
JournalTraceScreens..................................................A50
Cheque,EMVSmartCardandBNAScreens..........A60
SupervisorDiagnosticScreens ..................................A66
SupervisorTCP/IPScreens ........................................A68
SupervisorDialupScreens.........................................A71
SupervisorBNAScreens ............................................A84
SupervisorSettlementScreens ..................................A89
SupervisorMiscellaneousScreens............................A92

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxvii

List of Tables

Appendix B
CharacterSets
Table B1
Table B2
Table B3
Table B4

CharacterSets ................................................................ B3
StatementPrinterCharacterSets ................................ B5
MappingFileConventions .......................................... B9
FontIDMappingTable .............................................. B12

Appendix D
QuickReferencetoMessageTypes
Table D1
Table D2
Table D3
Table D4
Table D5
Table D6
Table D7
Table D8
Table D9
Table D10
Table D11
Table D12
Table D13
Table D14
Table D15

QuickReferencetoMessageTypes ............................D2
TransactionRequestMessageFormat........................D3
UnsolicitedStatusMessageFormat............................D7
SolicitedStatusMessageFields...................................D8
SolicitedStatusMessageFieldValues .......................D8
EncryptorInitialisationData .......................................D9
UploadEJDataMessage ..............................................D9
TerminalCommandFields ........................................D10
FieldValuesforTerminalCommands .....................D10
CustomisationDataCommandFields .....................D12
FieldValuesforDataCommands.............................D12
TransactionReply........................................................D14
AcknowledgeEJUploadBlockCommand .............D20
AcknowledgeandStopEJCommand......................D20
EJOptionsandTimersCommand............................D20

Appendix E
DeviceIdentifiers
Table E1
Table E2
Table E3
Table E4
Table E5
Table E6
Table E7
Table E8

DeviceHardwareConfigurationData ....................... E2
DeviceSuppliesData .................................................. E11
SuppliesStatusofallBNACassettes........................ E16
OverallBNARetractBinStatusReporting.............. E16
MostSevereBNASuppliesStatusReporting ......... E17
LeastSevereBNASuppliesStatusReporting ......... E17
BNASupplies:ExtendedMessageFormat.............. E17
DeviceFitnessData..................................................... E19

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxviii

APTRA Advance NDC, Reference Manual

List of Tables

Table E9
Table E10
Table E11

BNAFitness:ExtendedMessageFormat................. E24
DeviceTamperData ................................................... E25
TIBins(Alarms)SensorTypes .................................. E29

Appendix F
ASCII/EBCDICConversionTable
Table F1

ASCIItoEBCDICCodeConversion............................F2

Appendix G
RelatedDocumentation
Table G1
Table G2
Table G3
Table G4
Table G5
Table G6
Table G7

AdvanceNDCDocumentation ...................................G2
ProvidedAPTRAAuthorDocumentation ................G3
OtherAuthoringEnvironmentDocumentation.......G4
AdditionalNDC+Documentation..............................G5
OtherNCRDocumentation .........................................G6
CENXFSDocumentation ............................................G7
ISODocumentation.......................................................G7

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxix

List of Tables

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxx

APTRA Advance NDC, Reference Manual

Preface
Purpose and Audience

PurposeandAudience
Thepublicationprovidesreferencedetailsofstandardstatetables,
screen,keyboardandprinterdata,supervisormessages,
configurationparameters,FinancialInstitutionTables(FITs),
terminaltoCentral/Centraltoterminalmessages,securityfeatures
andreservedscreens.

Audience

TheAPTRAAdvanceNDC,ReferenceManualisintendedforthe
following:

Developerswhohavecustomised,orwishtocustomise,the
terminalconfigurationorthemessagesbetweentheterminal
andCentral
Programmersresponsiblefortheterminalconfigurationthat
customisestheAPTRAAdvanceNDCsoftware
ProgrammerswhowriteormodifyCentralcontrolapplications
tosupportterminalsrunningAPTRAAdvanceNDC.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxxi

Preface
How to Use This Publication

HowtoUseThisPublication
ThissectionsummarisesthecontentsoftheAdvanceNDCReference
Manual,andhowtouseitfordifferentpurposes.Italsoexplainsthe
navigationalaidsprovided,theconventionsusedandwhereto
obtainsupport.

ContentsofthePublication

Thepublicationcontainsthefollowinginformation:

Chapter 1,IntroducingtheAdvanceNDCSystem
ProvidesanoutlineoftheAdvanceNDCsoftware,withreferences
totheAPTRAAdvanceNDC,OverviewandAPTRAAdvanceNDC,
DevelopersGuideforfurtherintroductoryinformation.

Chapter 2,StateTables
Providesdetailsofthefunctionandformatofthestandardstate
tables,requiredforcustomisedterminalconfigurationusing
AdvanceNDC.

Chapter 3,ScreenData
Providesdetailsofthescreendata,requiredforcustomisedscreen
configurationusingAdvanceNDC;aworksheetforthecardholder
screenlayout,includingFDKalignment;andsomepointsto
considerwhenyouarepreparingscreensfordisplayonthe
terminal.Italsoincludestheformatanduseofreservedscreens
C09C19forSupervisorsettlementtransactions.

Chapter 4,KeyboardDataandLayouts
Providesdetailsofthekeyboarddata,requiredforcustomised
keyboardconfigurationusingAdvanceNDC;thekeyboardlayouts
providedwithAdvanceNDC;andhowtocalculatethecoordinates
thatareusedtodefinetouchareasonthescreen.

Chapter 5,PrinterData
Providesdetailsoftheprinterdata,requiredforcustomisedprinter
configurationusingAdvanceNDC.

Chapter 6,SupervisorMessages
ProvidesdetailsoftheSupervisormessages,requiredfor
customisedSupervisormessagesusingAdvanceNDC.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxxii

APTRA Advance NDC, Reference Manual

Preface
How to Use This Publication

Chapter 7,ConfigurationParameters
Providesdetailsoftheconfigurationparameters,requiredfor
customisedterminalconfigurationusingAdvanceNDC.

Chapter 8,FinancialInstitutionTables
ProvidesdetailsoftheFinancialInstitutionTables(FITs),required
forcustomisedFITsusingAdvanceNDC.

Chapter 9,TerminaltoCentralMessages
Providesdetailsofthefunctionandformatofeachtypeofmessage
thatissentfromtheterminaltoCentral.Thisinformationwillhelp
youtocreateormodifyyourCentralcontrolapplication.

Chapter 10,CentraltoTerminalMessages
Providesdetailsofthefunctionandformatofeachtypeofmessage
thatissentfromCentraltotheterminal.Thisinformationwillhelp
youtocreateormodifyyourCentralcontrolapplication.

Chapter 11,SecurityFeatures
ProvidesdetailsofthefeaturesthatAdvanceNDCprovidesto
safeguardagainstmessageinterferenceandfraudulentcards.This
informationwillhelpyoutodecodethemessagessentfromthe
terminaltoCentral,ifyouarecreatingormodifyingtheCentral
controlapplication.

Chapter 12,EMVSmartCardHandling
Providesanintroductiontothesmartcardhandlingenabledwith
AdvanceNDC.

Chapter 13,CCMVISA2DialupSystem
Providesinformationaboutmessagehandlingwhenusinga
modemforcommunicationswithCentral.

Appendix A,ReservedScreens
ShowsthescreenpositionsofallSupervisorandotherreserved
screens.

Appendix B,CharacterSets
Showsthecharactersetsandcodepagesprovidedonscreensand
printers.

Appendix C,CardholderScreenGraphics
Liststheexamplecardholderscreengraphicsprovidedwith
AdvanceNDC.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxxiii

Preface
How to Use This Publication

Appendix D,QuickReferencetoMessageTypes
Providesaquickreferencetothetypesofmessagesentbetween
Centralandtheterminal.Foreachmessagetype,themessageclass,
subclassandfieldswithinthemessageareidentified.Thiswillhelp
you,ifyouareaprogrammerdesigningtheCentralcontrol
application,toidentifythemessagesthatpasstoandfromCentral.

Appendix E,DeviceIdentifiers
Providesdetailsofthedeviceidentifiersforeachterminaldevice
andtheconfigurationdataassociatedwiththem.

Appendix F,ASCII/EBCDICConversionTable
DefinesthecodeconversionbetweenASCII,EBCDICandgraphic
characters.

Appendix G,RelatedDocumentation
Providesalistofthedocumentationavailabletohelpyoumigrateto
AdvanceNDC,andmodifyorenhanceanAdvanceNDC
application.

Roadmaptothe
Publication

Ifyouareaprogrammercreatingtheterminalconfigurationthat
customisestheAdvanceNDCsoftware,seechapters2to8for
detailsofstatetables,screen,keyboardandprinterdata,supervisor
messages,configurationparametersandFITs.
Ifyouareaprogrammercreatingacontrolapplicationforhostor
switch(Central),seechapters9and10fordetailsofthemessage
typessentbetweentheterminalandCentral.
Ifyouareaprogrammerwhohasextendedorintendstoextend
AdvanceNDCwithcustomisedroutines(Exits)fortheterminal,
seethefollowing:

ForinformationaboutthecreationofExitStates,andthe
messagetypesthatcanpassbetweenCentralandExits,chapters
2to4
Forinformationaboutthemessagesecurityfeaturesyoucan
use,chapter11.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxxiv

APTRA Advance NDC, Reference Manual

Preface
How to Use This Publication

NavigatingthePublication

ThepublicationcanbeviewedonscreenorprintedwiththeAdobe
Reader.
Thefollowingareavailableonscreen:

Hyperlinkedpagereferences,forexample,fromthetableof
contentsandindex
Hyperlinkednotesreferencedintables;thetablenotesaregiven
attheendoftherelevanttableandnumberedconsecutively
withineachchapter
HyperlinkedbookmarksintheBookmarkspane;thebookmarks
givethestructureofthepublicationdowntothreeheading
levels.

Thestructureofthepublicationcontainsthefollowingtohelpyou
findinformation,orsubmitcomments:
Table Pref-1
Navigation Aids

Element

Description

RevisionRecord

Listsupdatesfor3.0xreleasesinpageorderwith
pagereferences.Themostrecentrevisionislisted
first.Thepagereferencesforthecurrentrevision
arehyperlinked;pagereferencesforearlier
revisionsarenotalwayshyperlinked.

TableofContents

Liststhefirsttwoheadinglevelsinpageorderwith
pagereferences.

TableofContents
forchapteror
appendix

Liststhefirstthreeheadinglevelsinpageorder
withpagereferences.

Glossary

Providesanalphabeticallistofterms,acronyms,
andabbreviationswiththeirmeaning.

Index

Providesanalphabeticallistoftopics,keywords,
concepts,anddatareferenceswithpagereferences.

Feedback

Allowsyoutocommentonthepublicationby:

Printingtheformtofillinandpost
Selectingtheemaillink
Selectingtheweblink.

Conventionsand
AbbreviationsUsedinthe
Publication

AllreferencestoUSBprinters(receipt,journalandstatement),refer
todevicesrunningontheNCRrangeofSelfServSSTs.

Abbreviations
Thefollowingabbreviationsareusedthroughoutthepublication:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxxv

Preface
How to Use This Publication
Table Pref-2
Abbreviations Used in the Publication

Full Form

Abbreviated Form

Europay,Mastercard,VISA

EMV

GBNAandGBRU

GBXX(whentheinformation
appliestobothdevices)

CPMandbunchchequeacceptor

Chequeprocessor(whenthe
informationappliestoboth
devices)

IntegratedCircuitCard

ICC

MicrosoftWindowsXP
Professional

WindowsXP

Foralistofallabbreviationsusedinthemanual,seetheGlossary.

WhatElseShouldIRead?

NCRrecommendsyoufirstreadtheAPTRAAdvanceNDC,
OverviewandtheAPTRAAdvanceNDC,DevelopersGuide
(B0066046).
IfyouareworkingwithAdvanceNDConothervendorsSSTs,you
willalsoneedtheAPTRAAdvanceNDC,MultiVendorSupport
ReferenceManual(B0066344).
AllthedocumentationrelatedtoAdvanceNDCislistedand
describedinAppendix G,RelatedDocumentation.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxxvi

APTRA Advance NDC, Reference Manual

Preface
Support Information

SupportInformation
Ifyouhaveaproblemusingthesoftware,pleasecontactyour
internalsupportdepartment,oryourlocalNCRrepresentative.
NCRprovidesawiderangeofsupportprogrammesformore
information,contactyourlocalaccountteam.
Ifyouhaveanyproblemsusingthismanual,seetheUserFeedback
Formatthebackofthemanual,forourelectronicandpostal
addresses.Pleasetakethetimetoreply;yourcommentsare
appreciated.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

lxxvii

Preface
Support Information

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

lxxviii

APTRA Advance NDC, Reference Manual

Table of Contents
Introducing the Advance NDC System

Chapter 1

IntroducingtheAdvanceNDC
System
Overview

11

HowtheSSTOperates

12

CreatingtheCustomisationData

13

RoleoftheCentralControlApplication

14

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Introducing the Advance NDC System

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Introducing the Advance NDC System


Overview

Overview

ThischapterintroducesAdvanceNDCunderthefollowingtopics:

Howtheselfserviceterminal(SST)operates
Creatingthecustomisationdata
Roleofthecontrolapplicationonthehostorswitch(Central)

Forinformationonclearingpersistentmemory,refertotheAPTRA
AdvanceNDC,DevelopersGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

1-1

Introducing the Advance NDC System


How the SST Operates

HowtheSSTOperates

WhentheSSTisswitchedon,afterloadingitwiththeAdvance
NDCsoftware,apowerupmessageissenttoCentral.Central
downloadsanynecessarydatatotheSSTinaseriesofmessages.
Aftereachmessageissent,theSSTsendsanacknowledgementto
Central.WhenCentralhassentallthedownloaddatasuccessfully,
itputstheSSTintoservice.
Whenatransaction,isprocessed,thefollowingoperationsare
completed:
1

TheSSTgathersdetailsfromtheconsumerandcard(ifacardis
used)

TheSSTsendstheinformationinaTransactionRequest
messagetoCentral.

CentralsendsaTransactionReplycommand

TheSSTcompletesthetransaction.

Ifafaultoccurs,theSSTsendsamessagetoCentralandwaitsfora
furtherTransactionReplycommandbeforecompletingthe
transaction.Oncethetransactionhasbeencompletedsuccessfully,
theSSTsendsamessagetoCentraltoconfirmit.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

1-2

APTRA Advance NDC, Reference Manual

Introducing the Advance NDC System


Creating the Customisation Data

CreatingtheCustomisationData

Table 11,CustomisationDatabelow,describesthetypesof
customisationdataandwheretofindfurtherinformation.
Table 1-1
Customisation Data
Customisation Data

Description

StateTables

StatedefinitionsthatdeterminehowtheSSTprocessestransactions.For
details,seeChapter 2,StateTables.

Screens

InformationdisplayedwhiletheconsumerisusingtheSST.Fordetails,
seeChapter 3,ScreenData.

PrintedScreens

InformationprintedwhiletheconsumerisusingtheSST.Fordetails,see
Chapter 5,PrinterData.

SupervisorMessages

TheSupervisormessagesoutputtotheconsumerscreen,theenhanced
operatorpanel,andthereceiptandjournalprinters.Fordetails,see
Chapter 6,SupervisorMessages.

ConfigurationParameters

LocalconfigurationparameterssuchasAmountBuffersize,card
reader/writererrorthresholds,andtimers.Fordetails,seeChapter 7,
ConfigurationParameters.

FinancialInstitutionTables(FITs)

ThefinancialinstitutionstheSSTsupports.Foreachinstitution,thetable
defineswhetherPINverificationislocalorremote,thetypeofdata
encryption,andthepositionofdetailsonthecard.Fordetails,see
Chapter 8,FinancialInstitutionTables.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

1-3

Introducing the Advance NDC System


Role of the Central Control Application

RoleoftheCentralControl
Application
Table 12CentralControlCommandsandMessagesbelow
describesthecommandsandmessagesusedbyCentral.
Table 1-2
Central Control Commands and Messages
Command/Message

Description

TerminalCommands

InstructionssenttotheSST.
SeeChapter 10,CentraltoTerminalMessages.

TransactionReplyCommands

ResponsesfromCentraltoaTransactionRequestmessagefromtheSST,
tellingtheSSThowtocompletethetransaction.
SeeChapter 10,CentraltoTerminalMessages.

CustomisationDataCommands

CustomisationdatasenttotheSST.
SeeChapter 10,CentraltoTerminalMessages.

InteractiveTransactionResponse

MessagestotheSSTtoprompttheconsumerformoreinformation.
SeeChapter 10,CentraltoTerminalMessages.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

1-4

APTRA Advance NDC, Reference Manual

Table of Contents
State Tables

Chapter 2

StateTables
Overview

21

IntroductiontoStateTables
InvalidStateHandling
CustomisingStates
UnsupportedStateTypes
ReservedStates
ExitStates
StandardStateTypes
StateNumbers
ExtensionStates
TableEntryValue255
TableEntryValue000

22
22
22
22
23
23
23
24
25
25
25

ACardReadState
ReadConditionValues

26
28

BPINEntryState

211

CEnvelopeDispenserState

214

DPreSetOperationCodeBufferState

215

EFourFDKSelectionFunctionState

218

FAmountEntryState

220

GAmountCheckState

223

HInformationEntryState

228

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
State Tables

DataEntry
DataEntryandVoiceGuidance
ExitingtheInformationEntryState
EmulatedFDKsandTouchscreenKeyboards
ClearFunctionKeyandGeneralPurposeBuffers

228
228
228
228
229

ITransactionRequestState

232

JCloseState
FunctionOperations
Receipts,StatementsandEnvelopes
Cards
CardlessTransactions
Audio

238
238
238
238
239
239

KFITSwitchState

245

_ExpandedFITSwitchState

246

LCardWriteState

248

MEnhancedPINEntryState

250

NCameraControlState

253

REnhancedAmountEntryState

255

SLanguageCodeSwitchState

258

TCardReadPINEntryInitiationState
DASHCardReader

261
262

UDeviceFitnessFlowSelectState
SupportedDevices
CashHandlers

266
268
271

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
State Tables

VLanguageSelectFromCardState

272

WFDKSwitchState

273

XFDKInformationEntryState

274

YEightFDKSelectionFunctionState

277

bCustomerSelectablePINState

282

d...gandzExitStates

285

kSmartFITCheckState

286

mPIN&LanguageSelectState

287

>CashAcceptState
ConfirmationScreen
RefundableDeposits
DirectDeposits
DynamicTextDefinitions
DefiningReasonsforNoteRefusal

293
2103
2103
2103
2104
2104

wChequeAcceptState

2105

zMasterExpansionState

2112

z001BunchChequeAcceptState
DefiningDynamicTextforChequeRejection
DefiningDynamicTextforChequeRefusal

2113
2118
2118

z002BunchChequeHandlingState

2120

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
State Tables

z003ChequeDetailDisplayState
DefiningDynamicDataforChequeDepositStatus

2124
2129

z004DisplayChequeSummaryState
CurrentChequeIndex

2130
2131

z008InsertCardState

2136

z009BufferValidationState
DateValidationScenario

2140
2141

&BarcodeReadState

2143

TimeOutState

2148

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

State Tables
Overview

Overview

Statescontroltheinformationgatheringpartofconsumer
transactions.AdvanceNDCprovidesasetofstandardstates,and
mechanismsforreplacingstandardstatesoraddingnewones.
StatesthatyouwriteyourselfarecalledExitStates.
Thischapterdescribesthefunctionandformatofeachofthe
standardstatetabletypessupportedinAdvanceNDC.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-1

State Tables
Introduction to State Tables

IntroductiontoStateTables

Astatetableismadeupofthestatenumber,statetypeandtable
data.Moststatesincludeascreennumberandanextstatenumber
aspartofthetabledata.Astatenumbercanbedecimal(base10)or
alphanumeric(base36).Ingeneral,whereascreenispresent,itis
displayedwhenthestateisentered,theSSTperformstheaction
specifiedbythestatetype,andthetransactionflowcontinuesfrom
thespecifiednextstate.Thesescreenscanalsoreferenceassociated
keyboardlayoutsforFDKs.Fordetails,seeChapter 4,Keyboard
DataandLayouts.

InvalidStateHandling

Ifthenextstatespecifiedisinvalidorundefined,duetoeitherthe
statetableortheTransactionReplyspecifyingastatethathasnot
beendownloaded,thetransactionflowcontinuesfromadefault
Closestate.
WhenthedefaultClosestateistaken,theconsumertransactionis
completedbythedeliveryofareceiptorstatement,andthereturn
orcaptureofthecardasspecified.Thenumberofthelaststatetaken
isdisplayedinthetoplefthandcorneroftheconsumerscreen.This
allowsyoutochecktheparametersofthelaststatetakentofindout
whichstatetheSSTwasattemptingtotake.Fromthisyoucan
specifythemissingstateandincludeitinthedownload.
Note:ThefullstateflowcanbetracedusingtheSTATEDATAtrace
streamintheDebugLogorSilentDebugtools.Forfurther
informationonthesetools,refertotheAPTRAAdvanceNDC,
DevelopersGuide.

CustomisingStates

Youcustomiseastatebyassigningvaluestoitsparameters.To
buildastateflow,youselectdifferentstatetypesandplacethemin
theapplicationflowbylinkingthestatestogetheronestate
referencesanotherwithoneormoreofitsparametersorentries.
Whenyouhavefinishedcustomisingthestatetables,Central
downloadstheinformationtotheSSTinCustomisationData
commands.Chapter10,CentralToSSTMessagesdescribesthe
formatofthesecommands.

UnsupportedStateTypes

ThefollowingstatesarenotsupportedinAdvanceNDC:
2

PCourtesyAmountVerification
QDPMDocumentAccept
iAudioControl

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-2

APTRA Advance NDC, Reference Manual

State Tables
Introduction to State Tables

Thefollowingstatesarereserved:

ReservedStates

cDeviceTeststate
z010toz899(Masterexpansionstatezwithsubstaterange)

ExitStates

StandardStateTypes
Table 2-1
State Table Types

Aswellasstatesdtog,substatesz900toz999arereservedfor
Exitstates.
Thefollowingtablelistseachofthesupportedstandardstatetypes
thatcontroltransactionprocessing:
State Table Type

Description

CardRead

PINEntry

EnvelopeDispenser

PreSetOperationCodeBuffer

FourFDKSelectionFunction

AmountEntry

AmountCheck

InformationEntry

TransactionRequest

Close

FITSwitch

ExpandedFITSwitch

CardWrite

EnhancedPINEntry

CameraControl

CardholderVerification

EnhancedAmountEntry

LanguageCodeSwitch

CardReadPINEntryInitiation

LanguageSelectFromCard

FDKSwitch

FDKInformationEntry

EightFDKSelectionFunction

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-3

State Tables
Introduction to State Tables
State Table Type

Description

ExtensionState

CustomerSelectablePINState

d...g

AvailableasidentifiersforExitStates

SmartFITCheckState

PIN&LanguageSelectState

>

CashAcceptState

ChequeAcceptState

&

BarcodeReaderState

MasterExpansionState

z001

BunchChequeAcceptState

z002

BunchChequeHandlingState

z003

ChequeDetailDisplayState

z004

DisplayChequeSummaryState

z008

InsertCardState

z009

BufferValidationState

z900toz999

AvailableasidentifiersforExitStates

Note1:Duringtransactionprocessing,beforeentrytoeachstate,
AdvanceNDCchecksthekeyboardlayouttobeused.Ifthescreen
thatisabouttobeusedreferencesatouchscreenkeyboardnumber
butthetouchscreenkeyboardlayoutdoesnotprovidedefinitions
ofalltherequiredkeys,thetransactionflowgoestothedefault
Closestate.

StateNumbers

FromAdvanceNDC3.02,Alphanumeric(base36)numbersinstate
tableentriesaresupportedaswellasdecimal(base10).Using
alphanumericdataprovidessupportforupto46655statenumbers,
withoutchangingthetableentrylength.Inpreviousreleasesof
AdvanceNDConlydecimal(base10)numbersweresupported,
providingamaximumof999statenumbers.Thecharacterfieldin
thestateentriescontainseitheradecimaloralphanumericnumber,
dependingonthevalueofOption80.Fordetails,seeOption80
AlphanumericStateEntryonpage 719.
Decimalnumbersareintherange000to999.
Alphanumericnumbersareintherange000toZZZ.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-4

APTRA Advance NDC, Reference Manual

State Tables
Introduction to State Tables

Thevalue255isalwaysreservedunlessstatedotherwiseinthe
tableentry.

ExtensionStates

Manystatetypesallowtheuseofextensionstates(statetypeZ).
Theuseofeachextensionstateisdescribedinthestatetables.

TableEntryValue255

Unlessspecifiedinthestatetabledescription,thevalue255is
reserved.Usingavalueof255whennotexplicitlyspecifiedinthe
statetabledescriptioncanresultinunintendedconsequences
duringstateexecution.

TableEntryValue000

Whetheranextensionstateisoptionalormandatorydependsonthe
contextandconditionsofthetransactionflow.Conditionsforthe
useofvalue000areasfollows:

Ifanextensionstateisnotmandatoryandnotusedinthe
transactionflow,usethevalue000unlessadifferentvalueis
explicitlyspecifiedinthestatetabledescription.
Ifanextensionstateismandatory,donotusethe000value.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-5

State Tables
A - Card Read State

ACardReadState

WhenyouusetheCardReadstatetable,ensureitisthefirsttable
usedduringtransactionprocessingbyassigningstatenumber000
toit.TheSSTautomaticallyentersstate000whenputInService.
CardlesstransactionscanbeinitiatedinthisstateifEnhanced
ConfigurationParameteroption77isused.Fordetails,seeOption
77NextStateNumberonpage 718.
Note:IfaDipandSmartHardware(DASH)readerisusedwith
thisstate,theDASHreaderbehavesasastandarddipreader.
WhentheSSTenterstheCardReadstate,thefollowingbuffersare
initialised:
Table 2-2
Buffers Initialised for State A

Buffer

Initialised to...

CardDatabuffers

nodata

PINandGeneralPurposebuffer

nodata

Amountbuffer

zerofilled

OperationCodebuffer

spacefilled

FDKbuffer

zerofilled

TheCardReadstateperformsthefollowingactions:

Displaysthescreenselectedtoprompttheconsumertoentera
card
Displaystheerrorscreenselectedifthecardcannotberead
Ifallthereadconditionsaremagneticonly,attemptstoread
Track1forfuturenamedisplay
SetstheMediaEntryIndicatorflashingwhilethecardreaderis
waitingfortheconsumertoenteracard.Theindicatoris
switchedoffwhenthecardisentered.

Italsosetsthefollowinginformation:

ThenextstatenumbertheSSTgoestoifthecardisread
successfully
Whichtrack(s)and/orchipdataonthecardwillberead
Whenthecardshouldbereturnedtotheconsumer.Youcan
specifyintableentry8thatthecardisreturnedimmediatelyor
aftertheSSThasreceivedaTransactionReplycommandfrom
Central

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-6

APTRA Advance NDC, Reference Manual

State Tables
A - Card Read State

ThenextstatenumbertheSSTgoestoifthefinancialinstitution
IDonthecarddoesnotmatchanyFITentry
ThenextstatenumbertheSSTgoestoifthecardisasmartcard,
andthereadconditionbeingevaluatedhasthechipconnectbit
set.

Ifanattemptedcardejectfailsduringtheabovestateprocessing,the
cardiscapturedandscreenC04isdisplayedforthetimespecified
bytimer02.Fordetailsofreservedscreens,seetheCCardholder
DisplaysectioninChapter 3,ScreenData.Fordetailsoftimers,
seetheConfigurationParametersLoadsectioninChapter 10,
CentraltoTerminalMessages.
Ifthecardreadconditionsarenotsatisfiedduetoaninvalidcardor
amechanismerror,thecardisejectedandscreenC02isdisplayed.
Aftertwoattemptsatejectingthecard,AdvanceNDCtriesto
capturethecard.Ifthecardreaderjamsduringcardcapture,
AdvanceNDCreportsanunsolicitedstatusmessage(cardjam
duringcapture)withafatalseveritystatus.
Iftheconsumerdoesnottakethecardbeforetimer09expires,the
SSTcapturesthecard.Whenaninvalidcardisremovedbythe
consumerorcapturedbytheSST,thecardreaderisenabledforthe
nextcardentry.
Ifyouhavespecifiedintableentry8thatthecardshouldbe
returnedimmediately,thetransactionwillproceedtothenext
definedstatefollowingcardremoval.However,ifthecardis
capturedafteraneject,thecardreaderisenabledforthenextcard
entry.
Note:Ifthechipconnectbitistobesetforusewiththe
EMV/CAM2ExitsforAdvanceNDCproduct,NCRrecommends
thisissetinthefinalreadconditionused,topermitthemagnetic
readconditionstobefullytestedfirst.
Ifamagneticreadconditionismet,thestatewillattempttomatch
therelevantcarddatatotheFITdata.
Ifthemagneticreadconditionsallfailandthechipconnectbitisset,
noFITmatchisattemptedandtheapplicationproceedstotheNo
FITMatchNextState.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-7

State Tables
A - Card Read State
Table 2-3
A - Card Read State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoenter
thecard.WhiletheSSTiswaitingforcardentry,
thisscreenisdisplayed.

GoodReadNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoes:
1.FollowingagoodreadofthecardifFITsarenot
used(Tableentry9=000)
or
2.IftheFinancialInstitutionnumberonthecard
matchesaFinancialInstitutionnumberinaFIT.

Error(Misread)ScreenNumber
(Range000999)

Ifthereadconditionsarenotsatisfiedduetoabad
cardoramechanismerror,thecardisejectedand
thisscreenisdisplayed.

ReadCondition1

ReadCondition2

ReadCondition3

Thesethreeentriesspecifywhichcardtrack(s)
and/orchipdatawillberead.Thepossiblevalues
fortheseentriesareshowninTable 24inthenext
section.

CardReturnFlag

TellstheSSTwhenthecardshouldbereturnedto
theconsumer:
000ejectthecardimmediately.
001returnthecardasspecifiedbyaTransaction
Replycommandmessage.

NoFITMatchNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifeitherthe
FinancialInstitutionnumberonthecarddoesnot
matchanyFIT,orifthecardreaderisasmartcard
readerandthereadconditionbeingevaluatedhas
thechipconnectbitset(bit3).
IfFITsarenotused,thisentrymustbe000.

ReadConditionValues

Table 2-4
Read Condition Bit Information

Thefollowingtable,ReadConditionBitInformationshowswhich
tracksarereadwheneachbitissetinthereadcondition.The
decimalvaluesshowncorrespondtothestatetableentries
describedinTable 23,ACardReadState.
Bit Number

Binary

Decimal

Meaning

0001

001

ReadTrack3

0010

002

ReadTrack2

1and0

0011

003

ReadTrack2and3

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-8

APTRA Advance NDC, Reference Manual

State Tables
A - Card Read State
Bit Number

Binary

Decimal

Meaning

0100

004

ReadTrack1

2and0

0101

005

ReadTrack1and3

2and1

0110

006

ReadTrack1and2

2,1and0

0111

007

Alltracks

1000

008

Chipconnectreadsmartdata

47

Reserved

Areadconditionwillfailifitissettoadecimalvalueoutsidethe
rangeshown.
Readconditionsareevaluatedinorder.Foranexampleofthe
evaluationprocessformagneticonlyreadconditions(thatis,none
ofthereadconditionshasthechipconnectbitset),seethegraphic
ReadConditionFlowonpage 210.Forreadconditionoperations
wherethechipconnectbitissetinoneormorereadconditions,see
Chapter 12,EMVSmartCardHandling.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-9

State Tables
A - Card Read State
Figure 2-1
Read Condition Flow

Evaluate Read
Condition 1

Y
Satisfied?

N
Evaluate Read
Condition 2

Good Read Next State Number


(table entry 3)

Satisfied?

N
Evaluate Read
Condition 3

Y
Satisfied?

N
Error Screen Number (table
entry 4)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-10

APTRA Advance NDC, Reference Manual

State Tables
B - PIN Entry State

BPINEntryState

TheSSTshouldnotenterthisstateunlesstheFinancialInstitution
numberonthecardmatchesaFinancialInstitutionnumberinaFIT
duringtheCardReadstate.Fordetails,seeChapter 8,Financial
InstitutionTables.Thisstatedoesnothavetobethenextstateafter
theCardReadstate.
WhenspecifiedintheFIT,PINverificationcantakeplaceateither
theSSTorCentral.IfverifiedatCentral,thePINistransmittedinan
encryptedform.IflocalDESPINverificationisspecifiedintheFIT
andnoDESencryptorisavailable,theMaximumBadPINsNext
Stateexitistaken.IfDESencryptedPINtransmissionisspecifiedin
theFITandnoDESencryptorisavailable,anemptyPINbufferfield
isincludedintheTransactionRequestmessage.
IftheconditionsspecifiedintheFITDataLoadmessage(detailed
onpage 1021)forlocalPINverification,remotePINencryptionand
indirectnextstateprocessingarenotmet,PINverificationwillfail
andtheMaximumBadPINsNextStateexitistaken.
TheconsumerentersthePIN,whichcanconsistoffourtosixteen
digits,onthefaciakeyboard.Iftheconsumerentersfewerthanthe
numberofdigitsspecifiedintheFITentry,PMXPN,theconsumer
mustpressFDKA(orFDKIifthekeystotheleftoftheconsumer
screenareenabled)ortheEnterkeyafterthelastdigithasbeen
entered.PressingtheClearkeyclearsalldigits.
Table 2-5
B - Pin Entry State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoenter
thePINthefirsttime.Thisscreen,whichis
displayedonenteringthePINEntrystate,must
leavetheconsumerscreencursoratthestartofthe
PINEntrydisplayarea.AnXisdisplayedforeach
keypressed.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
doesnotenterthePINwithinthepermittedtime
limit.Enter255ifthetimeoutfunctionisnot
required.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-11

State Tables
B - PIN Entry State
Table
Entry

Number of
Characters

Contents

Description

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
pressestheCancelkeybeforethemaximumnumber
ofdigitsspecifiedforthePINhavebeenentered.

LocalPINCheckGoodPIN
NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)
SeeTableNote2.

StatenumbertowhichtheSSTgoesafter
verificationofacorrectPINentry.APreSet
OperationCodeBufferstate(clearingthefunction
keybufferbeforeTransactionSelection)usually
followsacorrectPINentry.

LocalPINCheckMaximumBad
PINsNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)
SeeTableNote1,TableNote2.

StatenumbertowhichtheSSTgoesifthecorrect
PINhasnotbeenenteredafterthenumberof
attemptsallowedbytableentry9.TheSST
normallyentersaClosestateifthisoccurs.

LocalPINCheckErrorScreen
Number
(Range000999)
SeeTableNote1,TableNote2.

Displayscreenthatpromptstheconsumerto
reenterthePIN.Thisscreenisdisplayedaftereach
incorrectPINentryattempt.AnXisdisplayedfor
eachkeypressed.Afterthenumberofreentry
attemptsallowedbytableentry9,theSSTenters
thestatedeterminedbytableentry6.

RemotePINCheckNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoeswhenlocalPIN
verificationisnotperformed.

LocalPINCheckMaximumPIN
retries
(Range001009)
SeeTableNote1,TableNote2.

MaximumnumberofincorrectPINentriesallowed
beforetheSSTentersthestatedeterminedbytable
entry6.

TableNote1:TheseLocalPINfields(6,7and9)arealsoused
whentheCheckRemotePINminimumlengthoptionisused;they
areusedinthesamewayasforLocalPINverification.Anincorrect
PINisonewhichislessthantheminimumlength.
AstheseLocalPINfieldscanbeusedwithRemotePINverification,
theymustcontainvalidentrieswheneitherRemoteorLocalPIN
verificationisused.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-12

APTRA Advance NDC, Reference Manual

State Tables
B - PIN Entry State

TableNote2:TosupportsecurePINencryption,fields5,6,7and9
mustalwaysbesetup,astheyareusedtocontrolthenumberof
allowedPINretrieswhenfewerthanfourPINdigitsareentered.
WithsecurePINencryption,acheckfortheminimumfourPIN
digitsisperformedregardlessofwhethertheFITspecifiestocheck
forshorterPINsornot.
ForFITdatadetails,seeChapter 8,FinancialInstitutionTables.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-13

State Tables
C - Envelope Dispenser State

CEnvelopeDispenserState

UsethisstateifyourSSThasanenvelopedispenser.Ifthestateis
enteredonanSSTwithoutthedispenser,itperformsnoactionand
takesthenextstateexitimmediately.OnanSSTwithanenvelope
dispenser,anenvelopeispresentedbeforetheexitistaken.Ifthe
envelopeispresentedsuccessfully,theMEIisswitchedonwherea
combinedenvelopedispenseranddepositoryMEIispresent.The
MEIisswitchedoffwhentheenvelopeistakenorretracted.Ifthe
envelopeisnottakenbytheconsumer,itisretractedwhentheSST
enterstheClosestate.
Note:InAdvanceNDC,anenvelopeisdispensedwhenthe
TransactionReplycommandmessageisprocessedifanenvelope
hasnotpreviouslybeendispensedintheEnvelopeDispenserstate.
AdvanceNDCdoesnotattempttodispenseenvelopesunless
envelopesarepresentinthedispenser.
Table 2-6
C - Envelope Dispenser State
Table
Entry

Number of
Characters

Contents

Description

StateType

NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTentersimmediatelyor
afteranenvelopeispresented.

39

21

Mustbe000.

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-14

APTRA Advance NDC, Reference Manual

State Tables
D - Pre-Set Operation Code Buffer State

DPreSetOperationCodeBuffer
State

ThisstatewilleithercleartheOperationCodebufferbyfilling
selectedbytes(toamaximumofeight)withthegraphiccharacter
space,oritwillpresetthebufferwithgraphiccharactersA,B,
C,D,F,G,HorI.Thesecharacterscorrespondtotheeight
FunctionDisplayKeys.
Table 2-7
D - Pre-set Operation Code Buffer State
Table
Entry

Number of
Characters

Contents

Description

StateType

NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesafter
presettingtheOperationCodebuffer.

ClearMask
(Range000255)

SpecifiesbytesofOperationCodebuffertobe
clearedtographicspace.Eachbitrelatestoabyte
intheOperationCodebuffer.Ifabitiszero,the
correspondingentryiscleared.Ifabitisone,the
correspondingentryisunchanged.
SeeTableNote3.

APreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoA.Ifabitisone,the
correspondingentryissettoA.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

BPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoB.Ifabitisone,the
correspondingentryissettoB.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

CPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoC.Ifabitisone,the
correspondingentryissettoC.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-15

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

Number of
Characters

Contents

Description

DPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoD.Ifabitisone,the
correspondingentryissettoD.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

Mustbe000.

Reserved

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberoftheExtensionstatecontaining
informationonhowtheotheroperationcodesare
preset.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

Table 2-8
Extension to State D
Table
Entry

Number of
Characters

Contents

Description

StateType

FPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoF.Ifabitisone,the
correspondingentryissettoF.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

GPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoG.Ifabitisone,the
correspondingentryissettoG.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

HPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoH.Ifabitisone,the
correspondingentryissettoH.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

IPreSetMask
(Range000255)

Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoI.Ifabitisone,the
correspondingentryissettoI.Ifabitiszero,the
correspondingentryisunchanged.
SeeTableNote3.

69

12

Mustbe000.

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-16

APTRA Advance NDC, Reference Manual

State Tables
D - Pre-Set Operation Code Buffer State

TableNote3:Theeightbitsrepresentthebinaryequivalentoftheir
respectivemasks.Bit0relatestothefirstentry,bit7relatestothe
eighthentry.Forexample,inthefollowingmask,
b7

b6

b5

b4

b3

b2

b1

b0

thethreedecimalcharactersinthetableentryare042.Thebytesin
theOperationCodebuffermodifiedare2,4and6.
TheOperationCodebufferissetintheorder:
space,A,B,C,D,F,G,HandI.
Therefore,ifalatervaluesetsthesamebit,itwillbetheonethatis
preset.
Forexample,F=042andI=006resultsinthefollowingOperation
Codebuffer:
_IIF_F__
whileF=042andI=004resultsinthefollowing:
_FIF_F__
Inthisexample,_representsaspacecharacter.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-17

State Tables
E - Four FDK Selection Function State

EFourFDKSelectionFunctionState

ThisstatereadswhichoneofthefourFDKs(FunctionDisplayKeys)
totherightoftheconsumerscreen(A,B,CorD)hasbeen
selectedbytheconsumer.
YoucanenablethefourFDKstotheleftofthescreen(I,H,G
andF),insteadofthefourtotheright,bysettingoptiondigit7a.
Forinformationonoptiondigits,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
EnablingthefourkeystotheleftofthescreenmeansthatkeysI,
H,GandFassumethefunctionalityofkeysA,B,CandD
respectively.Iftheconsumerselectsoneofthesekeys,thekeycode
forthatfunctionisstoredintheOperationCodebufferaskeyAto
D.Thetransactionthengoestothenextstate.
InTable 29,EFourFDKSelectionFunctionStateonpage 219,
entries5to8definewhichFDKsaretobeactiveduringthisstate.If
youneedtouseanyotherFDK,youshouldusetheEightFDK
SelectionFunctionstatetable.
TheSSTmaysupportTouchScreenFDKEmulationinsteadof
regularFDKs.Inthiscase,eightfixedtouchareasaredefinedonthe
screen,whichtheconsumertouchesinsteadofpressingthe
correspondingFDK.Thetouchareasareenabled/disabledinexactly
thesamewayastheFDKs.Fordetails,seetheFDKEmulation
sectioninChapter 4,KeyboardDataandLayouts.
Alternatively,theSSTmaysupportfulltouchscreenkeyboards.In
thiscase,touchareasaredefinedonthescreenforalltherequired
keys.Theconsumertouchestheseinsteadofpressingakeyonthe
keypadoranFDK.Fordetails,seeChapter 4,KeyboardDataand
Layouts.
Note:Foravoiceguidedsession,thisstatechecks
AudioGuidanceData.xmltoidentifythenumerickeysusedto
representtheFDKs.IftheconsumerchoosestoturnontheHide
Screenoption,theFDKsaredisabledforallentrystates.IftheHide
Screenoptionisoff,boththeFDKsandnumerickeysareactive.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-18

APTRA Advance NDC, Reference Manual

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

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatrequeststheconsumerto
choosebetweentransactiontypes,accountnames,
andsoon.Thisscreenmustbealignedwiththe
activeFDKs,andisdisplayedwhentheSSTenters
theFourFDKSelectionFunctionstate.Fordetails,
seetheCCardholderDisplaysectionin
Chapter 3,ScreenData.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
doesnotrespondtothescreenmessagewithinthe
permittedtimelimit.Enter255ifthetimeout
functionisnotrequired.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancel
keyispressed.

FDKA(orI)
NextStateNumber

FDKB(orH)
NextStateNumber

StatenumbertowhichtheSSTgoesifthespecified
FDKortouchareaispressed.
(Base10range000254or256999)
(Base36range000254or256ZZZ)
Enter255todeactivateanyFDKortoucharea.

FDKC(orG)
NextStateNumber

FDKD(orF)
NextStateNumber

BufferLocation
(Range000007)

DefinestheOperationCodebufferbyteinwhich
thekeycodefortheselectedFDKisstored.
EntryValue

PositioninBuffer

000
001
002
003
004
005
006
007

1stbyte
2ndbyte
.
.
.
.
.
8thbyte

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-19

State Tables
F - Amount Entry State

FAmountEntryState

Thisstatereadstheamountenteredbytheconsumer,displaysiton
theconsumerscreen,andsavesitintheAmountbuffer.The
standardfieldlengthforthisbufferiseightdigits,ortwelveif
EnhancedConfigurationParameteroption1isused;butthebuffer
lengthcanalsobeconfiguredforanynumberofcharactersuptoa
maximumoftwelve,throughaparameterinAppendBuffer.xml.
Note:Ifyourequiremultilingualsupportforamountentry,seeR
EnhancedAmountEntryStateonpage 255.
TheSSTexitsfromtheAmountEntrystateoncetheconsumer
pressesanactiveFDKortheCancelkey.Italsoexitsfromthisstateif
theconsumerdoesnotpressakeywithinthespecifiedtimelimit.
Fordetailsoftimers,seetheConfigurationParametersLoad
sectioninChapter 10,CentraltoTerminalMessages.Ifthe
consumerpressestheEnterkey,ithasthesameeffectaspressing
FDKA(orFDKIifoptiondigit7aisset).Formoreinformation,
seeEFourFDKSelectionFunctionStateonpage 218.
IftheconsumerpressestheClearkey,whichisalwaysactive,the
amountbufferandthescreenechofieldareclearedonecharacterat
atime.Thisallowstheconsumertoreenterthecorrectamount.
Oncetheconfigurednumberofcharactersisreached,thenextkey
clearsthebuffer,resettingthevalueto0andrestartingtheentry
fromthebeginning.AparameterinAppendBuffer.xmlcanbe
configuredtopreventclearingoftheamountwhentheconfigured
limitisreached.
AppendBuffer.xmlcanbeupdatedasdescribedinXML
ConfigurationDownloadonpage 1046orinstalledlocally.For
detailsofAppendBuffer.xml,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
IftheSSTsupportstouchscreenFDKemulationinsteadofphysical
FDKs,eightfixedtouchareasaredefinedonthescreen,whichthe
consumertouchesinsteadofpressingthecorrespondingFDK.The
touchareasareenabledanddisabledinexactlythesamewayasthe
FDKs.Fordetails,seeFDKEmulationonpage 42ofChapter 4,
KeyboardDataandLayouts.
Alternatively,theSSTmaysupportfulltouchscreenkeyboards.In
thiscase,touchareasaredefinedonthescreenforalltherequired
keys.Theconsumertouchestheseinsteadofpressingakeyonthe
keypadoranFDK.Fordetails,seeChapter 4,KeyboardDataand
Layouts.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-20

APTRA Advance NDC, Reference Manual

State Tables
F - Amount Entry State

Note:Inavoiceguidedsession,keyboardechoingisavailablebut
.wavfilesarenotsupportedforamountentryechoing.
Table 2-10
F - Amount Entry State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertomake
anamountentry.Thisscreenisdisplayedwhenthe
SSTenterstheAmountEntrystate.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheamount
entryisnotmadewithinthepermittedtimelimit.
Enter255ifthetimeoutfunctionisnotrequired.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancel
keyispressed.

FDKA(orI)
NextStateNumber

FDKB(orH)
NextStateNumber

FDKC(orG)
NextStateNumber

FDKD(orF)
NextStateNumber

StatenumbertowhichtheSSTgoesiftheconsumer
pressesanFDKortoucharea.NormallyoneFDK
ortouchareaisdesignatedforcorrectamount
entriesandanotherforincorrectamountentries.
TheremainingtwoFDKsortouchareasare
inactive.
(Base10range000254or256999)
(Base36range000254or256ZZZ)
Enter255todeactivateanFDKortoucharea.

AmountDisplayScreen
Number
(Range000999)

Overlayscreenforsettingtheconsumerscreen
cursorposition.SeeTableNote4
Additionalzeroescanbeaddedautomaticallyto
theamountbuffer.SeeTableNote5.
Thedefaultechofieldforeightdigitsis:
bbbbb$b0.00
whereb=space.
Thedefaultechofieldfortwelvedigitsis:
bbbbbbbbb$b0.00
whereb=space.

TableNote4:Thisscreenoptionallydefinestheinitialdisplay
formatbeforeamountentrybytheconsumer.Thecursorshouldbe
setonthelefthandsideoftheechofieldonthescreen.Thisisspace
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-21

State Tables
F - Amount Entry State

filleduntiltherequiredstartpositionforthecurrencycharacteris
reached.Fordetails,seeInternationalCurrencyDisplayFormat
onpage344.
TableNote5:Ifrequiredbythehost,thescreencanbeconfigured
toaddextrazerosautomaticallytotheamountbuffer,afterthe
decimalpoint.ThisconfigurationisdefinedintheAppendBuffer.xml
file,whichcanbeupdated,asdescribedinXMLConfiguration
Downloadonpage 1046,orinstalledlocally.Fordetailsof
AppendBuffer.xml,refertotheAPTRAAdvanceNDC,Developers
Guide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-22

APTRA Advance NDC, Reference Manual

State Tables
G - Amount Check State

GAmountCheckState

Thisstatecheckswhethertheamountenteredcanbedispensed.
Thisdoesnotcheckforcoins.Twochecksareperformed:

Whethertheamountheldwithinaspecifiedbufferisamultiple
ofanidentifiedvalue.
Whethertheamountheldwithinaspecifiedbufferis
dispensablewhentakingintoaccountthecurrencyrequired,
denominationsavailable,dispenserstatusandcassettestatus.
Notecountsareignored.

Note:Fordualcashhandlers,thisstateisnotsupportedwhenthe
AmountCheckCondition(Range000003)onpage 225issetto
003.
Tobeabletocheckthatanamountisdispensable,Centralmust
havedownloadedtheDispenserCurrencyCassetteMappingTable,
whichassociatesthecurrencytype,cassettetypeanddenomination
forthehostandSST(seepage 1043).Ifthistablehasnotbeen
downloaded,oracurrencytypeidentifiedintableentry7belowis
notpresentintheDispenserCurrencyCassetteMappingTable,
processingwillgotothedefaultClosestate.
Whendebugging,youcanviewthereasonforafailureofthisstate
intheDebugLogwindow.Forexample,aninvalidlength/valuein
theDispenserCurrencyCassetteMappingtablewillcauseanerror
tobedisplayed,specifyingtheinvalidvalue,fieldandposition.The
possibleerrors/causesaregivenafterthisstatetable.
Note1:OnlyuseDebugLogwhendebugging,notinaliveSST
environment.
Note2:TheXFScurrencydenominationsconfiguredintheCash
Dispenserserviceproviderarenotconsideredbythisstate.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-23

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

Number of
Characters

Contents

Description

StateType

AmountCheckConditionTrue
NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoeswhenthe
amountcheckconditionindicatedbytableentry8
evaluatestoTRUE.

AmountCheckConditionFalse
NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoeswhenthe
amountcheckconditionindicatedbytableentry8
evaluatestoFALSE.

Buffertobechecked
(Range000002)

Thisfieldspecifieswhichbufferistobechecked:
000Amountbuffer
001BufferB.
002BufferC.
IfBufferBorCcontainsmorethan12digits,the
amountcheckconditionevaluatestoFALSE.

IntegerMultipleValue
(Range000999)

Integermultiplevalueusedincheckingspecified
buffer.
Forexample,tocheckthatthespecifiedbuffer
containsamultipleoftheminimumdenomination
$5,thisfieldwouldbesetto005.
Thisfieldisignorediftableentry8isnot002.

NumberofDecimalPlaces
(Range000004)

Numberofdecimalplacesusedinspecifiedbuffer.
Forexample,$5issentas500cents,sohas002
decimalplaces.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-24

APTRA Advance NDC, Reference Manual

State Tables
G - Amount Check State
Table
Entry

Number of
Characters

Contents

Description

CurrencyType
(Range001255)

Currencytypeofamountinspecifiedbuffer.
UsedinconjunctionwiththeDispenserCurrency
CassetteMappingTable.
Thisfieldisignorediftableentry8isnot003.

AmountCheckCondition
(Range000003)

Amountcheckconditionrequired.
IftheconditionisTRUE,processinggoestothenext
stateidentifiedintableentry2.
IftheconditionisFALSE,processinggoestothe
nextstateidentifiedintableentry3.
Allconditionscheckthebufferindicatedbytable
entry4,andtakeaccountofthedecimalpoint
locationintableentry6.Thestateevaluatesthe
valuesasfollows:

000whetherthevaluetotherightofthe
decimalpointpositioniszero.

001andwhetherthevalueiszero,orif
BufferBorCcontainsmorethan12digits.

002andwhetherthevalueisawhole
numbermultipleofthevalueidentifiedintable
entry5.

003whetherthevalueisdispensablebythe
SST,takingintoaccounttheDispenser
CurrencyCassetteMappingTableentries,
currencytyperequired(tableentry7),the
currencytypedenominationsavailable,
dispenserstatusandcassettestatus.

Mustbe000.

Reserved

Thefollowingtableliststhepossibleerrorsassociatedwiththe
AmountCheckstate,whichyoumayseeinDebugLog.Thecauses
foreacherrorarealsoincluded,toassistincorrectingtheerror.
Table 2-12
Amount Check Error State
Error Message

Cause(s)

AmountCheckStateFAILEDNonwhole
amountentered

1)Anonwholeamounthasbeenentered
2)TheAmountCheckstateischeckingthewrongbuffer.For
example,theAmountenteredisstoredinbufferB,butthe
AmountCheckstatespecifiesbufferCistobecheckedintable
entry4

AmountCheckStateFAILEDAmount
entered=0

Amountenteredis0

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-25

State Tables
G - Amount Check State
Error Message

Cause(s)

AmountCheckStateFAILEDBufferB
containsmorethan12digits

ThelengthofbufferBismorethan12digitsinlength

AmountCheckStateFAILEDBufferC
containsmorethan12digits

ThelengthofbufferCismorethan12digitsinlength

AmountCheckStateFAILEDXisnota
wholenumbermultipleofY

XisnotawholenumbermultipleofY,whereXistheamount
entered,andYistheIntegerMultipleValuespecifiedintable
entry5

AmountCheckStateFAILEDCurrency
TypeXnotfoundinDispenserCurrency
CassetteMappingTableProceedingto
DefaultCloseState

TheCurrencyTypeXwasnotfoundintheDispenserCurrency
CassetteMappingTable,whereXistheCurrencyTypespecified
intableentry7.Possiblecausesare:
1)TheDispenserCurrencyCassetteMappingTablehasnotbeen
downloaded
2)CurrencyTypeXcouldnotbefoundintheDispenser
CurrencyCassetteMappingTable

AmountCheckStateFAILEDAmount
requestedcannotbesatisfiedfromphysical
cassettetypespresent

ANoteMixfortheamountrequestedcannotbecreatedbecause:
1)Morethan50notesarerequired
2)Theamountcannotbecreatedfromthedenominations
specifiedintheDispenserCurrencyCassetteMappingTable
3)Thecassette(s)containingthedenominationsrequiredforthe
NoteMixhaveabadstatus

AmountCheckStateFAILEDNovalid
entriesfoundintheDispenserCurrency
CassetteMappingTable

TherearenoCassetteTypesspecifiedintheDispenserCurrency
CassetteMappingTablewhichareinthecurrentlysupported
rangeof14

AmountCheckStateFAILEDCash
Handlerdeviceerror

TheCashHandlerhasastatusofFATALorSUSPEND

Youmayalsoseethefollowingerrors,associatedwiththe
DispenserCurrencyCassetteMappingTable:
Table 2-13
Amount Check Error State DCCMT
Error Message

Cause(s)

ERRORInvalidlengtherrorfoundinDispenser
CurrencyCassetteMappingTable

ThespecificcommandrejectreceivedbyCentral
indicatesamessagelengtherror

ERRORInvalidValue<fieldh1value>foundin
fieldh1ofDispenserCurrencyCassetteMapping
Table

Thevalueofsubfieldh1mustbeatwodigitASCIIhex
valueintherange01toFFinclusive.Ifitisnot,the
commandrejectB08Fieldvalueerror,datafieldvalue
outofrangeisreturned.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-26

APTRA Advance NDC, Reference Manual

State Tables
G - Amount Check State
Error Message

Cause(s)

ERRORInvalidValue<fieldh2value>foundin
fieldh2(atposition<value>)ofDispenser
CurrencyCassetteMappingTable

Thevalueofsubfieldh2mustbeatwodigitASCIIhex
valueintherange01toFFinclusive.Ifitisnot,the
commandrejectB08Fieldvalueerror,datafieldvalue
outofrangeisreturned.TheerroroutputtotheDebug
LoggivesthepositionoftheerrorintheDispenser
CurrencyCassetteMappingTablemessage.Thevalue
givenisthenumberofcharactersfromthebeginningof
themessagetowherethesubfieldstarts.

ERRORInvalidValue<fieldh3value>foundin
fieldh3(atposition<value>)ofDispenser
CurrencyCassetteMappingTable

Thevalueofsubfieldh3mustbeasingledigitASCIIhex
valueintherange0toFinclusive.Ifitisnot,the
commandrejectB08Fieldvalueerror,datafieldvalue
outofrangeisreturned.TheerroroutputtotheDebug
LoggivesthepositionoftheerrorintheDispenser
CurrencyCassetteMappingTablemessage.Thevalue
givenisthenumberofcharactersfromthebeginningof
themessagetowherethesubfieldstarts.

ERRORInvalidValue<fieldh4value>foundin
fieldh4(atposition<value>)ofDispenser
CurrencyCassetteMappingTable

Thevalueofsubfieldh4mustbeafivedigitASCII
numericvalueintherange00000to99999inclusive.Ifit
isnot,thecommandrejectB08Fieldvalueerror,data
fieldvalueoutofrangeisreturned.Theerroroutputto
theDebugLoggivesthepositionoftheerrorinthe
DispenserCurrencyCassetteMappingTablemessage.
Thevaluegivenisthenumberofcharactersfromthe
beginningofthemessagetowherethesubfieldstarts.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-27

State Tables
H - Information Entry State

HInformationEntryState

Inthisstate,datacanbeenteredusingoneoracombinationofthe
following:

DataEntry

ThenumerickeypadfordigitsorSMSstylealphanumericdata
entry
APCkeyboard
FDKs(FunctionDisplayKeys)oremulatedtouchscreenFDKs
Fulltouchscreenkeyboardsforalphanumericdataentry

Whentheconsumerentersdata,thisstatereadsinthedataand
savesitinoneoftwogeneralpurposebuffers.Youspecifyintable
entry9whichbufferistobeused,andwhethertheactualdatathe
consumerentersisdisplayedonscreen,orifXisdisplayedfor
eachkeypressed.

DataEntryandVoiceGuidance

Iftheconsumerhasselectedavoiceguidedsession,thefollowing
pointsmustbeconsidered:

ExitingtheInformation
EntryState

IftheentereddataismaskedwithXonthescreeninthisstate,
theSSTwillechokeyselectionwithabeeponly
IftheHideScreenoptionisselectedbytheconsumer,entered
dataisnotdisplayedbutonlyechoed,exceptwhenmaskedwith
X
IfthisstaterequiresbothFDKsandnumerickeys,the
voiceguidedsessioncannotmaptheFDKstothenumeric
keypad.

TheSSTexitsfromtheInformationEntrystateoncetheconsumer
pressesanactiveFDKortheCancelkey.Italsoexitsfromthisstateif
theconsumerdoesnotpressakeywithinthespecifiedtimelimit.If
theconsumerpressestheEnterkey,ithasthesameeffectas
pressingFDKA(orFDKIifoptiondigit7aisset).Fordetails,see
EFourFDKSelectionFunctionStateonpage 218.

EmulatedFDKsandTouchscreenKeyboards

TheSSTmaysupporttouchscreenFDKemulationinsteadof
physicalFDKs.Inthiscase,eightfixedtouchareasaredefinedon
thescreen,whichtheconsumertouchesinsteadofpressingthe
correspondingFDK.Thetouchareasareenabled/disabledinexactly
thesamewayastheFDKs.Fordetails,seetheFDKEmulation
sectioninChapter 4,KeyboardDataandLayouts.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-28

APTRA Advance NDC, Reference Manual

State Tables
H - Information Entry State

Alternatively,theSSTmaysupportfulltouchscreenkeyboards,
withtouchareasdefinedonthescreenforalltherequiredkeys.The
consumertouchestheseinsteadofpressingakeyonthekeypador
anFDK.Fordetails,seeChapter 4,KeyboardDataandLayouts.
Forinformationaboutconfiguringconsumerdataentryandthe
touchscreensamplekeyboardsprovidedwithAdvanceNDC,refer
tochapter5,ConfiguringAdvanceNDCandAssociated
ComponentsoftheAPTRAAdvanceNDCDevelopersGuide.

ClearFunctionKeyand
GeneralPurposeBuffers

TheClearfunctionkeyisalwaysactive.Iftheconsumerpressesthe
key,thegeneralpurposebufferandtheechofielddisplayedonthe
consumerscreenarecleared.Theconsumercannowreenter
information.
Thegeneralpurposebufferscanholdamaximumof32bytesof
data.WhentheSSTexitsfromtheInformationEntrystate,the
bufferspecifiedintableentry9containsthedatathattheconsumer
hasentered.Iftheconsumerhasnotenteredanydata,thebuffer
willbeempty.Fordetailsofthegeneralpurposebuffersrefertothe
APTRAAdvanceNDC,DevelopersGuide.
Note:Fornumericdataentryusingthenumerickeypad,ifthe
amountenteredexceedsthe32bytelimit,thenextkeypressclears
thebuffer,resettingthevalueto0andrestartingtheentryfromthe
beginning.
Tableentry9cansupportalphanumericdataentryusingaPC
keyboard,atouchscreenorthenumerickeypadforshortmessage
service(SMS)styledata.Defaultconfigurationsaresuppliedin
NDCKeyboard.XML,whichcanbereconfigured.Foralphanumeric
dataentry,whenthemaximuminputsizeisreached,anykeys
pressedwillgenerateabeep,butthecursorisnotdisplayed.
Note:FornumerickeypadentryandPCkeyboardentry,although
theconsumercanenterupto32charactersduringtheInformation
Entrystate,only30characterscanbeechoedonthescreenwhenX
isdisplayed.Thisisduetointernalrestrictions.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-29

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

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoenter
data.Thisscreenisdisplayedonenteringthe
InformationEntrystate,andmustleavethecursorat
thestartofthedisplayarea.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
doesnotrespondtotheconsumerscreenmessage
withinthepermittedtimelimit.Enter255ifthe
timeoutfunctionisnotrequired.SeeTableNote6.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancelkeyis
pressed.

FDKA(orI)
NextStateNumber

FDKB(orH)
NextStateNumber

FDKC(orG)
NextStateNumber

StatenumbertowhichtheSSTgoesiftheconsumer
pressesanFDKortoucharea.Enter255tomakean
FDKortouchareainactivewhiletheSSTisinthe
InformationEntrystate.
(Base10range000254or256999)
(Base36range000254or256ZZZ)

FDKD(orF)
NextStateNumber

EntryMode,Bufferand
DisplayParameters
(FormatNND,
RangeNN=00and0132,
RangeD=03)

EntryMode:
NN=00Numerickeyentry,maximuminputsize32.
NN=0132:SMSstyle,PCkeyboardand
touchscreenkeyboardalphanumericentry.Maximum
inputsizeisNN.SeeTableNote7.
Buffer:
Defineswhichbuffertouseforstorage
generalpurposebufferBorgeneralpurposebufferC
Display:
Defineswhethertheinputdataistobedisplayedon
theconsumerscreen,ormasked.Thedisplaybegins
fromthecurrentcursorposition.Bufferanddisplay
parametersareasfollows:SeeTableNote8.
D=0DisplayXforeachnumerickeypressed.Store
dataingeneralpurposebufferC.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-30

APTRA Advance NDC, Reference Manual

State Tables
H - Information Entry State
Table
Entry

Number of
Characters

Contents

Description

D=1Displaydataaskeyedin.Storedataingeneral
purposebufferC.
D=2DisplayXforeachnumerickeypressed.Store
dataingeneralpurposebufferB.
D=3Displaydataaskeyedin.Storedataingeneral
purposebufferB.
SeeTableNote9.

TableNote6:Whenatimeoutoccurs,theconsumerisasked
whethermoretimeisneeded.Iftheresponseisyes,theconsumer
canenterdataagain,butallpreviouslyentereddataislost.
TableNote7:Ifrequired,theSMSstylealphanumerickeyboard
layoutcanbeinstalledorconfiguredeitherbyediting
NDCKeyboard.xmlanddownloadingitduringsoftwaredistribution,
orbyusingtheXMLconfigurationdownloadmessage,describedin
XMLConfigurationDownloadonpage 1046.Fordetailsof
NDCKeyboard.xml,refertotheAPTRAAdvanceNDC,Developers
Guide.
TheXMLschemadefinitionprovidedwithAdvanceNDCisusedto
validatetheXMLfile.IftheXMLfileisnotvalid,AdvanceNDC
goestothedefaultClosestate.
TableNote8:AdvanceNDCdoesnotsupportmaskingof
charactersforSMSstyleentry,onlyforPCkeyboardentry.
TableNote9:WhenusedinstateH,thebufferidentifieswherethe
inputdataisstoredforfurtherprocessing,thatis,inthetransaction
requestsenttothehost.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-31

State Tables
I - Transaction Request State

ITransactionRequestState

ThisstatesendsaTransactionRequestmessagetoCentral,and
executestheTransactionReplycommandreceivedfromCentral.
TheinformationtobeincludedintheTransactionRequestmessage
isdefinedinthefollowingtable.Formoredetails,seethe
TransactionRequestMessagessectioninChapter 9,Terminalto
CentralMessages.
OnanSSTwithdigitalaudiocapabilityandautovoiceenabled,
message1isplayedwhenaTransactionRequestmessageissentto
Central.Fordetails,seeVoiceonpage 321.
Table 2-15
I - Transaction Request State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenshownontheconsumerscreen
whiletheSSTsendsaTransactionRequestto
CentralandwaitsforaTransactionReply
command.ThisisusuallyaPleaseWaitscreen.

CentralResponseTimeoutNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifCentralfails
toreplytotheTransactionRequestwithinthe
permittedtimeinterval(timer03).

SendTrack2Data

SeeTableNote10.

SendTrack1and/orTrack3Data

SeeTableNote11.

SendOperationCodeData

SeeTableNote10.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-32

APTRA Advance NDC, Reference Manual

State Tables
I - Transaction Request State
Table
Entry

Number of
Characters

Contents

Description

SendAmountData

SeeTableNote10.

SendPINBuffer(BufferA)Data/
SelectExtendedformat

SeeTableNote10andTableNote12.

SendGeneralPurposeBufferB
and/orGeneralPurposeBufferC
or
ExtensionStateNumber
(Base10range000003or
000254,256999)
(Base36range000003or
000254,256ZZZ)

Tosendthegeneralpurposebuffer,thefollowing
valuesapply:
000Sendnobuffers
001SendBufferB.
002SendBufferC
003SendBuffersBandC
004007Reserved
Iftheextendedformatisselectedintableentry8,
thisentryisanExtensionstatenumber.Formore
informationaboutextensionstates,seeExtension
Statesonpage 25.
SeeTableNote12.

TableNote10:Thefollowingvaluesdeterminewhetherornotthe
specifieddataisincludedinthecorrespondingTransactionRequest
messagefieldsenttoCentral:
Table 2-16
Track 2 Data Send Modifier

Value

Send Data

000

No

001

Yes

TableNote11:Thefollowingvaluesapplyonlytotableentry5,
anddeterminewhetherornotTrack1andTrack3dataareincluded
intheTransactionRequestmessagesenttoCentral:
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

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-33

State Tables
I - Transaction Request State

TableNote12:Theleastsignificantbitoftableentry8isusedto
indicateifBufferAistobesentintheTransactionRequestmessage.
Bit7isusedtoselectanextendedformatfortheTransaction
Requeststateparametertablewhichallowstableentry9toholdthe
statenumberoftheassociatedextensionstatenumber,asshownin
thefollowingtable:
Table 2-18
Table Entry 8 for Buffer A

Value

Description

000

Standardformat.DonotsendBufferA.

001

Standardformat.SendBufferA.

128

Extendedformat.DonotsendBufferA.

129

Extendedformat.SendBufferA.

WhenExtendedformatisselected,tableentry9hasitsmeaning
changedsothatitcanreferenceanExtensionstatenumber.When
thisisthecase,tableentry2oftheExtensionstatecontrolsthe
sendingofBuffersBandC.
Table 2-19
Extension 1 to State I
Table
Entry

Number of
Characters

Contents

Description

StateType

SendGeneralPurposeBuffersB
and/orC

Tosendthegeneralpurposebuffers,thesevalues
apply:
000Sendnobuffers
001SendBufferB.
002SendBufferC
003SendBuffersBandC

SendOptionalDataFields
A H
(Range000255)

Thisentryisbitencodedtocontrolthesendingof
individualoptionaldatafieldsintheTransaction
Requestmessage.Ifabitisset,thecorresponding
datafieldissent.Ifabitisclear,thedatafieldisnot
sent.
Bit

Field ID

1
2
3
4
5
6
7
8

A(Reserved)
B(Reserved)
C
D
E
F
G
H

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-34

APTRA Advance NDC, Reference Manual

State Tables
I - Transaction Request State
Table
Entry

Number of
Characters

Contents

Description

SendOptionalDataFields
I L
(Range000015)

Thisentryisasfortableentry3butthedatafields
areasfollows:

SendOptionalDataFieldsQ to
V,wanda
(Range000255)

SendOptionalData.
(Range000031)

Bit

Field ID

1
2
3
4
5
6
7
8

I
J
K
L
ReservedforM
ReservedforN
ReservedforO
ReservedforP

Thisentryisasfortableentry3butthedatafields
areasfollows:
Bit

Field ID

1
2
3
4
5
6
7
8

Q
R
S
ReservedforT
U
V
w(CashDepositData)
a(ChequeprocessorMICR/codeline)
SeeTableNote13andTableNote14

Thisentryisasfortableentry3butthedatafields
areasfollows:
Bit

Field ID

1
2
3
4
5
6

UserDataFields
b(Notesonescrowcounts)
Reserved
Reserved
e(Barcodedata)
g(Bunchchequedepositdata)
SeeTableNote13
Reserved
Reserved

7
8
7

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-35

State Tables
I - Transaction Request State
Table
Entry

Number of
Characters

Contents

Description

EMV/CAM2ProcessingFlag
(Range000003)

Thisentryisbitencodedtocontrolthelevelof
EMV/CAM2processingtobeperformed,as
follows:

ExtensionStateNumber
(Base10range000254,256999)
(Base36range000254,
256ZZZ)

Bit

Field ID

IndicateswhetherEMV/CAM2processing
istobeperformedasfollows:
0=DonotperformEMV/CAM2processing
(default)
1=PerformEMV/CAM2processing

Ifbit1isset,bit2indicateswhetherfullor
partialEMV/CAM2processingistobe
performedasfollows:
0=PerformfullEMV/CAM2processing
(default)
1=PerformpartialEMVProcessing.
IncludeEMV/CAM2bufferbutdonot
performanyEMVchipprocessing
SeeTableNote15

3
4
5
6
7
8

Reserved
Reserved
Reserved
Reserved
Reserved
Reserved

StatenumberofExtensionstate2.
Avalueof000disablesthisextension.
Ifavalueof255isusedforthisentry,the
applicationgoestothedefaultClosestate.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

TableNote13:ChequeProcessorbufferaandBunchCheque
Depositbuffergaremutuallyexclusive.Ifbothareset,bufferg
takesprecedenceandbufferaisnotincludedintheTransaction
Request.
TableNote14:IfChequeProcessorbufferaisusedtodeposita
bunchofcheques,thecodelinesarenotincludedintheTransaction
Request,thatis,theMICR/codelinedetectedfieldissetto0andthe
MICR/codelinefieldisempty.
TableNote15:Ifbit2(partialEMV/CAM2processing)isset,the
EMV/CAM2bufferissenttoCentralwithallcurrentlyknowndata
requestedbyCentralbutwithoutanyEMVpreauthorisation
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-36

APTRA Advance NDC, Reference Manual

State Tables
I - Transaction Request State

processingwiththechip.Themainpurposeistoallowadynamic
currencyconversion(DCC)transactiontotakeplace.Thisrequires
somechipinformationtobesenttoCentraltodecidewhetherto
offeraDCCtransactionandalsoallowCentraltoupdatethe
currencytypeandamountforthetransactionbeforesendingthem
tothechipduringEMVpreauthorisationprocessing.
Table 2-20
Extension 2 to State I
Table
Entry

Number of
Characters

Contents

Description

StateType

OfflineDeclineNextState
Number
Base10range000254,256999)
(Base36range000254,
256ZZZ)

StatenumbertheSSTgoestoif,duringa
chipbasedtransaction,thechiporSSTchoosesnot
togoonlinebutrequeststhatthetransactionis
declinedoffline.

39

21

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-37

State Tables
J - Close State

JCloseState

ThisstateterminatestheconsumerscurrentSSTsession.Alldata
elementsareclearedandvaluablemediasuchascardsandmoney
arehandledduringthisstate.

FunctionOperations

ProcessingoftheClosestatedependsonthefunctionaloperations
tobecompleted.

Receipts,StatementsandEnvelopes

Ifareceiptand/orstatementhasbeenprintedbutnotdelivered
duringapreviousTransactionRequeststate,itispresentedtothe
consumernow.Ifthecardhasnotbeenejectedorcaptured,itis
returnedorretaineddependingontheinstructioninthelast
TransactionReplymessage.Theappropriatemessagefromthose
specifiedinentries2,4,5and6ofTable 221isdisplayedonthe
consumerscreen.
Ifastatementispresentedandnottakenbytheconsumerthenafter
Timer02(page 723)hasexpiredandpriortostateexit,Timer95
(page 727)isstarted.Whenthistimerexpires,thestatementis
captured(thisdoesnotapplytoreceiptsidewaysprinting).Ifthe
statementistaken,thetimerisstopped.Whilethetimerisrunning
anduntilthenextstatementisstagedaftercapture,exitfromthe
Closestateisdelayed.Ifnostatementispresented,Timer95isnot
startedandexitfromtheClosestateisdelayeduntilthenext
statementisstaged.
IfthereceiptprintersupportsretractandTimer69(page 725)
expires,anyreceiptthathasnotbeenremovedisretracted.
OnanSSTwithanenvelopedispenser,anyenvelopethatisnot
takenbytheconsumerisretracted.Whentheenvelopeistakenor
retracted,theMEIisswitchedoff.

Cards
Ifthecardcannotbeejected,itiscapturedandscreenC04is
displayedfortheperiodspecifiedbyTimer02.Ifthecardisejected
butnottakenwithinthetimeperiodspecifiedbyTimer09
(page 724),itiscaptured.Fordetailsofconsumerdisplayscreens,
seeCCardholderDisplayonpage 36.Fordetailsoftimer
formatinamessage,seeConfigurationParametersLoadon
page 1014.
Whenacardisejected,orifnocardispresentwhentheClosestate
isentered,Timer02isstarted.TheSSTdoesnotexitfromtheClose

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-38

APTRA Advance NDC, Reference Manual

State Tables
J - Close State

stateuntilthistimerexpires.Thistimerprovidesaguaranteed
minimumdisplaytimefortheclosescreen.
Whenacardisejected,thebeeperissoundedtoremindthe
consumertotakethecard.Ifyoudonotwanttousethisfeature,
youcansetMessageModeoption4btoinhibitthebeeper.For
detailsoftheoption,refertotheAPTRAAdvanceNDC,Supervisors
Guide.

CardlessTransactions

Forcardlesstransactions,thescreendisplayedisthescreensetup
priortocardejectprocessingandTimer02isdefinestheminimum
timethescreenisdisplayed.

Audio

OnanSSTwithdigitalaudiocapability,whereautovoiceisenabled
andvoiceguidancedisabled,message8isplayedassoonasthe
cardistakenduringtheClosestate.Ifthecardhasalreadybeen
taken,themessageisplayedonentrytotheClosestate.Fordetails,
seeVoiceonpage 321.
Table 2-21
J - Close State
Table
Entry

Number of
Characters

Contents

Description

StateType

ReceiptDeliveredScreen
Number
(Range000999)

ScreendisplayedonentrytotheClosestate.Thisis
onlydisplayedifareceiptisdeliveredintheClose
stateandtheSSThasnotbeeninstructedbythelast
TransactionReplymessagetocapturethecard.The
lastTransactionReplyCommandperformed
determinesthescreentextasfollows:
CardBeforeCashTakecashandreceipt
FastCashTakecard,cashandreceipt
OtherCommandsTakecardandreceipt

NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesafterthestate
iscompleted.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-39

State Tables
J - Close State
Table
Entry

Number of
Characters

Contents

Description

NoReceiptDeliveredScreen
Number
(Range000999)

ScreendisplayedonentrytotheClosestate.Thisis
onlydisplayedifnoreceiptisdeliveredinthe
ClosestateandtheSSThasnotbeeninstructedby
thelastTransactionReplymessagetocapturethe
card.ThelastTransactionReplyCommand
performeddeterminesthescreentextasfollows:
CardBeforeCashTakecash
FastCashTakecashandcard
OtherCommandsTakecard

CardRetainedScreenNumber
(Range000999)

ScreendisplayedonentrytotheClosestate,
informingtheconsumerthatthecardhasbeen
retained.ThisisonlydisplayediftheSSThasbeen
instructedbythelastTransactionReplymessageto
capturethecardduringtheClosestate.Thisscreen
isalsodisplayedforfoursecondsifthecardis
capturedduetotimer09expiring(cardnottaken).

StatementDeliveredScreen
Number
(Range000999)

Displayscreentobeoverlaidwheneitherthe
receiptisdelivered(entry2)orthereisnoreceipt
delivery(entry4).Thisscreenisonlydisplayedif
thestatementiscutanddeliveredinaClosestate
andtheSSThasnotbeeninstructedbythelast
TransactionReplymessagetocapturethecard.

Mustbe000

Reserved

BNANotesReturnedScreen
Number
(Range000999)

ScreendisplayedonentrytotheClosestate,
informingtheconsumerthattheBunchNote
Acceptor(BNA)notesarebeingreturned.

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberoftheoptionalExtensionstate.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.
SeeTableNote16.

TableNote16:YoucanuseoneoftwomethodstodealwithCard
BeforeCashandFastCashtransactions:

UsedifferentClosestates
SendascreenmodifywiththeTransactionReplycommand.

FordetailsofCardBeforeCash,FastCashandProcess
DocumentWithCashtransactions,seetheTerminalFunctionsfor
TransactionCompletionsectioninChapter 10,Centralto
TerminalMessages.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-40

APTRA Advance NDC, Reference Manual

State Tables
J - Close State
Table 2-22
Extension to State J
Table
Entry

Number Of
Characters

Contents

Description

StateType

ChequeProcessorTake
DocumentScreenNumber
(Range000999)

Screennumberrequiredfortheerrorrecovery
actionswhichmaytakeplaceinthisstateifthe
chequeprocessorispresentandtheCheque
ProcessorDocumentReturn/RetainFlagissetto
either001or002.

ChequeProcessorDocument
Return/RetainFlag
(Range000002)

Thisflagcontrolstheerrorrecoveryactionswhich
maytakeplaceinthisstateifthechequeprocessor
ispresent.
Theflagcanbesetasfollows:
000Retain
001Returnandretractifnottaken
002Returnanddonotretractifnottaken.
SeeTableNote17.

47

12

Mustbe000

Reserved

ExtensionStateNumber

Extensionstate2.Thisvalueis000ifthe
parametersintheextensionstatearenotapplicable
orrequired.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.
SeeTableNote18.

Mustbe000

Reserved

67
8

BNANotesReturn/Retain/
LeaveFlag
(Range000002)

Thisflagcontrolstheerrorrecoveryactionswhich
maytakeplaceinthisstateifaBNAispresent.
Theflagcanbesetasfollows:
000Return
001Retain
002Leavenotesintheescrow.Ifthisisset,the
INITBNASupervisoroptionmustbeusedtoclear
thedevice,dependingonhowAutoErrorRecovery
isconfigured.
SeeTableNote19,TableNote20andTableNote21.

Mustsbe000

Reserved.

TableNote17:OnentrytotheClosestate,theapplication
determineswhetherachequeprocessorisconfigured,andifso,
whetheranyerrorrecoveryactionisrequired.Ifthedevicehasa
recoverableerrorconditionandstillhasachequewithinit,itwill
attempttoretain/captureorreturnthedocumentasdefinedby

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-41

State Tables
J - Close State

extensionstateentry3(ChequeProcessorDocumentReturn/Retain
Flag).
IftheClosestatedoesnotdefineanextensionstate,thedefaulterror
recoveryactionistoretainanydocumentfoundintheClosestate.
Ifthechequeistoberetained(ChequeProcessorReturn/RetainFlag
=000),anattemptismadetomoveitintotheRejectBin(bin2)if
present,otherwisebin1ifonlyonebinisavailable.InaCPM,the
retainedchequeisendorsedwithacustomisablestring,whichis
definedinscreenU0057.Inabunchchequeacceptor,theretained
chequescannotbeendorsed.
Ifthechequeistobereturned(ChequeProcessorReturn/Retain
Flag=001or002),anattemptismadetoreturnittotheconsumer.If
thedocumentsuccessfullyreachestheexit,thescreendefinedin
tableentry2(TakeDocumentScreenNumber)willbedisplayedfor
theperiodspecifiedbytimer94,oruntilthedocumentistaken.The
beeperisalsosoundedunlessoption2chasbeenset.Ifthe
documentdoesnotreachtheexit,ortheconsumerfailstotakethe
documentwithinthetimespecifiedbyTimer94,thefollowing
actionistakendependingonthesettingoftheflaginentry3:

IfChequeProcessorReturn/RetainFlag=001,anattemptis
madetomoveittotheRejectBin(bin2)
IfChequeProcessorReturn/RetainFlag=002,thedocumentis
leftattheexit.
Ifthechequeejectfailsortheejectedchequeisnottakenbefore
timer94expires,themessageCHEQUE EJECT FAILED (screen
U0088)isjournaled

Usingabunchchequeacceptor,morethanonebunchofcheques
canbereturnedtotheconsumer.Thescreendefinedintableentry2
ofextension2(ChequeProcessorWaitforChequeScreenNumber)
isdisplayedwhilethebunchesarebeingtransported,andthescreen
definedintableentry2ofextension1(ChequeProcessorTake
DocumentScreenNumber)isdisplayedwhenthebunchis
presented.
Ifthedocumentismovedsuccessfullytothebin,screenU0058is
journaledtogetherwiththesecuritytraceheadermessage.Ifthe
documentisnotmovedsuccessfullytothebinandtheconsumer
doesnothaveaccess,screenU0059isjournaledtogetherwiththe
securitytraceheader.
Ifanerroroccurswhilemovingthedocumenttobin2,an
unsolicitedmessageissenttothehost.Iftheerrorhasanassociated

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-42

APTRA Advance NDC, Reference Manual

State Tables
J - Close State

severityoffatal,thenanyfurtherattemptstousethedevicewill
yieldanerrormessage.
Allchequedataisdeletedwhenthisstateistaken,includingfiles
thathavebeencopiedandrenamedforusebytheImageMark
PassportATMImageAgent.
TableNote18:Ifanextensionstateisnotincluded,thedefault
actionforthechequeprocessordocumenterrorrecoveryistoretain
anychequefoundintheClosestate.
TableNote19:OnentrytotheClosestate,theSSTwilldetect
whetheracashacceptororarecyclingunitisconfigured.Ifthe
deviceisinarecoverablestateandstillhasnotesintheescrowora
directdepositisstillinprogress,theactiondefinedinextension
stateentry8(BNAReturn/Retain/LeaveFlag)isattempted.Ifdirect
depositisinprogress,notescannotbereturned.Notecountsare
journaledasfollows:

Ifthedepositusestheescrow,theescrownotecountsare
journaled
Ifthedepositdoesnotusetheescrow,thevaultednotecounts
arejournaled.

Iferrorconditionsaredetected,automaticerrorrecovery(AER)is
startedattheendoftheClosestateafterthecardhasbeenreturned
totheconsumer.Automaticerrorrecoveryisconfigurablethrough
theClassConfigurator.Fordetails,refertotheAPTRAAdvance
NDCDevelopersGuide.
TableNote20:IftheClosestateextensionstateentry8(BNANotes
Return/Retain/LeaveFlag)issetto001(Retain)andtheTransaction
Requestislostonthenetwork,thereisnowaytoidentifythe
consumertowhomthenotesbelongduetothemaskingofthecard
number.ThisisincompliancewithPaymentCardIndustry(PCI)
rules.
TableNote21:IfAERisenabledandnotesareleftintheescrowin
theClosestate,thenoteswillbeprocessedaspartofAER.Tomake
surenotesareleftintheescrow,AERmustbeturnedoff.Fordetails
ofAERconfiguration,refertochapter5,ConfiguringAdvance
NDCandAssociatedComponentsoftheAPTRAAdvanceNDC
DevelopersGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-43

State Tables
J - Close State

Table 223

Extension State 2 (J - Close State)


Table
Entry

Number Of
Characters

Contents

Description

StateType

ZExtensiontype

ChequeProcessorWaitfor
ChequesScreenNumber(range
000999)

Thisscreenisusedtoaskthecustomertowaitfor
additionalchequestobereturnedwhenmorethan
onebunchofchequesistobereturnedtothe
customer.Ifthisvalueis000orthisextensionstate
isnotpresentthentheChequeProcessorTake
DocumentScreenisdisplayeduntilallbunches
havebeentaken

RetractingPresentedMedia
ScreenNumber(range000999)

Screendisplayedifmediapresentedwithinthis
stateisnottakenandisbeingretracted.Thisscreen
doesnotapplytocardsorpassbookswhichhave
specificscreensdefinedforthispurpose.
Thewordingusedinthescreenshouldbedesigned
tohandleallmediatypesthatcanbereturnedand
retractedbythisstate.
Ifthisparameteris000(ortheoptionalExtension
stateismissing)andifthereservedgenericPlease
wait...screen(screenC20)isdefined,screenC20is
displayedduringtheretractoperation.Ifthis
parameteris000(ortheoptionalExtensionstateis
missing)andscreenC20isnotdefined,noscreen
willbedisplayedduringtheretract(unlessa
specificscreenisavailableinoneoftheother
parameters).

49

18

Mustbe000

Reserved

ExtensionStateNumber

Extensionstate2.Thisvalueis000ifthe
parametersintheextensionstatearenotapplicable
orrequired.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

67

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-44

APTRA Advance NDC, Reference Manual

State Tables
K - FIT Switch State

KFITSwitchState

EachFinancialInstitutionTable(FIT)containsanextstateindex
number.Thisindexnumberreferstothenextstatenumberthatthe
SSTgoestowhenitexitsfromtheFITSwitchstate,iftheFinancial
InstitutionnumberonthecardmatchesaFinancialInstitution
numberinaFIT.Formoredetails,seetheACardReadState
section.
TheFITSwitchstatetablecontainsalistofthesenextstatenumbers,
togetherwithanindexwhichmatchestheindexnumbersofthe
FITs.
Forexample,iftheFITthathasbeenidentifiedduringtheCard
Readstatecontainsanextstateindexnumberof3,thiscorresponds
toindexnumber3intheFITSwitchstatetable.Thisindexnumber
isfoundintableentry5,sotheSSTgoestothenextstatenumber
containedintableentry5whenitexitsfromthisstate.
Table 2-24
K - FIT Switch State
Table
Entry

Index

Number
of Chars

Contents

Description

StateType

K
StatetowhichtheSSTgoesdependingonthenext
stateindexstoredintheFIT.
(Base10range000254or256999)
(Base36range000254or256ZZZ)

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-45

State Tables
_ - Expanded FIT Switch State

_ExpandedFITSwitchState

ThisstateoperatesasstatetypeK,describedonthepreviouspage,
exceptthatmoreswitchcapacityhasbeenaddedthrougha
mandatoryextensionstate.Forexample,iftheFITidentifiedduring
theCardReadstatecontainsanextstateindexof3,thenextstate
numberisfoundintableentry5.
Table 2-25
_ - Expanded FIT Switch State
Table
Entry

Index

Number
of Chars

Contents

Description

StateType

_
StatetowhichtheSSTgoesdependingonthenext
stateindexstoredintheFIT.
(Base10range000254or256999)
(Base36range000254or256ZZZ)

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

NextStateNumber

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberofthemandatoryExtensionstate.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-46

APTRA Advance NDC, Reference Manual

State Tables
_ - Expanded FIT Switch State
Table 2-26
Extension to State _
Table
Entry

Index

Number
of Chars

Contents

Description

StateType

Z
StatetowhichtheSSTgoesdependingonthenext
stateindexstoredintheFIT.
(Base10range000254or256999)
(Base36range000254or256ZZZ)

NextStateNumber

NextStateNumber

NextStateNumber

10

NextStateNumber

11

NextStateNumber

12

NextStateNumber

13

NextStateNumber

14

NextStateNumber

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-47

State Tables
L - Card Write State

LCardWriteState

DuringaCardReadstate,theCardDatabuffersareclearedofall
previousdata.TheCardReadstatedefinesthecardtrackstobe
readandstoresthecardtrackdatainthecorrespondingCardData
buffer.IntheTransactionRequeststate,theSSTsendsaTransaction
RequestmessagetoCentral.Youcanspecifywhetherornottrack
dataisincludedinthismessage.Centralrespondstothismessage
bysendingaTransactionReplycommandtotheSST.Withinthis
commandarefieldswhichcontainupdatedtrackdata.Thisdata
replacesanypreviousdataintheSSTstrackdatabuffer.
DuringtheCardWritestate,theSSTwritesthecontentsoftheTrack
databuffersontothemagneticstripeofthecard.Youspecifywhich
screenistobedisplayedontheconsumerscreenwhilewritingtakes
place.
WritingonlytakesplaceiftheTrackdatabufferscontaindata
obtainedfromasuccessfulTrack3readduringaCardReadstate,or
updatedTrackdatafromaTransactionReplycommand.
TherearethreenextstatenumbersthattheSSTcangotowhenit
leavestheCardWritestate.OneexitistakeniftheTrackwriteis
successful.AnotheristakeniftheTrackwriteisunsuccessful.A
thirdexitistakeniftheTrackbuffersareemptyorcontaininvalid
data,andnowritingisattempted.
IftheSSTistowritetomorethanonetrack,theorderwillbeTrack
1,Track2andTrack3.Beforewriting,acheckismadetoensurethat
thedataisvalid.Ifthedataisnotvalidthewritestatewillexit
withoutwriting.IfthedataisvalidandatrackwritefailstheSST
willnotattemptanyfurtherrequestedtrackwritesandthewrite
statewillexit.
TousetheCardWritestate,themagneticstripecardmuststillbein
thereader.Thefollowingconditionsmustapply:

Tableentry8oftheCardReadstatemustnotbe000(returncard
immediately)
ACardBeforeCashTransactionReplymustnothavebeen
performed
AParallelEject/DispenseandPrint(FastCash)Transaction
Replymustnothavebeenperformed
Acardreaderwiththeabilitytowritetothetracksspecified
mustbepresent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-48

APTRA Advance NDC, Reference Manual

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

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

ScreendisplayedduringaCardWriteoperation.

GoodWriteNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesaftera
satisfactoryTrackwriteoperation.

BadWriteNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheTrack
writeisunsuccessful.

NoWriteAttemptedNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifnodataor
invaliddataispresentintheTrackbuffer.This
stateisalsousedifastartand/orendsentinelis
missing,ortheTrackdatabuffersaretoolong.

69

12

Mustbe000foreachtableentry

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-49

State Tables
M - Enhanced PIN Entry State

MEnhancedPINEntryState

ThisstateperformsthesamefunctionsasthePINEntrystate.Italso
supportsTrack3retriesiftheFITspecifieslocalPINcheckand
indicatesthatthereisaTrack3retryfieldonthecard.
IftheFITspecifiesTrack3retriesbutthereisnodataintheTrack3
buffer,theCancelNextStateexitistaken.
BeforetheconsumercanenteraPINforalocalPINcheckwith
Track3retries,thePINretryfieldonthecardischecked.Fora
MutualInstitutionsTransferSystem(MINTS)formatcard,theretry
fieldoftheTrack3databuffermustnotequalorexceedthelimit
specifiedinstatetableentry9.IfanInternationalStandards
Organisation(ISO)formatcardisused,theretryfieldmustnot
equal0.Iftheydo,inbothsituationstheSSTexitstotheMaximum
BadPINsNextStatespecifiedintableentry6.Thischeckismade
beforethestartofeachPINentryattempt.
AfterthePINisenteredbytheconsumerandcomparedwiththe
calculatedPIN,thePINretryfieldintheTrack3databufferis
updated.ForMINTSformatcards,iftheenteredPINiscorrect,the
PINretryfieldissetto0.ForISOformatcards,theretryfieldisset
tothevaluespecifiedinstatetableentry9.IftheenteredPINis
incorrect,thePINretryfieldisincrementedforMINTSformatcards
anddecrementedforISOformatcards.TheupdatedTrack3data
bufferisavailablefortransmissionthroughtheTransactionRequest
state.ThebuffercanalsobewrittenonthecardusingtheCard
Writestate.
OnanSSTwithdigitalaudiocapabilityandautovoiceenabled,
message7isplayedonentrytothisstate.Fordetails,seethe
ControlCodesforSpecialFeaturessectioninChapter 3,Screen
Data.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-50

APTRA Advance NDC, Reference Manual

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

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoenter
thePINthefirsttime.Thisscreenisdisplayedon
enteringthePINEntrystate.Itmustleavethe
cursoratthestartofthePINEntrydisplayarea.An
Xisdisplayedforeachkeypressed.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
doesnotenterthePINwithinthepermittedtime
limit.Enterstatenumber255ifthetimeout
functionisnotrequired.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
pressestheCancelkeybeforethemaximum
numberofdigitsspecifiedforthePINhavebeen
entered.

LocalPINCheckGoodPIN
NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesafter
verificationofacorrectPINentry.APreSet
OperationCodebufferstate(clearingthefunction
keybufferbeforeTransactionSelection)usually
followsacorrectPINentry.SeeTableNote24.

LocalPINCheckMaximumBad
PINsNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthecorrect
PINhasnotbeenenteredafterthenumberof
attemptsallowedbytableentry9.Thiscouldbea
CardWritestateinordertoupdatetheTrack3PIN
retryfield.
SeeTableNote22,TableNote23,andTableNote
24.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-51

State Tables
M - Enhanced PIN Entry State
Table
Entry

Number of
Characters

Contents

Description

LocalPINCheckErrorScreen
Number
(Range000999)

Displayscreenthatpromptstheconsumerto
reenterthePIN.Thisscreenisdisplayedaftereach
incorrectPINentryattempt.AnXisdisplayedfor
eachkeypressed.Afterthenumberofreentry
attemptsallowedbytableentry9,theSSTenters
thestatedeterminedbytableentry6.
SeeTableNote22andTableNote24.

RemotePINCheckNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoeswhenlocalPIN
verificationisnotperformed.

LocalPINCheckMaximumPIN
CheckRetries
(Range001009)

MaximumnumberofincorrectPINentriesbefore
theSSTentersthestatedeterminedbytableentry6.
ThisentryisusedasthePINretrycountifthePIN
retrycountisnotonthecard(FITentryPRCNT=
FF).SeeTableNote22andTableNote24.

TableNote22:ThesefieldsarealsousedwhentheCheckRemote
PINminimumlengthoptionintheFITisused.(Thehighorder
threebitsofPANLNarenot0andcontainavaluelessthanorequal
toPMXPN.PANLNdoesnotcontainFFhex.)Thefieldsareusedin
thesamewayasforlocalverification.AnincorrectPINisonethatis
lessthantheminimumlength.
TableNote23:TheLocalPINCheckMaximumBadPINsNext
StateNumbershouldbesettoanonzerovalidvalue,oranerror
willoccur.
TableNote24:TosupportsecurePINencryption,fields5,6,7and
9mustalwaysbesetup,astheyareusedtocontrolthenumberof
allowedPINretrieswhenfewerthanfourPINdigitsareentered.
WithsecurePINencryption,acheckfortheminimumfourPIN
digitsisperformedwhetherornottheFITspecifiestocheckfor
shorterPINs.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-52

APTRA Advance NDC, Reference Manual

State Tables
N - Camera Control State

NCameraControlState

Whentheapplicationentersthisstate,thecameratakesapicture.
ImagesarestoredinaconfigurablelocationontheSST.
Note:ItisnotnecessarytoaddthisstatetotheAdvanceNDC
applicationflowaspointshavealreadybeenaddedforpicture
taking.TheycanbeconfiguredthroughtheXMLfiledownloaded
fromthehost.Fordetails,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
ThedefaultlocationisC:\Programfiles\NCRAPTRA\Advance
NDC\Snapshots.InformationsuppliedbytheSSTisincludedinthe
filenameofthestoredimage.Thefilenamehasthefollowingformat:
NNNNNN_TTTT_DDMMYY_HHMMSS.mmm_CCCC_PPP_x.BMP
Table 2-29
Security Camera Image Filename Format

Filename Variable

Description

NNNNNN

SSTmachinenumber

TTTT

Transactionserialnumber
Asthisispopulatedbyreplydatafromthe
host,someflowpointsintheapplicationwill
have4underscores____instead

DDMMYY

DateinaformatdependentonECPoption3
(seeOption03DateFormatonpage 77)

HHMMSS.mmm

TimeinHHMMSS.mmmformat

CCCC

Lastfourdigitsoftheconsumerscard
number
Blankdata(incardlesstransactions)istreated
ascolonsforcommanddataandunderscores
forsavingafile.

PPP

Thenumberidentifyingtheflowpointat
whichthepicturewastaken
IfapictureistakenusingtheCameraControl
state,thisisalways000

Anumberintherange13identifyingthe
sequenceoftheimagesifmultiplepictures
havebeentaken
Thisisonlyincludedinthefilenameif
multiplepicturesweretaken

OnanSSTwithoutacamera,thisstatedoesnotperformanyaction
andtheapplicationflowgoestothenextstate.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-53

State Tables
N - Camera Control State

Whetherunsolicitedmessagesarereporteddependsonenhanced
configurationparameteroption32.Fordetails,seeOption32
UnsolicitedReportingControlonpage 710.
Table 2-30
N - Camera Control State
Table
Entry

Number of
Characters

Contents

Description

StateType

PictureType
(Range000001)

SpecifiestheSSTsupplieddatatosuperimposeon
theimage
000picturetype0
001picturetype1
SeeTableNote25andTableNote26

NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesaftertakingthe
picture

49

18

Mustbe000foreachtableentry

Reserved

TableNote25:InAdvanceNDC,thereisnodifferenceinthetwo
picturetypes.
TableNote26OnNCRSSTs,itisnotpossibletosuperimposeSST
dataontheimagebecauseAPTRAXFSdoesnotsupportthis
feature.However,theinformationisincludedinthefilenameofthe
savedimage.Fordetailsofsuperimposeddatasupportonother
vendorshardware,refertotheAPTRAAdvanceNDC,MultiVendor
SupportReferenceManual.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-54

APTRA Advance NDC, Reference Manual

State Tables
R - Enhanced Amount Entry State

REnhancedAmountEntryState

Usethisstateifyouwishtousemultilanguagescreensfor
enhancedamountentry.Thestandardfieldlengthforthisbufferis
eightdigits,ortwelveifEnhancedConfigurationParameteroption
1isused;butitcanbeconfiguredforanynumberuptotwelve
digitsthroughAppendBuffer.xml.
Thisstatereadstheamountenteredbytheconsumer,displaysiton
theconsumerscreen,andsavesitinthebuffersspecifiedbythe
statetable.ExitfromtheEnhancedAmountEntrystateoccurswhen
anactiveFDKispressed,theCancelkeyispressedoratimeout
occurs.TheEnterkeyisequivalenttoFDKA(orFDKI,ifthe
optionwhichenablesthekeystotheleftofthescreenisset).The
Clearkeyisalwaysactiveandclearstheamountenteredandthe
screenechofilledtoallowdataentryretrieswithintheAmount
Entrystate.
Oncetheconfigurednumberofdigitsisreached,thenextkeyclears
thebuffer,resettingthevalueto0andrestartingtheentryformthe
beginning.AparameterinAppendBuffer.xmlcanbeconfiguredto
preventclearingoftheamountwhentheconfiguredlimitis
reached.
Ifrequiredbythehost,thescreencanbeconfiguredtoaddextra
zerosautomaticallytotheamountbuffer,afterthedecimalpoint.
ThisconfigurationisdefinedintheAppendBuffer.xmlfile.Thefile
canbeupdated,asdescribedinXMLConfigurationDownloadon
page 1046,orcanbeinstalledlocally.
FordetailsofAppendBuffer.xml,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
Table 2-31
R - Enhanced Amount Entry State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Numberofdisplayscreenpromptinganamount
entry.

TimeOutNextStateNumber
(Base10range000254or256999)
(Base36range000254or
256ZZZ)

Statenumbertowhichtheapplicationgoesifthe
consumerfailstoentertheamountwithinthe
specifiedtimelimit.Enter255ifthetimeout
functionisnotrequired.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-55

State Tables
R - Enhanced Amount Entry State
Table
Entry

Number of
Characters

Contents

Description

CancelNextStateNumber
(Base10range000254or256999)
(Base36range000254or
256ZZZ)

Statenumbertowhichtheapplicationgoesifthe
consumerpressestheCancel key.

FDKA(orI)
NextStateNumber

FDKB(orH)
NextStateNumber

FDKC(orG)
NextStateNumber

StatenumbertowhichtheSSTgoesiftheconsumer
pressesthespecifiedFDK.NormallyoneFDKis
usedtospecifywhethertheamountentryiscorrect
andanothertospecifyincorrect.Theotherkeysare
inactive.Enter255todeactivateanyFDKortouch
area.
(Base10range000254or256999)
(Base36range000254or256ZZZ)

FDKD(orF)
NextStateNumber

ExtensionStateNumber
(Base10range000254or256999)
(Base36range000254or
256ZZZ)

StatenumberoftheExtensionstate.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

Table 2-32
Extension to State R
Table
Entry

Number of
Characters

Contents

Description

StateType

DocumentAmountBuffer
(Range000002)

Thisfielddetermineswhichbuffertheamount
enteredwillbestoredin:
000Amountbuffer
001BufferB.
002BufferC

AmountDisplayScreen
Number
(Range000999)
SeeTableNote27.

Overlayscreenforsettingthecursorpositionon
theconsumerscreen.Thisscreenoptionallydefines
theinitialdisplayformatbeforeamountentryby
theconsumer.Thecursorshouldbesetonthe
lefthandsideoftheechofieldonthescreen.Thisis
spacefilleduntiltherequiredstartpositionforthe
currencycharacterisreached.Fordetails,see
InternationalCurrencyDisplayFormaton
page 344.
Thedefaultechofieldforeightdigitsis:
bbbbb$b0.00
whereb=space.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-56

APTRA Advance NDC, Reference Manual

State Tables
R - Enhanced Amount Entry State
Table
Entry

Number of
Characters

Contents

Description

Thedefaultechofieldfortwelvedigitsis:
bbbbbbbbb$b0.00
whereb=space.
4

StartCAVcommand
(Range000001)

NotusedbyAdvanceNDC.

LanguageDependentScreen
Flag
(Range000001)

Thisflagdeterminesifthescreendefinedintable
entry3ofthisextensionstateislanguage
dependent:
000Notlanguagedependent
001Languagedependent,regardlessoflanguage
groupsize.

69

12

Mustbe000

Reserved

TableNote27:TheAmountEntryScreenwillnotbeadjustedfor
language,unlessalanguagehasbeenselectedandthelanguage
groupsizeis1000orgreater.Ifthelanguageadjustedscreenhasnot
beenloaded,theunadjustedscreenwillbeusedinstead.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-57

State Tables
S - Language Code Switch State

SLanguageCodeSwitchState

Inthisstate,theflowofatransactionisswitcheddependingon
whetheralanguagecodeispresentinthecarddataornot.
Youcanusethisstatetoselectthelanguagetobeused
automaticallyfromthecodeonthecard,ortoallowmanual
selectionforcardswhichhaveeithernolanguagecodeoraninvalid
languagecode.
ThelanguageusedisdeterminedbystateVLanguageSelectFrom
Cardstate,andstateYEightFDKSelectionFunctionstate.
ThisstateissubjecttothesamerestrictionsastheLanguageSelect
state.Fordetails,seetheVLanguageSelectFromCardState
section.
Note:If255isplacedinanyofthelanguagecodeexitsortheno
languagecodeexit,theSSTperformsadefaultClosestate.This
meansthattheconsumerscardisreturnedandthetransactionis
terminated.
Table 2-33
S - Language Code Switch State
Table
Entry

Number of
Characters

Contents

Description

StateType

NoLanguageCodeNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeisillegalorcannotberead.

LanguageCode=0NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis0.

LanguageCode=1NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis1.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-58

APTRA Advance NDC, Reference Manual

State Tables
S - Language Code Switch State
Table
Entry

Number of
Characters

Contents

Description

LanguageCode=2NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis2.

LanguageCode=3NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis3.

LanguageCode=4NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis4.

LanguageCode=5NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis5.

Extensionstatenumber
(Range000999or000ZZZ)

StatenumberoftheExtensionstatecontainingthe
nextstatesforlanguagecodes69.
Avalueof255meansthatthereisnoExtension
state,andlanguagecodes69causetheNo
LanguageCodenextstateexittobetaken.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-59

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

Number of
Characters

Contents

Description

StateType

LanguageCode=6NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis6.

LanguageCode=7NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis7.

LanguageCode=8NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis8.

LanguageCode=9NextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthelanguage
codeis9.

69

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-60

APTRA Advance NDC, Reference Manual

State Tables
T - Card Read - PIN Entry Initiation State

TCardReadPINEntryInitiation
State

YoucanusethisstateinsteadoftheCardReadstate,ifyouwantto
initiatePINentrybytheconsumeratthesametimeastheSSTreads
thecard.ThisstatemustbeusedforDASHcardreaders.However,
iftheDASHreaderisusedasadipreader,CardReadstateAcan
alsobeused.
Note:IfusingaDASHreader,butnochipconnectbitisset,the
DASHwillbehaveasastandarddipreader.
IfyouusetheCardReadstatetable,ensureitisthefirsttableused
duringtransactionprocessingbyassigningstatenumber000toit.
TheSSTautomaticallyentersstate000whenputintoservice.
ThisstateperformsthesamefunctionsastheCardReadstate:

TheSSTdisplaysascreenpromptingtheconsumertoentera
card
ThestatetableidentifiesthenextstatenumberthattheSSTgoes
tofollowingasuccessfulcardread
TheSSTdisplaysanerrorscreenifthecardcannotberead
Thestatetablespecifieswhichcardtracksaretoberead.

OnedifferencebetweenthisstateandtheCardReadstateisthatin
thisstatethecardisalwaysreturnedaccordingtotheinstructionin
theTransactionReplycommandmessage.
ThisstatealsoenablesthekeyboardforPINentrywhilethecardis
beingread,anddisplaysascreenpromptingtheconsumertoenter
thePIN.Thekeyboardisenabledforamaximumnumberof
numerickeys(16).YoucanspecifywhichFDKsaretobeactiveas
AcceptorClearkeys.TheClearkeyitselfisalwaysactive.TheEnter
keyisactiveifyouspecifyFDKAasanAcceptkey.
Note1:TheBAPE(BasicAlphanumericPINpadEncryptor)does
notsupportthisearlyenablingofthekeyboardwithsecurePIN
entry.WhentheBAPEisconfigured,thekeyboardisnotenabledfor
PINentryinthisstate;thekeyboardisenabledonlyinthePIN
Entrystate.
Note2:Thisstatealsosupportsmagneticsmartcards.Fordetailsof
howsmartcarddataishandled,seetheACardReadState
section.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-61

State Tables
T - Card Read - PIN Entry Initiation State

Oncethecardhasbeenreadsuccessfully,processingcontinuesto
thenextstate.ThismustbeaPINEntryorInformationEntrystate
(aninterveningFITSwitchstateisallowed).
IfthenextstateenteredisoneofthePINEntrystates,thecorrect
PINlengthisobtainedfromtheFIT.Iftheconsumerhasnotentered
thecompletePIN,thekeyboardisreenabledfortherealPINlength
withoutchangingthescreen.Whentheenteredkeydataisreturned,
itisprocessedusingthePINEntrystatetableparameters.Accept
keycodesareignored.ThefastPINentryscreenisonlyusedforthe
firstPINentry.Forallsubsequentattempts,thePINentryscreenis
used.Track1datacannotbedisplayedonthisscreenbecausethe
cardhasnotbeenreadatthispoint.
IfthenextstateenteredisanInformationEntrystate,nokeyboard
reenableisrequired.Whentheenteredkeydataisreturned,itis
processedusingtheInformationEntrystatetableparameters.
OnanSSTwithdigitalaudiocapabilityandautovoiceenabled,
message7isplayedassoonasthecardisdetectedbytheSST.For
details,seetheControlCodesforSpecialFeaturessectionin
Chapter 3,ScreenData.

DASHCardReader

StateTnowsupportstheDASHcardreaderforEMVprocessing.If
theSSThasaDASHcardreaderandoneormoreoftheCardRead
Conditions(stateentries57)hastheChipConnectBitsetto1,then
thecardislatchedonentrytotheDASHcardreaderandEMV
processingbegins.
Note:IfusingaDASHreader,butnochipconnectbitisset,the
DASHreaderbehavesasastandarddipreader.
WhentheDASHcardislatched,anattempttogaintheAnswerTo
Reset(ATR)fromthechipismade.IftheATRissuccessfulthenthe
NoFITMatchnextstateistaken.IfatthispointtheNoFITMatch
Exitistaken,itisnotpossibletorevertbacktomagneticstripe
processingforthattransaction.
IftheATRfails,theDASHcardreaderunlatchesthecardandthe
consumerisaskedtoremovethecardandwait.Thescreendefined
inExtensionstateentry6isavailableforthis.Ifthecardisremoved,
themagneticstripedataisread,magneticstripeprocessing
commencesandthecardreadconditionsarechecked.
FormoreinformationaboutsmartcardhandlinginAdvanceNDC,
seeChapter 12,EMVSmartCardHandling.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-62

APTRA Advance NDC, Reference Manual

State Tables
T - Card Read - PIN Entry Initiation State
Table 2-35
T - Card Read - PIN Entry Initiation State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoenter
acard.WhiletheSSTiswaitingforacardentry,
thisscreenwillbedisplayed.

GoodReadNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoes:
1.FollowingagoodreadofthecardifFITsarenot
used(TableEntry3inExtensionstate=000)
or
2.IftheFinancialInstitutionnumberonthecard
matchesaFinancialInstitutionnumberinaFIT.

Error(Misread)ScreenNumber
(Range000999)

Screenthatisdisplayedifanunsuccessfulread
occurs;orforaDASHcard,theconsumerfailsto
takethecardbeforetimer72expires.

ReadCondition1

ReadCondition2

ReadCondition3

Thesethreeentriesspecifywhichcardtrack(s)and
/orchipdatawillberead.Thepossiblevaluesfor
theseentriesarethesameasfortheACardRead
stateinTable 24onpage 28.

Reserved

Thisfieldisnotused.Theearlycardejectfeatureis
notsupportedbythisstate.Thecardisalways
returnedasspecifiedbytheTransactionReply
commandmessage.

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberoftheExtensionstatecontaining
informationforparallelPINentry.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-63

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

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

DisplayscreenthatpromptstheconsumertoenteraPIN.
Thisscreenisdisplayedoncardentry.Theidentifiedscreen
mustleavethecursorpositionedatthebeginningofthePIN
Entrydisplayarea.AnXisdisplayedforeachkeypressed.
TheTrack1namecannotbedisplayedatthistimebecause
thecardhasnotbeenread.

NoFITMatchNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheFinancial
InstitutionnumberonthecarddoesnotmatchanyFIT.If
FITsarenotused,thisentrymustbe000.TheNoFITmatch
exitisalsotakeniftheSSThasaDASHreaderandoneofthe
chipconnectbitsissetandtheATRsucceeds.

ClearKeyMask
(Range000255)

AbinaryencodedvaluewhichspecifiestheFDKsortouch
areasthatareactiveasClearkeysduringPINentry.Eachbit
relatestoanFDKortoucharea.Bit0relatestoFDKA(or
FDKAtoucharea);bit7relatestoFDKI(orFDKItouch
area).Ifabitis1,therelativeFDKortouchareaisactive.Ifa
bitis0,therelativeFDKortouchareaisinactive.SeeTable
Note28.

AcceptKeyMask
(Range000255)

AbinaryencodedvaluewhichspecifiestheFDKsortouch
areasthatareactiveasAcceptkeysduringPINentry.Eachbit
relatestoanFDKortoucharea.Bit0relatestoFDKA(or
FDKAtoucharea);bit7relatestoFDKI(orFDKItouch
area).Ifabitis1,therelativeFDKortouchareaisactive.Ifa
bitis0,therelativeFDKortouchareaisinactive.SeeTable
Note28.

ScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoremovethecard
andwaitifthecardreaderisaDASHcardreader,anda
chipconnectbitisset,buttheATRfails.Thisscreenis
displayeduntiltheconsumerremovesthecardortimer72
expires.

79

Mustbe000foreachtable
entry

Reserved

TableNote28:Theeightbitsrepresentthebinaryequivalentofan
AcceptkeyorClearkeymask.Forexample,inthefollowingmask:
b7

b6

b5

b4

b3

b2

b1

b0

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-64

APTRA Advance NDC, Reference Manual

State Tables
T - Card Read - PIN Entry Initiation State

thethreedecimalcharactersintableentry4or5are018andthe
activeFDKsortouchareasareBandF.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-65

State Tables
U Device Fitness Flow Select State

UDeviceFitnessFlowSelectState

TheDeviceFitnessFlowSelectstateisusedtotesttheoperational
conditionofadevice,orsubcomponent,andmakeabranchinthe
stateflow.Forexample,theDeviceFitnessFlowSelectstatecanbe
usedtotesttheoperationalconditionofthereceiptprinterandifit
isinoperative,causeabranchinthestateflowtodisplayascreen
allowingtheconsumertoselectwhethertocontinuewiththe
transaction.
Thedevicefitnessvalueusedinthetestisthesamevaluethat
wouldbereportedtothehostifitrequestedthedevicefitness.The
valuesreflectthecurrentstatusofthedeviceswhenSupervisoris
exitedandareupdatedasdevicestatusmessagesaresenttothe
host.
Thisstatemustnotbeusedifthehostdoesnotexplicitlycheckthe
devicefitnessonexitfromSupervisorasthehostcouldbeunaware
thatadeviceremainsinafatalcondition.
FordetailsofthedevicessupportedbytheDeviceFitnessFlow
Selectstate,seeSupportedDevicesonpage 268.
Table 2-37
U Device Fitness Flow Select State
Table
Entry

Number of
Characters

Contents

Description

StateType

DeviceNumber

Devicenumberor000(undefined)
Fordetailsofthesupporteddevicesandtheir
associateddevicenumbers,seeSupported
Devicesonpage 268
Ifthisisdefined,itisusedtoidentifythedevice,
otherwisetableentry4(DeviceIdentifierGraphic)
isused
TheDeviceUnavailableNextStateistakenifthe
identifieddeviceisnotpresentornotsupported,or
ifthedevicenumberisinvalid
SeeTableNote29,TableNote30andTableNote31

DeviceAvailableNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthedevice
andoptionalsubcomponentareinagood
condition

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-66

APTRA Advance NDC, Reference Manual

State Tables
U Device Fitness Flow Select State
Table
Entry

Number of
Characters

Contents

Description

DeviceIdentifierGraphic(DIG)

DecimalrepresentationoftheDIG
Fordetailsofthesupporteddevicesandtheir
associatedDIGs,seeSupportedDeviceson
page 268
Thisisusedonlyiftableentry2(DeviceNumber)
isundefined(000)
TheDeviceUnavailableNextStateistakenifthe
identifieddeviceisnotpresent,notsupported,or
itsDIGisinvalid
SeeTableNote29,TableNote30andTableNote31

DeviceUnavailableNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthedeviceis
inafatalorsuspendconditionorisnotpresent
SeeTableNote31

DeviceSubComponent
Identifier

Indexofthesubcomponentasreportedwithinthe
FitnessDatasolicitedstatusmessageforthe
specifiedDIGor000(overalldevice)
Identifiesthesubcomponentofadevice
Thisisusedonlywhentableentry4(Device
IdentifierGraphic)hasbeenusedtoidentifya
deviceandappliesonlytocashhandlers
SeeTableNote30andTableNote31

000

Reserved

000

Reserved

000

Reserved

TableNote29:Youcanspecifythedeviceforwhichyouwantto
querythefitnessinthefollowingways:

Usingtableentry2(DeviceNumber)tospecifythedevice
number
Usingtableentry4(DIG),andoptionallytableentry6
(SubComponentIdentifier)forcashdispensers,tospecify
theDIG.

NCRrecommendsthatyouusetheDIGtoidentifythedevice.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-67

State Tables
U Device Fitness Flow Select State

TableNote30:Thereportingoffitnessfordualcashhandlers
dependsonthesettingofEnhancedConfigurationOption76,as
follows:

IfEnhancedConfigurationOption76issetto000,querying
thedevicefitnessreportsthecombinedfitnessofthecash
handlerandcassettes(DIGE).Thefitnessoftheprimary
(DIGd)orsecondary(DIGe)cashhandlerwillbe
reportedasunavailable
IfEnhancedConfigurationOption76issetto001,querying
thedevicefitnessreportsthecombinedfitnessofthecash
handlerandcassettes(DIGE).Thefitnessoftheprimary
cashhandler(DIGd)willbereportedascashhandler0.
Thefitnessofthesecondarycashhandler(DIGe)willbe
reportedascashhandler1.

FordetailsofEnhancedConfigurationOption76,seeOption76
CashHandlersonpage 717.
TableNote31:TheSubComponentIdentifierisonlyusedwhen
queryingacashhandlerforthefitnessofacassettetype.Ifthe
cassettetypeisnotpresent,itisreportedasunavailable.

SupportedDevices

Table 238liststhesupporteddevices,andassociatedDevice
NumberandDIGforuseintheDeviceFitnessFlowSelectstate.

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)

CardReader/Writer

003

068=D

CashHandler
SeeTableNote32

004

069=E

EnvelopeDepository

005

070=F

ReceiptPrinter

006

071=G

JournalPrinter
SeeTableNote33

007

072=H

NightSafe

010

075=K

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-68

APTRA Advance NDC, Reference Manual

State Tables
U Device Fitness Flow Select State

Device

CassetteType1
SeeTableNote34

Device Number
(table entry 2)

015

Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)

Dependingondeviceconfiguration,asfollows:
Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)

Tableentry6:
001

CassetteType2
SeeTableNote34

016

Dependingondeviceconfiguration,asfollows:

Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)

Tableentry6:
002

CassetteType3
SeeTableNote34

017

Dependingondeviceconfiguration,asfollows:
Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)

Tableentry6:
003

CassetteType4
SeeTableNote34

018

Dependingondeviceconfiguration,asfollows:
Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)

Tableentry6:
004

CassetteType5
SeeTableNote34

095

Dependingondeviceconfiguration,asfollows:
Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)

Tableentry6:
005

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-69

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

Device

CassetteType6
SeeTableNote34

096

Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)

Dependingondeviceconfiguration,asfollows:
Fortableentry4:
E=69Singlecashhandlerordualcashhandleremulating
asinglecashhandler
100=d(primarycashhandler)
101=e(secondarycashhandler)

Fortableentry6:
006

CassetteType7
SeeTableNote34

097

Dependingondeviceconfiguration,asfollows:

Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)

Tableentry6:
007

StatementPrinter

021

086=V

EnvelopeDispenser

027

092=\

CoinDispenser

024

089=Y

BunchNoteAcceptor

034

119=w

ChequeProcessingModule

035

113=q

BarcodeReader

094

102=f

PrimaryCashHandler

098

100=d

SecondaryCashHandler

099

101=e

BiometricsCaptureDevice

N/A

120=x

PassbookPrinter

N/A

088=X
ThePassbookPrinterisnotsupportedinAdvanceNDCbut
theapplicationcanbeenhancedorextendedforit.

TableNote32:IfEnhancedConfigurationOption76issetto000,
queryingthedevicefitnessreportsthecombinedfitnessofthecash
handlerandcassettes.
TableNote33:IfEnhancedConfigurationOption35issetto001
(EJonly)or002(dualmode),thejournalprinterfitnessisreported
asgoodiftheEJlogfileisinagoodconditionevenifthehardcopy
journalprinterisinafatalcondition.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-70

APTRA Advance NDC, Reference Manual

State Tables
U Device Fitness Flow Select State

TableNote34:ThisisavailableonlywhenEnhanced
ConfigurationOption76=001

CashHandlers

Table 239givesexamplesofthetableentriesusedintheDevice
FitnessFlowSelectstatetoquerythefitnessofdifferentcash
handlerconfigurations.
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

Queriesthefitnessoftheentirecashhandlerasfollows:

Tableentry2isundefined,sotableentry4ischecked

Tableentry4identifiesthedeviceasasinglecashhandler
ordualcashhandlerconfiguredtoemulateasinglecash
handler

Tableentry6identifiesthewholedevice

Queriesthefitnessofcassettetype1asfollows:

Tableentry2isundefined,sotableentry4ischecked

Tableentry4identifiesthedeviceasasinglecashhandler
ordualcashhandlerconfiguredtoemulateasinglecash
handler

Tableentry6identifiescassettetype1

Queriesthefitnessofcassettetype3asfollows:

Tableentry2identifiescassettetype3,sotableentry4is
notchecked

Tableentry6isnotcheckedbecausetableentry4isnot
used

Queriesthefitnessofcassettetype3asfollows:

Tableentry2identifiescassettetype3,sotableentry4is
notchecked

Tableentry6isnotcheckedbecausetableentry4isnot
used

Queriesthefitnessofcassettetype3intheprimarycash
handlerasfollows:

Tableentry2isundefined,sotableentry4ischecked

Tableentry4identifiesthedeviceastheprimarycash
handler

Tableentry6identifiescassettetype3

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-71

State Tables
V - Language Select From Card State

VLanguageSelectFromCardState

Inthisstateyoucanuseonesetofstatetablestodisplayscreensin
differentlanguageswithinthesametransaction.Thisisdetermined
byacodeontheconsumerscard.Thecodeisaonecharacterfield
andislocatedusingtheLanguageCodeIndexparameter(PLNDX)
intheFIT.Formoredetails,seeChapter 8,FinancialInstitution
Tables.
Youcanuseuptosixscreengroupsinthisstate,andyouspecify
whichlanguageistobeusedineachgroup.Youalsospecifyintable
entry9howmanyscreenseachgroupwillcontain.Formoredetails,
seetheMultiLanguageScreenssectioninChapter 3,Screen
Data.
Table 2-40
V - Language Select from Card State
Table
Entry

Number of
Characters

Contents

Description

StateType

NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesafterselecting
thescreengroup.

LanguageCode
(Range09)

Decimalnumberintherange09identifyingthe
codeforscreengroup1.

LanguageCode
(Range09)

Decimalnumberintherange09identifyingthe
codeforscreengroup2.

LanguageCode
(Range09)

Decimalnumberintherange09identifyingthe
codeforscreengroup3.

LanguageCode
(Range09)

Decimalnumberintherange09identifyingthe
codeforscreengroup4.

LanguageCode
(Range09)

Decimalnumberintherange09identifyingthe
codeforscreengroup5.

LanguageCode
(Range09)

Decimalnumberintherange09identifyingthe
codeforscreengroup6.

ScreenGroupSize
(Range000400,where001
means1000)

Numberofscreensineachlanguagegroup.
Tospecify1000screens,setthisto001.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-72

APTRA Advance NDC, Reference Manual

State Tables
W - FDK Switch State

WFDKSwitchState

DataisplacedintheFDKbufferduringtheEightFDKSelection
FunctionstateortheFDKInformationEntrystate.Thisdataisread
bytheFDKSwitchstateinordertoidentifywhichnextstatetheSST
shouldgoto.
Table 2-41
W - FDK Switch State
Table
Entry

Number of
Characters

Contents

Description

StateType

FDKANextStateNumber

FDKBNextStateNumber

FDKCNextStateNumber

StatenumbertowhichtheSSTgoesdependingon
thekeycodestoredintheFDKbuffer
(Base10range000254or256999)
(Base36range000254or256ZZZ).

FDKDNextStateNumber

FDKFNextStateNumber

FDKGNextStateNumber

FDKHNextStateNumber

FDKINextStateNumber

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-73

State Tables
X - FDK Information Entry State

XFDKInformationEntryState

Tableentries29intheExtensiontothisstatecontainvaluesrelating
toFDKsAI.WhentheconsumerselectsanFDK,thisstate
placesthecorrespondingvalueintheGeneralPurposebufferor
AmountbufferthatyouhavespecifiedinTableEntry7.
Youcanusethisfunction,forexample,whenascreenoffersa
selectionoffixedamountsthattheconsumercanselectbypressing
aparticularFDK.ThisstatetranslatestheFDKselectedbythe
consumerintoavaluethatisplacedinthespecifiedbuffer.
TheFDKkeycodeisstoredintheFDKbufferforusebyanFDK
Switchstate.
TheSSTmaysupporttouchscreenFDKemulationinsteadof
regularFDKs.Inthiscase,eightfixedtouchareasaredefinedonthe
screen,whichtheconsumertouchesinsteadofpressingthe
correspondingFDK.Thetouchareasareenabled/disabledinexactly
thesamewayastheFDKs.Fordetails,seetheFDKEmulation
sectioninChapter 4,KeyboardDataandLayouts.
Alternatively,theSSTmaysupportfulltouchscreenkeyboards.In
thiscase,touchareasaredefinedonthescreenforalltherequired
keys.Theconsumertouchestheseinsteadofpressingakeyonthe
keypadoranFDK.Fordetails,seeChapter 4,KeyboardDataand
Layouts.
Note:Iftheconsumerhasselectedavoiceguidedsession,thisstate
checksAudioGuidanceData.xmltoidentifythenumerickeysusedto
representtheFDKs,whicharealsoactiveunlesstheconsumerhas
chosentohidescreens.
Table 2-42
X - FDK Information Entry State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptskeyselectionby
consumer.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
failstorespondtothemessagewithinthe
permittedtimelimit.Enter255ifthetimeout
functionisnotrequired.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-74

APTRA Advance NDC, Reference Manual

State Tables
X - FDK Information Entry State
Table
Entry

Number of
Characters

Contents

Description

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancel
keyispressed.

FDKNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifanFDKor
touchareaispressed.

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberofExtensionstatecontaining
assignedvaluesfortheeightFDKsortouchareas.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

BufferID
(Range010039)

Identifieswhichbufferistobeeditedandthe
numberofzerostobeaddedtothevaluesspecified
intheExtensionstate:
01XGeneralpurposebufferB.
02XGeneralpurposebufferC
03XAmountbuffer.SeeTableNote36and
Table 230.
Xspecifiesthenumberofzerosintherange09

FDKsActiveMask
(Range000255)

SpecifiestheFDKsortouchareasthatareactive
duringthisstate.EachbitrelatestoanFDKor
toucharea.Bit0relatestoFDKA(orFDKA
toucharea);bit7relatestoFDKI(orFDKItouch
area).Ifabitis1therelativeFDKortouchareais
active.Ifabitis0therelativeFDKortouchareais
inactive.SeeTableNote35.

Mustbe000

Reserved

TableNote35:Theeightbitsrepresentthebinaryequivalentofan
FDKActiveMask.Forexample,inthefollowingmask
b7

b6

b5

b4

b3

b2

b1

b0

thethreedecimalcharactersintableentry8are060andtheactive
FDKsortouchareasareC,D,FandG.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-75

State Tables
X - FDK Information Entry State

TableNote36:Ifused,theAmountbufferwillcontainuptotwelve
digits,dependingontheoptionselected.Ifthisstateisfollowedby
anAmountCheckstatewithanAmountCheckConditionsetto
000,theamountenteredisassumedtobeawholeamount.
TableNote37:Ifrequiredbythehost,thescreencanbe
configuredtoaddextrazerosautomaticallytotheamountbuffer,
afterthedecimalpoint.Thisconfigurationisdefinedinthe
AppendBuffer.xmlfiledescribedintheAPTRAAdvanceNDC,
DevelopersGuide.Thefilecanbeupdated,asdescribedinXML
ConfigurationDownloadonpage 1046,orcanbeinstalledlocally.
Table 2-43
Extension to State X
Table
Entry

Number of
Characters

Contents

Description

StateType

ValuestoredifFDKAorFDK
Atouchareapressed

ValuestoredifFDKBorFDK
Btouchareapressed

Eachtableentrycontainsavaluethatisstoredin
thebufferspecifiedintheassociatedFDK
InformationEntrystatetable(tableentry7)ifthe
specifiedFDKortouchareaispressed.
(Range000999or000ZZZ)

ValuestoredifFDKCorFDK
Ctouchareapressed

ValuestoredifFDKDorFDK
Dtouchareapressed

ValuestoredifFDKForFDK
Ftouchareapressed

ValuestoredifFDKGorFDK
Gtouchareapressed

ValuestoredifFDKHorFDK
Htouchareapressed

ValuestoredifFDKIorFDK
Itouchareapressed

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-76

APTRA Advance NDC, Reference Manual

State Tables
Y - Eight FDK Selection Function State

YEightFDKSelectionFunction
State

ThisstatereadstheFDKselectedbytheconsumer,storesthekey
codeinanFDKbufferforusebyanFDKSwitchstate,andupdates
theOperationCodebuffer.Ifyoudonotspecifyanextensionstate
intableentry6,thekeycodeoftheFDKselectedbytheconsumeris
storeddirectlyintheOperationCodebuffer.Ifyoudospecifyan
extensionstate,thekeycodeistranslatedintothreepseudokey
codes,whicharethenstoredintheOperationCodebuffer.
Youcanspecifyasecondextensionstateintableentry9toidentify
thescreenbasesformultilanguagescreendisplays.Ifyoudonot
specifythisextensionstate,thenmultilanguagedisplayisnotused.
TheSSTmaysupporttouchscreenFDKemulationinsteadof
regularFDKs.Inthiscase,eightfixedtouchareasaredefinedonthe
screen,whichtheconsumertouchesinsteadofpressingthe
correspondingFDK.Thetouchareasareenabled/disabledinexactly
thesamewayastheFDKs.Fordetails,seetheFDKEmulation
sectioninChapter 4,KeyboardDataandLayouts.
Alternatively,theSSTmaysupportfulltouchscreenkeyboards.In
thiscase,touchareasaredefinedonthescreenforalltherequired
keys.Theconsumertouchestheseinsteadofpressingakeyonthe
keypadoranFDK.Fordetails,seeChapter 4,KeyboardDataand
Layouts.
Note:Iftheconsumerhasselectedavoiceguidedsession,thisstate
checksAudioGuidanceData.xmltoidentifythenumerickeysusedto
representtheFDKs,whicharealsoactiveunlesstheconsumerhas
chosentohidescreens.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-77

State Tables
Y - Eight FDK Selection Function State
Table 2-44
Y - Eight FDK Selection Function State
Table
Entry

Number of
Characters

Contents

Description

StateType

ScreenNumber
(Range000999)

Displayscreenthatpromptskeyselectionbythe
consumer.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
doesnotrespondtothemessagewithinthe
specifiedtimelimit.Enter255ifthetimeout
functionisnotrequired.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
pressestheCancelkey.

FDKNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
pressesanFDKortoucharea.

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberofExtensionstatecontaining
assignedoperationcodesfortheeightFDKsor
touchareas.IfthereisnoExtensionstate,enter255.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

Bufferpositions
(Range000777)

IfthereisnoExtensionstate,thisdefinesthe
OperationCodebufferpositiontobeeditedbya
valueintherange000to007.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-78

APTRA Advance NDC, Reference Manual

State Tables
Y - Eight FDK Selection Function State
Table
Entry

Number of
Characters

Contents

Description

IfthereisanExtensionstate,thisspecifiesthree
bytesoftheOperationCodebuffertobesettothe
valuesspecifiedintheExtensionstate.Three
numericvalues,eachintherange0to7,are
specifiedtodefinethreepositionsinthe8byte
OperationCodebuffertobeedited.Thesethree
valuesmustbeorderedtocorrespondwiththeedit
charactersintheExtensionstate.Ifnobuffer
positionsorfewerthanthreebufferpositionsareto
beedited,thisisspecifiedintheExtensionstate.
8

FDKsActiveMask
(Range000255)

SpecifiestheFDKsortouchareasthatareactive
duringthisstate.EachbitrelatestoanFDKor
toucharea.Bit0relatestoFDKA(orFDKA
toucharea);bit7relatestoFDKI(orFDKItouch
area).Ifabitis1therelativeFDKortouchareais
active.Ifabitis0therelativeFDKortouchareais
inactive.SeeTableNote38.

MultiLanguageScreens
SelectionExtensionState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Ifthestateselectsthemultilanguagescreenbase,
thiscontainstheExtensionstatenumber.Ifthereis
noExtensionstate,enter000or255.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

TableNote38:Theeightbitsrepresentthebinaryequivalentofan
FDKActiveMask.Forexample,inthefollowingmask:
b7

b6

b5

b4

b3

b2

b1

b0

thethreedecimalcharactersintableentry8are060andtheactive
FDKsortouchareasareC,D,FandG.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-79

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

Number of
Characters

Contents

Description

StateType

OperationCodestoredifFDK
AorFDKAtouchareais
pressed.

OperationCodestoredifFDK
BorFDKBtouchareais
pressed.

OperationCodestoredifFDK
CorFDKCtouchareais
pressed.

EachtableentrycontainstheOperationCode
characterstobewrittentotheOperationCode
bufferifthespecifiedFDKortouchareaispressed.
Threecharactersarespecifiedforeachcode,which
mustbeintherangeAI.Theyarewritten,in
order,tothethreepositionsspecifiedinthe
associatedEightFDKSelectionFunctionstatetable
(tableentry7).Enter@ifnocharacteristobe
writtentoaspecifiedpositioninthebuffer.

OperationCodestoredifFDK
DorFDKDtouchareais
pressed.

OperationCodestoredifFDK
ForFDKFtouchareais
pressed.

OperationCodestoredifFDK
GorFDKGtouchareais
pressed.

OperationCodestoredifFDK
HorFDKHtouchareais
pressed.

OperationCodestoredifFDK
IorFDKItouchareais
pressed.

SeeTableNote39

TableNote39:IfspecifyingcharactersintherangeAtoIand@
causesdifficultieswiththestatetableeditor,youcanusevalues1
to9and0instead

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-80

APTRA Advance NDC, Reference Manual

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

Number of
Characters

Contents

Description

StateType

ScreenBaseifFDKAorFDK
Atouchareaispressed

ScreenBaseifFDKBorFDK
Btouchareaispressed

Eachtableentrycontainsthescreennumberofthe
firstscreenofeachlanguagegroup.Theinitialbase
is000,andallunusedfieldsshouldcontainthis
value.
SeeTableNote40

ScreenBaseifFDKCorFDK
Ctouchareaispressed

ScreenBaseifFDKDorFDK
Dtouchareaispressed

ScreenBaseifFDKForFDK
Ftouchareaispressed

ScreenBaseifFDKGorFDK
Gtouchareaispressed

ScreenBaseifFDKHorFDK
Htouchareaispressed

ScreenBaseifFDKIorFDKI
touchareaispressed

TableNote40:Whenamultilanguagescreenbaseintherange001
to009isspecified,itismultipliedby1000togive1000,2000,
3000....9000.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-81

State Tables
b - Customer-Selectable PIN State

bCustomerSelectablePINState

ThisstateallowstheconsumertoinputanewPIN.Itdiffersfrom
thePINentrystateinthenumberofretries.Thestatewillprompt
forthenewPINtwiceandwilltakeagoodexitifbotharethesame
andtheSSTcheckingfeatureisenabled.
Ifcheckingislocal,theexitwillbetakenwhenthetwonewPINs
havebeenbuiltintothePINblocksfortransmitting.Ifcheckingis
enabledandthetwoPINsenteredarenotthesametheconsumer
willbeaskedtoreentertheCustomerSelectablePIN(CSP)andthe
statewillnotexit.IftheFITspecifiesthatshortPINentryistobe
testedfor,shortPINswillberegardedasonetryagainstthelimit
specifiedinthestatetable.
Thescreenassociationforthisstateisderivedfromthescreen
specifiedintableentry2.TheconsumerPINisenteredonthefacia
keyboardandconsistsoffourtosixteendigits.Ifthenumberof
digitsenteredislessthanthevaluespecifiedintheFITentry
PMXPNtheconsumermustpressFDKA(orFDKIiftheoption
enablingthekeystotheleftoftheconsumerscreenisset)orthe
ENTERkeyonthefaciakeyboardafterthelastdigitentered.Note
thatpressingtheCLEARkeyonthefaciaclearsallthedigits.
Table 2-47
b - Customer-Selectable PIN State
Table
Entry

Number of
Characters

Contents

Description

StateType

FirstEntryScreenNumber
(Range000999)

Displayscreenthatpromptstheconsumertoenter
thePINthefirsttime.

TimeOutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
doesnotmakeaCSPentrywithinthespecified
timelimit.Enter255ifthetimeoutfunctionisnot
required.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
pressestheCancelkeytostoptheCSPtransaction.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-82

APTRA Advance NDC, Reference Manual

State Tables
b - Customer-Selectable PIN State
Table
Entry

Number of
Characters

Contents

Description

GoodNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
entersamatchingpairofnewPINvalues.

CSPFailNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumer
failstoenteramatchingpairofnewPINdigitsor
themaximumnumberofretriesforlocalPIN
checkingisreached.
Thisisalsotakenif:

ThereisnoFITmatch.

PINblockgenerationfails.Notethattheoption
tosendthePINbufferirrespectiveoffailure
doesnotoperate.

SecondEntryScreenNumber
(Range000999)

Displayscreenusedtoaskforconfirmationofthe
CSP.

MisMatchFirstEntryScreen
Number
Range(000999)

Displayscreenthatreplacesthescreenfortable
entry2oneachattemptafteraCSPpairattempt
didnotmatchoranerrorhasoccurredandthere
arestillfurtherretriesallowed.

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberoftheExtensionstate.
Formoreinformationaboutextensionstates,see
ExtensionStatesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-83

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

Number of
Characters

Contents

Description

StateType

Numberofattemptsallowedto
enteramatchingCSPpair
(Range000010)

Limitsthenumberofattemptstheconsumermay
maketoselectanewPIN.Avalueof0isnolimit.

Uselocalverificationofnew
PINpairattempts
(Range000001)

Specifieswhichattemptsaretobeverifiedlocally:
0Donotverifylocally.Makeattemptsavailablein
transactionrequestfieldsUandV.
1Verifybothattemptslocally.Resultavailablein
transactionrequestfieldU.Thisoptionisnot
possiblewhenusingBanksysPINblock
encryption.Arandomnumberisusedaspartofthe
encryptionandthereforenotwoconsecutivekeys
willbethesame.IfitisselectedtheCSPFailNext
StatewillbetakenwhenanattempttoenterPINsis
made.
SeeTableNote41

49

18

Mustbe000

Reserved.

TableNote41:IflocalcheckforshortPINsisspecified,itis
possibletohavetheCSPfailurescreendisplayedafterashortfirst
PINentry.ThewordingoftheCSPfailscreenshouldavoid
confusion,forexample,ThereisaproblemwiththenewPIN
pleasereenterwiththesecondPINentryscreenwordedPlease
reenterPINtoconfirmnewnumber.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-84

APTRA Advance NDC, Reference Manual

State Tables
d ... g and z - Exit States

d...gandzExitStates

StateidentificationlettersdtogarereservedforExitstates.For
furtherinformation,refertotheNCRpublicationAPTRAAdvance
NDC,ExtendingtheProduct.
Substates900to999underMasterExpansionstatezarealso
reservedforcustomerExitstates.Fordetails,seezMaster
ExpansionStateonpage 2112.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-85

State Tables
k - Smart FIT Check State

kSmartFITCheckState

ThisstateisrequiredwhenchipdataistobeusedinaFITcheck.
TheSmartFITCheckstateisdesignedtobeenteredfromyourown
CExitstate,suchastheexampleChipDataReadstate,whichwill
havereadthechipdatafromthesmartcardandplacedthedatain
themagnetictrackbuffers.FordetailsoftheexampleChipData
Readstate,seeChapter 12,EMVSmartCardHandling.
TheSmartFITCheckstatethenperformsaFITcheckforaSmart
Card.
ItispossibletocreatemorethanoneSmartFITCheckstateto
accommodatemultipleFITchecks.ThiswouldallowdifferentFIT
checkstobeperformedondatafromthesamecard.
Table 2-49
k - Smart FIT Check State
Table
Entry

No. of
Chars

Contents

Description

Statetype

k(6BH)

Reserved(000)

Notusedsetto0.

GoodReadNext
StateNumber
(Base10range
000254or256999)
(Base36range
000254or256ZZZ)

StatenumbertowhichtheSSTgoesiftheFinancialInstitutionnumber
onthecardmatchesaFinancialInstitutionnumberintheFIT.

Reserved(000)

Notusedsetto0.

Reserved(000)

Notusedsetto0.

Reserved(000)

Notusedsetto0.

Reserved(000)

Notusedsetto0.

CardReturnFlag

TellstheSSTwhenthecardshouldbereturnedtotheconsumer:
000ejectthecardimmediately
001returnthecardasspecifiedbyaTransactionReplymessage.

NoFITMatchNext
StateNumber

StatetakeniftheFITcheckfails.
ThestatemaybeaClosestate,orareturntoanotherCExitstatewhich
placesthechipdatainthereadbuffersbeforecallinganotherSmart
FITCheckstate.
IfFITsarenotused,thisentrymustbe000.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-86

APTRA Advance NDC, Reference Manual

State Tables
m - PIN & Language Select State

mPIN&LanguageSelectState

ThisstateperformsthesamefunctionsasthePINEntrystate(state
BorM)combinedwiththefunctionalityoftheEightFDK
SelectionFunctionstate(stateY).Thisstateallowslanguage
selectionfromanFDKfollowingthePINentry.Allthefunctionality
andconditionsofPINEntryandEightFDKSelectionstatesapplyto
thisstate.
Thisstatealsohasseveraltableentriesthatareincludedinthefirst
extensionstate.Normally,theconsumerentersthePIN,which
consistsoffourtosixteendigits,onthefaciakeyboard.Ifa
consumerentersfewerthanthenumberofdigitsspecifiedintheFIT
entry,PMXPN,theconsumermustpressanactiveFDK(asdefined
bytheFDKsActiveMask)ortheEnterkeyafterenteringthelast
digit.Otherwise,Autoentertakesonthelanguageassignedtothe
Enterkey.IftheEnterkeyisnotactiveonthekeyboard,theSST
usesthefirstactiveFDK.
IftheconsumerdoesnotenteraPIN,butpressesanActiveFDKto
selectalanguage,theSSTtakestheNoPINEnteredNextState
Number(tableentry2)exit.TheSSTnormallyentersthePINEntry
state(stateBorM)ifthisoccurs.
IftheFITspecifieslocalDESPINverificationandtheconsumer
entersanincorrectPIN,theSSTtakestheLocalPINEntryError
NextStateNumber(tableentry5)exit.Usually,aPINEntrystate
(stateBorM)isplacedinthisentryandthescreendisplayedisin
thelanguagejustselected.
IftheconsumerpressestheEnterkeyorAutoenterisusedtoaccept
thePIN,theFDKEnterKeyDefaultMask(tableentry9)defines
whichFDKkeycode,andthereforetheScreenBase,tostoreinthe
FDKbuffer.
ThestateBorstateMtableentrydefineswhetherthemaximum
retrycountisonTrack3ofthecardorinthestatetable.Previously,
NDC+usedtwoseparatestates,statesBandM,toimplementthis
functionality.Tosupportthisfunction,theFITmustspecifylocal
PINcheckandindicatethatthereisaTrack3retryfieldonthecard.
FormoreinformationaboutthePINEntrystate,seeBPINEntry
Stateonpage 211.FormoreinformationaboutEightFDK
SelectionFunctionstate,seeYEightFDKSelectionFunction
Stateonpage 277.
Iftheconsumerhasselectedavoiceguidedsession,thisstateis
usedonlyforPINentryandnotforlanguageselection.Fordetails
ofthevoiceguidanceXMLconfigurationfile,refertotheAPTRA
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-87

State Tables
m - PIN & Language Select State

AdvanceNDC,DevelopersGuide.Thefollowingmustbeconsidered
whenvoiceguidanceisenabled:

Thescreenoffsetvaluesusedinthisstatementmustmatchthe
screenOffsetsubelementdefinedintheXMLconfiguration
fileforvoiceguidance.Thesecondarylanguagesmustmatchthe
offsetusedinthescreensandstatesdownloadedfromCentral.
Thelanguageselection,performedaspartofinitialisationofa
voiceguidedsession,determinesthelanguageoffsetusedfor
thetransactionscreens
TheEnterkeymustbeactiveinthisstate
IftheopCodePossubelementisusedintheXMLconfiguration
file,thisstatemustusethesamebufferpositionintableentry7.
TheXMLconfigurationfilecanuseadifferentvaluethanthat
usedinthisstatetoidentifywhetherthesessionisa
voiceguidedsession
TheSSTwillechokeyselectionwithabeeponlyifthe
informationisnotdisplayedonthescreen
IfthisstaterequiresbothFDKsandnumerickeys,the
voiceguidedsessioncannotmaptheFDKstothenumeric
keypad.

Table 2-50
m - PIN & Language Select State
Table
Entry

No of
Chars

Contents

Description

StateType

m(ASCII6d,EBCDIC94)

ScreenNumber
(Range000999)

DisplayscreenthatpromptstheconsumertoenterthePINand
selectalanguageforthefirsttime.Thisscreen,whichis
displayedonenteringthePIN&LanguageSelectstate,must
leavethecursoratthestartofthePINEntrydisplayarea.An
asterisk(*)isdisplayedforeachkeypressed.

TimeOutNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerdoesnot
enterthePINwithinthepermittedtimelimit.Ifthetimeout
functionisnotrequired,enterstatenumber255.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerpressesthe
Cancelkeybeforethemaximumnumberofdigitsspecifiedfor
thePINhavebeenentered.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-88

APTRA Advance NDC, Reference Manual

State Tables
m - PIN & Language Select State
Table
Entry

No of
Chars

Contents

Description

NextStateOptions
ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberofExtensionstatecontainingthePINoptions;
theNextStatenumbersthattheSSTentersafterthePINis
entered;andtheFDKsEnterKeyMask.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

OperationCodesExtension
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

ThisentryisthesameasstateY,tableentry6.
StatenumberoftheExtensionstatecontainingassigned
operationcodesfortheeightFDKsortouchareas.
IfthereisnoExtensionstate,enter255.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

BufferPositions
(Range000777)

ThisentryisthesameasstateY,tableentry7.
IfthereisnoExtensionstate,thisdefinestheOperationCode
bufferpositiontobeeditedbyavalueintherange000to007.
IfthereisanExtensionstate,thisspecifiesthreebytesofthe
OperationCodebuffertobesettothevaluesspecifiedinthe
Extensionstate.Threenumericvalues,eachintherange0to7,
arespecifiedtodefinethreepositionsinthe8byteOperation
Codebuffertobeedited.Thesethreevaluesmustbeorderedto
correspondwiththeeditcharactersintheExtensionstate.Ifno
bufferpositionsorfewerthanthreebufferpositionsaretobe
edited,thisisspecifiedintheExtensionstate.Valuesgreater
than7willbeignored.

FDKsActiveMask
(Range000255)

ThisentryisthesameasstateY,tableentry8.
SpecifiestheFDKsortouchareasthatareactiveduringthis
state.EachbitrelatestoanFDKortoucharea.
Bit0relatestoFDKA(orFDKAtoucharea);bit7relatesto
FDKI(orFDKItoucharea).Ifabitis1therelativeFDKor
touchareaisactive.Ifabitis0therelativeFDKortouchareais
inactive.Valuesabove255willbeaccepted,butonlybits07
willbeused.
SeeTableNote42.

MultiLanguageScreens
SelectionExtensionState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

ThisentryisthesameasStateY,tableentry9.
Ifthestateselectsthemultilanguagescreenbase,thiscontains
theExtensionstatenumber.IfthereisnoExtensionstate,enter
000or255.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

TableNote42:Theeightbitsrepresentthebinaryequivalentofan
FDKActiveMask.Forexample,inthefollowingmask,thethree
decimalcharactersintableentry8are060andtheactiveFDKsor
touchareasareC,D,FandG:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-89

State Tables
m - PIN & Language Select State
Table 2-51
PIN & Language FDK Active Mask

b7

b6

b5

b4

b3

b2

b1

b0

Table 2-52
Extension 1 to State m
Table
Entry

No of
Chars

Contents

Description

Statetype

Z(ASCII5a,EBCDICE9)

NoPINEnteredNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerdoes
notenteraPIN,butselectsalanguagefromanactiveFDK
ortoucharea.TheSSTnormallyentersthePINEntrystate
(stateBorM)ifthisoccurs.

LocalPINCheckGoodPIN
NextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

ThisentryisthesameasstateB,tableentry5.
StatenumbertowhichtheSSTgoesafterverificationofa
correctPINentry.

LocalPINCheckMaximum
BadPINsNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

ThisentryisthesameasstateB,tableentry6.
StatenumbertowhichtheSSTgoesifthecorrectPINhas
notbeenenteredafterthenumberofattemptsallowedby
tableentry7.TheSSTnormallyentersaClosestateifthis
occurs.
SeeTableNote43.

LocalPINCheckErrorNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifanincorrectPINis
entered.TheSSTnormallyentersthePINEntrystate(state
BorM)inthelanguageselectedfromthisstateasyou
cannotgobacktothemstate,sincethereisnoerrorscreen
forbadPINentry.Thisstatetypeshouldmatchthestate
typeidentifiedintableentry8below.

RemotePINCheckNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

ThisentryisthesameasstateB,tableentry8.
StatenumbertowhichtheSSTgoeswhenlocalPIN
verificationisnotperformed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-90

APTRA Advance NDC, Reference Manual

State Tables
m - PIN & Language Select State
Table
Entry

No of
Chars

Contents

Description

LocalPINCheckMaximum
PINRetries(Range001009)

ThisentryisthesameasstateB,tableentry9.
MaximumnumberofincorrectPINentriesallowedbefore
theSSTentersthestatedeterminedbytableentry4.
SeeTableNote43.

StateBorMOption
(Range000001)

SpecifieswhethertouseTrack3retriesonthecardorfrom
thestatetable.Enter000ifPINEntrystateBfunctionality
isneeded.Enter001ifEnhancedPINEntrystateM
functionalityisneeded.

FDKEnterKeyDefaultMask
(Range000128)

SpecifiestheFDKortouchareathatisthedefaultlanguage
iftheEnterkeyonthekeypadispressedinsteadofan
FDK.EachbitrelatestoanFDKortoucharea.Bit0relates
toFDKA(orFDKAtoucharea);bit7relatestoFDKI(or
FDKItoucharea).Setthebittoa1tomakethatFDKthe
defaultEnterkeyvalue.ThemappedFDKwillbeseteven
iftheFDKisinactive.Onlyonebitshouldbesetto1;all
otherbitsshouldbe0.Ifallbitsaresetto0,theEnterkey
willnotbeactive.

TableNote43:ThesefieldsarealsousedwhentheCheckRemote
PINminimumlengthoptionisused.Theyareusedinthesameway
asforLocalPINverification.AnincorrectPINisonewhichisless
thantheminimumlength.
Table 2-53
Extension
2 to State m

Table
Entry

No of
Chars

Contents

Description

StateType

Z(ASCII5a,EBCDICE9)

OperationCodestoredifFDKA
orFDKAtouchareapressed

OperationCodestoredifFDKB
orFDKBtouchareapressed

OperationCodestoredifFDKC
orFDKCtouchareapressed

OperationCodestoredifFDKD
orFDKDtouchareapressed

EachtableentrycontainstheOperationCodecharactersto
bewrittentotheOperationCodebufferifthespecified
FDKortouchareaispressed.
Threecharactersarespecifiedforeachcode,whichmustbe
intherangeAI.Theyarewritten,inorder,tothethree
positionsspecifiedintheassociatedEightFDKSelection
Functionstatetable(tableentry7).Enter@ifnocharacter
istobewrittentoaspecifiedpositioninthebuffer.
Note:IfspecifyingcharactersintherangeAtoIand@
causesdifficultieswiththestatetableeditor,youcanuse
values1to9and0instead.

OperationCodestoredifFDKF
orFDKFtouchareapressed

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-91

State Tables
m - PIN & Language Select State
Table
Entry

No of
Chars

Contents

Description

OperationCodestoredifFDKG
orFDKGtouchareapressed

OperationCodestoredifFDKH
orFDKHtouchareapressed

OperationCodestoredifFDKI
orFDKItouchareapressed

Table 2-54
Extension 3 to State m
Table
Entry

No of
Chars

Contents

Description

StateType

Z(ASCII5a,EBCDICE9)

ScreenBaseifFDKAorFDKA
touchareaispressed

ScreenBaseifFDKBorFDKB
touchareaispressed

Eachtableentrycontainsthescreennumberofthefirst
screenofeachlanguagegroup.Theinitialbaseis000,and
allunusedfieldsshouldcontainthisvalue.

ScreenBaseifFDKCorFDKC
touchareaispressed

ScreenBaseifFDKDorFDKD
touchareaispressed

ScreenBaseifFDKForFDKF
touchareaispressed

ScreenBaseifFDKGorFDKG
touchareaispressed

ScreenBaseifFDKHorFDKH
touchareaispressed

ScreenBaseifFDKIorFDKI
touchareaispressed

SeeTableNote44

TableNote44:ThisExtensionstateisthesameastheExtension2
tostateY,Table 246onpage 281.
Whenamultilanguagescreenbaseintherange001to009is
specified,itismultipliedby1000togive1000,2000,3000,9000.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-92

APTRA Advance NDC, Reference Manual

State Tables
> - Cash Accept State

>CashAcceptState

Ifacashacceptorispresent,thisstatecanbeusedtoletthe
consumerdepositsinglenotesorbunchesofnotes.
MostofthecashdeposittransactionisnotcontrolledbyCentral,as
thetimetakenforasuccessfulcashdepositcouldexceedthe
transactionrequest/replytimers.Forthisreason,theprocessingofa
cashdeposittransactionisperformedbytheCashAcceptstate
beforeatransactionrequestissent.Cashacceptorunsolicited
messagesaresenttoinformCentralwhennoteshavebeen
processedorwhenanerroroccurs.
Understatetablecontrol,theCashAcceptstateperformsthe
following:
1

Activates/deactivatesacceptablenotetypesaccordingtothe
stateparametersinTable 258Extension3toState>(Cash
Accept)onpage 2100(SetNDCnotetype112...4950).
Note:Extension3ismandatoryfortheCashAcceptstate.

Acceptsasinglenoteorabunchofnotesdependingonthe
devicetype
Note:Whetherthebunchofnotesisstoredintheescrow
(refundabledeposit)ordepositeddirectlytothecassettes(direct
deposit)isdefinedintableentry5ofextensionstate4.For
details,seeTable 259,Extension4toState>(CashAccept)on
page 2102.

Identifiesthenotes

Checksthenotetypeanddenominationareactive;thatis,that
thenotetypeanddenominationareacceptedbyCentral

Returnsinvalidorinactivenotestotheconsumer

Processesanynotesidentifiedascategory2(suspect)or
category3(counterfeit)

Ifrefundabledepositisconfigured,refundsnotesifthereare
morenotesthantheescrowcapacityortheconsumerchoosesa
refundofanygoodnotesintheescrow.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-93

State Tables
> - Cash Accept State

Ifthecashacceptorhasretractcapabilitiesandretractisenabled,
retractsreturnednotesthathavenotbeentakenwithinthetime
specifiedbytheretracttimer

Whenextendedjournalingisenabledwithjournallevel3set,
journalseachconsumerinteraction,includingtimeouts.For
moreinformationaboutextendedjournalingandjournallevels,
refertotheAPTRAAdvanceNDC,SupervisorsGuide.

10 Onasinglenoteacceptor,foreachprocessednote,journalsthe
cumulativecountsandsendsanunsolicitedstatusmessagewith
thesamedetails.Onbunchnoteacceptors,doesthesamefor
eachprocessedbunchofnotes.
Iftheconsumercancelsthetransaction,CANCELisjournaled.
Ifthetransactiontimesout,CUSTOMER TIMEOUTisjournaled.
Table 2-55
> - Cash Accept State
Table
Entry

No. of
Chars

Contents

Description

Statetype

>(6EH)

CancelKeyMask

SpecifiestheCancel FDKwhichisactivewhenthePleaseEnter
Notesscreen,Confirmationscreen,CounterfeitNotesRetained
screenorEscrowFullscreenisdisplayed.SeeTableNote45,Table
Note46andTableNote47

DepositKeyMask

SpecifiestheDeposit FDKwhichisactivewhentheConfirmation
screen,CounterfeitNotesRetainedscreenorEscrowFullscreenis
displayed.SeeTableNote45andTableNote50

AddMoreKeyMask

SpecifiestheAdd More FDKwhichisactivewhentheConfirmation


screenisdisplayed.Forbothtypesofdeposit,whenanAdd More
FDKisenabled(AddMoreKeyMaskisnot000),thecashacceptor
isnotenabledwhiletheConfirmationscreenisdisplayed.
Fordirectdeposit,whennokeyisenabled(AddMoreKeyMaskis
000)andtheCashInAutoEnabledpropertyissetin
CashInCustom.accfg,thecashacceptorisenabledwhilethe
Confirmationscreenisdisplayed.

RefundKeyMask

SpecifiestheRefundFDKwhichisactivewhentheConfirmation
screenorEscrowFullscreenisdisplayed.SeeTableNote45and
TableNote49
Fordirectdeposits,thisvalueisignored

ExtensionState1
Base10range000254or
256999)
(Base36range000254
or256ZZZ)

Statenumberforextension1
SeeExtension1toState>(CashAccept)
Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-94

APTRA Advance NDC, Reference Manual

State Tables
> - Cash Accept State
Table
Entry

No. of
Chars

Contents

Description

ExtensionState2
Base10range000254or
256999)
(Base36range000254
or256ZZZ)

Statenumberforextension2
SeeExtension2toState>(CashAccept)onpage 298

ExtensionState3
Base10range000254or
256999)
(Base36range000254
or256ZZZ)

Statenumberforextension3
SeeExtension3toState>(CashAccept)onpage 2100

ExtensionState4
Base10range000254or
256999)
(Base36range000254
or256ZZZ)

Statenumberforextension4
SeeExtension4toState>(CashAccept)onpage 2102

Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.

Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.

Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.

TableNote45:EachbitrelatestoanFDK;Bit0relatestoFDKA,
Bit7relatestoFDKI.Ifabitis1,thecorrespondingFDKisactive.If
abitis0,thecorrespondingFDKisinactive.ThesameFDKshould
bedefinedonlyinonekeymaskthatisactiveatthesametimeas
otherkeymasks.Forexample,intheConfirmationscreen,thekey
masksusedfortheCancel,Deposit,Add MoreandRefundfunctions
shouldeachactivateadifferentkey.
TableNote46:IftheCancelkeyispressedbeforenotesareentered,
theCancelNextStateNumbertableentryistaken.IftheCancelkey
ispressedintheEnterNotesscreenwhentherearenotesinthe
escrow,theConfirmationscreenisdisplayed.IftheCancelkeyis
pressedattheConfirmationscreen,thenotesarerefundedandthe
CancelNextStateNumbertableentryistaken.
TableNote47:Ifdirectdepositisconfigured,theCancelkeyisnot
enabledintheConfirmationorEscrowFullscreens.Thisisthecase
whethertheCancelkeyisconfiguredasanFDKorPINPadkey.
TableNote48:Ifdirectdepositisconfigured,theAdd Morekeycan
beenabledbutisnotrequired.
TableNote49:Ifdirectdepositisconfigured,theRefundkeyisnot
enabled.
TableNote50:IftheFDKspecifiedintheDepositKeyMasktable
entryisselectedfromtheConfirmationScreen,theGoodNextState
Numbertableentrywillbetaken.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-95

State Tables
> - Cash Accept State
Table 2-56
Extension 1 to State > (Cash Accept)
Table
Entry

No of
Chars

Contents

Description

Statetype

PleaseEnterNotesScreen
(Range000999)

Thisscreenisdisplayedwhenthecashacceptorhasbeen
successfullyenabled(orreenabled)toacceptacashdeposit
fromtheconsumer.
SeeTableNote51

PleaseRemoveNotes
Screen
(Range000999)

Thisscreenisdisplayedwhenthecashacceptorhasrefundedor
rejectednotestotheconsumer.
SeeTableNote52

ConfirmationScreen
(Range000999)

Thisscreenisdisplayedwhenallthenoteshavebeenprocessed
andarevalidoridentifiedassuspectorcounterfeitnotesunder
ECB6.
Thescreenshowshowmanynotesofeachdenominationare
validorareretainedundertheECB6regulations,withfurther
optionsfortheconsumer.Dependingonthedisplaymodeand
confirmationscreenconfiguration,itcanalsodisplaythetotal
amounttobedepositedorthenotesstillremainingtobe
deposited.Whensuspectorcounterfeitnotesaredetected,this
screenisprecededbytheCounterfeitNotesRetainedscreen.
SeeTableNote53andConfirmationScreenonpage 2103

HardwareErrorScreen
(Range000999)

Thisscreenisdisplayedforthetimespecifiedbytimer63(by
default,15seconds)whenahardwareerror(forexampleanote
jam)occurs,sothatthetransactioncannotcontinue.
SeeTableNote54

EscrowFullScreen
(Range000999)

Thisscreenisdisplayedwhenthemaximumnumberofnotes
thatcanbeheldintheescrowisreached.
Ifdirectdepositisconfigured,thisisdisplayedwhenthedirect
depositlimitisreached.
SeeTableNote55

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-96

APTRA Advance NDC, Reference Manual

State Tables
> - Cash Accept State
Table
Entry

No of
Chars

Contents

Description

ProcessingNotesScreen
(Range000999)

Thisscreenisdisplayedwhilenotesarebeingprocessedafter
entrytothecashacceptor.

PleaseRemoveMorethan
90NotesScreen(Range
000999)

Thisscreenisdisplayedwhenthecashacceptorrefundsnotesto
theconsumerbecausethenumbernotesintheescrowexceeds
thesetcapacity.Thisscreenisdisplayedwhenallthenotesare
refundedtotheconsumerbecausemorethan90noteshavebeen
insertedbutsupportformorethan90notesisnotenabledas
describedinOption45:BNASettingsBitValueson
page 714.
SeeTableNote56

PleaseWaitScreen(Range
000999)

Thisscreenisdisplayedasfollows:
Untilthecashacceptorisreadytoacceptnotes.

WhentheRefundkeyisselectedanduntilthenotesare
readytobetaken

Whennoteinsertioniscancelled

WhentheMore Timekeyisselectedduringnoteentry.

Ifthisscreenissetto000,oneofthefollowingoccurs:

ThegenericPleaseWaitscreen(C20)isdisplayedifitis
defined

Thescreendisplayedbeforeentrytothisstatecontinuesto
bedisplayedifthegenericPleaseWaitscreenisnot
defined.

TableNote51:Ifthecashacceptorissuccessfullyenabled,the
screendefinedbythePleaseEnterNotesscreenwillbedisplayed,
andtheCancelKeyMaskwillbeused.Whenthecashacceptoris
reenabled,forexample,bypressingtheAdd Morekeyonthe
Confirmationscreen,pressingtheCancelkeyreturnscontroltothe
Confirmationscreen.
TableNote52:IftheRemoveRefusedNotesscreenisdefined(see
tableentry8inExtension3toState>(CashAccept)on
page 2100)andnotesareautomaticallyrejectedortheconsumer
requestsarefundwhenallthenotesareintheescrow,thePlease
RemoveNotesscreenwillbedisplayedwhenthenotesareatthe
refundslot.
TableNote53:Theformatofthedynamicdataforthe
ConfirmationandEscrowFullscreensisdefinedinthe
CashInCustom.accfgconfigurationfile.Thedynamicdatacanbe
adjustedforthetransactionlanguageasmultilingualsupportis
provided.Thesedefaultscreenscontaindisplaysofthe
denominationsintheescrowcountsor,ifdirectdepositis
configured,thevaultedcounts.Ifdirectdepositisconfiguredand
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-97

State Tables
> - Cash Accept State

dependingontheconfigurationdescribedintheAddMoreKey
Maskfieldofthe>CashAcceptStateonpage 294,thecash
acceptorisenabledwhilethescreenisdisplayed.Formore
informationabouttheconfigurationofdynamicdata,refertothe
APTRAAdvanceNDCDevelopersGuide,chapter5,Configuring
AdvanceNDCandAssociatedComponents.
TableNote54:Ifadeviceerrorsuchasanotejamoccurs,the
followingisperformed:
1

ThescreendefinedbytheHardwareErrorScreentableentryis
displayed.

AnunsolicitedstatusmessageissenttoCentralcontainingthe
errorinformation.

Timer63expires.

TheDeviceErrorNextStateNumbertableentryistaken.

TableNote55:Ifthemaximumnumberofnotesthatcanbeheldin
theescrowisreached,theEscrowFullscreenisdisplayed,andthe
Add Morekeyisnotenabled.Ifdirectdepositisconfigured,notes
cannotberefundedsonotallkeysinthescreenwillbeenabled.
TableNote56:Ifdirectdepositisconfigured,thisscreenisnot
used.
Table 2-57
Extension 2 to State > (Cash Accept)
Table
Entry

No of
Chars

Contents

Description

Statetype

GoodNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertheSSTgoestowhentheDepositkeyisselected.

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertheSSTgoestoiftheconsumerpressestheCancel
keytostoptheCashDeposittransactionorselectsRefundon
theConfirmationscreenandtakesthenotesorthenotesare
retracted.
SeeTableNote57andTableNote58

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-98

APTRA Advance NDC, Reference Manual

State Tables
> - Cash Accept State
Table
Entry

No of
Chars

Contents

Description

DeviceErrorNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertheSSTgoestoifanerroroccursthatmayrequire
subsequentactionbyCentral.

TimeoutNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertheSSTgoestoiftheconsumerfailstoenternotes
intotheBNAbeforetimer77expires,orfailstorespondtothe
promptsontheTimeoutscreen.
SeeTableNote59

NotesatRefundSlotNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertheSSTgoestoifthenotesremainattherefund
slotaftertimer78expires.Applicableonlyiftheretractoptionis
notconfigured.

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

RetractingNotesScreen
(Range000999)

Thisscreenisdisplayedwhenretractoperationsareenabledby
Option45andnotespresentedforremovalarebeingretracted.
Ifthisissetto000,thegenericPleaseWaitscreen(C20)screen
isdisplayedifitisdefined

TableNote57:Ifrefundabledepositisconfigured,andtheCancel
keyortheRefundkeyispressedafterthenoteshavebeenentered
andnosuspectorcounterfeitnotesaredetected,thenotesare
returnedtotheconsumerandthisnextstateistaken.Inaddition,if
suspectorcounterfeitnotesaredetected,theyareprocessed
accordingtothelevelofECB6regulationenabledthroughthe
GBXXconfigurationfile.Fordetails,refertoChapter5,
ConfiguringAdvanceNDCandSupportApplicationsinthe
APTRAAdvanceNDC,DevelopersGuide.Ifdirectdepositis
configured,theCancelNextStateNumberexitcanonlybetaken
beforevalidnotesareinserted.
TableNote58:IftheCancelkeyispressedafterselectingtheAdd
MoreFDK,thePleaseWaitscreenmaybedisplayedbeforethe
screendefinedbytheConfirmationscreen(tableentry4in
Extension1toState>(CashAccept))isredisplayed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-99

State Tables
> - Cash Accept State

TableNote59:Ifnotesareintheescrowwhenatimeoutoccurs,
theTimeoutNextStateexitistaken.WhentheClosestateis
reached,theBNANotesReturn/Retain/LeaveFlagintheExtension
totheClosestatedefineswhethernotesareleftintheescrow,
refunded,orvaulted.Thehostisthereforeincontrolofwhat
happens,eitherdirectlythroughatransactionrequeststate,or
indirectlybyspecifyingaClosestate.Indirectdeposits,somenotes
mayhavebeenalreadydepositedwhenthisexitistaken.
Table 2-58
Extension 3 to State > (Cash Accept)
Table
Entry

No of
Chars

Contents

Description

Statetype

SetNDCnotetype
112

ThethreeASCIIcharactersrepresent4bitnibblehexadecimal
values.Eachcharacterrepresentsabitmapstartingfromthe
rightmostcharacter.TheindividualbitssettheNDCnotetypes
toactiveorinactive.Forexample,sendingHexvalues10Esets
notetypes2,3,4and9toactive.Theothersintherangeare
inactive.TheactiveNDCnotetypeswillbeacceptedbythe
BNA.
SeeTableNote60andTableNote61
Hexvalues10Earebrokendowntobinaryasfollows:
1
0
E
0001 00001110
Takingindex1astherightmostdigitandindex12astheleft
mostdigit,theactivenotessetwillbenotesindexed2,3,4and
9.
SeeTableNote62

SetNDCnotetype
1324

ThethreeASCIIcharactersrepresentthreebitmaps,starting
fromtherightmostcharacter.TheindividualbitssettheNDC
notetypestoactiveorinactive.ThebitsmaptoNDCnotetypes
13to24.
SeeTableNote61

SetNDCnotetype
2536

ThethreeASCIIcharactersrepresentthreebitmaps,starting
fromtherightmostcharacter.TheindividualbitssettheNDC
notetypestoactiveorinactive.ThebitsmaptoNDCnotetypes
25to36.
SeeTableNote61

SetNDCnotetype
3748

ThethreeASCIIcharactersrepresentthreebitmaps,starting
fromtherightmostcharacter.TheindividualbitssettheNDC
notetypestoactiveorinactive.ThebitsmaptoNDCnotetypes
37to48.
SeeTableNote61

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-100

APTRA Advance NDC, Reference Manual

State Tables
> - Cash Accept State
Table
Entry

No of
Chars

Contents

Description

SetNDCnotetype
4950

ThethreeASCIIcharactersrepresentthreebitmaps,starting
fromtherightmostcharacter.TheindividualbitssettheNDC
notetypestoactiveorinactive.Bits48and49maptoNDCnote
types49and50respectively.
SeeTableNote61

Reserved(000)

Reservedforfutureuse.

RemoveRefusedNotes
Screen
(Range000999)

Displayedwhennotesarerefusedbythedeviceandreturnedto
theconsumer.
Ifthisissetto000,thescreenidentifiedinthePleaseRemove
NotesScreenisdisplayed.
Ifthereasonfortherefusalistobedisplayed,thereasonsmust
bedefinedinadisplaydynamictextdictionarycontrol
sequencewithinthisscreendefinition.Thereasonsfornote
refusalmustbeincludedasdescribedinDefiningReasonsfor
NoteRefusalonpage 2104
SeeTableNote63

CounterfeitNotesRetained
Screen
(Range000999)

Displayedtoprovideextrainformationtotheconsumerabout
howtoproceedwhencounterfeitorsuspectnotesareretained
underECB6regulations.Thescreencanbecustomised.For
example,itcouldcontaininformationsuchasNOTES
RETAINED FOR VERIFICATION. PLEASE CONTACT YOUR
BRANCH.
Thescreenalsoshowstheactualnumberofnotesretained
underECB6regulations,andpromptstheconsumertocontinue
totheconfirmationscreen,orcancelthetransaction.The
DepositKeyMaskisusedfortheContinueFDKandtheCancel
KeyMaskfortheCancelFDK.Iftheconsumerdoesnotrespond
tothepromptbeforetimer00expires,theConfirmationscreen
isdisplayed.
Thecountisdisplayedatthecurrentscreencursorposition.
IfdirectdepositsareacceptedbytheSST,nonotescanbe
returnedtotheconsumerafterinsertion.NCRtherefore
recommendsthatthisis000topreventthescreenfrombeing
displayed.Inthiscase,thenumberofretainednotesis
displayedontheConfirmationscreen(describedonpage 2103).
SeeTableNote64

TableNote60:Iftheenableissuccessful,thesubsetofactiveNDC
notetypesheldbytheapplicationwillberedefinedbytheSetNDC
NoteTypestableentry.
TableNote61:IfExtension3tostate>issettoallzeros,itis
ignoredandthepreviousdownloadisretained.
TableNote62:Thereisadependencyonwhichnotesarereported
throughtheSSTCommand,SendConfigurationNoteDefinitions

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-101

State Tables
> - Cash Accept State

astowhatactualindexwillbereportedasactive(fordetails,see
ReportCashDepositDefinitioninChapter 9,Terminalto
CentralMessages).
TableNote63:Fordetailsofdefiningadynamictextdictionary
controlsequence,seeDisplayDynamicTextDictionaryControl
Sequenceonpage 339.Thereasonsaredisplayedfromthefinal
cursorpositionafterthebasescreenisdisplayed.Ifthedynamictext
dictionarycontrolsequenceisnotdefined,noreasonisdisplayed.
TableNote64:ThenumberofnotesretainedunderECB6
regulationsincludesthenotesidentifiedascounterfeit.Ifthe
retentionofsuspectnotesisalsoconfigured,thenumberofnotes
identifiedassuspectisaddedtothecounterfeitcount.
Table 2-59
Extension 4 to State > (Cash Accept)
Table
Entry

No. of
Chars

Contents

Description

Statetype

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

DirectDepositControl
(Range000001)

Determineswhethernotesareplacedintheescrowordeposited
directlyintothecassettes.
Validvaluesareasfollows:

000Placeinsertednotesintheescrow(refundabledeposit)

001Depositinsertednotesdirectlyintothecassettes(direct
deposit).
SeeTableNote66andTableNote65

DirectDepositLimit
(Range000999)

Definesthenumberofnotesthatcanbeinsertedwhennotesare
depositeddirectlyintothecassettes.
Oncethislimitisreached,nofurthernoteswillbeaccepted,but
notesinsertedbeforethelimitisreachedwillbeprocessed.
Whenthevalueis000,thedefaultmaximumnumberofnotesforthe
hardwareisapplied.Forinformationondefiningthedefault
maximumnumberofnotes,refertoChapter5,Configuring
AdvanceNDCandAssociatedComponentsintheAPTRAAdvance
NDC,DevelopersGuide.

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-102

APTRA Advance NDC, Reference Manual

State Tables
> - Cash Accept State

TableNote65:Ifthisextensionisnotincludedinthestatetable
downloadorifitistruncatedbeforetableentry5,depositswilluse
theescrow.
TableNote66:Ifthedevicedoesnotsupporttheconfigured
DepositControl,theDeviceErrorNextStateNumberistakenas
describedintableentry4ofExtension2toState>(CashAccept)
onpage 298.

ConfirmationScreen

TheConfirmationscreen(definedintableentry4inExtension1to
State>(CashAccept))isadynamicscreenconstructedusingthe
detailsofthedeposittransactionandoverlaidonthescreendefined
intheCashAcceptstate.IfECB6mode1isused,anynotesretained
ascounterfeitorsuspectareincludedintheretainednotecounts.
Thescreenalsodisplaysthedenominationsofthedepositednotes.
ThedynamicConfirmationscreencontentcanbemodifiedusing
the.NETClassConfiguratorfile,asdescribedinChapter5,
ConfiguringAdvanceNDCandAssociatedComponentsofthe
APTRAAdvanceNDC,DevelopersGuide.
Whenalltheinsertednotesarevalid,thescreendefinedbythe
ConfirmationScreentableentry(tableentry4inExtension1to
State>(CashAccept))isdisplayed,andtheAdd
More/Deposit/RefundKeyMasktableentries(describedin
Table 255,>CashAcceptStateonpage 294)areusedtodefine
theactiveFDKs.
Note:Ifdirectdepositisconfigured,theRefundkeyisnotenabled
evenifitisconfiguredandthecashacceptorwillbeenabledwhile
theConfirmationscreendefinedintableentry4inExtension1to
State>(CashAccept)isdisplayedonlyifthevalueofAddMore
KeyMaskis000andtheCashInAutoEnabledpropertyistrue.

RefundableDeposits

IftheconsumerselectstheAdd MoreFDK(tableentry4in>Cash
AcceptState)fromtheConfirmationscreen,thescreendefinedby
thePleaseEnterNotesScreentableentry(tableentry2in
Extension1toState>(CashAccept))isdisplayed,andtheCancel
KeyMasktableentry(tableentry2in>CashAcceptState)is
used.

DirectDeposits

Ifthecashacceptorhasbeenautoenabledandtimer00expires
whilethecashacceptorisenabled,andtimer77isgreaterthantimer
00,thePleaseEnterNotesScreentableentryisusedtodefinethe
screentodisplay.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-103

State Tables
> - Cash Accept State

IfnodepositismadeattheConfirmationscreenbeforetimer77
expiresandtimer00isgreaterthantimer77,thecashacceptoris
disabledandtheTimeOutstateistaken.Ifadepositismadebefore
timer77expires,theProcessingNotesScreen(tableentry7in
Extension1toState>(CashAccept))isdisplayeduntilthenotes
havebeenprocessed.

DynamicTextDefinitions

ThefollowingdynamictextdefinitionscanbeusedintheCash
Acceptstate:

Reasonsforrefusalofnotes
Thenumberofcounterfeitorsuspectnotes.

DefiningReasonsforNoteRefusal

NotescanberefusedbytheSSTforvariousreasons.Insomecases,
specificinformationorguidanceneedstobeprovidedtothe
consumer.Toprovidethisinformation,messagescanbedefined
thatcorrespondtospecificvalues.Thesevaluesanddefinitionsare
includedinadynamictextdictionarycontrolsequencewitha
DictionaryIDof000.Fordetailsofthiscontrolsequence,see
DisplayDynamicTextDictionaryControlSequenceonpage 339.
Table 260liststheenumeratedvaluesandtheirdefinitions.The
displaytextmustreflectthesedefinitionsandmatchtheavailable
spaceandlanguageofthescreen.
Table 2-60
Rejected Notes Dynamic Text

Enumerated Value

Definition

001

Thecashunitisfull

002

Theitemshavebeenrecognised,butoneormoreof
thenotesareinvalid

003

Nonotesareintheinputarea

004

Adepositfailedforareasonnotcoveredbytheother
reasonsandthefailureisnotafatalhardwareproblem

005

Failureofacommoninputcomponentthatisshared
byallcashunits

006

Theintermediatestackerisfull

007

Foreignitemshavebeendetectedintheinputposition
Note:Tousevalue007,theserviceprovidermust
supporttheXFS3.10standard

999

Defaulttexttodisplaywhenspecifictextisnot
provided

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-104

APTRA Advance NDC, Reference Manual

State Tables
w - Cheque Accept State

wChequeAcceptState

Ifachequeprocessorispresent,thisstatecanbeusedtoallow
chequestobeenteredintothechequeprocessor.
Understatetablecontrol,theChequeAcceptstate:

Acceptscheques
Returnsphysicallyunacceptablecheques
Returnsincorrectlyorientatedcheques
Liftsfullfrontand/orrearimages
Readsthecodeline,forCentralauthorisation
Capturesejectedchequesthatarenottaken
Reportsunsolicitedevents.

Table 2-61
w - Cheque Accept State
Table
Entry

No. of
Chars

Contents

Description

Statetype

w(77H)

Reserved(000)

Reservedforfutureuse

Leave/CaptureOption

Thisentrydefinestheactiontotakeifaphysicallyunacceptableor
jammedchequeispresentedforreturn,butnottaken:
000Leaveatthroat
001Captureunacceptablechequetobin1
Ifthereturnedchequeisunacceptablebecauseitistooshortandthe
tableentryissettocapturethereturnedcheque,ajammayoccurin
thereartransport.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-105

State Tables
w - Cheque Accept State
Table
Entry

No. of
Chars

Contents

Description

ChequeEntryRetries

Specifiesthenumberofchequeentryretriestheconsumeris
allowedduringtheexecutionofthestate.Retriesmaybeallowedif
aphysicallyunacceptableorincorrectlyorientatedchequeis
detected:
000Donotallowconsumerretries
n01Allowonefurtherretryfollowinginitialrejection
n02Allowtwofurtherretries
n03Allowthreefurtherretries
Thevariablen canhaveoneofthefollowingvalues:
0Afterallthepermissibleretrieshavefailed,thechequeprocessor
acceptsaphysicallyacceptablechequeandcontinuestoprocessit,
evenifthecodelinecannotberead.
1Afterallthepermissibleretrieshavefailed,thestategoestothe
statedefinedbytheCancel/TimeOutnextstateexit.
SeeTableNote74.

ImageLift
(000003)

Specifieswhetherafrontand/orrearimageistobelifted,if
hardwarecapabilitiesallow.
000Nochequeimagesarelifted
001Animageofthefrontofthechequeislifted
002Animageofthebackofthechequeislifted
003Animageofthefrontandbackofthechequeislifted
Bydefaultthefrontimageofthechequeisdisplayed.ScreenC07
canbemodifiedtodisplaytherearimage.
Liftedfrontandrearimagesaredeletedfromthesystemduringthe
Closestate.
SeeTableNote67.

ExtensionState1
(Range000999or
000ZZZ)

Statenumberforextensionstate1.
SeeExtension1toStatewonpage 2108.
Ifavalueof255isusedforthisentry,thisindicatesthereisno
extensionstate1.
Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.

ExtensionState2
(Base10range000254
or256999)
(Base36range000254
or256ZZZ)

Statenumberforextensionstate2.
SeeExtension2toStatewonpage 2110.
Ifavalueof255isusedforthisentry,thisindicatesthereisno
extensionstate2.
Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-106

APTRA Advance NDC, Reference Manual

State Tables
w - Cheque Accept State
Table
Entry

No. of
Chars

Contents

Description

CancelKeyMask

SpecifiestheCancelFDKwhichisactivewhenthePleaseInsert
ChequeandFurtherProcessingscreensaredisplayed.
EachbitrelatestoanFDK,asfollows:
Bit0FDKA
Bit1FDKB
Bit2FDKC
Bit3FDKD
Bit4FDKF
Bit5FDKG
Bit6FDKH
Bit7FDKI
Ifabitissetto1,therelevantCancelFDKisactive.Ifabitissetto0,
therelevantFDKisinactive.

DepositKeyMask

SpecifiestheDepositFDKwhichisactivewhentheFurther
Processingscreenisdisplayed.
EachbitrelatestoanFDK,asfollows:
Bit0FDKA
Bit1FDKB
Bit2FDKC
Bit3FDKD
Bit4FDKF
Bit5FDKG
Bit6FDKH
Bit7FDKI
Ifabitissetto1,therelevantDepositFDKisactive.Ifabitissetto
0,therelevantFDKisinactive.
SeeTableNote68.

TableNote67:IftheliftingofimagesisrequestedbytheImageLift
entryinthestatetable,thentheseimagesarelifted.
TheimageisstoredinC:\ProgramFiles\NCRAPTRA\Advance
NDC\Data.Thiscanbechangedusingtheregistry,asdescribedin
theAPTRAAdvanceNDC,DevelopersGuide.
IftheimageistobedisplayedinanInformationEntrystate,the
imagecanbedisplayedinanassociatedscreenusingastandard
displayescapesequence,orbyreferencingscreenC07todisplaythe
imageaspartoftheFurtherProcessingScreen.
TableNote68:IftheDepositKeyMaskissetto000,thefurther
processingscreenisskippedandtheGoodDepositnextstateis

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-107

State Tables
w - Cheque Accept State

taken.Thismeansthattheconsumercanenterthechequeandthen
immediatelyentertheamountwhilethechequeimageisdisplayed
onscreen.
Note:TheChequeAcceptstatedoesnotdisplaythecheque.The
AmountEntrystatemustensurethechequeisdisplayed.
Table 2-62
Extension 1 to State w
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

PleaseInsertCheque
Screen
(Range000999)

Thisscreenisdisplayedwhenthechequeprocessorhasbeen
successfullyenabled(orreenabled)toacceptacustomerscheque.
SeeTableNote69

ProcessingCheque
Screen
(Range000999)

Thisscreenisdisplayedwhenthechequehasbeensuccessfully
enteredintothechequeprocessor.

UnacceptableCheque
Screen
(Range000999)

Thisscreenisdisplayedwhenachequecannotbeacceptedbythe
chequeprocessor.
SeeTableNote70

IncorrectOrientation
Screen
(Range000999)

Thisscreenisdisplayedwhenanincorrectlyorientatedchequehas
beenenteredandretriesstillremain.

FurtherProcessing
Screen
(Range000999)

ThisscreenisdisplayedaftertheProcessingChequescreen,and
maybeusedtodisplaytheliftedimages.

ChequeCaptured
Screen
(Range000999)

Thisscreenisdisplayedwhenachequehasbeencaptured.
Typicallyachequeiscapturedifitisreturnedtotheconsumerbut
nottaken.
Thisscreenisdisplayedfortheperioddefinedbytimer87.
SeeTableNote71

DeviceErrorScreen
(Range000999)

Thisscreenisdisplayedwhenahardwareerrorsuchasacheque
jamconditionoccurs,preventingthetransactionfrombeing
continued.
Thisscreenisdisplayedforafixedtimeof15seconds.

PleaseRemoveCheque
Screen
(Range000999)

Thisscreenisdisplayedwhenthechequeisreturned,andiswaiting
tobetakenbytheconsumer.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-108

APTRA Advance NDC, Reference Manual

State Tables
w - Cheque Accept State

TableNote69:Ifthechequeprocessorisempty,thecheque
processorisenabledtoacceptacheque.Ifthechequeprocessoris
notemptytheChequeAlreadyPresentnextstateexitistaken.Ifthe
chequeprocessorissuccessfullyenabled,thescreendefinedbythe
PleaseInsertChequeScreentableentryisdisplayed.Ifoptiondigit
2cisnotset,thebeeperissounded.Thechequeprocessorisenabled
forthetimespecifiedbytimer04,oruntiltheCancelkeyispressed.If
timer04issettogreaterthanoneminute,thechequeprocessor
firmwarewilltimeout,andbetreatedinthesamewayasatimer04
expiry.
Thebeeperisdisabledwhenachequeisdetected,iftheCancelkeyis
pressed,orifthetimerexpires.
IfthetimerexpiresortheCancelkeyispressed,anunsolicited
timeout/cancelstatusmessageissenttoCentral,andthestateexits
tothestatedefinedbytheCancel/TimeOutnextstateexit.
Iftheconsumerinsertsaphysicallyacceptablecheque,thescreen
definedbytheProcessingChequeScreenEntryinthestatetableis
displayed.
TableNote70:Iftheconsumerinsertsachequeofasizeornature
thatmakesitunabletobeprocessed(physicallyunacceptable)orif
thechequebecomesjammedonentry,itisreturnedtothe
consumer,andthescreendefinedbytheUnacceptableCheque
Screenentryisdisplayed.Thebeeperissoundediftheejectionwas
performed.
Theconsumerispresentedwiththechequeforthetimedefinedby
timer94.Thebeeperisstoppedwhentheconsumertakesthe
cheque,orwhenthechequeisretractedfollowingafailurebythe
consumertoretrievethecheque.
Iftheconsumerfailstoretrievethecheque,anunsolicitedtimeout
statusmessageissenttoCentral,andthereisanattempttomove
thechequetothereject/retainbiniftheLeave/CaptureOptioninthe
ChequeAcceptstateissettocapture.ThestateexitstotheCheque
CapturednextstateexitortheCancel/Timeoutnextstateexit,
dependingontheLeave/CaptureOption.Ifthechequeis
successfullymovedtothebin,asecuritytracemessage(U0058)is

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-109

State Tables
w - Cheque Accept State

journaledatthispointtoindicatethattheclearingactionhastaken
place.
Iftheconsumerretrievesthecheque,thechequeprocessoris
reenabledifthereareretriesleft,asdefinedbytheChequeEntry
Retriesentryinthestatetable.
Iftheconsumerretrievesthechequebuttherearenoretriesleft,the
chequeprocessorisnotreenabled,andthestateexitstothestate
definedbytheCancel/TimeOutnextstateexit.
TableNote71:Whenachequeiscaptured,itisendorsedwiththe
locallycustomisabledatausingreservedscreenU0057.Fordetails
ofthelocallycustomisable,refertochapter5,Configuring
AdvanceNDCandAssociatedComponents,theAPTRAAdvance
NDC,DevelopersGuide.
Table 2-63
Extension 2 to State w
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

ChequeAlreadyPresent
NextStateExit
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Thisexitistakenifachequeisdetectedasalreadypresentinthe
chequeprocessor.TherecommendednextstateistheClosestate,to
performerrorrecovery.

NoExceptionNextState
Exit
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Thisexitistakenifthechequeisacceptedandprocessedwithout
error,althoughthecodelinemaynothavebeenread.The
recommendednextstateisanInformationEntrystate,which
promptstheconsumertoentertheamountonthecheque,and
optionallydisplaystheimageliftedfromthecheque.
SeeTableNote70

ExceptionNextStateExit
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Thisexitistakenwhenanexceptionhasoccurred(thatis,adevice
failureoccursinthechequeprocessor).Therecommendednext
stateistheClosestate,toperformerrorrecovery.

CustomerCancel/
TimeoutNextStateExit
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Thisexitistakenwhentheconsumerfailstoinsertaphysically
acceptablechequewithintherequiredtimeornumberofretries.
Therecommendednextstateisthe4or8FDKSelectionFunction
statefromwhichtheChequeDeposittransactionwasselected.

SeeTableNote72

SeeTableNote73.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-110

APTRA Advance NDC, Reference Manual

State Tables
w - Cheque Accept State
Table
Entry

No. of
Chars

Contents

Description

ChequeCapturedExit
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Thisexitistakenwhentheconsumerfailstotakeareturned
cheque,whichisthenclearedtothechequeprocessorrejectbin.
SeeTableNote74

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

Reserved(000)

Reservedforfutureuse.

TableNote72:Ifajamoccursduringchequeprocessing,an
unsolicitedmessagewitherrorcode5issent.Ifanerroroccurs
duringchequeprocessing,anunsolicitedmessagewitherrorcode
4issent.Ineithersituation,thestatetakestheExceptionnextstate
exit.FordetailsofthemessageseeChequeProcessor
(Solicited/Unsolicited)onpage 9115.
TableNote73:Whenatimeoutoccurswhenthechequeprocessor
isenabled(timer94orhardwareinternaltimer)orduringthe
FurtherProcessingscreen(timer0),AdvanceNDCactivatesthe
TimeOutstatetodisplaytheDoyouneedmoretimescreen.The
CustomerCancel/Timeoutnextstateexitistakenifthecustomer
selectsNoorCancel,orfailstorespondbeforetimer01expires.
TableNote74:Onentrytothechequeprocessor,thefrontofthe
chequeisscanned,andanattemptismadetoreadthecodeline.Ifa
minimumoffour,ormore,validcharactersisreadsuccessfully
fromthecodeline,thechequeisdeemedtobecorrectlyorientated.
ThisminimumnumbercanbechangedusingtheActiveScriptHost
worker.
Anincorrectlyorientatedchequeisreturnedtotheconsumerif
thereareretriesleft,andthescreendefinedbytheIncorrect
OrientationScreenentryisdisplayed.Iftherearenoretriesleft,the
chequeisaccepted,andeithertheNoExceptionnextstateexitis
takentoallowCentraltodeterminetheacceptabilityofthecheque
orthestatedefinedbytheCancel/TimeOutnextstateexit.
Iftheconsumerfailstoretrievetheinvalidcheque,itisclearedto
theReject/RetainedBin.Ifthisactiontakesplace,anunsolicited
timeoutstatusmessageissenttoCentral,andthestateexitstothe
ChequeCapturednextstateexit.Asecuritytracemessage(U0058)
isjournaledtoindicatethattheclearingactionhastakenplace.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-111

State Tables
z Master Expansion State

zMasterExpansionState
Withinthestatetable,thestatetypeisidentifiedbyasingle
characterfield.TheMasterExpansionstateextendsthenumberof
newstatetypesthatcanbedefined.
FromAdvanceNDC3.04,allnewstatetypeshavezasthestate
type,withthefirstparameteridentifyingthestatesubtype.
Note:TheMasterExpansionstatusisidentifiedwithalowercase
z,whereasextensionstostatesandstatesubtypesareidentified
withanuppercaseZ.
Table 2-64
z - Master Expansion State
Table
Entry

No. of
Chars

Contents

Description

z(7AH)

StateType

Statesubtype
(Range000999)

Identifiesthestatesubtype

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

Definedbystatesubtype

Asdefinedinthestatesubtypestatetable

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-112

APTRA Advance NDC, Reference Manual

State Tables
z001 Bunch Cheque Accept State

z001BunchChequeAcceptState

TheBunchChequeAcceptstateallowsabunchofchequestobe
insertedintoabunchchequeacceptor,scannedandtheproduction
ofthecodelinealongwithanumberofimages.Anycheques
refused,(forexample,becauseofthefailureofcodelinevalidation)
orrejected(forexample,becausethechequeistooshort)bythe
devicearereturnedtotheconsumer.Afterthecompletionofthe
BunchChequeAcceptstate,acceptedchequesareheldinthe
escrow.
Ifchequesarereturned,buttheconsumerdoesnotremovethem,
theyareretractedtobin2.
Ifconfigured,advancedimagerecognitionfeaturescanbeusedto
dothefollowing:

Automaticallyobtaintheamountforeachcheque
Determinethequalityofeachchequeandreturnanycheques
thatdonotmeettherequiredqualitylevel.

Note:Ifatimeoutoccurs,ortheconsumercancelsthetransaction,
anunsolicitedmessageissenttoCentralandjournaled.
Table 2-65
z001 - Bunch Cheque Accept State
Table
Entry

No. of
Chars

Contents

Description

z(7AH)

MasterExtensionState

Statesubtype

001

CancelKeyMask

SpecifiestheFDKortouchscreenareatobeusedastheCancel
keywhenthePleaseInsertChequesscreenisdisplayed.See
TableNote75andTableNote76

EnableImageProcessing
(Range000003)

Specifiesthelevelofprocessingtobecarriedoutonthecheque
images,asfollows:
000noprocessing
001applyimagequalityassessment(IQA)teststodetermine
chequeacceptability
002attempttoobtaintheamountforeachcheque
Thisfieldisabitmaskandeachbitenablesafeaturewith
combinationsofbitsenablingmultiplefeatures.Forexample,
003appliesIQAtestsandobtainstheamountforeachcheque

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-113

State Tables
z001 Bunch Cheque Accept State
Table
Entry

No. of
Chars

Contents

Description

MaxItems
(Range000999)

Specifiesthemaximumnumberofchequesthatcanbeaccepted
intothedevice
If000isspecifiedorthespecifiedvalueisgreaterthanthe
maximumacceptedbythedevice,thedevicemaximumisused

ExtensionState1
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate1
SeeExtension1toStatez001onpage 2115

ExtensionState2
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate2
SeeExtension2toStatez001onpage 2116

ExtensionState3
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Mustbe000

Ifavalueof255isusedforthisentry,thedefaultClosestateis
taken
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

Ifavalueof255isusedforthisentry,thisindicatesthereisno
extensionstate2
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.
Statenumberforextensionstate3
SeeExtension3toStatez001onpage 2117
Ifavalueof255isusedforthisentry,thisindicatesthereisno
extensionstate3
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.
Reserved

TableNote75:EachbitisassociatedwithanFDK;frombit0FDK
Atobit7FDKI.Ifabitis1,thecorrespondingFDKisactive.Ifa
bitis0,thecorrespondingFDKisinactive.IfthesameFDKis
definedinmorethanonemask,thelatestkeymaskisused.
TableNote76:TheCancelkeyonthePINpadwillbeactive,evenif
noFDKisdefinedasCancel.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-114

APTRA Advance NDC, Reference Manual

State Tables
z001 Bunch Cheque Accept State
Table 2-66
Extension 1 to State z001
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

PleaseWaitforDevice
Screen
(Range000999)

Promptstheconsumertowaitforthedevicetobereadytoaccept
cheques
Ifthescreenisnottobechangedwhilewaitingforthedevice,set
thisfieldto000

PleaseInsertCheques
Screen
(Range000999)

Promptstheconsumertoenterchequeswhenthedeviceis
successfullyenabled,orreenabled,toacceptachequedeposit

ProcessingCheques
Screen
(Range000999)

ReplacesthePleaseInsertChequesscreenwhilethedevice
processestheinsertedcheques

PleaseWaitforRefused
ChequesScreen
(Range000999)

Promptstheconsumertowaitwhilerefusedchequesarereturned
Ifmultiplebunchesarereturned,thisscreencanbedisplayed
multipletimes

RetractingCheques
Screen
(Range000999)

Informstheconsumerthatreturnedcheques,whichhavenotbeen
taken,arebeingretracted
TheretractisinitiatedifTimer94expiresbeforethechequesare
taken
SeeTableNote77

DeviceUnavailable
Screen
(Range000999)

Informstheconsumerthatthedeviceisunavailablewhenthe
BunchChequeAcceptstateisentered
ThescreenisdisplayedforthetimedefinedbyTimer63
SeeTableNote77

HardwareErrorScreen
(Range000999)

Informstheconsumerthatthetransactioncannotcontinuebecause
ahardwareerror,suchasachequejam,hasoccurred
ThescreenisdisplayedforthetimedefinedbyTimer63
SeeTableNote77

Stacker/EscrowFull
Screen
(Range000999)

Informstheconsumerthatthestackerisalreadyfullwhenentering
theBunchChequeAcceptstate
ThescreenisdisplayedforthetimedefinedbyTimer63
Ifthetimerexpires,theGoodExitistaken
SeeTableNote77

TableNote77:Fordetailsofthetimers,seeTimersonpage 722.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-115

State Tables
z001 Bunch Cheque Accept State
Table 2-67
Extension 2 to State z001
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

PleaseRemoveRejected
ChequesScreen
(Range000999)

Informstheconsumerthatchequeshavebeenrejectedbeforethey
werefullyinserted.
Ifthereasonfortherejectionistobedisplayed,itmustbedefined
inadisplaydynamictextdictionarycontrolsequencewithinthis
screendefinition.Thereasonisdisplayedatthescreenposition
wherethedictionaryisdefined.Thereasonsforrejectionthatmust
beincludedinthedictionaryaredescribedinDefiningDynamic
TextforChequeRejectiononpage 2118
SeeTableNote78

PleaseRemoveRefused
ChequesScreen
(Range000999)

Informstheconsumerthatchequeshavebeenrefusedafterbeing
successfullyinserted
Ifthereasonfortherefusalistobedisplayed,itmustbedefinedin
adisplaydynamictextdictionarycontrolsequencewithinthis
screendefinition.Thereasonisdisplayedatthescreenposition
wherethedictionaryisdefined.Thereasonsforrefusalmustbe
includedinthedictionaryaredescribedinDefiningDynamicText
forChequeRefusalonpage 2118
SeeTableNote78

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

TableNote78:Fordetailsofdefiningadynamictextdictionary
controlsequence,seeDisplayDynamicTextDictionaryControl
Sequenceonpage 339.Thereasonsaredisplayedfromthefinal
cursorpositionafterthebasescreenisdisplayed.Ifthedictionary
controlsequencedynamictextisnotdefined,noreasonis
displayed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-116

APTRA Advance NDC, Reference Manual

State Tables
z001 Bunch Cheque Accept State
Table 2-68
Extension 3 to State z001
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

GoodNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifatleastonechequehasbeen
successfullyacceptedintothedeviceandanyrefusedchequeshave
beentakenbytheconsumer
Ifallchequeshavebeeneitherrefusedorrejected,thestatedoesnot
takeanexitandthedeviceisreenabledforchequeinsertion

CancelNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancelkeyispressedto
stopthechequedepositorNoisselectedfromtheTimeoutscreen.

DeviceErrorNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifanexceptionhasoccurred
whichmayrequiresubsequentactionbyCentral

TimeoutNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerfailstoenter
anychequesbeforeTimer04expires

ChequesRetractedNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifrefusedchequesare
subsequentlysuccessfullyretracted
Allcheques,notjustthosethathavebeenrejected,areretracted.All
chequesmustberetractedbecausethereisnoconsumerinteraction
tocontinuewiththedepositofchequesthathavebeeninsertedbut
notrejected
TheretractisinitiatedafterTimer94expires

GoodwithRefused
(Base10range000254or
25699)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifatleastonechequeis
refused,andtakenwhenreturned,andatleastonegoodchequeis
accepted.
Ifthisstateparameterisnotspecified,theSSTgoestotheGood
NextStateNumber.

Mustbe000

Reserved

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-117

State Tables
z001 Bunch Cheque Accept State

DefiningDynamicTextfor
ChequeRejection
2

Todefinethetexttobedisplayedwhenachequeisrejectedduring
theBunchChequeAcceptstate,theenumeratedvaluesand
definitionsmustbedefined.Thesevaluesanddefinitionsare
includedinadynamictextdictionarycontrolsequencewitha
DictionaryIDof000.Fordetailsofthiscontrolsequence,see
DisplayDynamicTextDictionaryControlSequenceonpage 339.
Table 269liststheenumeratedvaluesandtheirdefinitions.The
displaytextmustreflectthesedefinitionsandmatchtheavailable
spaceandlanguageofthescreen.

Table 2-69
Rejected Reasons

DefiningDynamicTextfor
ChequeRefusal
2

Enumerated Value

Definition

001

Therejecteditemistoolong

002

Therejecteditemistoothick

003

Morethanoneitemhasbeendetected

004

Theitemhasbeenremoved

005

Metalhasbeendetectedintheinputposition

006

Foreignitemshavebeendetectedintheinputposition

999

Optionaldefaulttexttodisplaywhenspecifictextis
notprovided

Todefinethetexttobedisplayedwhenabunchofchequesis
refusedduringtheBunchChequeAcceptstate,theenumerated
valuesanddefinitionsmustbedefined.Thesevaluesand
definitionsareincludedinadynamictextdictionarycontrol
sequencewithaDictionaryIDof001.Fordetailsofthiscontrol
sequence,seeDisplayDynamicTextDictionaryControlSequence
onpage 339.
Table 269liststheenumeratedvaluesandtheirdefinitions.The
displaytextmustreflectthesedefinitionsandmatchtheavailable
spaceandlanguageofthescreen.

Table 2-70
Refused Reasons

Enumerated Value

Definition

001

Thechequehasbeenrefusedasaresultofcheque
validation

002

Foreignitemshavebeendetectedintheinputposition

003

Theescrowisfullorthemaximumnumberofitems
thattheapplicationallowsinescrowhasbeenreached

004

Thecodelinedatahasbeenfound,butwasinvalid

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-118

APTRA Advance NDC, Reference Manual

State Tables
z001 Bunch Cheque Accept State
Enumerated Value

Definition

005

Theitemisinvalid
Forexample,somedevicesrejectblankpaper

006

Theitemistoolong

007

Theitemistooshort

008

Theitemistoowide

009

Theitemistoonarrow

010

Theitemistoothick

011

Theitemhasbeeninsertedinaninvalidorientation

012

Theitemscannotbeseparated

013

Therearetoomanyitemsintherefuseditemarea.The
refuseditemsmustbereturnedtotheconsumer
beforeanyadditionalitemscanbeaccepted

014

Processingoftheitemsdidnottakeplaceasthebunch
ofitemsisblockingthereturnofotheritems

015

Processingoftheitemsdidnottakeplaceasthebunch
ofitemspresentedisinvalid
Forexample,thebunchistoolargeorhasbeen
incorrectlypresented

016

Reserved

017

Theitemorbunchiscausingajam

018

Metal,forexampleastapleorpaperclip,hasbeen
detectedintheinputposition

999

Defaulttexttodisplaywhenspecifictextisnot
provided

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-119

State Tables
z002 Bunch Cheque Handling State

z002BunchChequeHandlingState

TheBunchChequeHandlingstateallowscontrolofchequesheldin
theescrow.Thisstateisusedinthefollowingcircumstances:

Iftheconsumercancelsthetransactionbeforemakinga
transactionrequestandthechequesaretobereturned
Iftheconsumerfailstotakerefusedchequesandthechequesare
toberetracted
Todepositthechequesintoabinifanofflinechequedeposit
solutionisrequired,

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

No. of
Chars

Contents

Description

z(7AH)

MasterExtensionState

Statesubtype

002

MediaControl
(Range000002)

Specifieswhathappenstothecheques,asfollows:
000movethechequestobedepositedintothebinspecifiedin
theBinNumberfieldandreturnanyotherchequestothe
consumer.Returnedchequesarethosethatfailedvalidationor
thattheconsumerrequestedforreturn.Ifthereturnedcheques
arenottakenbeforeTimer94expires,thechequesareretracted
andtheCustomerTimeoutnextstateexitistaken
001returnthechequestotheconsumerandretractthemif
thereisaproblemortheyarenottakenbeforeTimer94expires.
Ifthechequesareretracted,theCustomerTimeoutnextstate
exitistaken
002returnchequestotheconsumerbutdonotretractthemif
theyarenottaken.Ifthereturnedchequesarenottakenbefore
Timer94expires,thechequesareleftattheentryandthe
CustomerTimeoutnextstateexitistaken
FordetailsofTimer94,seeTimer94*onpage 727

DepositBinNumber
(Range000999)

Specifiesthebinnumberintowhichthechequeistobe
deposited
ThisonlyapplieswhentheMediaControlfieldissetto000
Ifaninvalidbinnumberisused,suchas003whenthereare
only2bins,avalueof001isused(bin1)

EndorseText
(Range000999)

Specifiesthescreencontainingthetextusedtoendorsethe
cheques
IfendorsementisnotrequiredortheEndorseControldefines
analternativesourcefortheendorsementdata,setthisto000

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-120

APTRA Advance NDC, Reference Manual

State Tables
z002 Bunch Cheque Handling State
Table
Entry

No. of
Chars

Contents

Description

StampFlag
(Range000001)

Specifieswhethertostampthecheques,asfollows:
000donotstampthecheques
001stampthecheques
Thisonlyappliesifthedevicesupportsstamping

Mustbe000

Reserved

ExtensionState1
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate1
SeeExtension1toStatez002

ExtensionState2
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate2
SeeExtension2toStatez002

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

Table 2-72
Extension 1 to State z002
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

PleaseWaitProcessing
ChequesScreen
(Range000999)

Promptstheconsumertowaitwhiletheactionspecifiedinthe
MediaControlfieldiscarriedout

PleaseRemoveReturned
ChequesScreen
(Range000999)

Promptstheconsumertoremovechequesthathavebeenreturned

PleaseWaitforMore
ReturnedChequesScreen
(Range000999)

Promptstheconsumertowaitforfurtherchequestobereturned

PleaseWaitRetracting
ChequesScreen
(Range000999)

Informstheconsumerthatreturnedchequesthathavenotbeen
takenarebeingretracted

DeviceUnavailable
Screen
(Range000999)

Informstheconsumerthatthedeviceisunavailablewhenthe
BunchChequeHandlingstateisentered
ThescreenisdisplayedforthetimedefinedbyTimer63,described
onpage 725

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-121

State Tables
z002 Bunch Cheque Handling State
Table
Entry

No. of
Chars

Contents

Description

HardwareErrorScreen
(Range000999)

Informstheconsumerthatthetransactioncannotcontinuebecause
ahardwareerror,suchasachequejam,hasoccurred
ThescreenisdisplayedforthetimedefinedbyTimer63

Mustbe000

Reserved

Mustbe000

Reserved

Table 2-73
Extension 2 to State z002
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

GoodOperationNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthechequeshavebeen
successfullyprocessedasdefinedintheMediaControlfield,as
follows:
IfMediaControlis000,themediahasbeendepositedintothe
specifiedbinandanyreturnedchequeshavebeentakenbythe
consumer
IfMediaControlis001or002,themediahasbeenreturnedand
takenbytheconsumer

DeviceErrorNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifanexceptionhasoccurred
whichmayrequiresubsequentactionbyCentral

CustomerTimeoutNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerhasnottaken
thereturnedcheques
IfMediaControlis002,thisexitistakenafterTimer94expires,
otherwiseitistakenafteranyreturnedchequesaresuccessfully
retracted

EndorseControl
(Range000001)

Defineswhereandhowthedatausedtoendorsethechequeis
defined,asfollows:
000TheEndorseTexttableentry(tableentry5).Ifboth
parametersaredefinedas000,theendorsementtextisnotsetusing
thisstate
001Createdusingdynamicdataelementsdefinedinthelocal
dynamicendorseconfigurationfile(notsupported)

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-122

APTRA Advance NDC, Reference Manual

State Tables
z002 Bunch Cheque Handling State
Table
Entry

No. of
Chars

Contents

Description

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-123

State Tables
z003 Cheque Detail Display State

z003ChequeDetailDisplayState
TheChequeDetailDisplaystatepromptstheconsumertoview
detailsaboutthedepositedchequesandentertheamountofthe
cheque.Thisstatecanbeconfiguredtooperateinthefollowing
modes:

Displaydetailsofaspecificcheque,butallownavigation
throughallcheques
Displaydetailsforallcheques
Displaydetailsofanychequesthatdonothaveanamount

Thedisplayisconfiguredusingscreendefinitionsandcancontain
thefollowing:

Scaledchequeimages
Codeline
Chequedepositcount,forexample,cheque3of4
Amountofthecheque.

FDKsortouchscreenareasareusedtoselectthefollowingactions:

Proceed
Requestthereturnofthechequeattheendofthetransaction
Canceltheamountentry
IfOperationMode(tableentry3)issetto001,viewthenextor
previouscheque

Anychequesrequestedforreturnbytheconsumerarereturnedas
follows:

Inonlinetransactions,duringtheTransactionReplyprocessing
Inofflinetransactions,duringtheBunchChequeHandlingstate

Note:Ifatimeoutoccurs,ortheconsumercancelsthetransaction,
nounsolicitedmessageissenttoCentralorjournaled.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-124

APTRA Advance NDC, Reference Manual

State Tables
z003 Cheque Detail Display State
Table 2-74
z003 - Cheque Detail Display State
Table
Entry

No. of
Chars

Contents

Description

z(7AH)

MasterExtensionState

Statesubtype

003

OperationMode
(Range001003)

Specifiesthemodeofoperation,asfollows:

001displaydetailsofthecurrentchequeandallowthe
consumertonavigatethroughallthechequesandeditthe
amounts.Adescriptionofthecurrentcheque(for
informationonthecurrentcheque,seeCurrentCheque
Indexonpage 2131)isprovidedintheDisplayCheque
Summarystate.Ifnochequesareavailable,anempty
ChequeDetailscreenisdisplayed.ThebackgroundCheque
Detailscreenmustthereforebedesignedtohandlethe
situationwherenochequedetailsaredisplayed.Selecting
theEnterkeycompletesamountentry,butdoesnot
provideanyscreennavigation.Onexitfromthisstate,the
currentchequeissettothelastchequedisplayed

002displayallchequesinturn,requestingthatthe
amountbeenteredorconfirmedforeachcheque.TheEnter
keyonthekeypadisusedtocompleteorconfirmthe
amountanddisplaythenextcheque.Whenthelastcheque
isconfirmed,thestatetakestheProceedNextStateexit.If
nochequesareavailable,thestateimmediatelytakesthe
ProceedNextStateexit.Onexitfromthisstate,thecurrent
chequeissettothefirstchequeinthechequelist

003displaythedetailsofallchequesthatdonothave
amountsavailableinturnandrequestthattheamountbe
entered.TheEnterkeyonthekeypadisusedtocompleteor
confirmtheamountanddisplaythenextcheque.Whenthe
lastchequeisconfirmed,thestatetakestheProceedNext
Stateexit.Ifnochequesareavailableorallchequeshavean
amountspecified,thestateimmediatelytakestheProceed
NextStateexit.Onexitfromthisstate,thecurrentchequeis
settothefirstchequeinthechequelist

Note:Iftheoperationmodeissetto000,itistreatedas001.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-125

State Tables
z003 Cheque Detail Display State
Table
Entry

No. of
Chars

Contents

Description

AllowZero
(Range000001)

Specifieswhetherachequecanbeleftwithanamountofzero,
asfollows:
000donotallowachequetohaveazeroamount
001allowachequetohaveazeroamount
Iftheconsumertriesdepositchequeswithoutenteringan
amountforeachchequeandchequesarenotallowedtohavea
zeroamount,thefirstchequewithazeroamountisdisplayed
usingtheZeroAmountErroroverlayscreen.Theconsumer
mustprovideanonzeroamountorcancelthetransaction.Ifa
chequeistobereturnedtotheconsumer,itisnotincludedin
theevaluationofchequeswithazeroamount

ChequeDetailScreen
(Range000999)

Informstheconsumerofthechequedetailsandallowsan
amounttobeenteredoredited
Ifthechequedepositstatusistobedisplayed,acontrol
sequenceforadynamictextdictionarymustbedefinedwithin
thisscreen.Fordetailsofthecontrolsequence,seeDisplay
DynamicTextDictionaryControlSequenceonpage 339.The
statusvaluesthatmustbeincludedinthedictionaryare
describedinDefiningDynamicDataforChequeDeposit
Statusonpage 2129

AmountDisplayScreen
Number
(Range000999)

Overlayscreentosetthecursorpositionandoptionallydefines
theinitialdisplayformatbeforeamountentryoreditbythe
consumer
Thecursormustbesettotheleftsideoftheechofieldonthe
display,whichisspacefilleduntiltherequiredstartposition
forthecurrencycharacterisreached
ThedefaultechofieldisbbbbbSb0.00,wherebrepresentsa
space
Formoreinformationonamountdisplay,seeInternational
CurrencyDisplayFormatonpage 344

ZeroAmountErrorScreen
(Range000999)

Overlayscreentoprompttheconsumertoprovideanonzero
amountforthedisplayedcheque

ExtensionState1
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate1
SeeExtension1toStatez003

ExtensionState2
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate2
SeeExtension2toStatez003

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

TableNote79:Fordetailsofdefiningadynamictextdictionary
controlsequence,seeDisplayDynamicTextDictionaryControl

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-126

APTRA Advance NDC, Reference Manual

State Tables
z003 Cheque Detail Display State

Sequenceonpage 339.Thereasonsaredisplayedfromthefinal
cursorpositionafterthebasescreenisdisplayed.Ifthedynamictext
dictionarycontrolsequenceisnotdefined,nostatusisdisplayed.
Table 2-75
Extension 1 to State z003
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

ProceedNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifthechequesdepositedhave
mettheconditionsofthetransactionandwantstoproceed

CancelNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancelkeyispressed
IfanyamounthasbeenmodifiedduringthisstatebeforetheCancel
keyispressed,themodifiedamountisretained

TimeoutNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerfailstorespond
withinthespecifiedtimelimit
Enter255ifthetimeoutfunctionisnotrequired

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-127

State Tables
z003 Cheque Detail Display State
Table 2-76
Extension 2 to State z003
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

ProceedKeyMask

SpecifiestheFDKsortouchscreenareasthatareactiveasProceed
keys
IftheProceedkeyortouchscreenareaispressedwhileenteringan
amount,theamountisacceptedbeforethenormalproceed
functionalityiscompleted
IfOperationMode(tableentry3)issetto002or003andzero
amountsareallowed,thisFDKnavigatestothenextchequeuntil
thelastchequeisdisplayed
SeeTableNote80

CancelKeyMask

SpecifiestheFDKsortouchscreenareasthatareactiveasCancel
keys
TheCancelFDKortouchscreenareaisactiveonallscreens
IftheCancelkeyortouchscreenareaispressedwhileenteringan
amount,theamountbeingenteredisdiscarded
SeeTableNote80

ReturnChequeKeyMask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontoreturnthechequetotheconsumerandnottoprovide
anamount
WhentheReturnChequeKeyortouchscreenareaisused,the
statusofthechequeistoggledbetweenreturnanddeposit
Pressingthiskeydoesnotcausethenextchequetobedisplayed
SeeTableNote80

NextChequeKeyMask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontomovetothenextchequeinthelist
ThisisnotusedwhentheOperationModefield(tableentry3)isset
to002or003,asnonavigationispossibleinthesemodes
IftheNextChequeKeyortouchscreenareaispressedwhile
enteringanamount,theamountisacceptedbeforethenormalnext
chequefunctionalityiscompleted
Ifthechequedisplayedisthelastcheque,pressingthiskey
displaysthefirstcheque
SeeTableNote80

PreviousChequeKey
Mask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontomovetothepreviouschequeinthelist
ThisisnotusedwhentheOperationModefieldissetto002or003,
asnonavigationispossibleinthesemodes
IfthePreviousChequeKeyortouchscreenareaispressedwhile
enteringanamount,theamountisacceptedbeforethenormal
previouschequefunctionalityiscompleted
Ifthechequedisplayedisthefirstcheque,pressingthiskey
displaysthelastcheque
SeeTableNote80

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-128

APTRA Advance NDC, Reference Manual

State Tables
z003 Cheque Detail Display State
Table
Entry

No. of
Chars

Contents

Description

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

TableNote80:EachbitisassociatedwithanFDK;frombit0FDK
Atobit7FDKI.Ifabitis1,theassociatedFDKortouchareais
active.Ifabitis0,theassociatedFDKortouchareaisinactive.

DefiningDynamicDatafor
ChequeDepositStatus
2

Whenthedepositstatusofachequeistobedisplayed,thedatais
definedusinganenumeratedlist.Thislistisincludedinadisplay
dynamictextdictionarycontrolsequencewithaDictionaryIDof
000.Fordetailsofthiscontrolsequence,seeDisplayDynamicText
DictionaryControlSequenceonpage 339.
Table 277,ChequeAcceptanceStates,liststheenumeratedvalues
andtheirdefinitions.Thedisplaytextmustreflectthesedefinitions
andmatchtheavailablespaceandlanguageofthescreen.

Table 2-77
Cheque Acceptance States

Enumerated Value

Definition

001

Thechequewillbedeposited

002

Thechequewillbereturnedduetoconsumerselection

003

Thechequewillbereturnedduetovalidationfailure

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-129

State Tables
z004 Display Cheque Summary State

z004DisplayChequeSummary
State

TheDisplayChequeSummarystatedisplaysasummaryofthe
chequesthathavebeenacceptedduringtheBunchChequeAccept
state(seepage 2113).Thisstateprovidesthefollowing:

Asummaryofthedeposittransaction.Thesummarycan
includethefollowing:
Thenumberofchequesinserted
Thenumberofchequesrefused
Thenumberofchequesthattheconsumerhasselectedfor
return
Thetotaldepositamount
Detailsofuptoninecheques.Thecontentofthecheque
displaycanbeconfiguredtodisplayascaledchequeimage,
thecodelineandtheamount
FDKsortouchscreenareaassignedtoselectthenextand
previouslistofcheques
AnFDKortouchscreenareaassignedtotaketheProceedNext
StateNumberexit(extension3,tableentry3)
AnFDKortouchscreenareaassignedtocancelthedeposit
AnFDKortouchscreenareaassignedtoallowtheinsertionof
morecheques
Handlingoftimeouts,byeitherallowingtheconsumermore
timeorbycompletingthestateandtakingtheTimeoutNext
Stateexit

Note:Ifatimeoutoccurs,ortheconsumercancelsthetransaction,
nounsolicitedmessageissenttoCentralorjournaled.

Enablingkeypadkeystoallowtheconsumertoselectacheque
toviewingreaterdetailusingtheChequeDetailDisplaystate.
Whileviewingthedetaileddisplay,theconsumercaneditthe
amountofthedisplayedcheque.Eachchequedisplayedinthe
summaryscreenisassociatedwithoneofthe1to9keypadkeys.
SelectinganumerickeycausestheViewChequeDetailsState
exittobetakenwiththecurrentchequesettothecheque
associatedwiththeselectedkey.Ifnochequeisassociatedwith
theselectednumerickey,thereisabeeptoacknowledgethekey
pressbutnothingelseoccurs.

Ifnochequesareavailablefordisplay,onlytheChequeSummary
screenisdisplayed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-130

APTRA Advance NDC, Reference Manual

State Tables
z004 Display Cheque Summary State

CurrentChequeIndex

TheDisplayChequeSummarystate,BunchChequeAcceptstate
andChequeDetailDisplaystateshareacurrentchequeindexvalue.
TheBunchChequeAcceptstateinitialisesthecurrentchequeindex
tothefirstchequeinthechequelist.
TheDisplayChequeSummarystatedisplayspagesofcheques,with
eachpagecontainingfromonechequeuptothenumberofcheques
definedbytheMaxChequeDetailsparameter(extension1,table
entry7).WhentheChequeDetailStateexitistakenfromthe
DisplayChequeSummarystate,thesettingofthecurrentcheque
indexdependsontheOperationModefieldasfollows:

IftheOperationModefieldissetto001,thecurrentcheque
indexissettothechequeselectedbytheconsumer.Ifyouwant
theselectedchequetobedisplayedimmediately,theCheque
DetailDisplaystatemusthavetheOperationModefieldsetto
001.OnreturntotheDisplayChequeSummarystate,thepage
ofchequesdisplayedisthepagecontainingthelastcheque
displayedintheChequeDetailDisplaystate
IftheOperationModefieldissetto002or003,thecurrent
chequeindexisresettothefirstchequeinthechequelist.On
returntotheDisplayChequeSummarystate,thecurrentcheque
indexisunchanged.

Table 2-78
z003 - Cheque Detail Display State
Table
Entry

No. of
Chars

Contents

Description

z(7AH)

MasterExtensionState

Statesubtype

004

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-131

State Tables
z004 Display Cheque Summary State
Table
Entry

No. of
Chars

Contents

Description

ExtensionState1
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate1
SeeExtension1toStatez004

ExtensionState2
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate2
SeeExtension2toStatez004

ExtensionState3
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberforextensionstate3
SeeExtension3toStatez004

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

Table 2-79
Extension 1 to State z004
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

ChequeSummaryScreen
(Range000999)

Containsthebackgroundforthechequesummarydisplay

NextFDKScreen
(Range000999)

NestedscreentooverlaytheChequeSummaryscreenwhenthe
NextFDKkeyortouchscreenareaisenabledbecausethereare
morechequestodisplaythancanfitonasinglescreen

PreviousFDKScreen
(Range000999)

NestedscreentooverlaytheChequeSummaryscreenwhenthe
PreviousFDKkeyortouchscreenareaisenabledbecausethereare
morechequestodisplaythancanfitonasinglescreen

ChequeDisplayArea
TopRow
(Range000015)

Specifiesthetopoftheareausedtodisplaydynamicchequedata

ChequeDisplayArea
LeftColumn
(Range000031)

Specifiestheleftoftheareausedtodisplaydynamicchequedata

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-132

APTRA Advance NDC, Reference Manual

State Tables
z004 Display Cheque Summary State
Table
Entry

No. of
Chars

Contents

Description

MaxChequeDetails
(Range00010)

Specifiesthemaximumnumberofchequestodisplayonasingle
screen

ChequeDetailsOverlay
Screen
(Range000999)

Overlayscreentodefinewhatisdisplayedforeachcheque.
Ifthechequedepositstatusistobedisplayed,adynamictext
dictionarycontrolsequencemustbedefinedwithinthisscreen.The
statusvaluesthatmustbeincludedinthedictionaryaredescribed
inDefiningDynamicDataforChequeDepositStatuson
page 2129
SeeTableNote81andTableNote82

ChequeDetailsOverlay
Size
(Range000015)

Specifiesthenumberofrowsallocatedforthedisplayofthecheque
details

TableNote81:Anypositioncoordinatesusedintheoverlay
screenarerelative.
TableNote82:Newdisplaycontrolcodesareaddedtoallowthe
displayofdynamicdataassociatedwiththeinsertedcheques.
Table 2-80
Extension 2 to State z004
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

ChequeDetailArea
BackgroundScreen
(Range000999)

Overlayscreentocleartheareaforchequedetaildisplayoninitial
entrytothestateandwheneithertheNextorPreviousFDKor
touchscreenareaisselected

CancelKeyMask

SpecifiestheFDKsortouchscreenareasthatareactiveasCancel
keys
TheCancelFDKisactiveonallscreens
SeeTableNote83

ProceedKeyMask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontoproceed
SeeTableNote83

NextFDKKeyMask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontodisplaythenextscreenofcheques
ThisFDKortouchscreenareaisonlyenablediftherearemore
chequestodisplaythanwillfitonasinglescreen
Ifthechequedisplayedisthelastcheque,pressingtheNextkeyor
touchscreenareadisplaysthescreencontainingthefirstcheque
SeeTableNote83

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-133

State Tables
z004 Display Cheque Summary State
Table
Entry

No. of
Chars

Contents

Description

PreviousFDKKeyMask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontodisplaythepreviousscreenofcheques
ThisFDKortouchscreenareaisonlyenablediftherearemore
chequestodisplaythanwillfitonasinglescreen
Ifthechequedisplayedisthefirstcheque,pressingthePrevious
keyortouchscreenareadisplaysthescreencontainingthelast
cheque
SeeTableNote83

AddMoreFDKKey
Mask

SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontoaddmorecheques
ThisFDKortouchscreenareaisonlyenabledwhenthedevicehas
thecapacitytoacceptadditionalcheques
SeeTableNote83

AddMoreFDKScreen
(Range000999)

NestedscreentooverlaytheChequeSummaryscreenwhenthe
AddMoreFDKkeyortouchscreenareaisenabled

Mustbe000

Reserved

TableNote83:EachbitisassociatedwithanFDK;frombit0FDK
Atobit7FDKI.Ifabitis1,therelativeFDKortouchareais
active.Ifabitis0,therelativeFDKortouchareaisinactive.
Table 2-81
Extension 3 to State z004
Table
Entry

No. of
Chars

Contents

Description

Statetype

Z(5AH)

CancelNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancelkeyispressed

ProceedNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheProceedkeyispressed

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-134

APTRA Advance NDC, Reference Manual

State Tables
z004 Display Cheque Summary State
Table
Entry

No. of
Chars

Contents

Description

AddMoreNextState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheAddMorekeyispressed

TimeoutNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerfailstorespond
inthespecifiedtimelimit
Enter255ifthetimeoutfunctionisnotrequired

ViewChequeDetailState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheconsumerchoosesto
viewthedetailsofacheque
ThisidentifiestheChequeDetailDisplaystate,whichmusthave
theOperationModesetto001

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-135

State Tables
z008 Insert Card State

z008InsertCardState

TheInsertCardstatesupportsmotorisedcardreadersandsmart
dipcardreaders.Thisstateallowscardentryduringatransaction.
Thestateoperatesasfollows:

Promptstheconsumertoinsertacard
Activatesthecardreader
Ifbeepingisenabled,startsbeeping
StartstheMEIflashingtoshowwheretoenterthecard.

Note:Beepingstartsonlyiftheextensionstatetableentryvalue6
issetto001.Ifitissetto000,thebeeperdoesnotsoundevenifthis
stateisactiveandtheMEIisswitchedon.Aftercardentry,theMEI
isswitchedoffandthebeepingstops.
TheInsertCardstateenablestheCancelkeybeforecardinsertion.If
theconsumerpressestheCancelkeyduringthistime,theapplication
flowgoestotheCancelNextState.Aftercardinsertion,theCancel
keyisdisabled.
TheInsertCardstateinitialisesthefollowing:

CardDatabuffers
ConsumersselectablePINbuffers
BufferA.

Ifthecardreadissuccessful,theCardDatabuffersarepopulated
withthecarddata.Ifthecardreadfailsbecauseofaninvalidcardor
adeviceerror,thepreviousdatainthesebuffersisretained,the
NextStateExitistakenandthecardisejected.
Thisstatehandlestimeoutsbasedontimer04.Iftheconsumerdoes
notenterthecardbeforetimer04expires,theTimeOutNextState
istaken.
ThefollowingfunctionsarenotsupportedbytheInsertCardstate:

Cardlessentry
Idlesequence
Initializationofthefollowing:
BufferB
BufferC
Amountbuffer
Operationcodebuffer
FDKbuffer
Promoteflowpoints.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-136

APTRA Advance NDC, Reference Manual

State Tables
z008 Insert Card State
Table 2-82
z008 - Insert Card State
Table
Entry

No. of
Chars

Contents

Description

StateType

SubType

008

InsertCardScreen
Number
(Range000999)

Promptstheconsumertoenteracard.Thisscreenisdisplayed
whiletheSSTiswaitingforcardentry.

GoodReadNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesineitherofthefollowing
situations:

AfterasuccessfulreadofthecardifFITsarenotused(Table
entry4intheextensionstate=000).

IftheFinancialInstitutionnumberonthecardmatchesa
FinancialInstitutionnumberinaFIT.

Error(Misread)Screen
Number
(Range000999)

Screentodisplayifthereadconditionsarenotsatisfiedduetoan
invalidcardoramechanismerror.
Afterejectingthecard,thecardreaderisreactivatedandwaitsfor
thecardentry.

Readcondition1

Readcondition2

Thesethreeentriesspecifywhichcardtrack(s)and/orchipdatawill
beread.Thepossiblevaluesfortheseentriesareshownin
Table 24.

Readcondition3

ExtensionStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumberoftheextensionstate.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-137

State Tables
z008 Insert Card State
Table 2-83
Extension to Statez008
Table
Entry

No. of
Chars

Contents

Description

StateType

Cancelnextstatenumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesiftheCancelkeyispressed.

TimeOutNextstate
number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoeswhentimer04expiresorwhen
acardisejectedduetoaninvalidreadbutnottakenbythe
consumer.
Ifthecardisnottakenwithinthedurationoftimer09,thecardis
capturedandtheTimeOutNextStateistaken.

NoFITMatchNextstate
number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesifeithertheFinancial
InstitutionnumberonthecarddoesnotmatchanyFIT,orthecard
readerisasmartcardreaderandthereadconditionbeing
evaluatedhasthechipconnectbitset(bit3).
IfFITsarenotusedthisentrymustbe000.

FatalNextstatenumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertowhichtheSSTgoesinthefollowingsituations:

Thecardreaderisinafatalcondition

Thecardreaderisoutofoperation

Thereisadeviceerror

Inthesecases,thecardisejectedandsubsequentlycapturedifitis
nottakenbytheconsumer.
6

Enablebeeper

Enablesordisablesthebeeperasfollows:

001Enablesthebeeperwhenwaitingforcardentryandwhen
thecardisejected

000Disablesthebeeper(default).

Thedefaultvalueisusedifthevalueisoutofrange
7

TakeCardscreennumber
(Range000999)

Ifthecardreaderisasmartdipreaderandachipconnectbitisset,
buttheATR(AnswertoReset)fails,thisscreenisdisplayedto
prompttheconsumertoremovethecardandwait.Thisscreenis
displayeduntiltheconsumerremovesthecardortimer72expires.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-138

APTRA Advance NDC, Reference Manual

State Tables
z008 Insert Card State
Table
Entry

No. of
Chars

Contents

Description

CardReturnFlag

TellstheSSTwhenthecardistobereturnedtotheconsumeras
follows:

000Ejectthecardimmediately

001ReturnthecardasspecifiedbyaTransactionReply
commandmessage
Thisflagisignoredwhenthereadconditionsfailorthecardreader
isinafatalcondition.Inthesecases,thecardisreturned
immediately,irrespectiveofthisflagvalue.
WhentheCardReturnFlagis000,thecardisreturnedaftera
successfulread.Iftheconsumerdoesnottakethecardwithinthe
durationoftimer09,thecardisleftatthethroatandtheGoodRead
NextStateistaken.

Mustbe000

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-139

State Tables
z009 Buffer Validation State

z009BufferValidationState

TheBufferValidationstateisusedtovalidatedataenteredbythe
consumerandheldinbuffersB,CortheAmountbuffer.The
validationisachievedusinganXMLconfigurationfile.Fordetails
oftheXMLconfigurationfile,ValidationRuleSet.xml,anditsrelated
schema,refertoChapter5,ConfiguringAdvanceNDCand
AssociatedComponentsintheAPTRAAdvanceNDC,Developers
Guide.
Examplesofstatesthatrequiredataentryareasfollows:

F(AmountEntry)
R(EnhancedAmountEntry)
X(FDKInformationEntry).

Thisstateensuresthatvaliddataissenttothehost.Thefollowing
areexamplesofdatathatcanbevalidatedusingtheBuffer
Validationstate:

Dateformats
Thelengthofdata
Thecontentofsomedata.

AdvanceNDCattemptstomatchtheRuleSetIDfromtableentry3
withthesameIDintheXMLconfigurationfile.Ifamatchisfound,
AdvanceNDCreadsthepatternfortheruleset.Iftherulepattern
matchesthebufferdata,theGoodValidationNextStateexitis
taken.Ifthepatterndoesnotmatch,theValidationFailNextState
exitistaken.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-140

APTRA Advance NDC, Reference Manual

State Tables
z009 Buffer Validation State
Table 2-84
z009 - Buffer Validation State
Table
Entry

No. of
Chars

Contents

Description

StateType

SubType

009

RuleSetID
(Range001999)

DefinestheruleidentifiertomatchwiththeIDattributeinthe
XMLconfigurationfile.

BufferID

Definesthebuffertobevalidated.
Validvaluesareasfollows:

001BufferB

002BufferC

003AmountBuffer
SeeTableNote84

GoodValidationNext
StateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumbertogotoifthedataissuccessfullyvalidated.

ValidationFailNextState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Statenumbertogotoifthedatavalidationfails.

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

TableNote84:Iftheidentifiedbuffercontainsnodata,the
ValidationFailNextStateexitistaken.

DateValidationScenario

ThefollowingscenarioillustrateshowthestatetableandXML
configurationfileareusedtovalidatebufferdata.
Inthisscenario,thefollowingarereadfromthestatetable:

RuleSetID(tableentry3).Inthisscenario,thisissetto123
BufferID(tableentry4).Inthisscenario,thisissetto001

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-141

State Tables
z009 Buffer Validation State

TheXMLconfigurationfilecontainsthefollowing:
<RuleSet ID="123">
<!-Date validation Rule -->
<Rule Pattern=="(0[1-9]|1[012])[/.](0[1-9]|[12][0-9]|3[01])[- /.](19|20)\d\d"/>
</RuleSet>

ThePatternattributeisdefinedusingregularexpressions.Formore
informationaboutdefiningvalidstringformatsusingregular
expressions,refertotheMicrosoftDevelopersNetworkpageat
http://msdn.microsoft.com/enus/library/2k3te2cs(VS.80).aspx.
AdvanceNDCcheckstheXMLconfigurationfileforamatching
rulesetIDandfindsone.Therulepatternischeckedagainstthe
bufferdata.Thedateformatismm/dd/yyyyandvalidationisas
follows:

IfBufferBcontains12/31/2009,thedataiswithinthelimits
specifiedintherulepatternandtheGoodValidationNextState
exitistaken.
IfBufferBcontains31/12/2009,themonthdataexceedsthelimit
of12andtheValidationFailNextStateexitistaken.

FordetailsoftheXMLschema,ValidationRuleSet.xsd,
ValidationRuleSet.xsdrefertosectionConfiguringCardholder
Functionalityinchapter5oftheAPTRAAdvanceNDC,Developers
Guide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-142

APTRA Advance NDC, Reference Manual

State Tables
& - Barcode Read State

&BarcodeReadState

TheBarcodeReadstateallowsanapplicationtoreadabarcode.
Optionallyafiltercanbeusedtoselectanalternativeflow,basedon
thebarcodecontent.
Whenthisstateisentered,thescreenidentifiedbytableentry1is
displayedandthebarcodereaderisenabled.
Thebarcodefiltersaredefinedinthebarcodereaderconfiguration
file,whichcanbedownloadedusingtheXMLconfiguration
downloaddescribedonpage 1046.Fordetailsofthebarcodereader
configurationfilerefertotheAdvanceNDC,DevelopersGuide.
Thedownloadedfiltersarecomparedtothebarcode,startingin
sequencefromfilterindexzero.Ifabarcodeissuccessfullyread,
andfilterexitextensionstatesaredefined,thebarcodeischecked
againstthebarcodereaderconfigurationfileasfollows:

Ifabarcodefilterintheconfigurationfilematchesthebarcode
readstate,theexitdefinedintheextensionstatesinthefilter
indexistaken
Ifthestatenumberforthematchedbarcodefilterissetto000
or255,theGoodBarcodeReadexitistaken

Ifthebarcodedoesnotmatchanyfilter,therearenofilters
defined,orthereisnonextstatedefinedinthefilterindex,the
GoodBarcodeReadexitistaken.

Table 2-85
& - Barcode Reader State
Table
Entry

No. of
Chars

Contents

Description

&(26H)

StateType

ScreenNumber(Range
000999)

Displayscreenpromptingtheconsumertoscanabarcode.

GoodbarcodeReadState
Number
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumbertheSSTgoestoifabarcodehassuccessfullybeen
readandnoBarcodeFiltermatches,orthereisnoexitdefined
fortheBarcodeFilterIndexintheExtensionStates.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-143

State Tables
& - Barcode Read State
Table
Entry

No. of
Chars

Contents

Description

CancelNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoifthebarcodescanwas
cancelledbythecustomer.

ErrorNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoifthereisaproblemreading
thebarcode,forexampleabarcodereaderhardwareorbarcode
readerconfigurationerror.

TimeoutNextStateNumber
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoifthebarcodescantimesout.

BarcodeDataDestination
(07)

Destinationbufferforbarcodedata

SeeTableNote85

SeeTableNote86

SeeTableNote87

Track3buffer(default)(max106bytes)

Track1buffer(max78bytes)

Track2buffer(max39bytes)

GeneralPurposebuffersAandB(max64bytes)

GeneralPurposebuffersBandC(max64bytes)

GeneralPurposebuffersCandA(max64bytes)

10 Barcodereaderbufferidentifiedbythecharactere(maxsize
limitedbymessagesize)

11 Amountbuffer(max8or12bytes,dependingonconfiguration).
SeeTableNote88,TableNote89,andTableNote90.
8

ActiveCancelFDKkeymask
(Range0255)

TheFDKkeys(s)enabledtocancelthebarcodescanning
process.TheCancelkeyonthePINPadwillalwaysbeenabledif
aCancelexitisdefined.

ExtensionState1
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Extensionstate1allowsadditionalparameterstobeaddedin
thefuture,asallparametersinextensionstates2toNcontain
theBarcodeFilterexitvalues.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-144

APTRA Advance NDC, Reference Manual

State Tables
& - Barcode Read State

TableNote85:TheCancelkeyandassociatedFDKareenabledifa
Cancelnextstateexitisdefined.IftheconsumerpressesCancel,the
deviceisdisabledandtheCancelnextstateexitistaken.
TableNote86:Ifabarcodecannotbereadbecauseofatechnical
problem,orthebarcodereaderisnotpresent,theErrornextstateis
taken.Anunsolicitedstatusmessageissenttoreportthedevice
fault.
TableNote87:IfthetimeoutdefinedbyTimer61expiresora
hardwaretimeoutoccurs,theinternalTimeOutstateistakento
requestmoretime.Iftherequestissuccessfulthebarcodereaderis
enabled.Iftherequestisdenied,thetimeoutnextexitstateistaken.
TableNote88:Ifthescannedbarcodedataexceedsthefixedlength
ofthedestinationbuffersize,itwillbetruncatedtothelengthofthe
buffer.
TableNote89:Ifoption3,4or5isselected,andthelengthofthe
scannedbarcodedataexceeds32bytes,itwillbesplitacrossthetwo
buffersandtruncatedat64bytes.
TableNote90:Whenabarcodeissuccessfullyreaditisplacedin
thebufferspecifiedbyBarcodeDataDestination.Ifthespecified
destinationbufferisunknown,theSSTwillgotoErrorNextState
Number.
TableNote91:Table 2-86
Extension 1 to State &
Table
Entry

No. of
Chars

Contents

Description

StateType

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

Reserved

Mustbe000

ExtensionState2
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

Extensionstate,000ifthereisnoextensionstate.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-145

State Tables
& - Barcode Read State

BarcodeReadExtensionstates28provideamechanismfor
selectingastateflowbranchbasedonthecontentofthebarcode
read.Thebarcodefilters,downloadedusingtheXMLconfiguration
download,arecomparedagainstthebarcode.Whenamatchis
found,theindexofthematchingfilterisusedtoselectanexit.
BarcodeReadExtensionstate2definestheexitsforabarcodefilter
matchwithanindexequalto0,1,2,3,4,5,or6;BarcodeRead
Extensionstate3definestheexitsforabarcodefiltermatchwithan
indexequalto7,8,9,10,11,12,or13,andsoon.Upto49filterscan
bedefined.
Table 2-87
Extensions 28 to State &
Table
Entry

No. of
Chars

Contents

Description

StateType

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten2)*7).
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto((Extensionstaten2)*7).If
thisvalueis000theGoodBarcodeReadNextStateExitis
takenwhenthefiltermatches.

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten2)*7)+1.
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto
((Extensionstaten2)*7)+1.
Ifthisvalueis000theDefaultBarcodeReadNextStateExitis
takenwhenthefiltermatches.

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten2)*7)+2.
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto
((Extensionstaten2)*7)+2.
Ifthisvalueis000theDefaultBarcodeExitistakenwhenthe
filtermatches.

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten2)*7)+3.
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto
((Extensionstaten2)*7)+3.
Ifthisvalueis000theGoodBarcodeExitistakenwhenthe
filtermatches.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-146

APTRA Advance NDC, Reference Manual

State Tables
& - Barcode Read State
Table
Entry

No. of
Chars

Contents

Description

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten2)*7)+4.
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto((Extensionstaten 2)*7)+4.
Ifthisvalueis000theGoodBarcodeExitistakenwhenthe
filtermatches.

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten 2)*7)+5.
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto
((Extensionstaten 2)*7)+5.
Ifthisvalueis000theGoodBarcodeExitistakenwhenthe
filtermatches.

NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten 2)*7)+6.
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto((Extensionstaten 2)*7)+6.
Ifthisvalueis000theGoodBarcodeExitistakenwhenthe
filtermatches.

NextExtensionState
(Base10range000254or
256999)
(Base36range000254or
256ZZZ)

ExtensionState,000signifiestherearenomoreextension
states.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-147

State Tables
Time-Out State

TimeOutState

TheSSThasafixedTimeOutstate.Thisisenteredunderoneofthe
conditionsdescribedinthefollowingtable:
Table 288

Entry Conditions for the Time-Out State

Entry
Condition

Description

Timer00expiresduringakeyboarddataentrystate

Timer04expiresduringanenvelopedeposit
transaction(envelopenotinserted)

Timer08expiresduringanightsafedeposit
transaction

AscreentimerfromanInteractiveTransaction
Responsemessageexpireswhilethenumerickeypad
ortheFDKsareactive

Timer61expiresduringabarcodereaderscan

Theconsumerfailstoremoveanenvelopewithinthe
periodspecifiedbytimer94

AtimeoutoccursduringaCashAcceptstate

AtimeoutoccursduringaChequeAcceptstateor
BunchChequeAcceptstate

Formoredetailsoftimers,seeTimersonpage 722and
ConfigurationParametersLoadonpage 1014.
OnentrytotheTimeOutstate,screenC00isdisplayed,givingthe
consumertheoptionofmoretime.Timer01andthefastbeepare
started.FormoredetailsseeRedefiningReservedScreenson
page 348.
YouhavetoensurethattheTimeOutstatedealsappropriatelywith
audiofilesifaforeignlanguagehasbeenselectedinamultiple
languageenvironment.
Dependingonthekeyselectedbytheconsumerandtheentry
conditionthatcausedtheTimeOutstatetobeentered,oneofthe
followingexitscanbetakenfromthestatethatenteredthe
TimeOutstate(thepreviousstate):

TheTimeOutnextstateexit
TheCancelnextstateexit.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-148

APTRA Advance NDC, Reference Manual

State Tables
Time-Out State

IftheconsumerpressesFDKA(orFDKIiftheoptionthat
enablesthekeystotheleftofthescreenisset)toselectmoretime,
theSSTreturnstothepreviousstate,theoriginaltimerisrestarted,
andbeepingstopsforentryconditions1,4,5or6,oraslowbeep
returnsforconditions2and3.
IftheconsumerpressesFDKB(orFDKH)ortimer01expires,the
beepingstopsandtheactiondescribedinthefollowingtable,
Table 289,ActionTakenonSelectionofFDKBforEachEntry
Condition,istakenfortheassociatedcondition,describedin
Table 288,EntryConditionsfortheTimeOutStateon
page 2148.
Table 2-89
Action Taken on Selection of FDK B for
Each Entry Condition

Entry
Condition

Action

TheTimeOutnextstateexitfromthepreviousstateistaken

AtimeoutstatusmessageissenttoCentral

AtimeoutstatusmessageissenttoCentral

TisplacedingeneralpurposebufferB

TheTimeOutnextstateexitfromthepreviousstateistaken

AtimeoutstatusmessageissenttoCentral

Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaCashAcceptstate,see>
CashAcceptStateonpage 293

Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaChequeAcceptstate,seew
ChequeAcceptStateonpage 2105
Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaBunchChequeAcceptstate,
seez001BunchChequeAcceptStateonpage 2113

Enhancedconfigurationparameteroption71controlsthenumberof
timestheTimeOutstatecanbeentered.Fordetails,seeOption71
TimeOutStateEntryonpage 716.
IftheconsumerpressestheCancelkey,thebeepingstopsandthe
actiondescribedinthefollowingtable,Table 290,ActionTakenon
SelectionoftheCancelKeyforEachEntryCondition,istakenfor
theassociatedconditiondescribedinTable 288,EntryConditions
fortheTimeOutStateonpage 2148.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

2-149

State Tables
Time-Out State
Table 2-90
Action Taken on Selection of the Cancel
Key for Each Entry Condition

Entry
Condition

Action

TheCancelnextstateexitfromthepreviousstateistaken

AtimeoutstatusmessageissenttoCentral

AtimeoutstatusmessageissenttoCentral

EisplacedingeneralpurposebufferB

TheCancelnextstateexitfromthepreviousstateistaken

AtimeoutstatusmessageissenttoCentral

Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaCashAcceptstate,see>
CashAcceptStateonpage 293

Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaChequeAcceptstate,seew
ChequeAcceptStateonpage 2105
Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaBunchChequeAcceptstate,
seez001BunchChequeAcceptStateonpage 2113

TheSSTmaysupporttouchscreenFDKemulationinsteadof
regularFDKs.Inthisstate,twooftheeightpossiblefixedtouch
areasareenabledonthescreenandtheconsumertouchesthem
insteadofpressingthecorrespondingFDK.Thetouchareasare
enabledanddisabledinexactlythesamewayastheFDKs.For
details,seetheFDKEmulationsectioninChapter 4,Keyboard
DataandLayouts.
Alternatively,theSSTmaysupportfulltouchscreenkeyboards.In
thiscase,touchareasaredefinedonthescreenforalltherequired
keys.Theconsumertouchestheseinsteadofpressingakeyonthe
keypadoranFDK.Ifthekeyboarddefinitionisnotvalidated,the
keyboardlayoutisnotchanged,thekeyboardisdisabledandtrace
messageT86isprintedonthejournal.Fordetails,seeChapter 4,
KeyboardDataandLayouts.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

2-150

APTRA Advance NDC, Reference Manual

Table of Contents
Screen Data

Chapter 3

ScreenData
Overview

31

TheScreenInterface
CustomerScreens
CustomerScreenGroups
ReservedScreens

32
32
33
33

TypesofReservedScreen
CCardholderDisplay
ScreenC00
ScreenC01
ScreenC02
ScreenC03
ScreenC04
ScreenC05
ScreenC06
ScreenC07
ScreenC20
GGraphicPictures
KExtendedScreenControls
Receipt:K01
Receipt:K09
Journal:K02
Journal:K10
ReceiptandJournal:K07
ReceiptandJournal:K08
Statement:K03
ControlSequencesforReceipt,JournalandStatement
Printers
LLogos
MSupervisorMenus
EditingtheContentsofReservedScreens
ReservedScreenConstraints

311
312
312
313
313

FormattingRulesforCardholderDisplayScreens

314

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

35
36
36
36
36
36
36
37
37
37
37
38
38
39
310
310
310
310
311
311

Table of Contents
Screen Data

CardholderScreen:DisplayCharacters
OperatorInterfaceDisplayCharacters
ControlCharacters
Track1NameDisplay
ISOFormatCards
VISAFormatCards
AutoSelectBackwardsSearch
AutoSelectForwardsSearch
ABAFormatCards
NameDisplay
ControlCodesforSpecialFeatures
Voice
PrerecordedMessages
DigitalAudioControlforVoiceGuidance
ScreenBlinkingandColourControl
ChangingDisplayDuringtheIdleLoop
SelectPrimaryCharacterSet
SelectSecondaryCharacterSet
LeftMarginControl
SetDisplayModeControl
LogoControl
PictureControl
DisplayImageFilesControl
LiftChequeImageControl
BunchChequeImageDisplayControl
BunchChequeCodelineDisplayControl
BunchChequeAmountDisplayControl
BunchChequeValueDisplayControl
DisplayDynamicTextDictionaryControlSequence
DynamicButtonControl
SyntaxofConditionalExpressions
DynamicTextControl
AnimationandDigitalVideo
InternationalCurrencyDisplayFormat
CurrencyEchoExample
ExampleofDefaultEchoDisplayFormat

314
315
316
318
319
319
319
320
320
320
320
321
321
323
327
330
331
331
332
332
333
333
334
335
335
337
337
338
339
341
342
343
344
344
345
346

MultiLanguageScreens
RedefiningReservedScreens

347
348

DisplayingPictures
PictureResolution
GuidelinesforPictures

349
349
349

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Screen Data

TouchScreenReset

350

SupervisorSettlementScreens
UsingtheFrontorRearInterfaceforSettlement
RearSettlementandInternationalSecurity(DAPI7)
SupervisorSettlementTransactions
ValidCommands
TransactionsParameterScreens(C09C19)

351
351
351
352
352
353

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Screen Data

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Screen Data
Overview

Overview

Thischapterprovidesinformationonthefollowingtopics:

Thescreeninterface
Typesofreservedscreen
Formattingrulesforconsumerdisplayscreens
Multilanguagescreens
Picturedisplay
Touchscreenreset
ThescreensusedforSupervisorsettlementtransactions.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-1

Screen Data
The Screen Interface

TheScreenInterface

Ascreenisastringofcharacters,includingcontrolcharacters,that
defineswhatistobedisplayedandwheretodisplayit(cardholder
screen,operatorpanelorprinter).Therearetwotypesofscreen:
Customerscreensdefinedbytheuser

Reservedscreensalreadydefinedwithintheterminal
software.
Theprogrammaticscreenlayoutforconsumerscreenandoperator
panelisasfollows:

Figure 3-1
Cardholder/EOP Screen Layout

@ A B

C D E

F G H

L M N O

<

>

10

11

12

13

14

15
0

CustomerScreens

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

Acustomerscreenisascreenthatyoucreate.AdvanceNDC
supportsupto9,999customerscreens.Youdecideonthetexttobe
included,andanypicturesorlogostobeused.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-2

APTRA Advance NDC, Reference Manual

Screen Data
The Screen Interface

Thedataisdownloadedtotheterminalinascreendataload
message.Formoredetails,seetheScreen/KeyboardDataLoad
sectioninChapter 10,CentraltoTerminalMessages.
Allthescreensthatareaccessedbythestatetablesarestoredinthe
ScreenTable.Eachscreeninthetablehasauniquenumberfrom
0000to9999.Itisthisnumberthatisreferencedbyparametersinthe
statetablesduringtransactionprocessing.

CustomerScreenGroups

Twoscreengroupsareused,asfollows:

Screengroupuforlanguageindependentscreennumbers
Screengrouplforlanguagedependentscreennumbers.

Screengroupu Thisdefineslanguageindependentnumbers,for
example,u1234.Thisisafourdigitscreengroup,sothefullrangeof
userscreensis0000to9999.Formultilanguageuse,theuserscreens
canbesplitintolanguagegroups.Whilethesizeofeachgroupcan
bevaried,itisassumedthateachgroupwillcontain1000screens.A
screeningroupucanalsobedefinedasafourdigitnumberin
doublequotes,withouttheprefixletter,forexample1234.
3

Screengroupl Thisdefineslanguagedependentscreen
numbers,forexample,l1234.Thisisalsoafourdigitgroup,butwill
normallyonlydefinescreensintherange0000to0999.Screengroup
lmapsontothe1000screensfromgroupuwhichareinuseforthe
currentlanguage.Ifnolanguageisdefined,thengrouplwillmap
tothefirstlanguagegroup.
3

Forcompatibility,thefollowingapply:

Numericscreennumbersintherange000to999canstillbe
specified,forexample123.
Forstateparameters,thescreennumbersmustbethreenumeric
digits.

Forexamples,seeMultiLanguageScreensonpage 347.

ReservedScreens

Areservedscreenisascreenthatisalreadydefinedwithinthe
terminalsoftware.Reservedscreenshavefixedfunctions,suchas
displayingSupervisorpromptsandmenus,andareonlydisplayed
atpredefinedtimes,suchaswhentheterminalisinOutofService
orOffLinemode.Somereservedscreensconsistofcontrol
sequencesandareusedtomanagedifferentaspectsofthedisplay,
forexample,charactersetsandlogos.
Thenumberingforreservedscreensconsistsofanalphacharacter
thatdefinesthescreentype,followedbytwonumericdigitsthat
definetheparticularscreen.Theexceptionstothisaretheerror
screens.Theseconsistofanalphacharacterthatdefinesthescreen

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-3

Screen Data
The Screen Interface

type,followedbyfournumericdigitsthatdefinetheparticular
screen.
Note:ForinformationaboutscreendataonothervendorsSSTs,
refertotheScreenDatatopicinChapter3oftheAPTRAAdvance
NDC,MultiVendorSupportReferenceManual.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-4

APTRA Advance NDC, Reference Manual

Screen Data
Types of Reserved Screen

TypesofReservedScreen

Thefollowingscreentypes(alsoknownasscreengroups)are
definedforreservedscreens:

ASupervisorfaciaandEnhancedOperatorInterface
Acknowledgements
CCardholderDisplay
dSupervisorDiagnosticScreens
EoreErrorScreens
GGraphicPictures
ISupervisorInformation
iSupervisorTCP/IP,Dialup,BunchNoteAcceptor(BNA)
andSettlementScreens
jSupervisorMiscellaneousScreens
KExtendedScreenControls
LLogos
MormSupervisorMenus
PorpSupervisorCRTandEnhancedOperatorInterface
Prompts
RSimulatedReceiptPreprint
SorsSupervisorInformationLines
TortJournalTraceandAcknowledgements
UCheque,EMVSmartCardandBNA
Xscreensprerecordedaudiomessages.

Thissectiondiscussesthefollowingscreentypes:

CCardholderDisplay
GGraphicPictures
KExtendedScreenControls
LLogos
MSupervisorMenus.

ForinformationaboutRscreens(SimulatedReceiptPreprint),see
SimulatedPreprintedReceiptMessagesonpage 524.
ForinformationaboutthereservedscreensC09toC19,see
SupervisorSettlementScreensonpage 351.
Fordetailsofthedefaultprerecordedaudiomessages,seeControl
CodesforSpecialFeaturesonpage 320.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-5

Screen Data
Types of Reserved Screen

FordetailsofthedefaulttextandlayoutforSupervisormenusand
theotherscreentypesnotdiscussedhere,seeAppendix A,
ReservedScreens.

CCardholderDisplay

ScreentypeC,withtheexceptionofscreensC09andC10C19,is
reservedforuseduringcardholdertransactions.Fordetailsof
screensC09andC10C19,seeSupervisorSettlementScreenson
page 351.
TheCscreentypeprovidesthefollowingscreensthatare
displayedatpredefinedtimes.

ScreenC00

Promptsacardholderwhohasfailedeithertomakeadepositorto
respondtoarequestforkeyboardinput.Youmustdownloadthe
screentotheterminalforthistotakeeffect.Thescreenmust
conformtothefollowingrequirements:

IfthecardholderpressesFDKA(orFDKI,iftheoptionthat
enablesthekeystotheleftofthecardholderscreenisset),more
timeisallowed.
IftheterminalsupportsTouchScreenFDKEmulationinsteadof
regularFDKs,thecardholdertouchestheFDKA(orFDKI)
toucharea.
IfthecardholderpressesFDKB(orFDKH),thetimeoutnext
stateexitofthepreviousstateistaken.
IftheterminalsupportsTouchScreenFDKEmulationinsteadof
regularFDKs,thecardholdertouchestheFDKB(orFDKH)
toucharea.

Fordetails,seetheTimeOutStatesectioninChapter 2,State
Tables.

ScreenC01

DisplayedwhentheterminalisinOffLinemode.

ScreenC02

DisplayedwhentheterminalisinOutofServicemode.

ScreenC03

DisplayedwhentheterminalisinSupervisormode.

ScreenC04

Displayedwhentheterminalcapturesacardasaresultofacard
readerfailure.Whenthisoccurs,thenextstateisexecuted,exceptin
aCardBeforeCashTransactionreply,whentheterminalwaitsfora

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-6

APTRA Advance NDC, Reference Manual

Screen Data
Types of Reserved Screen

newtransactionreplyfromCentral.Fordetails,seetheTerminal
FunctionsforTransactionCompletiononpage 1062.Thisscreenis
displayedfortheamountoftimespecifiedbyTimer02(page 723).
Forthetimerformatinamessage,seeConfigurationParameters
Loadonpage 1014.
Note:ScreenC04isalsodisplayedwhenthecardiscaptured
becauseithasnotbeentakenafterbeingejectedbeforethePINis
entered.

ScreenC05

Displayedwhencardholdertamperingissuspectedandthe
terminalentersSuspendmode.

ScreenC06

DisplayedwhentheterminalistemporarilyinOutofServicemode.
Thisscreenisdisplayedduringanyofthefollowingconditions:

Whenspecifiedinagooutofserviceterminalcommandsent
fromCentral.
OnexitfromSupplymodetoOutofService,ifSupplymode
wasenteredfromInService,andtheautoreturntoInService
localconfigurationoptionisnotset.
IfSupplymodeisenteredfromOutofServicewhiledisplaying
screenC06.

ScreenC07

Whentableentry5(ImageLiftoption)ofthewChequeAccept
State(seepage 2105)isset,thisscreenisusedtodisplaythelifted
chequeimage.
ThisscreencontainsthescreencontrolsequencePS,whichisused
todisplaytheliftedchequeimageasdescribedintheLiftCheque
ImageControlsectiononpage 335.
IftheimageisrequiredtobedisplayedinanHInformationEntry
State(seepage 228),theimagecanbedisplayedbyreferencing
screenC07todisplaytheimageaspartoftheFurtherProcessing
Screen.

ScreenC20

ThisisagenericPleaseWaitscreenthatcanbedisplayedwhen
thereisadelayinprocessingandthereisnotamorespecificscreen
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. Bydefault,thisscreenisundefined.IfC20is
notdefined,nothingisdisplayed.Ifitisdefined,itisdisplayed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-7

Screen Data
Types of Reserved Screen

Note:Thecashincomponent(CIC)usesscreenC20intheCash
Accept,ChequeAcceptandtheClosestates,andforRetractinthe
Refundtransactionreplyfunction.

GGraphicPictures

ScreentypeGisreservedforgraphicpictures.Fordetails,see
Appendix C,CardholderScreenGraphics.Thescreensprovided
areasfollows:

G00standardInsertCardpicture
G01standardPressKeypicture
G03standardMakeADepositpicture
G04standardTakeReceiptpicture
G05standardTakeMoneypicture
G06standardTakeStatementpicture.
G10standardScanBarcodepicture.

Thegraphicpicturescanbeinvokedasnestedscreens,andwillbe
displayedwiththetoplefthandcorneratthecurrentcursor
position.
Upto1000picturescanbedisplayedusingthePictureControl
command.Fordetails,seetheControlCodesforSpecialFeatures
sectiononpage 320.

KExtendedScreen
Controls

ScreenK00containsthescreencontrolsequencetodisplaythe
FITdependentlogo.
3

ScreenK00cannotbedownloaded.However,thecontrolsequence
SOK00causesoneofthelogosL00toL15tobedisplayed.For
detailsofcontrolsequences,seetheControlCharacterssectionon
page 316.ThelogoselectedfordisplayisdefinedbytheIndirect
NextStateIndex/LogoNumber(PSTDX)parameterinthecurrent
FITentry.
ScreensK01K03resetthereceipt,journalandstatement
printerstotheiroriginalsettings.
UsingtheSystemApplicationwithinSupervisor,youcanchange
thesettingsoftheprinters,forexample,charactersizeormargins.
Tomakesurethatthesettingsarerestoredafterusingtheseoptions,
screensaresenttoeachoftheprintersasfollows:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-8

APTRA Advance NDC, Reference Manual

Screen Data
Types of Reserved Screen
Table 3-1
K Extended Screen Controls: Restoring
Settings
Screen

Optional Screen if Printer is Thermal

Printer

K01andK09

K07andK08

Receipt

K02andK10

K07andK08

Journal

K03

Statement

IfyourequiretheSSTtomaintainnondefaultsettingsbeforeand
afterusingtheSystemApplication,youmustsetscreensK01to
K03tothenecessarynondefaultvaluesduringdownload.
Youmaydefineyourdirectoryforthereceipt/journalspecificdata
byeditingscreenK07intheresrvd.deffileorbydownloadingthe
screenfromCentral.
ScreenK08maycontainthecontrolsequencewhichidentifiesthe
filewiththecustomisabledataforcodepage000.Fordetails,seethe
DefineDownloadableCharacterSetonpage 515inChapter 5,
PrinterData.Bydefault,screenK08isnotdefined.
ScreensK09andK10maybeeditedtoincludetheDefine
DownloadableBitImagecontrolsequence(seepage 516),which
identifiesanimageanddownloadsittotheprintermemoryfor
processingwhenthePrintDownloadableBitImagecommandis
presentintheTransactionReplyprinterstream.
Note1:SomeoftheparametersforscreensK01K03canbeset
byhardwareswitchesontheprinters.Ifyoudecidetousethese
switches,makesurethatthescreensaredownloadedwiththesame
parametervalues.
Note2:ScreensK04,K05andK06arenotsupportedinAPTRA
AdvanceNDC.
ThedefaultcontentsforscreensK01K03andK07K10are
definedinthefollowingtables(alldetailsareinhexadecimal).

Receipt:K01
Table 3-2
Screen Contents K01

1B5B31363375

Topmargin163/144inch

1B5B3072

Linespacing7.5lpi

1B2831

G0set1singlesize

1B2932

G1set2singlesize

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-9

Screen Data
Types of Reserved Screen
1B5B30303070

Leftmarginzero

1B5B30343071

Rightmargin40characters

0F

SelectG0set

Receipt:K09
Table 3-3
Screen Contents K09

1B6531

PrintpositionofHRIbarcodecharacters

1B7733

Widthofbarcode

1B68313632

Heightofbarcode

1B2A31<image
filename>1B5C

DefineDownloadableBitImage

Journal:K02
Table 3-4
Screen Contents K02

1B5B3072

Linespacing7.6lpi

1B2831

G0set1singlesize

1B2932

G1set2singlesize

1B5B30303070

Leftmarginzero

1B5B30343071

Rightmargin40characters

0F

SelectG0set

Journal:K10
Table 3-5
Screen Contents K010

1B6531

PrintPositionofHRIbarcodecharacters

1B7733

Widthofbarcode

1B68313632

Heightofbarcode

1B2A31<image
filename>1B5C

DefineDownloadableBitImage

ReceiptandJournal:K07
Table 3-6
Screen Contents K07

PathtotheFinancialInstitutionReceiptand
Journalspecificdata,includingimagefiles,
graphicfilesandcustomerdefinedcode
pages.Maximumlengthis30.Bydefault,
thisisnotdefinedasthedriverwilluseits
ownpathof\40colfil

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-10

APTRA Advance NDC, Reference Manual

Screen Data
Types of Reserved Screen

ReceiptandJournal:K08
Table 3-7
Screen Contents K08

1B26<codepage
filename>1B5C

DefineCustomCodePage.Bydefault,thisis
notdefined.

Statement:K03
Table 3-8
Screen Contents K03

1B5B31343475

Topmargin144/144inch

1B5B3072

Linespacing18/144inch=8lpi

1B2831

G0set110cpi

1B2932

G1set210cpi

1B5B30303070

Leftmarginzero

1B5B30383071

Rightmargin80characters

0F

SelectG0set

ControlSequencesforReceipt,JournalandStatement
Printers

Thefollowingcontrolsequencesapplytothereceipt,journaland
statementprinters.FordetailsofcontrolsequencesforUSBprinters
refertotheAPTRAonlinedocumentationunderAPTRAXFS|
ProgrammersReference|XFSUPTRServiceProvider.
SetFirstLinePosition 1B5BP175whereP1isaone,twoorthree
byteASCIIrepresentationofnumbersintherange018288.The
bottomofthefirstlineisP1/144inchandsetsthetopmargin.
3

Note:Ifyouwanttochangethedefaultvalueforthefirstline
position,ensurethevalueyouspecifyisamultipleof18,otherwise
thevalueisroundedtothenearestlineposition.
LineSpacing 1B5BP172whereP1isaone,twoorthreebyte
ASCIIrepresentationofanumberintherange07.

Thefollowingdefaultsettingsapplyforreceiptandjournalprinters:

P1=0or1selects7.5lpi
P1=2or3selects6.0lpi
P1=4to7selects5.0lpi

Thefollowingdefaultsettingsapplyforthestatementprinter:

P1=0or1selects8lpi
P1=2or3selects6lpi
P1=4to7areignored

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-11

Screen Data
Types of Reserved Screen

Note:Theextracharacter[isnotprintedonUSBprinterswhen
invalidparametersarepassedwithescapesequencesESC[xror
ESC[xyzt.Theexpectedprintwillbe7.5linesperinchwhen
invalidparametersaresent.
CharacterSets 1B28/29G0/G1whereG0/G1isonebytethat
definesaparticularcharactersetintherange3150hex.Fordetails,
seeAppendix B,CharacterSets.Therearemorecharactersetsfor
thestatementprinterthanforthereceiptorjournalprinter.

SetLeftMargin 1B5BP170hexwhereP1isaone,twoorthree
byteASCIIrepresentationofnumbersintherange000038forthe
receiptandjournalprintersand0(rightmargin4)forthe
statementprinter.Thissetsthecolumnpositionoftheleftmargin.
SetRightMargin 1B5BP170hexwhereP1isaone,twoorthree
byteASCIIrepresentationofnumbersintherange000040forthe
receiptandjournalprintersand(leftmargin+4)137forthe
statementprinter.Thissetsthecolumnpositionoftherightmargin.

LLogos

ScreentypeLisreservedforlogos.ScreensL00toL15are
reservedfor16predefinedgraphicpicturessuchasbanklogos.You
candownloadthesescreenswithalternativepicturesortextif
required.
Upto100logoscanbedisplayedusingtheLogoControlcommand.
Fordetails,seeControlCodesforSpecialFeaturesonpage 320.

MSupervisorMenus

ScreentypeMisreservedforSupervisormenus.Theycontain
informationonthefollowingmenus:

Select
Replenish
Configure
Access.

Forthetextandlayoutofthesemenus,seeAppendix A,Reserved
Screens.
ThefollowingadditionalMscreenshavebeendefinedwhich
ensurethatAdvanceNDCwilloperateinthesamewayasprevious
NDC+releasesifyouchoosenottousethetouchscreenkeyboard
features.Theactualscreendisplaydatacontainedinthesescreensis
neverused.

M06Transactionprocessingstandardlayout
M09Transactionprocessingstandardlayoutwith
Clear/Cancelkeysswapped.

Youmayeditthesescreenstocustomisethedefaultlayouts.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-12

APTRA Advance NDC, Reference Manual

Screen Data
Types of Reserved Screen

EditingtheContentsof
ReservedScreens

ThereservedscreensaredefinedinaplainASCIItextfilenamed
resrvd.def,whichyoucanedit.Thisfilemaybeusedasasourcefor
newscreensandkeyboardlayouts.Itmayalsobeusedtoedit
screensandkeyboards.Itallowskeyboardlayoutstobedefined
locallywithoutanyimpactonCentral.

ReservedScreenConstraints

Theresrvd.deffilehascertainconstraintsonitsuse.Eachscreen
definitionstartswiththescreennumberinsidesinglequotation
marks.Therearethenthreespaces,followedbythefirstlineof
screendata,whichisalsoenclosedinsinglequotationmarks.A
LF/CRmustfollowthetrailingquotationmark.
Aswellasthescreentext,theresrvd.deffilecontainsplaceholders,
indicatedbythepercent(%)character,wheredynamicdataistobe
includedinascreen,forexample,inscreensI03,I04,T17,T18andso
on.Ifyouareeditingorlocalisingthetext,theseplaceholder
charactersmustbeleftinplace;onlyedittheprecedingor
surroundingtext.Forexample,inthefollowingscreenI08line,
edit/localiseonlythewordsCURRENTSCREENanddonot
removethe%placeholder:
CURRENT SCREEN = %

Subsequentlinesofthescreenareaddeduntilthelastline.Thislast
lineterminatesliketheothersbutisfollowedbyexactlyoneempty
linebeforethenextscreendefinition.
Note:Ifyouuseaneditorthataddscontrolcharacters,ensurethat
theyarenotaddedtotheresrvd.deffile.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-13

Screen Data
Formatting Rules for Cardholder Display Screens

FormattingRulesforCardholder
DisplayScreens

Theformattingrulesforallscreensthataredisplayedonthe
cardholderscreenduringStateTableprocessingincludethe
following:

Displaycharacters
Controlcharacters
Track1namedisplay
Controlcodesforspecialfeatures
Internationalcurrencydisplayformat.

Forgeneralpointstoconsiderwhenyouarepreparingscreensfor
display,seeDisplayingPicturesonpage 349.

CardholderScreen:
DisplayCharacters
Table 3-9
Cardholder Screen: Character Sets

Thecardholderscreencandisplayanycharactercontainedinthe
followingcharactersets:
3

Character Set ID

Number of
Characters

Designator

SingleSizeAlphanumeric1

96

SingleSizeAlphanumeric2

96

StandardGraphics1

64

StandardGraphics2

64

StandardGraphics3

64

DoubleSizeAlphanumeric1

96

>

DoubleSizeAlphanumeric2

96

SingleSizeAlphanumeric1

96

SingleSizeAlphanumeric1isthestandardcharacterset.Other
charactersetscanbeaccessedthroughtheSelectCharacterSet
controlsequence.
StandardGraphics2mapstoCustomerGraphics2(Arabic)andisa
displayonlyfont,reflectingtherangeandlookofcharactersthat
arerequiredinanSSTapplication.Formoreinformationabout
charactersets,seeAppendix B,CharacterSets.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-14

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Thefollowingcharactersetscontaincustomerdefinedcharacters.
Table 3-10
Character Sets with Customer-Defined
Characters

Character Set ID

Number of
Characters

Designator

Customergraphics2(Arabic)

64

Chinese1

64

Chinese2

64

Doublesizecharactergraphics
(Arabic)

64

Twocharactersetscanbeactiveatanyonetime.Normally
charactersaredisplayedfromtheprimarycharacterset,but
individualcharacterscanbedisplayedfromthesecondarysetusing
theVTcontrol.
Forthedefaultcharactersetsprovidedoncardholderscreens,and
printers,seeAppendix B,CharacterSets.

OperatorInterfaceDisplay
Characters

Theenhancedoperatorinterfacecandisplayanycharacter
containedinthefollowingcharacterset:

Table 3-11
Enhanced Operator Interface: Character
Set

Character Set ID

Number of
Characters

Designator

Singlesizealphanumeric1

96

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-15

Screen Data
Formatting Rules for Cardholder Display Screens

ControlCharacters
Table 3-12
Cardholder Screen: Control Character
Functions

Thefunctionofeachcontrolcharacterforcardholderscreenactivity
isdefinedinthefollowingtable:
Character

ASCII Hex
Code

FF

0C

Clearsthescreenandpositionsthecursorinthe
toplefthandcornerofthescreen.Setsblinkingto
offandresetsforegroundandbackground
colourstotheirdefaults.NCRrecommendsyou
usetheFF(formfeed)controlcharacteratthe
startofthescreenfollowinganidlescreen.This
ensurestheidlesequenceisstoppedbeforethe
nextscreenisdisplayed.

SO

0E

Insertsthescreencalledbythenext3,5or6
characters.Screenscanbenestedto5levels
usingSO.

Function

Note:Ascreennumberspecifiedas3decimal
digitsisalanguageindependentscreennumber
unlessthegroupsizeis1000orgreater,inwhich
casethescreenisadjustedforlanguage.
Ascreennumberspecifiedas4decimaldigits
prefixedbyu(u1234)oras4decimaldigitsin
doublequotes(1234)isalanguageindependent
screennumber.
Ascreennumberspecifiedas4decimaldigits
prefixedbyl(l0234)isalanguagedependent
screennumberandisadjustedforlanguage.
Ifthelanguageadjustedscreenhasnotbeen
loaded,thentheunadjustedscreenwillbeused
instead.Thisenableslogosandpicturestobe
definedjustonceinthebaselanguage.
SI

0F

Setsthecursortothepositionindicatedbythe
nexttwocharacters(rowselectedfirst,column
selectedsecond).Displaydataremains
unchanged.
Thefollowingcharactersareusedtodefinerows
onthecardholderscreen:
@,A,B,C,D,E,F,G,H,I,J,K,L,M,N,O
where@isthetoprowandOisthebottom
row.
Thefollowingcharactersareusedtodefine
columnsonthecardholderscreen:
@,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,:,;,<,=,>,?

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-16

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Character

ASCII Hex
Code

Function

where@isthelefthandcolumnand?isthe
righthandcolumn.Foradiagramshowingthe
cardholderscreenlayoutandFDKalignment,see
Cardholder/EOPScreenLayoutonpage 32.
ForadiagramshowingtheTouchScreenFDK
Emulationarea,seetheFDKEmulationsection
inChapter 4,KeyboardDataandLayouts.
Thecursorpositionisautomaticallyresetto
column@,row@attheendoftheoutermost
screenorafteranidlescreendelaycontrol
sequence.
HT

09

CausesthenameencodedonTrack1ofthecard
tobedisplayed,startingatthecurrentcursor
position(32charactersmaximum).BothISOand
VISAdisplayformatsaresupported.

DC1

11

Enablevideo.Showsthescreendisplay.

DC2

12

Disablevideo.Thiscommandinhibitsthescreen
displaysothatthecardholderdoesnotseethe
displaybeingbuiltonscreen.NCRrecommends
thatyousendadisablevideoasthefirstcontrol
characterinthescreen,andanenablevideoas
thelastcontrolcharacterinthescreen.

ESC

1B

Controlcharacterwhichintroduces
supplementarycontrolcodesforthefollowing
features:
Voice
Screenblinkingandcolourcontrol
Changingdisplayinidle
Selectcharacterset
Leftmargincontrol
Logocontrol
Picturecontrol
Setdisplaymodecontrol
Displayimagefilescontrol
Liftchequeimagecontrol
Animation
Fordetails,seeControlCodesforSpecial
Featuresonpage 320.

CR

0D

Causesthecursortobemovedtothecharacter
positionspecifiedbythecurrentlefthandmargin
onthefollowingline.

VT

0B

Causesthenextcharactertobedisplayedfromthe
secondarycharacterset.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-17

Screen Data
Formatting Rules for Cardholder Display Screens

Note:Useofthefullrangeofcontrolcharactersinreservedscreens
isrestricted.OnlyreservedscreensingroupYmaycontainanyof
theabovecontrolcharacters.Allotherreservedscreengroupsare
limitedtousingSO(OEhex)andCR(ODhex).

Track1NameDisplay

Fordisplaypurposes,Track1mustcontainthefollowingdata,in
oneoftwoformats:

Table 3-13
Track 1 Data Formats

Format A

Format B

StartSentinel=%

StartSentinel=%

FormatCode=A

FormatCode=B

Surname

AccountNumber(optionalupto
19characters)

SurnameSeparator=/

FieldSeparator=^

FirstNameandTitle

CountryCode(optional)

FieldSeparator=^

Surname

DiscretionaryData(optional)

SurnameSeparator=/

EndSentinel=?

FirstnameandTitle

LRC

FieldSeparator=^

TOTAL:Maximum79chars.

DiscretionaryData(optional)
EndSentinel=?
LRC
TOTAL:Maximum79chars.

Allthecontrolcharactersdefinedabovearemandatoryandmustbe
encodedwhetherornotallthefieldsareused.
Thecombinedlengthofthesurname,firstnameandtitle(excluding
trailingspacesandsurnameseparator)mustbebetween1and25
characters.Ifitexceedsthis,thenamefieldisignored.
Fouroptionsareprovidedtocontroltheextractionofthefirstname
andtitlefields:

ISO
VISA
AutoSelectBackwardsSearch
AutoSelectForwardsSearch.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-18

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

ISOFormatCards

Theseparatorbetweenthefirstnameandtitleisaspace.Thisoption
usesabackwardsearchfortheseparator.

(firstname,spacesallowed)(space)(titlewithnospace)(space)
(firstname,spacesallowed)(space)(titlewithnospaces)
(firstname,spacesallowed)(twoormorespaces)
(space)(titlewithnospaces)(space)
(firstnamewithnospaces)
(firstnamewithnospaces)(oneormorespaces).

VISAFormatCards

Theseparatorisafullstop.Thisoptionusesabackwardsearchfor
theseparator.

(firstname,fullstopsallowed)(fullstop)(titlewithnofull
stops)
(firstname,fullstopsallowed)(fullstop)
(fullstop)(titlewithnofullstops)
(firstnamewithnofullstops).

AutoSelectBackwardsSearch

ThisoptionselectsbetweenISOandVISAautomatically,butplaces
restrictionsonthepermittedformats.

(firstname,spacesallowed)(space)(titlewithnospaces)(space)
(firstname,spacesallowed)(twoormorespaces)
(space)(titlewithnospaces)(space)
(firstnamewithnospaces)(oneormorespaces)
(firstnamewithfullstopsallowed)(fullstop)(titlewithnofull
stops)
(firstname,fullstopsallowed)(fullstop)
(fullstop)(titlewithnofullstops)
(firstnamewithnofullstops)
(namewithspaces).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-19

Screen Data
Formatting Rules for Cardholder Display Screens

AutoSelectForwardsSearch

ThisoptionselectsbetweenISOandVISAautomatically,butplaces
restrictionsonthepermittedformats.

(firstnamewithnospaces)(space)(title,spacesallowed)(space)
(space)(title,spacesallowed)(oneormorespaces)
(firstnamewithnospaces)(oneormorespaces)
(firstnamewithnofullstops)(fullstop)(title,fullstops
allowed)
(firstnamewithnofullstops)(fullstop)
(fullstop)(title,fullstopsallowed)
(firstnamewithnofullstops)
(namewithspaces).

ABAFormatCards

ThesearethesameasVISAformat,withanoptionalthreedigit
countrycodeimmediatelybeforethesurname.Thiscodeisnot
displayed.

NameDisplay

Whenthenamedisplayisinvokedatthecurrentcursorpositionby
theHTscreencontrolcharacter,aspaceisinsertedbetweenthe
fields.Thenamedisplayisthesameforbothformats:
TITLEbFIRSTNAMEbSURNAME
TITLEbSURNAME
FIRSTNAMEbSURNAME
SURNAME
whereb=space
Note:Ifaninvalidcontrolsequenceisincludedinascreen,a]
characterisdisplayed.

ControlCodesforSpecial
Features
Table 3-14
Screen Display Special Features

ThefollowingfeaturescanbeaccessedbyusingtheESCcharacter
andsupplementarycontrolcodes:
3

Feature

Introducer

Identifier

Voice

ESCP

Screenblinkingandcolourcontrol

ESC[

Changingdisplayinidle

ESC[

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-20

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens
Feature

Introducer

Identifier

Selectprimarycharacterset

ESC(

Selectsecondarycharacterset

ESC)

Leftmargincontrol

ESC[

Logocontrol

ESCP

Picturecontrol

ESCP

Setdisplaymodecontrol

ESCP

Displayimagefilescontrol

ESCP

Liftchequeimagecontrol

ESCP

Bunchchequeimagedisplaycontrol

ESCP

Bunchchequecodelinedisplaycontrol

ESCP

Bunchchequeamountdisplaycontrol

ESCP

Bunchchequevaluedisplaycontrol

ESCP

DisplayDynamictextdictionary

ESCP

Dynamicbuttoncontrol

ESCb

Dynamictextdefinitioncontrol

ESCq

Animation(mayusepicturecontrolor
displayimagefilescontrol)
MPEG(mayusepicturecontrolordisplay
imagefilescontrol)

Voice

Ifdigitalaudiohardwareisinstalled,theSSTcanprovidethree
typesofspokenmessages:

Autovoiceprerecordedmessagesplayedatpredefinedtimes
Audiocontrolsembeddedinscreenstoplayprerecorded
messages
Fullvoiceguidance.

Note:Ifavoiceguidedsessionisactive,thefirsttwotypesarenot
playedduringthevoiceguidedsession.

PrerecordedMessages

Makesurethattheprerecordedmessageisbriefenoughtoplay
completelybeforethestateistimedout.Theterminalattemptsto
playmessagesatthefollowingtimes:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-21

Screen Data
Formatting Rules for Cardholder Display Screens

PINEntry(Message7) ThemessagestartsduringaPINEntry
stateorEnhancedPINEntrystatewhenthecardhasbeenreadand
recognised.IfaCardReadPINEntryInitiationstateisused,the
messagestartsassoonasthecardisdetectedbytheterminal.

TransactionRequest(Message1) Themessagestartswhena
TransactionRequestmessageissenttoCentral.
CardTaken(Message8) Themessagestartsassoonasacardis
takenintheClosestate.Ifthecardhasalreadybeentaken,the
messagestartsonentrytotheClosestate.
DigitalAudioControlinScreenDisplay Audiocontrol
sequencescanbeincludedinscreendatatoplayanyoneofupto
999audiomessages.Theformatofanaudiocontrolsequenceisas
follows:
Table 3-15
Digital Audio Control in Screen Display

Character

Description

Number of
Bytes

ESCP

Devicecontrolstringintroducer

ControlstringID

Variable

Messagenumber,range00999

Var(23)

Separator

Parameter
flag

Numberofmessagestobeplayed(03)
Thisparameterisincludedformigration
purposesonlyandisignored.Onlyone
messagecanbeplayedforeachvoice
controlsequence.

ESC\

Stringterminator

Theautovoicemessagesoccur,evenifadditionalmessagesare
invoked,unlesstheautovoicefeatureisdisabledbyanEnhanced
ConfigurationParametersLoadmessage.Fordetails,seeEnhanced
ConfigurationParametersLoadonpage 1016.
Thefollowingtenmessagesaresuppliedasdefaults:
0

Weregretthattheterminalsservicesarenotavailable.

Pleasewaitwhileyourtransactionisprocessing.

Entertheamountwhenyouareready.

Yourcardandreceiptarereadyforremoval.

Pleaseselecttheservicerequiredandtheaccounttobecharged.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-22

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Pleasetakeyourcash.

Welcome.Pleaseenteryoursecretnumber.

Thankyouforbankingwithus.

Pleasetakeanenvelopefromthedispenserandplaceyour
depositinside.Thenentertheamountwhenready.Placethe
sealedenvelopeintheslot,whereitwillbecheckedand
creditedtoyouraccount.

12 Tone.
Note:Messages5,10,11and13998arenotprovided.Message999
isinterpretedasastopcommand.

DigitalAudioControlforVoiceGuidance

AudiodatacanbeincludedinfieldnoftheTransactionReply
message.ThereferencedscreenmusthaveanAudioelementwith
PlaceholdersubelementsdefinedinthevoiceguidanceXML
configurationfile.IfthePlaceholdersubelementsarenotdefined,
thedynamicaudiodataisignored.FordetailsoftheTransaction
Replymessage,seeTransactionReplyCommandonpage 1049.
FordetailsoftheXMLconfigurationfileforvoiceguidance,referto
theAPTRAAdvanceNDC,DevelopersGuide.
ExamplesofaudiodatasentinTransactionReplymessagesare
givenonpage 324topage 326.
Digitalaudioforvoiceguidanceisinvokedbythefollowingcontrol
sequence:
Table 3-16
Digital Audio Control for Voice Guidance

Character

Description

Number of
Characters

ESCP

Devicecontrolstringintroducer

ControlstringID

Variable

Messagenumber,range00999
SeeTableNote1

Var(23)

Separator

Parameter
flag

Adigitifparametersfollow(forexample,
1)

Separator
SeeTableNote2

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-23

Screen Data
Formatting Rules for Cardholder Display Screens
Number of
Characters

Character

Description

Voice
guidance
variable

Audioplaceholderdatawithafixedor
dynamicformat
SeeTableNote2,TableNote3,TableNote
4andTableNote5

ESC\

Stringterminator

TableNote1:Thisparameterisincludedforcompatibility,butis
ignoredasthescreennumberisusedtoidentifytheAudioelement
inthevoiceguidanceconfigurationXMLfile.
TableNote2:Theseparametersmustberepeatedasrequiredto
identifytheaudiodata.
TableNote3:Thisparametermustnotcontainasemicolon(;)as
placeholdersareseparatedbysemicolons.NestedAudioIDshave
onlyoneplaceholder.
TableNote4Fixedformathasnospecialformattingrequirements
otherthanthatspecifiedinTableNote3.
Dynamicformatcontainsareferencetoanaudioelementalong
withtexttobeusedasaplaceholderwithinthereferencedaudio
element.Theformatisasfollows:
<SO><Audio element ID><Placeholder data>

Thisisparsedasfollows:
<SO>

Theshiftoutcharacter(0x0E)

<AudioelementID>

Anaudioelementenclosedindoublequotation
marks,forexample,1234orWelcome.Ifthe
audioelementisnumeric,thelanguagescreenoffset
willbeappliedtotheaudioelementidentifier

<Placeholderdata>

Atextfragmenttoreplaceanyplaceholdermarker
inthereferencedaudioelement.

TableNote5Referencestoaudioelementscanonlybespecifiedat
thestartofthevoiceguidancevariable.
Example1:ScreenUpdateinaTransactionReplywithFixed
Data

Thismessageupdatesscreen129,whichisthedisplayscreenfor
Closestate027.Thescreenandcontrolsequenceareshowninbold.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-24

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Theupdatedataforscreen129couldincludeuptothree
placeholderdatafieldsandeachwouldbespokeninturn.
TheTransactionReplyisasfollows:
4<fs><fs><fs>027<fs><fs>12345037129<FF><ESC>P0000;1;HAPPY
HOLIDAYS!<ESC>\<si>FKTHANK YOU!!!<fs>003ADVANCE NDC VG NEXT
STATE AND PRINT<lf>EXAMPLE 1<lf>UPDATE WITH ONE<lf>PLACEHOLDER

AudioID129canbedefinedasthefollowing:
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
Thank you for banking with us.
<PlaceHolder/> <PlaceHolder/> <PlaceHolder/> </Text> </Audio>

Alternatively,itcanbedefinedusinganaudiofile,asfollows:
<!-- file 0129.wav has recorded voice of the text
"Thank you for banking with us." -->
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
<Recording file="0129.wav" state="private"/> <PlaceHolder/>
<PlaceHolder/> <PlaceHolder/> </Text> </Audio>

TheoutcomeisthatduringtheClosestate,screen129isdisplayed
withthefollowingspokentext:
Thank you for banking with us. HAPPY HOLIDAYS!

Example2:UsingaNestedScreenwithFixedPlaceholderData

Screen129issentfromthehostandincludesacalltonestedscreen
135,asfollows:
<ff><si>FKTHANK YOU!!!<so>135

AudioID129andAudioID135aredefinedasfollows:
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
Thank you for banking with us. </Text></Audio>
<Audio audioID="0135" groupID="0000" repetitions="0">
<Text lang="en" state="private"> <PlaceHolder/> <PlaceHolder/>
<PlaceHolder/> </Text> </Audio>

Alternatively,theycanbedefinedusinganaudiofile,asfollows:
<!-- file 0129.wav has recorded voice of the text "Thank you
for banking with us." -->
<Audio audioID="0129" groupID="0000" repetitions="0">
<Text lang="en" state="private">
<Recording file="0129.wav" state="private"/> </Text> </Audio>
<Audio audioID="0135" groupID="0000" repetitions="0">
<Text lang="en" state="private"> <PlaceHolder/> <PlaceHolder/>
<PlaceHolder/> </Text> </Audio>

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-25

Screen Data
Formatting Rules for Cardholder Display Screens

TheTransactionReplyisasfollows,withscreenandcontrol
sequenceshowninbold:
4<fs><fs><fs>027<fs><fs>12345037135<esc>P0000;1;Ask about our
loan rates.; Special deals on offer this month.
<esc>\<fs>003ADVANCE NDC VG NEXT STATE AND PRINT<lf>EXAMPLE
2<lf>UPDATE WITH TWO<lf>PLACEHOLDERS

TheoutcomeisthatduringtheClosestate,screen129isdisplayed
withnestedscreen135andthefollowingspokentext:
Thank you for banking with us.
Ask about our loan rates.
Special deals on offer this month.

Inthisexampletheupdatedataforscreen135hastwoplaceholder
datafieldsspokeninturn;butitcouldhavethree.
Example3:UsingDynamicPlaceholderData

Screen1233containsthefollowingescapesequence:
<esc>P0;1;Welcome;<so>"1234"MasterCard;<so>"1235"VISA;
Remember you can top up your mobile phone here.<esc>\

AudioIDsaredefinedasfollows:
<Audio audioId="1233"> // audio associated with base screen
<Text>Hello <PlaceHolder/>. Please select the application.
<PlaceHolder/> <PlaceHolder/> <PlaceHolder/> </Text> </Audio>
<Audio audioID="1234">
<Text>For <PlaceHolder/> Please press 1. </Text> </Audio>
<Audio audioId="1235">
<Text>for <PlaceHolder/> Please press 2. </Text> </Audio>

Whenscreen1233isdisplayed,thespokentextwillbeconstructed
byAdvanceNDCasfollows:
Welcome. Please select the application.
For MasterCard please press 1.
For VISA please press 2.
Remember you can top up your mobile phone here.

GuidelinesforUsingMultipleScreenswithDigitalAudio
Ifyouhavetwoormoredigitalaudiomessagesinthesamescreen,
onlythelastoneisplayed.Ifasecondscreenisdisplayedbeforethe
digitalaudiomessageplayingonthefirstscreenhasfinished,oneof
thefollowingoccurs:
3

Ifthesecondscreendoesnotcontainanydigitalaudiomessages,
thefirstmessagecontinuestoplaywhilethesecondscreenis
displayed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-26

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Ifthesecondscreendoescontainadigitalaudiomessage,the
firstmessageisstoppedandthesecondmessagebeginstoplay.

Thefunctionthatextractsandplaysaudiomessagesdoessoby
startingwiththebasescreenandtraversingthroughallnested
screens,playinganyassociatedaudiomessagesforthebasescreen
andallnestedscreensintheordertheyareencountered.Playing
audiomessagesisdonebyprogressingthebasescreennumber,
alongwithallnestedscreennumbers,astheaudioidentifiers,plus
anyassociatedparameters,tospeakthecompleteaudiomessage.
Itispossibleforautomaticmessagestointerferewithdigitalaudio
messagesdefinedinotherscreens.Ifamessageisplayinginone
screenandtheapplicationmovestoastatewhereanautomatic
messageistobeplayed,thefirstmessageisstoppedandthe
automaticmessageisplayed.Youcanavoidthissituationby
disablingtheautomaticvoicefeature.SeeChapter 7,Enhanced
ConfigurationParametersLoadMessagefordetails.

ScreenBlinkingandColourControl

Youcancontroltheblinkingofdataandchangethecolourofdata
displayedonthescreenwiththefollowingcontrolsequence.This
sequenceisignoredbytheenhancedoperatorinterface.
Note:Blinkingtextonatransparentbackgroundisnotsupported
inAdvanceNDC.
Table 3-17
Screen Blinking and Colour Control

Character

Description

Number of
Characters

ESC[

ControlSequenceIntroducer

Variable

Screenblinkingandcolourcontrolcommands

Fieldseparator

Thevariablefield,separatedbyfield
separators,canberepeateduptothreetimes.
Thereshouldnotbeafieldseparatorafterthe
lastparameter.
m

Functiondefiningcharacter

Thevariablefieldismadeupfromthefollowingcommands:
BlinkingCommands
Table 3-18
Blinking Commands

Resetscolourstodefaultsandblinkingoff

00

Setblinkingon

10

Setblinkingoff

11

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-27

Screen Data
Formatting Rules for Cardholder Display Screens

ForegroundColourControlCommands
Table 3-19
Foreground Colour Commands

Intensity
Low

High

BlackForeground

20

B0

RedForeground

21

B1

GreenForeground

B2

22

YellowForeground

B3

23

BlueForeground

24

B4

MagentaForeground

25

B5

CyanForeground

26

B6

WhiteForeground

B7

27

Theseforeground(text)andbackgroundcolourcommandscanalso
beusedwiththeWindowsdisplaysettoHighColor(16bit)or
above.
BackgroundColourControlCommands
Table 3-20
Background Colour Commands

Intensity
Low

High

BlackBackground

30

C0

RedBackground

31

C1

GreenBackground

C2

32

YellowBackground

C3

33

BlueBackground

34

C4

MagentaBackground

35

C5

CyanBackground

36

C6

WhiteBackground

C7

37

Transparentbackground(onecodeonly)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-28

APTRA Advance NDC, Reference Manual

80

Screen Data
Formatting Rules for Cardholder Display Screens

DefaultForegroundColourControlCommands
Table 3-21
Default Foreground Colour Commands

Intensity
Low

High

BlackDefaultForeground

60

F0

RedDefaultForeground

61

F1

GreenDefaultForeground

F2

62

YellowDefaultForeground

F3

63

BlueDefaultForeground

64

F4

MagentaDefaultForeground

65

F5

CyanDefaultForeground

66

F6

WhiteDefaultForeground

F7

67

DefaultBackgroundColourControlCommands
Table 3-22
Default Background Colour Commands

Intensity
Low

High

BlackDefaultBackground

70

G0

RedDefaultBackground

71

G1

GreenDefaultBackground

G2

72

YellowDefaultBackground

G3

73

BlueDefaultBackground

74

G4

MagentaDefaultBackground

75

G5

CyanDefaultBackground

76

G6

WhiteDefaultBackground

G7

77

WhenaBlinkingOncontrolsequenceappearsinthescreendata,
anydisplaycharactersthatfollowareblinkeduntilaBlinkingOff
controlsequenceorthedatadelimiterattheendoftheoutermost
screenisreached,oranidlescreendelaysequenceoccurs.Graphics
arenotblinked,unlesstheyarecharacterbasedlogos.
Thecolourchangecommandswillhaveaneffectonthelevelsof
greydisplayedonamonochromescreen.
Note:Tosetupdefaultforegroundandbackgroundcoloursfora
screen,thecontrolsequenceshouldbeplacedbeforetheclearscreen
controlcharacter.Theresetattributescommandwillcausethe
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-29

Screen Data
Formatting Rules for Cardholder Display Screens

defaultforegroundandbackgroundcolourstobereplacedbythose
definedinresrvd.def.Asattributesarereseteachtimeanewscreen
numberistobedisplayed,youshouldensurethattherequired
defaultsettingsareappliedeachtimeanewscreenistobe
displayed.

ChangingDisplayDuringtheIdleLoop

Itispossibletohaveachangingscreendisplayonthecardholder
screenwhiletheterminalisidle,waitingforcardentry.Inthis
situation,theterminalcyclesthroughthespecifieddisplay
sequence.Ifadelaycontrolsequenceoccursattheendoftheidle
screen,theloopisrepeatedindefinitelyuntilacardisentered.
Youcanusethisfeatureonthecardholderscreenforadvertising,
preventingscreenburninorwhentheterminalisinOutofService,
OffLine,Supervisor(whencontrolisattherear)orSuspendmode.
Thefeatureisinvokedbythefollowingcontrolsequence,whichis
includedintheidlescreenreferencedfromtheCardReadstate:
Table 3-23
Change Display While Idle

Character

Description

Number of
Characters

ESC[

ControlSequenceIntroducer

Variable

DelayTimein100millisecondintervals
(000999)

Functiondefiningcharacter

Ifthiscontrolsequenceappearsanywhereotherthanintheidle
screen,itisignored.Forexample,idlescreensinOutofService
modemustbedefinedforreservedscreenC02,notthedefault
displayscreen002.Nestedscreenscanbeinvokedfromtheidle
screentoincreasetheamountofdatathatcanbedisplayedduring
theidlesequence.
Forexample,userdefinedscreens20and21willbedisplayed
alternatelyfor10and15secondsifthefollowingidlescreenis
defined:
S0 020 ESC [100z S0 021 ESC [150z

Anidlescreendelaysequenceresetsthefollowingscreencontrols:

Cursorpositionresetto@@
Blinkcontroloff
Charactersetsinglesizealpha
Leftmarginsettoleftmostcolumn

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-30

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Foregroundandbackgroundcoloursareresettotheirdefaultsas
definedinresrvd.def.
IfyouareusingrotatingidlescreensequencesforOutofServiceor
Supervisorscreens,NCRrecommendsthatyousendascreen
downloadcontainingthefollowinginformation:

Anonrotatingidlescreenatthestartofthedownload
Anynestedscreensthataretobeusedintheidlesequence
AtoplevelOutofService/Supervisorscreenattheendofthe
download.

Ifyoudonotfollowtheseguidelines,youmayfindthattheidle
sequencejumpstoitsopeningscreeneachtimeascreendownload
messageissent.

SelectPrimaryCharacterSet

ASCIIcodesintherange207Fhexinvokedisplaycharactersfrom
thesinglesizealphanumeric1characterset.Charactersfrom
additionalcharactersetsincludinggraphicscanbeinvokedbythe
followingcontrolsequence:
Table 3-24
Select Primary Character Set

Character

Description

Number of
Characters

ESC(

ControlSequenceIntroducer

Variable

CharacterSetDesignator

WhenaSelectPrimaryCharacterSetcontrolsequenceappearsin
thescreendata,theprimarydisplaycharactersthatfolloware
invokedusingthespecifiedcharacterset,untilthedatadelimiterat
theendoftheoutermostscreenisreached,oruntilanidlescreen
delaysequenceoccurs.Ifthishappens,thecharactersetdefaultsto
singlesizealphanumeric1untilanotherSelectPrimaryCharacter
Setcontrolsequenceappears.

SelectSecondaryCharacterSet

ASCIIcodesintherange207Fhex,precededbyaVTcharacter,
invokedisplaycharactersfromthecustomergraphics1character
set.Charactersfromadditionalcharactersetscanbeinvokedforthe
screenbythefollowingcontrolsequence:
Table 3-25
Select Secondary Character Set

Character

Description

Number of
Characters

ESC)

ControlSequenceIntroducer

Variable

CharacterSetDesignator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-31

Screen Data
Formatting Rules for Cardholder Display Screens

WhenaSelectSecondaryCharacterSetcontrolsequenceappearsin
thescreendata,thesecondarydisplaycharactersthatfolloware
invokedusingthespecifiedcharacterset,untilthedatadelimiterat
theendoftheoutermostscreenisreached,oruntilanidlescreen
delaysequenceoccurs.Ifthishappens,thecharactersetdefaultsto
customergraphics1untilanotherSelectSecondaryCharacterSet
controlsequenceappears,unlessscreenM15hasbeenchanged.
Note:Customergraphics1isnotsupportedbythebasicor
enhancedoperatorinterfaces.

LeftMarginControl

ThecolumnpositionofthecursorfollowingaCRcontrolcharacter
canbesetbyusingthefollowingcontrolsequence.Thedefaultis
column00.
Table 3-26
Set Left Margin Position

Character

Description

Number of
Characters

ESC[

ControlSequenceIntroducer

Variable

ColumnNumber(0031)

Functiondefiningcharacter

WhenaLeftMargincontrolsequenceappearsinthescreendata,all
subsequentCRcontrolcharacterswillreturnthecursortothe
columnspecified,untileitherthedatadelimiterattheendofthe
outermostscreenisreachedoruntilanidlescreendisplaysequence
occurs.Theleftmargincontrolwillthendefaulttocolumn00.

SetDisplayModeControl
AdvanceNDCsupportsdisplaymodesof640by480andabove.If
theSetDisplayModecontrolissent,itisignoredasscreen
resolutioncannotbechangedatruntime.Formoreinformation
aboutdisplayresolutionrefertotheAPTRAAdvanceNDC,
DevelopersGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-32

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

LogoControl

Thiscommandisusedforthecardholderscreentodisplayoneof
100logosstoredonthesystemdisk.
Table 3-27
Select Logo

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

Parameter

Thelogonumbertobedisplayedintherange
0099.

ESC\

StringTerminator

Alogoisthesameasapicture.Logosaredisplayedfromthecurrent
cursorposition.Afterdisplayingthelogo,thecursorisatthesame
columnpositionasthestartofthelogo.Therowpositionwillbethe
nextfreelineafterthelogo.
Thelogoisdisplayed,butwillbeclippedifthedifferencebetween
thecurrentrowpositionandthemaximumrowposition(15)isless
thanthelogolength,orifthedifferencebetweenthecurrentcolumn
positionandthemaximumcolumnposition(31)islessthanthe
widthofthelogo.
Ifthelogofilesarelarge,thecapacityofthesystemdiskmaybe
reachedbeforethelimitof100logos.

PictureControl

Thiscommandisusedforthecardholderscreentodisplayoneof
1000picturesstoredonthesystemdisk.
Thesixpredefinedleadthroughpictures(pic00<n>.pcx)are
numbered000,001,003to006,andarealsodisplayedby
reservedgraphicsscreensG00G01,G03G06.Thepredefined
picturesarestoredinC:\ProgramFiles\NCRAPTRA\Advance
NDC\MediaontheSST.ScreenG02isnotusedandscreensG07
G09arereserved.
Note:Variousgraphicformatsaresupported,includingPCX,
JPEG,GIF,TIFF,andJIFF.NCRrecommendsthatanuncompressed
bitmapformat,forexampleBMPorPCX,isusedifdisplay
performanceiscritical.Theuseofhighlycompressedformats,such
asJPEGmayresultindegradationofthedisplayperformance.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-33

Screen Data
Formatting Rules for Cardholder Display Screens

Picturescanbedisplayedwiththefollowingcontrolstring:
Table 3-28
Picture Control Command

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

parameter

Thepicturenumbertobedisplayed.Range
0999.

Var(13)

ESC\

StringTerminator

Picturesaredisplayedfromthecurrentrowposition.Thepictureis
displayed,butwillbeclippedifthedifferencebetweenthecurrent
rowpositionandthemaximumrowposition(15)islessthanthe
picturelength,orifthedifferencebetweenthecurrentcolumn
positionandthemaximumcolumnposition(31)islessthanthe
widthofthepicture.
Ifthepicturefilesarelarge,thecapacityofthesystemdiskmaybe
reachedbeforethelimitof1000pictures.

DisplayImageFilesControl

Thiscontrolcodeallowsyoutodisplaypicturesonthescreen,using
thefollowingcontrolstring
Table 3-29
Display Image File Command

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

parameter

Thenameoftheimagefiletobedisplayed

Var

ESC\

StringTerminator

ThefilenameisanASCIIstringcontainingthefilenameand
optionallythepathoftheimagefile.ThedefaultpathisC:\Program
Files\NCRAPTRA\AdvanceNDC\Media.
Note:WhenanAVIfileisdefinedinadownload,AdvanceNDC
expectsthefilenametocontainnomorethaneightcharacters
(<xxxxxxxx>.avi).Ifalongernameisused,anythingaftertheeighth
characterisignored.
Whenascreencontainingthiscontrolsequenceisdisplayed,the
imageisdrawnstartingfromthecurrentcursorposition.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-34

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

LiftChequeImageControl

Thiscontrolcodeallowsyoutodisplayaliftedchequeimageonthe
screen,usingthefollowingcontrolstring:
Table 3-30
Display Lifted Cheque Image Command

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

(x,y)

x=WidthScaling
y=HeightScaling
aspercentagesoftotalwidth/height

Var

ImagePath

Pathtodirectorywhereimageisstored.
Mustbethesamedirectoryasspecified
whenthechequeprocessorwasconfigured.

Var

SeparatesImagePathandFilename

Filename

NameofImageFiletobedisplayed

Var

ESC\

StringTerminator

ThefilenameisanASCIIstringcontainingthefilenameofthe
chequeimagefile;forexample,cheque.bmp.
Whenascreencontainingthiscontrolsequenceisdisplayed,the
chequeimageisdrawnstartingfromthecurrentcursorposition.A
halfinchblackstripeisdrawnatthebottomofthechequetomask
thecodeline.

BunchChequeImageDisplayControl

Thisdisplaysthefollowingasrequiredduringbunchcheque
acceptance:
Aspecificimageforaspecificcheque
AselectedimagefromtheavailablelistduringtheCheque
SummaryDisplaystate.Fordetails,seez004DisplayCheque
SummaryStateonpage 2130

Table 3-31
Bunch Cheque Image Display Control

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

Side

Thesideofthechequetodisplayasfollows:
0thefront
1theback

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-35

Screen Data
Formatting Rules for Cardholder Display Screens

Character

Description

Number of
Characters

Separator

Definesthescalingusedforthewidthofthe
imageasapercentageofthedisplaywidth

Var

Separator

Definesthescalingusedfortheheightofthe
imageasapercentageofthedisplayheight

Var

Textterminator

Image
selector

Identifieswhichofthemultipleimagesofa
chequetodisplayusinganindexfromthe
listofimagesrequestedforeachcheque

Separator

ChequeID

Specifiesthechequetodisplay
Ifthisissetto000,thestatedisplayingthe
imageselectsthechequebasedonan
internalchequedisplayindex
ThisIDistheidentifierassignedtothe
chequebythebunchchequeacceptorandis
alsousedinthefollowingmessagefields:

Bunchchequedepositfields,DataIDg,
intheTransactionRequestmessage

Chequefields,BufferIdentifierb,in
theTransactionReply
SeeTableNote6

ESC\

StringTerminator

TableNote6:Asabunchchequeacceptorcanholdmorecheques
thancanbelistedonasinglescreen,thecardholdercannavigate
betweenscreenscontainingsubsetsoftheavailablecheques.Ifthis
occurs,onlythestatedisplayingthechequescanidentifywhich
chequeiscurrentlydisplayedandtheChequeIDparameterissetto
zero.
Whenascreencontainingthiscontrolsequenceisdisplayed,the
chequeimageisdrawnstartingfromthecurrentcursorposition.A
halfinchblackstripeisdrawnatthebottomofthechequetomask
thecodeline.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-36

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

BunchChequeCodelineDisplayControl

Thisdisplaysthecodelineforachequeduringbunchcheque
acceptance.
Note:Ifyouarecomplyingwiththepaymentcardindustry(PCI)
guidelines,youmustnotusethiscontrolsequence.
Table 3-32
Bunch Cheque Codeline Display Control

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

ChequeID

Specifiesthechequetodisplay
Ifthisissetto000,thestatedisplayingthe
imageselectsthechequebasedonan
internalchequedisplayindex
SeeTableNote6

ESC\

StringTerminator

BunchChequeAmountDisplayControl

Thisdisplaystheamountforachequeduringbunchcheque
acceptance.
Table 3-33
Bunch Cheque Amount Display Control

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

ChequeID

Specifiesthechequetodisplay
Ifthisissetto000,thestatedisplayingthe
imageselectsthechequebasedonan
internalchequedisplayindex
SeeTableNote6

Separator

Amount
screen

Selectsthescreenusedtodefinethedisplay
oftheamount

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-37

Screen Data
Formatting Rules for Cardholder Display Screens

Character

Description

Number of
Characters

Separator

Amount
selector

SpecifieswhethertodisplaytheCourtesy
AmountRecognition/LegalAmount
Recognition(CAR/LAR)derivedamountor
theamountenteredbythecardholder,as
follows:
0displaythederivedamount
1displaytheamountenteredbythe
cardholder
2displaythederivedamount,unlessthis
hasbeenamendedbythecardholderwhen
theamendedamountisdisplayed

ESC\

StringTerminator

BunchChequeValueDisplayControl

ThisisusedtodisplayvaluesheldintheAdvanceNDCbuffers
duringbunchchequeacceptance.
Table 3-34
Bunch Cheque Value Display Control

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

Value
Selector

Specifiesthevaluetodisplay,asfollows:
000chequeindex
001totalnumberofchequesinserted
002totalnumberofchequesthathavebeen
addedtotheescrow
003reserved
004numberofchequestobereturnedto
thecardholder
005totalamountofthechequestobe
deposited.Thisisthesumoftheindividual
cheques
006contentsoftheAmountBuffer
007contentsofgeneralpurposebufferA
008contentsofgeneralpurposebufferB
009contentsofgeneralpurposebufferC
SeeTableNote6

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-38

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Character

Description

Number of
Characters

Separator

Value
format
screen

Selectstheoverlayscreenthatdefineshow
thevalueistobedisplayed
Ifthisissetto000,noformattingisapplied

ESC\

StringTerminator

DisplayDynamicTextDictionaryControlSequence

Thiscontrolsequencedefinesanddisplaysthetexttobeusedto
communicatedynamicconditionstothecardholder,forexample
thereasonforanerror.Thiscontrolsequenceassociatestextwithan
enumeratedvaluethatcanbedefinedfromadynamiccondition
withinastate.Thiscontrolsequenceisonlyusedinscreensthatare
displayedwithinstatetables.Thetextisspecifictothescreenin
whichthecontrolisdefined.
Forexample,thissequencecanbeusedtodefinethetexttoexplain
whychequeshavebeenrefusedduringtheBunchChequeAccept
state.Thestatedeterminesthereasons,convertsthereasonstoan
enumeratedvalue,andusestheenumeratedvaluetodeterminethe
requiredtext.
Thetextisdisplayedatthepositiononscreenwherethedictionary
isdefined.
Atruntime,ifastatedeterminesthatanenumeratedvaluedoesnot
existinthedictionary,thetextassociatedwithadefaultvalueis
used.Thestatedefinesthedefaultenumeratedvalueandwhetherit
ismandatory.Ifthedefaultenumeratedvalueismandatory,butnot
providedinthedownload,thedictionaryisignoredandisnotused.
Table 3-35
Display Dynamic Text Dictionary Control

Character

Description

Number of
Characters

ESCP

DeviceControlStringIntroducer

ControlStringID

Dictionary
ID

Dictionaryidentifier
Range000999
Themeaningisdefinedbythestateusing
thedataandthescopeislimitedtothe
screendefiningthedictionary,thereforethe
sameidentifiercanbeusedinmultiple
screenstorefertodifferentdictionaries

Separator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-39

Screen Data
Formatting Rules for Cardholder Display Screens

Description

Enumerated
valuelist0

Definesoneormoreenumeratedvaluesto
whichthetextfollowingthenextSeparator
relates
Thisparameterconsistsofoneormore
threecharacteralphanumericvalueswith
charactersintherange09andAZ.When
multiplevaluesareincludedeachvalueis
separatedbyacomma.Nocommais
requiredafterthelastentryinthelist
Fornumericvalues,forexampleerror
reasons,thevalueislimitedtoarangeof
000999
Fortextbasedvalues,forexamplecurrency
identifiers,alphabeticcharacterscanbeused

Var

Separator

Displaytext
0

Thetextassociatedwiththeprevious
enumeratedvalue.Thetextisenclosedin
doublequotationmarks(0x22).Ifa
quotationmarkistobeincluded,itmustbe
precededbyabackslash(0x5C)
Displayformattingmustbecontainedinthe
screenthatusesthedictionaryvalue.
Ifthedisplaycharacterisonlyavailablein
specificcharactersets,forexamplecurrency
symbols,thetextmustcontainthesequence
toensurethecorrectdisplayoftherequired
characters.Anymodifieddisplayattributes
mustbereset
SeeExampleDisplayTextonpage 341

Var

Textterminator

Enumerated
valuelist1

Definesoneormoreenumeratedvaluesto
whichthetextfollowingthenextSeparator
relates

Var

Separator

Displaytext
1

Thetextassociatedwiththeprevious
enumeratedvalue.

Var

Textterminator

Enumerated
valuelistn

Definesoneormoreenumeratedvaluesto
whichthetextfollowingthenextSeparator
relates
SeeTableNote7

Var

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-40

Number of
Characters

Character

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

Character

Description

Number of
Characters

Separator

Displaytext
n

Thetextassociatedwiththeprevious
enumeratedvalue
SeeTableNote7

Var

ESC\

StringTerminator

TableNote7:Enumeratedvaluesandrelateddisplaytextare
repeateduntilallrequiredvalueshavebeendefined.
ExampleDisplayText Displayformattingmustbecontainedin
thescreenthatusesthedictionaryvalue,asshowninthefollowing
examples:

TodisplayHELLO,enterthefollowing:
HELLO

TodisplayI said HELLO,enterthefollowing:


I said \HELLO\

TodisplayHELLO(andanysubsequenttext)inred,enterthe
following:
(ESC)[00;21mHELLO

Note:Inthedownloadedtext,(ESC)isreplacedby0x1B,and
theactualtextisasfollows:
0x22 0x1B 0x5B 0x30 0x30 0x3B
0x32 0x31 0x6D 0x48 0x46 0x4C
0x4C 0x4F 0x22

DynamicButtonControl

AdvanceNDCoffersthecapabilityofcreatingdynamicFDKmenu
systemsbyenablingordisablingabutton,dependingonadefined
setofconditionalexpressions.ThisallowsCentraltobuildamenu
systemaccuratelyreflectinganavailabletransactionsetor
applicationconfigurationwithouttakingtheSSToutofserviceto
updatethescreendata.
Note:DynamicbuttonsaresupportedforNDCformattedscreen
definitionsonly.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-41

Screen Data
Formatting Rules for Cardholder Display Screens

Thefollowingcontrolcodeisavailableforthedefinitionofabutton
withaconditionalexpressionparameterspecifyingtheconditions
thatmustbetrueforthebuttontobeenabled:
Table 3-36
Dynamic Button Definition

Character

Description

Number of
Characters

ESCPb

DeviceControlStringIntroducer

Fixed

FDKidentifier(F1F8)

Separator

Variable

Texttodisplayonthebutton

Var

Separator

Variable

Iconfilename

Var

Separator

Variable

Indextodynamiccontenthook

Var

Separator

Variable

Conditionalexpression
Ifnoneisspecified,thebuttonisalways
enabled

Var

ESC\

StringTerminator

Anexampleofthiscontrolisasfollows:
<ESC>PbF1;Cash Withdrawl;PICTURE1.PNG;002;TRUE<ESC>\

ThedynamiccontenthookisdefinedinDisplayManagerConfig.xml.
Fordetailsofthisfile,refertotheAPTRAAdvanceNDCDevelopers
Guide.

SyntaxofConditionalExpressions

Conditionalexpressionscanbesimpleorcomplex.Youcanquery
multipledevicesbyusinglogicalAND(&)andlogicalOR(|)with
DIGsandtheirsubcomponents.AlogicalANDspecifiesthatboth
devicesoneithersideoftheoperatormustbeavailable.Alogical
ORspecifiesthatoneofthedevicesoneithersideoftheoperator
mustbeavailable.Thesyntaxexamplesinthetableshowqueriesfor
thecashhandler(DIGE)anditscassettesandthereceiptprinter
(DIGG)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-42

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens
Table 3-37
Syntax of Conditional Expressions

Query

Type

Syntax

Tocheckwhethertwodevices
arebothavailable

Simple

E&G

Tocheckwhethereitherthecash
handlerorreceiptprinteris
available

Simple

E|G

Tocheckthatthecashhandleris
availablebutthereceiptprinter
isnotavailable

Simple

E&!G

Tocheckwhethercassettetype1
ANDcassettetype2are
availableORcassettetype3is
available

Complex

E001&E002|E003
or
(E001&E002)|E003

DynamicTextControl

AdvanceNDCoffersthecapabilityofcreatingdynamicscreentext
byenablingordisablingastring,dependingonadefinedsetof
conditionalexpressions.ThisallowsCentraltobuild,forexample,a
dynamicidlesequenceaccuratelyreflectingthesetofoperations
availableforatransactionwithouttakingtheSSToutofserviceto
updatethescreendata.
Note:DynamictextissupportedforNDCformattedscreen
definitionsonly.
Thecontrolcodeforthedefinitionofdynamictexthasamandatory
dataparameter,whichspecifiesthedevicesthatmustbeavailable
forthetexttobedisplayed.Thecontrolcodeisdefinedinthe
followingtable:
Table 3-38
Dynamic Text Definition

Character

Description

Number of
Characters

ESCq

DeviceControlStringIntroducer

Variable

Texttodisplay

Var

Separator

Variable

Indextodynamiccontenthook

Var

Separator

Variable

Conditionalexpression

Var

ESC\

StringTerminator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-43

Screen Data
Formatting Rules for Cardholder Display Screens

Anexampleofthiscontrolisasfollows:
<ESC>qTHIS IS DYNAMIC;002;FALSE<ESC>\

ThedynamiccontenthookisdefinedinDisplayManagerConfig.xml.
Fordetails,refertotheAPTRAAdvanceNDCDevelopersGuide.
Formoreinformationaboutconditionalexpressions,seeSyntaxof
ConditionalExpressionsonpage 342.

AnimationandDigitalVideo

Thisenablesyoutodisplayapredefinedanimationordigitalvideo
sequenceonthescreen.Thissequenceisatypeofpictureandis
displayedasapicture.Fordetails,seePictureControlon
page 333.
Thefollowingtablegivesexamplesofthemultimediaformatsthat
aresupportedwhentheappropriatecodecsareinstalledontheSST:
Table 3-39
Video and Animation File Formats

Extension

Description

AVI

AudioVideoInterleave:aMicrosoftcontainerformatfor
audioandvideofiles

MP4

ForWindowsMediaPlayerfromMicrosoft

WMV

WindowsMediaVideo:asubsetoftheAdvanced
SystemsFormat(ASF)containerformatfromMicrosoft

MPEG1,2

MovingPicturesExpertsGroup:responsibleforthe
developmentofstandardsforthecodedrepresentation
ofdigitalaudioandvideoandrelateddata

MOV

QuickTime:amultiplatform,multimediafileformat
fromApple

DIVX

CompressedvideoformatfromDivX,Incorporated

XVID

OpensourcevideoformatfollowingtheMPEG4
standard

Ananimationordigitalvideosequencemayalternativelybe
definedasafile.Inthiscase,itisdisplayedasanimagefile.For
details,seeDisplayImageFilesControlonpage 334.

InternationalCurrency
DisplayFormat

TheAmountDisplayscreenisanoverlayscreenwhichyouassign
andwhichisreferencedfromanamountentrystate.Thisfeature
allowsyoutodisplayanamountentryfield,relatingtothespecific
currency,andanentryechofield.Thisisusedonscreensthat
promptforamountentry.
Thecardholderscreencursorissettotheleftoftheechofieldfor
amountsenteredbythecardholder.Youcanalsodefineanecho

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-44

APTRA Advance NDC, Reference Manual

Screen Data
Formatting Rules for Cardholder Display Screens

fieldformatforamountentry.Thisisasimpletextstringthatis
displayedatthecursorpositiononentryintoanamountentrystate.
Themaximumlengthoftheechofieldis32characters.Thisincludes
upto12dataentrycharacters(*),acharacterdefiningthedecimal
pointposition,zeroprefillcharactersandleadingcurrency
characters.
Theonlyscreencontrolcharactersthatcanappearinthisscreenare
thesetcursorpositioncharacter,andthesecondarycharacterset
introducer(VT)character.Allothercharactersareignored.Ifyou
needtousesomeotherattributefortheamountdisplayscreen,you
mustincludeitinthescreenonwhichtheamountscreenis
superimposed(thescreencalledfromstatetableentry2ofan
amountentrystate).
Thedecimalpointcharactercanbe.or,.
Thefollowingexampleshowstheechofieldforeightdigitfields,
andthentheextensionsfortwelvedigits.

CurrencyEchoExample

IfthescreencontainsSI@@LIRA***0,000,thefollowingis
displayedatthetopleftcornerofthecardholderscreen:
Table 3-40
Currency Echo Example

LIRA0,000

Initialdisplaybeforeamountentrybycardholder

LIRA0,001

Firstentrycardholdertypes1

LIRA0,012

Secondentrycardholdertypes2

LIRA0,123

LIRA1,234

LIRA12,345

LIRA123,456

LIRA1234,567

LIRA2345,678

Eighthentrycardholdertypes8.

Ifnoechofieldformatisdefined,forexampleSI@@,adefault
screenisused,$*****0.00.
WhenconfiguredbytheoptionintheConfigurationParameters
Loadmessage,theamountentrybuffercancontainuptotwelve
digits.Fordetails,seetheConfigurationParametersLoadsection
inChapter 10,CentraltoTerminalMessages.Thisaffectsthe
amountechofieldinthefollowingways:

Upto12dataentrycharacters(*)canbeused
thedefaultis$*********0.00ifnoechofieldformatisdefined.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-45

Screen Data
Formatting Rules for Cardholder Display Screens

ExampleofDefaultEchoDisplayFormat
Inthefollowingexample,b=space:
Table 3-41
Default Echo Display Format

bbbbb$b0.00

Initialdefaultdisplaybeforeamountentryby
cardholder

$b0.01

Firstentrycardholdertypes1

$b0.12

Secondentrycardholdertypes2

$b1.23

Thirdentrycardholdertypes3

$b12.34

Fourthentrycardholdertypes4

$b123456.78

Eighthentrycardholdertypes8

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-46

APTRA Advance NDC, Reference Manual

Screen Data
Multi-Language Screens

MultiLanguageScreens

Youcancreateupto9,999multilanguagecardholderscreenstobe
displayedasrequestedfromonesetofstatetables.Youdothisby
definingagroupofscreensforeachlanguage,inwhichthe
equivalentscreenforalllanguageshasthesamerelativeposition
withinthegroup.Makesurethatallthescreensforwhichachoice
oflanguagescanbemadeareinthegroup.Notethatnestedscreens
musthaveabsolutepositions.
Thefirstgroupmuststartat000or0000,andcontainthose
screensforwhichlanguageselectionisnotpossible,thatis,screens
displayedfromtheCardReadstateandLanguageSelectFromCard
state.ScreensnormallyassociatedwithNotInServiceconditions,
suchasOutofService,SupplyandOffLine,shouldalsobeinthis
groupiftheCXXdefaultscreensareused.
Youdonotneedtochangethestatetables,butyoumustincludea
YEightFDKSelectionFunctionState(page 277)orV
LanguageSelectFromCardState(page 272)inordertoselectthe
language.
Forexample,iffourlanguagesarerequiredandthreedigitsare
used,thescreengroupbasescouldbe:
LanguageA000
LanguageB100
LanguageC200
LanguageD300
Thescreengroupsizewouldbe100.
Ifscreen025isdisplayedfromastatetable,thescreenis
downloadedas:
025forlanguageA
125forlanguageB
225forlanguageC
325forlanguageD.
Iffourlanguagesarerequiredandfourdigitsareused,thescreen
groupbasescouldbe:
LanguageA0000
LanguageB1000
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-47

Screen Data
Multi-Language Screens

LanguageC2000
LanguageD3000
Thescreengroupsizewouldbe001,representing1000.
Ifscreen025isdisplayedfromastatetable,thescreenis
downloadedas:
0025forlanguageA
1025forlanguageB
2025forlanguageC
3025forlanguageD.

RedefiningReserved
Screens

Whenmultilanguagescreensaresupported,youmustredefinethe
reservedscreensusedduringcardholdertransactionsasfollows:
3

C00mustcontainaninsertscreenwiththecontrolsequence
SOl0000.
Thefirstscreen(0000)ineachlanguagegroupmustcontainthe
timeoutscreen.IfacontrolsequenceotherthanSOl000isin
screenC00,thesamescreenwillbedisplayedforalllanguages.

C01,C02,C03Nochangeindefinition.
C04Containsanullvalueifnotused.
Containsaninsertscreenfortherelativescreennumbertobe
displayedforeachlanguage;forexample,thecontrolsequence
SOxxx,wherexxxistheoffsetinthescreengroup.
Containsscreendataifthesamescreenistobedisplayedforall
languages.

C05Nochangeindefinition.
C06Nochangeindefinition.
C07Nochangeindefinition.

Theusageofeachscreendoesnotchange.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-48

APTRA Advance NDC, Reference Manual

Screen Data
Displaying Pictures

DisplayingPictures

Thissectiondiscussessomepointstoconsiderwhenyouare
preparingpicturesfordisplayontheterminal.
Thefollowingimageformatsaresupported:

PictureResolution

GuidelinesforPictures

JPEG
GIF(includinganimatedandtransparentGIFs)
PNG(includingtransparentPNGs)
TIFF
PCX.

Thefirstpicturedisplayeddeterminestheamountofstretchingthat
isappliedtoallpictures.Forexample,ifthedesktopresolutionisset
to1024x768andthefirstpicturedisplayedis800x600,thepicture
isscaledupto1024x768.Allsubsequentpictureswillbescaledby
thesameamount.
Thefollowingpointsshouldbeconsideredwhenyouarepreparing
picturesforscreendisplay:

ToavoiddisplayflickerwithafullscreenPCXfile,includea
formfeedatthestartofthescreendefinition
Thesupplymodescreen,C03,isacardholderdisplayused
whentheterminalisinSupervisormode.Itmustbeofthesame
resolutionasthoseusedduringtherestofSupervisormodeif
switchingfrombacktofrontdisplays
Screensusedduringanidlesequenceshouldbeconstructed
usingthesameresolution.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-49

Screen Data
Touch Screen Reset

TouchScreenReset

Ascreenresetsequenceisincludedasareservedscreen,M15,in
theresrvd.deffile.Thisscreensetstheleftmarginandtheprimary
andsecondarycharactersets.ItissentwhenAdvanceNDC
displaysaprimaryscreen(thatis,onethatisnotpartofanested
sequence).
Asecondscreenresetsequence,M16,isalsoincludedinthe
resrvd.deffile.Thisscreencancontainsequencestobesenttothe
displaywhentheformfeedcharacter(0Chex)isreceivedfrom
Central.Thedefaultsequenceclearsthescreenandsetsthecursorto
thetoplefthandcorner,setsscreenblinkingoff,setsthecoloursto
defaultandresetsthedisplaymodetotheAdvanceNDCdefault.
Thedefaultdataforthesetwoscreensisasfollows:
M15

ESC[00p ESC(1 ESC)6

M16

DC2 ESC[00m ESCPi0 ESC\ FF

Formoreinformation,seeControlCodesforSpecialFeatureson
page 320andControlCharactersonpage 316.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-50

APTRA Advance NDC, Reference Manual

Screen Data
Supervisor Settlement Screens

SupervisorSettlementScreens

Supervisorsettlementtransactionsaredesignedtoallowasetof
SSTrelatedtransactions(suchassettlementofcashintheSST)tobe
performedusingtheoperatorkeyboard,andwithoutaSupervisor
card.ThisavoidshavingtouseaSupervisorcardtoactivateasetof
transactionflowsinadownload.
AswellasscreenC09,asetoftransactionsparameterscreens(C10
C19)canbeusedforthispurpose.Whenpresent,screensC10C19
overridescreenC09.Supervisorsettlementtransactionscanonlybe
carriedoutiftheinformationrelatingtothetransactionstobe
performedhasbeendownloadedinoneofthesereservedscreens.
SelectingtheSupervisortransactionsfunction(menuitem15 SUPV
TRANS)ontheSupervisorReplenishmenuenablesSupervisor
settlementtransactions.Thisindicatesthatonthenextentryto
InServicemode,theoperatorpanelistobeenabledforoneormore
predefinedsettlementtransactionstobeperformedpriortothe
cardholderinterfacebeingenabled.
IfmorethanoneofthescreensbetweenC10C19arepresentand
valid,theoperatorisaskedtochoosewhichonetouseforthe
settlementtransaction.Ifonlyoneispresentandvalid,itisused
andtheoperatordoesnothavetomakeanyselections.Ifnoneis
present,screenC09isused.

UsingtheFrontorRear
InterfaceforSettlement

OnafrontaccessSST,thecardholderdisplayandkeyboardorthe
frontoperatorkeyboardcanbeusedtoperformthetransactions.On
arearaccessSST,thecardholderdisplayshowstheInSupervisor
screen(003)throughoutthedurationoftheSupervisorsettlement
transactions.

RearSettlementandInternationalSecurity(DAPI7)

IfInternationalSecurityisconfigured,rearsettlementisnotalways
possible.IfanEPPisconfiguredandPINentryisrequired,PIN
entryattherearinterfaceisnotpossibleowingtoarestrictionin
CENXFS.TheinterfaceforPINentrycanbecontrolledthroughthe
registryandSupervisorMessageMode.
Fortheregistrysetting,refertotheAPTRAAdvanceNDC,
DevelopersGuide.FortheSupervisorMessageModeoptiondigit
(6A),refertotheAPTRAAdvanceNDC,SupervisorsGuide.
ForinformationaboutSecurityconfiguration,refertotheAPTRA
onlinedocumentationunderAPTRAXFS|Programmers
Reference.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-51

Screen Data
Supervisor Settlement Screens

SupervisorSettlement
Transactions

WhentheoperatorselectstheSupervisorTransactionsfunctionat
theSST,screensC09C19arecheckedforvalidSupervisor
settlementtransactiondata.
Validscreenscontainadefinitionofthecardtrackdatathatwould
beonthesupervisorcard,anddefinitionsforallthedatarequiredto
becollectedbythetransactionflows.Foreachtransaction,the
OperationCodebufferthatwouldhavebeencreatedbythe
transactionflowisalsodefined.Theformatofthescreensisdefined
inTransactionsParameterScreens(C09C19)onpage 353.
Duringsettlement,theoperatormaybepresentedwiththe
followingpromptsfordataentry:
PIN-, FUNC-, CASH-, BUFFER B-, BUFFER C-

Formoreinformationaboutthepromptsfordataentry,refertothe
theAPTRAAdvanceNDC,SupervisorsGuide,chapter3,Replenish
Menu,section15SPVRTRANS(SupervisorTransactions).
Thescreensforallfunctions,andthePLEASE WAITscreenshown
duringprocessing,areprovidedinresrvd.def.Thescreensmaybe
customisedtoshowmoreclearlywhatfunctionsareofferedand
whatvaluesaretobeentered.Forexample,theBUFFER C-prompt
couldbechangedtodisplayENTER NO OF NOTESastheprompt.
Forthedefaultsettlementscreensinresrvd.def,seeiSupervisor
SettlementScreensonpageA89.
Oncompletionofdataentry,theTransactionRequestmessageis
createdusingthespecifiedTransactionRequeststate,fileand
entereddata,andsenttoCentral(theHost).Fordetailsofthe
TransactionRequeststate,seeITransactionRequestStateon
page 232.
Ifthehostdoesnotrespondwithinthetransactiontimeoutperiod,
theCentralResponseTimeoutNextStateNumberexitfromthe
TransactionRequeststateisusedtocheckagainstthenext
state/actiontablefromthedatafile,andtheappropriateactionis
taken.

ValidCommands

OnlyPrintImmediateandNextStateandPrintcommandsare
acceptable;anyothercommandsareactedonasaNextStateand
Printcommand.Onlythenextstatefieldandprintfieldsforthe
receipt/journalareused;otherfieldsinthemessageareignored.
Therefore,careneedstobetakenwhendecidinghowCentral
shouldrespondtothesetransactionrequests.
Allprintingassociatedwiththereceiptandjournalisperformed,
andastatussent.Aprintimmediatewithnonextstatewillwaitfor
afurthercommand.Foranyothercommand,thenextstateis
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-52

APTRA Advance NDC, Reference Manual

Screen Data
Supervisor Settlement Screens

checkedagainstthenextstate/actiontableinthedatafile.Amatch
intheNextStateNumbertablewillcausetheequivalentnextstate
actionvaluetobecheckedforoneofthefollowingactionstobe
taken:
Promptfornexttransaction
Indicatetransactionfailureandpromptfornexttransaction
ExittonormalInServicemode
IndicatetransactionfailureandthenexittonormalInService
mode.

Ifnomatchinthetableisfound,thefirstactionisperformed.

TransactionsParameter
Screens(C09C19)

ThefollowingfieldsaredefinedforscreensC09andC10C19.You
mustensurethatthefielddataiscorrectandwithinthepermitted
values.
Ifafailureisindicated,themessageFAILnisdisplayed,wherenis
thenextstateoffsetnumberinthetransactiondatanextstatetable.

Table 3-42
Field Definitions for Screens C09C19

Field

Length (Bytes)

Content/Meaning

09,:NumberofActiveTransactions
(:=10)

Var(178)

Track1data,includingstartandendsentinels.If
thereisnoTrack1data,insertendsentinelonly.

Var(139)

Track2data,includingstartandendsentinels.If
thereisnoTrack2data,insertendsentinelonly.

Var(1106)

Track3data,includingstartandendsentinels.If
thereisnoTrack3data,insertendsentinelonly.

PINFlag.
0NoPINcollect.
1PINcollect.

TransactionRequestStateNumber.Usedto
createTransactionRequestmessage.

30

NextStateNumberTable.10entries(3bytes
each).Usedforcomparisontonextstatein
transactionreply.
Notusedentries=255.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

3-53

Screen Data
Supervisor Settlement Screens
Field

Length (Bytes)

Content/Meaning

10

NextStateActionTable.10entries(1byteeach);
oneforeachoftheNextstatevaluesdefined
above.
Values03:
0Functioncomplete,promptfornext
transaction.
1Functionfailed,promptfornexttransaction.
2Functioncomplete,returntonormal
operation.
3Functionfailed,returntonormaloperation.

OperationCodeBuffertransactionn
ValuesAIorspace.

LengthofBufferBtransactionn
Values08or?
?Bufferentryrequired.

Var(08)

DataforBufferB,lengthasspecifiedbyfieldj
(08).Notpresentiffieldj=?.
Values09.

LengthofBufferCtransactionn
Values08or?.
?Bufferentryrequired.

Var(08)

DataforBufferC,lengthasspecifiedbyfield1
(08).Notpresentiffield1=?.
Values09.

:
:

Fieldsimarerepeatedforthenumberof
transactionsspecifiedbyfielda.

Var(010)

AmountBufferFlagslengthisthatofthe
numberoftransactionsspecifiedbyfielda.
1byteforeachtransactionspecified

0Amountentrynotrequired
1Amountentryrequired.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

3-54

APTRA Advance NDC, Reference Manual

Table of Contents
Keyboard Data and Layouts

Chapter 4

KeyboardDataandLayouts
Overview

41

TheKeyboardInterface
PhysicalKeyboards
TouchScreenKeyboards
FDKEmulation
FullTouchScreen
AssociatingScreensandKeyboardsforFDKs
KeyboardMappingExamples
TimeOutStateExample
InformationEntryStateExample

42
42
42
42
44
44
46
46
47

StatesandKeyboards
AssociatedKeyboardsforFDKs
SecurePINEntryandKeyboards
KeyboardsinOperation

48
49
49
49

StandardKeyboardLayouts
TransactionProcessing
FrontInterface:SupervisorMode
EncryptionKeyEntry
SecureKeyEntry
RearInterface:OperatorKeyboardLayout

410
410
412
413
413
414

DefiningFullTouchScreens
TouchAreas
GenericKeyboardExample
CalculatingFullTouchScreenPositions
TheUnaryCoOrdinateSystem
CoordinateFormat
ConversiontoIEEEExample

416
416
416
417
417
418
418

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Keyboard Data and Layouts

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


Overview

Overview

Thischapterprovidesinformationaboutthefollowing:

Thekeyboardinterface
Statesandkeyboards
Standardkeyboardlayouts
Definingfulltouchscreenkeyboards

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-1

Keyboard Data and Layouts


The Keyboard Interface

TheKeyboardInterface

Thekeyboardispartoftheinterfacebetweenthecardholderor
operatorandtheterminal.Keyboardscanbephysicaldevices,or
emulatedonscreen(touchscreenkeyboards).
Forthefrontinterface,SMSstylealphanumericdataentryis
supported.OnBranchAssist18terminals,PCkeyboarddataentry
isalsosupported.
Thekeyboardlayoutfortherearinterfaceisfixedandcannotbe
customised.Keyboardlayoutsforthefrontinterfacecanbe
customised.Thefollowingrestrictionsapply:

Nestedkeyboardsarenotsupported
ExceptforFDKs,screenandkeyboardassociationsare
ignoredaskeyboardlayoutsaredefinedattheplatformand
serviceproviderlevel.
TheClearandCancelkeypositionscannotbeswapped.

FordetailsofscreenandkeyboardassociationsforFDKs,see
AssociatingScreensandKeyboardsforFDKsonpage 44.

PhysicalKeyboards

TouchScreenKeyboards

AphysicalkeyboardconsistsofthekeypadandFDKs.Itis
configuredusingthePINandTTUserviceproviders.Formore
information,refertotheAPTRAAdvanceNDC,DevelopersGuide.
Forterminalssupportingtouchscreens,touchscreenkeyboardscan
beusedineitherofthefollowingmodes:

FDKemulation
Fulltouchscreen.

InorderforCentraltodownloadthecorrectscreens,itrequests
informationfromtheterminalastowhetherFDKsoratouchscreen
isconfigured.Theterminalrespondstothisrequestbysendinga
solicitedconfigurationinformationstatusmessagetoCentral.For
details,seetheDeviceStatusInformationsectioninChapter 9,
TerminaltoCentralMessages.

FDKEmulation

Atouchscreencontainseightfixedtouchareaswhicharetouched
insteadofpressingthecorrespondingFDKs.Youcanchangethe
screensthataredisplayedwhenthecardholderisrequiredtomake
aselection,butthenumberandpositionofthetouchareasarefixed
andcannotbechanged.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-2

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


The Keyboard Interface

ThescreensarechangedusingaScreenDataLoadcommandfrom
Central,Fordetailsofthecommand,seetheScreen/KeyboardData
LoadsectioninChapter 10,CentraltoTerminalMessages.
YoucanconfigureAdvanceNDCtosoundabeepwhenan
emulatedFDKisselected.Forconfigurationdetails,refertoChapter
5,ConfiguringAdvanceNDCandAssociatedComponentinthe
APTRAAdvanceNDC,DevelopersGuide.
ThefollowingdiagramshowsthelocationoftheemulatedFDK
touchareas.
Figure 4-1
Emulated FDKs: Touch Areas
A

FDK I Touch Area

FDK A Touch Area

FDK H Touch Area

FDK B Touch Area

FDK G Touch Area

FDK C Touch Area

FDK F Touch Area

FDK D Touch Area

B
C

Theheightsandwidthsusedaregiveninthefollowingtable.The
heightsandwidthscorrespondtotherowsandcolumnsifthetouch
screeniscalibratedcorrectly.
Table 4-1
Emulated FDKs: Touch Area
Measurements

Measurement
Reference

Fraction/Screen
Height

Fraction/Screen
Width

Corresponding
Row

5/16ths

2/16ths

1/16th

Corresponding
Column

15/32nds

15

2/32nds

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-3

Keyboard Data and Layouts


The Keyboard Interface

FullTouchScreen
Youcandesignfulltouchscreenkeyboardsthatareeasiertouse
thanthephysicalkeyboard.Thisisparticularlyhelpfulfor
cardholderswithphysicaldisabilities.Upto200rectangularareas
canbedefinedonthescreen.Formoreinformation,seeDefining
FullTouchScreensonpage 416.

AssociatingScreensand
KeyboardsforFDKs

Associatedkeyboardsanddownloadablekeyboarddefinitionsare
supportedforphysicalandemulatedFDKsonly.
4

Associatedkeyboardsaresupportedbythefollowingstates:

FourFDKSelectionFunction(E)
AmountEntry(F)
InformationEntry(H)
EnhancedAmountEntry(R)
FDKInformationEntry(X)
EightFDKSelectionFunction(Y)
TimeOut

Associatedkeyboardsarenotsupportedbythefollowingstates:
PINEntry(B)

PIN&LanguageSelect(m)

EnhancedPINEntry(M)

CardReadPINEntryInitiation(T)

ChequeAccept(w)

CashAccept(>)

BarcodeRead(&)
AssociationsbetweenscreensandkeyboardsforFDKscanbe
createdusingtheScreen/KeyboardDataLoadcommand.For
details,seeCustomisationDataCommandsonpage 106.

ThetablebelowshowseachFDKkeywithitskeypositioncode,
defaultkeycode,andtheassociatedCENXFSkeyliteral.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-4

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


The Keyboard Interface
Table 4-2
FDKs, Key Codes and CEN-XFS
equivalents
FDK
Key Position Code
Default Key Code
CEN-XFS Code

FDK
Key Position Code
Default Key Code
CEN-XFS Code

I
17
FA
WFS_PIN_FK_FDK01

A
18
F6
WFS_PIN_FK_FDK05

H
19
F9
WFS_PIN_FK_FDK02

B
20
F5
WFS_PIN_FK_FDK06

G
21
F8
WFS_PIN_FK_FDK03

C
22
F4
WFS_PIN_FK_FDK07

F
23
F7
WFS_PIN_FK_FDK04

D
24
F3
WFS_PIN_FK_FDK08

DuetoCENXFSlimitations,AdvanceNDCcanonlyallow
remappingoflogicalCENXFSkeysandthekeycodesreturned;for
example,pressingWFS_PIN_FK_FDK04isinterpretedaskeycode
F5.
AkeyboarddatafieldintheScreen/KeyboardDataLoadmessage
data(seej1onpage 1011)containspairsofdatainthefollowing
form,allowingCENXFSkeystobemapped:
Table 4-3
Mapping CEN-XFS Keys

Number of
Characters

Supported
Range in
Advance NDC

Key
position

1724

IdentifiestheCENXFSkey
tomapfrom;thisisthekey
positionthatwillbeenabled.

Keycode

F3FA

IdentifiestheCENXFSkey
tomapto;thisisthekeycode
toreturn,whichwillaffect
theapplicationbehaviour.

Data

Description

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-5

Keyboard Data and Layouts


The Keyboard Interface

Ifavalueisnotwithinthesupportedrangeorthedatadownloaded
fromCentralisincomplete,thatkeydefinitionisignored.Ifthe
samekeypositionisspecifiedmorethanonceinthedata,thelast
definitionisused.
Note:AdvanceNDConlyrecognisesthemappingofFDKs;invalid
mappingsareignored.
AnykeysthatarenotspecifiedintheScreen/KeyboardDataLoad
messagearenotenabled.Ifnokeyboarddefinitionisspecifiedor
thekeyboarddefinitiondoesnotenabletherequirednumberof
keys,thedefaultkeyboardlayoutisused.Tofurtherreducethe
numberofenabledFDKs,FDKkeyboardmaskscanbespecifiedif
supportedbythestatetableforthekeyboardinputoperation.

KeyboardMapping
Examples

Thefollowingexamplesillustratekeyboardmappinginthe
TimeOutandInformationEntrystates.
4

TimeOutStateExample

ThisexampleshowsaScreen/KeyboardDataLoadmessagefora
samplescreenlayoutwithanassociatedkeyboarddefinition.Two
messagesareshown;thesecondmessagemodifiesthetextpositions
andFDKsenabled.Thesamekeycodesarereturnedsothe
applicationdoesnotneedtobechanged.
Screen/KeyboardDataLoadmessage

Themessageforasamplescreenanddefaultkeyboardlayoutisas
follows:
3<fs><fs><fs>11<fs>000<FF><SI>BCWOULDYOULIKEMORETIME?<SI>FHPRESS
IFYES><SI>IHPRESSIFNO><GS>00518F620F5

ToupdatethetextpositionsandenableFDKDandFDKF,sendthe
followingmessage:
3<fs><fs><fs>11<fs>000<FF><SI>BCWOULDYOULIKEMORETIME?<SI>O2PRESS
IFYES><SI>O@<PRESSIFNO<GS>00524F623F5

InthekeyboarddefinitionfortheTimeOutstateabove,Advance
NDCwillenableCENXFSkeysWFS_PIN_FK_FDK_08(key
position24)andWFS_PIN_FK_FDK_04(keyposition23).
IfWFS_PIN_FK_FDK_08ispressed,theapplicationwillbehaveasif
WFS_PIN_FK_FDK_05hadbeenpressed(keycodeF6).
IfWFS_PIN_FK_FDK_04ispressed,theapplicationwillbehaveasif
WFS_PIN_FK_FDK_06(keycodeF5)hadbeenpressed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-6

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


The Keyboard Interface

InformationEntryStateExample

Thisexampleshowsthemessagefordownloadingasamplestate
definitionandthemessageforanassociatedscreenandkeyboard
definition.TheScreen/KeyboardDataLoadmessageupdatesthe
screendisplayedonentrytotheInformationEntrystate(seeH
InformationEntryStateonpage 228)touserepositionedfunction
keys.
Inthisexample,theStateTablesLoadmessagedoesthefollowing:

Downloadsstate015asanInformationEntrystate
Specifiesscreennumber25tobedisplayedonentrytothestate
DoesnotspecifyaTimeOutNextStateNumber
Specifies026astheCancelNextStateNumber
Specifies017astheFDKANextStateNumber
Specifies015astheFDKBNextStateNumber
DoesnotspecifyaNextStateNumberforanyotherFDKs
Specifiesdatatobedisplayedasitiskeyedin.

StateTablesLoadmessage

Themessageisasfollows:

3<fs><fs><fs>12<fs>015H025255026017015255255001

IftheInformationEntrystateisdefinedtoenableFDKsAandB,but
nokeyboardisdefinedforthescreendisplayedonentrytothe
InformationEntrystate,WFS_PIN_FK_FDK_05and
WFS_PIN_FK_FDK_06areenabled.WhenWFS_PIN_FK_FDK_05is
pressed,theapplicationwillrecognisetheF6keycode.When
WFS_PIN_FK_FDK_06ispressed,theapplicationwillrecognisethe
F5keycode.
ThefollowingScreen/KeyboardDataLoadMessageenables
WFS_PIN_FK_FDK_01(FDKI)andWFS_PIN_FK_FDK_02(FDK
H).
Screen/KeyboardDataLoadMessage

3<fs><fs><fs>11<fs>000<FF><SI>BIPLEASEKEYIN<SI>CGTHEACCOUNT
NUMBER<SI>DDYOUWISHTOTRANSFERTO<GS>00517F619F5

Inthiscase,whenWFS_PIN_FK_FDK_01ispressed,theapplication
willbehaveasifWFS_PIN_FK_FDK_05hadbeenpressed.If
WFS_PIN_FK_FDK_02ispressed,theapplicationwillbehaveasif
WFS_PIN_FK_FDK_06hadbeenpressed:
Table 4-4
Mapping CEN-XFS Example

Key Enabled (Key position, Default Key Code)

Mapped to...

WFS_PIN_FK_FDK_01(17,FA)

WFS_PIN_FK_FDK_05

WFS_PIN_FK_FDK_02(19,F9)

WFS_PIN_FK_FDK_06

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-7

Keyboard Data and Layouts


States and Keyboards

StatesandKeyboards

Bothphysicalandtouchscreenkeyboardscanbeenabledinthe
followingstatetypes:

FourFDKSelectionFunction(E)
AmountEntry(F)
InformationEntry(H)
TransactionRequest(I)
EnhancedPINEntry(M)
EnhancedAmountEntry(R)
CardReadPINEntryInitiation(T)
FDKInformationEntry(X)
EightFDKSelectionFunction(Y)
CustomerSelectablePINEntry(b)
ExitStates(d...gandz900toz999)
PIN&LanguageSelect(m)
CashAccept(>)
ChequeAccept(w)
BarcodeRead(&)
TimeOut.

Keyboardscanalsobeusedbythecardholderduringaninteractive
transactionresponse.
Downloadablekeyboarddefinitions(associatedkeyboards)are
supportedonlyforphysicalandemulatedFDKs.Thefollowing
statetypesdonotsupportdownloadablekeyboarddefinitions:

PINEntry(B)
EnhancedPINEntry(M)
CardReadPINEntryInitiationState(T)
PIN&LanguageSelect(m)
ChequeAcceptState(w)
CashAcceptState(>)
BarcodeState(&)

Cardlesstransactioninitiationdoesnotsupportassociated
keyboards.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-8

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


States and Keyboards

AssociatedKeyboardsfor
FDKs

SecurePINEntryand
Keyboards

Ifascreennumberreferencedinoneofthesestatetablesis
associatedwithakeyboardlayout,thelayoutissetup.Optionssuch
asswappingleftandrightFDKsorswappingtheClearandEnter
keysareignored.Ifakeyboardisnotassociatedwiththescreen,a
defaultlayoutisused.
AdvanceNDCusessecurePINentry.Becausethetouchscreenis
notsecure,anykeyboardlayoutspecifiedforsecurePINentrymust
usethephysicalkeyboardforPINentry.Therefore,onlythe
physicalkeyboardcanbeenabledinthefollowingstates:

PINEntry
CardReadPINEntryInitiation
LanguageSelectPINEntry

ThetouchscreencanonlybeusedinFDKemulationmodeduring
securePINentry.

KeyboardsinOperation

If,duringatransaction,auserdefinedkeyboardisabouttobeused
butthereisanerrorwiththedefinition,theinvalidkeyboardis
ignoredandastandardlayoutused.
ExitStatesareresponsiblefortheirownkeyboarduse.
Ifalayoutcontainstouchscreendefinitionsbutnotouchscreenis
available,thatdatawillbeignoredbuttherestofthelayoutwillbe
used.Thisallowsglobalconfigurationofanetworkwherenotall
theSSTshavetouchscreens.
Fortouchscreens,ifthedatasuppliedbythekeyboardlayout
definitioncontainsoutofrangevalues,thesetofdatawillbe
ignored.Iftheresultantlayoutisincompleteforusebyastate,the
transactionflowmaygototheClosestate.Forphysicalkeyboards,
thedataisignored.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-9

Keyboard Data and Layouts


Standard Keyboard Layouts

StandardKeyboardLayouts

ThefollowingkeyboardlayoutsareprovidedAdvanceNDC:

Transactionprocessing
Supervisormode
Encryptionkeyentry
Securekeyentry
Operator.

InCENXFS,keypositionsaremanagedbytheserviceproviders
(SPs);thereforethereturncodesprovidedbyAdvanceNDCare
basedontheCENXFSkeyvalues.Formoreinformationaboutthe
CENXFSspecifications,seeCENXFSDocumentationon
page G7.
ForinformationaboutSPkeyboardconfiguration,refertothe
onlinedocumentationforNCRAPTRAunderXFSPINService
ProviderandXFSTTUServiceProvider.
FormoreinformationaboutkeyboardconfigurationinAdvance
NDConNCRSSTs,refertotheAPTRAAdvanceNDC,Developers
Guide;forothervendorsSSTs,refertotheAPTRAAdvanceNDC,
MultiVendorSupportReferenceManual.

TransactionProcessing

Figure 4-2
Standard Keyboard Layout for Cardholder
Transactions

Thefollowingillustrationshowsthelayoutofthestandard
cardholderkeyboardduringtransactionprocessing,definedby
screenM06:

FDKI

CLR

FDKA

FDKH

CNL

FDKB

FDKG

ENT

FDKC

FDKF

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-10

APTRA Advance NDC, Reference Manual

FDKD

Keyboard Data and Layouts


Standard Keyboard Layouts

Thefollowingtableshowshowtheautoactivatorvaluesare
assignedtothenumerickeyswiththecorrespondingCENXFS
functionkeydefinitions:
Table 4-5
Numeric Autoactivators (PIN)

1
WFS_PIN_FK_1

2
WFS_PIN_FK_2

3
WFS_PIN_FK_3

4
WFS_PIN_FK_4

5
WFS_PIN_FK_5

6
WFS_PIN_FK_6

7
WFS_PIN_FK_7

8
WFS_PIN_FK_8

9
WFS_PIN_FK_9

0
WFS_PIN_FK_0

Note:Theautoactivatorvaluesfornumerickeysapplytoall
cardholderkeyboardlayouts.
Thefollowingtableshowshowtheautoactivatorvaluesare
assignedfornonnumerickeys,withthecorrespondingCENXFS
functionkeydefinitions:
Table 4-6
Non-Numeric Autoactivators (PIN)
FA (FDK I)
WFS_PIN_FK_FDK01

FF (Clear)
WFS_PIN_FK_CLEAR

F6 (FDK A )
WFS_PIN_FK_FDK05

F9 (FDK H )
WFS_PIN_FK_FDK02

F2 (Cancel)
WFS_PIN_FK_CANCEL

F5 (FDK B )
WFS_PIN_FK_FDK06

F8 (FDK G )
WFS_PIN_FK_FDK03

F1 (Enter)
WFS_PIN_FK_ENTER

F4 (FDK C )
WFS_PIN_FK_FDK07

F7 (FDK F )
WFS_PIN_FK_FDK04

F3 (FDK D )
WFS_PIN_FK_FDK08

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-11

Keyboard Data and Layouts


Standard Keyboard Layouts

FrontInterface:Supervisor
Mode
4

ThelayoutofthecardholderkeyboardduringSupervisormodeis
showninthefollowingillustration.Ifyoudefineaninvalid
keyboardforSupervisormode,itisignoredandthiskeyboardis
enabled.

Figure 4-3
Supervisor Mode: Keyboard Layout

FDKF

CLR

CNL

ENT

FDKD

Thefollowingtableshowshowtheautoactivatorvaluesfor
nonnumerickeysareassociatedwiththecorrespondingCENXFS
keycodedefinitions:
Table 4-7
Supervisor Mode Autoactivators (PIN)
FF(Clear)
WFS_PIN_FK_CLEAR
F2(Cancel)
WFS_PIN_FK_CANCEL
F1(Enter)
WFS_PIN_FK_ENTER
FF(Clear)
WFS_PIN_FK_CLEAR

F1(Enter)
WFS_PIN_FK_ENTER

Ifyouareusingatouchscreen,FDKemulationisthedefault.
Note:RedefiningtouchareasisnotsupportedinSupervisormode.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-12

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


Standard Keyboard Layouts

EncryptionKeyEntry

Figure 4-4
Encryption Key Entry Keyboard Layout

Thecardholderkeyboardlayoutforencryptionkeyentryisshown
inthefollowingillustration.Ifyoudefineaninvalidkeyboardfor
encryptionkeyentry,itisignoredandthiskeyboardisenabled.

CLR

ENT

F
ENT

Theautoactivatorvaluesfornonnumerickeysareassignedas
follows,withthecorrespondingCENXFSdefinitionsforPINand
TTU:
Table 4-8
Encryption Key Entry Autoactivators (PIN)

F1(Enter)
WFS_PIN_FK_ENTER
FF(Clear)
WFS_PIN_FK_CLEAR

F1(Enter)
WFS_PIN_FK_ENTER

Table 4-9
Encryption Key Entry Autoactivators (TTU)

F1(Enter)
WFS_TTU_CK_ENTER
FF(Clear)
WFS_TTU_CK_CLEAR

SecureKeyEntry

Figure 4-5
Cardholder Keyboard: Secure Key Entry
Layout

F1(Enter)
WFS_TTU_CK_ENTER

Thefollowinglayoutshowsthepositionsforthecardholder
keyboardduringsecurekeyentryonNCRSSTs.Aswellas
standardcompliance,securekeyentryoffersenhancedsecurityin
whichtheapplicationneverseesthekeyvalue.Thedecisiontouse
securekeyentryistheresponsibilityofthefinancialinstitution.
1

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-13

Keyboard Data and Layouts


Standard Keyboard Layouts

ThelayoutinFigure45CardholderKeyboard:SecureKeyEntry
Layout,isthedefaultone.Differentkeyboardlayoutsforsecure
keyentryaresupported.Ifthekeyboardconfiguredthroughthe
platformisdifferentfromthedefaultlayout,screenI30mustbe
updatedinresrvd.deftomatchthekeyboardlayoutinuse.
Keyentrycannotbecancelleduntilallthedigitsareentered,when
theoptiontoconfirmthekeyisgiven.
Note:Astheapplicationandserviceprovidersneverseewhatkeys
arepressedinsecurekeyentry,mappingtoCENXFScodesisnot
required.
Fordetailsofhowthekeyboardismappedforsecurekeyentry,
refertotheAPTRAonlinedocumentationunderAPTRAXFS|
ProgrammersReference|XFSServiceProviders|XFSPINService
Provider|ConformanceMatrixCommands

RearInterface:Operator
KeyboardLayout

Theoperatorkeyboardlayoutfortherearinterfaceisasfollows:
4

Figure 4-6
Operator Keyboard Layout

Clear

CLR

CNL

ENT

Enter

NocorrespondingCENXFSdefinitionsfornumerickeysare
providedasthenumbersarereturned.
Thefollowingtableshowshowtheautoactivatorvaluesare
assignedfornonnumerickeys,withthecorrespondingCENXFS
commandkeysdefinitionfortheTextTerminalUnit(TTU).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-14

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


Standard Keyboard Layouts
Table 4-10
Non-Numeric Autoactivators (TTU)

FF(Clear)
WFS_TTU_CK_CLEAR

F2(Cancel)
WFS_TTU_CK_CANCEL

F1(Enter)
WFS_PIN_FK_ENTER

FF(Clear)

F1(Enter)

WFS_TTU_CK_CLEAR

WFS_TTU_CK_ENTER

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-15

Keyboard Data and Layouts


Defining Full Touch Screens

DefiningFullTouchScreens

Todefineatouchscreenkeyboard,eachtouchareaisdefinedbythe
XandYcoordinatesfortwodiagonallyoppositecorners,followed
bythecodewhichisreturnedtotheterminalwhentheareais
touched.Touchareascanonlyberectangularinshape.
Upto200areascanbedefinedashexadecimalstringsandenabled
onthetouchscreenatthesametime.Eachtouchareacanbeany
sizeandinanyposition.Ifanyareasoverlap,thefirstdefinedtakes
priority.

TouchAreas
Table 4-11
Touch Area Definition

Eachtouchareaisdefinedasfollows:
4

Label

No. Of
Chars

Range

Description

TPx1

00000000FFFFFFFF

Xcoordinateoffirstcorner

TPy1

00000000FFFFFFFF

Ycoordinateoffirstcorner

TPx2

00000000FFFFFFFF

Xcoordinateofsecondcorner

TPy2

00000000FFFFFFFF

Ycoordinateofsecondcorner

TC

00FF

Thereturncodeforthearea

WhenthisdataisdownloadedfromCentral,therangeofthereturn
codeischeckedbuttherangeofthepositioncharactersisnot.
Therefore,youmustensurethatvalidvaluesareused.Ifanillegal
positionvalueisused,thetouchareathatitbelongstoisignored.If
therangecheckfailsorinsufficientcharactersareprovidedtodefine
atoucharea,thedataforthatareawillbeignored.
Note:Thereturncoderangeislimitedtothedesignatedkeyboard
valuesasdeterminedbytheapplicationstate.

GenericKeyboardExample

Agenerickeyboardcanbesetupwithnumerickeys09,Cancel,
ClearandFDKsA,B.AstatethatrequiresonlyFDKsA,Band
CancelwillignorethenumerickeysandClear.Astatethatrequires
onlythenumerickeys09,CancelandClearwillignoretheFDKs.
However,bothstatescanreferencethiskeyboardaslongastheir
minimumrequirementsaremet.
Note:Thisexamplecanalsobeappliedtophysicalkeyboards.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-16

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


Defining Full Touch Screens

CalculatingFull
TouchScreenPositions

Touchscreendefinitionsaresupportedforlegacydefinitions.Ifyou
wanttodefinenewones,thissectionexplainstheformatofthe
coordinatesthatareusedtodefinetouchareasonthescreenand
howtocalculatethem.

TheUnaryCoOrdinateSystem

Theunarycoordinatesystemisbasedonatwodimensional
cartesianspacewithnormalisedcoordinates.Thisallowsyouto
specifypositionsthatdonotdependonthephysicalscreen
dimensionsorresolution.
Thecoordinatesarethehorizontalandverticaldisplacements,X
andY,fromanorigininthetoplefthandcornerofthescreen.The
rangeofvaluesforeachisfromzero(inclusive)toone
(noninclusive), 0 X Y 1 .Thuseachcoordinateisdefinedas
decimalfractionsofthewidthandheightofthephysicalscreen.

Figure 4-7
Unary Co-ordinates
Screen

(X1,Y1)

Touch
Area
(X2,Y2)

CoordinatesaredefinedasIEEEfloatingpointnumbers,witha
limitofE+21.Afloatingpointnumberisstoredinmemoryas32bits
inthefollowingformat:
Figure 4-8
Format for Floating Point Numbers

Sign

Exponent

Mantissa

24 23

31 30
byte 0

8 7

16 15
byte 1

byte 2

0
byte 3

Acoordinateiscalculatedusingthefollowingformula:
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-17

Keyboard Data and Layouts


Defining Full Touch Screens
N = 2

exp 127

1 + mant 2

23

where:
expisavalueintherange0255
mantisavalueintherange02

CoordinateFormat

Acoordinatemaybeexpressedaseitherfourbytesofpackeddata
oreightbytesofunpackeddata.Acoordinateinpackedformatis
obtainedbyreversingthefourbytesrepresentingthefloatingpoint
number.Unpackedformatisobtainedbytakingeachhexdigitin
thepackedformatandadding30hextoittoproduceeightbytesin
therange303Fhex.TheequivalentASCIIstringisusedinfieldj2
oftheScreen/KeyboardDataLoadmessage.
ToconvertanumbertoIEEEformat,youshouldwriteitinthe
followingform:
A

N= 2 1 + B

where:
A = exp 127
B = mant 2

23

Note:Aisthehighestwholenumberpowerof2thatgivesavalue
lessthanorequaltothenumber,N.

ConversiontoIEEEExample
Inthisexample,thenumber0.635isconvertedtoIEEEformat.
N=0.635
A

0.635 = 2 1 + B

TocalculateA:
Thehighestpowerof2thatgivesavaluelessthanorequalto
0.635is1.(21=0.5)
A = 1

TocalculateB:
0.635 = 2

1 + B

1 + B = 0.635 2 = 1.27
B = 0.27

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-18

APTRA Advance NDC, Reference Manual

Keyboard Data and Layouts


Defining Full Touch Screens

Tocalculatetheexponent(exp):
A = exp 127 = 1
exp = 126 = 7Ehex
exp = 01111110bin

Figure 4-9
Calculate Exponent
Exponent

Sign

Mantissa

0 1 1 1 1 1 1 0
24 23

31

byte 0

Tocalculatethemantissa(mant):
B = mant 2

23

mant = 0.27 2

= 0.27

23

= 2264924 = 228F5Chex

mant = 01000101000111101011100bin
Figure 4-10
Calculate Mantissa
Exponent

Sign

Mantissa

0 1 0 0 0 1 0 1 0 0 0 1 1 1 1 0 1 0 1 1 1 0 0
24 23

31

byte 1

8 7

16 15
byte 2

0
byte 3

Thecoordinateisalwayspositive,sothesignisalwayszero.
sign = 0

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

4-19

Keyboard Data and Layouts


Defining Full Touch Screens
Figure 4-11
Calculate Sign
Exponent

Sign

Mantissa

0
24 23

31

byte 0

Puttingallthesetogethergivesthefollowing:

Figure 4-12
Calculate Co-ordinate

Exponent

Sign

Mantissa

24 23

31 30
byte 0

8 7

16 15
byte 1

byte 2

0
byte 3

Themostsignificantbitofbyte1isdeterminedbytheleast
significantbitoftheexponent.Inthiscase,thisis0.
Byte0

00111111bin

3Fhex

Byte1

00100010bin

22hex

Byte2

10001111bin

8Fhex

Byte3

01011100bin

5Chex

Therefore,0.635becomes3F228F5C.
7

Thecoordinateinpackedformatis5C8F223F.

Thecoordinateinunpackedformatis353C383F3232333F.
TheequivalentASCIIstringis5<8?223?.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

4-20

APTRA Advance NDC, Reference Manual

Table of Contents
Printer Data

Chapter 5

PrinterData
Overview

51

PrinterTypesSupportedbyAdvanceNDC

52

PPDDefaultPrint
EightCharacterAmountBuffer
TwelveCharacterAmountBuffer

54
54
55

PrinterControlCharacters
EnhancedPrinterControlCodes
SetLeftMargin
SetRightMargin
PrinterIndependentMarginControl
SelectOS/2CodePage
SelectInternationalCharacterSets
SelectArabicCharacterSets
PrintDownloadableBitImage
PrintBarcode
PrintGraphics
PrintChequeImage
DefineDownloadableCharacterSet
DefineDownloadableBitImage
SelectPrintingPositionofHRICharacters
SelectWidthofBarcode
SelectHorizontalHeightofBarcode
SelectDualsidedPrinting

56
57
57
58
59
59
59
510
510
512
513
514
515
516
516
517
517
518

CharacterSets
PrimaryPrintPage
SecondaryPrintPage

519
521
521

StatementPrinterControls
LeftMarginControl

522
522

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Printer Data

RightMarginControl
MarginControlUse
LinesPerInchControl

522
523
523

SimulatedPreprintedReceiptMessages

524

SidewaysPrintingonReceipt
UnsupportedFunctions

528
528

PrinterControlSequencesandRegistrySettings

529

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Printer Data
Overview

Overview

Thischapterprovidesinformationonthefollowingtopics:

PrintertypessupportedbyAdvanceNDC
DefaultprintsforProgrammablePrintingDepository(PPD)
Printercontrolcharacters
Charactersets
Statementprintercontrols
Simulatedpreprintedreceiptmessages
Sidewaysprintingonreceiptprinters
Printercontrolregistrysettings.

Note:ThischapterprovidesinformationforNCRprinters.For
differencesthatmightbeexperiencedwithprintersfromother
vendors,refertotheAPTRAAdvanceNDC,MultiVendorSupport
ReferenceManual.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-1

Printer Data
Printer Types Supported by Advance NDC

PrinterTypesSupportedbyAdvance
NDC
5

TheAdvanceNDCsoftwaresupportsprintingonthefollowing
devicesonNCRSSTs:

Receiptprinter(SDC,RS232,USB)
Journalprinter(SDC,RS232,USB)
Statementprinter(SDC,Parallel,USB)
ProgrammablePrintingDepository(PPD)
Chequeprocessorendorsecheque

Note:Allthedeviceslistedabovearesupportedusingthe
CENXFSinterface.Formoreinformation,refertotheAPTRA
AdvanceNDC,DevelopersGuide.Fordetailsofmultivendorprinter
supportandcontrolcodemapping,refertoAppendixC,Printer
DataControlCodesintheAPTRAAdvanceNDC,MultiVendor
SupportReferenceManual.
ThedefaultprintingmethodforUSBprintersisformsbased
printing,buttheycanbeconfiguredtoprintrawdata.Theother
printertypesuserawdataforprinting.Inrawdataprinting,
printerspecificcontrolcodesaresentdirectlytotheprinter.
FormsbasedprintingutilisestheWindowsprintingenvironment,
removingtheneedtoknowdetailsoftheprinter.Thisis
implementedinAdvanceNDCusingXFSforms,whichare
generateddynamicallybytheapplication.
TheUSBprintersaresupportedontheSelfServrangeofSSTsfrom
NCR.TwosidedprintingissupportedfortheUSBreceiptand
statementprinters.
SidewaysprintingissupportedwiththeSDCandRS232receipt
printer.Formoreinformation,seeSidewaysPrintingonReceipt
onpage 528.
WhenprintinginsidewaysmodeontheSDCorRS232receipt
printertheformlengthisnotconfigurable.Areceiptwitha
maximumof20linescontainingupto80columnscanbeprintedin
sidewaysmodeonthereceiptbeforeacut.
Thedatatobeprintedonaparticularprinter,orprinters,mustbe
placedinaprinterdatafieldcontainedinaTransactionReply
Commandmessage.Fordetails,seetheTransactionReply
CommandsectioninChapter 10,CentraltoTerminalMessages.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-2

APTRA Advance NDC, Reference Manual

Printer Data
Printer Types Supported by Advance NDC

Thelengthoftheprinterdatafieldisvariable,anddependsonthe
amountofdataanddatacompressionperformed,theprinter
characteristics,andtheoverallmessagelengthlimitation.Thereare
13printerdatafields.
OntheSDCandRS232receiptandjournalprinters,the
uncompresseddatalengthisrestrictedto500charactersperprinter
datafield.Thereforetheuncompresseddatalengthcanbeupto
6500characters,althoughnotallcommsprotocolsmaysupportuser
messagesofthislength.
Printingtothestatementprinterisrestrictedbythecompressed
datafieldlength.AnoptionontheConfiguremenuinSupervisor
allowsthesettingofamaximumnumberoflinestoprintbeforea
cutonprinterswheretheblackmarkisnotused.Fordetails,referto
45MAXSTATEMENTLENGTHinchapter4,ConfigureMenu,
oftheAPTRAAdvanceNDC,SupervisorsGuide.
ThePPDcanprintupto80characters.
Theprinterflagfieldspecifiesonwhichprinter(s)theinformationis
printed.Doublewidthcharacterscanbeprintedoncertainprinters.
Areceiptlengthissetatpoweruptimeonaterminalthat
implementsacutafterthefollowing:

24or49linesonanonthermalreceiptprinter
24linesorgreateronathermalprinter,themaximumlengthis
specifiedbytheprintervendor.

Printingofchainedtransactionsononereceiptforcesanautomatic
cutifanattemptismadetoprintonthelineafterthatspecifiedas
thedefaultsetting.
AnalternativeSupervisoroptionisavailablethatallowsreceiptsof
upto49linestobeprintedontheterminalwithoutacut;fordetails,
seetheAPTRAAdvanceNDC,SupervisorsGuide.Thisisnot
supportedinsidewaysprintingmodeonthereceiptprinter.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-3

Printer Data
PPD Default Print

PPDDefaultPrint

IfadepositisrequestedinaTransactionReplycommand,butnone
oftheprinterflagfieldscontainsavalueof4or5,thefollowing
informationisprinted,dependingonwhethertheamountbuffer
lengthiseightortwelvecharacters:

EightCharacterAmount
Buffer

Thefollowingisprintedforthisbuffer:

Transactionserialnumber
Thisfourcharacternumberisprintedinprintcolumns1to4
andrepeatedincolumns16to19.
Amountbuffer
ThecontentsoftheAmountbufferareprintedinprintcolumns
6to14.Leadingzerosaresuppressedandthedecimalcharacter
(,or.)isdisplayedinitstrueposition.Fordetails,seetheF
AmountEntryStatesectioninChapter 2,StateTables.
Carddata
Thefirst30charactersfromTrack2ofthecardareprintedin
columns21to50,withaleading*incolumn20.TheStart/End
sentinelsarenotprinted.Thefieldseparatorisprintedas=.
Printingistruncatedifanendsentinelisencountered.Ifthe
Track2datadoesnotcontain30characters,thetrailing
charactersareblanked.
Machinenumber
ThemachinenumberisenteredusingtheSupervisorfunction
MACHINENO.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.Sixcharactersarereservedforthisfield.If
thereisnomachinenumber,thefieldremainsblank.The
machinenumberappearsincolumns72to77.
Dateandtime
Thedateisdisplayedincolumns53to62,andthetimein
columns64to71.InAdvanceNDC,thedateisdisplayedinone
oftwoformats:MM/DD/YYYYorDD/MM/YYYY.Thedateformatis
setbytheoptionsetintheEnhancedConfigurationParameters
Loadmessage.Fordetails,seetheEnhancedConfiguration
ParametersLoadsectioninChapter 10,CentraltoTerminal
Messages.Thetimeisdisplayedashh:mm:ss,usingthe24
hoursconvention.Eightcharactersarereservedforthisfield,
anditisalwaysdisplayedintheformathh:mm:ss.

Atypicalprintlineis:
1234

250.00 1234*012345678901234567890123456789

20/11/2009

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-4

APTRA Advance NDC, Reference Manual

15:30:29

000000

Printer Data
PPD Default Print

TwelveCharacterAmount
Buffer

Thefollowingisprintedforthisbuffer:

Transactionserialnumberthisfourcharacternumberis
printedinprintcolumns1to4
AmountbufferthecontentsoftheAmountbufferareprinted
inprintcolumns6to18.Fordetails,seetheFAmountEntry
StatesectioninChapter 2,StateTables.Leadingzerosare
suppressedandthedecimalcharacter(,or.)isdisplayedinits
trueposition
Carddatathefirst30charactersfromTrack2ofthecardare
printedincolumns21to50,withaleading*incolumn20.The
Start/Endsentinelsarenotprinted.Thefieldseparatorisprinted
as=.Printingistruncatedifanendsentinelisencountered
Dateandtimethedateisdisplayedincolumns53to60,and
thetimeincolumns64to71.AdvanceNDCsupportstwodate
formats:MM/DD/YYYYandDD/MM/YYYY.Thedateformatissetby
theoptionsetintheEnhancedConfigurationParametersLoad
message.Thetimeisalwaysdisplayedintheformathh:mm:ss,
usingthe24hoursconvention.Eightcharactersarereservedfor
thisfield.

Atypicalprintlineisasfollows:
1234

250.00 *012345678901234567890123456789

20/11/2009

15:30:29

000000

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-5

Printer Data
Printer Control Characters

PrinterControlCharacters
Thesecharactersallowdatatobeformattedforprinting.The
printersvaryinthecontrolcharacterstheysupport.
Thecontrolcharactersareshowninthefollowingtable,withany
specialprintercharacteristicsnoted,otherwisetheyrefertoall
printers:
Table 5-1
Printer Control Characters
Character

ASCII Code

Function

LF

0Ahex

Causesthenextgraphiccharactertobeprintedonthenextlineatthecolumn
definedbytheleftmargin.

FF

SO

0Chex

0Ehex

Journal

SubsequentLFcontrolswithnointerveninggraphic
charactersareignored.

PPDEnvelope

Allignored.

Receipt

Causesafeedof24linesinnormalprintingmode,ora
feedtothelengthofthelongestprintlineinsideways
printingmodeuptoamaximumof80columns,cutand
delivertocustomer.

Journal

Causesalinefeed.

Statement

Causesafeedtoblackmark,cutanddelivertocustomer.

PPDEnvelope

Ignored.

Fillsanareaoftheprinterformwithspaces.ThisSOcommandisfollowed
byasinglegraphiccharacterindicatingthedesirednumberofspacestobe
insertedasfollows:
Character

No.ofspaces

19
:
;
<
=
>
?

19
10
11
12
13
14
15

PPDEnvelope

Ignored.

Statement

Internationalalphanumericset3(designator7,BorE)
doesnotcontainaspacecharacter.Inthiscasethearea
willbefilledwithspace.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-6

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Characters
Character

ASCII Code

Function

ESC

1Bhex

Controlcharacterintroducingsupplementarycontrolcodes.Formore
information,seeCharacterSetsonpage 519andStatementPrinter
Controlsonpage 522.

HT

09hex

PPDEnvelope

Ignored.

Statement

Positionsthenextgraphiccharacterinthenexttab
column.Tabsaredefinedtobeineveryeighthcolumn
fromtheleftmargin.Atabpasttherightmargin
positionsthecharacterinthefirstpositionofthenext
line.Multipletabsarepermitted.

PPDEnvelope

Ignored.

Others

NotdefinedforAdvanceNDC.Causesprinthead
movementandmisalignmentofdata.

Note:Forthestatementprinter,NCRrecommendsthatprintdata
hasalinefeedinsertedattheendofeachlineandaformfeed
insertedattheendofeachstatement.
Usingthedefaulttopmarginofoneinch,thefollowingmaximum
numberoflinescanbeprinted:
Table 5-2
Maximum Printed Lines

Size of Media

Lines Per Inch

Maximum Lines

101.6mm/4inch

17

101.6mm/4inch

23

152.4mm/6inch

29

152.4mm/6inch

39

Fordifferentvaluesoftopmargin/linefeed,werecommendthatno
printingtakesplacewithin5mm/0.2inchofthebottomofthe
statement.

EnhancedPrinterControl
Codes

Thesecodesareallintroducedintothecontrolsequencebythe
controlcode1BH(ESC)andareusedfortheSDCandRS232receipt
andjournalprinters.
Note:Differences,includingdifferencesinuseorapplicationof
controlcodesforUSBreceiptandjournalprinters,aregivenin
PrinterControlSequencesandRegistrySettingsonpage 529.

SetLeftMargin

Youcansettheindentationofprintcolumnsfromtheleftedgeof
thepapertothevaluegivenbythevariablefieldwiththefollowing
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-7

Printer Data
Printer Control Characters

controlsequence.Theformatofthevariablefieldisaone,twoor
threebyteASCIIvalueintherange000078.
Table 5-3
Set Left Margin Position

Character

Description

Number of
Characters

1BH5BH
(ESC)[

ControlSequenceIntroducer

Variable

Positionoftheleftmostprintcolumnfrom
theleftedgeofthepaper

70Hp

EscapeSequenceID

Theleftmarginsettingmustbeatleasttwolessthanthecurrent
rightmarginsettingorasquarebracketwillbeprinted.
Thesettingoftheleftmarginremainsuntilitiseitherchangedby
thiscontrolsequence,thepowersupplytotheprinteristurnedoff
oraresetoftheterminaliscarriedout.
Thisissupportedonthestatementprinterandthereceiptprinterin
sidewaysprintingmode.Thedefaultvalueis0.

SetRightMargin

Therightmarginfortheprintdataissetwiththefollowingcontrol
sequence.Theformatofthevariablefieldisaone,twoor
threebyteASCIIrepresentationoftheprintcolumnwithvalid
valuesintherange002080.
Table 5-4
Set Right Margin Position

Character

Description

Number of
Characters

1BH5BH
(ESC)[

ControlSequenceIntroducer

Variable

Positionoftherightmostprintcolumnfrom
column2

71Hq

EscapeSequenceID

Anattempttoprintbeyondtherightmarginwillresultintheextra
charactersprintingfromtheleftmargin.
Therightmarginsettingmustbeatleasttwogreaterthanthe
currentleftmarginsettingorasquarebracketwillbeprinted.
Thesettingoftherightmarginremainsuntilitiseitherchangedby
thiscontrolsequence,thepowersupplytotheprinteristurnedoff
oraresetoftheterminaliscarriedout.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-8

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Characters

Thisissupportedonthestatementprinterandonthereceiptprinter
insidewaysprintingmode.Thedefaultvalueis40forreceiptand
journalprintersand80forthestatementprinter.

PrinterIndependentMarginControl

Someprintersexpressmarginvaluesasdots,meaningthatthe
actualmarginisdependentontheresolutionoftheprinter.
AdvanceNDCprovidesasolutionthatisapplicabletoallprinters
andisnotdependentontheprinterresolution.
Theleftmargincontrolissetusingthespacecharacterofthe
standardfontsize,regardlessofthecurrentlyselectedfontsize.
Therightmarginissetbyinsertingalinefeedcharacteratthepoint
specifiedbytherightmargincontrol.

SelectOS/2CodePage

YoucanselectoneofthesupportedOS/2codepages(fordetails,see
theCodePagessectioninAppendix B,CharacterSets)withthis
controlsequence.OncetheOS/2codepageisselected,printdatain
therange20HtoFFHwillbeacceptedandprinted.
Table 5-5
Select OS/2 Code Page

Character

Description

Number of
Characters

1BH(ESC)

EscapeSequenceIndicator

25H%

EscapeSequenceID

3xH3yH
3zH

OS/2CodePageIdentifier

ValidvaluesforOS/2codepageidentifiersare000,437,850,851,
852,855,857,860,861,862,863,864and866.Ifaninvalidcodepage
issenttotheprinter,asquarebracketwillbeprinted.Codepage000
isauserdefineddownloadablecharactersetcodepage.Fordetails,
seetheDefineDownloadableCharacterSetsection.
Toreturntostandardcharactersetmode,usetheSelectCharacter
Setcontrolsequence.
Thisissupportedonthethermalreceiptandjournalprintersonly.

SelectInternationalCharacterSets

TheprinterhardwaresupportsbothInternationalandArabic
charactersetsandanapplicationcanmakeuseoftheInternational
setwiththiscontrolsequencewhichoverridesthecustomisation
switchsetting.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-9

Printer Data
Printer Control Characters
Table 5-6
Select International Character Sets

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

32H2

EscapeSequenceID

Thisisnotsupportedincodepagemodeonthethermalprinter.
Note1:WhenthiscontrolsequenceisincludedintheTransaction
Replyprinterdatastream,theprinterdefaultstoInternational
CharacterSet1.Ifprintingusinganothercharactersetisrequired
theSelectCharacterSetcontrolsequencemustalsobepresentinthe
printerdatastream.
Note2:Thiscontrolsequenceshouldnotbeincludedin
TransactionReplyprinterdatawhichistobeinterlacedwith
reservedscreenR01.Fordetails,seetheSimulatedPreprinted
ReceiptMessagessection.

SelectArabicCharacterSets

AnapplicationcanmakeuseoftheArabiccharactersetwiththis
controlsequencewhichoverridesthecustomisationswitchsetting.
Table 5-7
Select Arabic Character Sets

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

33H3

EscapeSequenceID

Thisisnotsupportedincodepagemodeonthethermalprinter.
Note1:WhenthiscontrolsequenceisincludedintheTransaction
Replyprinterdatastream,theprinterdefaultstoArabicCharacter
Set1.IfprintingusinganothercharactersetisrequiredtheSelect
CharacterSetcontrolsequencemustalsobepresentintheprinter
datastream.
Note2:Thiscontrolsequenceshouldnotbeincludedin
TransactionReplyprinterdatawhichistobeinterlacedwith
reservedscreenR01.Fordetails,seetheSimulatedPreprinted
ReceiptMessagessection.

PrintDownloadableBitImage
Printingdownloadablebitimagesissupportedusingeitherforms
orrawdataonUSBprinters,andrawdataonthermalreceiptand

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-10

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Characters

journalprinters(SDC)only.Thecontrolsequenceallowsa
predefinedbitimagetobeprintedinoneoffourformats,asfollows:

Table 5-8
Print Downloadable Bit Image

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

2FH/

EscapeSequenceID

3xH

1printbitimageone
2printbitimagetwo

3yH

0normalwidth,normalheight
1normalwidth,doubleheight
2doublewidth,normalheight
3doublewidth,doubleheight

Fordetailsofdefiningtheimagepriortoprinting,seeDefine
DownloadableBitImageonpage 516.
Ifthesizeoftheimagetobeprintedexceedsthewidthoftheline,
truncationwillbeused.Textandimage(s)cannotbemixedonthe
sameline.
Whendataispresentintheprinterbufferthiscommandisignored.
Itisthereforerecommendedthatalinefeedissentbefore
attemptingtoprintimages.
ThecontrolsequenceshouldnotbeincludedinTransactionReply
printerdatawhichistobeinterlacedwithreservedscreenR01.For
details,seetheSimulatedPreprintedReceiptMessagessection.
RawData ForUSBprintersifthereisnoimagefile,thepathand
filenameareprinted,forexample:

C:\Program Files\NCR APTRA\Advance


NDC\Media\LOGO1.LGO

Ifthereisnodefinitionfile,nothingisprinted.
ForSDCprinters,ifthereisnoimagefile,thepathandfilename
aloneareprinted,witharightsquarebracket]beforeandafter,for
example:
]C:\Program Files\NCR APTRA\Advance
NDC\Media\LOGO1.LGO]

Ifthereisnodefinition,justarightsquarebracketisprinted
Forms ThebitmapimageisregisteredbyANDCusingtheDefine
DownloadableBitImageandprintedusingPrintDownloadableBit
Imagebyprintingaformwiththegraphic.Ifthereisnofile,the
5

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-11

Printer Data
Printer Control Characters

pathandfilenameareprintedwitharightsquarebracket]before
andafter,forexample:
]C:\Program Files\NCR APTRA\Advance
NDC\Media\LOGO1.LGO]

Ifthereisnodefinition,onlyarightsquarebracketisprinted

PrintBarcode

Barcodeprintingissupportedusingrawdataonly.Youcanprinta
barcodefortheASCIIcharacterspresentinthestringwiththe
controlsequenceshowninTable 59onpage 512.
Table 5-9
Print Barcode

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

6BHk

EscapeSequenceID

3xH

TypeofBarcode
0UPCA
1UPCE
2JAN13(EAN)
3JAN8(EAN)
4Code39
5Interleaved2of5
6Codabar

<ASCII
data>

ASCIIcharacterstobeprintedasbarcodes

Variable

1BH5CH
(ESC)\

ControlSequenceTerminator

Theprinterservicesoftwarewillcalculatethecheckdigitforthe
UPCandJAN(EAN)codesifitisnotsentfromthehost.Itwillalso
generatesixcharacterzerosuppressedUPCEtagsfromfull11or
12characterssentfromthehostaccordingtostandardUPCErules.
Whendataispresentintheprinterbufferthiscommandisignored.
Itisthereforerecommendedthatalinefeedissentbefore
attemptingtoprintbarcodes.
ThiscontrolsequenceshouldnotbeincludedinTransactionReply
printerdatawhichistobeinterlacedwithreservedscreenR00or
R01.Fordetails,seetheSimulatedPreprintedReceiptMessages
section.
Ifthehorizontalsizeexceedsoneline,theexcessdataisnotprinted.
Barcodepositionalinformation,forexample,theprintingposition
ofhumanreadableinterface(HRI)charactersandthewidthand
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-12

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Characters

heightofthebarcodemustbedefinedinthedownloadablereserved
Kscreenspriortoattemptingtoprint.

PrintGraphics

BitmapscanbeprintedusingformsorrawdataonUSBprinters,
andrawdataonthermalprinters.

ThecontrolsequenceletsyouprintapreloadedEpsonprinter
graphicsfile.EpsonprintergraphicsfilesarestandardEpson
graphicsdatafilesformattedfortheEpsonLQ950printer.The
printerresolutionshouldbesetat120180dotsperinch.
Thefollowingcontrolsequenceisusedtoprintthistypeoffile:
Table 5-10
Print Graphics

Character

Description

Number of
Characters

1BH

ESC

PrivateuseEscapeSequence
Indicator

47H

EscapeSequenceID

Nameoffilewithgraphicsdata

Variable

ControlSequenceTerminator

<filename>
1BH5CH

ESC\

TheformatfortheEpsongraphicsfileisdescribedinthe
ProgrammersManualforthe40ColumnPrinter(B0064612).
Whendataispresentintheprinterbuffer,thiscommandisignored.
Therefore,NCRrecommendsthatalinefeedissentbefore
attemptingtoprintgraphics.
Thegraphicsfilecanbegeneratedusinganysoftwarepackage
whichsupportstheEpsonprinterdriver.Thedefaultpathnamefor
thefiledefinedinthecontrolsequenceshouldbedefinedinthe
downloadablereservedK07screen.
ThiscontrolsequenceshouldnotbeincludedinTransactionReply
printerdatawhichistobeinterlacedwithreservedscreenR01.For
details,seetheSimulatedPreprintedReceiptMessagessection.
RawData Ifthegraphicsfileismissing,thefilenameandpathare
printed,forexample,
5

C:\Program Files\NCR APTRA\Advance


NDC\Media\GRAPHIC.PRN

Forms Forformsbasedprinting,anypredefinedextension,such
as.prn,isconvertedto.bmp.Theextensionisdefinedinthe
followingregistryentry:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-13

Printer Data
Printer Control Characters
HKLM\SOFTWARE\NCR\Advance
NDC\PRINTING\FORMS_GRAPHICS_EXT

Ifthefileismissing,thefilenameandpathareprintedwitha.bmp
extension,forexample:
C:\Program Files\NCR APTRA\Advance
NDC\Media\GRAPHIC.BMP

Ifnoextensionisset,theoriginalextensionisprinted,forexample:
C:\Program Files\NCR APTRA\Advance
NDC\Media\GRAPHIC.PRN

PrintChequeImage

Chequeimagescanbesizedandrotated,andthecodelinecanbe
maskedifthechequeistobeprintedonthereceipt.
Chequeimagesareprintedonthermalreceiptprintersusingeither
formsandbitmapsforUSBprintersor,forprintingfromrawdata,
theEpsonGraphicsformat.Fordetails,seePrintGraphicson
page 513.
Printingcanbeusedtoprocessandprinttherequiredchequeimage
onthereceiptprinterusingthecontrolsequencedescribedin
Table 511.

Table 5-11
Print Cheque Image

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

70Hp

EscapeSequenceID

<side>

Whethertoprintthefrontorbackofthe
cheque
0front
1back

<codeline
control>

Howthecodelineisprinted
0Printtheimageofthechequewithno
alterations.Thismustbeusedwhenprinting
thebackofthecheque
1Printanimageofthechequewiththe
codelineblackened
2Printanimageofthechequewiththe
codelineremoved.

Note:ForPADSScompliance,thecodeline
controlvariablemustbesetto1or2if
<side>issetto0

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-14

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Characters
Number of
Characters

Character

Description

<image
selector>

Indexidentifyingtheimagetoprint.Thisis
anindexwithinthelistofimagesrequested
foreachcheque
Ifthisfieldisnotpresent,onlythefirst(or
theonly)imageisprinted

<cheque
ID>

Thechequeidentifier.Thisisthesame
chequeidentifierusedinthecgxfieldsof
theTransactionRequestandthebbxfields
oftheTransactionReply
Ifthisfieldisnotpresent,theimageofthe
lastchequeprocessedisprinted

1BH5CH
(ESC)\

ControlSequenceTerminator

DefineDownloadableCharacterSet

Thiscommanddefinesandenterscharactersintothememoryarea
oftheprinter.Twomodesofoperationareavailable,standardand
compressed.Standardmodeconsistsofcharactersrepresentedbya
charactercellsizeof11horizontalbitsby16verticalbits(atotalof
22bytespercharacter).Compressedmodeconsistsofcharacters
storedasacharactercellof8horizontalbitsby16verticalbits(a
totalof16bytespercharacter).NCRrecommendsusingstandard
modeonly.
Table 5-12
Define Downloadable Character Set

Character

Description

Number of
Character
s

1BH(ESC)

PrivateuseEscapeSequenceIndicator

26H&

EscapeSequenceID

<filename>

Nameoffilewiththedatafortheselected
characterset

Variable

1BH5CH
(ESC)\

ControlSequenceTerminator

TheformatforthefilenameisdescribedintheProgrammersManual
forthe40ColumnPrinter(B0064612).
Thiscommandcanbeusedtooverwritesinglecharacters.Theuser
definedcharactersareavailableuntilpowertotheprinteristurned
offoraresetoftheterminaliscarriedout.Thiscontrolsequenceis
definedinKReservedScreenK08.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-15

Printer Data
Printer Control Characters

Thiscontrolsequenceissupportedonthermalreceiptandjournal
printersonly.

DefineDownloadableBitImage

Youcanusethiscontrolsequencetodefineanddownloadabit
imagetotheprinter.TheimagecanthenbeprintedusingthePrint
DownloadableBitImagecontrolsequencewithoutresendingthedata.
Table 5-13
Define Downloadable Bit Image

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

2AH*

EscapeSequenceID

Var

1Definebitimageone
2Definebitimagetwo

<ASCII
filename>

Nameoffilewiththedatafortheselectedbit
image

Variable

1BH5CH
(ESC)\

ControlSequenceTerminator

Thiscontrolsequenceissupportedonthermalreceiptandjournal
printersonlyandisdefinedinKReservedScreensK09andK10.
TheformatforthefilenameisdescribedintheProgrammersManual
forthe40ColumnPrinter(B0064612).
Onelargebitimagecanbedefinedandprintedortwosmallerbit
imagescanbedefinedandprinted.Ifonebitimageisrequiredthen
themaximumbitimagedatalengththatcanbesentis17920bytes,
thatisbitimage1.Iftwobitimagesarerequiredthenthemaximum
bitimagedatalengthofeachis8960bytes,thatisacombinedtotal
of17920bytes.
Defininganewbitimageerasesthepreviousone.Thedownloaded
imageisavailabletotheapplicationuntilitisoverwrittenorpower
totheprinteristurnedoff,unlesstheprinterisaUSBthermal
printer.AUSBprinterretainsbitimageswhenpoweredoff.Areset
oftheterminaldoesnoterasetheimage.

SelectPrintingPositionofHRICharacters

Thiscontrolsequencedefinesthelocationofhumanreadable
interface(HRI)charactersinASCIIcharacterformatwithrespectto
thebarcodetheyrepresent.Thesettingremainsuntileitheritis
changedbythiscontrolsequence,powertotheprinteristurnedoff
oraresetoftheterminaliscarriedout.
ThebarcodecanbeprintedusingthePrintBarcodecontrolsequence
withoutresendingthepositionalinformation.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-16

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Characters

ThiscontrolsequenceisdefinedinKReservedScreensK09and
K10.
Table 5-14
Select HRI Character Printing Position

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

65He

EscapeSequenceID

Var

Printingposition
1notprinted(default)
2abovethebarcode
3belowthebarcode
4bothaboveandbelowthebarcode

Thisissupportedonthermalreceiptandjournalprintersonly.

SelectWidthofBarcode

ThisdefinesthebarcodeminimumwidthinASCIIformattondots
orn/150withvalidvaluesofnbeing2,3and4.
Table 5-15
Select Barcode Width

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

77Hw

EscapeSequenceID

Var

Barcodeminimumwidth

Thesettingremainsuntileitheritischangedbythiscontrol
sequence,powertotheprinteristurnedofforaresetoftheterminal
iscarriedout.Thedefaultsettingis3.
ThebarcodecanbeprintedusingthePrintBarcodecontrolsequence
withoutresendingthepositionalinformation.
ThiscontrolsequenceisdefinedinKReservedScreensK09and
K10.
Thisissupportedonthermalreceiptandjournalprintersonly.

SelectHorizontalHeightofBarcode

Thiscontroldefinesthebarcodeheight,asthreeASCIIcharacters,in
dotsorn/150withvalidvaluesofnintherange001255.The
controlissupportedonlyonthermalreceiptandjournalprinters.
Forformsbasedprinting,thiscontrolsequenceisignoredasthe
heightofthebarcodeisfixed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-17

Printer Data
Printer Control Characters
Table 5-16
Select Barcode Horizontal Height

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

68Hh

EscapeSequenceID

Var

BarcodeHeight

Thesettingremainsuntileitheritischangedbythiscontrol
sequence,powertotheprinteristurnedofforaresetoftheterminal
iscarriedout.Thedefaultsettingis162.
ThebarcodecanbeprintedusingthePrintBarcodecontrolsequence
withoutresendingthepositionalinformation.
ThiscontrolsequenceisdefinedinKReservedScreensK09and
K10.

SelectDualsidedPrinting

OnSelfServSSTs,thiscontrolsequencecanbeusedtoprinton
twosidedpaper.
Table 5-17
Select Dual-sided Printing

Character

Description

Number of
Characters

1BH(ESC)

PrivateuseEscapeSequenceIndicator

71Hq

EscapeSequenceID

Var

0Printonfrontofpaper
1Printonbackofpaper

ThisprintercontrolissupportedonlyonUSBreceiptandstatement
printers.Iftheprinterdoesnotsupportdoublesidedprinting,or
twosidedpaperisnotloaded,thissettingisignored.Atstartof
day,printingdefaultstothefrontofthepaper.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-18

APTRA Advance NDC, Reference Manual

Printer Data
Character Sets

CharacterSets

ForformsbasedprintingonUSBprinters,AdvanceNDCsupports
theAlpha1toAlpha6andArabic1toArabic6charactersetswith
providedWindowsfontfiles.Ifyouneedtocreateyourownfonts,
NCRrecommendsyoucreateWindowsfontfiles.Ifyourequire
supportforthis,contacttheNCRProductManager.
Forprintingrawdata,theUSBreceiptandUSBjournalprinters
supportthesamecharactersasthereceiptandjournalprinters.
However,thisisachievedusingamappingfile,astheUSBReceipt
andJournalprintersusecodepagestodefinethecharacters.For
detailsofthemappingfile,seeMappingFilesonpage B8.
TheSDCandRS232receiptandjournalprinterssupportas
standardthefirst96charactersfromthesingleanddoublesize
alphanumeric1characterset.
ThePPDenvelopeprintersupportsthesinglesizealphanumeric1
characterset(96characters).
Thestatementprintersupportsasstandardthefullsingle,double
andcondensedalphanumericsets1,2,4and5,plusasingle,double
andcondensedalphanumericset3comprisingthelast32characters
ofbothalphanumericsets1and2,plusthelast32charactersfrom
set5.Italsosupportsthefull12cpialphanumericsets1to5.
Thefollowingcharactersetdesignatorsareavailable:
Table 5-18
Character Set Designators

Designator

Characters
Per Inch

Character Set

10

Singlesizealphanumeric1

10

Singlesizealphanumeric2

10

Singlesizealphanumeric3

>

Doublesizealphanumeric1.
SeeTableNote1.

Doublesizealphanumeric2.
SeeTableNote1.

Doublesizealphanumeric3.
SeeTableNote1.

17

Condensedalphanumericset1(statement,
thermalreceiptinsidewaysprintonly)

17

Condensedalphanumericset2(statement,
thermalreceiptinsidewaysprintonly)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-19

Printer Data
Character Sets

Designator

Characters
Per Inch

17

Condensedalphanumericset3(statement,
thermalreceiptinsidewaysprintonly)

12

12cpisizealphanumeric1(statementonly)

12

12cpisizealphanumeric2(statementonly)

12

12cpisizealphanumeric3(statementonly)

10

Singlesizealphanumeric4

10

Singlesizealphanumeric5

Doublesizealphanumeric4.
SeeTableNote1.

Doublesizealphanumeric5.
SeeTableNote1.

17

Condensedalphanumericset4(statement,
thermalreceiptinsidewaysprintonly)

17

Condensedalphanumericset5(statement,
thermalreceiptinsidewaysprintonly)

12

12cpisizealphanumeric4(statementonly)

12

12cpisizealphanumeric5(statementonly)

10

Singlesizealphanumeric6(euro)

Doublesizealphanumeric6(euro)
SeeTableNote1.

17

Condensedalphanumeric6(euro)
(statement,thermalreceiptinsidewaysprint
only)

Character Set

TableNote1:Doublesizesetsarenotsupportedbythereceipt
printerinsidewaysprintingmode,andreceiptofthesedesignators
willnotchangethecurrentselectedcodeset.
ThestatementprintercontainsasetofArabiccharactersetsthatcan
beselectedinsteadofthestandardsetsbyahardwareswitchonthe
printer.Refertotherelevantprintermanualforthehardware
switchsettings,orcontactyourlocalNCRrepresentative.
WhenaSelectCharacterSetcontrolsequenceappearsintheprinter
data,thecharactersthatfollowareinvokedusingthespecifieddata
charactersetuntilasubsequentselectcharactersetcontrolsequence
appears.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-20

APTRA Advance NDC, Reference Manual

Printer Data
Character Sets

Forreceiptandjournalprinters,thecharactersetdefaultstosingle
sizealphanumeric1attheendoftheprinterdatafield,untilanother
SelectCharacterSetcontrolsequenceappears.
Forthestatementprinter,thecharactersetselectedisuseduntil
anotherSelectCharacterSetsequenceappears,althoughthe
charactersetmaybechangedbydiagnosticoperations.NCR
recommendsthatthecharactersetisselectedatthestartofeach
statement.
Forthedefaultcharactersetsprovidedoncardholderscreensand
printers,seeAppendix B,CharacterSets.

PrimaryPrintPage

Thedefaultcharactersetforallprintersisthesinglesize
alphanumeric1set.ASCIIcharactersintherange207Fhexinvoke
charactersfromaset.Alternativecharactersetsareselectedusing
thefollowingsequence:
Table 5-19
Select Primary Print Page

Character

Description

Number of
Characters

1BH(ESC)

PrivateUseEscapeSequenceIntroducer

EscapeSequenceID

Variable

CharacterSetDesignator

SecondaryPrintPage

Thedefaultcharactersetisthesinglesizealphanumeric1set.ASCII
charactersintherange207Fhexinvokecharactersfromaset.
Alternativecharactersetsareselectedusingthefollowingsequence:
Table 5-20
Select Secondary Print Page

Character

Description

Number of
Characters

1BH(ESC)

PrivateUseEscapeSequenceIntroducer

EscapeSequenceID

Variable

CharacterSetDesignator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-21

Printer Data
Statement Printer Controls

StatementPrinterControls

Thefollowingcontrolsequencesapplytothestatementprinter
specifically:

LeftMarginControl

Table 5-21
Set Left Margin (Statement Printer)

Leftmargincontrol
Rightmargincontrol
Margincontroluse
Lines/inchcontrol.

Thiscontrolsequencegivesthecolumnwheretheprintheadis
positionedfollowinganLFcharacter.Thedefaultvalueis0.
Description

Number of
Characters

ControlSequenceIntroducer

<ASCIIDATA>

Columnnumberrange
From000to(rightmargin4)

Var(13)

70H

Functiondefiningcharacter

Character

1BH
(ESC)

5BH
[

WhenaSetLeftMargincontrolsequenceappearsintheprinter
data,allthesubsequentLFcontrolcharactersreturntheprinthead
tothecolumnspecified,untilthenextSetLeftMargincontrol
sequenceisreceived.Whenthecontrolisreceived,thespecified
columnisdefinedforthecharacterset.

RightMarginControl

Table 5-22
Set Right Margin (Statement Printer)

Thiscontrolsequencegivesthecolumnpositionfortheright
margin.ThisisthecolumnatwhichanautomaticLFisperformed.
Thedefaultvalueis80.
Description

Number of
Characters

ControlSequenceIntroducer

<ASCIIDATA>

Columnnumberrange
From(leftmargin+4)to132

Var(13)

71H

Functiondefiningcharacter

Character

1BH
(ESC)

5BH
[

WhenaRightMarginControlsequenceappearsintheprinterdata,
allsubsequentprintingcausesanautomaticLFifprintingis

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-22

APTRA Advance NDC, Reference Manual

Printer Data
Statement Printer Controls

attemptedbeyondthespecifiedcolumnnumber.Thecontrolstays
ineffectuntilthenextRightMarginControlsequenceisreceived.
Whenthecontrolisreceived,thepositionisdefinedforthe
characterset.Excessivevaluesofthecolumnnumberareignored,
andtheprevioussettingremainsoperative.

MarginControlUse

ThemarginsareunderthecontrolofCentral.Whenleftandright
margincontrolsareused,theymustbeincludedinthedataforthe
statementprinterbeforeanyprintablecharactersonthecurrentline.
Iftheyarenot,thenewmargindoesnottakeeffectuntilthenext
line.Theyshouldbesentforeachstatementprinted,asthemargins
canbechangedbySupervisordiagnosticfunctions.
Whenthecontrolsarereceived,themarginsaresettothecolumn
positionintheselectedcharacterset.Theyarenotaffectedby
subsequentcharactersetchanges.Therightmarginsettingmust
remainwithinthepaperwidth,orprintheaddamagemayoccur.

LinesPerInchControl
Table 5-23
Switch Lines Per Inch (6/8)

Thiscontrolsequenceprovidesyouwiththecapabilityofswitching
betweensixandeightlinesperinch.Thedefaultvalueiseight.
Description

Number of
Characters

ControlSequenceIntroducer

<ASCIIDATA>

Linesperinchselectorrange(from00
to03)

72H

Functiondefiningcharacter

Character

1BH
(ESC)

5BH
[

Whenalinesperinchcontrolsequenceisreceived,linespacingon
thenextexplicitorautomaticLFcharacterassumesthespecified
value.Thiscontinuesuntilthenextlinesperinchcontrolsequence
isreceived.Legalvaluesareasfollows:
Table 5-24
Line Spacing Values

Value

Spacing
(Lines/Inch)

00

01

02

03

Othervaluesareignored.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-23

Printer Data
Simulated Pre-printed Receipt Messages

SimulatedPreprintedReceipt
Messages

ScreennumbersR00R01arereservedforsimulatedpreprinted
receiptmessages.Thesimulatedpreprintdatacanbedownloaded
asasetofreservedscreens.Thesecanbeinterlacedwithreceipt
printertextsentinaTransactionReplyCommandmessage.
Note:WhenscreenR00isusedtodefineimagestobeprintedon
thethermalreceiptprinter,theapplicationisnotawareofthesizeof
theimageorthenumberofprintlines.PrintingofR01and/or
TransactionReplyprintdatawillbeginonthelineaftertheimage
definedinR00.Therefore,ifthenumberoflinesofdataplusthe
numberoflinesusedbytheimageexceedstheconfiguredform
length,thedatawillbeprintedontwoormorereceipts.

ScreenR00containsthereceiptheader.Thiscantaketheform
oftexttobeprintedorcancontainthecontrolsequencewhich
instructsthethermalreceiptprintertoprinttheimagedefined
inthecontrolsequence.Thecontrolsequenceisdefinedin
PrintDownloadableBitImageonpage 510.
Thistextorimageisprintedatthetopofthereceipt,beforeany
printtext.Printingstartsonthefirstavailableprintline.
Subsequentprintingoccursonthefirstblanklineafterthe
preprintheader.Ifareceiptiscutattheendofatransactionthe
headerisprintedbeforeauthorisationofthenexttransactionto
speeduptransactiontime.ThereforethereservedscreenR00is
notsupportedinsidewaysprintingmodeandshouldnotbe
downloadedtoaterminalwhichwillbeusedforsideways
printingonthereceipt.

ScreenR01containsthepreprinttexttobeinterlacedwith
printtextfromCentral.Theprinttextiseffectivelyoverlaidline
bylineonthepreprinttexttoproducethefinalprint(printtext
takespriority).
Thefollowingcontrolsequencesshouldnotbeincludedinthe
printerdatatobeinterlacedwithscreenR01sentinthe
TransactionReply:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-24

APTRA Advance NDC, Reference Manual

Printer Data
Simulated Pre-printed Receipt Messages
Table 5-25
Invalid Control Sequences for Screen R01

Character

Description

1BH32H

SelectInternationalCharacterSets

1BH33H

SelectArabicCharacterSets

1BH2FH3xH3yH

PrintDownloadableBitImage

1BH6BH3xH<ASCII
Data>1BH5CH

PrintBarcode

1BH47H<filename>
1BH5CH

PrintGraphics

ScreenR01isnotsupportedinsidewaysprintingmode.
ThisfeatureallowsblankstationerytobeusedwithaCentral
applicationprogramthatwasoriginallydesignedtooperatewith
preprintedstationery.Anotheruseofthesescreensistoalignthe
firstprintlinewithpreprintedheaders.Thisisdonebybuilding
screenR00withtherequirednumberofLF(linefeed)controls.
Thesereservedscreensmustbeconstructedwithnormalprinter
messagecharactersandcontrols.
Thefollowingexampleshowstheinterlacingofthesimulated
preprinttextscreensandthetextreceivedfromCentralina
TransactionReplyCommandmessage.
Figure 5-1
Screen Text Interlacing

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-25

Printer Data
Simulated Pre-printed Receipt Messages

Thefollowingexampleshowsthedatacodingforthescreens.
Table 5-26
Screen R00 Data

Screen R00 Data

Print Line

(SO)4FIRSTFINANCIAL(LF)

(LF)

(LF)

DATE(SO)6TIME(SO)6MACHINE(LF)

Table 5-27
Screen R01 Data and Interlaced Data from
Central

Screen R01 Data

Interlaced Data from Central

Print Line

(LF)

25019112:00001(LF)

(LF)

(LF)

(LF)

(LF)

ACCOUNTNUMBER(LF)

(LF)

(LF)

12345678(LF)

(LF)

(LF)

10

(LF)

(LF)

11

CODESERIALAMOUNT(LF)

(LF)

12

(LF)

10(SO)61233(SO)6$20.00(LF)

13

(LF)

(LF)

14

CODESERIALAMOUNT(LF)

(LF)

15

(LF)

11(SO)61234(SO)6$150.00(LF)

16

(LF)

(LF)

17

THANKYOU(LF)

18

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-26

APTRA Advance NDC, Reference Manual

Printer Data
Simulated Pre-printed Receipt Messages

Thefollowingdiagramshowsanexampleofthefinalreceipt
produced.
Note:

Lines14containdatafromScreenR00
Lines8,12,15and18containdatafromscreenR01
Lines5,9,13and16containdatafromCentral

Figure 5-2
Final Simulated Pre-printed Receipt
Line 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Note:Ifformfeedcontrolsareused,thefollowingwilloccur:

Ifthehostdatacontainsaformfeedcontrol,anyremaining
dataintheR01screenisaddedbeforethepagebreak.Screen
R00isprintedonthesecondandsubsequentreceiptswhen
producedbythesameprintcommand.
IfscreenR00containsanyformfeedcharacters,theseare
convertedtospacesbeforethescreendataisprefixedtothe
hostdata.
IfscreenR01containsanyformfeedcharacters,any
remaininghostdataisaddedbeforetheformfeed.Any
remainingdatafromtheR01screenoccurringaftertheform
feedcharacterisnotprinted.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-27

Printer Data
Sideways Printing on Receipt

SidewaysPrintingonReceipt

Sidewaysprintingonthereceiptprinteriscontrolledthroughthe
useoffunctionidentifiersP(PrintStatementandWait)andQ
(PrintStatementandSetNextState)inconjunctionwiththeprinter
flag=intheTransactionReplymessagesentfromCentral.For
details,seetheTransactionReplyCommandsectionin
Chapter 10,CentraltoTerminalMessages.
Youcansettheleftandrightmarginsofprinterdatatobeprinted
sidewaysonthereceiptprinterbyusingtheSetLeftMarginandSet
RightMargincontrolsequencesdescribedinthischapter.See
EnhancedPrinterControlCodesonpage 57.
Whenprintinginsidewaysmodeonthereceiptprinter,the
maximumconfigurationofacustomerreceiptis80columnsby20
lines.WherethedatasentfromCentralcausesthislinecounttobe
exceeded,thesidewaysstatementiscutafter20linesandthe
remainingdataprintedonthenextstatement(s).

UnsupportedFunctions

Thefollowingarenotsupportedinsidewaysprintingmode:
5

Printingofimages,graphicsanddoublesizecharacters
PrintingonthereceiptprinterinSupervisormode
PrintingontheUSBReceiptprinter
ReservedscreensR00andR01;thesescreensshouldnotbe
downloadedtoanSSTthatwillbeusedforsidewaysprinting
onthereceiptprinter.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-28

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Sequences and Registry Settings

PrinterControlSequencesand
RegistrySettings

Thefollowingtableprovidestheprintercontrolandrelatedregistry
settingsforreceiptandjournalprintersonPersonasSSTswith
equivalentregistrysettingsforUSBprintersonSelfServSSTs.
Theprintercontrolcodesreceivedfromthehostarethesameasthe
registryvaluesspecifiedforprintersonPersonasSSTs.
Detailsaregivenforreceiptprinters.Adash()meansthevalueis
notset.Differencesforotherprintersareindicatedunderthecontrol
codeasfollows:

Adollarsign($)=thevalueisnotsetforthejournalprinter
Avalueinbrackets=adifferentvalueforthejournalprinter
Anasterisk(*)=thevalueisnotsetfordotmatrixreceipt
printers
Anampersand(&)=thevalueisnotsetfordotmatrixjournal
printers

Table 5-28
Printer Control Sequences and Registry
Settings
Control

NDC Control Code


(Hex)

Registry Name

USB Control Code


(Hex)

Header

HEADER

Sequenceaddedbefore
anyprintdata.
Thesequenceisnot
processedbyAdvance
NDC,andmust
thereforeusethe
printersnativeescape
sequences

Footer

FOOTER

Sequenceaddedafter
anyprintdata.
Thesequenceisnot
processedbyAdvance
NDC,andmust
thereforeusethe
printersnativeescape
sequences

Linefeed
character

0D

LINE_FEED

0A

Variable Description

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-29

Printer Data
Printer Control Sequences and Registry Settings
NDC Control Code
(Hex)

Registry Name

USB Control Code


(Hex)

Variable Description

0C

FORM_FEED

1D54191B46

Carriagereturn
character

0D

CR

0A

Horizontaltab
character

09

HT

09

Setleftmargin

1B5Bvar70

LEFT_MARGIN

1D4Cbvar

Columnpositionofthe
leftmargininstandard
characters,typically
between1and39

Control

Formfeed
character
SeeTableNote2

SeeTableNote3

SeeTableNote4

FortheUSBReceiptand
Journalprinters,thisis
thecolumnpositionof
leftmarginindots
Setrightmargin

1B5Bvar71

RIGHT_MARGIN

Columnpositionofthe
rightmargininstandard
characters,typically
between1and39

SelectOS2code
page

1B25var

OS2_CODE_PAGE

1B25bvar

Codepagenumber

Copycodepage
toRAM

1B3Avar

COPY_CODE_PAGE

1B3A30bvar30

Codepagenumber

Select
international
characterset

1Bvar

INTR_CHAR_SET

1Bvar

ARAB_CHAR_SET

1B2Fvar
&

BIT_IMAGE

1D2Fbvar

Bitimageidentifier/bit
imagesize

SeeTableNote3
SelectArabic
characterset
SeeTableNote3
Print
downloadedbit
image

SeeTableNote5
FortheUSBReceiptand
Journalprinters,thisis
bitimagesize

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-30

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Sequences and Registry Settings

Control

Printbarcode

NDC Control Code


(Hex)

1B6Bvar1B5C
&

Registry Name

USB Control Code


(Hex)

BARCODE

1D6Bbvar

Variable Description

Barcodetypeand
barcodedata
FortheUSBReceiptand
Journalprinters,thisis
barcodetype(tvar),
length(lvar),anddata
(dvar).SeeTable 530on
page 535fordetails

1B47var1B5C
*&

GRAPHICS

bvar

Pathandnameof
graphicsfile.

Printlastimage
processed
SeeTableNote6
andTableNote
7

1B47var1B5C
$*&

CHEQUE

bvar
$

Sideofchequetoprint
andhowthecodelineis
printed

Selectprimary
charactersetG0

0F

SHIFT_IN

Selectsecondary
charactersetG1

0E

SHIFT_OUT

Selectcharacter
setasactiveset
G0

1B28var

CHAR_SET1

Charactersetnumber

Selectcharacter
setasactiveset
G1

1B29var

CHAR_SET2

Charactersetnumber

Definecharacter
set

1B26var1B5C

DEF_CHAR_SET

var

Path/filenamecontaining
thecharacterset
definition

1B2Avar1B5C
&

DEF_BIT_IMAGE

1D 23 bvar

BitimageIDandthe
path/filenamecontaining
thedefinition

Printgraphics
file
SeeTableNote8

SeeTableNote
13
Definebitimage

SeeTableNote5

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-31

Printer Data
Printer Control Sequences and Registry Settings

Control

NDC Control Code


(Hex)

Registry Name

USB Control Code


(Hex)

Variable Description

Positionof
humanreadable
characters
(forbarcode)

1B65var
*&
SeeTableNote
11

POS_HRI_CHAR

1D48bvar

Positionofcharacters

1B68var
*&

HZ_HGHT_BARCODE

1D 68 bvar

Heightindots

1B77var
*&

WIDTH_BARCODE

1D 77 bvar

Widthindots

1B5Bvar73

SET_FORM_LEN

1B 62 bvar

Lengthofforminrows

Cut
(andfeedon
someprinters)

11

CUT

1D 54 19 1B
46

Sidewaysmode
on

1D

SW_ON

Sidewaysmode
off

1E

SW_OFF

Verticaltab

0Bvar

VERT_TAB

14bvar

Numberoflinesto
advance

Setextradot
rows

1B5Bvar72

EXTRA_DOT_ROW

16bvar

Numberofextrarows

1B5Bvar74

LINE_SPACE

1B33bvar

Linespacing

SeeTableNote12

SeeTableNote9
andTableNote
10
Heightof
barcode
SeeTableNote
13
Widthof
barcode
SeeTableNote
13
Formlength
SeeTableNote
14

SeeTableNote
15
Setlinespacing
SeeTableNote
16

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-32

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Sequences and Registry Settings
NDC Control Code
(Hex)

Registry Name

USB Control Code


(Hex)

Variable Description

Setfirstline
position

1B5Bvar75

FIRST_LINE_POS

1B65bvar

Firstlineposition

Selectprint
mode

PRNT_MODE

1B21var

Printmodevalue

Selectlogo

SELECT_LOGO

1D23bvar

Bitmapidentifier

Control

TableNote2:Thisformfeedcontrolcombinestheformfeed(1D
54),thecut(19)andthepresent(1B46)controlcodessothatit
providesthesamefunctionalityastheoriginalformfeedcontrol
(0C).
TableNote3:Thisissupportedatapplicationlevelforallprinters.
TheUSBReceiptandJournalprinterssupportcodepagesthatdiffer
fromthoseusedbyotherprinters,butcontainthesamecharacters.
AdvanceNDCprovidesamappingfilesothateachcodeiscorrectly
mappedandapplied.Fordetailsofthemappingfile,seeMapping
FilesinAppendix B.
Whetheramappingfileischeckedforacorrespondingsectionisset
usingtheregistry.WhenthehostrequestsanArabicor
Internationalcharactersetandamappingfileistobechecked,the
correspondingsectionislocatedinthemappingfile.Iffound,the
specifiedcharactersetisused,otherwisethecontrolsequenceissent
directlytotheprinter.
TableNote4:Thisisusedonlyforpositioningbitimagesforthe
USBReceiptandJournalprinters,theNDCCodeisusedforsetting
theleftmarginforprintabledata.
TableNote5:ForUSBreceiptandjournalprinters,monochrome
bitmap(.bmp)filesforbothformsbasedandrawdataprintingare
supported.Themonochromebitmapisregisteredordownloaded
usingtheDefineDownloadableBitImagecontrolsequence.Itcan
thenbeprintedusingthePrintDownloadableBitImagecontrol
sequence.Ifthefileisnotfoundinthespecifiedlocation,thepath
andfilenameareprintedasdescribedinPrintDownloadableBit
Imageonpage 510.
TableNote6:Thisregistrysettingisusedevenwhenthehost
downloadsthe1B5Cvar1B5Ccode.ThisisbecausethePrint
Graphicscontrolsequenceisusedtoprintchequeimagegraphics
regardlessofthetypeofprinterinuse.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-33

Printer Data
Printer Control Sequences and Registry Settings

TableNote7:Thevariabledatafortheprintchequeimagecontains
thefollowinginformation.Forthereceiptprinter,theprintercontrol
sequencemustbeplacedwithinthePrinterDatafield,notatthe
beginningorend.
Table 5-29
Print Cheque Image Variable Data

Variable

Description

Chars

<side>

Selectsthefrontorbackofthechequetobe
printed.
Valuescanbeasfollows:

0forfrontimage

1forbackimage

<codeline
control>

Defineshowthecodelineisprinted.Values
canbeasfollows:

0toprintthenormalimageofthe
cheque;thismustbeusedifsideissetto
1

1toprintanimageofthechequewith
thecodelineblackedout

2toprintanimageofthechequewith
thecodelineremoved

Note:ForPADSScompliance,thecodeline
controlvariablemustbesetto1or2if
<side>issetto0

TableNote8:Bitmapsaresupportedforformsbasedprintingon
USBreceiptandjournalprintersForprintingrawdataonUSB
receiptorjournalprinters,thegraphicmustbeconvertedtoa.prn
file.Forfurtherinformation,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
TableNote9:Thedefaultsettingisemptysoitisnotprocessed
TableNote10:Becauseofresolutiondifferences,thebarcodewill
beadifferentsizeontheUSBReceiptprinter.
TableNote11:Ifthebarcodedoesnotfitontheline,apartial
barcodeisprinted
TableNote12:Ifthebarcodedoesnotfitontheline,thebarcodeis
notprinted
TableNote13:TheUSBReceiptandJournalprintersusea
resolutionof203dpiratherthan150dpi.Toadjustyourexisting
charactersetsforthischange,seeUSBPrintersandDownloadable
CharacterSetsinAppendix B.Ifmorethan188dotsarespecified,
theUSBReceiptandJournalprinterswillnotbeabletoreproducea
barcodeofthesamesizeasotherthermaljournalorreceiptprinters.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-34

APTRA Advance NDC, Reference Manual

Printer Data
Printer Control Sequences and Registry Settings

TableNote14:Thereceiptlengthisthenumberoflinestobe
printed.Maximumandminimumlengthsarestatedininches.The
defaultrangeisaminimumofeither4.4inchesor3inchesanda
maximumof7.5inches.USBReceiptandJournalprintersignore
anythingoutsidethesetrange.Otherprintersresettheformlength
appropriately.
TableNote15:TheEXTRA_DOT_ROWcontrolsequencedepends
onprinterresolution.Toproduceaconsistentspacebetweenlines,
NCRrecommendsusingtheLINE_SPACEcontrolsequence
instead.
TableNote16:AdvanceNDCsetsthelinespacinginstepsofn/144
inchtoensurethatlinespacingisnotaffectedbydifferencesin
resolution.
TableNote17:ResolutiondifferencesaremanagedbyAdvance
NDC.IfusingaUSBReceiptandJournalprinter,however,the
inputvalueshouldnotbegreaterthan90duetotheinputboundary
constraintsoftheprinterhardware.
Table 5-30
USB Receipt and Journal Printer: Barcode
Types, Length, and Data

tvar

Type Name

lvar

dvar

65

UPCA

4857(ASCIInumerals)

FixedLength:11,12

66

UPCE

4857

FixedLength:11,12

67

JAN13
(EAN13)

4857

FixedLength:12,13

68

JAN8
(EAN8)

4857

FixedLength:7,8

69

CODE39

4857
6590(ASCIIalphabet)
32,36,37,43,45,47
(ASCIIspecial
characters)
dl=dk=42(start/stop
codeissuppliedby
printerifnecessary)

Variable

70

Interleave
d2of5
(ITF)

4857

Variable
Evennumber

71

CODABA
R(NW7)

6568(startcode)
4857
36,43,45,46,47,58

Variable

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

5-35

Printer Data
Printer Control Sequences and Registry Settings
tvar

Type Name

lvar

dvar

72

Code93

0127

Variable

73

Code128

0105
dl=103105(mustbea
startcode)
d2=0102(databytes)
Stopcodeisprovided
bytheprinter

Variable

10

PDF417

0255

Variable

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

5-36

APTRA Advance NDC, Reference Manual

Table of Contents
Supervisor Messages

Chapter 6

SupervisorMessages
Overview

61

SupervisorMessages
CharacterSets
ControlCodes
ScreenSizeLimitations
CardholderScreen/EnhancedOperatorInterfaceLayout
PrinterLayout
AutomaticScreenEditing
MediaStatusMessages
TestCashReport

62
62
62
63
63
64
64
64
64

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Supervisor Messages

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Supervisor Messages
Overview

Overview

ThischapterdescribestheformattingrulesforSupervisormessages
thatareoutputtotheconsumerscreen(whentheSupervisor
interfacehasbeentransferredtothefront),theoperatorpanel,and
thereceiptandjournalprinters.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

6-1

Supervisor Messages
Supervisor Messages

SupervisorMessages

Formattingrulesapplytothefollowing:

Charactersets
Controlcodes
Screensizelimitations
Cardholderscreen/Enhancedoperatorinterfacelayout
Printerlayout
Automaticscreenediting
Mediastatusmessages
Testcashreport.

Thetextforthesemessagesiscontainedinreservedscreens.Ifthese
screensarenotdownloaded,standardEnglishlanguagetextis
displayedorprinted.Ifyouwanttousealternativetext,youcando
sobyeitherofthefollowing:

Editingresrvd.deftotranslatetheEnglishtext
Downloadingthealternativetextwiththereservedscreen
number.

ForalistofallSupervisorreservedscreens,showingthefunction
forwhicheachoneisusedandthedefaulttext,seeAppendix A,
ReservedScreens.
Note:FordetailsofhowtheSupervisormessagesaresizedfor
anothervendorshardware,seeSupervisorMessagesinChapter3
oftheAPTRAAdvanceNDC,MultiVendorSupportReferenceManual.

CharacterSets
ControlCodes

Alldisplay/printcharactersareobtainedfromtheSingleSize
Alphanumeric1characterset.
Thefollowingcontrolcodesaresupported:

CRcausesthenextcharactertobedisplayedatthebeginning
ofthenextline.CRmustappearoneachline
SOthesameasprintercontrol(multiplespaces).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

6-2

APTRA Advance NDC, Reference Manual

Supervisor Messages
Supervisor Messages

ScreenSizeLimitations

Table 6-1
Screen Size Limits

Thefollowingtableshowsthemaximumnumberofcolumnsand
rowsforeachtypeofscreen:
Screen
Type

Table 6-2
Display Positions

No. Of
Rows

No. Of
Columns

Cardholder/EnhancedOperator
InterfaceAcknowledgementLines

32

E/e

ErrorMessages

32

Cardholder/EnhancedOperator
Interface/PrinterInformationOutput

14

32

M/m

Cardholder/EnhancedOperator
Interface/PrinterMenus

13

32

P/p

Cardholder/EnhancedOperator
InterfaceDataEntryPrompts

27

S/s

MediaStatusLines

32

T/t

JournalTrace

15

32

SupervisorTCP/IPScreens

15

32

SupervisorBunchNoteAcceptor
(BNA)Screens

14

32

SupervisorVISA2screens

15

32

CardholderScreen
/EnhancedOperator
InterfaceLayout

Usage

IfSupervisorfunctionsareselectedfromthefaciakeyboardorthe
enhancedoperatorinterface,allscreensaredisplayedfromthe
leftmostcolumn.Thefollowingtableshowsthedisplaypositions.
6

Screen
Type

Usage

Row
Position

Column
Position

AcknowledgementLine

14

132

LastSupervisorControlKey

16

726

E/e

ErrorMessages

14

132

I/i

InformationDisplay

12

132

M/m

Menus

113

132

P/p

PromptLine

115

127

P/p

EnterandClearKeys

16

15,
2832

KeyboardEcho

15

2832

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

6-3

Supervisor Messages
Supervisor Messages

Row16isusedtodisplaykeylegendsforFDKsDandF.Asthese
actasEnterandClearkeysinSupervisormode,columns1to6and
27to32ofLastSupervisorControlKeyscreensmustnotcontain
significanttext.Youshouldalsotakecareifyouaredesigninganew
screentobedownloadedfortouchdisplaywhenanenhanced
operatorinterfaceisalsopresent,asyourdesignwillhaveto
incorporatebothtouchandFDKs.
Rows1to14cancontaineithertheCurrentMenuand
AcknowledgementlineforthelastfunctionortheInformation
Displayfromthelastfunction.
Duringencryptionkeyentry,columns1to3and29to32contain
legendsforthesixFDKsthatareusedashexkeysAF.Thesehex
keyssupplementnumerickeys09forentryofhexadecimaldigits.
Theencryptionkeyentryassistancescreenmustnotcontain
significanttextinthesepositions.

PrinterLayout

AutomaticScreenEditing

MediaStatusMessages

TestCashReport

Allprintingofreservedscreensstartsatcolumn6andextendsasfar
ascolumn37.Thefixedformatsecuritytraceheaderstartsat
column1.NotethatyoucannotusesidewaysprintinginSupervisor
mode.
Certainreservedscreensareeditedbytheterminalpriortodisplay
orprintinordertoincludeinformationheldbytheterminal.These
screenscontainapercent(%)characterasaplaceholdertoindicate
thestartlocationofthegenerateddata.Fordetailsofthescreensin
reservd.def,seeAppendix A,ReservedScreens.Forinformation
abouteditingthescreens,seeEditingtheContentsofReserved
Screensonpage 313.
TheMediaStatusmessageisbuiltbytheterminalfromtheMedia
Statusheader(screenI05)andMediaStatuslines(Sorsscreens).
ScreenI05isoverlaidfromline3onwardswithMediaStatuslines.
Ifamediaexceptionconditionexists,theappropriatemessageis
displayed.Otherwise,nothingisdisplayed.Ifnoexception
conditionexistsorifthereservedscreencontainsnodata,screen
S00isdisplayedonline3toindicatethatallsuppliesareadequate.
Thisensuresthatifyouonlyusetwocassettetypes,messages
relatingtocassettes3and4areneverdisplayed.
ThisreportisbuiltbytheterminalfromtheCashTestHeader
(screenI07)andCassetteOperationallines(screensS15S18).
ScreenI07isoverlaidfromline3onwardswithCassette
Operationallines.Ifacassetteisoperational,forexample,anotehas
beensuccessfullypickedandpurged,theappropriatelineis
displayed.Ifitisnotoperational,nothingisdisplayed.Ifno

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

6-4

APTRA Advance NDC, Reference Manual

Supervisor Messages
Supervisor Messages

cassettesareoperational,screenS14isdisplayedonline3,withthe
message:
NO GOOD CASSETTES

Atypicalreportisasfollows:
*CASH TEST*

}ScreenI07
}

TOP CASSETTE GOOD


SECOND CASSETTE GOOD

Ifanexitshutterfaultisdetected,screenS25isdisplayedonthe
CRTafterscreenI07.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

6-5

Supervisor Messages
Supervisor Messages

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

6-6

APTRA Advance NDC, Reference Manual

Table of Contents
Configuration Parameters

Chapter 7

ConfigurationParameters
Overview

71

ConfigurationParametersLoadMessage
CameraControl(Fieldh)
SupplyMode,ReadyStatus&AmountBuffer
Length(Fieldm)
LogicalUnitNumberLUNO(Fieldo)
TimerNumber(Fieldp)
MillisecondTicksperTimerField(Fieldq)
UnsupportedParameters
ReservedParameters

72
72
72
73
73
74
75
75

EnhancedConfigurationParametersLoadMessage
76
Option00CameraControl
76
Option02AutoVoice
77
Option03DateFormat
77
Option04RollWidth
77
Option05LeftPrintColumn
77
Option07Track1 Format
78
Option12SpecificCommandReject
78
Option15TransactionStatusInformation
78
Option16JournalPrinterBackupTime
78
Option17JournalPrinterBackupPrintOperations
78
Option23EnvelopeDispenserStatus
79
Option24Enhanced/TISensorStatusUnsolicitedMessage 79
Option25MediaEntry/ExitIndicatorsFlashRate
710
Option27RemoteRelay
710
Option30IncludePANinDCSData
710
Option32UnsolicitedReportingControl
710
Option33SimulateSupervisorModeEntry/Exit
711
Option34MCNRange
711
Option35ReportDualModeEJ&HardcopyB/UUnsolicited
Messages
712
Option36EnhancedEJBackup
712
Option37PrintTrack2toJournal
712
Option44BNAJournalNotesCount
713

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Configuration Parameters

Option45BNASettings
Option46MCRWEnhancedCardDeviceSecurityJitter
Option48BarcodeReader
Option69EMVSmartCardExtendedStatus
Option70EMVSmartCard
Option71TimeOutStateEntry
Option74DestinationforCashDepositRetract
Option76CashHandlers
Option77NextStateNumber
Option78GBRUMStatusReporting
Option79CoinDispenser
Option80AlphanumericStateEntry
Option83ChequeProcessor
NumberofSecondsperTimerFieldFieldl
UnsupportedParameters

Timers
TimeUnitsforTimers
TimerDescriptions
TimerAdjustmentForVoiceGuidance
Timer00*
Timer01*
Timer02
Timer03
Timer04*
Timer05*
Timer06
Timer07*
Timer08*
Timer09*
Timer10
Timer60
Timer61*
Timer63
Timer68
Timer69
Timer72
Timer77*
Timer78*
Timer87*
Timer92
Timer94*
Timer95*
Timer96*
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

713
716
716
716
716
716
717
717
718
718
719
719
719
720
720

722
722
722
722
722
722
723
723
723
723
724
724
724
724
725
725
725
725
725
725
726
726
726
726
726
727
727
727

Table of Contents
Configuration Parameters

ReservedTimers
UnsupportedTimers

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

727
727

Table of Contents
Configuration Parameters

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Configuration Parameters
Overview
G

Overview

Inadditiontostates,screensandprinterdata,youcandownloada
configurationparametermessage,oranenhancedconfiguration
parametermessagewithadditionaloptions,tocustomisetheway
anSSToperates.
Thischapterdescribestheparametersavailableinthesetwo
configurationmessageformats.
Note:TheSSTcanbefurtherconfiguredlocallybytheuseof
messagemodeoptions,whichareaccessedthroughtheSupervisor
Configuremenu.Formoreinformation,refertotheAPTRAAdvance
NDC,SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-1

Configuration Parameters
Configuration Parameters Load Message

ConfigurationParametersLoad
Message

ThismessagecontainstheparametersusedinNDC+forDiebold
emulation.ThemessageformatissupportedinAdvanceNDC
althoughDieboldemulationmodeisnotsupported.Notallthe
parametersinthismessagearesupportedinAdvanceNDC.Details
ofunsupportedandreservedparametersaregivenonpage75.
Fordetailsofthemessageformat,seeConfigurationParameters
Loadonpage1014.
FordetailsofotherparametersthatcanbeusedinAdvanceNDC,
seeEnhancedConfigurationParametersLoadMessageon
page76.

CameraControl(Fieldh)

Table 7-1
Values for Camera Control

IftheSSTisfittedwithacamera,thisparametersetsautomatic
picturetakingonoroff.Possiblevaluesareasfollows:
Value

Description

Yes

Yes

No

No

Note:Cameracontrolcanalsobeconfiguredwithenhanced
configurationoption00.Fordetails,seeOption00Camera
Controlonpage76.

SupplyMode,Ready
Status&AmountBuffer
Length(Fieldm)
Table 7-2
Values for Supply Mode, Ready Status and
Amount Buffer Length

Thissingleparameterisusedtosetthreeconfigurationoptionsand
thevaluetobedownloadedisformedbyaddingthevaluesforthe
threeoptionstogether.Thevaluesforthethreeoptionsareas
follows:
Value

Description

000

Nooptionselected(default)

001

ReadyStatus
SendaseparateReadyBstatusmessagetoCentralin
responsetoaTransactionReplymessage.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-2

APTRA Advance NDC, Reference Manual

Configuration Parameters
Configuration Parameters Load Message
Value

Description

002

SupplyMode
ReturntheSSTautomaticallytothepreviousmode
whenitleavesSupplymode.

008

AmountBufferLength
Settheamountbufferlengthtotwelvedigits.The
defaultiseightdigits.

016

IncludeTransactionStatusData
IncludethetransactionstatusinformationintheReady
Bmessage.(ReadyBmustalsobeenabledorthe
valueisignored.)

Forexample,tosendaseparateReadyBstatusmessagetoCentral,
leaveSupplyModeunselected,settheAmountBufferLengthto12,
andexcludethetransactionstatusdata,thevaluetodownloadis
001+008=009.
Note:InEnhancedConfigurationParametersLoad,thisparameter
isOptionCode01offieldj.

LogicalUnitNumber
LUNO(Fieldo)

Thisparameterdetermineswhetherthelogicalunitnumber,LUNO,
willbetransmittedinTransactionRequest,Solicitedand
UnsolicitedStatusmessages.
ThenumbertellsCentralwhichSSTtransmittedthemessage.Ifthis
fieldisnotpresent,theLUNOdefaultsto000,ortoapreviously
downloadedvalueheldbytheSST.Ifthedatasecurityfeatureis
configured,anadditionalsixcharactersarepresentcontainingthe
securitySSTnumber.
Note:InEnhancedConfigurationParametersLoad,thisparameter
isfieldh.

TimerNumber(Fieldp)

Thisparametersetsthetimeoutvalueforeachofthetimersthatthe
SSTapplicationuses.Thetimersavailablearethesameforboth
configurationloadandenhancedconfigurationload.
Thefollowingtablesummarisesthetimers.Fordetailed
descriptions,seeTimersonpage722.
Forthelistofreservedtimers,seeReservedTimersonpage727.
Note:InEnhancedConfigurationParametersLoad,thisparameter
isfieldk.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-3

Configuration Parameters
Configuration Parameters Load Message
Table 7-3
Summary of Timers

MillisecondTicksper
TimerField(Fieldq)

Timer Number

Function

00

Cardholderkeyboardentrytimeout

01

Cardholderresponsetotimeoutscreentimeout

02

Closestateorejectfailurecardholderscreentimeout

03

Communicationsresponsetimeout

04

Cheque/envelopeinsertiontimeout

05

Cashretracttimeout

06

Communicationsconnectionsampleinterval

07

Presenttimeout

08

Nightsafedeposittimeout

09

Cardremovaltimeout

10

Additionalpresenttimeout

60

EJacknowledgementtimeout

61

Barcodereaderscantimeout

63

Hardwarefailurescreentimeout

68

StatementMEIdurationtimeout

69

ReceiptMEIdurationtimeout

72

DASHcardremovaltimeout

77

BNA/GBXXcashacceptancetimeout

78

GBXXcashrejectiontimeout

87

Chequecapturescreentimeout

91

EJinspectiontimeout(notsupported).

92

Faultdisplaytimeout

94

Cheque/enveloperemovaltimeout

95

Statementretracttimeout

96

Statementpresenttimeout

97

Dooraccessopentimeout(notsupported)

Thisparametersetsthetimeoutintervalforthetimersin800
millisecondticks.Thevalidrangeis000255,providingatimeout
rangeof0204seconds.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-4

APTRA Advance NDC, Reference Manual

Configuration Parameters
Configuration Parameters Load Message

UnsupportedParameters

ThefollowingparametersarenotsupportedinAdvanceNDCbut
arereservedinthemessage:

ReservedParameters

CardReadErrorThreshold(Fieldi)
CardWriteErrorThreshold(Fieldl)

Thefollowingparametersarereservedforfutureuse:
7

Fieldj
Fieldk
Fieldn

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-5

Configuration Parameters
Enhanced Configuration Parameters Load Message

EnhancedConfigurationParameters
LoadMessage
TheEnhancedConfigurationParametersLoadmessageformat
containsalltheoptionsavailableinAdvanceNDC.
ThefollowingparametersarecommontobothConfiguration
ParametersLoadandEnhancedConfigurationParametersLoad
messageformats,andhavethesamevalues:

SupplyMode,ReadyStatus,AmountBufferLengthand
TransactionStatusData(Option01)
LogicalUnitNumberLUNO
TimerNumber

Theseparametersaredescribedonpage72topage73.
Mostenhancedconfigurationparametersaredefinedbyanoption
numberinfieldiofthemessage,withfieldjholdingtheoption
code.Thissectiondescribestheoptionsandcodes.
Fordetailsofthemessageformat,seeEnhancedConfiguration
ParametersLoadonpage1016.
ForalistofunsupportedparametersseeUnsupported
Parametersonpage720.

Option00Camera
Control

IftheSSTisfittedwithacamera,thisparametersetsautomatic
picturetakingonoroff.Possiblevaluesareasfollows:
7

Option Code

Description

001

AdvanceNDCSecurityCameraisswitchedon
(default).Theflowpointsatwhichpicturesaretaken
dependontheconfigurationofNDCSecurityCamera.xml.

002

AdvanceNDCSecurityCameraisswitchedoff

Note:Cameracontrolcanalsobeconfiguredintheconfiguration
parametersloadmessage.Fordetails,seeCameraControl(Field
h)onpage72.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-6

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option02AutoVoice

Table 7-4
Option 02: Auto Voice Values

IftheSSTisfittedwithanautomaticvoicefeature,thisparameter
setsautovoiceonoroff.Possiblevaluesareasfollows:
Option Code

Description

001

Autovoiceon(default)

002

Autovoiceoff.

Note:Ifthecardholderselectsavoiceguidedsession,thisoptionis
ignoredandautovoicemessagesarenotplayedduringthesession.

Option03DateFormat

Thisparametersetsthedateformat.Possiblevaluesareasfollows:
7

Table 7-5
Option 03: Date Formats

Option04RollWidth

Option05LeftPrint
Column

Option Code

Description

001

MMDDYY(default)

002

DDMMYY

003

YYMMDD

004

YYDDMM

Thisparameterdefinesthenumberofcolumnsusedinreceiptprint
screensinmessagessentfromCentral.Anautomaticnewline
occursifthislimitisexceeded.Thevalidrangeis001040,andthe
defaultis025.Thisoptionapplieswhenusedinnormalprintmode
(notsidewaysprintingmode).
Thisparameterdefinestheleftmostcolumnusedinreceiptprint
screensinmessagesfromCentral.Therangeis001to040,andthe
defaultvalueis008.Thisoptionapplieswhenusedinnormalprint
mode(notsidewaysprintingmode).
Note:ItistheresponsibilityoftheCentralapplicationtoensure
thatthesumofthevaluesforrollwidth(option04)andleftcolumn
(option05)donotexceed041.NCRrecommendsthatyoudefine
bothoptionsinthesamemessage.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-7

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option07Track1
Format

Thisparametersetsthemethodofextractingthenameandtitle
fromTrack1dataonthecard.Possiblevaluesareasfollows:
7

Table 7-6
Option 07: Track 1 Format Values

Option12Specific
CommandReject

Description

001

ISOformat(default)

002

VISAformat

003

Autosearchbackwards

004

Autosearchforwards.

ThisparameterdetermineswhethertheSSTtransmitsSpecific
CommandRejectoptions.Possiblevaluesareasfollows:
7

Table 7-7
Option 12: Specific Command Reject
Values

Option15Transaction
StatusInformation

Option Code

Table 7-8
Option 15: Transaction Status Information
Values

Option16JournalPrinter
BackupTime
7

Option Code

Description

000

Donottransmitspecificcommandrejectstatuses,except
MAC(default)

001

Transmitspecificcommandrejectstatuses.

Thisparameterdetermineswhetherthetransactionstatus
informationfromthelastcommandisappendedtoTransaction
Requestmessages.Possiblevaluesareasfollows:
Option Code

Description

000

Donotappendlasttransactionstatusinformation
(default)

001

Appendlasttransactionstatusinformation.

Thisparametersetsthemaximumtimeinhoursthatjournalprinter
backupisallowedbeforealljournallingisdiscontinued.Itisnot
supportedwhendualmodejournalprintingisactive.
Thevalidrangeis000255.Thedefaultsettingis000.
Note:Ifoptions16and17arebothnonzero,whicheverlimitis
reachedfirstwillbeexecuted.

Option17JournalPrinter
BackupPrintOperations
7

Thisparametersetsthemaximumnumberofprintoperations(in
hundreds)tobebufferedwhilethejournalprinterisfatal.Itisnot
supportedwhendualmodejournalprintingisactive.
Thevalidrangeis000225.Thedefaultsettingis000.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-8

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message

Note:Ifoptions16and17arebothnonzero,whicheverlimitis
reachedfirstwillbeexecuted.

Option23Envelope
DispenserStatus

Thisoptiondetermineswhetherenvelopedispenserstatus
messagesaresent.Possiblevaluesareasfollows:
7

Table 7-9
Option 23: Envelope Dispenser Status
Values

Option24Enhanced/TI
SensorStatusUnsolicited
Message
Table 7-10
Option 24: Enhanced/TI Sensor Status
Unsolicited Message Values

Option Code

Description

000

Donotsendenvelopedispenserstatusmessages
(default)

001

Sendenvelopedispenserstatusmessages

002

Notsupported

003

Sendenvelopedispenserstatusmessages

ThisoptiondetermineswhethertheEnhancedTI/SensorStatus
unsolicitedmessageissentfromtheSSTwhentamperingis
suspectedondevicesnotsupportedintheexistingTI/SensorStatus
unsolicitedmessage.Possiblevaluesareasfollows:
Option Code

Description

000

DonotsendtheEnhancedTI/SensorStatus
unsolicitedmessage;continuetosendtheexisting
TI/SensorStatusunsolicitedmessage(default)

001

SendtheEnhancedTI/SensorStatusunsolicited
messagewhenappropriate;donotsendtheexisting
TI/SensorStatusunsolicitedmessage.

002

SendtheFlexibleTI/SensorStatusunsolicited
messageinallcircumstances;donotsendanyother
version.

Note:Settingthevalueto002alsocausesbufferCtobeincludedin
thesolicitedTI/SensorStatusmessageinadditiontobuffersAandB.
FordetailsofthesolicitedTI/SensorStatusmessage,seeTamper
andSensorStatusDataonpage948.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-9

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option25Media
Entry/ExitIndicatorsFlash
Rate

ThisparametersetstheflashratefortheMediaEntry/Exit
Indicators.Theflashratecanrangefrom4.0Hztocontinuouslyon
asfollows:

Table 7-11
Option 24: Media Entry/Exit Indicators
Flash Rate

Option Code

Description

000

4.0Hz(fast)(default)

001

1.0Hz(medium)

002

1.0Hz

003

0.25Hz(slow)

004

0.25Hz

005

Continuouslyon.

Theflashrateformediaentryindicatorscanalsobesetusingthe
messagemodeoptionontheConfiguremenuinSupervisormode.
OnexitfromDiagnostics,theflashrateisresetaccordingtothe
valueintheenhancedconfigurationparameter25ormessagemode
option8,whicheverhasbeenmorerecentlyset.Fordetails,referto
theAPTRAAdvanceNDC,SupervisorsGuide.

Option27RemoteRelay

Table 7-12
Option 27: Remote Relay

Option30IncludePAN
inDCSData

Table 7-13
Option 30: Include PAN in DCS data

Option32Unsolicited
ReportingControl

Thisparameterdetermineswhentheremoterelayisactive.Possible
valuesareasfollows:
Option Code

Description

000

Remoterelayisactivewhenadeviceconditionthat
needsoperatorinterventionoccursandduringoffline
mode(default)

001

RemoterelayisactiveonlywhentheSSTisinservice.

Enhancedconfigurationparameteroption30issupported
dependingonhardwarecapability.Itisusedtosuperimposethe
PANontheimage.Valuesareasfollows:
Option Code

Description

000

IncludePANinDCSdata(default)

001

DonotincludePANinDCSdata

Thisoptioncontrolsreportingoffaultswithvoiceguidanceand
camera.Italsocontrolsthereportingofstatechanges
7

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-10

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message

(active/inactive)inthecardholderdisplaysensor.Thepossible
valuesareasfollows:
Table 7-14
Option 32: Unsolicited Reporting Control

Option33Simulate
SupervisorMode
Entry/Exit

Table 7-16
Option 34: MCN Range Values

Description

000

Donotsendmessagesforvoiceguidance,security
cameraorcardholderdisplayalarm.

001

Sendvoiceguidanceerrorsonly.

002

Sendcameraerrorsonly.

003

Sendbothvoiceguidanceandcameraerrors.

004

Sendcardholderdisplaychangesonly.

005

Sendvoiceguidanceerrorsandcardholderdisplay
changes.

006

Sendcameraerrorsandcardholderdisplaychanges.

007

Sendvoiceguidanceerrors,cameraerrorsand
cardholderdisplaychanges.

ThisoptionsimulatesentrytoorexitfromSupervisormodeafter
safedooractivity.Possiblevaluesareasfollows:
7

Table 7-15
Option 33: Simulate Supervisor Mode
Entry/Exit Values

Option34MCNRange

Option Code

Option Code

Description

000

SimulateSupervisormodeentry/exit:thecashdispenser
isclearedwhenthesafedoorisclosed,andagainwhen
theSSTisswitchedtoInServicemode(default)

001

DonotsimulateSupervisormodeentry/exit:thecash
dispenserisonlyclearedwhentheSSTisswitchedto
inservicemode.Noclearisissuedwhenthesafedooris
closed.

ThisoptioncontrolstherangeoftheMessageCoordinationNumber
(MCN).andextendsit.Possiblevaluesareasfollows:
Option Code

Description

000

31Hto3FH(default)

001

31Hto7EH

AnyothervaluewillkeepthepreviousMCNrange.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-11

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option35ReportDual
ModeEJ&HardcopyB/U
UnsolicitedMessages

ThisoptioncontrolsthereportingtoCentralofunsoliciteddevice
statusmessagesfordualmodeEJandhardcopybackup.Possible
valuesareasfollows:
7

Table 7-17
Option 35: Report Dual Mode & Hardcopy
B/U Unsolicited Message Values

Option Code

Description

000

DonotreporteitherdualmodeEJorhardcopybackup
unsolicitederrormessages(default)

001

ReportonlydualmodeEJunsolicitederrormessages

002

ReportbothdualmodeEJandhardcopybackup
unsolicitederrormessages.

ForinformationaboutthemessagesequencesreturnedbytheSST,
seetableUnsolicitedMessageSequencesforOption35(EJDual
Mode)onpage997.

Option36EnhancedEJ
Backup

ThisoptiondetermineswhethermultipleorstandardEJbackups
areallowed.Possiblevaluesareasfollows:
7

Table 7-18
Option 36: Enhanced EJ Backup Values

Option Code

Description

000

AllowstandardEJbackup(default)

001

AllowmultipleEJbackup.

Note:Changestooption36canbedisabledthroughSupervisor.
Forfurtherinformation,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.

Option37PrintTrack2
toJournal
Table 7-19
Option 37: Print Track 2 to Journal

Thisoptiondetermineswhetherthefirst22charactersofdatafrom
cardtrack2areautomaticallyjournalledwhenacardisread.
Possiblevaluesareasfollows:
Option Code

Description

000

Donotprintdataonthejournal(default)

001

Printdataonthejournal.

Theprintformatisasfollows:
CARD: ;XXXXXXXXXXXX1251=09
DATE DD-MM-YY TIME HH:MM:SS

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-12

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option44BNAJournal
NotesCount

IfaBunchNoteAcceptor(BNA)ispresent,thisoptiondetermines
whethervaultedandrefundednotecountsareautomatically
printedtothejournalprinterfollowingatransactionreply.
NCRrecommendsthatyousetthisoptionifimplementingtheECB
6regulations.Ifthisoptionisnotsetandnotesarerecategorised
duringsecondbillvalidation,ECB6countsmaybeomittedfrom
thejournal.
Possiblevaluesareasfollows:

Table 7-20
Option 44: BNA Journal Notes
Count Values

Option Code

Description

000

Donotjournalvaultednotes(default)

001

Journalallvaultednotes.

002

Journalallreturnedcounts

003

Journalallvaultedandreturnedcounts

Note:Notecountsarealwaysprintedtothejournalprinterinthe
Closestate.

Option45BNASettings

IfaBNAispresent,thisparametersetsthefollowing:
7

InclusionoftheBNAcountsforthelasttransactionstatusinthe
TransactionRequestmessagesenttoCentral
Numberofnotestoaccept
Retractoptionconfiguration
Extendedmessageformatoption
Note:WhenCentralsendsaterminalcommandtocheckthe
suppliesandfitnessofthedevice,forexample,onexitfrom
Supervisor,theresponsecanbeusedtotracktheinsertionand
removalofcassetteswhenextendedmessagesareenabled.

Suppliesreportingwhenbit3isnotset
Recyclingoptionconfiguration.

Duetothecomplexityandnumberofsettingscontrolledbythis
parameter,informationisprovidedonthebitsettingsratherthan
theavailableoptioncodes.Theoptioncodeisadecimalvalueof

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-13

Configuration Parameters
Enhanced Configuration Parameters Load Message

between000and255.Eachbitcanbesetasdescribedinthe
followingtable:
Table 7-21
Option 45: BNA Settings Bit Values

Bit Number

Description

InclusionofBNAlasttransactionstatuscountsinthe
TransactionRequestmessagesenttoCentral
Validvaluesare:
0Donotincludetransactionstatuscounts
1Includetransactionstatuscounts

Numberofnotestoaccept
Thismustbesetifbit3orbit6issetorifdirectdeposit
isconfigured
Validvaluesare:
0Acceptupto90notes
1Acceptmorethan90notes
Note:IftheSSTisconfiguredfordirectdepositmode,
youmustsetthenumberofnotesthatcanbeaccepted
tomorethan90.

Retractoptionconfiguration
Validvaluesare:
0Donotretractnotes
1Retractnotes

Extendedmessageformatoption
Bit1mustbesetifthisisset
Thismustbesetifbit6isset
Bit4isignoredifthisisset
Validvaluesare:
0Donotuseextendedmessageformat
1Useextendedmessageformat
Fordetailsoftheaffectedmessages,seethefollowing:

SuppliesDataonpage944

FitnessDataonpage946

ExtendedSendSupplyCountersonpage957

NoteAcceptor(Solicited/Unsolicited)on
page9109

Suppliesreportingwhenbit3isnotset
Bit3mustnotbesetifthisisset
Validvaluesare:
0Reportwhenfirstcassetteisfulloralmostfull
1Reportwhenallcashincassettesarefull
Whichevervalueisused,aretractbinisreportedwhen
fulloralmostfull.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-14

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message
Bit Number

Description

EnhancedCashDepositMode
NotsupportedbyAdvanceNDC

Recyclingoptionconfiguration
Bit3mustbesetifthisisset
Value0:

Donotuserecyclingcassettesduringdeposit
transactions

DonotreportNDCcassettestypesthathave
acceptednotesduringthelastdeposit
Value1:

Userecyclingcassettesduringdeposittransactions

ReportNDCcassettetypesthathaveacceptednotes
duringthelastdeposit

Thefollowingtableprovidessomeexampleoptioncodes:
Table 7-22
Example Option 45: BNA Settings Values

Option Code

Description

000

Donotincludelasttransactionstatuscounts
Acceptupto90notes
Donotretractnotes
Donotuseextendedmessageformat
Reportwhenfirstcassetteisfullornearlyfull
(default)

015

Includelasttransactionstatuscounts
Acceptmorethan90notes
Retractnotes
Useextendedmessageformat
Ignorenotereportsettings

023

Includelasttransactionstatuscounts
Acceptmorethan90notes
Retractnotes
Donotuseextendedmessageformat
Reportwhenoneretractbinorallcashincassettesare
fullornearlyfull

074

Donotincludelasttransactionstatuscounts
Acceptmorethan90notes
Donotretractnotes
Useextendedmessageformat
Ignorenotereportsettings
Userecyclingcassettes

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-15

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option46MCRW
EnhancedCardDevice
SecurityJitter

IftheEnhancedCardDevice(ECD)ispresent,thisparametersets
thelevelofECDJittertobeappliedduringcardentry/exit.The
defaultvalueis000.
7

Note:Arebootisrequiredifthisparameterischanged,toallowthe
newsettingtotakeeffectatdevicelevel.

Table 7-23
Option 46: MCRW Enhanced Card Device
Security Jitter Values

Option48Barcode
Reader

Table 7-24
Option 48: Barcode Reader Values

Option69EMVSmart
CardExtendedStatus

Option70EMVSmart
Card

Option Code

Description

000

NoECDJitter,orECDJitternotrequired(default)

001

StandardECDJitter

002

MaximumECDJitter(butslowercardread/write).

Ifthebarcodereaderispresent,thisoptiondefineswhetherthe
barcodereaderspecificfieldsareincludedinthemessagessentto
thehost.
Option Code

Description

000

DIGfisnotreportedinanymessagesenttothehost.
TransactionRequestbuffereisstillusedifselectedin
theTransactionRequeststate(default).

001

DIGfisreported.

ThisoptionisreservedforusewithEMV/CAM2Exits.
7

Fordetails,refertotheEMVIntegratedCircuitCard(ICC)Reference
Manual.
ThisoptionisreservedforusewithEMV/CAM2Exitsandisnot
supportedinAdvanceNDC.

Fordetails,refertotheEMVIntegratedCircuitCard(ICC)Reference
Manual.

Option71TimeOutState
Entry
7

ThisoptioncontrolsentrytotheTimeOutstateandhowmany
timestheTimeOutstatecanbeenteredforeachcardholderaction.
Oncethespecifiedlimitisreached,thetimeoutactionisperformed.
Validvaluesareasfollows:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-16

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message
Table 7-25
Option 71: Time-Out State Entry

Option74Destinationfor
CashDepositRetract

Option Code

Description

000

TheTimeOutstateisneverentered(themoretime
screenisneverdisplayed)

001to009

TheTimeOutstatecanbeentereduptothespecified
numberoftimes

255

ThenumberoftimestheTimeOutstatecanbeentered
isunlimited(default)

Thisoptionspecifiesthedestinationfornotesretractedduringa
cashdeposittransactionasfollows:

Table 7-26
Option 74: Destination Values for
Retracted Notes During Cash Deposit

Option76CashHandlers
Table 7-27
Option 76: Cash Handlers

Option Code

Description

000

Retractthenotestoaretractbin(default)

001

Retractthenotestothecashincassettedefinedbythe
serviceprovidersettings.

Thisoptionspecifiesthecassettetypesupportandmessageformat
forsingleordualcashhandlersystemsasfollows:
Option Code

Description

000

Ifdualcashhandlersareused,emulateasinglecash
handlerandsupportallexistingmessages.
Onlycassettetypes1,2,3,and4aresupported.
DIGEisusedtoreportthecombinedstatusofthe
emulateddevice.(default)

001

Ifasinglecashhandlerisused,DIGEreportsthe
deviceinallmessages.
Ifdualcashhandlersareused,emulateasinglecash
handler,andsupportextendedmessagesforupto
sevencassettetypes.
Cassettetypes1,2,3,4,5,6and7aresupported.
Ifdualcashhandlersareused,DIGEreportsthe
emulateddeviceinallmessages,whileDIGdreports
cashhandler0andDIGereportscashhandler1in
TerminalCommandresponsesonly.
Inallcases,theHardwareConfigurationmessagealso
reportsthemaximumnumberofitemsthatcanbe
dispensedinasingletransaction.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-17

Configuration Parameters
Enhanced Configuration Parameters Load Message

Note:Asincreasedcashhandlercapacityhasbeenimplemented
withouthostimpact,thehostcannotselectthecashdispensertobe
usedfordispensingcash.

Option77NextState
Number

Thisoptiondetermineswhethercardlesstransactionsarepermitted
andsetsthestatenumbertogotofromtheinitialCardReadstate
forconsumercardlesstransactions.Possiblevaluesareasfollows:

Table 7-28
Option 77: Next State Number Values

Option Code

Description

000

Cardlesstransactionsnotallowed(default)

001254or
256999

StatenumbertogotofromtheCardReadstatewhen
cardlesstransactionsareallowedandwhenEnhanced
ConfigurationParameteroption80issetto0

001254or
256toZZZ

StatenumbertogotofromtheCardReadstatewhen
cardlesstransactionsareallowedandwhenEnhanced
ConfigurationParameteroption80issetto1

Note:Option77requiresaregistrysettingtobeconfigured.For
details,refertotheCardlessTransactionssectioninchapter5of
theAPTRAAdvanceNDCDevelopersGuide.

Option78GBRU
MStatusReporting

ThisoptioncontrolsthereportingoftheMStatusforaGBRUused
asadispenserinthefollowingcases:
7

Inastatusmessage,allfieldsarethesameasforafourcassette
stackingdispenser(standardcashhandler),withthepossible
exceptionoftheMStatus.Fordetails,seeGBRUtoCDM
MStatusMappingonpage972
InresponsetoaTerminalCommand,allfieldsarethesameasa
standardcashhandler.

Note:TheMDataisalwaysGBRUspecificregardlessofthesetting
ofthisoption.
Possiblevaluesareasfollows:
Table 7-29
Option 78: GBRU M-Status Reporting

Option Code

Description

000

ReportaCDMMStatus.

001

ReportaGBRUMStatus.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-18

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message

Option79Coin
Dispenser

Table 7-30
Option 79: Coin Dispenser

Option80Alphanumeric
StateEntry

Thisoptionallowsthemodificationofthemessageformatto
supportuptoeightcoinhoppertypes.Possiblevaluesareas
follows:
Option Code

Description

000

Coindispensersupportsfourcoinhoppertypesusing
NDC+compatiblemessageformats(default)

001

Coindispensercansupportmorethanfourhopper
typesusingextendedmessageformats.AdvanceNDC
supportsuptoeighthoppertypes

Thisoptioncontrolswhichnumbersystemisusedtointerpretstate
numberfields.Possiblevaluesareasfollows:

Table 7-31
Option 80: Alphanumeric State Entry

Option Code

Description

000

Statenumbersareinterpretedasbase10(decimal)
numbers.Eachcharacterisintherange0to9.State
numberrangeis000to999.Thereare1000state
numbersavailable.Thisisthedefaultvalue.

001

Statenumbersareinterpretedasbase36numbers.Each
characterisintherange0to9orAtoZ.A
represents10andZrepresents35.Bothuppercaseand
lowercaselettersarevalid(Aisthesameasa).State
numberrangeis000toZZZ.Thereare46655state
numbersavailable.
ExampleZD4is(35*(36^2))+(13*36)+4=45832.

Note:Toavoiderrorsinstatetransitions,theEnhanced
ConfigurationParametersLoadmessagecontainingoption80must
besentbeforetheStateTablesLoadmessage.

Option83Cheque
Processor

Thisoptionallowsthemodificationofthemessageformatto
supportthereportingofbinsinthechequeprocessorandfurther
supportforbunchchequeacceptors.Possiblevaluesareasfollows:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-19

Configuration Parameters
Enhanced Configuration Parameters Load Message
Table 7-32
Option 83: Cheque Processor

NumberofSecondsper
TimerFieldFieldl

Option Code

Description

000

Chequeprocessorsupportsthereportingofthreebins
usingNDC+compatiblemessageformats(default)

001

Chequeprocessorsupportsthereportingofallbinsthat
arepresent,usingtheextendedmessageformat.
Atleastthreebinsarereportedforachequeprocessor.
Thenumberofbinsreporteddependsonthehardware
configuration.

002

Onbunchchequeacceptorsonly,inadditiontothe
informationreportedbyOptionCode001,thedevice
statusmessagealsoincludesthelocationofthe
depositedcheques.

004

Scanschequesafterendorsementwhensupportedby
thehardware.
Thebackofthechequeisscanned
Ifarearimagewasrequestedwhenthechequewas
accepted,theimagefromthescanafterendorsement
replacesthisimage
Ifthechequeisnotendorsed,theimageisnotscanned

Thisparametersetsthetimeoutvalueinsecondsforthetimer
numberspecifiedinfieldk.Themaximumnumberofsecondsis
255.
ForadescriptionofthefieldintheEnhancedConfiguration
ParametersLoadmessage,seepage1016.

UnsupportedParameters

Table 7-33
Unsupported Parameters

Thefollowingtableliststheenhancedconfigurationload
parametersthatarenotsupportedinAdvanceNDC.Theoption
numbersarereservedinthemessageformat.
Option Number

Configuration Parameter Description

09

Dieboldstatusreportingforvandalguard.
ThisparameterisretainedforNDCcompatibility
only;DieboldisnotsupportedbyAdvanceNDC,
sovandalguarderrorsareneverreported.

10

Tamperindicationstatusreporting

11

Extendedstatuscontrol

13

Cardreadererrorthreshold

14

Track3writeerrorthreshold

21

Opticalsensor

22

Journalprinterbackuplogtamper

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-20

APTRA Advance NDC, Reference Manual

Configuration Parameters
Enhanced Configuration Parameters Load Message
26

Touchscreenerrorreporting

28

TransactionprocessingapplicationinformedofSM
activity

31

Enableaudibleechoofkeyboard

39

MCRWnonmagneticcardaccept

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-21

Configuration Parameters
Timers

Timers

Thesametimersareavailableinbothconfigurationloadmessages
andenhancedconfigurationloadmessages.

TimeUnitsforTimers

TimerDescriptions

Whenaconfigurationloadmessageissent,thetimervaluesarein
ticks.Atickis800milliseconds.Whenanenhancedconfiguration
messageissent,thevaluesareinseconds.Avalueof30ticksina
configurationloadmessageistheequivalentof24secondsinan
enhancedconfigurationloadmessage.Thevaluesaregivenin
secondsinbothconfigurationloadandenhancedconfigurationload
messages,unlessotherwisestated.
Timersthatarereservedforfutureuseorcurrentlyunsupportedin
AdvanceNDCareallmarkedasreservedinthemessageformat.
Fordetailsofthesetimers,seepage727.

TimerAdjustmentForVoiceGuidance

Timersmarkedwithanasterisk(*)inthefollowinglistcanbe
adjustedforavoiceguidedsessionusingthetimersAdjust
subelementoftheXMLconfigurationfileforvoiceguidance,which
isdescribedinChapter6,ConfiguringVoiceGuidanceinthe
APTRAAdvanceNDC,DevelopersGuide.Iftwotimersareadjusted,
suchas timersAdjustforvoiceguidanceandTimer0Multiplier
forSMSstyledataentryintheInformationState,thisdoublesthe
timeradjustment.
Note:ForSMSstyledataentry,itisnotnecessaryforthehostto
increasethetimespecifiedintheTimerfieldofthismessage,unless
evenmoretimeisrequiredthanisgainedbyaddingthe
timersAdjustparameter.

Timer00*

Cardholderkeyboardresponsetime.Whenascreenisdisplayed
whichpromptsthecardholdertomakeakeyboardentry,the
cardholdermustrespondwithinthetimeoutintervalspecifiedfor
timer00.Otherwise,theSSTwillexititspresentstateandenterthe
TimeOutstate.

Timer01*
Cardholdertimeoutresponse.Thistimerisstartedonentrytothe
TimeOutstate,togivemoretimeforkeyboardinput,form
insertionorenvelopeinsertion.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-22

APTRA Advance NDC, Reference Manual

Configuration Parameters
Timers

Timer02

Closestateorejectfailurecardholderscreendisplaytimeout
interval.ThistimerisstartedintheClosestateafterthecardhas
beenejected.ItisalsostartedduringaCloseorCardReadstateifan
ejectcannotbesuccessfullyperformed(screenC04isdisplayed).
Attheendofthisinterval,theSSTproceedstothenextstatenumber
specifiedinthestatetabledata,providedthecardhasbeentakenor
captured.Ifthecardisstillaccessibletothecardholderwhenthe
timerexpires,theClosestateexitisdelayeduntiltimer09expires
(inducingacapture)oruntilthecardistaken.Atimeoutintervalof
zeroisnotpermittedfortimer02.
Thistimermustalsobeusedforcardlesstransactionstoprovidea
minimumtimefordisplayofthescreensetuppriortocardeject
processing.

Timer03

Communicationmessagetimeoutinterval.WhentheSSTisready
totransmitaTransactionRequesttoCentral,theSSTstartstimer03.
IftheSSTdoesnotreceiveaTransactionReplycommandbefore
timer03expires,throughtheCentralResponseTimeoutNextState,
theSSTexitstheTransactionRequeststatespecifiedinthe
TransactionRequeststatetable.Ifthisoccurs,ahosttransaction
timeoutmessageisjournalled,(asinreservedscreent68.).

Timer04*

Cheque/envelopeinsertionresponsetimeout.Whenascreenis
displayedwhichpromptsthecardholdertoinsertachequeor
envelopeintoadepository,thecardholdermustrespondwithinthe
timeoutintervalspecifiedbytimer04,otherwisetheSSTentersthe
TimeOutstate.Thekeyboardbeepersoundswhilethistimeris
active.Thedefaultis30ticks.Ifthistimerissettogreaterthanone
minuteonthechequeprocessor,thechequeprocessorfirmwarewill
timeout.

Timer05*

Cashretracttimeout.Whencashispresentedtoacardholder,this
timeridentifiesthelengthoftimeitremainsaccessibletothe
cardholderbeforearetractisattempted.Ifthecardholdertakeshis
moneybeforeexpiry,thetimeriscancelled.Ifthetimerexpires,a
retractoperationisattempted.Avalueofzeroisnotpermittedfor
timer05.IftheSSTisconfiguredtosoundthebeeperduringcash
present,thistimergivesthemaximumlengthoftimethebeeperwill
sound.ThistimerisusedinCardBeforeCashtransactionstoallow
beepingwhentheSSTisconfigurednottoretractcash.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-23

Configuration Parameters
Timers

Timer06

Communicationsconnectionsampleinterval.Thistimerdefinesthe
sampleintervalusedbytheapplicationtomonitorthe
communicationsconnection.Thistimerisnotusedinadialup
environment.Itsdefaultvalueis600seconds.
Note:ForTCP/IPcommunications,youcanreducethisinterval(for
example,to1second)asthetimeittakesfortheTCP/IP
communicationstodetectlossofaconnectioncanbecontrolledvia
theSupervisorTCP/IPConfigurationmenu.Formoreinformation,
refertotheAPTRAAdvanceNDC,SupervisorsGuide.

Timer07*

Presenttimeout.Thistimerisstartedwhencashhasbeen
dispensedandtheTransactionReplyscreenTakeCashis
displayed.Whenthetimerexpires,thenextstatespecifiedinthe
TransactionReplycommandisentered.Atimeoutintervalofzero
isnotpermitted.Thedefaultvalueis24seconds.
Note1:ThistimerisnotusedforParallelDispense/PrintandEject
transactionsonanSSTconfiguredtostopcashretract.
Note2:Timer07iscombinedwithtimer05inParallel
Eject/DispenseandPrint(FastCash)(seepage1069)andCard
BeforeParallelDispenseandPrint(seepage1070)transactions.It
isstartedafternotesaretakeninDispenseandPrint(page1064)
andCardBeforeCash(seepage1067).
Note3:Incardbeforecashtransactionswhenthenoretractoption
isset,therecommendedminimumvalueofthistimeris5.

Timer08*

Nightsafedeposittimeout.Thistimerisstartedwhenthenight
safedoorisunlockedtoacceptanightsafedeposit.Ifnobagis
detectedandthistimerexpires,theSSTentersthetimeoutstate.If
thebagdetectionmechanismisfaulty,thistimeoutisallowedto
expireinordertogivethecardholdertimetoperformadeposit.
However,theTimeOutstateisnotentered.

Timer09*

Cardholdertimeoutintervalbeforecardcaptureattempt.Ifthe
cardispresentedtothecardholderandnotremovedwithinthis
timeperiod,anattemptismadetocapturethecard.Toreducethe
possibilityofacardnotbeingcompletelyejectedatthefirstattempt,
thecardisreejectedafterhalfthetimervaluehasexpired,and
capturedatthefulltimerexpiry.Thedefaultvaluefortimer09is24
seconds.Atimeoutintervalofzeroisnotpermitted.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-24

APTRA Advance NDC, Reference Manual

Configuration Parameters
Timers

Timer10

Additionalpresenttimeout.Thistimer,ifconfigured,isaddedto
Timer07toallowanadditionaltimeoutinthefollowingfunctions:

DispenseandPrint.Fordetails,seeDispenseandPrinton
page 1064
DisplayandPrint.Fordetails,seeDisplayandPrinton
page 1065.

Ifatimeoutintervalofzeroisconfigured,Timer07isnotaffected.

Timer60

EJacknowledgementtimer.ThisisusedintheEJOptionsand
Timerscommand(describedinEJOptionsandTimers.onpage
1081)tospecifythemaximumtimetowaitforanuploadblock
acknowledgmentfromthehostbeforeresendingtheblock.Avalue
of000isinfinite.Thedefaultis255.

Timer61*

Barcodereaderscantimer.Definesthelengthoftimeabarcode
readerisenabledtoscanforabarcode.Thedefaultvaluefortimer
61is60seconds.
Note:Onsomedevicesthetimeoutisalsosupportedbyhardware,
inthesecasesthetimethatthedeviceisenabledwillbetheshorter
ofthetwovalues.

Timer63

Hardwarefailurescreentimeout.Definesthelengthoftimethe
hardwarefailurescreenisdisplayedintheCashAccept,Bunch
ChequeAcceptandBunchChequeHandlingstates.Thedefault
valuefortimer63is15seconds.Ifavalueof0isspecified,the
defaultvalueisused,otherwise,thespecifiedvalueinsecondsis
used.

Timer68

StatementMEIdurationtimer.ThelengthoftimetheMEIflashes
afterthestatementispresentedtothecardholder.TheMEIstartsto
flashassoonasthedatastartstoprint;thatis,totalMEIflashing
duration=printingduration+cutandejectduration+timer68.The
defaultvaluefortimer68is2seconds;therangeis210.

Timer69

ReceiptMEIdurationtimer.ThelengthoftimetheMEIflashesafter
thereceiptispresentedtothecardholder.TheMEIstartstoflashas
soonasthedatastartstoprint;thatis,TotalMEIflashingduration=
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-25

Configuration Parameters
Timers

PrintingDuration+CutandEjectDuration+Timer69.Thedefault
valuefortimer69is6seconds;therangeis210.

Timer72

DASHcardremovetimer.Thistimerdefinesthetimetowaitforthe
cardholdertotakethecard,ifthecardreaderisaDASHreader.If
thetimerexpiresbeforethecardholdertakesthecard,theSST
displaysanErrorMisreadscreenandrestartsthetimer.Ifthe
timerexpiresagain,theDASHcardreaderentersaSuspendstate.
Theminimumtimeoutvalueis1secondandthemaximumis255;
thedefaultis20.Ifavalueissentoutsidetherange,itdefaultsto20
(25ticks).
Note:IfusingaDASHreaderandCardReadStateA,orCardRead
StateTwithnochipconnectbitset,theDASHreaderwillnotenter
aSuspendstate.

Timer77*

BNA/GBXXcashacceptancetimer.Thistimerdefinesthetimeout
valuefornoteentrytotheBunchNoteAcceptor(BNA)orGBXX.
Theminimumtimeoutvalueis10seconds,thedefaultis30andthe
maximumis255.Ifenabled,thekeyboardbeepersoundswhilethis
timerisactive.

Timer78*

GBXXcashrejectiontimer.Thistimerdefinesthetimeoutvaluefor
noteremovalfromtheGBXX.Theminimumtimeoutvalueis10
seconds,thedefaultis24andthemaximumis255.Ifenabled,the
keyboardbeepersoundswhilethistimerisactive.Withtheretract
optionselected,anynotesthatarenotremovedareretracted.

Timer87*

Chequecapturescreentimeout.Thistimerdefinesthedurationfor
whichtheChequeCapturedscreenisdisplayed,typicallyaftera
returnedchequehasnotbeentakenbythecardholder.The
minimumtimeoutvalueis1second,thedefaultis24andthe
maximumis255.

Timer92
Faultdisplaytimeout.Thistimerdefinestheamountoftimefor
whicheachfaultmessageisdisplayed.Theminimumtimeout
valueis1second,themaximumis255andthedefaultis4(5ticks).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-26

APTRA Advance NDC, Reference Manual

Configuration Parameters
Timers

Note:Ifthisvalueissettozero,theEOPdisplaywillneverbe
refreshed.

Timer94*

Cheque/enveloperemovalresponsetime.Thistimerdefinesthe
durationforwhichachequeorenvelopeispresentedforremoval
bythecardholder.Theminimumtimeoutvalueis10seconds
(valueslessthan10aresetto10),thedefaultis30.Anydownloaded
valuegreaterthan120issetto120.

Timer95*

Statementretracttimeout.ThistimerisusedduringCloseState
processing.Itdetermineswhentoretractastatementthathasnot
beentakenbythecardholder.Thedefaultis30seconds,andisused
ifyousupplyavalueofzero.

Timer96*

Statementpresenttimeout.Thistimerisusedonlyinthestatement
andcontinuefunctionandisstartedregardlessofwhetherornota
statementisbeingdelivered.Whenthetimerexpires,thenextstate
specifiedbytheTransactionReplycommandisentered.Avalueof
zeroforthistimermeansdonotwait.
Thefollowingtimersarereservedforfutureuse:

ReservedTimers

1159
62
6467
7071
7376
7981
8486
8890
93
9899

UnsupportedTimers

Thefollowingtimersareforfunctionsthatarenotsupportedin
AdvanceNDC:
82Cameradelayperiod(seeNote:)
83DigitalCameraService(DCS)fileexpirytimeout(seeNote:)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

7-27

Configuration Parameters
Timers

91EJloginspectiontimeout
97Dooraccessopentimeout.
Note:Forthesecuritycamera,AdvanceNDCusesanXML
configurationfiletocontrolthenumberofimages,whentheyareto
betakenandthestoragecapacitytobeusedforthem.Fordetails,
refertoChapter5,ConfiguringAdvanceNDcandSupport
ApplicationsintheAPTRAAdvanceNDC,DevelopersGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

7-28

APTRA Advance NDC, Reference Manual

Table of Contents
Financial Institution Tables

Chapter 8

FinancialInstitutionTables
Overview

81

FITData
FITFields
PIDDX(InstitutionIDIndex)
PFIID(InstitutionID)
PSTDX(IndirectNextStateIndex)
PAGDX(Algorithm/BankIDIndex)
PMXPN(MaximumPINDigitsEntered)
PCKLN(MaximumPINDigitsChecked)
PINPD(PINPad)
PANDX(PANDataIndex)
PANLN(PANDataLength)
PANPD(PANPad)
PRCNT(Track3PIN)
POFDX(PINOffsetData)
PDCTB(DecimalisationTable)
PEKEY(EncryptedPINKey)
PINDX(IndexReferencePoint)
PLNDX(LanguageCodeIndex)
PMMSR(MMSensorFlag)
PBFMT(PINBlockFormat)

82
83
84
84
84
84
85
85
86
87
88
88
89
89
89
89
810
811
811
811

LinkedFITs

813

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Financial Institution Tables

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Financial Institution Tables


Overview

Overview

TheFinancialInstitutionTable(FIT)isanimportantpartofthe
customisationdataforanAdvanceNDCsystem.FITsmayalsobe
downloadedtotheterminalbyamessagefromCentral.TheFIT
containsspecificinformationabouthowaparticularinstitutions
transactionsshouldbeprocessed.
EveryinstitutiontheterminalsupportsmusthaveaFIT.Institutions
whichhavemorethanonetypeofcardmusthaveaFITforeach
cardtype.
Whenacardisread,theFITissearchedtofindtheFITentrywhich
matchestheFinancialInstitutionIdentificationnumber(FIID)on
thecard.ParametersinthisFITentryandfollowinglinkedFITsare
thenusedforallsubsequentPINprocessing.
ThischapterdescribestheFITdataandlinkedFITs.Fordetailsof
theFITmessageformat,seeFITDataLoadonpage 1021.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-1

Financial Institution Tables


FIT Data

FITData

EachFITcontainsthefieldsdescribedhere,andeachfielddefaults
tozeroifnotspecified.Somefieldsholdinformationonhow
transactionswillbeprocessedforthatinstitution.Otherfields
containanoffsettowhereinformationrequiredfortransaction
processingisstoredonthecard.
EachentryintheFITDataloadmessagehasavalueintherange
00FFhexadecimal(hex),andforthepurposesofthisdescriptionis
consideredastwodigits,eachhavingpossiblevaluesintherange
0Fhex.However,theFITdataissenttotheterminalindecimal,so
toconstructtheFITDataloadmessageyoushouldconverteach
digitpairfromhextodecimaltoproduceathreecharacterstringin
therange000255.
FordetailsoftheFITmessageformat,seeFITDataLoadon
page 1021.
ThefollowingtabledefinesthefieldsintheFITandindicatesthose
fieldsthatareoffsetstodataonthecard.
Table 8-1
FIT Fields
No of
Digits

Offset

IndexforFinancialInstitutionIDnumberon
card

Yes

PFIID

FinancialInstitutionIDnumber

10

No

Indirectnextstateindex

PSTDX

IndexforentriesintheIndirectnextstatetable

No

Algorithm/BankID
index

PAGDX

AlgorithmindexforDiebold
NotsupportedbyAdvanceNDCasLocal
DieboldPINverificationisnotsupported.

Yes

MaximumPINdigits
entered

PMXPN

MaximumnumberofPINdigitsallowedforthe
cardholdertoenter

No

MaximumPINdigits
checked

PCKLN

NumberofdigitsusedforlocalPINcheck

No

PINpad

PINPD

CharacterusedtopadPINfortransmissionto
Centralandtheencryptionmethodused

No

PANdataindex

PANDX

IndexforlocationofPAN(PersonalAccount
Number)oncard

Yes

PANdatalength

PANLN

PANdatafieldlength

No

Field

Contents

Acronym

Definition

InstitutionIDIndex

PIDDX

InstitutionID

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-2

APTRA Advance NDC, Reference Manual

Financial Institution Tables


FIT Data

Field

Contents

Acronym

Definition

No of
Digits

Offset

PANpad

PANPD

CharacterusedtopadPANfieldforencryption

No

Track3PINretrycount
index

PRCNT

IndexforPINretrycountfieldoncard

Yes

PINoffsetindex

POFDX

IndexforPINoffsetfieldoncard

Yes

Decimalisationtable

PDCTB

Decimalisationtableusedinencryptionprocess

16

No

EncryptedPINkey

PEKEY

DESEncryptedPINkey

16

No

Indexreferencepoint

PINDX

Trackandindexreferencepointinformationfor
allcardrelatedentriesinFIT

Yes

Languagecodeindex

PLNDX

Indexforlanguagecodeoncard

Yes

CIM86sensorflag

PMMSR

FlagtoidentifythelocationoftheCIM86
sensorintheFIT
NotsupportedbyAdvanceNDC

No

Reserved

No

PINBlockformat

PBFMT

SelectsPINblockformatforremotePIN
verification

No

Note:Forthetwodigitfields,thetermsdigit1anddigit2refer
tothehighandlownibblesrespectively.
TheFITreferencesdataonthecardusingsixfieldsintheFITwhich
areoffsetstowhereinformationisstoredonthecard.Thesefields
are:

PIDDX
PAGDX
PANDX
POFDX
PLNDX
PRCNT

Anotherfield,PINDX,identifiesthetrack,thedelimiterandthe
directionofcountingforeachoffset.

FITFields

SomeofthefieldsintheFITarenotsupportedbyAdvanceNDC,
andthisisindicatedinthetext.Unsupportedfieldsareignoredby
AdvanceNDC.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-3

Financial Institution Tables


FIT Data

PIDDX(InstitutionIDIndex)

EachcardcontainsanIDnumbertoidentifythefinancialinstitution
itbelongsto.ThisfieldgivestheoffsetfortheFIIDonthecard.The
rangeis007Fhex.
Youshouldadd80hextothisnumberifitisrequiredtomodifythe
indexdelimitersintableentryPINDX.SeethePINDX(Index
ReferencePoint)sectionfordetails.YoucanhaveavalueofFFhex
inthisfieldiftheFinancialInstitutionidentificationnumberonly
containsF.

PFIID(InstitutionID)

TheFinancialInstitutionIdentificationnumber.Theterminalchecks
whethertheFinancialInstitutionIdentificationnumberfoundusing
PIDDXmatchesthisfield.Ifitdoes,itusesthisFIT.Ifitdoesnot,it
checksthenextFIT.Therangeofeachdigitinthisfieldis09orF
hex.IfFhexisused,thecorrespondingpositionoftheidentification
numberonthecardisnotcompared.

PSTDX(IndirectNextStateIndex)

Eachdigitofthistwodigitfieldhasaseparatepurpose.
Thefirstdigitspecifiesalogoidentifier,015.Thelogoidentifier
identifiesthelogothatistobeusedifascreencontaininga
FITdependentlogocontrolcodeisdisplayed.
TheseconddigitisusedtoidentifyanentryinaFITSwitchState
table(stateKor_).Theentryidentifiesthenumberofthenext
statethatcontrolwillgoto.Therangeofindirectnextstatesis07
forstateKand014forstate_.Thisfieldusedinassociationwith
aFITSwitchStateenablesyoutoselectdifferentpartsofthestate
flowfordifferentFinancialInstitutions.

PAGDX(Algorithm/BankIDIndex)

TheuseofthisfielddependsonthetypeofPINverificationusedfor
thisFinancialInstitution.
DESverificationfieldnotusedmustbezero.
DieboldverificationthefieldgivestheoffsetoftheAlgorithm
Numberonthecard.Therangeis007Fhex.Ifthevalueinthefield
isFFhex,theAlgorithmNumberisnotonthecard,butisthe
PANPDfieldcontent.NotsupportedbyAdvanceNDCasLocal
DieboldPINverificationisnotsupported.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-4

APTRA Advance NDC, Reference Manual

Financial Institution Tables


FIT Data

PMXPN(MaximumPINDigitsEntered)

Thisfieldisatwodigitnumberthatspecifiesthemaximumnumber
ofdigitsthecardholdercanenterashispersonalidentification
number(PIN).Therangeis0410hex.
ThetypeofPINblockthatistransmittedintheTransactionRequest
messageisspecifiedbythehighestordertwobits,asshowninthe
followingtable:
Table 8-2
PIN Block Type Selection

Bits

PIN Block to be used

Diebold

ISOFormat0(ANSI)

SpecifiedbyPBFMT(PINBlockFormat)

BANKSYS

PCKLN(MaximumPINDigitsChecked)

Thisfieldidentifies:

ThetypeofPINverificationusedforthiscard
Iflocalorremoteverificationisrequired
ThenumberofPINdigitstobechecked
Thelengthoftheoffsetnumber.

ThereareonlythreesupportedmethodsofPINverification,as
follows:

RemoteDES
LocalDES
LocalVISA

ThePCKLNfieldisonebytesplitintotwofields,consistingofthree
bitsandfivebits.Thehighorderthreebitfieldspecifiesthetypeof
localPINverificationtouse:

000DES(LocalorRemote)
001VISA(Localonly)
010DIEBOLD.NotsupportedbyAdvanceNDC.
011,100,101,110,111Reserved

ForLocalVISAPINverification(highorder3bits001),thelower
fivebitfieldspecifiesthenumberofenteredPINdigitstocheck.It
mustbeintherange0410hexandlessthanorequaltoPMXPN.
Thevaluealsospecifiesthelengthoftheoffsetnumber.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-5

Financial Institution Tables


FIT Data

ForDESPINverification(highorder3bits000),thelowerfivebit
fieldspecifiesiflocalorremoteverificationistobeperformed,and
thenumberofenteredPINdigitstocheck.Localverificationis
performedwhenthelowerfivebitfieldisnonzero,inwhichcaseit
mustbeintherange0410hexandlessthanorequaltoPMXPN.
Thevaluealsospecifiesthelengthoftheoffsetnumber.
IfPCKLNiszero,remoteDESPINverificationisperformedandthe
onlysignificantFITentriesarea,b,c,e,g,nando.

PINPD(PINPad)

ThisfieldonlyappliestofinancialinstitutionsthatuseDES
encryptionforremoteverification.Thefieldcontainstwodigits,and
therangeis00CFhex.
Thefirstdigitspecifiesthemethodofencryption,theencryption
keyandwhetherthemessagecoordinationnumbershouldbe
includedinthePINblock.
TheseconddigitisthedigitusedtopadthePIN.
Thefirstdigitisbinaryencoded.Thesignificanceofeachbitisas
follows:
Table 8-3
PINPD Bit Encoding Significance

Bit0(1hex)=

doubleencryptionsequence:
0MASTCOM
1PEKEYCOM

Bit1(2hex)=

double/singledesignator:
0single
1double

Bit2(4hex)=

encryption/noencryption:
0encrypt
1noencrypt

Bit3(8hex)=

coordinationnumber/nocoordinationnumber:
0nocoordinationnumber
1coordinationnumberincluded.
ThisbithasnoeffectifthePINblockformatis
specifiedusingthePBFMTfield.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-6

APTRA Advance NDC, Reference Manual

Financial Institution Tables


FIT Data
Table 8-4
PINPD First Digit Coding

First Digit
Hex Value

Type of
Encryption

Encryption Key and Sequence


First

Second

Single

COM

Double
SeeTableNote2and
TableNote3.

MASTER

COM

Double

PEKEY

COM

None
SeeTableNote1and
TableNote3.

Single

COM

Double
SeeTableNote3.

MASTER

COM

Double

PEKEY

COM

None
SeeTableNote1and
TableNote3.

TableNote1:Theencryptioncommands4andChexwhichcallfor
transmittinganunencryptedPINarenotsecureandarenot
supportedbyAdvanceNDC.
TableNote2:DoubleencryptioninvolvesencryptingthePINfield
usingthefirstencryptionkey,thenencryptingtheencryptedPIN
field,usingthesecondencryptionkey.
(TripleDESencryptioninvolvesencryptingavalueusingthefirst
halfoftheencryptionkey,decryptingusingthesecondhalf,and
thenencryptingwiththefirsthalfagain.)
TableNote3:Whenthekeyentrymodeissettodoublelength
restricted,PINblockencryptionmodes2,4,AandCarenot
permitted.NoPINblockwillbesent.
FordetailsofPINblockformats,seeChapter 11,Security
Features.

PANDX(PANDataIndex)

ThisfieldgivestheoffsetofthePrimaryAccountNumberonthe
card.PANDXspecifiesthislocationastheoffsetfromadelimiter
specifiedinPINDX.TherangeofPANDXis007Fhex.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-7

Financial Institution Tables


FIT Data

PANLN(PANDataLength)

Thisfieldspecifiesthenumberofdigitsfromtheoffset,specifiedby
PANDX,thattheterminalwilluseinPINverification.The
permittedvaluedependsonthetypeofPINverificationbeingused:

DEStwodigitsintherange0010hex
VISAtwodigitswithvalues0Dor10hex

PANLNmustbeequaltoorgreaterthanthePINchecklength
specifiedinPCKLN.IfPANLNis1Fhex,allthedigitsofthePAN
areused,startingfromtheoffsetpositiongivenbyPANDXtothe
fieldseparatorfollowingthePAN.
WhenremotePINverificationisused,thetopthreebitsofthisfield
canbeusedtospecifyiflocalPINcheckingisperformedonashort
PINentry.Ifthevalueofthetopthreebitsequalszeroorisgreater
thanthemaximumPINentrylength,PMXPN,orifPANLNequals
FFhex,nolocalPINcheckingtakesplace.TosupportsecurePIN
encryption,acheckfortheminimumfourdigitsisalways
performedlocally,regardlessofthePANLNsetting.SeeChapter 2,
BPINEntryStatefordetails.
Ifthevalueofthetopthreebitsisnotequaltozeroandislessthan
orequaltothemaximumPINentrylength,PMXPN,localPIN
checkingtakesplace.IfthePINislessthanspecified,alocalPIN
entryerrorisindicated.Fordetails,seetheBPINEntryState
sectioninChapter 2,StateTables.

PANPD(PANPad)

Thisisatwodigitfield.TheusedependsonthetypeofPIN
verificationused.
DES Digit1specifieswhethertheencryptionprocessusesthe
MasterkeyorthePEKEYentryintheFITforPINverification.This
digitmustbe0or8:

0usethePEKEYforencryption
8usetheMasterkeyforencryption.

TherangeofPANPDis000Fhexand808Fhex.PANPDonly
appliestolocalPINverification.
Digit2isthedigitusedtopadthePAN.Thismustbethesameas
theonespecifiedinPINPDforencryptingPINs.
VISA

Notused.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-8

APTRA Advance NDC, Reference Manual

Financial Institution Tables


FIT Data

PRCNT(Track3PIN)

ThisfieldgivestheoffsetforthePINretrycountfieldonthecard.
ThePINretrycountfieldisatwodigitfield,withvaluesinthe
range007Ehex.
Therearetwodifferentmethodsofcountingretries:

ISOeachtryisdecrementedfromaninitialvalue,untilthe
valuereacheszero.Ifthismethodisused,80hexisaddedtothe
number.
MINTSeachtryincrementsavalueuntilitreachestheretry
value.

TherangeofPRCNTis007EhexforMINTSand80FEhexforISO.
IfyouusetheEnhancedPINEntrystate,butdonotrequireTrack3
retries,thisfieldshouldcontainavalueofFFhex.

POFDX(PINOffsetData)

ThisfieldgivestheoffsetfortheOffsetdatafieldonthecard.The
lengthoftheOffsetdatafromPOFDXisgivenbyPCKLN.The
OffsetdataisusedtovalidatethePIN.IftheOffsetdataisnotused,
thensetPOFDXtoFFhex.
WhenVISAPINverificationisbeingused,thisfieldcontainsthe
fivedigitPINverificationkeyindicator,PVKI,followedbythe
fourdigitPINverificationvalue,PVV.
TherangeoftheOffsetdatais007FhexandFFhex.Theoffsetdata
isadded(modulo10)totheleftmostdigitsofthegeneratedPIN.

PDCTB(DecimalisationTable)

ThisfieldisusedforDESPINverificationonly.Itisatableof16
decimaldigitswhichtheterminalusestoconverthexadecimal
digitsgeneratedduringDESPINverificationintodecimalfor
comparisonwiththePINenteredbythecardholder.Thismustbe
identicaltothetableusedforPINgeneration.

PEKEY(EncryptedPINKey)

ThisfieldisusedforDESlocalandremotePINverificationonly.It
is16hexadecimaldigitslongandiscreatedbyencryptingthe
encryptionkeyusedbytheFinancialInstitutionidentifiedinthis
table.YoucanelecttousethePEKEYinthePINPDandPANPD
fields.TheterminaldecryptsthePEKEYusingtheMasterkey.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-9

Financial Institution Tables


FIT Data

PINDX(IndexReferencePoint)

Thissixdigitfieldisthekeytostartingpointsforalloftheother
cardfieldsreferencedintheFITPIDDX,PAGDX,PANDX,
POFDX,PLNDX,andPRCNT.
PIDDXlocatestheFinancialInstitutionIdentificationNumber
PAGDXlocatestheAlgorithmNumber/BankID.Notsupported
byAdvanceNDCasLocalDieboldPINverificationisnot
supported.
PANDXlocatesthePAN
POFDXlocatesthePINOffsetData
PLNDXlocatestheLanguageCode
PRCNTlocatesthePINRetryCount.

PINDXidentifiesthetrack,thestartingpointandthedirectionto
countintofindthedata.PAGDXandtheotherfieldsidentifyhow
fartocounttothebeginningofthedata.
IfthevalueofPIDDXisgreaterthan80hex,thePINDXvalueis
ORedwith1hextoobtainthetruePINDXvalue.
Forexample,ifPINDXcontainsallzerosoritisomittedfromthe
FITdataindexreferencingiscarriedoutasfollows:
IfPIDDXislessthan80hex,allindexreferencingiscarriedout
ontrack2inaforwarddirectionfromthestartsentinel
IfPIDDXisgreaterthan7Fhex,allindexreferencingiscarried
outonTrack3inaforwarddirectionfromthestartsentinel.

Note:Thedelimiterisnotincludedintheoffsetcount.
Thefollowingtablegivesthedigitcorrespondingtoeachvalid
combinationoftracknumber,delimiteranddirection:
Table 8-5
PINDX Index Reference Point

Hex Value

Track No.

Delimiter

Direction

StartSentinel

Forwards

StartSentinel

Forwards

StartSentinel

Forwards

1stFieldSeparator

Forwards

1stFieldSeparator

Forwards

1stFieldSeparator

Forwards

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-10

APTRA Advance NDC, Reference Manual

Financial Institution Tables


FIT Data
Hex Value

Track No.

Delimiter

Direction

EndSentinel

Backwards

EndSentinel

Backwards

EndSentinel

Backwards

EachdigitinPINDXspecifiestrackandindexreferencepointsfor
oneoftheindexentriesintheFIT.Thefollowingtableshowshow
thesedigitsareassigned:
Table 8-6
PINDX Digit Assignment

PINDX Digit

Related Index

Related Card Data

PAGDX

Algorithmnumber(Diebold)
NotsupportedbyAdvanceNDCas
LocalDieboldPINverificationisnot
supported.

PIDDX

FinancialInstitutionIDnumber

PRCNT

PINretrycount

PANDX

PAN

PLNDX

Languagecode

POFDX

PINoffsetdata

PLNDX(LanguageCodeIndex)

Thefieldgivestheoffsetforthelanguagecodeonthecard.This
fieldcanbeusedinconjunctionwithaLanguageSelectFromCard
statetosetthescreengroupthatshouldbedisplayed.Theterminal
usesthelanguagecodetodisplaymultilanguagescreensduringa
transaction.
PLNDXisintherange017Fhex.Avalueof00hexisnotallowedif
thelanguagecodeisused.Avalueof7Fhexmeanszeroifthe
languagecodeisusedandthesearchisbackwardsfromanend
sentinelonly.

PMMSR(MMSensorFlag)

ThefielddescribesMMsensorwithCIM86MCRWusage.
TheCIM86MCRWisnotsupportedbyAdvanceNDC.

PBFMT(PINBlockFormat)

ThisfieldspecifiestheformatofthePINblocktobegeneratedfor
remotePINverification,asfollows:

0Dieboldwithoutcoordinationnumber.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-11

Financial Institution Tables


FIT Data

1Dieboldwithcoordinationnumber(notsupported)
2ISOformat0(ANSI)
3ISOformat1
4ISOformat3
5BANKSYS.

ThisfieldisonlyusedwhenselectedbyPMXPNhavingbit7=0
andbit6=1.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-12

APTRA Advance NDC, Reference Manual

Financial Institution Tables


Linked FITs

LinkedFITs

ThissectionexplainshowtouselinkedFinancialInstitutionTables.
ThisfeatureonlyappliesforlocalPINverification.
DatarelatingtoPINverificationcanappearindifferentlocations,
dependingonthetypeofcardused.Forthisreason,ifafinancial
institutionallowsmorethanonepositiontobeused,the
customisationdatamustincludeoneFITforeachvariation.These
FITsarereferredtoaslinkedFITs.ThefirstFITinagroupoflinked
FITsisknownasthebaseFIT.
AlinkedFITisidentifiedbythefollowingFITentries:

PIDDX
PFIID
ThePINverificationalgorithmbitsinPCKLN
ThetrackdesignatorparametersofPINDX.

Youmustensurethattheseentriesareidenticaltothe
correspondingentriesinthebaseFIT,andthatthebaseFITand
associatedlinkedFITshaveconsecutiveFITnumbers.
ThefollowingFITentriesareusedforlocalPINverification:

PCKLN
PANDX
PANLN
PANPD
POFDX
PDCTB
PEKEY
PRCNTonlyvalidinthebaseFIT
TheindexreferencepointsinPINDX.

NCRrecommendsthatthePSTDXvaluesinlinkedFITshavethe
samevaluesasthebaseFIT.Thelogonumberisalwaysobtained
fromthebaseFIT,buttheindirectnextstateindexisobtainedfrom
thecurrentlyactiveFIT.Thismeansthatitcanbeobtainedfroma
linkedFITiftheFITSwitchstatefollowsaPINEntrystate.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

8-13

Financial Institution Tables


Linked FITs

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

8-14

APTRA Advance NDC, Reference Manual

Table of Contents
Terminal to Central Messages

Chapter 9

TerminaltoCentralMessages
Overview

91

TransactionRequestMessages
TransactionRequestMessageFormat
InteractiveTransactionResponse

92
92
917

SolicitedStatusMessages
ContentofSolicitedStatusMessages
StatusDescriptorField
StatusInformationField
StatusInformation
Ready(B)Status
CashDepositRecycleDataSubfieldg3
RecycleCassetteDispenseDataSubfieldg3
SpecificCommandReject
TerminalState
SendConfigurationInformation
HardwareFitnessSubfieldg3
HardwareConfigurationDataSubFieldg4
SuppliesStatusSubfieldg5
HardwareConfigurationData
SuppliesData
FitnessData
TamperandSensorStatusData
SoftwareIDandReleaseNumberData
EnhancedConfigurationData
LocalConfigurationOptionDigits
ReportCashDepositDefinition
SendSupplyCounters
BasicSendSupplyCounters
ExtendedSendSupplyCounters
SendTallyInformation
SendErrorLogInformation
SendDate/TimeInformation
SendConfigurationID

918
918
918
918
920
921
921
922
923
927
927
929
931
939
940
944
946
948
950
950
951
951
953
953
957
965
966
967
968

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Terminal to Central Messages

SolicitedDeviceFaultStatus
DeviceFaultStatusResponses
DeviceFaultStatusInformationField
GBRUtoCDMMStatusMapping

969
969
970
972

OtherSolicitedMessages
EncryptorInitialisationData
UploadEJDataMessage

973
973
978

UnsolicitedStatusMessages
ConditionsforSendingUnsolicitedMessages
UnsolicitedStatusInformationField

981
981
982

DeviceStatusInformation
TimeOfDayClock(Unsolicited)
PowerFailure(Unsolicited)
CardReader/Writer(Solicited/Unsolicited)
CashHandler(Solicited/Unsolicited)
Depository(Solicited/Unsolicited)
ReceiptPrinter(Solicited/Unsolicited)
JournalPrinter(Unsolicited)
ElectronicJournalPrinter(Unsolicited)
NightSafeDepository(Solicited/Unsolicited)
Encryptor(Unsolicited)
Camera(Unsolicited)
Sensors(Unsolicited)
TouchScreenKeyboard(Unsolicited)
SupervisorKeys(Unsolicited)
CardholderDisplayAlarm(Unsolicited)
StatementPrinter(Solicited/Unsolicited)
VoiceGuidance(Unsolicited)
NoteAcceptor(Solicited/Unsolicited)
EnvelopeDispenser(Unsolicited)
ChequeProcessor(Solicited/Unsolicited)
CoinDispenser(Solicited/Unsolicited)
BarcodeReader(Unsolicited)

984
984
984
985
986
991
992
993
995
998
999
999
9100
9103
9103
9105
9106
9107
9109
9114
9115
9119
9122

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Overview

Overview

Thischapterdescribesthemessagessentfromtheterminalto
Central,asfollows:

Transactionrequestmessages
Solicitedstatusmessages,includingencryptorinitialisationand
EJuploaddata
Unsolicitedstatusmessages
Statusinformationaboutdevicesanddevicefaults

Note:ForanydifferencesonothervendorsSSTs,refertothe
APTRAAdvanceNDC,MultiVendorSupportReferenceManual.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-1

Terminal to Central Messages


Transaction Request Messages

TransactionRequestMessages

TransactionRequestmessagescontainthedatathatCentralrequires
inordertoauthoriseacardholdertransactionattheterminal.The
messageissentduringacardholdertransaction,eitheronentryto
theTransactionRequeststateoraspartofanInteractiveTransaction
messagesequence.

TransactionRequest
MessageFormat

TheformatoftheTransactionRequestmessageisgiveninthe
followingtable:
9

Table 9-1
Transaction Request Message Format
Field

Number of
Characters

Mandatory/Optional

Description

Var

HeaderProtocoldependent.

MessageClass.Themessageclassis:
1Unsolicitedmessage.

MessageSubClass.Themessagesubclassis:
1TransactionRequestmessage.

FS

FieldSeparator

3or9

LogicalUnitNumber(LUNO).ThisNumberisdefinedinafield
transmittedtotheterminalinaConfigurationParametersLoadmessage.
Thedefaultnumberis000.Ifthedatasecurityfeatureisconfigured,an
additionalsixcharactersarepresentwhichcontainthemachinenumber.

FS

FieldSeparator

FS

FieldSeparator

SeeTableNote3

TimeVariantNumber.Thisfieldcancontainaneightdigitnumber
derivedfromthetimeofdaybytheterminalforeachtransactionrequest.
Thedigitscancontainthecharacters09,AF.

FS

FieldSeparator

TopofReceiptTransactionFlag.InformsCentralifreceiptdataforthis
transactionwillprintatthetopofthereceiptasfollows:
0willnotprintdataforthistransactionatthetopofthereceipt
1willprintdataforthistransactionatthetopofthereceipt.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-2

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

Mandatory/Optional

Description

MessageCoOrdinationNumber.Containsacharacterassignedbythe
terminaltoeachtransactionrequestmessage.Theterminalassignsa
differentcoordinationnumbertoeachsuccessivetransactionrequest,on
arotatingbasis.Validrangeofthecoordinationnumberis31hexto3F
hex,orifenhancedconfigurationparameter34MCNRangehasbeen
setto001,from31hexto7Ehex.Centralmustincludethecorresponding
coordinationnumberwhenrespondingwithaTransactionReply
Command.
ThisensuresthattheTransactionReplymatchestheTransactionRequest.
Ifthecoordinationnumbersdonotmatch,theterminalsendsasolicited
statusmessagewithaCommandRejectstatus.
CentralcanoverridetheMessageCoOrdinationNumbercheckby
sendingaCoOrdinationNumberof0inaTransactionReply
command.Asaresult,theterminaldoesnotverifythattheTransaction
Replycoordinateswiththelasttransactionrequestmessage.

FS

FieldSeparator

Var(39)

SeeTableNote1

Track2Data.Containsupto39charactersofTrack2datafromthestart
sentineltotheendsentinelinclusive.Charactersareintherange303F
hex.

FS

FieldSeparator

Var
(106)

SeeTableNote1

Track3Data.Containsupto106charactersofTrack3datafromthestart
sentineltotheendsentinelinclusive.Charactersareintherange303F
hex.

FS

FieldSeparator

SeeTableNote1

OperationCodeData.ContainsthedatacollectedintheOperationCode
bufferasaresultoffunctiondisplaykeyspressed.StatesDPreSet
OperationCodeBufferState,EFourFDKSelectionFunctionState
andYEightFDKSelectionFunctionStatedeterminethecontentsof
thisfield,whichidentifiesthetransactionselectedbythecardholder.

FS

FieldSeparator

8or12

See
TableNote1
TableNote4

AmountEntryField.Identifiestheamountentrymadeatthekeyboard.
ThecontentofthisfieldisdeterminedbytheAmountEntryand
EnhancedAmountEntrystates.Thedataisrightjustifiedwithzerosto
fillunusedpositionsontheleft.Thisfield,ifrequestedinthetransaction
requeststate,iseithereightortwelvebyteslong.Itwillbezerofilledif
noamountentryhasbeenmadesincethelastCardReadstatewas
executed.ThelengthisselectedintheConfigurationParametersLoad
messageortheEnhancedConfigurationParametersLoadmessage.

FS

FieldSeparator

Var(32)

SeeTableNote1

PINBuffer(BufferA).Containsa16characterPIN,encryptedas
specifiedintheFIT,forremotePINverification.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-3

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

Mandatory/Optional

Description

FS

FieldSeparator

Var(32)

SeeTableNote1

GeneralPurposeBufferB.Containsthekeyboarddataenteredduringthe
InformationEntrystateorafterreceivinganInteractiveTransaction
Response.ThelastcharacterinthisbufferisagraphicTiftheterminal
timesoutwaitingforthecardholdertorespond(usingthekeyboard)to
anInteractiveTransactionResponse,oragraphicEifthecardholder
pressestheCancelkey.Minimumdatalengthis3characters.Maximum
datalengthis32characters.
MaycontainanamountvalueenteredduringtheEnhancedAmount
Entrystate.Inthiscase,thebufferlengthwillbethesameastheAmount
EntryField.

FS

FieldSeparator

Var(32)

SeeTableNote1

GeneralPurposeBufferC.Containskeyboarddataasspecifiedbythe
InformationEntrystate.Datalengthcannotexceed32characters.
MaycontainanamountvalueenteredduringtheEnhancedAmount
Entrystate.Inthiscase,thebufferlengthwillbethesameastheAmount
EntryField.

FS

See
TableNote2
TableNote7

FieldSeparator

Track1Identifier.IdentifiesdatainthenextfieldasTrack1data:
1Track1data.

Var(78)

Track1Data.Containsupto78charactersofTrack1datafromthestart
sentineltotheendsentinelinclusive.Thecharacterrangeis205Fhex.

FS

See
TableNote5
TableNote7

FieldSeparator

SeeTableNote5

TransactionStatusDataIdentifier.Identifiesthedatathatfollowsinthe
nextfieldasTransactionStatusdata:
2statusdata.

Var(71)

SeeTableNote5

LastTransactionStatuscontainsstatusdatarelatingtotheprevious
transactionperformedbytheterminal,asfollows:
LastTransactionSerialNumber4bytes
LastStatusIssued1byte.SeeTableNote17.
LastTransactionNotesDispensedData20bytesorVarbytes.SeeTable
Note9.
LastTransactionCoinageAmountDispensed5bytes(always00000)
LastTransactionCoinsDispensedData20bytes
LastTransactionCashDepositData21orVarbytes

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-4

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

Mandatory/Optional

Description

LastTransactionSerialNumbercontainsthefourdigitserialnumberof
thelasttransactionpartiallyprocessedbytheterminal.Ifthisdoesnot
matchthelasttransactionserialnumbersentbyCentral,thistransaction
wasnotinitiated.
LastStatusIssuedcontainsonebyteidentifyingwhatthelastknown
statusmessagesentfromtheterminalwas(otherthandownloadtype
messages).ItdoesnotnecessarilyrelatetotheTransactionSerial
Number.Thevaluewillbeoneofthefollowing:
0nonesent
1goodterminationsent
2errorstatussent
3transactionreplyrejected.
Ifoption76issetto000(fourcassettetypes),LastTransactionNotes
DispensedDatacontainsfourfivedigitdecimalcountsdefiningthe
notesdispensedonthelasttransactionifthelastfunctioncommand
receivedandprocessedwasadispensecommand.Thesecountswillbe
zeroifthelastfunctioncommandreceivedandprocessedwasnota
dispensecommand.
Ifoption76issetto001(sevencassettetypes),LastTransactionNotes
DispensedDatacontainssevenfivedigitdecimalcountsdefiningthe
notesdispensedonthelasttransactionifthelastfunctioncommand
receivedandprocessedwasadispensecommand.Thesecountswillbe
zeroifthelastfunctioncommandreceivedandprocessedwasnota
dispensecommand.
IfaCoinDispenserispresentandoption79issetto000(fourhopper
types),theLastTransactionCoinsDispensedDatacontainsfour
fivedigitdecimalcountsdefiningthecoinsdispensedfromeachhopper
onthelastdispensetransaction.Thesecoincounts(20bytes)willbezero
ifthelastfunctioncommandwasnotacoindispensetypefunction,orif
thisisthefirsttransactionafterinstallation.
IfaCoinDispenserispresentandoption79issetto001(morethanfour
hoppertypes),the25bytesofcoindatainfieldrareallsettozeros,and
theLastTransactionCoinsDispensedDataisprovidedinfieldscf1to
cf<n+1>(dataIDf)ratherthanfieldr.IfaCoinDispenserisnot
present,all25bytesarezero.
TheLastCashDepositTransactionDirectionispresentifaBNAorGBXX
ispresentandcontains1byteasfollows:
0lasttransactionwasnotacashdeposit
1vaultdirection
2refunddirection.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-5

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

Mandatory/Optional

Description

Wherebit0ofoption45(BNASettings)isset,thefollowingdatawillalso
beincluded:
NumberofNotesRefundedduringlasttransaction5bytes
NumberofNotesRejectedduringlasttransaction5bytes
NumberofNotesEncashedduringlasttransaction5bytes
NumberofNotesEscrowedduringlasttransaction5bytes
IftheECB6regulationsareenforcedandlevel3isconfigured,allsuspect
notesareencashedeveniftheLastCashDepositTransactionDirectionis
reportedas2,refunddirection.
Counterfeitnotesarenotreportedinthesefields.
Wherebits1,3and6ofoption45(BNASettings)areset,thefollowing
datawillalsobeincluded:
Numberofrecyclecassettesreported2bytes
NDCCassetteType3bytes
NumberofNotes3bytes
NumberofRecycleCassettesReported.Consistsofatwodigitdecimal
countintherange00to99
Ifnorecyclecassettehasacceptednotes,thisfieldcontains00andthe
NDCCassetteTypeandNumberofNotesfieldsarenotbeincluded.If
thisisnonzero,itindicateshowmanytimestheNDCCassetteTypeand
NumberofNotespairarerepeated.
NDCCassetteType.Consistsofonethreedigitdecimalidentifier.The
identifiercanbebetween001and007dependingonthecashhandler
configuration.Thisfieldisrepeatedthesamenumberoftimesasthe
numberofrecyclecassettesreported.
Ifnorecyclecassettehasacceptednotes,thisfieldisomitted.
NumberofNotes.Consistsofathreedigitdecimalcountofthenumber
ofnotesmovedtotherecyclecassette,intherange001to999.Thisfieldis
repeatedthesamenumberoftimesasthenumberofrecyclecassettes
reported.
Ifnorecyclecassettehasacceptednotes,thisfieldisomitted.
FS

See
TableNote6
TableNote7

FieldSeparator

av1

See
TableNote6
TableNote7

CSPDataIDU.AvalueofU(55H,ASCII)inthisfieldidentifiesthe
followingfieldasthefirstCustomerSelectedPINdata.Ifthisfieldis
selectedintheITransactionRequestStatetable(seeChapter 2,State
Tables)andnoCSPhasbeenrequested,onlythisfieldwillbepresent.

av2

Var(16)

See
TableNote6
TableNote7

CSPData.Thisfieldcontainsanencrypted16characterPIN.SeetheFIT
DatatableinChapter 8,FinancialInstitutionTables.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-6

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

FS

Mandatory/Optional

Description

See
TableNote6
TableNote7

FieldSeparator

aw1

See
TableNote6
TableNote7

ConfirmationCSPDataIDV.AvalueofV(56H,ASCII)inthisfield
identifiesthefollowingfieldasthesecondCustomerSelectedPINdata.If
thisfieldisselectedintheITransactionRequestStatetable(see
Chapter 2,StateTables)andnoCSPhasbeenrequested,onlythisfield
willbepresent.IftheCSPstateindicatesthatlocalverificationofthetwo
CustomerSelectablePINsistobecarriedout,onlytheidentifierwillbe
sentifrequestedbytheTransactionRequestState.

aw2

Var(16)

See
TableNote6
TableNote7

ConfirmationCSPData.Thisfieldcontainsanencrypted16character
PIN.Fordetails,seetheFITDatatableinChapter 8,Financial
InstitutionTables.

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

ax1

See
TableNote6
TableNote7
TableNote8

VCDataIDW.ThevalueWinthisfieldidentifiesthefollowingfield
ascontainingdatainsertedbyExits.

ax2

Var

See
TableNote6
TableNote7
TableNote8

ThisfieldisavailableforusebyExits.

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

ay1

See
TableNote6
TableNote7
TableNote8

VCDataIDX.ThevalueXinthisfieldidentifiesthefollowingfieldas
containingdatainsertedbyExits.

ay2

Var

See
TableNote6
TableNote7
TableNote8

ThisfieldisavailableforusebyExits

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-7

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

az1

Mandatory/Optional

Description

See
TableNote6
TableNote7
TableNote8

VCDataIDY.ThevalueYinthisfieldidentifiesthefollowingfieldas
containingdatainsertedbyExits.

az2

Var

See
TableNote6
TableNote7
TableNote8

ThisfieldisavailableforusebyExits

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

ba1

See
TableNote6
TableNote7
TableNote8

VCDataIDZ.ThevalueZinthisfieldidentifiesthefollowingfieldas
containingdatainsertedbyExits.

ba2

Var

See
TableNote6
TableNote7
TableNote8

ThisfieldisavailableforusebyExits

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

bb1

See
TableNote6
TableNote7
TableNote8

VCDataID[.Thevalue[inthisfieldidentifiesthefollowingfieldas
containingdatainsertedbyExits.

bb2

Var

See
TableNote6
TableNote7
TableNote8

ThisfieldisavailableforusebyExits

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

bc1

See
TableNote6
TableNote7
TableNote8

VCDataID\.Thevalue\inthisfieldidentifiesthefollowingfieldas
containingdatainsertedbyExits.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-8

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

bc2

Mandatory/Optional

Description

Var

See
TableNote6
TableNote7
TableNote8

ThisfieldisavailableforusebyExits.

FS

See
TableNote6
TableNote7
TableNote8

FieldSeparator

bd1

See
TableNote6
TableNote7
TableNote8

SmartCardDataID5.Thevalue5inthisfieldidentifiesthefollowing
fieldascontainingdatainsertedbyEMV/CAM2Exits.

bd2

Var

See
TableNote6
TableNote7
TableNote8

SmartCardData.ThisfieldisavailableforusebyEMV/CAM2Exits.

FS

See
TableNote10

FieldSeparator

ca1

See
TableNote10

DeviceIDw.Thevaluewinthisfieldidentifiesthefollowingtwo
fieldsascontainingcashacceptordata.

ca2

See
TableNote10

Twodigithexadecimalnumber(0132)representinganotetype,
allowingupto50notetypestoberepresented.

ca3

2or3

See
TableNote10
TableNote11

Numberofnotesintheescrow,orvaultedifusingdirectdepositto
cassettes,forthenotetypedefinedinca2.
Thisfieldhaseither2or3digits,dependingonwhetheroption45isset
toreportmorethan90notesornot.
Ifoption45isnotsettoreportmorethan90notes,thisisatwodigit
number(0190).
Ifoption45issettoreportmorethan90notes,thisisathreedigit
number(000999).
Fordetailsofthesettingsforoption45,seepage 1016inthetable
EnhancedConfigurationParametersLoad.

FS

See
TableNote12
TableNote14

FieldSeparator

cb1

See
TableNote12
TableNote14

DocumentDataIDa.Thevalueainthisfieldidentifiesthefollowing
fieldascontainingsinglechequedepositdata.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-9

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

cb2

Mandatory/Optional

Description

See
TableNote12
TableNote13
TableNote14
TableNote16

MagneticInkCodeRecognition(MICR)detected.Thisfieldcontainsthe
value1ifaminimumnumberofMICRcharactershavebeendetected,
orthevalue0iftheMICRonanotherwisegoodchequehasnotbeen
detectedafterretries.

cb3

Var(256)

See
TableNote12
TableNote14

MagneticInkCodeRecognition(MICR)value.Thisfieldisonlypresentif
theMICRdetectedfieldvalueis1,inwhichcaseitcontainstheMICR
readfromthecheque.

FS

ce1

O
See
TableNote15

FieldIDe.Thevalueeinthisfieldshowsthatbarcodedataisbeing
reported.

ce2

ASCIIhexadecimalrepresentationoftheBarcodeFormatidentifier.The
listofbarcodeformatvaluesisbasedontheCENXFSbarcodereader
deviceclass,orthevalue0000ifthebarcodeformatisnotknown.

ce3

Reserved

ce4

Var

Thescannedbarcodedata.Thelengthisdefinedbythebarcodeformat
andthelengthofthescannedbarcode.Thelengthofthewholemessage,
includingthisfield,mustnotexceedthemaximummessagelength,as
definedbytheCOMMSprotocol.

FS

FieldSeparator

cf1

FieldIDf.Thevaluefinthisfieldshowsthatmorethanfourcoin
hoppertypesarebeingreported.

cf2

Numberofcoinsdispensedfromhoppertype1

cf3

Numberofcoinsdispensedfromhoppertype2

cf4

Numberofcoinsdispensedfromhoppertype3

cf5

Numberofcoinsdispensedfromhoppertype4

FieldSeparator

:
Ifacoindispenserispresentandoption79issetto001,theLastTransactionCoinageAmountDispensedis
reportedinfieldscf1tocf<n+1>insteadoffieldrasdescribedonpage 94.
Dependingonthenumberofhoppertypespresent, nisanumberbetween5and8.
:
cf<n
+1>

FS

Numberofcoinsdispensedfromhoppertypen
See
TableNote6
TableNote7

FieldSeparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-10

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

cg1

Mandatory/Optional

Description

See
TableNote6
TableNote7
TableNote18
TableNote19

DataIDg.Thevalueginthisfieldshowsthatabunchchequedeposit
isbeingreported

cg2

SeeTableNote
18

TotalChequestoReturn.Thisfieldcontainsacountofthecheques
insertedintothebunchchequeacceptor,butnotincludedinthedeposit
transaction
Thesechequeshaveeitherfailedthequalityassessmentorthecardholder
hasrequestedtheirreturn.Theyarereturnedtothecardholderwhenthe
remainingchequesareprocessedduringaTransactionReply
Thisfieldis000ifnochequesarereturned
Thefollowingfieldsonlycontaindetailsofthechequesthatarenotgoing
tobereturned

cg3

cg4

cg5

AmountExponentSign.Thisfieldcontainstheamountexponentsign,
whichiseither+or

cg6

AmountExponentValue.Thisfieldcontainstheexponentvalueforall
chequeamountsreportedinthebunchchequedepositbuffer
Theactualchequeamountrelatestotheamountreportedasfollows:
<cheque_amount>=
<cheque_amount_reported>*10^<Exponent>
ThisfieldtogetherwiththeAmountExponentSignfielddefinesthe
<Exponent>value
Forexample,iftheexponentis2andthechequeamountreportedis
1234,thechequeamountis12.34

cg7

12

TotalCustomerAmount.Thisfieldcontainsthesumofallamounts
enteredorcorrectedbythecardholderforchequestobedeposited.Ifthe
cardholderhasnotenteredorcorrectedanamountforacheque,the
derivedamountisusedtocalculatethetotalcustomeramount
Thisfieldcontainsadecimalnumberpaddedtotheleftwithzeros

cg8

12

TotalDerivedAmount.Thisfieldcontainsthesumofallamountsfor
chequetobedepositedderivedfromimageprocessingtechnologies
Thisfieldcontainsadecimalnumberpaddedtotheleftwithzeros
Thisfieldisalwayszero.

cg9

Mustbe0000

cg10

Mustbe0000
SeeTableNote
18

See
TableNote20

DepositCurrency.ThisfieldcontainsthethreecharacterISO4217
currencycodeforthedepositedcheques
Ifmultiplecurrenciesaredeposited,fieldscg4tocg16arerepeatedfor
eachdepositedcurrency

ChequeIdentifier.Thisfieldcontainsathreedigitnumberintherange
001999thatidentifiesaspecificchequeinthedepositrequest
Thevaluestartsat001foreachnewtransaction

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-11

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

cg11

Mandatory/Optional

Description

12

See
TableNote20

CustomerChequeAmount.Thisfieldcontainsthevalueofthecheque
identifiedinfieldcg10asenteredorcorrectedbythecardholder.Ifthe
cardholderhasnotenteredorcorrectedtheamount,thisfieldissetto
zero
Thisfieldsuppliesthe<cheque_amount_reported> valueusedin
calculatingthechequeamountasdescribedinfieldcg6
Thisfieldcontainsadecimalnumberpaddedtotheleftwithzeros

cg12

12

See
TableNote20

DerivedChequeAmount.Thisfieldcontainsthevalueofthecheque
identifiedinfieldcg10asderivedfromimageprocessingtechnologies.If
thereisnoderivedvalue,thisfieldissettozero
Thisfieldsuppliesthe<cheque_amount_reported> valueusedin
calculatingthechequeamountasdescribedinfieldcg6
Thisfieldcontainsadecimalnumberpaddedtotheleftwithzeros
Thisfieldisalwayszero

cg13

See
TableNote20

CodelineLength.Thisfieldcontainsthelengthofthedatareportedin
fieldcg14forthechequeidentifiedinfieldcg10
Thisfieldcontainsadecimalnumberintherange000999

cg14

var

See
TableNote21
TableNote22
TableNote20
TableNote23
TableNote24

CodelineData.Thisfieldcontainsthecodelinereadfromthecheque

cg15

See
TableNote20

ChequeGroupseparator

cg16

See
TableNote19

CurrencyGroupseparator

FS

See
TableNote6
TableNote7

FieldSeparator

ci1

See
TableNote6
TableNote7
TableNote25

FieldID<.Thevalue<inthisfieldshowsthatvoiceguidancedatais
beingreported.

ci2

See
TableNote6
TableNote7
TableNote25

Voiceguidancelanguageidentifier.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-12

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Field

Number of
Characters

Mandatory/Optional

Description

FieldSeparator

Optionaldatafields.Thesefieldswillbeusedforfutureexpansion.

Var

Data.

FS

See
TableNote6
TableNote7

FieldSeparator

See
TableNote3

MessageAuthenticationCodeData.Thisfieldcontainsthecalculated
valueforauthenticationofthismessage.

Table Note 1:Fieldshtonareoptional,andthefieldstobe


includedinthemessagearespecifiedintheTransactionRequest
state.Ifnokeyshavebeenloadedintotheencryptor,fieldlisnot
sent.
Table Note 2:Afieldseparatorandoptionalfieldsoandp
compriseagroup.Whenincludedinthemessage,allthefieldsof
thisgroupmustbepresent.Thefieldseparatormustalsobepresent
ifanyofthesucceedingfieldsarepresent.
Table Note 3:Fieldseandxandtheprecedingfieldseparatorare
presentonlyiftheDatasecurityfeatureisselectedandthesecurity
flagssettingsrequiretheirinclusion.Fordetails,refertotheAPTRA
AdvanceNDC,SupervisorsGuide.
Table Note 4:Thestandardfieldlengthiseightdigits,butitcanbe
configuredfortwelvedigits.Fordetails,seetheConfiguration
ParametersLoadsectioninChapter 10,CentraltoTerminal
Messages.
Table Note 5:Fieldsqandrandtheprecedingfieldseparatorare
presentonlyifEnhancedConfigurationOption15selectsthem.For
details,seetheEnhancedConfigurationParametersLoad
MessagesectioninChapter7andEnhancedConfiguration
ParametersLoadsectioninChapter10.Thefieldseparatormust
alsobepresentifanyofthesucceedingfieldsarepresent.
Table Note 6:Theoptionalfieldsfromav1onwardswiththe
precedingfieldseparatorformfieldgroups.Thenameofeachfield
isgivenbytwoalphabeticcharacterswitheachsubfieldelement
identifiedbyanumericcharacter.Thesefieldsareusedforgeneral
expansionofthetransactionrequestmessage.Eachfieldis
identifiedbyanIDfield.Eachfieldisonlyincludedinthemessage
ifthecorrespondingflagissetintheTransactionRequeststate.If
theTransactionRequeststatespecifiesthatafieldwillbeincluded,
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-13

Terminal to Central Messages


Transaction Request Messages

atleastthedataidentifierwillbepresent.Iftheflagforafieldisnot
set,theentirefieldanditsprecedingfieldseparatorarenot
included.
Table Note 7:Ifanyofthefieldsfromav1onwardsareincludedin
themessage,thefieldseparatorsprecedingfieldsopandqr
willbepresenteveniftheassociateddataisnot.
Table Note 8:Fieldsax*tobd*areavailableforusebyExits.They
maycontainanysevenbitASCIIdatasubjecttolengthlimits
imposedbythecommunicationprotocolinuse,exceptthatthey
mustnotcontainGroupSeparator(1DH)orFieldSeparator(1CH)
characters.
Table Note 9:TheLastTransactionNotesDispenseddataconsistsof
4or7fivedigitdecimalcounts,definingthenotesdispensedinthe
lastdispensetransaction.Ifthelastreceivedcommandwasnota
dispensecommand,thesecountswillbezero.
Table Note 10:Ifacashacceptorispresent,theprecedingfield
separatorandoptionalcashacceptorfieldsca1,ca2andca3are
includedasagroup.Whenmultiplenotetypesarereportedinthe
transactionrequestmessage,thesequenceofthesefieldsisca1ca2
ca3ca2ca3....,whereca2andca3arerepeatedforthetypesthat
arepresent,upto50notetypes.
Table Note 11:IfyouuseECB6,thisfieldincludesnotesidentified
assuspectorauthentic,butnotnotesidentifiedascounterfeit.
Suspectnotesaretreatedasauthenticnotes.
Table Note 12:Ifachequeprocessorispresent,theprecedingfield
separatorandoptionalchequeprocessorfieldscb1,cb2andcb3
areincludedasagroup.Thechequeprocessorfieldsareonly
includedinthemessageifthecorrespondingflagissetinthe
TransactionRequeststate,inwhichcaseatleasttheBufferIdentifier
willbepresent.Whenaflagforafieldisnotset,theentirefieldand
itsprecedingfieldseparatorarenotincluded.
Table Note 13:IfthecorrespondingflagissetintheTransaction
Requeststateandtheoptionalchequeprocessorfieldscb1,cb2
andcb3areusedtoreportabunchchequedeposit,fieldcb2isset
to0.
Table Note 14:Whenanyofthefieldscb1,cb2orcb3aretobe
includedinthemessage,thefieldseparatorsprecedingfieldso
andp,andqandrwillbepresenteveniftheassociateddatais
not.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-14

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

Table Note 15:Ifabarcodereaderispresent,theprecedingfield


separatorandoptionalbarcodereaderfieldsce1,ce2andce4are
includedasagroup.Thebarcodereaderfieldsareonlyincludedin
themessageifthecorrespondingflagissetintheTransaction
Requeststate,inwhichcaseatleasttheBufferIdentifierwillbe
present.Whenaflagforafieldisnotset,theentirefieldandits
precedingfieldseparatorarenotincluded.
Table Note 16:IftheMICRisnotdetectedafterallretries,theremay
benoMICRcodelineonthecheque.Allchequedetailsarestillsent
toCentral,incasethechequecanbeendorsedwithouttheMICR
beingread.
Table Note 17:TheLastStatusIssuedbyteappliesonlytosolicited
statusmessages;unsolicitedmessagesarenotpartofthetransaction
status.
Table Note 18:IfthefieldgroupwithDataIDgispresentandall
chequesaretobereturned,onlyfieldcg2isincluded.Ifanyfield
fromcg4onwardsisalsopresent,fieldscg2tocg9aremandatory.
Table Note 19:Tosupportchequedepositsofmorethanone
currency,fieldscg4tocg16arerepeatedforeverycurrency
exceptforthelastcurrencyinthemessagewhenfieldcg16is
omitted.Thetotalsinfieldscg7andcg8containthetotalsforthe
firstcurrencyandarefollowedbythedetailsforthechequesinthe
firstcurrency.Thisgroupingisrepeatedforeachadditional
currency.
Table Note 20:Thedetailsforeachchequetobedepositedmustbe
providedinthefieldgroupwithDataIDg,withfieldscg10to
cg14repeatedtoreporteverychequetobedepositedinthis
transaction.Thedetailsforeachchequeareseparatedfromthe
previouschequedetailsbyagroupseparator(fieldcg15)andeven
thelastchequehasatrailinggroupseparator.
Table Note 21:ThecharactersreadfromthecodelineinE13Bformat
willhavethefollowingencoding:
Table 9-2
E13B Codeline Encoding

E13B
Character

E13B Meaning

09

09

NDC Character

Hex Value

09

0x30to
0x39

0x62

Amount

0x63

OnUs

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-15

Terminal to Central Messages


Transaction Request Messages
E13B
Character

NDC Character

Hex Value

E13B Meaning

0x64

Transit

0x2D

Dash

space

0x20

space

Space

0x41

N/A

Reject/Unreadable

Table Note 22:ThecharactersreadfromthecodelineinCMC7


formatwillhavethefollowingencoding:
Table 9-3
CMC7 Codeline Encoding

CMC7
Character

CMC7 Meaning

09

09

NDC Character

Hex Value

09

0x30to
0x39

0x62

S2StartoftheAmount
field

0x61

S1StartofBankAccount

0x65

S5Transit/Routing

0x64

S4Unusedinnormal
cheques

0x2D

S3TerminateRouting

space

0x20

space

Space

0x41

N/A

Reject/Unreadable

Table Note 23:ThecodelinefieldinthefieldgroupwithDataIDg


isemptyifitcannotberead.
Table Note 24:IfthefieldwithDataIDaisusedtodepositabunch
ofcheques(thatis,usingthesinglechequeTransactionRequest
buffer),nocodelinedataisprovidedandfieldcb2inbufferaisset
to0.
Table Note 25:Thevoiceguidancebytesareonlypresentifthe
transactionisavoiceguidedtransactionandthebufferisdefinedin
theXMLconfigurationfile.Ifthevoiceguidancebufferisnotused,
theOperationCodefield(fieldj)canbeusedtoidentify
voiceguidedtransactionsandthelanguageused.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-16

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Transaction Request Messages

AdvanceNDCalwayssendasolicitedstatus(errororready)in
responsetoatransactionreply.TheLastStatusIssuedbytevalueof
0willonlybeseeniftheterminalisresetwhileprocessinga
transactionreply,orontheveryfirsttransactionafterpersistent
memoryiscleared.
Thisfieldispresenttoguardagainstthepreviousresponsebeing
lostduetoacommunicationsfailure,andindicateswhatstatus
AdvanceNDCpreviouslyattemptedtosendtoCentral.Thisisso
thatacommunicationsfailurewillnotcausethevaluetobesetto0.
IfyouhaveproblemsreconcilingtheunsolicitedE5message
(unknownnumberofnotesretracted)withthetransaction,then
messagemodeOptionDigit4Ashouldbeusedtosendadelayed
dispenserstatusmessage.

InteractiveTransaction
Response
Table 9-4
Reply to Interactive Transaction Response

WhentheTransactionRequestmessageissentinreplytoan
InteractiveTransactionResponse,itdiffersfromtheprevious
descriptioninthatitconsistsonlyofthefollowingfields.
b

MessageClass

MessageSubClass
FieldSeparator

LogicalUnitNumber
2FieldSeparators

TimeVariantNumber
FieldSeparator

TopofReceiptTransactionFlag

MessageCoOrdinationNumber
6FieldSeparators

GeneralPurposeBufferB.Minimumdatalengthis1characters.;
1or2FieldSeparators
SeeTableNote26

MACData

Table Note 26:Iftheamountenteredexceedsthelimitof32bytes,


thenextkeypressclearsthebuffer,resettingthevalueto0and
restartingtheentryfromthebeginning.
Forfurtherinformationaboutgeneralpurposebuffers,refertothe
APTRAAdvanceNDC,DevelopersGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-17

Terminal to Central Messages


Solicited Status Messages

SolicitedStatusMessages

TheterminalrespondstoacommandfromCentralbysendinga
solicitedstatusmessage.Thissectiongivesinformationaboutthe
formatandcontentofsolicitedstatusmessages.

ContentofSolicitedStatus
Messages

Theinformationinthestatusmessagedependsonthecommand
received,andwhetherornottheterminalcanperformthe
instruction.Thefollowingfieldsinthestatusmessagecontainthis
information:

StatusDescriptor
StatusInformation.

Note:Exitscanalsosendsolicitedstatusmessages.Thesehavethe
sameformatasstandardsolicitedstatusmessages,butthecontent
oftheStatusDescriptorandStatusInformationfieldsdependson
theExit.Formoreinformation,refertoAPTRAAdvanceNDC,
ExtendingtheProduct.

StatusDescriptorField

Thestatusdescriptorfieldidentifieswhichofthefollowing
conditionsisbeingreported:

Ready.Thecommandhasbeenperformedsuccessfully
DeviceFault.Adevicefaulthasoccurred
CommandReject/SpecificCommandReject.Thecommandhas
beenrejected
TerminalState.Thevaluesofsupplycountersorterminal
configurationareincludedinthemessage.

StatusInformationField

Thestatusinformationfieldcontainsadditionalinformationwhena
DeviceFault,SpecificCommandRejectorTerminalStatedescriptor
isused.Formoredetails,seeStatusInformationonpage 920.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-18

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Table 9-5
Solicited Status Message Format
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
2Solicitedmessage.

MessageSubClass.Themessagesubclassis:
2Statusmessage.

FS

FieldSeparator

3or9

LogicalUnitNumber(LUNO).Thisnumberisdefinedinafield
transmittedtotheterminalinaConfigurationParametersLoad
message.Thedefaultnumberis000.Ifthedatasecurityfeatureis
configured,anadditionalsixcharactersarepresentwhichcontainthe
machinenumber.Fordetails,seetheAPTRAAdvanceNDC,
SupervisorsGuide.

FS

FieldSeparator

FS

FieldSeparator

See
TableNote27
TableNote28

TimeVariantNumber.Containsaneightdigitnumberderivedfrom
thetimeofdaybytheterminalforeachstatusmessage.Thedigitscan
be09,AF.

FS

See
TableNote27

FieldSeparator

StatusDescriptor.Describesthestatusmessageasfollows:
8

DeviceFaultThisindicatesthataterminaldeviceis
reportingabnormalstatus.Thisvalueisalsousedina
configurationIDstatusmessage.

ReadyThisindicatesthattheinstructionwascompleted
successfully.

CommandRejectThisisinsertedintothestatusdescriptor
fieldunderthefollowingconditions:
1.Terminalreceivesanillegalcommand.
2.TerminalreceivesillegaldatafromCentral.
3.Terminalreceivesdatawhilenotinthecorrectmode.
Formoreinformation,seetheMessageValidationsection
inChapter 10,CentraltoTerminalMessages.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-19

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

ReadyThisindicatesthattheTransactionReplywas
successfullycompleted.(WhenseparateReadyfor
TransactionReplycommandsoptionhasbeenselectedasa
configurationparameter.)

SpecificCommandRejectThisissenttoindicatearejection
ofthemessageforauthenticationfailure,orifthespecific
commandrejectoptionissetandamessageisrejectedthat
wouldotherwisegenerateacommandrejectA.Thestatus
informationfieldidentifiesthereasonforrejection.

TerminalStateThisissentinresponsetoTerminal
Commandsrequestingsupplycounters,terminal
configurationinformation,orthedateandtime.

FS

See
TableNote29

FieldSeparator

Var

See
TableNote29

StatusInformation.Additionalstatusinformationissentonly
whenthestatusdescriptorcontains8,CorF.

FS

See
TableNote27
TableNote28

FieldSeparator

See
TableNote27
TableNote28

MessageAuthenticationCode(MAC)Data.Containsthe
calculatedvalueforauthenticationofthismessage.The
charactersareintherange09andAF.

Var

Trailer.Protocoldependent.

Table Note 27:ThisisnotsentunlessMessageAuthenticationisin


use,andhasbeenselectedforsolicitedstatusmessages.Fordetails,
seetheMessageAuthenticationFieldSelectionLoadsectionin
Chapter 10,CentraltoTerminalMessages.
Table Note 28:ThisisnotsentiftheStatusDescriptorfieldcontains
9orB.
Table Note 29:ThisisnotsentunlesstheStatusDescriptorfield
contains8,CorF.

StatusInformation

AdditionalinformationcanoptionallybecontainedintheStatus
InformationfieldwhentheBReadystatusdescriptorisused.
AdditionalinformationisalwayscontainedintheStatus
Informationfieldwhenthefollowingstatusdescriptorsareused:

CSpecificCommandReject
FTerminalState
8DeviceFault.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-20

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Ready(B)Status

WhentheStatusDescriptorisBandtheReadystatusissetto
includetransactionstatusdata,thefollowinginformationispresent
intheStatusInformationfield.FordetailsofsettingtheReady
statustoincludetransactionstatusdata,seeSupplyMode,Ready
Status&AmountBufferLength(Fieldm)onpage 72.
Table 9-6
Ready (B) - Status Information
Field

Number of
Characters

Mandatory/Optional

Description

g1

TransactionSerialNumber(TSN).ContainstheTSNofthelast
transactionprocessedbytheterminal.

FS

FieldSeparator
SeeTableNote30

g2

DataIdentifier.Identifiesthedatathatfollowsinthenextfieldas
follows:
1RecycleCassetteDepositData
2RecycleCassetteDispenseData

g3

Var

TransactionData.Containsthetransactiondataasfollows:
Foradepositusingrecyclecassettes,seeCashDepositRecycleData
Subfieldg3onpage 921
Foradispenseusingrecyclecassettes,seeRecycleCassetteDispense
DataSubfieldg3onpage 922.
SeeTableNote31

Table Note 30:Ifnoadditionaldataispresent,thefieldseparatoris


omitted.Newdatagroupsmaybeincludedinthefuture.
Table Note 31:Agroupseparatorfollowseachreportedcassette,
exceptthelast.
CashDepositRecycleDataSubfieldg3 Ifthetransactionis
identifiedasadepositusingrecyclecassettesorhascausedthe
statusoftherecyclecassettestochange,thefollowingdatais
returnedintheReadyBmessage:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-21

Terminal to Central Messages


Solicited Status Messages
Table 9-7
Cash Deposit: Recycle Data

Number of Bytes

Description

NumberofCDMRecycleCassetteTypes
Reported.Thisisintherange01to99.

CDMNDCCassetteType.Consistsofone
threedigitidentifierofthecassettetypebeing
reportedon.Theidentifiercanbebetween001
and007.
ThisisrepeatedforeachCDMcassettethathas
acceptednotes.SeeTableNote32

NumberofNotesStoredorRetained.Consistsof
athreedigitdecimalcountofthenumberof
notesdeposited.Thisisintherange001to999.
ThisisrepeatedforeachCDMcassettethathas
acceptednotes.SeeTableNote32

CurrentFitnessStatus.Fordetails,seeFitness
Dataonpage E19.
ThisisrepeatedforeachCDMcassettethathas
acceptednotes.SeeTableNote32

CurrentSuppliesStatus.Fordetails,see
SuppliesDataonpage E11.Thisfielddoes
notreportnochange.
ThisisrepeatedforeachCDMcassettethathas
acceptednotes.SeeTableNote32

GS.SeeTableNote32

Table Note 32:IfthenumberofCDMrecyclecassettetypesis


greaterthan1,fieldsCDMNDCCassetteTypetotheGSinclusive
arerepeatedforeveryCDMcassettethathastakennotes.TheGS
forthelastcassettereportedisomitted.
RecycleCassetteDispenseDataSubfieldg3 Ifthe
transactiondataisidentifiedasadispenseusingrecyclecassettesor
hascausedthestatusofrecyclecassettestochange,thefollowing
dataisreturnedintheReadyBmessage:
9

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-22

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Table 9-8
Recycle Cassette: Dispense Data

Number of Bytes

Description

NumberofCIMRecycleCassetteTypes
Reported.Thisisintherange01to99.

CIMNDCCassetteType.Consistsofone
threedigitidentifierofthecassettetypebeing
reportedon.Theidentifiercanbebetween001
and255.ThisisrepeatedforeachCIMcassette
thathasdispensednotes.SeeTableNote32

NumberofNotesDispensed.Consistsofa
threedigitdecimalcountofthenumberofnotes
dispensed.Thisisintherange001to999.
ThisisrepeatedforeachCIMcassettethathas
dispensednotes.SeeTableNote32

CurrentFitnessStatus.Fordetails,seeCash
AcceptorFitness(DIGw)onpage E23.
ThisisrepeatedforeachCIMcassettethathas
dispensednotes.SeeTableNote32

CurrentSuppliesStatus.Fordetails,seeCash
AcceptorSupplies(DIGw)onpage E16.This
fielddoesnotreportnochange.
ThisisrepeatedforeachCIMcassettethathas
dispensednotes.SeeTableNote32

GS.SeeTableNote32

SpecificCommandReject

WhentheStatusDescriptorisCSpecificCommandReject,the
followinginformationispresentintheStatusInformationfield.For
detailsoftheconditionsunderwhichindividualstatusvaluesare
generated,seeMessageValidationonpage 1086.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-23

Terminal to Central Messages


Solicited Status Messages
Table 9-9
Specific Command Reject - Status
Information
Field

Number of
Characters

Mandatory/
Optional

Description

g1

StatusValue.Givesthereasonforrejectingthecommand.Valuesare:
1MACFailure.ResultofMACverificationdidnotequaltheMACfieldin
themessage.
2TimeVariantNumberFailure.Thetimevariantnumberreceivedinthe
lastTransactionReplymessageisnotthesameasthelasttransmittedvalue.
3SecurityTerminalNumberMismatch.Thenumberreceivedinthelast
transactionreplysecurityterminalnumberisnotthesameasthenumber
heldintheterminal.
AMessageFormaterror.
(g2)StatusQualifier:
01

Messagelengtherror.

02

FieldSeparatormissing/unexpectedlyfound.

03

TransactionReplymessagehastoomanyprintgroups.

04

GroupSeparatormissing/unexpectedlyfound.

07

MalformedXML.

08

XMLdoesnotconformtoXMLschema.

BFieldValueerror.
(g2)StatusQualifier:
01

IllegalMessageClass.

02

IllegalMessageSubClassorIdentifier.

03

IllegalEncryptionKeyChangeorExtendedEncryptionKeyChange
MessageModifier.

04

IllegalTerminalCommandCode.

05

IllegalTerminalCommandModifier.

06

IllegalTransactionReplyFunctionIdentifier.

07

Datafieldcontainsnondecimaldigit.

08

Datafieldvalueoutofrange.

09

InvalidMessageCoOrdinationnumber.

10

IllegalFITnumber.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-24

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/
Optional

Description

11

Toomanynotesinadispensefunction.

12

Reserved

13

UnrecognisedDocumentDestination.

14

Reserved

15

UnrecognisedBufferIdentifier.

16

Reserved

17

DocumentNameError.

18

Thescreenidentifierisoutofrange.

19

Reserved

20

Nodatasuppliedtoendorsecheque

21

Reserved

22

InvalidEncryptionKeySize.

23

RSASignatureVerificationFailed.

24

SignatureorEncryptionKeyPKCS#1PackingFailed.

25

SignatureorEncryptionKeyPKCS#1UnpackingFailed.

26

InvalidSignatureorEncryptionKeyPKCS#1PadBlockType.

27

FixedHeaderDecryptionFailed.

28

NullByteAfterPaddingMissing.

29

InvalidPadByteCount.

34

Invalid/IncompleteChequeIdentifier(s).

35

PassbookupdatenotsupportedinspecifiedTransactionReply
Function.

CIllegalMessagetypeforcurrentmode.
(g2)StatusQualifier:
01

MessagetypeonlyacceptedwhileterminalisInServiceand
expectingaTransactionReply

02

Messagenotacceptedwhilediagnosticsisin progress.Thisis
returnedwhentheapplicationhaspassedcontroltoVDM

03

MessagenotacceptedwhileinOutofServiceorSupplymode

04

MessagenotacceptedwhileinInServicemode

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-25

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/
Optional

Description

05

MessagenotallowedwhileconfiguredforNCRstatusmessage
mode

0609

Reserved

10

MessagenotacceptedwhileprocessingaTransactionReply.

11

Chequenotpresentinchequeprocessortransportwhileprocessinga
TransactionReply

1214

Reserved

15

EncryptionKeyChangeorExtendedEncryptionKeyChange
messagenotacceptedduringacardholdertransaction,orwhilethe
terminalisinsuspendmode,orwhiletheoperatorisinitiatingthe
executionofsupervisory/settlementtransactions.

16

Reserved

17

Keychangeoperationcannotbeacceptedinrestrictedencryption
mode.ThisapplieswhenanExtendedEncryptionKeyChange
messagewithmodifier3,4,6or7isreceivedinrestrictedmode.

18

Keyentrymodenotauthorised.

DHardwareFailure.
(g2)StatusQualifier:
01

EncryptionfailureduringEncryptionKeyChangeorExtended
EncryptionKeyChangemessage.

02

TimeofDayClockfailureorinvaliddatasentduringDate/TimeSet
command

0305

Reserved

06

Insufficientdiskspace.

07

FileIOerror.

08

Filenotfound.

ENotSupported.
(g2)StatusQualifier:
01

ADLLrequiredtocompletethetransactionreplyprocessingis
missing.

02

Requireddevicenotconfigured.Also,sidewaysprintonthereceipt
isrequested,buteithertheprinterdoesnothavethecapabilityorhas
notbeenconfiguredforsidewaysprinting.

03

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-26

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

g2

Number of
Characters

Mandatory/
Optional

Description

04

Reserved

05

Journalprinterbackupinactive

StatusQualifier.PresentforstatusvaluesAE.(Seeprecedingtext)

TerminalState

Thissectiondescribeswhatinformationcanbecontainedinfieldg,
theStatusInformationfield,whentheStatusDescriptorisF
TerminalState.
Fieldgismadeupofanumberofsubfieldsnamedg1,g2,g3
andsoon.Subfieldg1identifieswhichterminalcommandhas
beenreceived,asshowninthefollowingtable.Theremaining
subfieldscontainthestatusinformationrequestedbythat
command,asshowninthesubsequenttables.
Table 9-10
Terminal State - Status Information
Sub-Field g1

Terminal Command

Sub-Field g1

Sendconfigurationinformation

Sendsupplycounters

Sendtallyinformation(unsupported)

Senderrorloginformation(unsupported)

Senddate/timeinformation

SendconfigurationID

EKCretrievehallmarkkey(unsupported)

Hardwareconfigurationdata

Suppliesdata

Fitnessdata

Tamperandsensorstatusdata

SoftwareIDandreleasenumberdata

Localconfigurationoptiondigits

Sendnotedefinitions(BNA)

SendConfigurationInformation

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationTerminalCommandmessage(a
commandcodeof7withnocommandmodifier,oracommand

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-27

Terminal to Central Messages


Solicited Status Messages

modifierof6toincludeenhancedconfigurationinformation).The
responsereturnsalltheconfigurationinformationavailable.
Ifamessagewithacommandcodeof7alsohasacommand
modifier,theresponsereturnstheconfigurationinformation
specifiedbythecommandmodifier.Fordetailsoftheterminal
commandcode,seeConfigurationInformation(CommandCode=
7)onpage 104.
Fortheconfigurationresponseswhenamodifierotherthan6is
included,seesectionsHardwareConfigurationDataonpage 940
toReportCashDepositDefinitiononpage 951.
Table 9-11
Send Configuration Information Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessageissenttoCentralinresponsetoa
SendConfigurationInformationTerminalCommandmessageandhas
identifier1

g2

ConfigurationID.ContainsthelastfourdigitconfigurationID
numbers(00009999)senttotheterminalfromCentral

FS

FieldSeparator

g3

22or38

HardwareFitness.Containsonebyteforeachdeviceormajordevice
resource.Thepositionofthebyteidentifiesthedevice;thebyte
indicatesthefitnessstatus.Fordetails,seeHardwareFitness
Subfieldg3onpage 929

FS

FieldSeparator

g4

44or76

HardwareConfiguration.Containsinformationforeachdevice
indicatingwhetherornotitisconfigured.Ifconfigured,itgivesdetails
ofwhichoption,ifany,isconfigured.Fordetails,seeHardware
ConfigurationDataSubFieldg4onpage 931.
Note:Asthebytesizeforthisfieldislimited,somenewdevice
configurationscannotbesent,forexamplebarcodereader.

FS

FieldSeparator

g5

23or26

SuppliesStatus.Containsonebytepertypeofmediacontaineror
resource.Thepositionofthebyteidentifiesthemediaresource;the
byteindicatesthesuppliesstatus.Fordetails,seeSuppliesStatus
Subfieldg5onpage 939

FS

FieldSeparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-28

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

g6

5or12

SensorStatus.Containsonebytepersensorandisidenticaltothe
informationreportedincharacters213oftheSensorsStatusmessage
includedlaterinthischapter.
Asinthestatusmessages,TIsensorsarereportedonlyiftheTIfeature
isconfigured.
Thenumberofcharactersisalwaystwelveiffieldsg7andg8are
present.ThelastsevenbytesareblankifnoTIispresent

FS

FieldSeparator

g7

AdvanceNDCReleaseNumber.Containsasixdigitdecimalnumber.
Thefirstpairofdigitsrepresentsthereleasenumber.Thesecondpair
ofdigitsrepresentsthepointreleasenumber.Thethirdpairofdigits
representsthepatchreleasenumber.SeeTableNote33.

FS

FieldSeparator

g8

AdvanceNDCSoftwareID.ContainstheAdvanceNDCSoftwareID.
Thefieldtakesthefollowingvalues:
G5310283 (AdvanceNDCpackage)
IftheAdvanceNDCsoftwareIDisunavailable,thisfieldcontains
nineblanks.SeeTableNote33.

Table Note 33:Fieldsg7andg8areincludedonlyifthe


appropriatemessagemodeoptiondigitisset.Fordetailsofthis
optiondigit(6C,addtheAdvanceNDCReleaseNumberand
SoftwareIDfieldstotheConfigurationTerminalStateMessage),
refertotheAPTRAAdvanceNDC,SupervisorsGuide.
HardwareFitnessSubfieldg3 Thedeviceisidentifiedbythe
positionofthebyte,asshowninthefollowingtable.Thefield
returnsthefitnessofmostdevicesandmodulesforanoverallview
ofthestateoftheSST.
Table 9-12
Hardware Fitness Sub-Field g3

Byte position

Device indicated

TimeofDayClock,seeTableNote34

HighOrderCommunications

SystemDisk

MagneticCardReader/Writer,seeTableNote34

CashHandler,seeTableNote34

Depository,seeTableNote34

ReceiptPrinter,seeTableNote34

JournalPrinter,seeTableNote34and

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-29

Terminal to Central Messages


Solicited Status Messages
Byte position

Device indicated

Reserved

Reserved

10

NightSafeDepository,seeTableNote34

11

Encryptor,seeTableNote34

12

SecurityCamera

13

DoorAccess(notsupported)

14

FlexDisk

15

Cassettetype1

16

Cassettetype2

17

Cassettetype3

18

Cassettetype4

1920

Reservedfornewdevice (=0)

21

StatementPrinter,seeTableNote34

22

SignageDisplay,seeTableNote36

2324

Reserved,seeTableNote36

25

SystemDisplay,seeTableNote36

26

MediaEntryIndicators,seeTableNote36

27

EnvelopeDispenser,seeTableNote34andTable
Note36

28

DocumentProcessingModule(notsupported)
SeeTableNote36

29

CoinDispensingModuleTamperIndication
SeeTableNote36

30

DocumentProcessingModule,ModuleTamper
Indication(notsupported)
SeeTableNote36

31

Reserved,seeTableNote36

32

VoiceGuidanceSystem
SeeTableNote36

33

Reserved,seeTableNote36

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-30

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Byte position

Device indicated

34

BunchNoteAcceptor
SeeTableNote36

35

ChequeProcessor
SeeTableNote36

3637

Reserved,seeTableNote36

Table Note 34:TherelationshipbetweentheDeviceIdentifier


Graphic(DIG)inthestatusmessageandtheoffsetintheFitness
tableis:offset = DIG - 41 hex
Table Note 35:WhendualmodeisconfiguredusingEnhanced
ConfigurationParameteroption35,onlythestatusofthephysical
deviceisreported.Fordetailsofoption35,seeOption35Report
DualModeEJ&HardcopyB/UUnsolicitedMessageson
page 712.
Table Note 36:Thesefieldsarereturnedonlyifcommandmodifier
6,Sendenhancedconfigurationdata,isused.Fordetails,see
ConfigurationInformation(CommandCode=7)onpage 104in
tableTerminalCommandsonpage 102.
FitnessSeverity Eachbyteindicatesthecurrentfitnessofthe
devicebyaseverityvalue,asshowninthefollowingtable.Routine,
warningandfatalconditions(severityvalues1,2and4)canonlybe
clearedbylocalsupervisorfunctions.
9

Table 9-13
Hardware Fitness Severity Values

Severity Value

Meaning

Noerror

Routineerrorshaveoccurred

Warningconditionshaveoccurred
investigationrequired

Suspend.Terminaliscurrentlyinsuspendstate
duetosuspectedtamperingwiththisdevice

Fatalerrorconditionexists

HardwareConfigurationDataSubFieldg4 Theconfiguration
dataforeachdeviceisreportedastwohexadecimalcharacters
representingabyteofconfigurationinformation.Thefollowing
tablegivesdetailsofthebytepositionforeachdeviceandthevalue
orbitsignificanceofeachbyteasappropriate.
9

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-31

Terminal to Central Messages


Solicited Status Messages
Table 9-14
Hardware Configuration Data: Sub-Field
g4

Byte

Device

Product

Class

0E
0F
10
11
12
13
14
15
16
17
18
19
1A
1B
1C
1D
1E
1F
20
21
22
23
24
25
26
27
28
29
2A

5663
5674
5675
5684
5685
5688
5665
5670
Personas75
Personas88
Personas40
Personas70
Personas74
Personas84
Personas85
Personas90
EasyPoint55orEasyPoint57
Personas86
5588
Personas73
Personas72
Personas77
6674
6676
5879
5887
5362
Personas71
5867

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-32

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Byte

Device

6622
6624
6626
6628
6631
6632
6634
6638
6625
6618
6636
2012(SelfServ22e)
2016(SelfServ16)
6642(SelfServ42)
2004(SelfServ4)
2008(SelfServ8)
Note:ThislistdoesnotimplyAdvanceNDC
supportforalltheseproductclasses.

30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
3F

7F

SystemDisk
00
01
02

Noconfiguration

Harddiskpresent
Reserved
Reserved

MagneticCardReader/Writer.SeeTableNote37.
00
01
03
05
07
08
09
0A
0B
0C
10
11
1D
1E
1F
20

Nocardreaderattached
Track2(readonly)
Track1/2/3MCRW(writeontrack3only).
(Alsoreturnedifcardreadercannotbeidentified)
PCDipReader
3TrackWriteMCRW
Track2SmartCardReader
Track1/2/3SmartCardReader
3TrackWriteSmartCardReader
Track1/2andTrack2/3DipMSR
Track1/2/3CIM86MCRW
Track1/2DipMSR
Track1/2SwipeReader
DipandSmartHardware(DASH)Reader
Track1/2/3withMM
Track1/2/3SmartwithMM
Track3SmartwithMM

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-33

Terminal to Central Messages


Solicited Status Messages
Byte

Device

CashHandler.SeeTableNote37,TableNote41andTableNote
42
00
01
02
03
04

EnvelopeDepository.SeeTableNote37.
00
01
02
03
04

Notconfigured
Integraljournalprinter
Reserved
Thermalprinter
Electronicjournal
Electronicjournalandintegraljournalprinter
Reserved
Electronicjournalandthermalprinter

Reserved
00

Notconfigured
Plainpaper
Blackdotpaper
Sidewaysprinting,noblackmark
Sidewaysprinting,blackmark
Thermalprinternoblackmark
Thermalprinterblackmark
Thermalprintersidewaysprinting,noblackmark
Thermalprintersidewaysprinting,blackmark

JournalPrinter.SeeTableNote37.
00
01
02
03
80
81
82
83

Notconfigured
Reserved
ProgrammablePrintingDepository(PPD)
Reserved
Reserved

ReceiptPrinter.SeeTableNote37.
00
01
02
03
04
05
06
07
08

Notconfigured
Stackingcashhandler
Spraycashdispenser
Stackingcashhandlerwithrecyclecapabilities.See
TableNote38
Stackingcashhandlerwithrecyclecapabilities
disabled.SeeTableNote38

Notconfigured

Reserved
00

Notconfigured

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-34

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Byte

Device

10

NightSafeDepository.SeeTableNote37.
00
01
02

11

Encryptor.SeeTableNote37.
?0
?1
02
03
04
05
06
?7

12

13

Notconfigured
BAPEencryptor.
Reserved
Reserved
Reserved
Reserved
Reserved
EPPencryptor
?=SSTkeyentrymode(0,B,CorD)where:
0=singlelengthkeyswithoutXORkeyentry
B=singlelengthkeyswithXORkeyentry
C=doublelengthkeys
D=doublelengthkeys,restrictedmode.SeeTable
Note39
Forexample,C7=doublelengthkeyentrywithanEPP
encryptor.

SecurityCamera
00

Notconfigured

01

Fixedformat

02

Variableformat

03

Reserved

04

Digital

DoorAccess(notsupported)
00

14

Notconfigured
Configured
Reserved

Notconfigured

FlexDisk
00
01
02

Notconfigured
1.44MBflexdiskconnected
2.88MBflexdiskconnected

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-35

Terminal to Central Messages


Solicited Status Messages
Byte

Device

15

TamperIndicating(TI)Bins.SeeTableNote37.
Notcoindispenser
01

16

CardholderKeyboard
00
01
02

17

Reserved
Standard(BAPE)keyboard
EPPkeyboard

OperatorKeyboard
00
01
02

18

Securecashandinsecurecards,andeitherinsecure
depositbinornoenvelopedepository(PPD).This
valueisalwayssetto01asAdvanceNDCcannot
determineifTIexistsinamultivendorenvironmentas
thiscapabilityisnotsupportedinCENXFS.

Notconfigured
Standardkeyboard(basic)
KeyboardplusFDKs(enhanced)

CardholderDisplay/Voice
Bit0
Bit1
Bit2
Bit2
Bit3
Bit3
Bit4
Bit5
Bit6
Bit7

0(always)
0(always)
0Voicenotsupported
1Voicesupportedifdigitalaudiopresent.
0StandardFDKs
1Touchscreen
0(always)
0(always)
0(always)
0(always)

19

7F

Noconfiguration

20

7F

Noconfiguration

21

StatementPrinter.SeeTableNote37.
00
01
02
03
09

Notconfigured
Standardstatementprinter
Reserved
Reserved
Enhancedthermalstatementprinter(SDC+)

2223

Reserved.SeeTableNote40.

24

CoinDispenser.
00
01
02
03

NotConfigured
Reserved
CoinDispenserwithfourhoppertypes
CoinDispenserwithmorethanfourhoppertypes

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-36

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Byte

Device

25

SystemDisplay.SeeTableNote40.
00
01
02

26

MediaEntryIndicators
00
01

27

Notconfigured

CoinDispensingModuleTamperIndication.
SeeTableNote40.
00
01

30

Notconfigured
Configured
Reserved
Reserved

DocumentProcessingModule(notsupported)
SeeTableNote40.
00

29

Notconfigured
Configured

EnvelopeDispenser.SeeTableNote37andTableNote40.
00
01
02
03

28

Notconfigured
Reserved
Configured

Notconfigured
Configured

DocumentProcessingModuleTamperIndication(not
supported).SeeTableNote40.
00

Notconfigured

31

Reserved.SeeTableNote40.

32

VoiceGuidance
SeeTableNote40
00
01
02

33

Notconfigured
StandardAudiopresent
EnhancedAudiopresent

Reserved.SeeTableNote40.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-37

Terminal to Central Messages


Solicited Status Messages
Byte

Device

34

NoteAcceptor
SeeTableNote37andTableNote40
00
01
02
03
04

Notconfigured
Reserved
Reserved
Bunchnoteacceptor
Bunchnoteacceptorwithrecyclecapabilities,also
knownasarecyclingunit.OnNCRSSTsthisiscalleda
GBRU.SeeTableNote38

05

Bunchnoteacceptor.OnNCRSSTs,thisiscalleda
GBNAbutitcanalsobereportedwhenaGBRUwith
recyclingdisabledispresent.SeeTableNote38

06

Bunchnoteacceptorthatcanaccepteithercashor
chequesbutnotbothinasingletransaction.SeeTable
Note42

07

Bunchnoteacceptorthatcanacceptnotesandcheques
separatelyortogetherinasingletransaction.(Not
supported)
Singlenoteacceptor

08
35

3637

ChequeProcessor
SeeTableNote37andTableNote40
00
01
02
03

Notconfigured
Singlechequeacceptmodule(CPM)
Bunchchequeacceptor
Bunchchequeacceptorthatcanalsoaccept
cash.Thedevicecanaccepteithercashorchequesbut
notbothinasingletransaction.SeeTableNote42

04

Bunchchequeacceptorthatcanalsoaccept
cash.Thedevicecanacceptbothcashandcheques
separatelyortogetherinasingletransaction.(Not
supported)

Reserved.SeeTableNote40.

Table Note 37:TherelationshipbetweentheDIGandthe


configurationtableoffsetis:offset = 2 x (DIG - 41 hex)
Table Note 38TheMStatusvaluesreportedindevicestatus
messagesarecompatiblewiththeGBXXfamilyofdevices.
Table Note 39Ifanattemptismadetoimportakeywiththesame
valueasthecurrentlyloadedkey,theimportisrejectedwith
encryptionfailurereasonD01.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-38

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Table Note 40:Thesefieldsarereturnedonlyifcommandmodifier


6,Sendenhancedconfigurationdata,isused.Fordetails,see
ConfigurationInformation(CommandCode=7)onpage 104in
tableTerminalCommandsonpage 102.
Table Note 41:Whendualcashhandlersareused,eitherbothcash
handlersmustbestandardcashhandlersoronecashhandlermust
beastandardcashhandlerandtheotheraGBRU.IfaGBRUis
used,itmustbeconfiguredastheprimarycashhandler.
Table Note 42:AnNCRscalabledepositmodule(SDM)canbe
configuredasachequeprocessorthatcanacceptcashandcheques
orasacashacceptorthatcanacceptcashandcheques.
SuppliesStatusSubfieldg5 Themediacontainerorresource
isidentifiedbythebyteposition,asshowninthefollowingtable:
Table 9-15
Supplies Status Sub-Field g5

Byte position

Device indicated

Reserved

Reserved

Notused(=0)

CardCaptureBin

CashHandlerRejectBin

DepositBin

ReceiptPaper

JournalPaper

Notused(=0)

Notused(=0)

10

NightSafe

11

Notused(=0)

12

Notused(=0)

13

Notused(=0)

14

Notused(=0)

15

Type1CurrencyCassettes

16

Type2CurrencyCassettes

17

Type3CurrencyCassettes

18

Type4CurrencyCassettes

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-39

Terminal to Central Messages


Solicited Status Messages
Byte position

Device indicated

19

Notused(=0)

20

Notused(=0)

21

StatementPaper

22

StatementRibbon

23

Reserved,seeTableNote43

24

Reserved,seeTableNote43

25

EnvelopeDispenser,seeTableNote43

Table Note 43:Thesefieldsarereturnedonlyifcommandmodifier


6,Sendenhancedconfigurationdata,isused.Fordetails,see
ConfigurationInformation(CommandCode=7)onpage 104.
SuppliesValues Eachbyteindicatesthecurrentstatusofthe
supplesbyanumericvalue,asshowninthefollowingtable,which
givesgenericvalues.Astatusof0Notconfiguredforcurrency
binsindicatesthatnocassettesofthattypewereinstalledonthelast
exitfromSupervisor,andnosubsequentattempthasbeenmadeto
dispensefromthattype.Ifattemptsaremadetodispensefroma
cassettetypethatisnotinstalled,thestatuschangesto3Media
out.
9

Fordetailsofdifferencesforspecificdevices,seeSuppliesDataon
page E11.
Table 9-16

Supplies Value

Meaning

Notconfigured

Goodstate

Medialow

Mediaout

Overfill

Supplies Status Values

HardwareConfigurationData

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandwithacommand
codeof7andacommandmodifierof1.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-40

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Table 9-17
Hardware
Configuration Data Response
:
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessagehasidentifierH.

g2

ConfigurationIDIdentifierA.

Var(4)

ConfigurationID.Thisfourcharacterfieldcontainsthelast
fourdigitconfigurationIDnumber,intherange00009999,sentto
theterminalfromCentral.

FS

FieldSeparator

g3

ProductClassIdentifierB.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-41

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

Var(2)

ProductClass.ThistwocharacterfieldcontainstheProductClass
oftheterminal.Thefollowingentriesarepossible,butthisdoesnot
meanthatAdvanceNDCsupportsalltheseclasses:
0E5663
0F5674
105675
115684
125685
135688
145665
155670
16 Personas75
17Personas88
18Personas40
19Personas70
1APersonas74
1BPersonas84
1CPersonas85
1DPersonas90
1EEasyPoint55orEasyPoint57
1FPersonas86
205588
21Personas73
22Personas72
23Personas77
246674
256676
265879
275887
285362
29Personas71
2A5867
306622
316624
326626
336628
346631
356632
366634
376638
386625
396618
3A6636
3B2012(SelfServ22e)
3C2016(SelfServ16)
3D6642(SelfServ42)
3E2004(SelfServ4)
3F2008SelfServ8)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-42

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

FS

FieldSeparator

g4

HardwareConfigurationIdentifierC.
Thisfieldcontainshardwareconfigurationinformationforeachof
thedevicespresentintheSST.Itisdividedintoaseriesofsubfields
separatedbygroupseparators.
Ifadeviceisnotpresent,therewillbenocorrespondingDIGinthe
field.

g5

O
See

DeviceIdentifierGraphic(DIG).Thisidentifiesthedevicetowhich
thefollowinghardwareconfigurationdataapplies.Fordetails,see
seeHardwareConfigurationDataonpage E2.

Var

O
See

HardwareConfiguration.Thiscontainsinformationforeachdevice
indicatingwhichvariantofthedeviceisconfiguredandanyother
configurationdataavailable.Fordetails,seeHardware
ConfigurationDataonpage E2.

O
SeeTableNote44

GroupSeparator.

O
SeeTableNote44

DeviceIdentifierGraphic(DIG).

Var

O
SeeTableNote44

HardwareConfiguration.

O
SeeTableNote45

FieldSeparator.

O
SeeTableNote45

DeviceIdentifierGraphic(DIG).

Var

O
SeeTableNote45

Data.

TheDIGanditsassociateddata,togetherwiththeprecedinggroup
separatorformagroup.WhentheDIGispresent,allelementsof
thisgroupmustbepresent.
Table Note 44:TheDIGanditsassociateddata,togetherwiththe
precedinggroupseparatorformagroup.WhentheDIGispresent,
allelementsofthisgroupmustbepresent.Suchgroupsarerepeated
asoftenasnecessarytoensurethatthedatarelatingtoalldevices
presentintheterminalisreported.
Table Note 45:Thesefieldsarereservedforfutureexpansion.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-43

Terminal to Central Messages


Solicited Status Messages

SuppliesData

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandmessage(a
commandcodeof7withacommandmodifierof2).Fordetails,
seetheTerminalCommandssectionofChapter 10,Centralto
TerminalMessages.
Note:Ifoption83issetto000,nosuppliesdataissenttoCentral
forthechequeprocessor.
Table 9-18
Supplies Data Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessagehasidentifierI.

g2

SuppliesStatusIdentifierA.
Thisfieldcontainssuppliesinformationforeachofthedevices
presentintheSST.Itisdividedintoaseriesofsubfieldsseparated
bygroupseparators.
Ifadeviceisnotpresent,therewillbenocorrespondingDIGinthe
field.

O
SeeTableNote46

DeviceIdentifierGraphic(DIG).Thisidentifiesthedevicetowhich
thefollowingsuppliesstatusdataapplies.Fordetails,see
Appendix E,DeviceIdentifiers.

Var

O
SeeTableNote46

SuppliesStatus.Thiscontainsinformationforeachdeviceindicating
theconditionofthedevicesreplenishables.Fordetails,see
SuppliesDataonpage E11.
ExceptforcashacceptorsseeCashAcceptorSupplies(DIGw)
onpage E16eachelementofthesuppliesstatusdatawilltakeone
ofthefollowingvalues:

O
SeeTableNote47

Value

Description

Notconfigured/reserved

Goodstate

Medialow

Mediaout

Overfill

GroupSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-44

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

g3

Number of
Characters

Mandatory/Optional

Description

O
SeeTableNote47

DeviceIdentifierGraphic(DIG).

Var

O
SeeTableNote47

SuppliesStatus.

O
SeeTableNote48

FieldSeparator

O
SeeTableNote48

DataIdentifier.

Var

O
SeeTableNote48

Data.

Table Note 46:TheDIGanditsassociateddata,togetherwiththe


precedinggroupseparatorformagroup.WhentheDIGispresent,
allelementsofthisgroupmustbepresent.
Table Note 47:TheDIGanditsassociateddata,togetherwiththe
precedinggroupseparatorformagroup.WhentheDIGispresent,
allelementsofthisgroupmustbepresent.Suchgroupsarerepeated
asoftenasnecessarytoensurethatthedatarelatingtoalldevices
presentintheterminalisreported.
Table Note 48:Thesefieldsarereservedforfutureexpansion.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-45

Terminal to Central Messages


Solicited Status Messages

FitnessData

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandmessage(a
commandcodeof7withacommandmodifierof3).Fordetails,
seetheTerminalCommandssectionofChapter 10,Centralto
TerminalMessages.
Table 9-19
Fitness Data Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessagehasidentifierJ.

g2

HardwareFitnessIdentifierA.
Thisfieldcontainsfitnessinformationforeachofthedevicespresent
intheSST.Itisdividedintoaseriesofsubfieldsseparatedbygroup
separators.

O
SeeTableNote49

DeviceIdentifierGraphic(DIG).Thisidentifiesthedevicetowhich
thefollowingfitnessdataapplies.Fordetails,seeAppendix E,
DeviceIdentifiers.

Var

O
SeeTableNote49

Fitness.Eachfitnesscharacterisencodedwithoneofthefollowing
errorseverityvalues,indicatingthecurrentfitnessofthedevice:
Char

Severity

Noerror/notsupported

Routineerrorshaveoccurred

Warningconditionshaveoccurredinvestigationis
required

Suspend.Theterminaliscurrentlyinthesuspendstatedue
tosuspectedtamperingwiththisdevice

Fatalerrorconditionexistsonthisdevice

Routine,warningandfatalerrorscanonlybeclearedbylocal
Supervisorfunctions.
Fordetails,seeFitnessDataonpage E19.
1

O
SeeTableNote50

GroupSeparator.

O
SeeTableNote50

DeviceIdentifierGraphic(DIG).

Var

O
SeeTableNote50

Fitness.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-46

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

g3

FieldSeparator.
(Presentforfutureexpansion.)

DataIdentifier
(Presentforfutureexpansion.)

Var

Datapresentforfutureexpansion.
(Presentforfutureexpansion.)

Table Note 49:TheDIGanditsassociateddata,togetherwiththe


precedinggroupseparatorformagroup.WhentheDIGispresent,
allelementsofthisgroupmustbepresent.
Table Note 50:TheDIGanditsassociateddata,togetherwiththe
precedinggroupseparatorformagroup.WhentheDIGispresent,
allelementsofthisgroupmustbepresent.Suchgroupsarerepeated
asoftenasnecessarytoensurethatthedatarelatingtoalldevices
presentintheterminalisreported.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-47

Terminal to Central Messages


Solicited Status Messages

TamperandSensorStatusData

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandmessage(a
commandcodeof7withacommandmodifierof4).Fordetails,
seetheCentraltoTerminalMessagessectionofChapter 10,
CentraltoTerminalMessages.Thisstatusmessagereports
physicalcassettes,includingcassettesotherthancashincassettes
whenthedeviceisacombinedcashin/cashoutdevice.
Table 9-20
Tamper and Sensor Data Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessagehasidentifierK.

g2

SensorStatusIdentifierA.

Var(5)

SensorStatus.Thisfivecharacterfieldcontainsonebytepersensor
andisidenticaltotheinformationreportedinbytes26oftheSensors
Statusmessage.Fordetails,seetheSensors(Unsolicited)section.

FieldSeparator

TamperIndicatorIdentifierB.

Var

TamperStatus.ThisfieldcontainsthestatusoftheTIsensors.IftheTI
featureisnotconfigured,thisfield,withthebufferidentifier,willnot
bepresent.

g3

Thecontentsofthetamperstatusdatafieldareasfollows:
Char

Code

17

Identicaltobytes713oftheSensorsStatusmessage,
describedintheSensors(Unsolicited)section.

0CoinDispenserout.
1CoinDispenserin.

0CoinDispenserHopper1out.
1CoinDispenserHopper1in.

10

0CoinDispenserHopper2out.
1CoinDispenserHopper2in.

11

0CoinDispenserHopper3out.
1CoinDispenserHopper3in.

12

0CoinDispenserHopper4out.
1CoinDispenserHopper4in.

13

NotsupportedinAdvanceNDC

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-48

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

Ifadeviceisnotconfigured,anyassociatedTIbytewilltakethevalue
0.
g4

g5

ExtendedTamperIndicatorIdentifierC.SeeTableNote51

SeeTableNote
52andTable
Note53

DeviceIdentifierGraphic(DIG).Thisfieldcontainsdataoneach
devicepresentintheSST.

Var

SeeTableNote
52andTable
Note53

TamperStatus.
ThisfieldcontainstheconditionoftheTIsensors.IftheTIfeatureis
notconfigured,thisfield,withthebufferidentifier,willnotbepresent.
Thelengthoftheconfigurationdatavariesdependingonthedevice
beingreported.
Fordetails,seeTamperIndicatorIdentifierB.

SeeTableNote
54

GroupSeparator

SeeTableNote
54

DeviceIdentifierGraphic(DIG).Thisfieldcontainsdataoneach
devicepresentintheSST.
Fordetails,seeTamperDataonpage E25.

Var

SeeTableNote
54

TamperStatus.ThisfieldcontainstheconditionoftheTIsensors.If
theTIfeatureisnotconfigured,thisfield,withthebufferidentifier,
willnotbepresent.
Fordetails,seeTamperIndicatorIdentifierB.

FieldSeparator.Thisfieldispresentforfutureexpansion.

DataIdentifier.Thisfieldispresentforfutureexpansion.

Var

Data.Thisfieldispresentforfutureexpansion.

Table Note 51:ThesettingofEnhancedConfigurationoption24


determineswhethertheextendedtamperinformationissent.For
detailsofoption24,seeOption24Enhanced/TISensorStatus
UnsolicitedMessageonpage 79.
Table Note 52:TheDIGandassociateddataareagroup.IftheDIG
ispresent,alltheelementsofthegroupmustalsobepresent.
Table Note 53:ADIGandassociateddataareincludedasoftenas
requiredtoreportonalldevices.
Table Note 54:Thesefieldsarepresentforfutureexpansion.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-49

Terminal to Central Messages


Solicited Status Messages

SoftwareIDandReleaseNumberData

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandmessage(a
commandcodeof7withacommandmodifierof5).Fordetails,
seetheTerminalCommandssectionofChapter 10,Centralto
TerminalMessages.
Table 9-21
Software ID and Release Number Data
Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessagehasidentifierL.

g2

ReleaseNumberIdentifierA.

Var(6)

NDCReleaseNumber.Containsasixdigitdecimalnumber.Thefirst
pairofdigitsrepresentthereleasenumber.Thesecondpairofdigits
representthepointreleasenumber.Thethirdpairofdigitsrepresent
thepatchreleasenumber.
Forexample,020600isrelease2.06.

FS

FieldSeparator

g3

SoftwareIDIdentifierB.

Var(9)

AdvanceNDCSoftwareID.ContainstheAdvanceNDCSoftwareID.
Forthisrelease,thefieldtakesthefollowingvalues:
G5310283 (AdvanceNDCpackage)
IftheAdvanceNDCsoftwareIDisunavailable,thisfieldcontains
nineblanks.

g4

FieldSeparator.Thisfieldispresentforfutureexpansion.

DataIdentifier.Thisfieldispresentforfutureexpansion.

Var

Data.Thisfieldispresentforfutureexpansion.

EnhancedConfigurationData

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandmessage(a
commandcodeof7withacommandmodifierof6).Itreturnsall
theconfigurationinformationavailable.
Fordetailsofthismessage,seeSendConfigurationInformation
onpage 927.Enhancedinformationisincludedinsubfieldsg3,
g4andg5asdescribedinthefollowingsections:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-50

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

HardwareFitnessSubfieldg3onpage 929
HardwareConfigurationDataSubFieldg4onpage 931
SuppliesStatusSubfieldg5onpage 939.

LocalConfigurationOptionDigits

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationterminalcommandmessage(a
commandcodeof7withacommandmodifierof7).
Table 9-22
Local Configuration Option Digits
Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.ThismessagehasidentifierM.

g2

LocalOptionsIdentifierA.

Var(16)

LocalOptionDigits.ThesecharactersrepresentthevaluesoftheLocal
OptionDigitswhichmaybeenteredusingtheMSGMODEoptionon
theConfiguremenuinSupervisormode.Fordetails,refertothe
APTRAAdvanceNDC,SupervisorsGuide.
EachcharacterisanASCIIrepresentationoftheassociatedOption
Digit.

g3

FieldSeparator.Reservedforfutureexpansion.

DataIdentifier.Reservedforfutureexpansion.

Var

Data.Reservedforfutureexpansion.

ReportCashDepositDefinition

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
CashDepositDefinitionterminalcommandmessage(acommand
codeof7withacommandmodifierof8).
Table 9-23
Note Definitions (BNA) Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier(N)

g2

AcceptedCashItemsIdentifier(A)

Var(11)

Cashtypeinformation,11charactersforeachtypeuptoamaximum
of50cashtypes.
SeeTableNote55andTableNote56.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-51

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

FS

SeeTableNote57

g3

ECB6NoteRetentionModeID(D)

ECB6NoteRetentionMode

SeeTableNote57

DataIdentifier.Reservedforfutureexpansion

Var

Data.Reservedforfutureexpansion

FS

Table Note 55:Thisfieldisrepeatedforeachitemtyperecognized


bythedepositmodule.Fornoteacceptors,NDCnotetypemapping
isperformedwhenAdvanceNDCisstarted.Formoreinformation,
refertotheAPTRAAdvanceNDC,DevelopersGuide.
Table Note 56:Eachcashitemtypeconsistsof11byteswiththe
followingformat:
# B B I

S O V A L U E

whichisinterpretedasfollows:
Byte

Meaning

Activeindicator(!=inactive)
Ifthenoteisidentifiedasactive,itcanbeacceptedbythe
BNA.Ifthenoteisidentifiedasinactiveitisrejected.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-52

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages
Byte

Meaning

BB

Cashitemidentifier
Bitpositions(01H32H)

ISO

ThreecharacterISO4217CountryCode(forexample,USD=
USdollar)

VALUE

Thevalueoftheitem,paddedrightwithspaces.Toallow
valuesthatrequiremorethan5characterstorepresentthe
valueamultiplierisappendedtothevalueasfollows:

Onethousandisrepresentedas1K

Tenthousandisrepresentedas10K

Onehundredthousandisrepresentedas100K
Onehundredthofthecurrencyunitisrepresentedas1c.
Themultipliercharactermustbecontainedwithinthe5
availablecharactersforthevalue.
Thefollowingmultipliersaredefined:
c
K
M
G
T

=
=
=
=
=

10-2
103
106
109
1012

X = Valuecannotberepresented

Table Note 57:Thefieldseparatorsmustbepresentifanyother


fieldsfollow.
Table Note 58:Ifthefollowingmessageisreturned,useINITBNA
toclearthedeviceandpopulatetheCashItemtypemessage,as
follows:
22<fs>000<fs><fs>F<fs>NA

TheNAattheendofthemessageisreturnedasthedeviceisina
badstateandanattempthasbeenmadetoinitialisethedevice.

SendSupplyCounters

ThisSolicitedStatusmessageissenttoCentralinresponsetoaSend
CountersTerminalCommandmessage.Dependingonthemodifier
usedwiththecommandcodeof4,thebasicorextendedmessageis
used.FordetailsoftheTerminalCommandmessage,seethe
TerminalCommandssectionofChapter 10,CentraltoTerminal
Messages.
Forthebasicmessageformat,seethenextheadingandforthe
extendedmessageformat,seeExtendedSendSupplyCounterson
page 957.
BasicSendSupplyCounters
thefollowing:

Thebasicmessageformatcanreport
9

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-53

Terminal to Central Messages


Solicited Status Messages

Fourcassettetypes.Inadualcashhandlersystemitreportsthe
combinednumberofnotesforeachcassettetype.
Fourcoinhoppertypes.

Table 9-24
Send Supply Counters Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.Thismessagehasidentifier2.

g2

TransactionSerialNumber(TSN).ContainstheTSNofthelast
transactionprocessedbytheterminal.Ifthisdoesnot
correspondtothelastTSNsentbyCentral,itmeansthatthe
transactionhasnotbeeninitiatedandthecountershavenot
beenupdated.

g3

AccumulatedTransactionCount.Definesthetotalnumberof
detectedtransactionattemptssincetheterminalwasinstalled
orthenonvolatileterminalmemorywaslastcorrupted.The
countisresetto0after9,999,999transactions.
Atransactionattemptisdetectedwhenitisrecognisedthatthe
TSNreceivedfromCentralisdifferentfromthepreviously
receivedTSN.

g4

20

NotesInCassettes.Consistsoffourfivedigitdecimalcountsof
thetotalnumberofnotesremainingincassettetypes1,2,3and
4.Thecountsaresetbysupervisorfunctionsandare
decrementedoneachdispensetransaction.Thesecountsare
zeroifnotsetbyanAddCashorSetStandardCash
supervisorfunction.Thecountcontains65535(thedecimal
equivalentof0FFFFhex)ifmorenoteshavebeendispensed
fromacassettethanithasbeensettocontain,orifnotesare
dispensedfromacassettetypethathasnotbeenset.
Ifdualcashhandlersareused,thecombinednumberofnotes
forthecassettetypeisreported.Onlyfourcassettetypesare
reported,regardlessofthesettingoftheEnhanced
Configurationoption76.

g5

20

NotesRejected.Consistsoffourfivedigitdecimalcountsofthe
totalnumberofnotesmovedtotherejectbinfromcassette
types1,2,3and4.
Ifdualcashhandlersareused,thecombinednumberofnotes
forthecassettetypeisreported.Onlyfourcassettetypesare
reported,regardlessofthesettingoftheEnhanced
Configurationoption76.
Althoughfieldsg4andg5maynotbetotallyaccurate,the
sumofthesecountsforaparticularcassettetypedoes
accuratelyrepresentthedifferencebetweentheoriginal
numberofnotesaddedandthenumberofnotesdispensed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-54

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

g6

20

NotesDispensed.Consistsoffourfivedigitdecimalcountsof
thetotalnumberofnotesdispensedfromcassettetypes1,2,3
and4.Thesecountsareconsistentwithnotecountsreported
sincethecountswerelastclearedbyasupervisortransaction.
Ifdualcashhandlersareused,thecombinednumberofnotes
forthecassettetypeisreported.Onlyfourcassettetypesare
reported,regardlessofthesettingoftheEnhanced
Configurationoption76.
Ifatransactionisprematurelystoppedbyapowerfailure,
thesecountsareupdatedtoreflectthenumberofnotes
dispenseduptothetimeofpowerfailure.

g7

20

LastTransactionNotesDispensed.Consistsoffourfivedigit
decimalcountsofthenumberofnotesdispensedonthelast
transactionprocessedbytheterminal.ThisfieldallowsCentral
torecovernotecountsafterpowerfailure,evenifthepower
failureoccurredinthemiddleofadispenseoperation.

g8

CardsCaptured.Consistsofonefivedigitdecimalcountofthe
numberofcardscapturedsincethecountwasclearedbya
supervisortransaction.Thecountincludescardscapturedupto
andincludingthetransactiondefinedinfieldg2.

g9

EnvelopesDeposited.Consistsofonefivedigitdecimalcount
ofthenumberofenvelopesdepositedsincethecountwaslast
clearedbyaSupervisortransaction.Thecountincludes
envelopesdepositeduptoandincludingthetransaction
definedinfieldg2.

g10

CameraFilmRemaining.Thecamerafilmremainingisalways
00000.

g11

LastEnvelopeSerialNumber.Thisisalways00000.

g12

Reserved.

GS

SeeTableNote59

GroupSeparator.

g20g22

Var(15)

Reserved.

GS

SeeTableNote59

GroupSeparator.

g30g32

Var(15)

Reserved.

GS

SeeTableNote59

GroupSeparator.

g40g4x

Var(x)

Reserved.

GS

SeeTableNote59

GroupSeparator.

g50g53

Var(20)

Reserved.

GS

SeeTableNote59

GroupSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-55

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

g60

Mandatory/Optional

Description

Var(20)

O
SeeTableNote60

Coinsremaining

g61

Var(20)

O
SeeTableNote60

Coinsdispensed

g62

Var(20)

O
SeeTableNote60

Lasttransactioncoinsdispensed

GS

SeeTableNote59

GroupSeparator.

g70

O
SeeTableNote61

Totalnotesrefunded

g71

O
SeeTableNote61

Totalnotesrejected

g72

O
SeeTableNote61

Totalnotesencashed

g73

O
SeeTableNote61

Totalnotesescrowed

GS

SeeTableNote59

GroupSeparator.

g80g89

Reserved.

GS

SeeTableNote59

GroupSeparator.

g90g99

Reserved.

GS

SeeTableNote59

GroupSeparator.

g100
g109

Reserved.

GS

SeeTableNote59

GroupSeparator.

g110
g119

Reserved.

GS

SeeTableNote59

GroupSeparator.

g120

ChequeprocessorchequesdepositedintoBIN1

g121

Chequeprocessorchequesdepositedintoreject/retainBIN2

g122

ChequeprocessorchequesdepositedintoBIN3

g12n

ChequeprocessorchequesdepositedintoBINn1

GS

SeeTableNote59

GroupSeparator.

g130
g139

Reserved.

GS

SeeTableNote59

GroupSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-56

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

g140

Reserved.

GS

SeeTableNote59

GroupSeparator.

g150
g154

Reserved.

GS

SeeTableNote59

GroupSeparator.

g160

Numberofpassbookscaptured.

Table Note 59:Ifanyoptionalgroupispresent,allofthegroup


separatorsprecedingitwillbeincluded,enablingthehostto
identifythegroupfieldbyitsposition.
Table Note 60Fieldsg60g62formagroupandwillonlybe
presentifacoindispenserispresent.
Table Note 61:Fieldsg70g73formagroupandwillonlybe
presentifaBNAispresent.:
Fieldsg120g129formagroupandwillonlybepresentifa
chequeprocessorispresent.
ExtendedSendSupplyCounters Theextendedmessageformat
supportsthereportingofuptoeightcoinhoppers.Thecountsare
groupedandseparatedbyaGroupSeparator.

Table 9-25
Send Supply Counters: Extended
Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.Thismessagehasidentifier7.

g2

g3

TransactionSerialNumber(TSN).ContainstheTSNofthelast
transactionprocessedbytheterminal.Ifthisdoesnotcorrespondto
thelastTSNsentbyCentral,itmeansthatthetransactionhasnot
beeninitiatedandthecountershavenotbeenupdated.

g4

AccumulatedTransactionCount.Definesthetotalnumberof
detectedtransactionattemptssincetheterminalwasinstalledorthe
nonvolatileterminalmemorywaslastcorrupted.Thecountisreset
to0after9,999,999transactions.

TransactiongroupidA.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-57

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

AtransactionattemptisdetectedwhenitisrecognisedthattheTSN
receivedfromCentralisdifferentfromthepreviouslyreceived
TSN.
GS

SeeTableNote62

GroupSeparator.

g5

SeeTableNote62

CardReaderdatagroupIDB

g6

CardsCaptured.Consistsofonefivedigitdecimalcountofthe
numberofcardscapturedsincethecountwasclearedbya
supervisortransaction.Thecountincludescardscaptureduptoand
includingthetransactiondefinedinfieldg3.

GS

SeeTableNote62

GroupSeparator.

g7

SeeTableNote62

CashHandler0datagroupIDC

g8

SeeTableNote62
andTableNote63

CassetteType.Consistsofonethreedigitidentifierofthecassette
typebeingreportedon.Theidentifiercanbebetween000and007
dependingonthecashhandlerconfiguration.

g9

SeeTableNote62
andTableNote63

NotesInCassettes.Consistsofafivedigitdecimalcountofthe
numberofnotesinthecassette.

g10

SeeTableNote62
andTableNote63

NotesRejected.Consistsofafivedigitdecimalcountofthenumber
ofrejectnotes.
Althoughfieldsg9andg10maynotbetotallyaccurate,thesum
ofthesecountsaccuratelyrepresentsthedifferencebetweenthe
originalnumberofnotesaddedandthenumberofnotesdispensed.

g11

SeeTableNote62
andTableNote63

NotesDispensed.Consistsofafivedigitdecimalcountofthe
numberofdispensednotes.
Ifatransactionisprematurelystoppedbyapowerfailure,these
countsareupdatedtoreflectthenumberofnotesdispensedupto
thetimeofpowerfailure.

g12

SeeTableNote62
andTableNote63

LastTransactionNotesDispensed.Consistsofafivedigitdecimal
countofthenumberofnotesdispensedduringthelasttransaction.

g13

SeeTableNote62,
TableNote63and
TableNote65

NotesDeposited.Consistsofafivedigitdecimalcountofthetotal
numberofdepositednotes.

GS

SeeTableNote62

GroupSeparator.

g14

SeeTableNote62

CashHandler1datagroupIDD

g15

SeeTableNote62
andTableNote63

CassetteType.Consistsofonethreedigitidentifierofthecassette
typebeingreportedon.Theidentifiercanbebetween000and007
dependingonthecashhandlerconfiguration.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-58

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

g16
g17

Mandatory/Optional

Description

SeeTableNote62
andTableNote63

NotesInCassettes.Consistsofonefivedigitdecimalcountofthe
numberofnotesinthecassette.

SeeTableNote62
andTableNote63

NotesRejected.Consistsofafivedigitdecimalcountofthenumber
ofrejectnotes.
Althoughfieldsg16andg17maynotbetotallyaccurate,thesum
ofthesecountsaccuratelyrepresentsthedifferencebetweenthe
originalnumberofnotesaddedandthenumberofnotesdispensed.
Thisisbecausenotespresentedbutnottakenandthenretractedare
senttotherejectbin.Inthisscenario,theNotesRejectedcountisnot
increased,buttheNotesInCassettescountisdecremented.

g18

SeeTableNote62
andTableNote63

NotesDispensed.Consistsofafivedigitdecimalcountofthe
numberofdispensednotes.
Ifatransactionisprematurelystoppedbyapowerfailure,these
countsareupdatedtoreflectthenumberofnotesdispensedupto
thetimeofpowerfailure.

g19

SeeTableNote62
andTableNote63

LastTransactionNotesDispensed.Consistsofafivedigitdecimal
countofthenumberofnotesdispensedduringthelasttransaction.

g20

SeeTableNote62,
TableNote63and
TableNote65

NotesDeposited.Consistsofafivedigitdecimalcountofthe
numberofdepositednotes.

GS

SeeTableNote62

GroupSeparator.

g21

SeeTableNote62

CoindispenserdatagroupIDE

g22

SeeTableNote62
andTableNote64

HopperTypeNumber.Consistsofonetwodigitidentifierofthe
hoppertypebeingreportedon.Theidentifiercanbebetween01
and08dependingonthecoinhopperconfiguration.

g23

SeeTableNote62
andTableNote64

CoinsRemaining.Consistsofafivedigitdecimalcountofthetotal
numberofcoinsremaininginthehoppertypeidentifiedinfield
g22.Thecountsaresetbysupervisorfunctionsandare
decrementedoneachdispensetransaction.Thesecountsarezeroif
notsetbyanAddCoinsorStdCoinssupervisorfunction.The
countissetto65535(thedecimalequivalentof0FFFFhex)ifmore
coinshavebeendispensedfromahopperthanithasbeensetto
contain,orifcoinsaredispensedfromahoppertypethathasnot
beenset.

g24

SeeTableNote62
andTableNote64

CoinsDispensed.Consistsofafivedigitdecimalcountofthetotal
numberofcoinsdispensedfromthehoppertypeidentifiedinfield
g22.Thiscountisconsistentwithcoincountsreportedsincethe
countswerelastclearedbyasupervisortransaction.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-59

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

g25

Mandatory/Optional

Description

SeeTableNote62
andTableNote64

LastTransactionCoinsDispensed.Consistsofafivedigitdecimal
countofthenumberofcoinsdispensedonthelasttransaction
processedbytheterminal.ThisfieldallowsCentraltorecovercoin
countsafterpowerfailure,evenifthepowerfailureoccurredinthe
middleofadispenseoperation.

g26

SeeTableNote62,
TableNote64,and
TableNote65

CoinsDeposited.Consistsofafivedigitdecimalcountofthetotal
numberofcoinsdepositedfromthehoppertypeidentifiedinfield
g22.Thiscountisconsistentwithcoincountsreportedsincethe
countswerelastclearedbyasupervisortransaction.

GS

SeeTableNote62

GroupSeparator.

g27

SeeTableNote62

EnvelopeDepositorydatagroupIDF

g28

SeeTableNote62

EnvelopesDeposited.Consistsofonefivedigitdecimalcountofthe
numberofenvelopesdepositedsincethecountwaslastclearedbya
Supervisortransaction.Thecountincludesenvelopesdepositedup
toandincludingthetransactiondefinedinfieldg3.

g29

SeeTableNote62

LastEnvelopeSerialNumber.Thelastenvelopeserialnumberis
always00000.

GS

SeeTableNote62

GroupSeparator.

g30

SeeTableNote62

CameradatagroupIDG.

g31

SeeTableNote62

CameraFilmRemaining.Thecamerafilmremainingisalways
00000.

GS

SeeTableNote62

GroupSeparator.

g32

SeeTableNote62

DPMdatagroupIDH(notsupported).

g33

SeeTableNote62

DepositBinIdentifier(notsupported).

g34

SeeTableNote62
andTableNote91

DocumentsDepositedinBin(notsupported).

GS

SeeTableNote62

GroupSeparator.

g35

SeeTableNote66
andTableNote67

BNACassetteCountsdatagroupIDI.

g36

SeeTableNote66,
TableNote67
andTableNote68

NDCCassetteType.Consistsofonethreedigitidentifier.The
identifiercanbebetween001and999.

g37

SeeTableNote66,
TableNote67
andTableNote68

TotalNotesInCassette.Consistsofafivedigitdecimalcountofthe
numberofnotesinthecassette.

g38

SeeTableNote66,
TableNote67
andTableNote68

NumberofNoteTypesReported.Thisisavalueintherange000
to999

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-60

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

g39

Mandatory/Optional

Description

SeeTableNote66,
TableNote67
andTableNote69

NoteTypeIdentifier.Thisisavalueintherange0001toFFFF

g40

SeeTableNote66,
TableNote67,
TableNote69and
TableNote70

Numberofnotesofthetypeidentifiedbythenotetypeidentifierin
fieldg39.Consistsofafivedigitdecimalcountofthenumberof
notesofanidentifiedtype.

GS

SeeTableNote62

GroupSeparator.

g41

SeeTableNote71

ChequeprocessordatagroupIDJ

g42

SeeTableNote71
andTableNote72

BinNumber

g43

SeeTableNote71
andTableNote72

Chequesdepositedinbin

GS

SeeTableNote62

GroupSeparator.

g44

SeeTableNote73

BNAEmulation(andExtendedEmulation)depositdatagroupID
K

g45

SeeTableNote73
andTableNote74

TotalNotesRefunded

g46

SeeTableNote73,
TableNote74and
TableNote77

TotalNotesReturnedRejected

g47

SeeTableNote73
andTableNote74

TotalNotesEncashed

g48

SeeTableNote73
andTableNote74

TotalNotesEscrowed

GS

SeeTableNote62

GroupSeparator.

g49

SeeTableNote62,
TableNote65and
TableNote75

DualDispensercombineddatagroupIDl

g50

SeeTableNote68

CassetteType.Consistsofonethreedigitidentifier.Theidentifier
canbebetween001and007dependingonthecashhandler
configuration.

g51

SeeTableNote68

NotesinCassette.Consistsofafivedigitdecimalcountofthe
numberofnotesinthecassette.

g52

SeeTableNote68

NotesRejected.Consistsofafivedigitdecimalcountofthenumber
ofrejectnotes.

g53

SeeTableNote68

NotesDispensed.Consistsofafivedigitdecimalcountofthe
numberofdispensednotes.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-61

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

Mandatory/Optional

Description

g54

SeeTableNote68

LastTransactionNotesDispensed.Consistsofafivedigitdecimal
countofthenumberofnotesdispensedduringthelasttransaction.

g55

SeeTableNote68
andTableNote76

NotesDeposited.Consistsofafivedigitdecimalcountofthe
numberofdepositednotes.

GS

SeeTableNote62

GroupSeparator.

g58

SeeTableNote66

ECB6Category2NotesdatagroupIDN
NotsupportedbyAdvanceNDC.

g59

SeeTableNote66
andTableNote68

NDCCassetteType.Consistsofonethreedigitidentifierofthe
cassettetype.Theidentifiercanbebetween001and999depending
onthecashhandlerconfiguration.

g60

SeeTableNote66
andTableNote68

TotalNumberCategory2Notes.Consistsofafivedigitdecimal
countofthenumberofdepositednotesidentifiedascounterfeit
underECB6.

g61

SeeTableNote66
andTableNote68

NumberofReportedCategory2NoteTypes.Consistsofa
threedigitcountofthenumberofdepositednotetypesbeing
reportedascounterfeitunderECB6.Thecountcanbebetween000
and999.

g62

SeeTableNote66
andTableNote69

Category2NoteTypeIdentifier.Consistsofonefourdigitidentifier
ofthenotetypereportedascounterfeitunderECB6.Theidentifier
canbebetween0001andFFFF.

g63

SeeTableNote66
andTableNote69

Category2Notes.Consistsofafivedigitdecimalcountofthetotal
numberofnotesofthenotetypeinfieldg62identifiedas
counterfeitunderECB6.

GS

SeeTableNote62

GroupSeparator.

g64

SeeTableNote66

ECB6category3notesgroupdataidO
NotsupportedbyAdvanceNDC.

g65

SeeTableNote66
andTableNote68

NDCCassetteType.Consistsofonethreedigitidentifierofthe
cassettetypebeingreportedon.Theidentifiercanbebetween001
and999dependingonthecashhandlerconfiguration.

g66

SeeTableNote66
andTableNote68

TotalNumberCategory3Notes.Consistsofafivedigitdecimal
countofthenumberofdepositednotesidentifiedascategory3
underECB6.

g67

SeeTableNote66
andTableNote68

NumberofReportedCategory3NoteTypes.Consistsofa
threedigitcountofthenumberofdepositednotetypesbeing
reportedascategory3underECB6.Thecountcanbebetween000
and999.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-62

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

Field

Number of
Characters

g68

Mandatory/Optional

Description

SeeTableNote66
andTableNote69

Category3NoteTypeIdentifier.Consistsofonefourdigitidentifier
ofthenotetypereportedascategory3underECB6.Theidentifier
canbebetween0001andFFFF.

g69

SeeTableNote66
andTableNote69

Category3Notes.Consistsofafivedigitdecimalcountofthetotal
numberofnotesofthenotetypeidentifiedinfieldg62identifiedas
category3underECB6.

GS

SeeTableNote62

GroupSeparator.

Table Note 62:Ifanyoptionalgroupispresent,allofthegroup


separatorsprecedingitwillbeincluded,enablingthehostto
identifythegroupfieldbyitsposition.Thegroupsincludedinthe
messagedependonthepresenceofdevicesintheATM.Infuture
releases,newgroupsmaybeaddedandnewcountsaddedtothe
endofexistinggroups.
Table Note 63:Fieldsg8tog13andg15tog20arerepeatedforeach
cassettetypepresentinthedispenser.Theywillberepeatedeither
fourorseventimesdependingonthesettingofEnhanced
Configurationoption76.
Table Note 64:Fieldsg22tog26arerepeatedforeachconfigured
hoppertypeinthecoindispenser.
Table Note 65:Thesefieldsusedonlyondevicesthatcanrecycle
depositeditems.
Table Note 66:ThesefieldsareincludedinEnhancedCashDeposit
mode.
Table Note 67:Thesefieldsareincludedwhenbit3ofEnhanced
Configurationoption45issetandEnhancedCashDepositisnot
enabled.Fordetailsofoption45,seeOption45BNASettingson
page 713.
Table Note 68:Fieldsg36tog38,g49tog55andg58tog69are
repeatedforeachNDCcassettetype.
Table Note 69:Fieldsg39andg40andg58tog69arerepeatedfor
eachNoteTypeIdentifierwithineachcassette.Thesefieldsarenot
presentiftherearenonotesinthecassette.
Table Note 70:Fieldg40includesallnotesidentifiedascategory2,
category3,orcategory4underECB6

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-63

Terminal to Central Messages


Solicited Status Messages

Table Note 71:Fieldsg41tog43areonlyincludedwhenacheque


processorispresent.
Table Note 72:Fieldsg42andg43reportthenumberofcheques
storedineachbin.
Table Note 73:Fieldsg44tog48areonlyincludedinBNA
Emulationmodes.
Table Note 74:Fieldsg45tog48containthecountsforallnotetypes.
Table Note 75:Fieldsg49tog55areincludedonlywhendualcash
handlersareemulatingasinglecashhandlerasdefinedby
enhancedconfigurationoption76.Fordetailsofoption76,see
Option76CashHandlersonpage 717.
Table Note 76:Fieldg55isusedonlyifrecyclingisenabled.If
recyclingisnotenabled,thisfieldcontains00000.
Table Note 77:Notesreturnedtothecardholderwithoutbeing
processedareunknownunderCENXFS.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-64

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

SendTallyInformation

FromAdvanceNDC2.06onwards,tallyreportingisnotsupported.
AdefaultmessageissenttoCentralinresponsetoaSendTally
GroupTerminalCommandmessage(acommandcodeof5).
Thedataisalwaysasshowninthefollowingtable:
Table 9-26
Send Tally Information Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.Thismessagehasidentifier3.

g2

GroupNumber.Containsthegroupnumberoftherequestedtallies
(AtoNorV).

g3

12

DateAndTimeLastCleared.
Thisfieldalwayscontainsthefollowingdefaultdateandtime:
YY=Year(00)
MM=Month(01)
DD=Day(01)
HH=Hour(00)
MM=Minute(00)
SS=Second(00)

g4

TallyData.
Thisfieldisalways=000000.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-65

Terminal to Central Messages


Solicited Status Messages

SendErrorLogInformation

Note:FromAdvanceNDC2.06onwards,errorlogreportingis
notsupported.AdefaultmessageissenttoCentralinresponsetoa
SendErrorLogGroupmessage(acommandcodeof6)
Thedataisalwaysasshowninthefollowingtable:
Table 9-27
Send Error Log Information Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.Thismessagehasidentifier4.

g2

GroupNumber.Thegroupnumberoftherequestedloggroup
(A,BorC).

g3

NewEntries.
Thisfieldisalways00.

g4

12

DateLastCleared.
Thisfieldalwayscontainsthefollowingdefaultdateandtime:
YY=Year(00)
MM=Month(01)
DD=Day(01)
HH=Hour(00)
MM=Minute(00)
SS=Second(00)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-66

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Status Messages

SendDate/TimeInformation

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
DateAndTimemessage(acommandcodeof8).Fordetails,see
theTerminalCommandssectionofChapter 10,Centralto
TerminalMessages.
Table 9-28
Send Date/Time Information Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.Thismessagehasidentifier5.

g2

ToDClockStatus.Thisfieldhasthefollowingvalues:
0Timeisactual.
1Timeisdefault(clocknotloadedwithactualtime).
2ToDmalfunction.

g3

12

TerminalDate/Time.Theactualdateandtimereturnedbythe
terminalclockinthefollowingformat:
YY=Year(0099)
MM=Month(0112)
DD=Day(0131)
HH=Hour(0023)
MM=Minute(0059)
SS=Second(0059)
If00<=YY<=89,theyearistakentobeintherange2000<=YY<=2089.If
90<=YY<=99,theyearistakentobeintherange1990<=YY<=1999.
InthecaseofaToDmalfunction,thesearezero.InthecaseofDefault
time,thevalueisinitialisedtothelowestvalue,andcountingstarts
fromthis.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-67

Terminal to Central Messages


Solicited Status Messages

SendConfigurationID

ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationIDterminalcommandmessage(acommandcodeof
3).Fordetails,seetheTerminalCommandssectionof
Chapter 10,CentraltoTerminalMessages.
Table 9-29
Send Configuration ID Response
Field

Number of
Characters

Mandatory/Optional

Description

g1

MessageIdentifier.Thismessagehasidentifier6.

g2

ConfigurationID.ContainsthelastfourdigitconfigurationID
number(00009999)senttotheterminalfromCentral.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-68

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Device Fault Status

SolicitedDeviceFaultStatus

ThissectiondescribestheinformationcontainedintheStatus
InformationfieldwhentheStatusDescriptoris8DeviceFault,
Fordetails,seetheDeviceFaultStatusInformationFieldsection.
AllsolicitedstatusdevicefaultmessagesrequireCentraltoreply
withaTransactionReplycommand.Thecashhandlerand
depositorydevicesareusedonlyinresponsetoaTransactionReply
(TR)command,andonlygiveunsolicitedstatusesduring
TransactionReplyprocessing.
ThefirstcharacterintheStatusInformationfieldidentifiesthe
devicebymeansofaDIG.Devicesareidentifiedbythesamecode
inSolicitedandUnsolicitedmessages.Fordetails,seeAppendix E,
DeviceIdentifiers.

DeviceFaultStatus
Responses
Table 9-30
Device Fault Status in Response to
Transaction Reply Commands

Thefollowingtableshowsthesoliciteddevicefaultstatusmessages
whichmaybereturnedforeachTransactionReplycommand.
9

Transaction Reply Command

Device Faults

DepositandPrint

Depository

DispenseandPrint

CashHandler,Coin
Dispenser

PrintImmediate

None

SetNextStateandPrint

None

NightSafeDepositandPrint

None

CardBeforeCash

CardReader/Writer,Cash
Handler,CoinDispenser

FastCash

CashHandler,Coin
Dispenser

CardBeforeParallelDispenseand
Print

CardReader/Writer,Cash
Handler,CoinDispenser

PrintStatementandWait

StatementPrinterand
Receiptinsidewaysmode

PrintStatementandSetNextState

StatementPrinterand
Receiptinsidewaysmode

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-69

Terminal to Central Messages


Solicited Device Fault Status

DeviceFaultStatus
InformationField

Transaction Reply Command

Device Faults

Refund

BunchNoteAcceptor

Encash

BunchNoteAcceptor

ProcessCheque

ChequeProcessingModule

WhentheStatusDescriptoris8DeviceFault,theinformation
giveninTable 931ispresentintheStatusInformationfield.Inthe
NumberofCharacterscolumn,anumberinbracketsindicatesthe
maximumfieldlength.
Thedatareturnedinthefieldsisvariableinlengthasitisdifferent
foreachdevice,buteachdevicewillalwayssendthesamenumber
ofcharacters.Fordetails,seeFitnessDataonpage E19.

Table 9-31
Device Fault Status Information Field
Field

Number of
Characters

Mandatory/Optional

Description

g1

DeviceIdentifierGraphic(DIG).Thedeviceidentifier.

g2

Var(17)

TransactionStatus.Containsinformationrequiredtomakea
transactioncompletiondecision.

FS

SeeTableNote78

FieldSeparator

g3

Var(14)

ErrorSeverity.Containsinformationrequiredtodecidewhetherto
shutdownorcontinuetousetheSST.Eachcharacterisalwayscoded
inthesameway:
Code

Description

NoError.Continuetousenoerrorhasoccurred.Diagnostic
informationfollows.

Routine.Continuetousearoutineerrorhasoccurredand
diagnosticinformationfollows.

Warning.Continuetouse,butitisrecommendedthatthe
networkoperatorbeinformedoftheerrororexception
condition.Diagnosticinformationfollows.

Suspend.Thiscodeindicatesthattheterminalwillsuspend
transactionprocessingoncompletionofthecurrent
transaction(state000entered).Thisissentifcardholder
tamperingissuspected.IfnoactionistakenbyCentral,the
terminalwillattempttogobackinserviceinfiveminutes.
Diagnosticinformationfollows.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-70

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Solicited Device Fault Status

Field

Number of
Characters

Mandatory/Optional

Description

Fatal.Thiscodeindicatesthatthedeviceisoutofserviceand
willcontinuetoreportfatalerroruntiloperatorintervention
attheterminal.Itisrecommendedthattheterminalisput
outofserviceorthattransactionsinvolvingthefaultydevice
arenotallowed.

FS

SeeTableNote78

FieldSeparator

g4

Var

DiagnosticStatus.Usedforloggingerrors.Thefieldlengthmaybe
omittedifthereisnoerrorconditiontobereported.Thefieldwill
alwaysbepresentifprecededbyanErrorSeverityfieldwithavalue
of1orgreater.Thefollowingvendorspecificrulesareappliedforall
devices:
Characters1and2containamainerrorstatusvalue(MStatus)inthe
range099,transmittedastwocharacterswhichgivethedecimal
representationoftheMStatusvalue.
MStatusisusedmainlyasanerrorlogtoassistmachineservicing.It
mayalsobeusedinatransactionlogtosupplementTransaction
statusorDevicestatusinformation.
Note:ForaGBRUwithEnhancedConfigurationoption78setto
000,seeGBRUtoCDMMStatusMappingonpage 972forthe
MStatusreporting.
Characters3ton(MData)containdetaileddiagnosticinformation
relatedtothedevice.Eachbyteistransmittedastwocharacters.
Thesegivethehexadecimalrepresentationofthevalueofthebyte.
Note:Thedatareturnedfordevicesishardwaredependent,except
fortheEJprinter,wherethedataisapplicationdriven.
Note:WhereanEPPispresent,thedatareturnedinthisfieldisof
theformat00mm.00isalwaysreturnedincharacters1and2,andmm,
incharacters3ton,containsthevaluefrombyte0oftheTdata.

FS

SeeTableNote78

FieldSeparator.

g5

Var(8)

SuppliesStatus.Containsinformationaboutthestateofsupplies
(paper,currency,magneticcards,envelopes,inkwells,documents)in
theterminal.Thisfieldcontains1characterforeachsupplies
containermanagedbythedevice.Eachcharacterisalwayscodedin
thesameway:
0

NoNewState.Thestateofthecontainercanbeassumedto
beunchanged.

GoodState.Thestateofthecontainerisknowntobegood,
forexample,notlow,emptyoroverfilled.

MediaLow.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-71

Terminal to Central Messages


Solicited Device Fault Status

Field

Number of
Characters

Mandatory/Optional

Description

MediaOut.

Overfill.Thecontainerhassensedafullconditionand
shouldbeemptied.

Ifthisfieldisomitted,itcanbeassumedthatthereisnonewstate
onanycontainer.

Table Note 78:Includedifanyofthesubsequentfieldsarepresent.


Asthefieldlengthsmaychangewiththehardwarebeingused,
Centralshouldnotattempttoanalysethesefieldsbyallocatinga
fixedlengthtoeachdevice.Insteadfieldlengthsshouldbe
determinedbysearchingfortheFS(fieldseparator)characters.

GBRUtoCDMMStatusMapping
ForaGBRUdeviceusedasacashdispenser,youcanchooseto
reporttheMStatus(fieldg4)asaCDMorasaGBRU.Thisisset
usingEnhancedConfigurationoption78,fordetailsseeOption78
GBRUMStatusReportingonpage 718.
ToreportusingtheCDMMStatus,theGBRUMStatusismapped
toanequivalentCDMMStatus.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-72

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Other Solicited Messages

OtherSolicitedMessages

Othersolicitedmessagesthatcanbesentfromtheterminalto
Centralareasfollows:

EncryptorInitialisation
Data

EncryptorInitialisationData
UploadEJDataMessage

Thismessageclass/subclassisusedwheninitialisingtheencryptor
module,andisusedinasimilarwaytotheterminalstatemessage.
However,itdoesnotcontainanyofthefieldsassociatedwith
messageauthentication,andisthereforesuitablefortheinitial
exchangeofdatarequiredtoinitialisetheencryptor.
ThissolicitedmessageisreturnedinresponsetoanExtended
EncryptionKeyChangemessage,describedinExtended
EncryptionKeyChangeonpage 1036.

Table 9-32
Encryptor Initialisation Data Response
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
2Solicitedmessage.

MessageSubClass.Themessagesubclassis:
3EncryptorInitialisationData.

FS

FieldSeparator

3or9

LogicalUnitNumber(LUNO).Thisnumberisdefinedinafield
transmittedtotheterminalinaConfigurationParametersLoad
message.Thedefaultis000.Ifthedatasecurityfeatureisconfigured,
anadditionalsixcharactersarepresent.Thesecontainthesecurity
terminalnumber.

FS

FieldSeparator

FS

FieldSeparator

InformationIdentifier.Identifiesthetypeofinformationsent,as
follows:
1

EPPserialnumberandsignature

EPPpublickeyandsignature

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-73

Terminal to Central Messages


Other Solicited Messages

Field

Number of
Characters

Mandatory/Optional

Description

NewKeyVerificationValue(KVV)

Keysstatus

Keyloaded

Keyentrymode

RSAencryptionKVV

SSTcertificate

SSTrandomnumber

PKCS7keyloaded

Encryptorcapabilitiesandstate

Keydeleted

EPPattributes

VariablelengthEPPserialnumberandsignature

FS

FieldSeparator

Var

EncryptorInformation,dependentontheInformationIdentifierin
fielde,asfollows:

WhenInformationIdentifier=1:
8

EPPSerialNumber

320

EPPSerialNumberSignature,createdusingtheRSANCRkey,and
base94encoded.ForfurtherdetailsofEPPauthenticationandbase94
encoding,seeEPPAuthenticationProcessonpage 1118andBase
94EncodingandDecodingonpage 1126.

WhenInformationIdentifier=2:
320

EPPPublicKey(PKEPP),base94encoded.
TheexponentoftheEPPPublicKeyisalways65537,andis
thereforenotsenttoCentral.

320

EPPPublicKeySignature,createdusingtheRSANCRkey,andbase
94encoded.ForfurtherdetailsofEPPauthenticationandbase94
encoding,seeEPPAuthenticationProcessonpage 1118andBase
94EncodingandDecodingonpage 1126.

WhenInformationIdentifier=3:
6or72

NewKVVforkeyjustloadedorreactivated

WhenInformationIdentifier=4:
KeysStatus,containingKVVsasfollows:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-74

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Other Solicited Messages

Field

Number of
Characters

Mandatory/Optional

Description

MasterKeyKVV

CommunicationsKeyKVV

MACKeyKVV

BKeyKVV

Ifakeyhasnotbeenloaded,itsKVVwillbesixzeroes.
IfthehardwaredoesnotallowaKVVtobegenerated,6spaces(0x20)
willbereported
Note:CentralshouldacceptavariablelengthKeyStatusfield,incase
newkeysneedtobeaddedinthefuture.
FordetailsofthecalculationofKVVs,seeKeyVerificationValues
onpage 1117.
WhenInformationIdentifier=5:
ForKeyLoaded,thisfieldisabsent.
WhenInformationIdentifier=6:
KeyEntryMode,asinglecharacterintherange1to4asfollows:
1

SinglelengthwithoutXOR

SinglelengthwithXOR

DoublelengthwithXOR

Doublelength,restricted.

WhenInformationIdentifier=7
3

Binarydatalength

Var

RSAKVVbase94encoded

WhenInformationIdentifier=8
3

Binarydatalength

Var

SSTcertificatebase94encoded

WhenInformationIdentifier=9
Var

SSTrandomnumber,ASCIIhexadecimalencoded.

WhenInformationIdentifier=A
6

KVVofnewDESkey

Binarydatalength

Var

KeyLoadAcknowledgementPacket,base94encoded
SeeTableNote79
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-75

Terminal to Central Messages


Other Solicited Messages

Field

Number of
Characters

Mandatory/Optional

Description

WhenInformationIdentifier=B
2

RemoteKeyProtocol,twocharactersintherange00to06as
follows:
00

None

01

Signature

02

Certificate

03

Signatureandcertificate

04

Enhancedsignature

06

Enhancedsignatureandcertificate

Certificatestate
00Notreadyornotsupported
01Certificateprimary
02Certificatesecondary

EPPVariableLengthSerialNumberCapability
SeeTableNote80
0

VariablelengthEPPserialnumbersnotsupported
SeeTableNote81

VariablelengthEPPserialnumberssupported
SeeTableNote82

WhenInformationIdentifier=C
ForKeyDeleted,thisfieldisabsent
WhenInformationIdentifier=D
EPPattributesaredefinedasfollows:
1

Var

EPPVendorCompanyNameIdentifier
AlphanumericcharactersthatdefinetheEPPvendorcompany
nameasregisteredwithPCI

GroupSeparator

Var
1

EPPModelIdentifierDataIdentifier
AlphanumericcharactersthatdefinetheEPPmodelidentifier
asregisteredwithPCI

GroupSeparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-76

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Other Solicited Messages

Field

Number of
Characters

Mandatory/Optional

Description

Var

EPPHardwareIdentifierDataIdentifier
AlphanumericcharactersthatdefinetheEPPhardware
identifierasregisteredwithPCI

GroupSeparator

Var

EPPFirmwareIdentifier(s)DataIdentifier
AlphanumericcharactersthatdefinetheEPPfirmware
moduleidentifiersasregisteredwithPCI.

GroupSeparator

Var

EPPApplicationIdentifier(s)Dataidentifier
Alphanumericcharactersthatdefinetheapplicationmodule
identifiersasregisteredwithPCI

WhenInformationIdentifier=E
ThevariablelengthEPPserialnumberandsignaturearereturnedas
follows:
Var

EPPserialnumber(SNEPP)

GroupSeparator

Var

SNEPPsignaturesignedusingSKVendor(SNEPP*SKVendorbase
94encoded)

Table Note 79Thekeyloadacknowledgementpacketis


summarisedasfollows:
(Sign(SKSST)[RHost||RSST||IHost])

Thisisinterpretedasfollows:
SKSST

=SSTsverificationsecretkey

RHost

=Hostsrandomnumber

RSST

=SSTsrandomnumber.

IHost

=Hostidentifier

Table Note 80Anumberofmessageswereoriginallydefinedwith


an8bytefixedlengthfieldfortheEPPserialnumber.However,8
bytesarenotsufficientforEPPsfromsomevendors.Thisfield
reportswhethervariablelengthserialnumbersaresupported.
WhenvariablelengthEPPserialnumbersaresupported,NCR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-77

Terminal to Central Messages


Other Solicited Messages

recommendsthatthehostusesvariablelengthvariantsof
messages.
Table Note 81:IfvariablelengthEPPserialnumbersarenot
supported,thefollowingconditionsapply:

OnlyEPPswith8byteserialnumberscanbesupported
TheEPPserialnumbercanonlyberequestedthroughthe
ExtendedEncryptionKeyChange(EEKC)commandwitha
modifierofF(theresponseisDataIdentifier1).
TheEEKCcommandtodeletehostpublickeysInEnhanced
RemoteKeyLoading(modifiersSandT)mustusethe
definitionforafixedlengthserialnumbermessage.

Table Note 82IfvariablelengthEPPserialnumbersaresupported


thefollowingapply:

UploadEJDataMessage

EPPswithanylengthofserialnumbercanbesupported
TheEPPserialnumbercanberequestedthroughtheEEKC
commandwithamodifierofF(theresponseisDataIdentifier
1).ThisworksonlyonEPPswith8byteserialnumbers.
TheEPPserialnumbercanberequestedthroughtheEEKC
commandwithamodifierofV(theresponseisDataIdentifier
E).ThisworksonEPPswithserialnumbersofanylength.
TheEEKCcommandtodeletehostpublickeysinEnhanced
RemoteKeyLoading(modifiersSandT)canuseeitherthe
fixedlengthorvariablelengthdefinitionfortheserialnumber.

TheterminalsendsthissolicitedmessagetoCentralinresponseto
anEJCommand,takingthedatafromthefileejdata.loginthe
c:\programfiles\ncraptra\advancendc\datadirectoryontheSST.A
pointerismaintainedinpersistentmemorytoindicatethelocation
ofthenextblockofdatatobeuploaded.Anybinaryzerosinthe
electronicjournaldataarereplacedwithanASCIIquestionmark(?)
characterbeforetheuploaddataissent.
Thesizeoftheelectronicjournaldatablocksthataresentineach
uploadmessagecanbesetintheEJOptionsandTimerscommand.
FordetailsofEJOptionsandTimersandacknowledgement
messages,seetheEJCommandsonpage 1081.
TheSSTwillcontinuetouploadEJdatablocksaslongasan
acknowledgementmessageisreceivedfromCentralforeach
messagesent.Ifanacknowledgementisnotreceivedwithinthe
timespecifiedbytimer60,theSSTwillresendthecurrentblockup
tothemaximumnumberofretriessetintheEJOptionsandTimers
message.WhenallEJdataisuploaded,thedataisdeletedfromthe
ejdata.logfile.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-78

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Other Solicited Messages

TheSSTwillonlysendanUploadEJDatamessage,orprocessanEJ
command,wheninOutofServicemodeorInServicemodewhen
thereisnotransactioninprogress.UploadEJDatamessageswill
notbesentwhentheSSTisinSupervisormode.AnyEJdata
accumulatedintheEJfileejdata.logwhiletheSSTisinSupervisor
modewillbesentatthenextopportunity.
Note:TheSupervisorfunctionINITEJRNLshouldnotbe
performedduringEJupload.Formoreinformation,refertothe
APTRAAdvanceNDC,SupervisorsGuide,Chapter3,Replenish
Menu.
Table 9-33
Format of the Upload EJ Data Message
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
6ElectronicJournal.

MessageSubClass.Themessagesubclassis:
1UploadData.

FS

FieldSeparator

FS

FieldSeparator

FS

FieldSeparator

FS

FieldSeparator

MachineNumber.Range000000to999999.

Date.Range000000to999999intheformatYYMMDD.
Datetheblockwassent,determinedbytheSSTsinternalclock.

Time.Range000000to999999intheformatHHMMSS.
Timetheblockwassent,determinedbytheSSTsinternalclock.

LastCharPreviousBlock.
Range000000to999999.SeeTableNote83.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-79

Terminal to Central Messages


Other Solicited Messages

Field

Number of
Characters

Mandatory/Optional

Description

LastCharThisBlock.
Range000000to999999.SeeTableNote83.
TheSSTcomparestheLastCharacterReceivedfieldinthe
acknowledgementmessagesentfromthehostwiththeLastCharThis
BlockfieldofthelastUploadEJDatamessageitsenttotheHost.If
thesetwovaluesarenotthesame,theacknowledgementmessageis
ignored.Formoredetails,seetheEJCommandssectionin
Chapter 10,CentraltoTerminalMessages.
TheLastCharacterPreviousBlockfieldcanbeusedbythehostto
checkonthereceivedmessage.

BlockLength.Range001350.Defaultis200.
SetusingtheEJOptionsandTimerscommandmessage;onlythelast
datablocksenttothehostshouldbelessthanthisblocklength.

Var

ResponseData.Range001350asspecifiedbyFieldi.Uploaddata
consistsofASCIItextwithacarriagereturn(CR)attheendofeach
line.Linesareamaximumof40characters.SeeTableNote84.

Table Note 83:TheLastCharPreviousBlockandLastCharThis


Blockvaluesarebasedonamodulus1,000,000charactercount
whichstartsatzerofollowingacoldstartoftheSST.Thecountis
incrementedforeachcharacterwrittentotheelectronicjournal.The
countisnotresetforawarmstart,thatis,apowerfailorreset
duringwhichthepersistentmemoryispreserved.
Table Note 84:Ifthelastblocklengthattheendoffileislessthan
specifiedinFieldi,thatlengthwillbereturned.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-80

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Unsolicited Status Messages

UnsolicitedStatusMessages

Unsolicitedstatusmessagesareusedtoreportanychangeof
conditionattheterminal.Theseinclude:

ConditionsforSending
UnsolicitedMessages

Recognitionofanexternalevent
Deviceerrors
Suppliesproblems.

UnsolicitedstatusmessagesdonotrequireareplyfromCentral.
Theyaresentunderthefollowingconditions:
9

Powerfailure:amessageissentonpowerup
Anexternaleventisdetected.Thisincludesbininserted/
removed,alarmactivated,supervisorkeysandswitches.The
reportingofsupervisorswitchchangesisdelayediftheSSTisin
use
AdevicefaultisdetectedasaresultofprocessingaTransaction
Replycommand,butthefaultconditiondoesnotrequire
Centralrecoveryaction.ThismeansthatTransactionReply
processingcancontinueasifnofaulthadoccurred
Adevicefaultisdetectedwhichisnottheresultofprocessinga
TransactionReplycommand.Forexample,printer/MCRW
errors
Ifanalarmisactivatedduringapowerfailureor
communicationsloss,amessageissentwhenpoweror
communicationsarerestored
Ifsupervisor/supplyswitchvaluesarechangedwhileoffline,
thelastchangeofbothswitchesisreportedwhen
communicationsarerestored
IfthemessagemodeoptionissettoenabletheCancelkeywhile
aStatementandWaitfunctionisbeingcarriedoutandthe
cardholderpressestheCancelkey.Fordetails,refertothe
APTRAAdvanceNDC,SupervisorsGuide
ErrorsintheClosestate.

Note:Exitscanalsosendunsolicitedstatusmessages.Theseareof
thesameformatasstandardunsolicitedstatusmessages,butthe
contentoftheStatusInformationfielddependsontheExit.For
moreinformation,refertothepublication,APTRAAdvanceNDC,
ExtendingtheProduct.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-81

Terminal to Central Messages


Unsolicited Status Messages
Table 9-34
Unsolicited Status: Message Format
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
1Unsolicitedmessage.

MessageSubClass.Themessagesubclassis:
2Statusmessage.

FS

FieldSeparator

3or9

SeeTableNote85

LogicalUnitNumber(LUNO).Thisnumberisdefinedinafield
transmittedtotheterminalinaConfigurationParametersLoad
message.Thedefaultis000.Ifthedatasecurityfeatureisconfigured,
anadditionalsixcharactersarepresent.Thesecontainthesecurity
terminalnumber.

FS

FieldSeparator

FS

FieldSeparator

Var

StatusInformation.Thecontentofthisfieldvariesaccordingtothe
messagemodeselectedatinstallationtime.SeeTable935.

Var

Trailer.Protocoldependent.

Table Note 85:Inpowerupstatusmessages,thisfieldcontains


eithertheLUNOthathasbeenpreviouslydownloaded,or000.

UnsolicitedStatus
InformationField

Oneofthefollowingconditionsmustbesatisfiedbeforean
unsolicitedmessageissent:
9

Devicestatusisnonzero
Errorseverityis2(warning)orgreater
Suppliesstatusis2,3,or4.

Aroutineerrordoesnotgenerateanunsolicitedstatusmessage.
ThefollowingtableshowsthestructureoftheStatusInformation
fieldinunsolicitedstatusmessages.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-82

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Unsolicited Status Messages
Table 9-35
Unsolicited Status: Status Information Field
Field

Number of
Characters

Mandatory/Optional

Description

e1

DeviceIdentifierGraphic(DIG).Thedeviceidentifier

e2

Var
(154max)

DeviceStatus.Usedforrecordinganytransactionexceptionof
changeofstateofthedevice.Fordeviceswhichreportboth
SolicitedandUnsolicitedStatusmessages,acommonsetof
Transaction/DeviceStatuscodesaredefinedforuseineithertype
ofmessage.WhenprocessingaTransactionReplycommand,any
unsolicitedTransactionexceptionsarereportedpriortothe
soliciteddevicefaultorreadystatus.

FS

SeeTableNote86

FieldSeparator

e3

Var(14)

ErrorSeverity.Asg3inSolicitedmessages.

FS

SeeTableNote86

FieldSeparator

e4

Var

DiagnosticStatus.Asg4inSolicitedmessages.

FS

SeeTableNote86

FieldSeparator

e5

Var(8)

SuppliesStatus.Asg5inSolicitedmessages.

e6

Var

Additionaldataspecifictodevicemessage.Canbeusedtoreport
thecardnumberofacapturedcard.

Table Note 86:Thisfieldseparatorisincludedifanyofthe


followingoptionalfieldsareincluded.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-83

Terminal to Central Messages


Device Status Information

DeviceStatusInformation

Solicitedorunsolicitedstatusinformationcanbereportedfor
devicesasdescribedinthefollowingsections.
Forinformationonthejournallingthatoccurs,refertotheAPTRA
AdvanceNDC,SupervisorsGuide.

TimeOfDayClock
(Unsolicited)

ThismessageindicatesthattheTimeofDayClockisnotavailable.
Centralcaneitherkeeptheterminaloutofserviceorreturnitto
service.

Table 9-36
Time-Of-Day Clock Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicA.

e2

DeviceStatus.
1Clockresetbutrunning.
2Clockhasstopped.

e3

ErrorSeverity.
2Warningclockreset.
4Fatalclockmalfunction.

e4

Notpresent.

e5

Notpresent.

PowerFailure
(Unsolicited)

ThismessageissentduringpoweruptotellCentralthatapower
interruptionhasoccurred.IftheSSTisconfiguredtosenda
messagewhenevercommunicationsisrestored,thismessageissent
whentheconnectionisreestablished.
CentralcanusetheconfigurationIDcontainedinthismessageto
checkwhetheradownloadisneededbeforesendingaStartUp
TerminalCommandmessagetoputtheterminalinservice

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-84

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information
Table 9-37
Power Failure Status
Field

No. of Characters

Content

e1

DeviceIdentifierGraphicB.

e2

DeviceStatus.Thiscontainstheconfigurationidentificationnumber(00009999)of
thecustomisationdatastoredondisk.Centralcanusethisinformationtocheckifa
downloadisneededbeforeputtingtheterminalinservice.Avalueof0000
indicatesthatadownloadmustbeperformed.

e3

Notpresent.

e4

Notpresent.

e5

Notpresent.

CardReader/Writer
(Solicited/Unsolicited)

Thismessagegivesdetailsofanyexceptionconditionthatis
detectedduringcardprocessing.Soliciteddevicefaultsarereported
onlyonCardBeforeCashtransactions.
Note:Iffailureoccursinthephysicalconnection,anunsolicited
statusmessageisreportedindicatingthattheMCRWhasafatal
severityandthatthedeviceisinoperative.AdvanceNDCdoesnot
puttheSSTintoOutofServicemodewhentheMCRWentersafatal
state.Itistheresponsibilityofthehostandthehostmustbe
configuredtodothisifrequired.

Table 9-38
Card Reader/Writer Status
Number of
Characters

Content

g1/
e1

DeviceIdentifierGraphicD.

g2/
e2

Transaction/DeviceStatus.Givesdetailsofanytransactionrelatedexceptioncondition
detectedwhileprocessingacardattheterminal.Possiblevaluesare:

Field

Sol/
Unsol

Code

Description

Notransactionexceptionconditionoccurredbutconsultotherfieldsfor
errorseverity,diagnosticstatusorsuppliesstatuschanges.

S/U

Thecardholderdidnottakehiscardwithintheallowedtimeanditwas
capturedorjammed.SeeTableNote87

S/U

Themechanismfailedtoejectthecard,whichwaseithercapturedor
jammed.

S/U

Themechanismfailedtoupdatetherequestedtracksonthecard.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-85

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

S/U

InvalidtrackdatareceivedfromCentral.

Errorintrackdata.

IfusingEMV/CAM2,usetheEMV/CAM2generatedhardwareerrortoidentifythe
devicestatus.
EMV/CAM2canalsogeneratemessagestoidentifywhethertheerrorisduetohardware
ordataproblemsusingaDIGofc.
ForfurtherinformationaboutEMV/CAM2messages,refertotheEMVIntegratedCircuit
Card(ICC)ReferenceManual.
g3/
e3

Var
(1or2)

ErrorSeverity.Thisisaoneortwocharacterfieldcodedinthestandardwaytobeusedto
makeashutdowndecision.

g4/
e4

Var

DiagnosticStatus(MstatusplusMdata).Thiscontainsinformationtobeusedfor
loggingdeviceerrors.TheMstatusdescribesthemainerrorfound.

g5/
e5

SuppliesStatus.Thisisasinglecharacterfieldindicatingthestateofthecardcapturebin.
Code

Description

Nonewstate

Nooverfillcondition(capturebin)

Overfillcondition(capturebin)

Table Note 87:Ifacardjamsduringacaptureoperation,multiple


unsolicitedmessagesaresent.Thefinalmessagewillhaveadevice
statusof1althoughtheprecedingmessagesmayhaveadevice
statusof0.

CashHandler
(Solicited/Unsolicited)

Thismessagegivesdetailsofadispenseoperationinresponsetoa
TransactionReplyCommandmessage.
9

Duringatransactionwhenacassetteisreenabledfordispensing,
nodispensedorpresentednotecountsarereported.
Note:Statusandsuppliesofanyaffectedcassettearereported.
TheformatdependsonthesettingofEnhancedConfiguration
option76,asdescribedinTable 939.WhenEnhancedConfiguration
option76issetto001,thecountsandstatusfieldsreportcassette
typesinnumericalorder.
IfOptionDigit4Aisset,asolicitedstatusmessageisreturnedwhen
notesaresuccessfullyretracted.Fordetailsofoptiondigits,referto
theAPTRAAdvanceNDC,SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-86

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information
Table 9-39
Cash Handler Status
Field

Number of
Characters

Content

g1/e1

DeviceIdentifierGraphicE.

g2/e2

Var(23)

Transaction/DeviceStatus(TcodeplusTdata).Givesdetailsofadispenseoperationin
responsetoaTransactionReplyCommandmessage.Character1(Tcode)canbe:

Sol/Unsol

Code

Description

Successfuloperation,butanexceptionhasoccurredasdetailedin
subsequentfields.

Shortdispense.
Foraspraydispenser,thiscanalsoindicatethatanextranotehas
beendispensed.

Nonotesdispensed.

Notesdispensedunknown.Thecardholdermayhavehadaccessto
anypresentednotes,soitshouldbeassumedsomemayhavebeen
dispensed.Interventionmayberequiredtoreconcilethecash
amounttotals.Thefollowingcountscontainrequesteddispense
values.

Nonotesdispensedorcardnotejected.Thisstatusisreturnedona
cardbeforecashtransactionifthestackoperationfailsandthenotes
arepurgedpriortocardeject.

S/U

Somenoteshavebeenretractedwhenthenoteswerenottaken
followingaPresenttimeout.Thenumberofnotesretractedis
unknown.

SeeTableNote94
WhenEnhancedconfigurationoption76issetto000,thecountsarereportedasfollows:
Characters29(Tdata)containnotesdispensedcounts.Eachpairofcharacters
representsatwodigitdecimalvalueintherange0099foraparticularcassettetype.
Characters

Cassette Types

23
45
67
89

1
2
3
4

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-87

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

Thefollowingoptionalcharacters1017areonlyvalidforaspraycashdispenser,and
containacountofnotesdispensedtothecardholderplusnotesinanunknownlocation.
Eachpairofcharactersrepresentsatwodigitdecimalvalueintherange0099fora
particularcassettetype.
Thedefaultmessageformatdoesnotincludethesecharacters.Theextrafieldsare
enabledinOptionDigit4C.Fordetailsofoptiondigits,refertotheAPTRAAdvance
NDC,SupervisorsGuide.
Characters

Cassette Types

1011
1213
1415
1617

1
2
3
4

WhenEnhancedconfigurationoption76issetto001,thecountsarereportedasfollows:
Characters215(Tdata)containnotesdispensedcounts.Eachpairofcharacters
representsatwodigitdecimalvalueintherange0099foraparticularcassettetype.
Characters

Cassette Types

23
45
67
89
1011
1213
1415

1
2
3
4
5
6
7

Thefollowingoptionalcharacters1631areonlyvalidforaspraycashdispenser,and
containacountofnotesdispensedtothecardholderplusnotesinanunknownlocation.
Eachpairofcharactersrepresentsatwodigitdecimalvalueintherange0099fora
particularcassettetype.
Thedefaultmessageformatdoesnotincludethesecharacters.Theextrafieldsare
enabledinOptionDigit4C.Fordetailsofoptiondigits,refertotheAPTRAAdvance
NDC,SupervisorsGuide.
Characters

Cassette Types

1617
1819
2023
2425
2627
2829
3031

1
2
3
4
5
6
7

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-88

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

g3/e3

5or8

ErrorSeverity.Usedtomakeashutdowndecision.
Character0

Severityinformationrelatedtocompletedevice

Character1

Severityrelatedtocassettetype1

Character2

Severityrelatedtocassettetype2

Character3

Severityrelatedtocassettetype3

Character4

Severityrelatedtocassettetype4

Ifenhancedconfigurationoption76issetto001,theerrorseverityisreportedforthe
furthercassettesasfollows:
Character5

Severityrelatedtocassettetype5

Character6

Severityrelatedtocassettetype6

Character7

Severityrelatedtocassettetype7

Ifallcassettesofonetypeareunusableforanyreason,forexample,empty,notpresent,
orfaulty,thentheseveritycodeforthatcassettetypeismarkedasfatal.
Ifdualcashhandlersareused,thisseveritycodecanbechangedtosuspendusinga
registrykey,asdescribedintheAPTRAAdvanceNDC,DevelopersGuide.Thesuspend
severityisreportedwhenneithercashhandlerhastherequirednotemix.Reportinga
fatalseveritymeansthatanavailablenotetypeisneverrequested;thesuspendseverity
allowstransactionstocontinuerequestingbothnotetypes.
g4/e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound
andoccupiestwocharacters.

g5/e5

SuppliesStatus.Indicatesthestateofthecurrencycassettesandrejectbin.
SeeTableNote89
Character0

stateofrejectbin

Character1

stateofcassettetype1

Character2

stateofcassettetype2

Character3

stateofcassettetype3

Character4

stateofcassettetype4

IfEnhancedConfigurationoption76issetto001,thesuppliesstatusisreportedforthe
furthercassettesasfollows:
Character5

stateofcassettetype5

Character6

stateofcassettetype6

Character7

stateofcassettetype7

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-89

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

Codesforcharacters1to7are:
Code

Description

Nonewstate(cassettenotaccessedorstateunknownbecauseofafatal
hardwaremalfunction).
SeeTableNote90

Sufficientnotes.

Noteslow.

Outofnotes.

Codesforcharacter0are:
Code

Description

Nonewstate(cassettenotaccessedorstateunknownbecauseoffatal
hardwaremalfunction).
SeeTableNote90

Nooverfillcondition.

Overfillcondition.

Note: Ifanattemptismadetodispensenotesfromacassettetypethatisnotinstalled,a
suppliesstatuscodeof3isreturned.

Table Note 88:Foraspraydispenserthenotesdispensedcountsare


significant.Forexample,thecardholdermayhavereceivedsome,
butnotall,requestednotesduetoanerrorcondition.Inthiscase,
thesearecountsofthenotesdeliveredtothecardholder.However,
ifthenotesstickinthetransport,thesecountersdisplaythenumber
ofnotesrequestedandnotthenumberdelivered.
Table Note 89:Whennotesareretracted,thesuppliesstatusofall
cassettesisincludedintheunsolicitedmessageandjournalled.
Table Note 90:Bydefault,thesupplystatusreportedforrepeated
transactions,isthatofthecassettereferencedbythetransaction.If
thestatusremainsthesameastheprevioustransaction,itdoesnot
changeto0(nonewstate).Thepurgebinneverreports0.
Reportingoftheactualstatusofallcassettescanbeconfigured
throughtheregistry.Fordetailsoftheregistrysetting,refertothe
APTRAAdvanceNDC,DevelopersGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-90

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Thismessagegivesdetailsofadepositoperationinresponsetoa
TransactionReplyCommandmessage.

Depository
(Solicited/Unsolicited)

Table 9-40
Depository Status
Field

Number of
Characters

Content

g1/e1

DeviceIdentifierGraphicF.

g2/e2

Transaction/DeviceStatus.Givesdetailsofadepositoperationinresponsetoa
TransactionReplyCommandmessage.Thevaluesare:
Sol/
Unsol

Code

Description

Successfuloperation,butanexceptionhasoccurredasdetailedin
subsequentfields.

Timeoutoncardholderdeposit.

Failuretoenablemechanismforadeposit.

Envelope/documentjamorenvelope/documentdepositfailed.The
cardholderhasaccess.Thisstatusisalsoreturnedifthereisanydoubt
aboutcardholderaccess.

Envelope/documentjamorenvelope/documentdepositfailed.The
cardholderdoesnothaveaccess.

g3/e3

ErrorSeverity.Standardcode.

g4/e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

g5/e5

SuppliesStatus.Indicatesthestateofthedepositbin.Thisfieldisnotsentwiththe
messagewhenadeposittimeoutoccurs.Statesreportedare:
Code

Description

Noenvelopedeposited

Nooverfillcondition

Overfilldetected

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-91

Terminal to Central Messages


Device Status Information

ReceiptPrinter
(Solicited/Unsolicited)

Thismessageindicateswhetherornotaprintoperationhasbeen
successfullycompleted.Asolicitedstatusmessageissentonlyin
responsetoaPrintImmediateTransactionReplycommand.

Table 9-41
Receipt Printer Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicG.

e2

Transaction/DeviceStatus.Indicateswhetherornottheprintwassuccessfullycompleted.

e3

Sol/
Unsol

Code

Description

Successfulprint

S/U

Printoperationnotsuccessfullycompleted

Devicenotconfigured

Cancelkeypressedduringsidewaysreceiptprint

Receiptretracted

ErrorSeverity.Standardcodeusedtomakeashutdowndecision.
Holdstheseverityinformationaboutthereceiptprinterandcapturebin.
Byte/char1

ReceiptPrinter,corecomponents

Byte/char2

CaptureBin

e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

e5

SuppliesStatus.Indicatesthestatusoftheprinterpaper,ribbon,printhead,knifeand
capturebin.Thecapturebinseverityandsupplieswillbereportedas0,iftheprinter
doesnothaveacapturebin.
Char

Code

Description

Sufficientpaper

Paperlow

Paperexhausted

RibbonOK

Ribbonreplacementrecommended

Ribbonreplacementmandatory

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-92

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

PrintheadOK

Printheadreplacementrecommended

Printheadreplacementmandatory

KnifeOK

Knifereplacementrecommended

CapturebinOK

Capturebinoverfill

Whenapaperexhaustedconditionisdetected,thestatusmessageis:
TransactionStatus=0
ErrorSeverity=40
SuppliesStatus=31111
(Ribbon,printhead,knifeandcapturebinareOK).

JournalPrinter
(Unsolicited)

Thismessageindicateswhetherornotaprintoperationhasbeen
completedsuccessfully.FromAdvanceNDC2.06onwards,
continuousmessagingoffataljournaldevicestatusissetandcannot
bechanged.
Note:Althoughnoknifeispresentonthe40columnjournal
printer,astatusof1(knifeOK)isalwaysreturnedinany
unsolicitedstatusmessage,asacommonformatisusedacrossall
the40columnprinters.

Table 9-42
Journal Printer Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicH.

e2

1or25

Transaction/DeviceStatus.Indicateswhetherornottheprintwassuccessfully
completed.
SeeTableNote91,TableNote92,andTableNote93.
Sol/
Unsol

Code

Description

Successfulprint

Printoperationnotsuccessfullycompleted

Devicenotconfigured

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-93

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

Journalprinterbackupactivated

Journalprinterbackupandreprintterminated

Journalprinterbackupreprintstarted

Journalprinterbackuphalted

Journalprinterbackuplogsecurityerror

Journalprinterbackupreprinthalted

<

Journalprinterbackuptamperstateentered

e3

ErrorSeverity.Standardcodeusedtomakeashutdowndecision.

e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

e5

SuppliesStatus.Indicatesthestatusoftheprinterpaper,ribbonandprinthead.
Char

Code

Description

Sufficientpaper

Paperlow

Paperexhausted

RibbonOK

Ribbonreplacementrecommended

Ribbonreplacementmandatory

PrintheadOK

Printheadreplacementrecommended

Printheadreplacementmandatory

KnifeOK

Whenapaperexhaustedconditionisdetected,thestatusmessageis:
TransactionStatus=0
ErrorSeverity=4
SuppliesStatus=3111
(RibbonandprintheadareOK;knifeisalwaysOK).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-94

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Table Note 91:Ifthetransactioncodeis:,JournalPrinterbackupis


operational,andthevalueofEnhancedConfigurationParameters
Loadoption22is2,thefollowingextradataissent:
AnASCIIdigitstringwithaformatof
*XXX*dd/mm/yy*hh:mm*YYYY,asfollows:
XXX

thelastprintedSecurityTraceNumber

dd/mm/yy hh:mm therecorddateandtime


YYYY

therecordnumberrelativetothelast
printedSecurityTraceNumber

Table Note 92:Ifrequired,supervisormessagemodeoption12can


beusedtoreportajournaloutstatusaslow.Formoreinformation,
refertotheAPTRAAdvanceNDC,SupervisorsGuide.
Table Note 93:AsinNDC+,whennojournalprinterisconnectedto
theSSTandtheEJhasnotbeenactivated,nounsolicitedmessageis
senttothehosttoindicatethatthejournalisnotconfigured.

ElectronicJournalPrinter
(Unsolicited)

Thismessageindicateswhetherornotaprintoperationhasbeen
completedsuccessfully.
9

Note:Ifcutoverautomaticinitialisationisinuse,thismessage
shouldnotbereturnedwhentheEJfilereaches90%or100%full.As
cutoverperformsaninitialisationoperationwhentheEJfilereaches
90%full,the100%fullmessageisreturnedonlyifthecutover
operationfails.Forinformationonenablingcutover,refertothe
APTRAAdvanceNDC,SupervisorsGuide.
Table 9-43
Electronic Journal Printer Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicH.

e2

Transaction/DeviceStatus.Indicateswhetherornottheprintwascompletedsuccessfully.
Sol/
Unsol

Code

Description

Successfulprint

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-95

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

SeeTable
Note94.

Content

Printoperationnotcompletedsuccessfully

Devicenotconfigured.Bydefaultthiscodeissuppressed.Formore
information,refertotheAPTRAAdvanceNDC,DevelopersGuide.

EJindualmodeprintoperationsuccessful

>

EJindualmodeprintoperationnotsuccessful

e3

ErrorSeverity.Standardcodeusedtomakeashutdowndecision.

e4

Var

DiagnosticStatus(MstatusplusMdata).ThisdataisgeneratedbyAdvanceNDC.The
Mstatusdescribesthemainerrorfound,asfollows:
0
1
5
6
7
50
51
52
53
54
55

e5

EJstatusOK
EJfatal
EJlogfilefull
EJnotconfigured
EJlogfilenotfound
EJlogfileopenfailure
EJlogfileclosefailure
EJflexdisknotfound
EJflexdiskdriveheadjam
EJflexdiskprotected
EJflexdiskfull.

SuppliesStatus.Indicatesthestatusoftheelectronicjournal,asfollows:
Char

Code

Description

EJlogspaceOK

EJlogspacelow

EJlogfull

Valuealways1

Valuealways1

Valuealways1

Whenanelectronicjournallogspacelowconditionisdetected,thestatusmessageis:
TransactionStatus=0
ErrorSeverity=2
SuppliesStatus=2111

Table Note 94:Ifoption35intheenhancedconfiguration


parametersload(seepage 1018)issetto001(reportEJindual
modeunsolicitederrors)or002(reportEJandhardcopybackupin
dualmodeunsolicitederrors)andboththejournalprinterandthe
EJareinerror,twounsolicitederrorswillbereported:oneforthe
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-96

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

physicaldeviceandonefortheEJ.Iftheoptionissettothedefault
of000,onlythephysicaldevicewillbereported.Thefollowingtable
liststhemessagesequencesreturnedfordualmodeforeachtype.
Table 9-44
Unsolicited Message Sequences for
Option 35 (EJ Dual Mode)
Option 35
Value

000

Type

Message Sequence

Comment

Physical
journal

H0

Printoperationsucceeded

Papersuppliesareloworout

H1

Printoperationfailed

Sentwhentheprintoperationis
unsuccessful
Note:NomessagesaresentfromtheEJor
hardcopybackup

001

Physical
journal

EJonly

H0

Printoperationsucceeded

Papersuppliesareloworout

H1

Printoperationfailed

Sentwhentheprintoperationis
unsuccessful

H=

EJprintoperation
succeeded

Sentinadditiontomessagesforphysical
journal.EJisnearlyfull

H>

EJprintoperationfailed

EJisfull
Note:Nomessagesaresentfromhard
copybackup

002

EJand
hardcopy
backup

EJonly

Option 35
Value

Type

H0

Printoperationsucceeded

Papersuppliesarelow

H6

Journalprinterbackup
activated

Sentwhenthephysicaljournalprinter
entersafatalstate

H8

Journalprinterbackup
reprintstarted

Sentwhenthejournalprinterrestarts

H7

Journalprinterbackup
andreprintterminated

SentafterH8whenthereprintis
successfullycompleted

H;

Journalprinterbackup
reprinthalted

Sentifthejournalprinterentersafatal
stateduringareprint

H=

SuccessfulEJprint
operation

Sentinadditiontomessagesforphysical
journal.EJisnearlyfull

H>

EJprintoperationfailed

EJisfull

Message Sequence

Comment

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-97

Terminal to Central Messages


Device Status Information

NightSafeDepository
(Solicited/Unsolicited)

AsolicitedstatusmessageissentinresponsetoaTransactionReply
Commandmessageifthedeposithasnotbeendetected.Itindicates
thatoneofthefollowingconditionshasoccurred:

Cardholderhasnotattemptadeposit
Depositdoorisjammedclosed
Bagdetectionmechanismisfaulty.

Theunsolicitedstatusmessageissentonthetenthconsecutive
cardholderdidnotattemptdepositindication.
Table 9-45
Night Safe Depository Status
Field

Number of
Characters

Content

g1

DeviceIdentifierGraphicK.

g2

Transaction/DeviceStatus.

g3

Sol/
Unsol

Code

Description

Tenthconsecutivecustomerdidnotattemptadeposit.Reportedonly
once.

Undetecteddeposit,orbagdetectionswitchblockedbeforeenable.
SeeTableNote95.

ErrorSeverity.
Code

Description

Noerror.Bagdetectionmechanismwasclearwhenthedepositdoorwas
unlocked.

Warning.Bagdetectionmechanismwasblockedwhenthedepositdoorwas
unlocked(solicitedstatus).NCRrecommendsthatyoushutdowntheterminalif
yourequireconfirmationofalldeposits.

Tenthconsecutivecustomerdidnotmakedeposit(unsolicitedstatus).
g4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

g5

SuppliesStatus.Indicatesthestatusofthenightsafe.
Code

Description

Nonewstate(solicitedonly)

Nooverfillcondition

Overfillcondition

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-98

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Table Note 95:Ifthebagdetectionmechanismisblockedwhenthe


depositdoorisunlocked,thecardholderisgiventimetomakethe
deposit(timer08).Whentimer08expires,theerrorstatusissent.
Themoretimescreen(screenC00)isnotdisplayedunlessthebag
detectionmechanismisclearwhenthedoorisunlocked.
IfmessagemodeOptionDigit3Aissettocheckthebagdetection
mechanismbeforeunlockingtheNightDepositdoor,andthedour
isfoundtobeblocked(overfill),thesolicitedstatusmessageissent
immediately.Fordetails,seetheAPTRAAdvanceNDC,Supervisors
Guide.Inthiscase,nodepositisallowed.Thecurrenttransaction
mustbeterminatedbyCentral,andnofurtherNightDeposit
transactionswillbeallowedbyCentraluntiltheconditionis
cleared.

Encryptor(Unsolicited)

Thismessageindicatesthatanattempttousetheencryptorhas
failed.Ifanerrorstatusisreported,NCRrecommendsthatan
attemptbemadetoreenterthelocalencryptionkeys.

Table 9-46
Encryptor Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicL.

e2

DeviceStatus.
1

Encryptorerror.

Encryptornotconfigured.

e3

ErrorSeverity.Standardcodeusedtomakeashutdowndecision.

e4

Var

DiagnosticStatus.
Note:TheencryptorstatusisreportedintheMdatafieldoftheDiagnosticStatusfor
compatibilitywithNDC+.

e5

Notused.

Camera(Unsolicited)

Thismessageindicatesthatacameraerrorhasbeendetected.For
detailsoftheEnhancedConfigurationoptiontoenableunsolicited
errorreportingforthesecuritycamera,seeOption32Unsolicited
ReportingControlonpage 710.
SupervisormessagemodeOptionDigit3Bcanalsobesettosend
unsolicitedmessages.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-99

Terminal to Central Messages


Device Status Information
Table 9-47
Camera Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicM.

e2

DeviceStatus.Always0.

e3

ErrorSeverity.Thiscanbegood,warningorfatal.

e4

Var

DiagnosticStatus.
Note:TheMdatainformationappliesonlytocertaintypesofcamera.

e5

SuppliesStatus.Indicatesthestatusofthestoragecapacityforpictures.
Code

Description

CapacityOK

NearlyFull

CapacityExhausted

Sensors(Unsolicited)

ThismessageissentonSupervisormodeentryandexit,tamper
indicatingbinin/outconditionsandalarmconditions.

Table 9-48
Sensors Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicP.

e2

19

DeviceStatus.Thisfieldcontainsupto19bytes.
Byte1indicatesthetypeofchangebeingreported:
Char

Code

Description

TIsensorchange

Modechange

Alarmstatechange

SeeTableNote98

FullTIandfullalarmschangedetected

SeeTableNote98

FlexibleTIandalarmschangedetected

Ifbyte1=2(modechange)thenextbytegivesdetailsofthecurrentstate:
2

Supervisormodeexit

Supervisormodeentry

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-100

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

SimulatedSupervisormodeentry/exitduringAER(ifconfiguredthrough
theregistry)

Bytes3/413areomitted.
Forexample,P21indicatesSupervisormodeentryandP20Supervisormodeexit.
IfanextrafieldisincludedtodistinguishbetweensimulatedSupervisorentryandexit
duringAER,thecodesareP211andP201.Byte3isusediftheextrafieldisaddedinthe
message.
Forinformationonconfiguringtheextrafieldthroughtheregistry,refertothe
ConfiguringSupervisorFunctionalitysectionofchapter5intheAPTRAAdvanceNDC,
DevelopersGuide.
Ifbyte1=1(TIsensorchange)or3(Alarmstatechange)bytes213givedetailsofthe
stateofthefollowingsensors:
2

10

11

Supervisormodeinactive

Supervisormodeactive

Vibrationand/orheatsensorinactive.
SeeTableNote96andTableNote97.

Vibrationand/orheatsensoractive

Doorcontactsensorinactive.SeeTableNote96andTableNote97.

Doorcontactsensoractive

Silentsignalsensorinactive.SeeTableNote96andTableNote97.

Silentsignalsensoractive

Electronicsenclosuresensorinactive.SeeTableNote96andTableNote97.

Electronicsenclosuresensoractive

Depositbinout

Depositbinin

Cardbinout

Cardbinin

Currencyrejectbinout

Currencyrejectbinin

Currencycassetteinposition1(top)out

Currencycassetteinposition1(top)in

Currencycassetteinposition2(second)out

Currencycassetteinposition2(second)in

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-101

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

12

13

Currencycassetteinposition3(third)out

Currencycassetteinposition3(third)in

Currencycassetteinposition4(bottom)out

Currencycassetteinposition4(bottom)in

Ifbyte1=5(fullTIandfullalarmschangedetected)bytes213areasabove.Bytes1419
givedetailsofthestateofthefollowingsensors.
Char

Code

Description

14

Coindispenserout

Coindispenserin

Coindispenserhopper1out

Coindispenserhopper1in

Coindispenserhopper2out

Coindispenserhopper2in

Coindispenserhopper3out

Coindispenserhopper3in

Coindispenserhopper4out

Coindispenserhopper4in

CPMpocketsopen

CPMpocketsclosed

15

16

17

18

19

Ifbyte1=6(flexibleTIandalarmschangedetected),thedataisthesameasthatforthe
ExtendedTamperIndicatorIdentifierCoftheTamperandSensorsDatacommand.For
details,seeTable 920,TamperandSensorDataResponseonpage 948.
e3

Notpresent

e4

Notpresent

e5

Notpresent

Table Note 96:IftheterminalisnotconfiguredwiththeTamper


Indicatingfeature,acodeof1isneverreturnedandbytes713are
omittedfromallmessages.
Table Note 97:Ifadeviceisnotconfigured,theassociatedtamper
bytewilltakethevaluezero.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-102

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Table Note 98:Thesetypesofchangearereportedonlywhenoption


24issettosendtheEnhancedTI/Sensorstatus.

TouchScreenKeyboard
(Unsolicited)

Thismessageindicatesthatthekeyboardhasdetectedanerror.
9

Table 9-49
Touch Screen Keyboard Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicQ.

e2

DeviceStatus.Always3,indicatingahardwareerror.

e3

ErrorSeverity.Always4,indicatingfatal.

e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

e5

Notpresent.

ThismessageissenttoinformCentralofthefunctionsselectedby
theoperatorafterentrytoSupervisormode.

SupervisorKeys
(Unsolicited)

Note:WhenDiagnosticsisselectedfromtheSelectmenuin
Supervisor,anR07messageissenttothehost.Thisindicatesthat
theDiagnosticsoptionhasbeenselected,butnotwhetherentryto
Diagnosticshasbeensuccessful.
Table 9-50
Supervisor Keys Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicR.

e2

Var

DeviceStatus.
Char

Code

Description

IfOptionDigit0=0,thedevicestatusfieldwillcontaintwocharacters:
12

0098

KeyselectionfromSelectmenu.

or

IfOptionDigit0=1,thedevicestatusfieldwillcontainthreecharacters:
1

Selectmenu

Replenishmentmenu

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-103

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

23

Configuremenu

Accessmenu

Reserved.

Exitmenu.SeeTableNote99.

Exitmenu.SeeTableNote99.

0098

Menuitemselected.Forthepermittedvaluesforeachmenu,referto
theAPTRAAdvanceNDC,SupervisorsGuide.

or
IfOptionDigit0=2,thedevicestatusfieldwillcontainfivecharacters:
13

asforOptionDigit0=1

45

0098

Itemselectedfromasubmenu,suchastheKeyEntrymenu.Forthe
permittedvaluesforeachmenu,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.

or
IfOptionDigit0=3,thedevicestatusfieldwillcontainsevencharacters:
15

asforOptionDigit0=2

67

0098

Itemselectedfromtheoptions,suchascomponentselectiononthe
KeyEntrymenu.Forthepermittedvaluesforeachmenu,refertothe
APTRAAdvanceNDC,SupervisorsGuide.

or
IfOptionDigit0issettoanyvaluegreaterthan3,theselectionsarereportedasifOptionDigit0hadbeenset
to2;thatis,thecomponentselectionsarenotreported.

Table Note 99:Menunumbers7and8arereservedforExits


designers.YoumayalsoredefinethesemessagesusingtheSUPCTR
file.Formoreinformation,refertotheAPTRAAdvanceNDC,
ExtendingtheProductpublication.
Table Note 100:Whenamenuislongerthanonescreen,function
99isusedtoswitchbetweenthescreens.Nomessageis
transmittedforthisselection.
ThemenuitemisnormallyasdefinedintheAPTRAAdvanceNDC,
SupervisorsGuide,butwiththefollowingexception:
Forcompatibilitywithpreviousreleases,function25KeyEntryon
theAccessmenuisnotreportedwhenOptionDigit0=1.Actions
intheKeyEntrysubmenuarereportedusingtheAccessmenu

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-104

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

functions6to11.Thecomponentsofeachkeyareenteredand
writtentotheencryptorasfollows:
Key

Enter Component

Write to Encryptor

06

07

08

09

10

11

Allotherfieldsareomitted.

CardholderDisplayAlarm
(Unsolicited)
9

Anunsolicitedmessageissenttoindicateastatechangeinthe
cardholderdisplaysensor.Thereportingofunsolicitedmessageis
controlledthroughEnhancedConfigurationParametercommand,
option32.Fordetails,seeOption32UnsolicitedReporting
Controlonpage 710.

Table 9-51
Cardholder Display Alarm Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphicS.

e2

DeviceStatus
Always0

e3

ErrorSeverity.Thisisasinglecharacterfieldcodedinthestandardwaytobeusedto
makeashutdowndecision.Thevaluecaneitherbe0or4.
0Noerror/notsupported.
4Fatal.

e4

Fieldnotpresent.

e5

Fieldnotpresent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-105

Terminal to Central Messages


Device Status Information

StatementPrinter
(Solicited/Unsolicited)

AsolicitedstatusmessageissenttoCentralifafaultwhichrequires
attentionoccursduringtransactionprocessing.Anunsolicited
statusmessageissentwhenastatementisdetectedinthetransport,
thestatementprintersupplies(paper,ribbon,printhead,knife,
capturebin)requireattention,oranerroronacutanddeliver
functionduringaClosestate.

Table 9-52
Statement Printer Status
Number of
Characters

Content

g1/
e1

DeviceIdentifierGraphicV.

g2/
e2

Transaction/DeviceStatus.

Field

Sol/
Unsol

Code

Description

Notransactionerrorcondition,butcheckotherfieldsforerrorseverity,
diagnosticstatusorsuppliesstatuschange.

S/U

Print/cutnotsuccessful

Devicenotconfigured

Statementpresentintransport

CardholderpressedCancelduringaprintstatementandwaitfunction.

g3/
e3

ErrorSeverity.Standardcodeusedtomakeashutdowndecision.

g4/
e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

g5/
e5

Thisfivecharacterfieldindicatesthestatusoftheprinterpaper,paperribbon,printhead,
knifeandcapturebin.
Char

Code

Description

Sufficientpaper

Paperlow

Paperexhausted

RibbonOK

Ribbonreplacementrecommended

Ribbonreplacementmandatory

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-106

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

PrintheadOK

Printheadreplacementrecommended

Printheadreplacementmandatory

KnifeOK

Knifereplacementrecommended

Knifereplacementmandatory

CapturebinOK

Capturebinoverfill.SeeTableNote102.

Table Note 101:IfmessagemodeOptionDigit3Cisset,theCancel


keyonthecardholderkeyboardisenabledduringPrintStatement
AndWaitfunctions.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.IfthecardholderpressestheCancelkey,anew
unsolicitedstatusmessageissenttoCentral.Ifthisoptionisused,
theCentralapplicationmustbechangedsothatitrecognisesthe
newstatusmessage.
Thestatementprintthatisbeingperformedwhenthecardholder
pressesCancelisunaffectedandiscompletedasnormal.
Table Note 102:Ifthestatementcapturebinreturnsastatusof
overfill,thestatementprintermustbeinitialisedusingthe
SupervisoroptionINITSTMNTfromtheReplenishMenu,once
thecapturebinhasbeenemptied.Fordetails,refertotheAPTRA
AdvanceNDC,SupervisorsGuide.

VoiceGuidance
(Unsolicited)

IfthereisaproblemwiththevoiceguidancesystemandEnhanced
Configurationoption32isset,thisunsolicitedmessagegivesthe
statusofthefollowingfeaturesofvoiceguidance:

Theaudiocard
Theenhancedaudiocontrol
Theaudiojack
ThevoiceguidanceXMLconfigurationfile.

Fordetailsofoption32,seeOption32UnsolicitedReporting
Controlonpage 710.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-107

Terminal to Central Messages


Device Status Information
Table 9-53
Voice Guidance Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphica.

e2

DeviceStatus.Indicatesthereisaproblemwiththevoiceguidancesystem.Thevalueis:

e3

e4

Var

Sol/
Unsol

Code

Description

Anerrorhasoccurred

ErrorSeverity.
Code

Description

Noerrors

Warning

Fatal

DiagnosticStatus.Thediagnosticstatusisformattedasfollows:
Byte

Code

Description

00

Audiocardisinaccessible

01

Audiocardisaccessible

00

Noaudiojackavailable

01

Theaudiosystemisinmanualmodeandthepublicstate.Allaudio
messagesareplayedthroughthespeakers.

02

Theaudiosystemisinautomaticmodeandthepublicstate.Whena
headsetisinserted,theaudiomessagesareplayedthroughtheaudio
jack;otherwiseaudiomessagesareplayedthroughthespeakers.

04

Theaudiosystemisinsemiautomaticmodeandthepublicstate.Whena
headsetisinserted,theaudiomessagesareplayedthroughtheaudio
jack;otherwiseaudiomessagesareplayedthroughthespeakers.

08

Theaudiosystemisinmanualmodeandtheprivatestate.Allaudio
messagesareplayedthroughtheaudiojackonly,whetherornota
headsetisinserted.

16

Theaudiosystemisinautomaticmodeandtheprivatestate.Whena
headsetisinserted,audiomessagesareplayedthroughtheaudiojack;
whentheheadsetisremoved,thedeviceentersthepublicstate.

32

Theaudiosystemisinsemiautomaticmodeandtheprivatestate.All
audiomessagesareplayedthroughtheaudiojack;whentheheadsetis
removed,theaudiosystemremainsintheprivatestate.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-108

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

e5

00

Noaudiojackispresent

01

Aheadsetisconnected

02

Noheadsetisconnected

00

TheXMLdefinitionfileisinaccessible

01

TheXMLdefinitionfileisaccessible

Notused.

NoteAcceptor
(Solicited/Unsolicited)

Thismessagegivesthestatusofthecashacceptororrecyclingunit
inthefollowingsituations:
9

Soliciteddevicestatusmessagesaresentinresponsetothe
followingTransactionReplycommandmessages:
RefundCashDeposit
DepositCash
DepositCashandWait
Asaresultofacashacceptororrecyclinguniterror
Wheneverthedevicecompletesanoperation,forexample,after
processinginsertednotes.Thisisalwaysreported,whetherthe
operationissuccessfulorproducesanerror.
Intheeventofanerror,forexamplewhenarefundoperation
jams,thenumberofnotesateachlocationintheBNAwill
becomeindeterminable.Inthiscase,thebestknown
representationofthecountswillbeshown.Acounterof0,
representedbyaspaceinthemessage,maybereportedfor
activenotetypeswhosecountsareunknown.
Allcounterlogsinstatusmessagesincludecategory3(suspect)
andcategory4(authenticated)notescombined.Category2
(counterfeit)notesareneverincludedexceptinECB6messages,
whichreportspecificcountsforcategory2(?)andcategory3
(@)notes.

Duringadispenseoperationwhererecyclingisenabledandthe
suppliesstatuschangesfromMediaFulltoMediaHighor
MediaHightoGoodforacassette,anunsolicitedstatus
messageissent.Notransactionnotecountsarereported.
IntheClosestateofatransactionwherenotesarestillinescrow
(becauseofacardholdertimeoutintheCashAcceptstateora
hosttimeout).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-109

Terminal to Central Messages


Device Status Information
Table 9-54
Bunch Note Acceptor Status
Field
(Subfield)

Number of
Characters

Content

g1/e1

DeviceIdentifierGraphicw.

g2/e2

Transaction/DeviceStatus;givesdetailsofacashacceptororrecycleunitoperationin
responsetoaTransactionReplycommandmessage,orasaresultofacashacceptoror
recyclinguniterror
Valuesare:

ErrorCode(e200/g200)
SeeTableNote103
Sol/
Unsol

Code

Description

Successfuloperation,butanexceptionhasoccurredornoteshavebeen
movedinthedeviceoutsideaTransactionReplyfunction.Uptodate
countsareincluded,whichwillbeintheescrownotesfield(refundable
deposits)orthevaultednotesfield(directdeposits).Inthiscase,both
countsarecumulativewithinthetransaction.SeeTableNote104

Cancel selected,RefundselectedoratimeoutoccursduringtheCash
Acceptstate.Notecountswillbeintheescrownotesfield(refundable
deposit)orthevaultednotesfield(directdeposit).SeeTableNote104

N/A

Notused

S/U

Errorifcountsareincluded,theyareasaccurateastheavailable
informationallows,exceptfornotesleftinescrowintheClosestate
whenthenotecountsareaccurate.SeeTableNote104

S/U

Deviceinoperativenotesareleftattheexitslot;countsareincluded.
Usuallythisisreturnedcountsinthew4messageasnotesareattheexit
slot.SeeTableNote104

NonotesinescrowwhentheTransactionReplyfunctionattemptsto
vaultescrowednotesorreturncash,indicatinganerroratthehost

Notesdetectedatpowerup;ifautomaticerrorrecoveryisdisabled
countsareincludedintheescrowcountsfield;ifautomaticerror
recoveryisenabledandthenotesaresuccessfullymoved,thecounts
willbeinthevaultedcountsfield.

Notesnottaken,butretracted;countsareincludedintheVaultedcounts
field.(notreportedoncashacceptorsthatdonotsupportretract
operationsorwithretractdisabled)

N/A

Notsupported

Counterfeitnoteshavebeendetected
SeeTableNote105,TableNote106andTableNote107

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-110

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information
Field
(Subfield)

Number of
Characters

Content

Suspectnoteshavebeendetected
SeeTableNote105,TableNote106andTableNote107

(g201/
e201)

50

Escrowcountsupto90foreachofthe50NDCnotetypes(1byteeach)
SeeTableNote108

(g202/
e202)

50

Vaultedcountsupto90foreachofthe50NDCnotetypes(1byteeach)
SeeTableNote108

(g203/
e203)

50

Returnedcountsupto90foreachofthe50NDCnotetypes(1byteeach)
SeeTableNote108

(g204/
e204)

Totalnumberofnotes,upto90,returnedtotheexitslot
SeeTableNote109

g205/
e205)

Totalnumberofnotes,upto90,inescrow
SeeTableNote109

(g206/
e206)

Totalnumberofnotes,upto90,justvaulted
SeeTableNote109

Whenbit1ofoption45isset,thefollowingfieldsarealsopresentfornotetypeswithmorethan90notes.Each
pairconsistsofaNoteType,andaNoteCountthevalueofwhichisaddedtothepreviousnotecounttoreport
thetotalnumberofnotesentered.
Note:Thesefieldsarerepeatedforeachnotetypewherethenumberofnotesenteredismorethan90.Ifanyof
thesefieldsispresent,allthegroupseparatorsmustbepresentevenifthereisnodataforthedatagroups.Ifall
thetotalvaluesarenotmorethan90notes,nofieldsafterg206/e206willbepresent.
(g207/
e207)

EscrowcountsforeachNDCnotetypewithmorethan90notes
SeeTableNote110
2

Notetypeasahexadecimalvalue

Notecountasadecimalvalue,addedtothepreviousnotecountforthattype,toreport
thetotalnumberofnotesentered

(g208/
e208)

VaultedcountsforeachNDCnotetypewithmorethan90notes
SeeTableNote110
2

Notetypeasahexadecimalvalue

Notecountasadecimalvalue,addedtothepreviousnotecountforthattype,toreport
thetotalnumberofnotesentered

(g209/
e209)

(g210/
e210)

ReturnedcountsforeachNDCnotetypewithmorethan90notes
SeeTableNote110
2

Notetypeasahexadecimalvalue

Notecountasadecimalvalue,addedtothepreviousnotecountforthatNDCnotetype,
toreportthetotalnumberofnotesentered

Totalnumber(decimalvalue)ofnotesreturned(movedtotheexitslot)inexcessof90
SeeTableNote111

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-111

Terminal to Central Messages


Device Status Information
Field
(Subfield)

Number of
Characters

(g211/
e211)

Totalnumber(decimalvalue)ofnotesinescrow/toptransportinexcessof90
SeeTableNote111

(g212/
e212)

Totalnumber(decimalvalue)ofnotesjustvaultedinexcessof90
SeeTableNote111

g3/e3

Var

Errorseverity,asdescribedinCashAcceptorFitness(DIGw)onpage E23

g4/e4

Var

Diagnosticstatus(MstatusplusMdata);theMstatusdescribesthemainerrorfound
SeeTableNote112andTableNote113

g5/e5

Var

Suppliesstatusofallcassettesinthedevice,asdescribedinCashAcceptorSupplies
(DIGw)onpageE16
Thestatusisreportedasfollows:

Content

Code

Description

Nochange

Goodstate

Binout(missingorremoved)

Mediahigh(nearlyfull)

Mediafull(overfull)

Table Note 103:Forfieldg2,theerrorcodeinformationisobtained


bymappingfromXFStothecorrespondingerrorcode.
Table Note 104Countsarecumulativeuptothepointthatnotesare
refunded.Thenaretractoperationwillrestartthecount.
Table Note 105:Thereportingofcounterfeitandsuspectnotescan
beconfigured.Fordetailsofthisconfiguration,refertoChapter5,
ConfiguringAdvanceNDCandAssociatedComponentsinthe
APTRAAdvanceNDC,DevelopersGuide.Ifbothcounterfeitand
suspectnotesaredetected,separateunsolicitedmessagesaresent
foreachtype.Suspectnotecountsareincludedinthenotecounts
forallstatusmessagesotherthanw?statusmessages.Counterfeit
notesareincludedonlyinw?statusmessages.
Table Note 106:Thecounterfeitandsuspectnotecountsinboththe
escrowcountsfield(refundabledeposit)andthevaultedcounts
field(directdeposit)arecumulative.Thatis,eachmessagereports
thetotalcountsintheEscrowcountsfieldforallbunchesofnotes
inserteduntileitheraTransactionRequestmessageissentornotes
arerefunded.Inmultiplebunchdeposits,amessageissentforeach
bunchdepositedevenifnomoresuspectorcounterfeitnoteshave
beenadded.ForrefundabledepositinECB6mode,theinserted

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-112

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

suspectnotes(category3)willbereportedtogetherwiththe
authenticatednotes(category4)intheEscrowcountsfields
independentlyoftheactualpossiblephysicallocationofthesuspect
notes.
Thew?andw@messagesarenotsentinthefollowingsituations:
Whenautomaticerrorrecoveryisperformedattheendofthe
transaction.
Ifnonotesofthecategoryhavebeeninsertedduringthe
transaction.

Table Note 107:Ifcounterfeitandsuspectnotesareconfigured,this


messagecanalsobeconfiguredtoincludecardholderdataafterthe
suppliesdata.Ifthisdataistobeincluded,thefieldsdescribedin
Table 955areaddedtothemessage.Fordetailsofconfiguringthis
extensiontothemessage,refertoChapter5oftheAPTRAAdvance
NDC,DevelopersGuide.
Table 9-55
Additional Cardholder Data

Field

Number of Characters

Content

FS

Fieldseparator

e600

Var(78)

Track1data

GS

Groupseparator

e601

Var(39)

Track2data

GS

Groupseparator

e602

Var(106)

Track3data

Table Note 108:EachbytecontainanASCIIvaluebetween20Hand


7AH,representingthenumberofnotesofthatdenomination;for
example,ASCIIchar!(21H)inposition2meansonenoteofNDC
notetype2.
Table Note 109:AsingleASCIIvaluebetween20Hand7AH,
representingatotalforthenumberofnoteswithinaprocessing
category;forexample,ASCIIchar!(21H)meansonenote.
Table Note 110:Agroupofzeroormoredatapairsproviding
informationfordenominationswithmorethan90notes.Only
denominationsthathavemorethan90notesareincluded;
denominationswithexactly90notesarenot.Eachdatapairconsists
ofaDenominationTypefieldandaNoteCountfield.The
DenominationTypefieldhasahexadecimalvalueintherange01to
32.TheNoteCountfieldhasadecimalvalueintherange001to999.
TheNoteCountvalueisaddedtotheequivalentprevious

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-113

Terminal to Central Messages


Device Status Information

singlebyteASCIInotecount.Thesumofthepreviousfieldandthe
currentfieldprovidesthetotalnumberofnotes.
Table Note 111:Thedecimalvalue(001to999)tobeaddedtothe
equivalentprevioussinglebyteASCIInotecount.Thesumofthe
previousfieldandthisvalueprovidesthetotalnumberofnotes.If
anyoffieldse210/g210toe212/g212arepresent,allmustbe
present.
Table Note 112:Whenaw6message(notesdetectedatstartofday)
oraw3message(deviceerror)issent,andtheplatformhasnot
providedanMStatusvalue,anappropriatefixednonzero
MStatusvaluewillbeincludedinthemessage.
Table Note 113Nativediagnosticsdataisreportedifavailable
(alwaysavailableonNCRSSTs)otherwiseXFSvaluesaremapped
toGBRUMStatusvalues.

EnvelopeDispenser
(Unsolicited)

Theenvelopedispenserreportsunsolicitedstatusmessages
dependingonthevalueofEnhancedConfigurationParameter
option23(seepage 1017).Statusmessagesaresentwhenthe
envelopedispenserisdetectedasbeinglow/outoranenvelope
failedtobepresentedorretracted.
Remotestatusindicatorsandtheremoterelayareoptionallysetand
enableddependingonthevalueofoption23.Solicitedstatus
messagesareneversentfortheenvelopedispenser,regardlessof
thevalueofoption23.
Messagesdetailingfitness,configurationandsuppliesinformation
aresenttothehostinresponsetothesendconfigurationdata
terminalcommand.

Table 9-56
Envelope Dispenser Status
Field

Number of
Characters

Content

e1

DeviceIdentifierGraphic\.

e2

DeviceStatus.Indicateswhetherthelastoperationwassuccessful.

e3

Sol/
Unsol

Code

Description

Envelopepresentedsatisfactorily.

Failureenvelopenotpresentedorretracted.

ErrorSeverity.Standardcode.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-114

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

e4

Var

DiagnosticStatus(MstatusplusMdata).TheMstatusdescribesthemainerrorfound.

e5

SuppliesStatus.Indicatesthereplenishmentstatusofthebincontainingenvelopestobe
dispensed.
Code

Description

Sufficientenvelopes.

Envelopeslow.

Envelopesexhausted.

ChequeProcessor
(Solicited/Unsolicited)

Thismessagegivesdetailsofpossiblechequeprocessorresponsesto
aTransactionReplycommand,someofwhichcanbecontrolledby
EnhancedConfigurationoption83.Fordetails,seedescribedon
Option83ChequeProcessoronpage 719.
IfaTransactionReplycommandcontainsoneofthecheque
processorfunctionvaluesandtheSSTdoesnothaveacheque
processorconfigured,asolicitederrormessageisreturned.

Table 9-57
Cheque Processor Status
Field

Number of
Characters

Content

g1

DeviceIdentifierGraphicq.

g2

Var(2)

Transaction/DeviceStatus.Givesdetailsofachequeprocessoroperationinresponsetoa
TransactionReplyCommandmessage.Thevaluesare:
ErrorCode(e200/g200).SeeTableNote114.
Sol/
Unsol

Code

Description

Successfuloperation,butanexceptionhasoccurred.

S/U

Cancelselected/Timeoutoccursduringprocessing(entry/retrieval)of
cheque,duetooneofthefollowing:
Cardholderdidnotinsertacheque
Cardholderinsertedchequewhichwasnotsuccessfullyaccepted,but
retrievedbycardholder
CardholderselectedCancelkeyinsteadofinsertingcheque.
Whenoption83bit0andbit1aresettozero,thiscodealsoreports
retracts.

S/U

Chequeprocessorfailure.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-115

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

Chequedetectedatpowerup.

S/U

Error,noaccess(erroronbin).

S/U

Chequejam.

Chequejam,noaccess.

Whenoption83bit0orbit1issettoone,thefollowingcodemayalsobereturned:
S/U

Chequeretractedandcaptured.

ErrorPosition(e201/g201)

(space)

Code

Description

Nonhardwarestatusreported,orerrorpositionnotknown(severityisGood,
SuspendorFatal).

Chequeentry/reentryerror(SuspendorFatal).
Onabunchchequeacceptor,thisisreportedafteranerrorhasoccurredwhile
insertingchequesorwhenanerroroccurswhileretractingcheques

Imageliftingerror(SuspendorFatal).
Onabunchchequeacceptor,thisisnotreported

Ejecterror(SuspendorFatal).
Onabunchchequeacceptor,thisisreportedafteranerrorwhenallchequesare
returnedtothecardholder

Captureerror(SuspendorFatal).
Onabunchchequeacceptor,thisisreportedafteranerrorwhenallchequesare
captured

Endorseerror(SuspendorFatal).
Onabunchchequeacceptor,thisisreportedwhenanerrorisdetectedwiththe
endorserbeforechequesaremovedfromthestackeroranyitemshavebeen
endorsed.Allchequesarewaitingtobeprocessed

Powerfailerror,lastchequeendorsed(Errorcode3,Suspendonly).
Onabunchchequeacceptor,thisisnotreported

Powerfailerror,lastchequenotendorsed(ErrorCode3,Suspendonly).
Onabunchchequeacceptor,ifapowerfailerroroccurs,somechequesmay
havebeenendorsed,butsomemaynot

Whenoption83bit1issettoone,thefollowingadditionaldataisreturnedtoindicatethe
locationofthemedia
SeeTableNote115
1

GS

GroupSeparator
SeeTableNote116andTableNote117

ChequeID.Thethreedigitdecimalnumberassignedtoeachchequeintherange000999

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-116

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

g3/
e3

Number of
Characters

Content

ChequeLocation
Value

Description

01

Thechequeisinsidethedevice,butnotinabin

02

Thechequeisinabin.ThebinisidentifiedintheBinNumberfield

03

Thechequehasbeenreturnedtothecardholder

04

Thelocationofthechequeisunknown

BinNumber.Atwodigitdecimalvaluecontainingthenumberofthebininwhichthe
chequehasbeendeposited
Ifthechequeisnotinabin,thisis00

Var

ErrorSeverity.
Whenoption83bit0andbit1aresettozero,asinglecharacterisreturned,which
representstheoverallerrorseverityofthedevice.
Char

Description

Overallchequeprocessor

Whenoption83bit0orbit1issettoone,thefollowingisreturned:
Char

Description

Overallchequeprocessor

Endorseprinter

Stamper

Reserved

Reserved

Bin1

Bin2

Bin3

Binn

Thenumberofbinsreporteddependsonhardwareconfiguration
Eachcharactercantakeoneofthefollowingvalues:
Value

Description

Noerror/Notconfigured

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-117

Terminal to Central Messages


Device Status Information

Field

g4/
e4

Number of
Characters

Var

Content

Routine

Warning

Suspend

Fatal

DiagnosticStatus.
Whenoption83bit0andbit1aresettozero,thisfieldcontainszeroesandis14bytes
long.
Whenoption83bit0orbit1issettoone,thisfieldisvariablelengthandcontainsthe
chequeprocessordiagnosticinformation.

g5/
e5

Var

SuppliesStatus.
Whenoption83bit0andbit1aresettozero,thisfieldcontainszeroesandis4byteslong.
Whenoption83bit0orbit1issettoone,thefollowingisreturned:

Endorseprinter

Stamper

Reserved

Reserved

Bin1

Bin2

Binn
SuppliesStatusValues
Value

Description

Notconfigured/Reserved

Goodstate

Medialow

Mediaout

Overfill

Mediahigh(almostfull)

Table Note 114:Forfieldg2,theerrorcodeinformationisobtained


bymappingthereceivedActiveXeventtoitscorrespondingerror
code.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-118

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Table Note 115:Ifanerroroccurs,itisnotalwayspossibleto


accuratelyreportthelocationofacheque.
Table Note 116:Wheninformationonchequelocationisreported,
eachchequeisreportedwithinagroupseparatedbyagroup
separator.Allfieldsmustbepresentforeachchequethathasa
chequeID,includinganychequesthatthecardholderrequestedfor
return.Eachchequedatagroupisprecededbyagroupseparator.
Nogroupseparatorfollowsthefinalchequetobereported,andif
nochequesarereported,nogroupseparatorispresent.
Table Note 117:Whentheunsolicitedmessageisgeneratedbeforea
transactionrequesthasbeensenttoCentral,noinformationonthe
cardholderorthechequesisavailabletoCentral.However,alllocal
dataisjournalled.

CoinDispenser
(Solicited/Unsolicited)

ThismessagegivesdetailsofaCoinDispenserresponsetoa
TransactionReplyCommandmessage.Unsolicitedmessages
alwayshaveadevicestatusof0.
Whenoption79issetto000,thismessagereportsthestatusoffour
hoppertypes.Whenoption79issetto001,thismessagereports
thestatusofthenumberofhoppertypesreportedintheHardware
Configurationmessage.Thestatusisalwaysreportedfora
minimumoffourhoppertypes.Fordetailsofoption79,seeOption
79CoinDispenseronpage 719.

Table 9-58
Coin Dispenser Status
Number of
Characters

Content

g1/
e1

DeviceIdentifierGraphicY.

g2/
e2

1
SeeTable
Note118

Transaction/DeviceStatus.Givesdetailsofacoindispenseoperationinresponsetoa
TransactionReplyCommandmessage.Thevaluesare:

SeeTable
Note119

Sol/
Unsol

Code

Description

S/U

Successfuloperation,butanexceptionhasoccurred,describedinthe
DiagnosticStatusfield.

Thecoindispenserlowthresholdsforeachcoinhopperwerenotset
duringtheconfigurationoftheSST.Nocoinshavebeendispensed.

Field

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-119

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

Thecoindispensehasnotstartedastherequestedhopperis:
inafatalstate

outofcoins

notinthecorrectpositiontoallowadispense

inalowconditionwithoutenoughcoinstoperformthedispense.
Nocoinshavebeendispensed.

g3/
e3

Thecoindispensehasfailedforareasonotherthanajam.Somecoins
mayhavebeendispensed.

Thecoindispensehasfailedduetoajaminthehopper.Somecoins
mayhavebeendispensed.

Thecoindispensehasfailedduetoajaminthetransportchute.Some
coinsmayhavebeendispensed.

Thetransportchuteexitsensorwasblockedatthestartofthecoin
dispense.Nocoinshavebeendispensed.

<

Acoindispensehasbeenattemptedwhilethecoindispenserisina
fatalstate.Nocoinshavebeendispensed.

Tamperingdetectedduringdispense.Thecoindispensehasfailed
duetothemodulebeingaccessedduringthedispense.Somecoins
mayhavebeendispensed.

Var

CoinsDispensed

SeeTable
Note120

Char

Description

23

Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype1

45

Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype2

67

Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype3

89

Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype4

1011

Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype5

<n>(<n
>+1)

Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype
<n>

Var

ErrorSeverity.Usedtomakeashutdowndecision.Holdstheseverityinformationforthe
coindispenserandthesubdeviceelements(coinhoppers1to<n>).
Char

Description

Coindispensercorecomponents

Coinhoppertype1

Coinhoppertype2

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-120

APTRA Advance NDC, Reference Manual

Terminal to Central Messages


Device Status Information

Field

Number of
Characters

Content

Coinhoppertype3

Coinhoppertype4

Coinhoppertype5

<n>

Coinhoppertype<n>

Eachcharactercantakeoneofthefollowingvalues:
Value

Description

Noerror

Routine

Warning

Suspend.Thisisonlyusedforthecoindispensercorecomponentscharacter

Fatal

g4/
e4

Var(14)

DiagnosticStatus.Maintenancedatareportedbythecoindispenser.

g5/
e5

Var(4)

SuppliesStatus.Holdsthereplenishableconditionforthecoindispenserandthe
subdeviceelements.Seefieldg3/e3(ErrorSeverity)fortheorderofreportingonthecoin
dispenserandthesubdeviceelements.
Value

Description

Statenotdeterminedduringthisoperation

Good

HopperLow.Thesensorassociatedwiththishopperhasindicatedalow
condition.

HopperEmpty.Thesensorassociatedwiththishopperhasindicatedlowand
thecoinlowthresholdlimithasbeenreached.

Table Note 118:Forfieldg2,theerrorcodeinformationisobtained


bymappingthereceivedActiveXFSeventtoitscorrespondingerror
code.
Table Note 119:Unsolicitedmessagesalwayshaveadevicestatusof
0.
Table Note 120:Thisinformationcanbeusedtofacilitatea
transactionreversalorcorrectionifrequired.Theinformationrefers
tocoinsthathaveleftthehopper,butnotnecessarilyreachedthe
cardholder.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

9-121

Terminal to Central Messages


Device Status Information

BarcodeReader
(Unsolicited)

Thismessagegivesdetailsofthebarcodereaderresponsetoa
TransactionReplycommandmessage.Unsoliciteddevicestatus
messagesaresentonlyifoption48issetto1.Formoreinformation,
seeOption48BarcodeReaderonpage 716.

Table 9-59
Barcode Reader Status
Number of
Characters

Content

e1/
g1

DeviceIdentifierGraphicf

e2/
g2

DeviceTransactionStatus
ErrorCode(e200/g200)

Field

e3/
g3

e4/
g4

e5/
g5

Sol/
Unsol

Code

Description

Goodoperationbutsomeexceptionhasoccurredasdetailedinthe
accompanyingdata.

Barcodereaderisinoperative.

FieldSeparator

OverallBarcodeReaderErrorSeverity
Code

Description

Noerror/Notconfigured

Routine

Warning

Suspend

Fatal

FieldSeparator

Var

Diagnosticstatus
Barcodereaderdiagnosticinformation

FieldSeparator

SuppliesStatus

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

9-122

APTRA Advance NDC, Reference Manual

Table of Contents
Central to Terminal Messages

Chapter 10

CentraltoTerminalMessages
Overview
EMVMessageClassSupport
UnsupportedCommands
UnsupportedTerminalCommands
UnsupportedCustomisationDataCommands

101
101
101
101
101

TerminalCommands

102

CustomisationDataCommands

106

StateTablesLoad

108

Screen/KeyboardDataLoad
ManagingKeyboardsandAssociations

1010
1012

ConfigurationParametersLoad

1014

EnhancedConfigurationParametersLoad

1016

FITDataLoad

1021

ConfigurationIDNumberLoad

1023

MessageAuthenticationFieldSelectionLoad

1025

DateandTimeLoad

1032

EncryptionKeyChange

1033

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Central to Terminal Messages

ExtendedEncryptionKeyChange

1036

DispenserCurrencyCassetteMappingTable

1043

XMLConfigurationDownload

1046

TransactionReplyCommand
TerminalFunctionsforTransactionCompletion

1049
1062

InteractiveTransactionResponse

1077

EJCommands
EJOptionsandTimers
AcknowledgeEJUploadBlock
AcknowledgeandStopEJ
ContinuousandBatchUploadMethods

1081
1081
1082
1083
1084

MessageValidation
ValidMessageClasses
SSTtoCentral
CentraltoSST
CommandRejectCauses
OtherInvalidParameters
Exits

1086
1086
1086
1086
1086
1093
1093

MessagesReceivedinWrongOperationalMode
CustomisationDataCommands
TransactionReplyCommand
TerminalCommands

1094
1094
1095
1096

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Overview
J

Overview

10

ThischapterdescribesCentraltoterminalmessages,underthe
followingtopics:

TerminalCommands
CustomisationDataCommands
TransactionReplyCommand
InteractiveTransactionResponse
EJCommands
MessageExceptionHandling
MessagesReceivedinWrongOperationalMode.

Note:ForanydifferencesonothervendorsSSTs,refertothe
APTRAAdvanceNDC,MultiVendorSupportReferenceManual.

EMVMessageClass
Support
UnsupportedCommands

10

10

Messageclass8issupportedbyEMV/CAM2ExitsforAPTRA
AdvanceNDC.Fordetails,refertotheEMVIntegratedCircuitCard
(ICC)ReferenceManual.
CommandsthatarenotsupportedinAdvanceNDCaremarkedas
Reservedinthemessageformats,exceptforsendtalliesandsend
errorlogs,asdefaultmessagesarereturnedifthesecommandsare
sent.

UnsupportedTerminalCommands

Sendtallyinformation(commandcode5)
Senderrorloginformation(commandcode6)
RetrieveandsendhallmarkkeyfromEKC(commandcode=)
EnableFREEJDATA(commandcode>)
Enableimagedumpinginformation(commandcode?).

UnsupportedCustomisationDataCommands

10

10

InitialiseEKC(identifierF)
Overridereservedscreens(identifierG)
Screen/KeyboardData:NestedKeyboardData(fieldj3)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-1

Central to Terminal Messages


Terminal Commands

TerminalCommands
ThesecommandsaresentbyCentraltostartuporshutdownthe
terminal,ortorequestconfiguration,counter,ordateandtime
information.
Table 10-1
Terminal Commands
Field

Number of
Characters

Mandatory/
Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
1TerminalCommand.

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredbythe
terminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredbythe
terminal.

FS

FieldSeparator.

CommandCode.OnecharacterfieldusedtoidentifythetypeofTerminal
Command.Thecodesthatcanbeusedinthisfieldare:
Code

Description

Goinservice(startup).
TheStartUpcommandisusedtoplacetheterminalInService
afterapowerupandCustomisationDataload.Theterminal
sendsaReadystatusinresponsetoastartupcommandwhen
theterminalenterstheInServicemode.Ifastartup
commandisreceivedwhiletheterminalisInService,butnot
inState000,theterminalsendsaReadystatuswhenitenters
State000.Thestartupcommandcanalsoputtheterminalinto
serviceafterashutdown,exitfromSupervisormodeor
Suspend.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-2

APTRA Advance NDC, Reference Manual

10

Central to Terminal Messages


Terminal Commands

Field

Number of
Characters

Mandatory/
Optional

Description

Gooutofservice(shutdown).
TheShutDowncommandplacestheterminaltemporarily
OutofService.Allpendingmessagesaresentandcurrent
transactionscompletedbeforetheterminalexecutesthe
shutdown.Theterminalthenindicatesthatithassuccessfully
completedtheshutdownprocedurebysendingaReady
statusinaSolicitedStatusmessage.

SendconfigurationID.
TheSendConfigurationIDcommandaskstheterminalto
sendtheConfigIDnumbertoCentral.

Sendsupplycounters.
TheSendSupplyCounterscommandaskstheterminalto
sendthestateofthesupplycounterstoCentralintheformat
identifiedbytheCommandModifierfieldg,asfollows:
Sendbasicsupplycountersmessage
Sendextendedsupplycountersmessage

Sendtallyinformation.Notsupported;defaultmessagereturned.

Senderrorloginformation.Notsupported;defaultmessage
returned.

Sendconfigurationinformation.
TheSendConfigurationInformationcommandasksthe
terminaltosendthefollowingconfigurationinformationdata,
identifiedbytheCommandModifierfieldg,toCentral:
HardwareConfiguration*
SuppliesStatus*
HardwareFitness*
SensorStatus
SoftwareIDandreleasenumber
LocalConfigurationOptionDigits
NoteDefinitions(BNA)
*Thesecategoriesreturninformationforasubsetofpossible
devices.

Senddateandtimeinformation.
TheSendDateandTimeInformationcommandasksthe
terminaltosendthelocallyhelddateandtimetoCentral.

Reserved.

Reserved.

Reserved.

Reserved.

<

Reserved.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-3

Central to Terminal Messages


Terminal Commands

Field

Number of
Characters

Mandatory/
Optional

Description

>

Reserved.

Reserved.

Disconnect.
Fordetails,seeChapter 13,CCMVISA2DialupSystem.

Maintainconnectiontocompletetransaction(NoOp).
Fordetails,seeChapter 13,CCMVISA2DialupSystem.

CommandModifier.ThisfieldcanoptionallybeusedwhentheCommand
Codeis2or4andmustbepresentwhentheCommandCodeis5,6or7.
Code

Go out-of-service (Command Code = 2)

StandardOutofServicescreendisplayed

TemporaryOutofServicescreendisplayed
Defaultstozeroif:
Anyvalueotherthanzerooroneissent
Thefieldisempty

Code

Send Supply Counters message (Command Code = 4)

none

Sendbasicsupplycountersmessage

Sendbasicsupplycountersmessage

Sendextendedsupplycountersmessage

Code

Tally (Command Code = 5) not supported

Code

Error Log (Command Code = 6) not supported

Code

Configuration Information (Command Code = 7)

none

Sendconfigurationinformation(includedforcompatibility
withearlierreleases)

Sendhardwareconfigurationdataonly

Sendsuppliesdataonly

Sendfitnessdataonly

Sendtamperandsensorstatusdataonly

SendsoftwareIDandreleasenumberdataonly

Sendenhancedconfigurationdata

Sendlocalconfigurationoptiondigits

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-4

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Terminal Commands

Field

Number of
Characters

Mandatory/
Optional

Description

Sendcashitemdefinitions(BNA)

Ifthecommandmodifierisnotwithintherange18,themessagewill
berejected.Ifthespecificcommandrejectoptionisset,aSpecific
CommandRejectwillbereturned.
h

Var

Trailer.Protocoldependent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-5

Central to Terminal Messages


Customisation Data Commands

CustomisationDataCommands

10

CentralcanusevariousCustomisationDatacommandsto
downloaddifferenttypesofdatatotheterminal.Thecommandsare
asfollows:
StateTablesLoad
Screen/KeyboardDataLoad
ConfigurationParametersLoad
EnhancedConfigurationParametersLoad
FITDataLoad
ConfigurationIDNumberLoad
MACFieldSelectionLoad
DateandTimeLoad
EncryptionKeyChange
ExtendedEncryptionKeyChange
DispenserCurrencyCassetteMappingTable
XMLConfigurationDownload

Thefollowingtableshowsthemessageclass,subclassand
identifierforeachcommand.
Table 10-2
Customisation Data Commands

Message
Class

Message
Sub-Class

Identifier

Command

Screen/KeyboardDataLoad

StateTablesLoad

ConfigurationParametersLoad

Reserved

FITDataLoad

ConfigurationIDNumberLoad

EnhancedConfigurationParameters
Load

MACFieldSelectionLoad

DateandTimeLoad

Reserved

DispenserCurrencyCassette
MappingTable

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-6

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Customisation Data Commands
Message
Class

Message
Sub-Class

Identifier

Command

Reserved

XMLConfigurationDownload

09

InteractiveTransactionResponse

19

EncryptionKeyChange

19,
AK

ExtendedEncryptionKeyChange

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-7

Central to Terminal Messages


State Tables Load

StateTablesLoad
Usethismessagetodownloadstatetablestotheterminal.Itmay
takemorethanonemessagetotransmitthestatetables,inwhich
caseeachmessagewillcontainaportionofthestatetables.For
detailsofthestatetables,seeChapter 2,StateTables.
Table 10-3
State Tables Load
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
2StateTable

FS

FieldSeparator.

StateNumber.Containsabase10(decimal)numberintherange000
254or256999,orabase36(alphanumeric)numberintherange
000254or256ZZZ.Thisidentifiesthestatenumberforthestatedata
whichfollowsit.SeeTableNote2.

Var(25)

StateTableData.Thefirstcharacteridentifiesthestatetype.Valid
valuesare:A,B,C,D,E,F,G,H,I,J,K,L,M,N,O,R,S,T,V,W,X,
Y,Z,b,d,e,f,g,k,m,w,_,&,>.
Characters2to25giveassociatedstatedata.

FS

FieldSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-8

APTRA Advance NDC, Reference Manual

10

Central to Terminal Messages


State Tables Load

Field

Number of
Characters

Mandatory/ Optional

Description

StateNumber.

Var(25)

StateTableData.

:
Thefieldseparator,statenumberandstatedatafieldsmayberepeatedifnecessarytothemaximum
lengthpermessagepermittedbytheprotocol.
:
FS

SeeTableNote1.

FieldSeparator.

SeeTableNote1.

MessageAuthenticationCode(MAC)Data.Containsthevalue
transmittedforauthenticationofthismessage.

Var

Trailer.Protocoldependent.

TableNote1:Thefieldseparatorandfieldjareonlyusedwhen
theDataSecurityfeatureisselectedandtheflagsarecorrect.For
details,seetheAPTRAAdvanceNDC,SupervisorsGuide.
TableNote2:EnhancedConfigurationParametersLoadoption80
withtherequiredsettingfortheAlphanumericStateEntrystate
mustbesentbeforetheStateTablesLoadmessage.Ifitisnotsent,
thedefaultvalueofbase10isassumed.SeeEnhanced
ConfigurationParametersLoadonpage 1016.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-9

Central to Terminal Messages


Screen/Keyboard Data Load

Screen/KeyboardDataLoad

10

Thismessageisusedtodownloadscreenand/orkeyboarddatainto
theterminal.ThemaximumlengthofasingleScreen/Keyboard
DataLoadmessageis2000bytes.
Table 10-4
Screen/keyboard Data Load
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.ProtocolDependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
1Screenand/orKeyboardData

FS

FieldSeparator.

3,5or6

SeeTableNote3
TableNote4

ScreenNumber.Identifiesthescreendatabeingtransmitted.For
details,seeChapter 3,ScreenData.
Screennumberscanbespecifiedasthreedecimaldigits(123),four
decimaldigitsindoublequotes(0123),agroupletterandtwodigits
oragroupletterandfourdigits.Thegroupswithfourdigitnumbers
areE,X,Y,Zandu.Ascreendefinedingrouplisalso
accepted,mappingdirectlyontogroupu(l0123isequivalentto
u0123).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-10

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Screen/Keyboard Data Load

Field

Number of
Characters

Mandatory/Optional

Description

Note: Thenumberingforerrormessagereservedscreensconsistsof
analphacharacterfollowedbyfournumericdigits.Thenumberingfor
allotherreservedscreensconsistsofanalphacharacterfollowedby
twonumericdigits.
i

Var

SeeTableNote3

ScreenDataField.Representsthedatatobedisplayedonthe
cardholderscreenorprinter.Thisfieldalwaysfollowsascreen
numberfieldandisalwaysfollowedbyafieldseparatoror
protocoldependenttrailer.Fordetails,seeChapter 3,ScreenData.

GS

SeeTableNote3

GroupSeparator

j1

Var

SeeTableNote5

KeyboardNumberandKeyboardData.Identifiesthephysical
keyboarddatabeingtransmitted.Itmusthaveaminimumofthree
charactersintherange000999thatareusedtospecifythekeyboard
numbertobeprocessed.Theremainingcharactersmakeupavariable
lengthdatafieldthatdefinesthekeyboardlayout.
Thisdataismadeupofsetsoffourcharacters,twofortheposition
codeandtwoforthereturncode.Fordetails,seeTheKeyboard
Interfaceonpage 42.

GS

SeeTableNote5

GroupSeparator

j2

Var

SeeTableNote5

TouchScreenData.Identifiesthetouchscreenkeyboarddatabeing
transmitted.Thecharactersmakeupavariablelengthdatafieldthat
definesthekeyboardlayout.Thisdataismadeupofsetsof34
characters,32fordefiningthetouchareaplustwoforthereturncode.
Fordetails,seeRearInterface:OperatorKeyboardLayouton
page 414.
Ifyoucreatenewdefinitions,youcancalculatethecoordinatesofthe
touchareamanuallyFordetails,seeCalculatingFullTouchScreen
Positionsonpage 417.

GS

SeeTableNote5

GroupSeparator

j3

SeeTableNote5

NestedKeyboardData(notsupportedbyAdvanceNDC).

GS

SeeTableNote5

GroupSeparator

j4

Var

SeeTableNote5

MiscellaneousKeyboardDataThisfieldisreservedforfuture
expansion.

Var

Trailer.Protocoldependent.

TableNote3:Screendataand/orkeyboarddatamaybe
downloadedinamessage.Ifanypartoffieldj1j4ispresent,the
screendatafieldmustbeterminatedbyagroupseparatorto
indicatethestartofkeyboarddata.
TableNote4:Fieldshj4mayberepeatedanynumberoftimes,
asdefinedbythecommunicationsprotocollimitbutnotexceeding
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-11

Central to Terminal Messages


Screen/Keyboard Data Load

themaximummessagelengthof2000bytesforScreen/Keyboard
data.Thefieldseparatorprecedingfieldhmustberepeatedfor
eachadditionalscreenand/orkeyboarddefinition.
TableNote5:Ifkeyboarddataistobedownloaded,itmustbe
separatedfromthescreendatafieldbyagroupseparatoreven
whennoscreendataispresentinthemessage.
Eachfieldofkeyboarddatamustbeterminatedbytheassociated
groupseparator,evenwhenthatfieldisempty.Theonlyexception
tothisisthattrailinggroupseparatorsmaybeomittedafterthelast
keyboardfieldthatcontainsactualdata.Thisrulemeansthatthe
keyboarddatatypecanbeidentifiedbythenumberofgroup
separatorsprecedingit.

ManagingKeyboardsand
Associations

10

Itispossibletoadd,deleteandchangekeyboardlayoutsand
associationsbetweenscreensandlayouts.Thefollowinglistgives
examplesofhowthisisdone.
a

Toaddorupdateakeyboarddefinitionalone:
<gs>
<keyboard no.> <keyboard data>
<gs>
<touch data>

Todeleteakeyboardandanyassociationstoit:
<gs>
<keyboard no.>

Toreplaceexistingscreenswithoutchanginganyassociations:
<screen no.> <screen data>
<fs>
<screen no.> <screen data>

Todeletescreensandanyassociationswiththem:
<screen no.>
<fs>
<screen no.>

Todeleteascreenanddeleteakeyboardlayout,destroyingany
otherassociationstothatlayout:
<screen no.>
<fs>
<keyboard no.>

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-12

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Screen/Keyboard Data Load

Tosendanewscreenanditsassociatedkeyboarddetailsinone
message:
<screen no> <screen data>
<gs>
<keyboard no.> <keyboard data>
<gs>
<touch data>

Tosendanewscreenandspecifyanassociatedkeyboardthat
willbeprovidedelsewhere:
<screen no.> <screen data>
<gs>
<keyboard no.>

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-13

Central to Terminal Messages


Configuration Parameters Load

ConfigurationParametersLoad
ThismessagedownloadstheLogicalUnitNumber(LUNO),
parametersandtimersintotheterminal.Fordetailsofthe
parametersseeConfigurationParametersLoadMessageon
page 72.Fordescriptionsofthetimers,seeTimersonpage 722.
Thismessagedoesnotenabletheconfigurationofadditional
optionsavailablewithAdvanceNDC,forwhichyouusethe
EnhancedConfigurationParametersLoadmessagedescribedon
page 1016.
Table 10-5
Configuration Parameters Load
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredbythe
terminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
3ConfigurationData

FS

FieldSeparator.

SeeTableNote6

CameraControl

SeeTableNote6

Reserved

SeeTableNote6

Reserved

SeeTableNote6

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-14

APTRA Advance NDC, Reference Manual

10

Central to Terminal Messages


Configuration Parameters Load

Field

Number of
Characters

Mandatory/Optional

Description

SeeTableNote6

Reserved

O
SeeTableNote6

SupplyMode,ReadyStatusandAmountBufferLengthOptions.
(Fordetails,seepage 72)

O
SeeTableNote6

Reserved.Mustbe000000000.

FS

SeeTableNote7

FieldSeparator.

LUNO.LogicalUnitNumbertoreturnintransactionrequests,and
solicitedstatusandunsolicitedstatusmessagessentbytheterminal.(For
details,seepage 73)

FS

SeeTableNote7

FieldSeparator.Mustbepresentifthefollowingfieldsarepresent.

O
SeeTableNote8

TimerNumber.
(Foralistoftimers,seepage 73;fordetaileddescriptions,seepage 719)

Numberof800MillisecondTicksperTimerField.
(Fordetails,seepage 74)

:
Thetimernumberandticksarerepeated.Thedataforeachtimerisdownloadedinthissequence:timer
number(2bytes),numberof800millisecondticks(3bytes)unlessstatedotherwiseinthetableabove.If
aparticulartimerisnotincluded,adefaultvalueisassumed.
:
r

Var

Trailer.Protocoldependent.

TableNote6:Fieldshtonmaybeomittedunlessfieldmis
populatedwhenalltheearlierfieldsmustbepopulated.The
omittedfieldsassumeavalueofzero.
TableNote7:Thisfieldseparatormustbepresentifanyofthelater
fieldsinthemessagearepresent.
TableNote8:Unlessotherwisestatedinthetimerdescriptions(see
page 722)atimeoutintervalof000istakenasinfinity,andan
unconfiguredtimertakesatimeoutintervalof30ticks.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-15

Central to Terminal Messages


Enhanced Configuration Parameters Load

EnhancedConfigurationParameters
Load

10

Thismessagesupportsconfigurationofoptionsandtimers,
includingadditionaloptionsthatarenotsupportedinthe
ConfigurationParametersLoadmessage.Formoredetailsofthe
format,seeEnhancedConfigurationParametersLoadMessageon
page 76
ThismessagedoesnotincludeoptionsandtimersfortheElectronic
Journal(EJ)Uploadfeature;thesearesetintheEJOptionsand
Timerscommand.Fordetails,seeEJCommandsonpage 1081.
Table 10-6
Enhanced Configuration Parameters Load
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredbythe
terminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
AEnhancedConfigurationData

FS

FieldSeparator.

LogicalUnitNumber.AsfieldoofConfigurationParametersLoad;
(fordetailsseepage 73)

FS

SeeTableNote9

FieldSeparator.Mustbepresentifanyofthefollowingfieldsare
present.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-16

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Enhanced Configuration Parameters Load

Field

Number of
Characters

i
j

Mandatory/Optional

Description

O
SeeTableNote11

OptionNumber.Containsaconfigurationoptionnumber,forwhich
thevaluesareheldinfieldj.

O
SeeTableNote11

OptionCode.Specifiestheconfigurationforthefunction(option
number)infieldi.Optionnumbersareasfollows.Fordetailsofthe
optioncodesforeachoption,seeEnhancedConfigurationParameters
LoadMessageonpage 76.
Option
Number

Description of Option

00

Cameracontroloption:asfieldhin
ConfigurationParametersLoad;(fordetails,seepage 71)

01

Ready/Supply/Amountbufferoptions:asfieldmin
ConfigurationParametersLoad;(fordetails,seepage 72)

02

Autovoice

03

DateformatforSupervisorjournalmessages

04

Rollwidth

05

Leftprintcolumn.

06

Reserved

07

Track1format

0811

Reserved

12

Specificcommandrejectoption

1314

Reserved

15

Transactionstatusinformationoption

16

Journalprinterbackuptimeoption

17

Journalprinterbackupprintoperationsoption

1822

Reserved

23

Envelopedispenserstatusoption.

24

EnhancedTI/Sensorstatusoption.

25

Mediaentry/exitindicatorsflashrateoption.

26

Reserved

27

Remoterelay

2831

Reserved

32

UnsolicitedReportingControlforcameraandvoiceguidance

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-17

Central to Terminal Messages


Enhanced Configuration Parameters Load

Field

Number of
Characters

Mandatory/Optional

SeeTableNote10

SeeTableNote12

Description

33

SimulateSupervisorModeentry/exit

34

MCNrange

35

ReportDualModeEJandHardcopyBackupUnsolicited
Messages

36

EnhancedEJbackup

37

PrintTrack2toJournal

3843

Reserved

44

BunchNoteAcceptor(BNA)JournalVaultedNotesCount

45

BunchNoteAcceptor(BNA)MessageSettings

46

MCRWEnhancedCardDevice(ECD)SecurityJitter

47

Reserved

48

Barcodereader

4968

Reserved

69

EMVSmartCardExtendedStatus:reservedforusewith
EMV/CAM2Exits.

70

EMVSmartCard:reserved.

71

TimeOutStateentry

74

CashDepositRetractDestination

76

CashHandlers

77

Nextstatenumber

78

GBRUvariantreporting

79

CoinDispenser

80

AlphanumericStateEntry

83

ChequeProcessingModule

FS

SeeTableNote9

FieldSeparator.

O
SeeTableNote11

TimerNumber.Containsthetimernumber.Theuseofthetimersisas
follows.Timerswithanasterisk(*)canbeadjustedforavoiceguided
session.Formoreinformation,seeTimersonpage 722.
00*

Keyboardentrytimeout

01*

Cardholderresponsetotimeoutscreentimeout

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-18

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Enhanced Configuration Parameters Load

Field

Number of
Characters

Mandatory/Optional

Description

02

Closestatescreentimeout

03

Communicationsresponsetimeout

04*

Envelope/chequeinsertiontimeout

05*

Cashretracttimeout

06

Poll/selecttimeout

07*

Presenttimeout

08*

Nightsafedeposittimeout

09*

Cardremovaltimeout

10

Additionalpresenttimeout

11
59

Reserved

60

EJacknowledgementtimer

61*

Barcodereaderscantimeout

62

Reserved

63

Hardwarefailurescreentimeout

64
67

Reserved

68

StatementMEIdurationtimeout

69

ReceiptMEIdurationtimeout

70
71

Reserved

72

DASHcardremovaltimeout

73
76

Reserved

77*

BNAcashacceptancetimeout

78*

GBXXcashretracttimeout

79
86

Reserved

87*

Chequecapturescreentimeout

88
91

Reserved

92

Faultdisplaytimeout

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-19

Central to Terminal Messages


Enhanced Configuration Parameters Load

Field

Number of
Characters

Mandatory/Optional

Description

93

Reserved

94*

Chequeremovaltimeout

95*

Statementretracttimeout

96*

Statementpresenttimeout

97
99

Reserved.

O
SeeTableNote11

CustomisationDataCommandsNumberofSecondsperTimerField.
Specifiesthetimeoutintervalfortheprecedingtimerinseconds.The
numberofsecondscanbe001255.Ifthetimeoutintervalisnot
specified,thetimerdefaultvalueof30secondsisapplied.

Var

Trailer.Protocoldependent.

TableNote9:Thisfieldseparatormustbepresentifanyofthe
subsequentfieldsinthemessagearepresent.
TableNote10:ASupervisoroptionallowsoption36tobeignored
ifsentfromthehost.Forfurtherinformation,refertotheAPTRA
AdvanceNDC,SupervisorsGuide.
TableNote11:Fieldsi,j,kandlmayberepeatedtodefine
multipleoptionsand/ortimers.
TableNote12:EnhancedConfigurationParametersLoadoption80
(AlphanumericStateEntry)affectsfollowingStateTablesLoad
messages.Formoreinformation,seeStateTablesLoadon
page 108.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-20

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


FIT Data Load

FITDataLoad

10

ThismessagedownloadsFinancialInstitutionTables(FIT)tothe
terminal.Eachcommandcanincludeasmanytablesastheprotocol
permits.Upto1000FITscanbestoredontheSST.OneFITis
requiredforeachmemberFinancialInstitutioninthenetwork.For
details,seeChapter 8,FinancialInstitutionTables.
Table 10-7
FIT Data Load
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
5FITData

FS

FieldSeparator.

FITNumber.DesignatesthenumberassignedtotheFITinthe
followingfield.Valuesintherange000to999arevalid.TheFIT
numberdefinesthesearchorder.Forexample,FIT000isthefirstentry
checkedduringaFITsearch.Ifthereisagapinthenumberingrange,
allomittedentriesintheFITdatadefaultto000.IflinkedFITsare
used,theymusthaveconsecutiveFITnumbers.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-21

Central to Terminal Messages


FIT Data Load

Field

Number of
Characters

Mandatory/Optional

Description

Var

FITData.SpecifiescontrolwordsforlocalPINverification,remote
PINencryptionandindirectnextstateprocessing.FITdataconsistsof
anumberofthreecharacterentries.Thevalidrangeis000to255,
representingdecimalvaluesintherange000255.Theterminalstores
41entries.Thoseinexcessofthisareignored.Iffewerthan41entries
arereceived,novaluesarestored.Fordetailsofthedata,seeFIT
Dataonpage 82.

FS

FieldSeparator.

M
SeeTableNote13

FITNumber.Asfieldh.

Var

M
SeeTableNote13

FITData.Asfieldi.

FS

SeeTableNote14

FieldSeparator.

SeeTableNote14

MessageAuthenticationCode(MAC)Data.Containsthevalue
transmittedforauthenticationofthismessage.
Thecharactersare09,AF.

Var

Trailer.Protocoldependent.

TableNote13:Afieldseparatorandfieldsjandkcanbe
repeateduntilthemaximumlengthpermittedbytheprotocolis
reached.
TableNote14:ThefieldseparatorandMACDatafieldlareonly
presentiftheflagsettingsarecorrect.Fordetails,seetheAPTRA
AdvanceNDC,SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-22

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Configuration ID Number Load

ConfigurationIDNumberLoad

10

Thismessagecontainsanidentifierforthecustomisationdatainthe
terminal.Atterminalinstallationtime,oranytimecustomisation
dataissenttotheterminal,theconfigurationIDissetto0000.The
configurationIDnumberloadmessagemustbeincludedasthelast
ofthedownloadedcustomisationdatamessagestosetthe
configurationIDtothedesirednumber.TheconfigurationID
numbercanbeanynumberfrom0001to9999.
TheterminalholdscustomisationdataandtheconfigurationIDon
thesystemdisk.Onreceiptofapowerupstatusmessagefromthe
terminal,Centralcanverifythatthecustomisationdatahasbeen
correctlyloaded.OnlyifaconfigurationIDof0000isreceiveddoes
Centralneedtoreloadthecustomisationdata.
Note:ConfigIDisstoredinmemory,butnotsaveduntila
goinserviceisissued.Ifpowerfailoccursbeforethecommandis
issued,theConfigIDwillneedtobereloaded.
Table 10-8
Configuration ID Number Load
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Includedforfutureuseandignoredbytheterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSequenceNumber.Includedforfutureuseandignoredby
theterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
6ConfigurationIDnumber

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-23

Central to Terminal Messages


Configuration ID Number Load

Field

Number of
Characters

Mandatory/ Optional

Description

FS

FieldSeparator.

ConfigurationIDNumber.Thevalidrangeis00019999.

Var

Trailer.Protocoldependent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-24

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Authentication Field Selection Load

MessageAuthenticationField
SelectionLoad

10

Thismessageisusedtosetthemessagesandfieldsspecifiedforfull
orselectiveMACverification,ifachangetothedefaultvaluesis
necessary.FieldsareselectedforinclusionintheMACifthe
relevantoffsetbyteissetto1.
Table 10-9
Message Authentication Field Selection
Load
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuseand
isignoredbytheterminal.

FS

FieldSeparator.

MessageSequenceNumber.Thisfieldisincludedforfutureuseandis
ignoredbytheterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
BMessageAuthenticationFieldselection

FS

FieldSeparator.

Var(47)

SeeTableNote15

TransactionRequestField.Thisfieldcontainsthefieldselectiondata
forthetransactionrequestmessage.
ThefieldsoftheTransactionRequestmessageareselectedforinclusion
intheMACiftherelevantoffsetbyteissetto1.Theoffsetsforthe
TransactionRequestmessagefieldsareshown:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-25

Central to Terminal Messages


Message Authentication Field Selection Load

Field

Number of
Characters

Mandatory/Optional

SeeTableNote15

Description
Offset

Description

0MACthecompletemessage.Ignorethefollowingdigitsin
thefield
1SelectivelyMACthefieldsbelowiftherelevantbyteissetto
1

Fieldsbandc

Fieldd

Reserved

Fielde

Fieldf

Fieldg

Fieldh

Fieldi

Fieldj

10

Fieldk

11

Fieldl

12

Fieldm

13

Fieldn

14

Fieldo

15

Fieldp

16

Fieldsqandr,optionallybufferf

17

Fieldaa*IdentifiedbyDataIDAReserved

18

Fieldab*IdentifiedbyDataIDBReserved

19

Fieldac*IdentifiedbyDataID6Reserved

20

Fieldad*IdentifiedbyDataIDCReserved

21

Fieldae*IdentifiedbyDataIDDReserved

22

Fieldaf*IdentifiedbyDataIDEReserved

23

Fieldag*IdentifiedbyDataIDFReserved

24

Fieldah*IdentifiedbyDataIDGReserved

25

Fieldai*IdentifiedbyDataIDHReserved

26

Fieldaj*IdentifiedbyDataIDIReserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-26

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Authentication Field Selection Load

Field

Number of
Characters

Mandatory/Optional

Description

27

Fieldak*IdentifiedbyDataIDJReserved

28

Fieldal*IdentifiedbyDataIDKReserved

29

Fieldam*IdentifiedbyDataIDLReserved

30

Fieldan*IdentifiedbyDataIDMReserved

31

Fieldao*IdentifiedbyDataIDNReserved

32

Fieldap*IdentifiedbyDataIDOReserved

33

Fieldaq*IdentifiedbyDataIDPReserved

34

Fieldar*IdentifiedbyDataIDQReserved

35

Fieldas*IdentifiedbyDataIDRReserved

36

Fieldat*IdentifiedbyDataIDSReserved

37

Fieldau*IdentifiedbyDataIDTReserved

38

Fieldav*IdentifiedbyDataIDUCSPData

39

Fieldaw*IdentifiedbyDataIDVConfirmationCSPData

40

Fieldax*IdentifiedbyDataIDWAvailableforuseby
Exits

41

Fielday*IdentifiedbyDataIDXAvailableforuseby
Exits

42

Fieldaz*IdentifiedbyDataIDYAvailableforuseby
Exits

43

Fieldba*IdentifiedbyDataIDZAvailableforuseby
Exits

44

Fieldbb*IdentifiedbyDataID[Availableforuseby
Exits

45

Fieldbc*IdentifiedbyDataID\Availableforuseby
Exits

46

Fieldbd*IdentifiedbyDataID5Availableforuseby
EMV/CAM2Exits

51

FieldceidentifiedbyDataIDeBarcodereaderdata

*IndicatesthatalltheelementspresentforthatfieldwillbeMACed
(groupseparatorsexcluded).
FS

FieldSeparator.

Var(36)

SeeTableNote16
andTableNote19

TransactionReplyField.Thisfieldcontainstheselectiondataforthe
TransactionReplymessage.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-27

Central to Terminal Messages


Message Authentication Field Selection Load

Field

Number of
Characters

Mandatory/Optional

Description

ThefieldsoftheTransactionReplymessageareselectedforinclusionin
theMACiftherelevantoffsetbyteissetto1.Theoffsetsforthe
transactionreplymessagefieldsareshownbelow:

SeeTableNote15

Offset

Description

0MACthecompletemessage.Ignorethefollowingdigitsin
thefield
1SelectivelyMACthefieldsbelowiftherelevantbyteissetto
1

Fieldsbandc

Fieldd

Fielde

Fieldf

Fieldsg,h,i,jandj1jn

Fieldk

Fieldl

Fieldm

Fieldn

10

Fieldo

11

Fieldp

12

Fieldsqandr

13

Fieldssandt

14

Fieldsu,vandsubsequentprintfields.
SeeTableNote18.

15

Fieldw

16

Fieldx

17

Fieldaa*IdentifiedbyDataIDAReserved

18

Fieldab*IdentifiedbyDataIDBReserved

19

Fieldac*IdentifiedbyDataIDCReserved

20

Fieldad*IdentifiedbyDataIDDReserved

21

Fieldae*IdentifiedbyDataIDEReserved

22

Fieldaf*IdentifiedbyDataIDFReserved

23

Fieldag*IdentifiedbyDataIDGReserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-28

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Authentication Field Selection Load

Field

Number of
Characters

Mandatory/Optional

Description

24

Fieldah*IdentifiedbyDataIDHReserved

25

Fieldai*IdentifiedbyDataIDIReserved

26

Fieldaj*IdentifiedbyDataIDJReserved

27

Fieldak*IdentifiedbyDataIDKTrack1Data

28

Fieldal*IdentifiedbyDataIDLTrack2Data

29

Fieldam*IdentifiedbyDataIDMVirtualControllerdata

30

Fieldan*IdentifiedbyDataIDNVirtualControllerdata

31

Fieldao*IdentifiedbyDataIDOVirtualControllerdata

32

Fieldap*IdentifiedbyDataIDPVirtualControllerdata

33

Fieldaq*IdentifiedbyDataIDQVirtualControllerdata

34

Fieldar*IdentifiedbyDataIDRVirtualControllerdata

35

Fieldas*IdentifiedbyDataIDasinglechequedeposit
data.
SeeTableNote20.

36

Fieldat*IdentifiedbyDataID5Availableforuseby
EMV/CAM2Exits.SeeTableNote20.

*IndicatesthatalltheelementspresentforthatfieldwillbeMACed
(groupseparatorsexcluded).
FS

FieldSeparator.

11

SeeTableNote16

SolicitedStatusField.ThisfieldcontainstheMACselectiondataforthe
solicitedstatusmessage.

FS

FieldSeparator.

SeeTableNote16

OtherMessagesField.ThisfieldcontainstheMACselectiondatafor
FITload,statetablesload,terminalstatestatusandDispenserCurrency
CassetteMappingTablemessages.

FS

FieldSeparator.

SeeTableNote16

Track1Field.ThisfieldcontainstheMACselectiondataformagnetic
cardtrack1.

FS

FieldSeparator.

SeeTableNote16

Track2Field.ThisfieldcontainstheMACselectiondataformagnetic
cardtrack2.

FS

FieldSeparator.

11

SeeTableNote16

Track3Field.ThisfieldcontainstheMACselectiondataformagnetic
cardtrack3.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-29

Central to Terminal Messages


Message Authentication Field Selection Load

Field

Number of
Characters

Mandatory/Optional

Description

FS

FieldSeparator.

SeeTableNote16

EMVSmartCardConfiguration.ThisfieldcontainstheMACselection
datafortheEMVConfigurationmessage.

FS

SeeTableNote17

FieldSeparator.

SeeTableNote17

MessageAuthenticationCode(MAC)Data.Thisfieldcontainsthe
eightcharactervaluetransmittedforauthenticationofthismessage.
Thecharactersare09andAF.

Var

Trailer.Protocoldependent.

TableNote15:Offset16notonlycontrolswhetherfieldsqandr
areincludedintheMACgeneration,butalsowhetherbufferfis
includedwhenmorethanfourhoppertypesaresupportedbythe
coindispenser.
TableNote16:Variablelengthfieldsmaybetruncated,thatis,
trailingcharactersmaybeomitted.Theomittedcharacterswilltake
avalueofzero.IfMessageAuthenticationisturnedon,anyfixed
(notvariable)lengthfieldsmustbeeitheremptyorfullypopulated,
orthemessagewillberejectedwithaMACfailure.
TableNote17:ThefieldseparatorandMACareonlypresentwhen
theDataSecurityfeatureisselectedandtheflagsaresetcorrectly.
Fordetails,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
WhentheDataSecurityfeatureisset,allthemessagessentfrom
CentraltotheterminalthatcontainaMACfieldmusthavethis
optionalfieldpresent.
TableNote18:Theprinterfields,followingfieldsuandv,will
beMACediffieldsuandvaretobeMACed.Thegroup
separatorsbetweentheadditionalprinterfieldswillnotbeincluded
intheMACingactivity.
TableNote19:TheMACingofothermessages,includingthe
DispenserCurrencyCassetteMappingTablemessageandtheEMV
Configurationmessages,arespecifiedintheSelectiveMessage
AuthenticationsectionofChapter11,SecurityFeatures.
TableNote20:IfyouwishtouseselectiveMACingonEMVICC
datawithAdvanceNDCandNDC+basedterminals,youcannot
usethesameMessageAuthenticationFieldSelectionLoadmessage.
ThisisbecauseofthedifferentEMVfieldoffsets(35forNDC+and
36forAdvanceNDC).FormoreinformationaboutEMVIntegrated
CircuitCard(ICCorSmartCard)configurationusingAPTRA
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-30

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Authentication Field Selection Load

AdvanceNDC,seeOtherNCRDocumentationinAppendix G,
RelatedDocumentation.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-31

Central to Terminal Messages


Date and Time Load

DateandTimeLoad
Thismessageisusedtosetthelocaldateandtimeintheterminal.
Table 10-10
Data and Time Load
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuseand
isignoredbytheterminal.

FS

FieldSeparator.

MessageSequenceNumber.Thisfieldisincludedforfutureuseandis
ignoredbytheterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
CDateandTime

FS

FieldSeparator.

10

Date/TimeData.
Thisfieldcontainsthedateandtimeinthefollowingformat:
YY=Year
MM=Month
DD=Day
HH=Hour
MM=Minute

(0099)
(0112)
(0131)
(0023)
(0059)

If00<=YY<=89,theyearistakentobeintherange2000<=YY<=2089.If
90<=YY<=99,theyearistakentobeintherange1990<=YY<=1999.
Note: Secondsaresettozerowhenthedateandtimeareset.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-32

APTRA Advance NDC, Reference Manual

10

Central to Terminal Messages


Encryption Key Change

EncryptionKeyChange

10

Forsecurity,theCentralprogrammercanusethismessageto
changetheMasterKey(Akey),CommunicationKey(Bkey)and
VISAMasterKey(Vkey)initiallyenteredbyalocaloperator
throughSupervisormode.FromAdvanceNDC2.02,itispossibleto
changetheCommunicationkeywhiletheterminalisinservice,but
notcurrentlyhandlingatransaction.Thisisnotpossiblewhenthe
terminalisinsuspendmode,ortheoperatorisinitiatingthe
executionofsettlementtransactions.
InadditiontotheEncryptionKeys,theoperatormaychangethe
MessageAuthenticationKeyandVISAKeyTable.Fordetails,refer
totheAPTRAAdvanceNDC,SupervisorsGuide.
Note:IfanEncryptionKeyChangemessageissentinSupervisor
mode,themessageisnotprocesseduntilthefrontkeyboardis
disabled,followingamenuselectionorsupervisormodeexit.
TheEncryptionKeyChangemessagemay:

Includeanencryptedencryptionkey.
Specifythecurrentencryptionkeythattheterminalmustuseto
decryptthisencryptedencryptionkey.
Specifywhichofthecurrentencryptionkeystoreplace.

Theabovespecificationsarecontainedinthemodifierfieldofthe
message.
AsolicitedstatusmessagewillbereturnedtoCentralafteran
attempttomodifyanencryptionkey,toindicateitssuccessor
failure.
Centralmustencryptthenewencryptionkeywiththesamekey
designatedtodecryptitattheterminal.
PINverificationmayrequiretheuseofaseparatePINkey.Thekey
usedinthiscaseisthePEKEY,containedintheFIT,whichcanbe
differentforeachfinancialinstitutioninthesystem.
OnpowerfailurethehostsendstheKeyExchangemessages.
Thismessageisnotconsideredpartofthecustomisationdataand
doesnotresettheconfigurationIDtozero.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-33

Central to Terminal Messages


Encryption Key Change
Table 10-11
Encryption Key Change
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuseand
isignoredbytheterminal.

FS

FieldSeparator.

MessageSequenceNumber.Thisfieldisincludedforfutureuseandis
ignoredbytheterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
3EncryptionKeyInformation

Modifier.Thisonecharacterfieldspecifiestheencryptionkeychange
totakeplace:
1Deciphernewmasterkeywithcurrentmasterkey*
2Deciphernewcommunicationskeywithcurrentmasterkey*
3Deciphernewcommunicationskeywithcurrentcommunications
key*
4Uselocallyenteredcommunicationskey(Bkey)ascurrent
communicationskey
5DeciphernewMACkeywithcurrentmasterkey*
6DeciphernewMACkeywithcurrentcommunicationskey*
7Uselocallyenteredcommunicationskey(Bkey)ascurrentMAC
key
8DeciphernewVISAmasterkeywithcurrentVISAmasterkey*
9KeydataisnewVISAkeytable;theequivalentoldkeyis
overwritten.SeeTableNote21.
*Theequivalentoldkeyisoverwritten.

FS

FieldSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-34

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Encryption Key Change

Field

Number of
Characters

Mandatory/ Optional

Description

24or288

NewKeyData.Keydataconsistsofentriesofthreecharacters.The
validrangeofeachentryis000255.
Eachentrydefinesthevalueoftwohexadecimalencryptionkeydigits.
Akeyconsistsofeightentries.Thefirstentrycontainsdigits1and2.
Thelastentrycontainsdigits15and16(95and96).
Forexample,255,254,253,252,251,250,249,248isequivalenttoFF,
FE,FD,FC,FB,FA,F9,F8enteredlocallyattheterminal.
SeeTableNote22.

Var

Trailer.Protocoldependent

TableNote21:WhenVISAPINverificationisused,anychangeto
thekeysshouldbedonewithamessagemodifier8tochangethe
masterkey,followedbyamessagemodifier9toloadthenewkey
table.
TableNote22:Inallmessageswherekeydataispresent,exceptfor
modifier9,onlyonekeyispresent.Formodifier9,twelvekeys
comprisingthesixVISAkeytablepairsarepresent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-35

Central to Terminal Messages


Extended Encryption Key Change

ExtendedEncryptionKeyChange

10

WithanEncryptingPINPad(EPP),thismessagecanbeusedto
changetheMasterKey(Akey),CommunicationKey(Bkey)and
VISAMasterKey(Vkey)initiallyenteredbyalocaloperator
throughSupervisormode.IfanEPPisnotpresent,thismessageis
rejected.
ItispossibletochangetheCommunicationkeywhiletheterminalis
inservice,butnotcurrentlyhandlingatransaction.Thisisnot
possiblewhentheterminalisinSuspendmode,ortheoperatoris
initiatingtheexecutionofsupervisoryorsettlementtransactions.
Thismessagesupportstheterminalkeymodesofsingleand
doublelengthkeys.Forfurtherdetails,seeChapter 11,Security
Features.
Note:IfanExtendedEncryptionKeyChangemessageissentin
Supervisormode,themessageisnotprocesseduntilthefront
keyboardisdisabled,followingamenuselectionorsupervisor
modeexit.
TheExtendedEncryptionKeyChangemessagemay:

Includeanencryptedencryptionkey
Specifythecurrentencryptionkeythattheterminalmustuseto
decryptthisencryptedencryptionkey
Specifywhichofthecurrentencryptionkeystoreplace.

Theabovespecificationsarecontainedinthemodifierfieldofthe
message.
TheExtendedEncryptionKeyChangemessageenablessingle
lengthkeystobedownloaded(asthepreviousEncryptionKey
Changemessage),butalsodoublelengthkeys.
Ifthismessageissentforasinglelengthkeywhentheterminalisin
doublelengthkeymode,orviceversa,acommandrejectisissued
indicatinganEncryptionKeyChangemessageofthewronglength
hasbeenissued.
TheExtendedEncryptionKeyChangemessagecanbesentto
changetheCommunicationKey(Bkey)atanypointafteritis
initiallyentered,exceptwhenatransactionisinprocess,orthe
terminalisinSuspendmode,orwhentheoperatorisexecutinga
supervisor/settlementtransaction.
Ifthekeyloadissuccessful,anEncryptorInitialisationData
messageisreturnedtoCentraltoreportthenewkeysKey
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-36

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Extended Encryption Key Change

VerificationValue(KVV).Ifthekeyloadfails,arejectmessageis
sent.
WhenaDESkeyisusedtoencryptthenewencryptionkey,Central
mustencryptthenewencryptionkeywiththesamekeydesignated
todecryptitattheterminal.
PINverificationmayrequiretheuseofaseparatePINkey.Thekey
usedinthiscaseisthePEKEY,containedintheFIT,whichcanbe
differentforeachfinancialinstitutioninthesystem.
OnpowerfailuretheMasterkeyisunchanged,butthe
CommunicationskeyandMACkeyarechangedtothelocally
enteredBkeyiftheRestartModeoptionspecifiesthis,orif
configurationdatareloadfromdiskfails.Thehostmustensurethat
anyrequiredExtendedEncryptionKeyChangemessagesaresent.
TheExtendedEncryptionKeyChangemessagecanbesentto
changetheMACkeytothecurrentMasterkey(modifier5)orthe
currentCommunicationskey(modifier6)atanypointafteritis
initiallyentered,exceptforthefollowing:

Whenacardholdertransactionisinprogress
WhentheterminalisinSuspendmode
WhenaSupervisorsettlementtransactionisinprogress.

Thismessageisnotconsideredpartofthecustomisationdataand
doesnotresettheconfigurationIDtozero.
Table 10-12
Extended Encryption Key Change
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuseand
isignoredbytheterminal.

FS

FieldSeparator.

MessageSequenceNumber.Thisfieldisincludedforfutureuseandis
ignoredbytheterminal.

FS

FieldSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-37

Central to Terminal Messages


Extended Encryption Key Change

Field

Number of
Characters

Mandatory/ Optional

Description

MessageSubClass.Themessagesubclassis:
4ExtendedEncryptionKeyInformation

Modifier.Thisonecharacterfieldspecifiestheencryptionkeychange
totakeplace:
1Deciphernewmasterkeywithcurrentmasterkey.
SeeTableNote23.
2Deciphernewcommunicationskeywithcurrentmasterkey.
SeeTableNote23.
3Deciphernewcommunicationskeywithcurrentcommunications
key.SeeTableNote23andTableNote24.
4Uselocallyenteredcommunicationskey(Bkey)ascurrent
communicationskey.
SeeTableNote24andTableNote26.
5DeciphernewMACkeywithcurrentmasterkey.
SeeTableNote23.
6DeciphernewMACkeywithcurrentcommunicationskey.
SeeTableNote23andTableNote24.
7Uselocallyenteredcommunicationskey(Bkey)ascurrentMAC
key.SeeTableNote24andTableNote26.
8DeciphernewVISAmasterkeywithcurrentVISAmasterkey.
SeeTableNote26.
9KeydataisnewVISAkeytable.
SeeTableNote23andTableNote25.
ADeciphernewVISAmasterkeywithcurrentmasterkey.
SeeTableNote23andTableNote25.
BLoadHostSecurityModule(HSM)publickeyandsignature.
SeeTableNote27.
ThekeydatafieldcontainstheHSMpublickey(PKHSM)and
signatureblock(PKHSM)createdusingSKNCR,eachbase94
encodedgivingatotallengthof640bytes.
CLoadinitialmasterkey(Akey)withRSAkey.
SeeTableNote27.
ThekeydatafieldcontainstheinitialAkeyencryptedwiththeEPP
publickey[AKEY],PKEPPandsignatureblock([AKEY],PKEPP)
createdusingSKHSM,eachbase94encodedgivingatotallengthof
640bytes.
SeeTableNote34.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-38

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Extended Encryption Key Change

Field

Number of
Characters

Mandatory/ Optional

Description

DLoadnewinitialcommunicationskey(Bkey)withRSAkey.
SeeTableNote27.
ThekeydatafieldcontainstheinitialBkeyencryptedwiththeEPP
publickey[BKEY],PKEPPandsignatureblock([BKEY],PKEPP)
createdusingSKHSM,eachbase94encodedgivingatotallengthof
640bytes.
SeeTableNote24andTableNote34.
ELoadnewinitialVISAmasterkey(Vkey)withRSAkey.
SeeTableNote27.
ThekeydatafieldcontainstheinitialVkeyencryptedwiththeEPP
publickey[VKEY],PKEPPandsignatureblock([VKEY],PKEPP)
createdusingSKHSM,eachbase94encodedgivingatotallengthof
640bytes.
SeeTableNote34.
FSendEPPserialnumber.
SeeTableNote27.
TheterminalwillrespondwithanEncryptorInitialisationData
messagecontainingthesignedserialnumber.
IftheEPPserialnumberreturnedbytheEPPisnot8bytesinlength.it
willberejectedwithaSpecificCommandRejectcodeofE06.
IftheencryptorhaspreviouslybeenusedinBAPEmode,this
commandoptionwillfailunlessthekeyentrymodeischanged
througheitherthemodifierJortheSupervisorAccessmenu.
SeeTableNote32.
GSendEPPpublickey.
SeeTableNote27.
TheterminalwillrespondwithanEncryptorInitialisationData
messagecontainingthesignedEPPpublickey
HSendallKVVs.SeeTableNote26
IReserved.
JSetkeyentrymode.SeeTableNote27andTableNote32
KSendcurrentkeyentrymode
LLoadhostcertificate(primaryorsecondary)
MSendSSTcertificate
NSendSSTrandomnumber
ThisissupportedonlyiftheSSTisusingcertificatesortheEnhanced
Signatureschemeforremotekeyloading.IfNisnotsupported,the
messagewillberejectedwithreasonE02:
OLoadAkeyPKCS7encoded.
PReplacecertificationauthoritycertificate

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-39

Central to Terminal Messages


Extended Encryption Key Change

Field

Number of
Characters

Mandatory/ Optional

Description

QSendencryptorcapabilitiesandstate.
RLoadNCRSubpublickeyandsignature.SeeTableNote35
SDeleteHSMpublickey.SeeTableNote36
TDeleteNCRSubpublickey.SeeTableNote35andTableNote36
USendEPPattributes.SeeTableNote37
VSendvariablelengthEPPserialnumber.SeeTableNote38
FS

FieldSeparator.

KeyDataSize.Specifiesthesizeofthefollowingkeydatafieldin
hexadecimal(hex).
ForasinglelengthDESkey,thesizeis018hex(24decimal)characters.
ForadoublelengthDESkey,thesizeis030hex(48decimal)
characters.
ForthesixVISAtablekeys,thesizeis120hex(288decimal)characters.

0640

NewKeyData.Maximumlengthis640bytes.
SeeTableNote27andTableNote32
ForDESkeys,thekeydataconsistsofentriesofthreecharacters.The
validrangeofeachentryis000255.
Eachentrydefinesthevalueoftwohexadecimalencryptionkeydigits.
Akeyconsistsofeightentriesforasinglelengthkey,orsixteenentries
foradoublelengthkey.Thefirstentrycontainsdigits1and2.Thelast
entrycontainsdigits15and16(95and96).
Forexample,255,254,253,252,251,250,249,248isequivalenttoFF,
FE,FD,FC,FB,FA,F9,F8enteredlocallyattheterminal.
InallmessageswhereDESkeydataispresent,exceptformodifier9,
onlyonekeyispresent.Formodifier9,twelvekeyscomprisingthe
sixVISAkeytablepairsarepresent.
Thekeyisinterpretedassingleordoublelengthdependingonthe
KeyEntrymodeoptionselectedfromtheSupervisorAccessmenu.For
moreinformation,seeChapter 11,SecurityFeatures.

TableNote23:Formodifiers1,2,3,5,6,8,9andAthe
equivalentoldkeyisoverwritten.
TableNote24:Modifiers3,4,6,7andDcannotbeusedifthe
KeyEntrymodeissettoDoubleLengthRestricted,whentheywill
berejectedwithreasonC17.SeeChapter 11,SecurityFeatures.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-40

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Extended Encryption Key Change

TableNote25:WhenVISAPINverificationisused,anychangeto
thekeysshouldbeperformedwithmessagemodifier8orAto
changethemasterkey,followedbymessagemodifier9toloadthe
newkeytable.
TableNote26:Formodifiers4,7andH,fieldiisnotpresent.
TableNote27:ModifiersB,C,D,E,F,GJ,UandVare
supportedonlybytheEPP.IftheterminaldoesnothaveanEPP,the
messagewillberejectedwithSpecificCommandRejectE02
Functionnotsupportedinhardware.
TableNote28:OnlytheAkeyhastobedownloadedusingRSA.
Thecommunicationskey,MACkeyandVISAkeycanbeloaded,
encryptedbytheAkey.
TableNote29:Modifiers2and3canbeusedwhiletheterminalis
inservice,butnotperformingatransaction,tochangethe
communicationskey.Allothermodifierscanonlybeusedwhilethe
terminalisoutofservice.Iftheterminalisnotinthecorrectmode,
themessageisrejectedwithreasonC15.
TableNote30:Dependingonthesingle/doubleencryptionmode
oftheterminal,theinitialkeys(A,BandV)maybesingleordouble
length.AsthelengthofanencryptedRSAblockisalways256bytes,
themessagelengthremainsunchanged.
TableNote31:TheexponentoftheHSMPKisalways65537,and
isthereforenottransmittedtotheterminal.
TableNote32:ModifierJissupportedonlyontheEPPencryptor,
andhastheadditionalrestrictionthatitwillbeacceptedonlyafter
thehosthasdemonstratedthatithastheabilitytodownload
encryptionkeysusingRSAkeydownload.Thisisachievedbythe
exchangeofpublickeysandreadingtheEPPserialnumber.Ifthis
exchangeofmessageshasnotbeenperformedsincethelastpower
upthecommandwillberejected(ReasonC18notauthorised).To
permitmigrationfrompreviousNDC+releases,iftheEPPis
operatinginBAPEemulationmodethismodifierwillbeaccepted
oncewithouttheneedfortheauthorisationsequence.Changingthe
keyentrymodewillswitchtheencryptorintoEPPmode.
FormodifierJthekeydataconsistsofasinglecharacterinthe
range1to4whichselectsthenewmode,asfollows:
1=SetmodetosinglelengthwithoutXOR
2=SetmodetosinglelengthwithXOR
3=SetmodetodoublelengthwithXOR
4=Setmodetodoublelengthrestricted.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-41

Central to Terminal Messages


Extended Encryption Key Change

Themodecontrolsthemanualencryptionkeyentrymode,the
encryptionkeysizeandtherestrictionsplacedonkeyusage.When
usingaremotekeyprotocol,themodemustbesetbasedontheDES
keysizetobeusedandthelevelofrestrictiontobeplacedonthe
usageofencryptionkeys.
AllfourkeymodesaresupportedfornonsecureEPPonNCRand
othervendorsmachines.WithsecureEPPandDAPI7onlykey
mode4issupported.IfthemodecannotbesupportedbytheEPP,
aSpecificCommandRejectisreturned.
TableNote33:SecuritymessagesfromCentralwillnotbe
processediftheapplicationisinSupervisormode.
TableNote34:FormodifiersC,DandE,whentheenhanced
signatureremotekeyprotocolisusedthesignatureisgenerated
fromarandomnumberconcatenatedwiththeencryptedsingleor
doublelengthDESkey.Therandomnumberisreturnedinresponse
toanEEKCrequestwithmodifierN.Therandomnumberisnot
includedinthemessagefromthehosttotheEPP.
TableNote35:ModifiersR,SandTaresupportedonlyunder
theenhancedsignatureremotekeyprotocol.Iftheenhanced
signatureisnotsupported,SpecificCommandRejectE02is
returned.
TableNote36:ModifiersSandTareusedtodeletetheHSM
publickeyandHSMRootpublickey.Deletionofthesekeys
dependsonthecapabilityoftheEPPwhichsupportseithera
variablelengthserialnumberorafixedlengthserialnumberthatis
of8bytes.
TableNote37:ModifierUisusedtoreturntheEPPattributesfor
thehosttodeterminewhethertheEPPisPCIcompliant.
TableNote38:WherevariablelengthEPPserialnumbersare
supportedusemodifierVtoreportEPPserialnumbersforall
hardwarevariantstoavoiddifferenthostprocessingrequirements
ondifferenthardware.
Note:TheapplicationaddstheSNEPPtothemessagedatafor
verification.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-42

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Dispenser Currency Cassette Mapping Table

DispenserCurrencyCassette
MappingTable

10

Thetablecontainedinthismessageisusedtodefinecurrencytypes,
whichmaptotheconfigurationsettingsintableentry7ofthe
AmountCheckStatedefinedintheAmountCheckStateTable.
WhentheDataSecurityfeatureisset,allthemessagessentfrom
CentraltotheterminalthatcontainaMACfieldmusthavethis
optionalfieldpresent.
Table 10-13
Dispenser Currency Cassette Mapping
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuse
andisignoredbytheterminal.

FS

FieldSeparator.

MessageSequenceNumber.Thisfieldisincludedforfutureuseand
isignoredbytheterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
1CustomisationData

MessageIdentifier.Themessageidentifieris:
EDispenserCurrencyCassetteMappingTable

FS

FieldSeparator.

NumberofMappingEntries.TwodigitASCIIhexvalue(range01to
FF).SeeTableNote39.

i1

SeeTableNote39

CurrencyType.SingledigitASCIIhexvalue(range01toFF).Used
formappingtostatetypeGtableentry7.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-43

Central to Terminal Messages


Dispenser Currency Cassette Mapping Table

Field

Number of
Characters

Mandatory/ Optional

Description

i2

SeeTableNote39

CassetteType.SingledigitASCIIhexvalue(range0toF,types1to4
supported).

i3

SeeTableNote39

DenominationforCassette.FivedigitASCIInumericvalue(for
example,00005for$5).

FS

SeeTableNote40

FieldSeparator.

SeeTableNote40

MessageAuthenticationCode(MAC)Data.Containsthevalue
transmittedforauthenticationofthismessage.Thecharactersare09,
AF.

Var

Trailer.Protocoldependent.

TableNote39:Iffieldhisgreaterthan01,thefieldsi1toi3
inclusivearerepeatedforthenumberoftimesindicatedbyfieldh.
TheDataCommandmessageisexpectedattheterminalonlywhen
theterminalisinoutofservicemodeorsupply/supervisormode.
IfCentraltransmitsaDataCommandmessageanditdoesnot
conformtotheformatabove,orissentatatimewhenitisnot
expected,asolicitederrormessageisgenerated,identifyinga
SpecificCommandRejectvalueforthefailurereason(orsimplyA
ifSpecificCommandRejectprocessingisnotactivated).
IfaSpecificCommandRejectvalueisgeneratedthenthemessage
contentwillbeignored.
Thefollowingexampleshowsthecontentsforfieldshandiusing
twocurrencies,dollarsandeuros,with:

cassettetype1=10dollars
cassettetype2=20dollars
cassettetype3=100euros
cassettetype4=200euros
.... 04 01 1 00010 01 2 00020 02 3 00100 02 4 00200
....

Thespacesareincludedforclaritybutdonotappearintheactual
messagetotheterminal.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-44

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Dispenser Currency Cassette Mapping Table

TableNote40:ThefieldseparatorandMACarepresentonlywhen
theDataSecurityfeatureisselectedandtheflagsaresetcorrectly.
Fordetails,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
WhentheDataSecurityfeatureisset,allthemessagessentfrom
CentraltotheterminalthatcontainaMACfieldmusthavethis
optionalfieldpresent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-45

Central to Terminal Messages


XML Configuration Download

XMLConfigurationDownload

10

Thismessageisagenericcommandthatdownloadsconfiguration
datatotheterminal.Theconfigurationdatacontentisdefinedin
XMLfilesandiscontainedwithinanumberofXMLschemafiles.
Theseschemafilesaredefinedwhennewconfiguration
requirementsareidentified.
AdvanceNDCrespondstotheXMLconfigurationdownloadinthe
samewayasallotherdatacommands,forexample,itsendsa
Ready9oraRejectsolicitedmessage.AnXMLschemafile
containingconfigurationdatacanbedownloadedinparts(uptoa
maximumof9999),orasasinglefile.TheReady9acknowledges
receiptofeachXMLschemafilepart;butthisdoesnotimplythe
contentisvalid.Validationoccursonlywhenthefinalpartofthe
fileisdownloaded.
Thehostmustdownloadthepartsofthefileinsequence.Whenthe
lastpartofthefileisdownloaded,AdvanceNDCconstructsthe
wholefile,validatesthefile,completestheconfigurationprocess
andstoresthefile.ThenameofthefileisreadfromtheXML
configurationdataandisstoredintheC:\ProgramFiles\NCR
APTRA\configdirectory.Ifpartofafileisdownloadedoutof
sequence,aSpecificCommandRejectisreturned.Ifthehostdoes
notreceivetheReady9acknowledgement,itcanresendthelast
partwithoutgettinganerror.Thisallowsthehosttorecoverfroma
communicationsfailureorcontinuewiththedownloadaftera
powerfailureattheSST.
Thehostcancanceladownload(andpotentiallyrestartthewhole
process)bysettingeitherfieldh(TotalMessageParts),orfieldi
(MessagePart)to0000.Thecanceldownloadrequestisrequiredif
thehostreceivesaSpecificCommandReject.AdvanceNDCreplies
withaReady9whenithasprocessedthecanceldownload
request.
Allpartsofthedownloadarediscardedwhenthefinalparthas
beendownloadedandprocessed,orwhenthehostcancelsthe
download.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-46

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


XML Configuration Download
Table 10-14
XML Configuration Download Message
Format
Field

Number of
Characters

Mandatory/
Optional

MessageClass.
Themessageclassis:3DataCommand.

ResponseFlag.
Thisfieldisincludedforfutureuseandisignoredbytheterminal.

FieldSeparator.

LogicalUnitNumber.
Includedforfutureuseandisignoredbytheterminal.

FieldSeparator.

MessageSequenceNumber.
Includedforfutureuseandisignoredbytheterminal.

FieldSeparator.

MessageSubclass.
Themessagesubclassis:1CustomisationData.

MessageIdentifier.
Themessageidentifieris:IXMLConfigurationDownload.

FieldSeparator.

TotalMessageParts.
Totalnumberofpartsthattheconfigurationdataissplitinto.Itcontainsa
fourdigitdecimalnumber,intherange0000to9999.Ifthisvalueis
0000,allpreviouspartsofapartialconfigurationdatadownloadare
discarded(seeTableNote41).

FieldSeparator.

Messagepart.
Partnumberfortheconfigurationdatacontainedwithinthismessage.It
containsafourdigitdecimalnumber,intherange0000to9999.Ifthis
valueis0000,allpreviouspartsofapartialconfigurationdatadownload
arediscarded(seeTableNote41).IfthisvalueequalsthevalueinTotal
MessageParts(fieldh),thedownloadedpartsarecombinedandvalidated
againstthespecificschema.Ifthedataisvalidtheconfigurationdatais
storedinanXMLfileataspecificlocation.

FieldSeparator.

Description

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-47

Central to Terminal Messages


XML Configuration Download

Field

Number of
Characters

Mandatory/
Optional

VAR

NDCConfigurationData.
Fordetailsoftheconfigurationdataformat,refertotheAPTRAAdvance
NDCDevelopersGuide

SeeTable
Note42.

FieldSeparator.

SeeTable
Note42.

MessageAuthenticationCodeData(MAC)Data.
Valuetransmittedforauthenticationofthismessage.Thecharactersarein
therange09andAF.

Description

TableNote41:Ifeitherfieldhoricontainthevalue0000,all
previouspartsofapartialconfigurationdownloadarediscarded.
TableNote42:ThefieldseparatorandMACDatafieldkareonly
presentiftheflagsettingsarecorrect.Fordetails,refertothe
APTRAAdvanceNDC,SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-48

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

TransactionReplyCommand

10

ATransactionReplycommandissenttotheterminaloncethe
cardholderhasenteredallthedatanecessaryforaspecific
TransactionRequest,andarequesthasbeensenttoCentral.
TheterminalregardstheTransactionReplycommandasan
authorisationtocompletethetransaction.Ifthetransactioncannot
becompletedsuccessfully,theterminalsendsadevicefault
SolicitedStatusmessagetoCentral.Theterminalthenwaitsfor
anotherTransactionReplycommand,authorisingittocompletethe
transactioninanotherway.
ThemaximumlengthofaTransactionReplycommanddependson
theprotocol.
Table 10-15
Transaction Reply Command: Message
Format
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
4TransactionReplyCommand

ResponseFlag.Includedforfutureuseandignoredbythe
terminal.

FS

FieldSeparator.

3or9

LogicalUnitNumber(LUNO).Thecontentsofthisfieldareonly
usedwhenCentralasksforthesecurityterminalnumbertobe
checked.Inthiscasethefieldwillcontainninecharacters,thelast
sixofwhicharechecked.

FS

FieldSeparator.

3or8

SeeTableNote53

MessageSequence/TimeVariantNumber.TheMessageSequence
numberfieldisignoredbytheterminalandisincludedforfuture
use.TheTimeVariantfieldcontainsaneightcharactertime
variantnumberwhichshouldbethesameasthelasttimevariant
numbertransmittedtoCentral.

FS

FieldSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-49

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

NextStateIDData.Containsabase10(decimal)numberinthe
range000254or256999,orabase36(alphanumeric)numberin
therange000254or256ZZZ.Thisidentifiesthestatenumber
whichtheterminalshouldexecuteafterithascompletedthe
specifiedTransactionReplycommand.

ThisfieldmustbeincludedinallTransactionReply
messagesexceptaPrintImmediate.
FS

FieldSeparator.

g1

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype1notestodispense.Containsthenumberoftype1
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

g2

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype2notestodispense.Containsthenumberoftype2
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

g3

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype3notestodispense.Containsthenumberoftype3
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

g4

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype4notestodispense.Containsthenumberoftype4
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

g5

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype5notestodispense.Containsthenumberoftype5
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

g6

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype6notestodispense.Containsthenumberoftype6
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

g7

SeeTableNote49,
TableNote50,Table
Note51,andTable
Note52

Numberoftype7notestodispense.Containsthenumberoftype7
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.

GS

SeeTableNote55

GroupSeparator

j1

SeeTableNote56
andTableNote55

Numberofhoppertype1CoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertype1.
Validrangeisdefinedbyhardwarecapabilities.See TableNote57.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-50

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

j2

Mandatory/ Optional

Description

SeeTableNote56
andTableNote55

Numberofhoppertype2CoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertype2.
Validrangeisdefinedbyhardwarecapabilities.See TableNote57.

j3

SeeTableNote56
andTableNote55

Numberofhoppertype3CoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertype3.
Validrangeisdefinedbyhardwarecapabilities.See TableNote57.

j4

SeeTableNote56
andTableNote55

Numberofhoppertype4CoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertype4.
Validrangeisdefinedbyhardwarecapabilities.See TableNote57.

j5

SeeTableNote56
andTableNote55

Numberofhoppertype5CoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertype5.
Validrangeisdefinedbyhardwarecapabilities.See TableNote57.
:

Repeatedforthenumberofhoppertypespresent.
:
jn

SeeTableNote56
andTableNote55

NumberofhoppertypenCoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertypen.
Validrangeisdefinedbyhardwarecapabilities.See TableNote57.

FS

FieldSeparator.

TransactionSerialNumber.NumberthatCentralusestoidentify
thetransaction.ItisusedbytheSSTforthefollowingfunctions:
DefaultPPDprinting
TransactionnumberofthelasttransactionprocessedbytheSST.
(ThiscanberequestedbyCentralbytransmittingaSendSupply
CountersTerminalCommandtotheterminal.)
Partoftheinformationprintedonthejournalwhenanexception
statusissenttoCentral.
Validrangeis00009999

FunctionIdentifier.Instructstheterminalonwhatfunctionsareto
beperformed:
Function ID

Functions Performed

1or7

Depositandprint.SeeTableNote45.

2or8

Dispenseandprint.SeeTableNote43.

3or9

Displayandprint

Printimmediate

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-51

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

Setnextstateandprint

Nightsafedepositandprint

Ejectcardanddispenseandprint(cardbeforecash)

BorC

Paralleldispenseandprintandcardeject

Reserved.Aspecificcommandrejectwillbesentifthis
isreceived.

Cardbeforeparalleldispense/print

Reserved

Printstatementandwait.SeeTableNote44.

Printstatementandsetnextstate.SeeTableNote44.

Reserved.ASpecificCommandRejectwillbesentif
thisisreceived.

Reserved.ASpecificCommandRejectwillbesentif
thisisreceived.

Reserved.ASpecificCommandRejectwillbesentif
thisisreceived.

Refundnotesandprint

Depositnotesandprint

Depositnotesandwait

Processcheque

Processmultiplecheques

TableNote43:IftheDispenseandPrintfunctionisusedwitha
spraycashdispenserandamotorisedcardreader,thefulltimeout
oncashtakenbeforereturningcardandthenprintingwillbeused.

TableNote44:FunctionIDsPandQareusedtoprint
statementsonthestatementprinterwhentheprinterflaginthe
TransactionReplyis8orsidewaysonthereceiptprinterwhenthe
printerflagis=.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-52

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

TheactiontakenonaPrintImmediatecommanddependsonwhen
itisreceivedandthecontentsofthenextstateIDfield.

TableNote45:Dieboldmodeisnotsupported,therefore
AdvanceNDCoperationisdifferentfromNDC+.InAdvance
NDC,anenvelopeisalwaysdispensedonexecutionofthe
transactionreplyifanenvelopehasnotpreviouslybeendispensed
throughtheexecutionoftheEnvelopeDispenserState.
Next State
Field

Action

Trans.
Request

Included

Asnextstateandprint.

Trans.
Request

Omitted

PrintandwaitfornewTransaction
Replycommand.

Other

SeeMessageValidationsectioninthis
chapter.

State

3or5

ScreenNumber.Containseitherathreedigitdecimalvaluefrom
010to999,orafivecharactervaluecontainingafourdigitscreen
numberprefixedwiththeletteruorl.Thescreennumber
definesthescreentobedisplayedontheterminalduringexecution
ofthespecifiedfunction.
Toselectascreenfromthecurrentlanguagegroup,useeither
grouplorathreedigitscreennumber.Toselectascreen
independentlyoflanguagegroup,usegroupu.
OnaCardBeforeCashorCardBeforeParallelDispenseandPrint
transaction,thisscreenshouldcontaintwonestedscreennumbers
fordisplayingatdifferenttimesduringthetransaction;S0(screen
1)S0(screen2).Donotincludeaclearscreencontrol,asthis
preventsthenestedscreensbeingdisplayed.
Thisfieldmustbepresentiffieldnispresent.Otherwise,itis
optional.Ifthescreennumberisnotpresentornotdefined,no
voicedatawillbeplayed.

Var

ScreenDisplayUpdate.Containsscreennumbersandnewscreen
datawhichcanreplaceexistingscreendata.Thenewscreendatais
displayedwhenitsscreennumberisreferencedduringtransaction
processing.
Toimmediatelyupdateadisplayedscreen,thedisplayedscreen
mustbethefirstscreeninthescreenupdatedata.Ina
voiceguidedsession,thiscanbeusedtoinsertdynamicaudiodata
inamessage;fordetails,seeDigitalAudioControlforVoice
Guidanceonpage 323.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-53

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

Screennumbersinthescreenupdatecanbespecifiedasfourdigit
numbersingroupu(u1234)toloadascreenindependentof
languagegroup.Ascreennumberfromgroupl(l1234)canbe
specifiedtoloadascreeninthecurrentlanguagegroup.Ascreen
numberspecifiedwiththreedecimaldigits(123)willbelanguage
independent,unlessalanguagehasbeenselectedwithagroup
sizeof1000orgreater,inwhichcasethescreennumberwillbe
adjustedforlanguage.
Thescreenupdatedataisinthefollowingformat:
No. Of
Bytes

Content

3,5or6

Screennumber

Var

Screendata

1*

Groupseparator

4*

Reserved

3*

Screennumber

Var*

Screendata

*Thesefieldsareonlyincludedwhenmultiplescreensaretobe
updatedwithinonemessage.Theyarerepeatedforeach
additionalscreen.
FS

FieldSeparator.

MessageCoOrdinationNumber.
SeetheTransactionRequestMessagessection(fieldg)in
Chapter 9,TerminaltoCentralMessages.

CardReturn/RetainFlag.Tellstheterminaltoeitherreturnor
retainthecardduringtheClosestate.
0returncardduringClosestate
1retaincardduringClosestate
ThisflagisignoredandthecardisalwaysreturnediftheFunction
IDisA,BorCandthecardisnotinthecardreaderattheclose
state.

M
SeeTableNote46

PrinterFlag.Tellstheterminalwhichprinterorprinterstouse.
0Donotprint
1Printonjournalprinteronly
2Printonreceiptprinteronly
3Printonreceiptandjournalprinter

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-54

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

4PrintonPPDiftheFunctionIDis1or7(Depositandprint).
5PrintonPPDandjournaliftheFunctionIDis1or7(Deposit
andprint).
8Printonstatementprinteronly
9Reserved
:Reserved
=PrintsidewaysonthereceiptprinteriftheFunctionIDisP
(PrintStatementandWait)orQ(PrintStatementandSetNext
State).
>orwIdentifiesaudiodataforavoiceguidedsession.
SeeTableNote61.
aStampchequeiftheFunctionIDis:(Processcheque).This
flagindicatesthatachequeistobestamped.Thedatafieldis
ignoredasthestampcontentisfixed.Thisflagisnotactionedifthe
chequeisejected.
bEndorsechequeiftheFunctionIDis:(Processcheque)orc
(ProcessMultipleCheques).Thisflagindicatesthatprintingtakes
placeonthereverseofachequeandrelatestocheque
endorsement.Thisflagisnotactionedifthechequeisejected.
IftheFunctionIDisBorC(Paralleldispense,ejectandprint),
NCRrecommendsthatyouuseonlyonejournalprintdatafield
andonereceiptprintdatafield.
Ifmultipleprinterflags4and/or5areusedinthesame
transactionmessage,onlythefirstprinterdatafieldwillbeprinted
onthedepository.
Ifprinterflagvalue8isusedinanyfunctionsotherthanPand
Q,thefollowingprinterdatafieldwillbeignored.Onlythefirst
printerdatafieldwithflagvalue8willbeacceptedinamessage.
Forsidewaysprintingonthereceipt,onlyoneprinterflagof=
willbeacceptedinthemessageforfunctionsPandQ.Ifprinter
flag=isusedinanyotherfunction,thefollowingprinterdata
fieldwillbeignored.
Ifprinterflags=and8arebothpresentinatransactionreply
alongwithFunctionIdPorQ,thefirstoftheseflags
encounteredinthemessagewillbeacceptedandprocessed.Itis
thereforerecommendedthatonlyoneoftheseprinterflagsis
presentinaPrintStatementandWaitorPrintStatementandSet
NextStatefunction.
Printerflags9and:areignored.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-55

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

Var(500)

PrinterDataField.Themaximumlengthofthisfielddependson
theamountofdatacompressionusedinthetransmitteddata,but
itisatleast500bytesofuncompressedprintdata.Inserteddatais
printedbytheprinterindicatedinthePrinterFlagfield.
Eachprinterdevicehasitsownrestrictions:
Textsenttoprintonthedepositorymustbe80charactersorless.
Textsenttoprintonthereceiptprintermustbe:
24linesorlessifprintinginnormalmode
49linesorlessiflocalconfigurationoptiondigit6Bisset
20linesorlessforsidewaysprintingonthereceipt.
Sidewaysprintingisnotsupportedforthejournalprinter.
Textsenttobeprintedsidewaysonthereceiptprintercanbeupto
amaximumwidthof80characters.
Thestatementprinterisconstrainedeithertothecompresseddata
lengthandtheoverallmessagelength,ortothelengthofpaper.
WhenusedwithprinterflagbforFunctionID:(Processcheque)
orFunctionIDc(ProcessMultipleCheques),thisfieldcontains
theendorsementprintdata(ASCIItext)forthecheque.
Whenusedwithprinterflagwor>(Identifyaudiodatafor
voiceguidance),thisfieldcontainstheaudioIDsubelement
referencetotheTextelementinthevoiceguidanceXML
configurationfile,andanydynamicaudiodatatobeincludedin
themessage.SeeTableNote61.
Ifthefirstcharacteris?,thetextisprintedinthealternative
format.Thealternativeformatcouldbenormal,bold,or
compressedtextdependingonthechequeprocessorvariant.
The?charactercanbeusedtoselecttheXFSPTRformtouse.
Theseformscanbeusedtomodifythetextformat.Fordetails,
refertotheAPTRAonlinehelpunderAPTRAXFS|
ProgrammersReference|XFSServiceProviders|XFSPTR
ServiceProvider.
Noescapesequencesorcontrolcodesaresupportedwithprinter
flagb.Ifnoendorsementdataissuppledwiththisflag,aSpecific
CommandRejectisreturned.

GS

SeeTableNote46

GroupSeparator.

PrinterFlag.Seefieldq.

Var(500)

PrinterData.Seefieldr.

GS

SeeTableNote46

GroupSeparator.

PrinterFlag.Seefieldq.

Var(500)

PrinterData.Seefieldr.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-56

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

GS

SeeTableNote46

GroupSeparator

v1

PrinterFlag.Seefieldq.

v2

Var(500)

PrinterData.SeeFieldr.
:

GS,v1andv2mayberepeateduptoninefurthertimes.SeeTableNote46.
:
FS

SeeTableNote48

FieldSeparator.

O
SeeTableNote48

BufferIdentifier.A4inthisfieldidentifiesthefollowingdataas
Track3data.

Var(106)

O
SeeTableNote48

Track3Data.ContainsthedatatobewrittenontoTrack3during
theCardWritestateorCardBeforeCashfunctioncommand.This
datareplacesanyexistingdataintheterminalsTrack3buffer.The
Track3dataconsistsofupto106charactersincludingthestartand
endsentinels.

FS

SeeTableNote48

FieldSeparator.

ak1

BufferIdentifierK.AvalueofKfortheBufferIdentifier
indicatesthatthefollowingfieldsdefinethenewTrack1datathat
istobewrittentothecard.

ak2

Var(78)

Track1Data.ThisfieldcontainsthedatatobewrittentoTrack1
duringtheCardWritestateorCardBeforeCashfunction
command.Thisdatareplacesanydataalreadyintheterminals
Track1buffer.TheTrack1dataconsistsofupto78characters.

FS

SeeTableNote48

FieldSeparator.

al1

BufferIdentifierL.AvalueofLfortheBufferIdentifier
indicatesthatthefollowingfieldsdefinethenewtrackdatathatis
tobewrittentothecard.

al2

Var(39)

Track2Data.ThisfieldcontainsthedatatobewrittentoTrack2
duringtheCardWritestateorCardBeforeCashfunction
command.Thisdatareplacesanydataalreadyintheterminals
Track2buffer.TheTrack2dataconsistsofupto39characters.

FS

SeeTableNote48

FieldSeparator.ReservedforExits

am1

VCdataIDM.
Fieldsam1/am2toar1/ar2arereservedforExitsuse.Thefirstfield
inthepairisadataidentifier,thesecondisavariablelengthbuffer.
ThedataidentifiershouldbeintherangeM(4DH)toR(52H).
ThefieldscanbeselectivelyMACed.Fordetails,seetheMessage
AuthenticationsectioninChapter 11,SecurityFeatures.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-57

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

am2

Var

VCdata
TheExitdata.ThedatafieldshouldnotcontaintheGroup
Separatorcharacter(1DH).

FS

SeeTableNote48

FieldSeparator.ReservedforExits

an1

VCdataIDN.

an2

Var

VCdata

FS

SeeTableNote48

FieldSeparator.ReservedforExits

ao1

VCdataIDO.

ao2

Var

VCdata

FS

SeeTableNote48

FieldSeparator.ReservedforExits

ap1

VCdataIDP.

ap2

Var

VCdata

FS

SeeTableNote48

FieldSeparator.ReservedforExits

aq1

VCdataIDQ.

aq2

Var

VCdata

FS

SeeTableNote48

FieldSeparator.ReservedforExits

ar1

VCdataIDR.

ar2

Var

VCdata

FS

SeeTableNote48

FieldSeparator.ReservedforExits

as1

SeeTableNote48

BufferIdentifierS

as2

SeeTableNote48

Cashhandlernumber(0or1)

as3

SeeTableNote48

1stcassettetypeinspecifiedcashhandler

as4

SeeTableNote48

Numberofbillstodispensefrom1sttype

as5

SeeTableNote48

2ndcassettetypeinspecifiedcashhandler

as6

SeeTableNote48

Numberofbillstodispensefrom2ndtype

as7

SeeTableNote48

3rdcassettetypeinspecifiedcashhandler

as8

SeeTableNote48

Numberofbillstodispensefrom3rdtype

as9

SeeTableNote48

4thcassettetypeinspecifiedcashhandler

as10

SeeTableNote48

Numberofbillstodispensefrom4thtype

...

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-58

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

asn

SeeTableNote48

Lastcassettetypeinspecifiedcashhandler

asn
+1

SeeTableNote48

Numberofbillstodispensefromlasttype

FS

SeeTableNote54

at1

SeeTableNote48

SmartcarddataID5

at2

Var

SeeTableNote48

Smartcarddata.FordatathatisspecifictoEMV/CAM2,thedata
willbeginwithCAM.Formoreinformation,refertotheEMV
IntegratedCircuitCard(ICC)ReferenceManual.Othersmartcard
customisationsmaybeginwithadifferentvalue.

FS

SeeTableNote54

ba1

SeeTableNote48

Cheque(s)DestinationBufferDataIDa

ba2

SeeTableNote48
andTableNote58

Cheque(s)destinationdata
1Depositchequeintopocket1
2Depositchequeintopocket2
3Depositchequeintopocket3
EEjectthecheque
Thehostcandeterminethenumberofpocketspresentby
retrievingtheHardwareConfigurationDataonlymessage.Ifthe
TransactionReplyspecifiesapocketwhichdoesnotexist,the
chequewillbecapturedtotherejectpocketandthecountforthe
rejectpocketwillbeupdated.IfaTransactionReplyissentthat
doesnotcontainoneoftheabovedestinationvalues(aninvalid
chequedestinationfield),aSpecificCommandRejectwitherror
codeB13UnrecognisedDocumentDestinationwillbereturned.
IftheTransactionReplydoesnotincludeendorsementprintdata
(seepage 1056),noendorsementdataisprintedandchequesare
senttopocket2(pocket1ifonlyonepocketisavailable).

FS

SeeTableNote54

bb1

ProcessMultipleChequesBufferDataIDb

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-59

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

bb2

SeeTableNote59

ChequeIdentifier.
Range000999
ReferstospecificchequesreportedintheTransactionRequest
message.Ifthisreferstoachequethatwasnotreportedinthe
TransactionRequestmessage,specificcommandrejectB34is
returned
Ifthisis000,thefollowingfieldsapplytoallchequesthatdonot
haveaspecificactiondefined
Ifthisbufferdoesnotincludeactionsforallchequesincludedin
theTransactionRequestmessage,eitherexplicitlyorwithasetting
of000,specificcommandrejectB34isreturnedandnoneofthe
chequesareprocessed
FordetailsofthespecificcommandrejectB34,seeTable 1036
SpecificCommandRejectValue/QualifierCombinationson
page 1087

bb3

SeeTableNote59

ChequeDestination
SpecifiesthedestinationforthechequeidentifiedbytheCheque
Identifierfield
00Returnchequetocardholder
01Depositchequeintopocket1
:
15Depositchequeintopocket15

bb4

SeeTableNote59

ChequeStamp
Specifieswhetherthechequeistobestampedifsupportedbythe
hardware
0Donotstampthecheque
1Stampthecheque

bb5

SeeTableNote59

Reserved
Mustbefilledwithzeros

bb6

Var

SeeTableNote59

ChequeEndorseText
Containsthetexttousewhenendorsingthecheque.Anyprint
dataprovidedforPrinterflagbisignored
Multiplelinesoftextcanbeprovidedwitheachlineseparatedbya
carriagereturn(0x0D)andlinefeed(0x0A)sequence
Ifthebunchchequeacceptordoesnotsupportmultiline
endorsement,thecarriagereturnandlinefeedcharactersare
removedandreplacedwithaspace(0x20)character

GS

SeeTableNote59

Groupseparator

FS

SeeTableNote60

Fieldseparator

bc

UsedforEMVdynamiccurrencyconversiontransactions.For
details,refertotheEMVICCReferenceManual.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-60

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Field

Number of
Characters

Mandatory/ Optional

Description

FS

SeeTableNote54

Fieldseparator

MessageAuthenticationCode(MAC)Data.Containsthe
transmittedvalueforauthenticationofthismessage.The
characterscanbe09,AF.

Var

Trailer.Protocoldependent.

TableNote46:Agroupseparatorandoptionalfieldss/t,u/v,
v1/v2andsoon,compriseagroup.Whenincludedinthemessage,
allfieldsofthegroupmustbepresent.Theremaybeuptothirteen
printfieldgroupswithinamessage.
TableNote47:WhendefiningtheTransactionReplymessagefora
chequeprocessor,themessagemustcontainoneorbothofprinter
flagsaorb.Ifneitherflagispresentallchequesaredepositedin
therejectbin.
TableNote48:Thefieldswandx,ae*,af*,ak*toat*
includingtheirfieldseparators,comprisegroups.Ifthefieldisnot
included,itsprecedingfieldseparatormustbeomitted.
TableNote49:Ahighernumberedtypecanbeomittedifno
dispenseofthattypeisrequested.
TableNote50:Itispossibletodispensefromasmanycassette
typesasarepresentinthecashhandler.
TableNote51:Thelengthofthisfieldisdependentonthesetting
ofEnhancedConfigurationoption76.Fordetails,seeOption76
CashHandlersonpage 717.ASpecificCommandRejectissentif
thefieldistoolong.
TableNote52:Themaximumnumberofnotesthatcanbe
dispensedisreportedintheHardwareConfigurationmessage.The
maximumnumberofnotesistakenfromtheserviceprovider
capabilityinformation.Anyrequestformorethan999notesis
rejectedasthisisabovethemessagereportingcapacity
TableNote53:TheTimeVariantNumber,lengtheightbytes,is
presentiftheMACflagsettingsarecorrect.Otherwise,theMessage
SequenceNumber,lengththreebytes,isoptionallypresent.For
details,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
TableNote54:ThefieldseparatorandMACdatafieldyare
presentiftheDataSecurityfeatureisselected,andtheMACflag

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-61

Central to Terminal Messages


Transaction Reply Command

settingsarecorrect.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
TableNote55:Thisgroupseparatorshouldonlybeincludedifa
coindispenseisrequired.
TableNote56:Fieldj1mustbepresentiftheprecedinggroup
separatorisincluded.However,highernumberedhoppersmaybe
omittedifnodispensefromthesehoppersisrequired.Thetotal
numberofcoinsdispensedmustnotexceed25.
TableNote57:Themaximumnumberofcoinsthatcanbe
dispensedisreportedintheHardwareConfigurationmessage.The
maximumnumberofcoinsistakenfromtheserviceprovider
capabilityinformation.Anyrequestformorethan999coinsis
rejectedasthisexceedsthemessagereportingcapacity.
TableNote58:Themessageformatcanalsosupportdestinations
4through9todepositthechequeintochequeprocessorbins4
through9;andathroughftodepositthechequeintocheque
processorbins10through15.AdvanceNDCdoesnotsupportthese
destinations.
TableNote59:Fieldsbb2tobb6arerepeatedforeachcheque,and
thedetailsforeachchequeareseparatedbyaGroupSeparator.
Detailsforthechequeswithinasinglecurrencycanbeprovidedin
anyorder,thatisthechequedetailsareprovidedasanunordered
list.Thelastchequedoesnothaveagroupseparatorfollowingthe
data.Fieldbb2correspondstotheChequeIdentifierusedinthe
TransactionRequestmessage.
TableNote60:Thefieldseparatorisrequiredonlyifthefollowing
fieldispresent.
TableNote61:Thevoiceguidancedataisplayedaftersuccessful
processingofthetransactionreplyfunctionandbeforemovingto
thenextstatespecifiedinthetransactionreplymessage.Ifthe
transactionreplyprocessingfails,forexample,becauseofa
dispenserfault,resultinginasolicitedstatussenttothehost,voice
datafromtheoriginaltransactionreplymessageisdiscarded.If
alternativevoicedataisrequired,thehostmustsenditinthe
subsequenttransactionreplymessage.

TerminalFunctionsfor
TransactionCompletion

10

FieldloftheTransactionReplycontainsaFunctionIdentifier.This
tellstheterminalwhatfunctionsaretobeperformedtocomplete
thetransaction.Thefunctionsareasfollows:

DepositandPrint(Table1016onpage1063)
DispenseandPrint(Table1017onpage1064)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-62

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

DisplayandPrint(Table1018onpage1065)
PrintImmediate(Table1019onpage1066)
SetNextStateandPrint(Table1020onpage1066)
NightSafeDepositandPrint(Table1021onpage1067)
CardBeforeCash(Table1022onpage1067)
ParallelEject/DispenseandPrint(Table1023onpage1069)
CardBeforeParallelDispenseandPrint(Table1024onpage
1070)
PrintStatementandWait(Table1025onpage1071)
PrintStatementandSetNextState(Table1026onpage1071)
RefundNotesandPrint(Table1027onpage1072)
DepositNotesandPrint(Table1028onpage1073)
DepositNotesandWait(Table1029onpage1073)
ProcessCheque(Table1030onpage1074)
ProcessMultipleCheques(Table1031onpage1075).

Notethatdispensefunctionsmayhaveslightlydifferentbehaviour
ifaspraydispenserispresent.Thisisbecausethespraydispenser
sendseachnotestraightintoareceivingpocketinsteadofstacking
andpresentingthemasastandarddispenserdoes.Also,thereisno
possibilityofretractingnotesdispensedbyaspraydispenser.
Thefollowingtablesillustratethesequenceofevents,andrelated
screendisplays,foreachofthesefunctions.
Table 10-16
Deposit and Print
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)
TransactionReplyCommand
Screen
(INSERTENVELOPE)

Presentenvelope.SeeTableNote62
Enabledepository.
Startslowbeep.SeeTableNote63.
Switchonmediaentryindicator.
Waitforcardholdertoinsertenvelope.
Stopbeeping.
(EnterTimeOutstateiftimer04expires.
SeeTableNote64andTableNote65).
Printonenvelope.
Printonreceiptandjournaltodefinedlevel.
Sendstatus.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-63

Central to Terminal Messages


Transaction Reply Command
State

Screen

Operation

NextStatein
TransactionReply
Command

NextStateScreen
(forexample,SELECT
TRANSACTION)

Switchoffmediaentryindicator.

EventualClosestate

CloseScreen
(forexample,TAKECARD)

Waitforcardtobetakenorcaptured.
Capturecardiftimer09expires.
SeeTableNote65.

Cutanddeliverreceiptifnecessaryandejectcard.
Timer02
SeeTable
Note66.

TableNote62:Anenvelopeispresentedonlyifanenvelopehas
notpreviouslybeendispensedduringtheEnvelopeDispenserState.
Fordetails,seeCEnvelopeDispenserStateonpage 214
TableNote63:Ifthebeeperisnotrequired,localconfiguration
optiondigit2Ccanbesettostopitsoperation.Fordetails,referto
theAPTRAAdvanceNDC,SupervisorsGuide.
TableNote64:TheCancelkeyisactivewhentheInsertEnvelope
screenisdisplayed.PressingtheCancelkeycausesatimeoutstatus
tobesenttoCentral.
TableNote65:Fordetailsoftimers,seetheConfiguration
ParametersLoadsection.
TableNote66:Timer02(page 723)isusedtodeterminethelength
oftimethattheClosescreenisdisplayed.
Table 10-17
Dispense and Print
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)

Dispensetherequestedcashand
coins.
SeeTableNote67

TransactionReplyScreen
(TAKECASH)

Printonreceiptandjournalto
definedlevel.
Sendstatus.

NextStatein
TransactionReply
Command

Timers
(07+10)
or
(05+07)
SeeTable
Note68

NextStateScreen
(forexample,SELECT
TRANSACTION)

TableNote67:Adispensecanconsistofnotesonly,coinsonly,ora
combinationofnotesandcoins.Ifthedispenseincludesa

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-64

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

combinationofnotesandcoins,thenotesmustbesuccessfully
dispensedbeforethecoinsaredispensed.
TableNote68:Iftheterminalisconfigurednottoretractnotes,
timers07(page 724)and10(page 725)areusedtocontrolthe
minimumlengthoftimeforthetransaction,withtimer05ifbeeping
isactive.Fordetailsofconfigurationoptions,refertotheAPTRA
AdvanceNDC,SupervisorsGuide.
Iftheterminalisconfiguredtoretractnotes,timer05(page 723)is
usedifbeepingisactive,thentimer07.Timer05isstartedwhen
notesarepresented;ifitexpiresbeforethenotesaretaken,aretract
isattempted.
Ifsomenotesareretracted,thePresenterErrormessageislogged
tothejournal,andanunsolicitederrorisreportedtoCentral.For
details,seetheCashHandler(Solicited/Unsolicited)sectionin
Chapter 9,TerminaltoCentralMessages.
Ifthenotesaretakenbeforetheexpiryoftimer05(page 723),itis
cancelled.
Ifthelocalconfigurationoptionisselected,thebeeperissounded
duringthetimethattimer05isinuse.Fordetailsofconfiguration
options,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
Timer07(page 724)isstartedafternoteshavebeentakenandthe
nextstateisenteredonexpiry.
Fortimerformatinamessage,seeConfigurationParameters
Loadonpage 1014.
Table 10-18
Display and Print
State

Screen

Operation

TransactionRequest

TransactionReplyScreen
(forexample,DISPENSE
ERROR)

Printonreceiptandjournalto
definedlevel.
Sendstatus.

NextStatein
TransactionReply
Command

Timer
(10+07)
or
(07)
SeeTable
Note69.

NextStateScreen
(forexample,SELECT
TRANSACTION)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-65

Central to Terminal Messages


Transaction Reply Command

TableNote69:Onaterminalconfigurednottoretractnotes,timers
10and07areusedasshown.
Onaterminalconfiguredtoretractnotes,timer07(page 724)is
used.
Fordetailsofthetimerformatinamessage,seeConfiguration
ParametersLoadonpage 1014.
Fordetailsofconfigurationoptions,refertotheAPTRAAdvance
NDC,SupervisorsGuide.

Table 10-19
Print Immediate
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)

Printonreceiptandjournaltodefinedlevel.
WaitforanotherTransactionReplycommand.

PrintImmediatemayalsobereceivedatothertimes.Fordetails,see
theMessagesReceivedinWrongOperationalModesectionon
page 1094.
Table 10-20
Set Next State and Print
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)

Printonreceiptandjournalto
definedlevel.
Sendstatus.

NextStatein
TransactionReply
Command

NextStateScreen

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-66

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command
Table 10-21
Night Safe Deposit and Print
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)

Unlocknightsafe.
Startslowbeep.

TransactionReplyCommand
Screen
(INSERTBAG)
SeeTableNote70

Waitforcardholdertoinsertbag.
Stopbeeping.
(EnterTimeOutstateiftimer08expires
SeeTableNote71).
Printonreceiptandjournaltodefinedlevel.
Sendstatus.

Nextstatein
TransactionReply
Command

NextStateScreen
(forexample,Transaction
State)

TableNote70:TheCancelkeyisactivewhentheInsertBag
screenisbeingdisplayed.PressingtheCancelkeycausesan
undetecteddepositstatustobesenttoCentral.
TableNote71:Timer08(page 724)isstartedwhenthenightsafe
doorisunlockedtoacceptanightsafedeposit.
Table 10-22
Card Before Cash
State

Screen

Operation

TransactionRequest
SeeTableNote72.

TransactionRequestScreen
(PLEASEWAIT)

Ejectcard.
SeeTableNote73.

TransactionReplyScreen1
(TAKECARD)

Waitforcardtobetaken.
(Capturecardiftimer09expires)

TransactionReplyScreen2
(PLEASEWAITFORCASH
ANDRECEIPT)

Dispensetherequestedcashandcoins.
SeeTableNote73andTableNote75.
Printonreceiptandjournaltodefinedlevel.
Sendstatus.
Cutanddeliverreceiptifnecessary.

ClosescreenTableEntry2
(TAKERECEIPTAND
CASH)
or
TableEntry4
(TAKECASH)

Timer02
(Determinesthelengthoftimethat
theClosescreenisdisplayed).

Close

Countand
stackcash

TableNote72:InnormalusagethenextstateisalwaysClose.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-67

Central to Terminal Messages


Transaction Reply Command

TableNote73:Track3updatecantakeplacebeforecardejectif
newTrack3dataiscontainedinthetransactionreplymessage.
TableNote74:Adispensecanconsistofnotesonly,coinsonly,ora
combinationofnotesandcoins.Ifthedispenseincludesa
combinationofnotesandcoins,thenotesmustbesuccessfully
dispensedbeforethecoinsaredispensed.
TableNote75:Foraterminalconfiguredfornoteretraction,timer
05(page 723)isstartedafterthecashhasbeendispensed.Timer05
isalsousedforbeepinginCardBeforeCashtransactionswherethe
SSTisconfigurednottoretractnotes.Fordetailsofconfiguration
options,seetheAPTRAAdvanceNDC,SupervisorsGuide.
OnSSTswithcashretractenabled,ifthenoteshavenotbeentaken
whenthistimerexpires,retractionisattempted.Ifsomenotesare
retracted,thePresenterErrormessageisloggedtothejournaland
anunsolicitederrorisreportedtoCentral.Fordetails,seetheCash
Handler(Solicited/Unsolicited)onpage 986.Ifthenotesaretaken
beforethetimerexpires,thetimeriscancelled.Inbothcases,timer
07page 724)isstarted,andthenextstateisenteredonexpiry.For
detailsoftimers,seetheTimerssectiononpage 722ofChapter 7,
ConfigurationParameters.
Iflocalconfigurationoptiondigit2BissetattheSST,thebeeperis
soundedduringthetimethattimer05isoperative.Fordetails,see
theAPTRAAdvanceNDC,SupervisorsGuide.
TableNote76:WhenthenoretractoptionissetinaCardBefore
Cashtransaction,therecommendedminimumvalueoftimer07is5
seconds.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-68

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command
Table 10-23
Parallel Eject/Dispense and Print (Fast
Cash)
State

Screen

Operation

TransactionRequest
SeeTableNote77

TransactionRequestScreen
(PLEASEWAIT)

ParallelEject/DispenseandPrint.
SeeTableNote79,TableNote80andTableNote82

TransactionScreen
(TAKECARDANDCASH)

Printreceiptandjournaltodefinedlevel.
Sendstatus.
SeeTableNote81.
Cutanddeliverreceiptifnecessary.

CloseScreenTableEntry2
(ANDRECEIPT)
or
TableEntry4
(NULL)
SeeTableNote78

Waitforcardtobetakenorcaptured,
ifnotalreadytaken.

Close

Timer02
SeeTable
Note83.

TableNote77:InnormalusagethenextstateisClose.
TableNote78:NCRrecommendsthattheClosescreensaddtextto
theTransactionReplyscreenratherthanclearthescreen.
TableNote79:Followingtheparalleleject/dispenseandprint,
timers05and07arestarted.Fordetailsoftimers,seethe
ConfigurationParametersLoadsection.Ifthetotaltimeout
periodexpiresbeforethecashistakenaretractisattempted.Ifsome
notesareretractedthePresenterErrormessageisloggedtothe
journal,andanunsolicitederrorisreportedtoCentral.Fordetails,
seetheCashHandler(Solicited/Unsolicited)sectioninChapter 9,
TerminaltoCentralMessages.Ifthenotesaretakenbeforethe
timerexpires,itiscancelledandthenextstateisentered.Ifthelocal
configurationoptionisselected,thebeeperissoundedwhilsttimer
07isinuse.Fordetailsofconfigurationoption,seetheAPTRA
AdvanceNDC,SupervisorsGuide.
TableNote80:AtransactionthatusestheParallelEject/Dispense
andPrintreplyiscommonlyreferredtoasaFastCashtransaction.
ToachieveoptimumperformancewithaFastCashtransaction,this
replyshouldbeusedtogetherwiththeTCardReadPINEntry
InitiationStatedescribedinChapter2.
TableNote81:Printerandcardreadererrorsarereportedas
unsolicitedstatusmessages.Adispenseerrorisreportedbya
solicitedstatusmessagetogiveCentraltheoptionofprintingan
errorreportordisplayinganerrorscreen.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-69

Central to Terminal Messages


Transaction Reply Command

TableNote82:Adispensecanconsistofnotesonly,coinsonly,ora
combinationofnotesandcoins.Ifthedispenseincludesa
combinationofnotesandcoins,thenotesmustbesuccessfully
dispensedbeforethecoinsaredispensed.
TableNote83:Timer02isusedtodeterminethelengthoftimethat
theClosescreenisdisplayed.
Table 10-24
Card Before Parallel Dispense and Print
State

Screen

Operation

TransactionRequest
SeeTableNote84

TransactionRequestScreen
(PLEASEWAIT)

Waitfortransactionreply

TransactionReplyScreen1
(TAKECARD)

Ejectcard.
Waitforcardtobetaken.
(Capturecardiftimer09expires)
Sendstatusiffailureandabort(seeTableNote87).
Otherwisecontinue.

SeeTableNote85

TransactionReplyScreen2
(PLEASEWAITFORCASH
ANDRECEIPT)

Stackanddispensecash,andprintfullreceiptdata,
butonlycutthereceiptifaformfeedissentora
completepage(24or49lines)hasbeenprinted.
Sendstatusiffailureandabort.
Sendstatus.
SeeTableNote88.

Close

CloseScreen
SeeTableNote86

Cutanddeliverreceiptifnecessary.

TableNote84:Innormalusage,thenextstateisaClose.
TableNote85:Adispensecanconsistofnotesonly,coinsonly,ora
combinationofnotesandcoins.Ifthedispenseincludesa
combinationofnotesandcoins,thenotesmustbesuccessfully
dispensedbeforethecoinsaredispensed.
TableNote86:NCRrecommendsthattheClosescreensdonot
clearthescreenbutsimplyaddtexttotheTransactionReplyscreen.
TableNote87:Printerandcardreadererrorsarereportedas
solicitedstatusmessages.Adispenseerrorisreportedbyasolicited
statusmessagetogiveCentraltheoptionofprintinganerrorreport
ordisplayinganerrorscreen.
TableNote88:Followingthecardeject,dispenseandprint,timers
05and07arestarted.Ifthetotaltimeoutperiodexpiresbeforethe
cashistaken,aretractisattempted,thePresenterErrormessageis
loggedtothejournalandanunsolicitederrorwillbereportedto
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-70

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command

Centralifthelocalconfigurationoptiontodelaystatusreportingis
notset.
Ifthenotesaretakenbeforethetimersexpire,theyarecancelled
andthenextstateentered.Fordetailsoftimers,seeTimerson
page 722.
Ifthelocalconfigurationoptiontosoundthebeeperissetandthe
noretractoptionisnotset,thebeeperwillbesoundedduringthe
timethattimers05plus07areoperative.
Fordetailsoflocalconfigurationoptions,refertotheAPTRA
AdvanceNDC,SupervisorsGuide.
Table 10-25
Print Statement and Wait
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)
TransactionReplyScreen
(STATEMENTBEING
PRINTED)

Printonstatementorprintsidewaysonreceipt
printerandjournaltodefinedlevel.
Sendstatus(statementprinterorreceiptprinterif
printingsidewaysonthereceipt).
WaitforanotherTransactionReplycommand.

Note:Alocalconfigurationoption(optiondigit3C)canbesetto
enabletheCancelkeyonthecardholderkeyboard.Fordetails,see
theAPTRAAdvanceNDC,SupervisorsGuide.
Table 10-26
Print Statement and Set Next State
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)

PrintonStatementorprintsidewaysonreceipt
printer.

TransactionReplyScreen
(TAKESTATEMENT)

Printonreceiptandjournalto
definedlevel.
Sendstatus(statementprinteror
receiptprinterifprintingsidewayson
thereceipt)

NextStatein
TransactionReply
Command

Timer96
SeeTable
Note89.

NextStateScreen

TableNote89:Timer96isusedonlyintheprintstatementand
continuefunctionandisstartedwhetherornotastatementisbeing
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-71

Central to Terminal Messages


Transaction Reply Command

delivered.Whenthetimerexpires,thenextstatespecifiedbythe
TransactionReplycommandisentered.
Table 10-27
Cash Acceptor Refund and Set Next State
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)

Attempttomovenotesfromthe
escrowtotherefundslot.
SeeTableNote90

TransactionReplyScreen
(PLEASEREMOVENOTES
FROMREFUNDSLOT)
SeeTableNote91

Waitfornotestoberemovedfrom
therefundslot.
Ifspecified,printonreceiptand
journaltodefinedlevel.
Sendstatusasfollows:
Ifanerroroccursbeforethenotesare
presented,sendasolicitedmessage.
IfanerroroccursorTimer78expires
afterthenotesarepresentedand
beforethenotesareremoved,either
retractthenotesiftheretractoptionis
setandsendanunsolicitedmessage,
orjustsendanunsolicitederror
messagetoCentral.
SendaReadymessagewhenthe
notesaresuccessfullypresented.

NextStatein
TransactionReply
Command

Timer78

NextStateScreen

TableNote90:Ifinsertedcashisdepositeddirectlytothecassettes,
thenotescannotberefunded.Inthissituation,asolicitedstatus
message(w5)reportsthattheescrowisempty.
TableNote91:IfthescreenreferencedintheTransactionReply
onlycontainsnestedscreens,thefirstnestedscreenisdisplayed
whenthenotesarepresented;andthesecondnestedscreenis
displayedwhenthenotesarebeingretracted(ifthecustomerhas
nottakenthenotesandAdvanceNDChasbeenconfiguredto
retractthenotes).IfthescreenreferencedintheTransactionReply
containsmorethannestedscreens,itisfullydisplayedwhenthe
notesarepresented.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-72

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Transaction Reply Command
Table 10-28
Cash Acceptor Encash
State

Screen

Operation

Transaction
Request

TransactionRequestScreen
(PLEASEWAIT)
TransactionReplyScreen
(YOURCASHISBEING
DEPOSITED)SeeTable
Note92andTableNote93

Attempttomovethenotesfromtheescrowtothecash
depositbin(encash).Ifcashhasbeendepositeddirectly
tothecassettes,thisisalogicaloperationonly:no
physicalmovementofnotestakesplaceastheoperation
isalreadycomplete.
Ifspecified,printonreceiptandjournaltodefinedlevel.
Thisisnormallydoneaftertheencashoperation.
Sendstatusasfollows:
Ifanerroroccurssendasolicitedmessage.
IfthenotesaresuccessfullydepositedSendaReady
message.UnsolicitedmessagescanaccompanytheReady
messagewhenathresholdorcassetteerroroccursduring
thesuccessfulencash
WaitforanotherTransactionReplycommand.

Table 10-29
Cash Acceptor Encash, Print and Set Next
State
State

Screen

Operation

Transaction
Request

TransactionRequestScreen
(PLEASEWAIT)
TransactionReplyScreen
(YOURCASHISBEING
DEPOSITED)SeeTable
Note92andTableNote93

NextStatein
TransactionReply
Command

Attempttoencashthenotes.Ifcashhasbeendeposited
directlytothecassettes,thisisalogicaloperationonly:no
physicalmovementofnotestakesplaceastheoperation
isalreadycomplete.
Ifspecified,printonreceiptandjournaltodefinedlevel.
Thisisnormallydoneaftertheencashoperation.
Printonstatementorprintsidewaysonreceiptprinter.
Sendstatusasfollows:
Ifanerroroccurs,sendasolicitederrormessage.
Ifnotesaresuccessfullydeposited,setthenextstateand
sendaReadymessagetoCentral.
UnsolicitedmessagescanaccompanytheReadymessage
whenathresholdorcassetteerroroccursduringthe
successfulencash

NextStateScreen

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-73

Central to Terminal Messages


Transaction Reply Command

TableNote92EnhancedConfigurationParameteroption44canbe
usedtojournaltheencashcountsintheusualstatusmessageformat
whenevertheReadymessageissent.
TableNote93Ifconfiguredintheregistry,thetransactionreply
printdatawillbeprintedwhilenotesarebeingmovedtothe
cassettes,otherwiseitwillbeprintedaftertheDepositoperationis
completed.Fordetailsoftheregistrysetting,
DoParallelEncashPrint,refertotheAPTRAAdvanceNDC
DevelopersGuide.
Table 10-30
Process Cheque
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)
TransactionReplyScreen
(YOURCHEQUEISBEING
PROCESSED)

NextStatein
TransactionReply
Command

Endorsecheque,andattempttomove
chequetobin1,2or3.Cheque
stampingisnotsupportedby
AdvanceNDC.
Sendstatus:
Ifthechequeissuccessfully
processed,sendaReady9messageto
Central.
Ifchequeisejected,butnottaken,
retaininbin2andsendunsolicited
errormessagetoCentral.

NextStateScreen

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-74

APTRA Advance NDC, Reference Manual

Timer94

Central to Terminal Messages


Transaction Reply Command
Table 10-31
Process Multiple Cheques
State

Screen

Operation

TransactionRequest

TransactionRequestScreen
(PLEASEWAIT)
TransactionReplyScreen
SeeTableNote94

NextStatein
TransactionReply
Command

Chequehandlingisspecifiedbythe
contentofbufferbinthe
TransactionReplymessage,as
follows:

Returnallchequestothe
cardholderwithoutendorsingor
stampinganycheque

Depositallcheques,stampedand
endorsed

Returnallchequestothe
cardholder,stampedand
endorsed

Selectivelyreturnordeposit
cheques,controlstampingand
endorsementindividuallyfor
eachcheque.Adefaultactioncan
bedefinedforallchequeswhere
aspecificactionisnotdefined
Ifchequesareejected,butnottaken,
retractandretainthemandsend
messagetoCentralasfollows:

Ifmultiplebunchesmustbeused
toreturnallchequesandcheques
areretractedbeforeallhavebeen
presented,sendasolicitederror
message

Ifchequesareretractedafterall
chequeshavebeenpresentedand
thestatusmessagehasalready
beensent,sendanunsolicited
messagetoindicatethatthe
chequeshavebeenretracted

Iftheretractedchequesjam
beforereachingtherejectbin,
sendanunsolicitederror
messagetoreportajam

Timer94

NextStateScreen

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-75

Central to Terminal Messages


Transaction Reply Command

TableNote94:ScreenreferencedbytheTransactionReplymust
containonlynestedscreens.Thescreensdisplayasfollows:

Nestedscreen1(TRANSACTION RESULTandPLEASE WAIT)


Nestedscreen2(PLEASE REMOVE CHEQUES)
Nestedscreen3(PLEASE WAIT FOR MORE CHEQUES)
Nestedscreen4(CHEQUES BEING RETRACTED).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-76

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Interactive Transaction Response

InteractiveTransactionResponse

10

ThismessagemaybesentinresponsetoaTransactionRequestin
ordertoobtainmoreinformationfromthecardholder.Thisfacility
allowsCentraltocommunicatedirectlywiththekeyboardand
displayinthosesituationswherestatetablesequencingis
inappropriate.Forexample,acardholderaccountselectioncanbe
handledinthisway.Centralcanestablishwhichaccountsare
availabletothecardholderandbuildthescreenaccordingly.The
messagedefinesscreendataandactivekeys.Keydataisreturnedin
aTransactionRequestmessage.Fordetails,seetheTransaction
RequestMessagessectioninChapter 9,TerminaltoCentral
Messages.
TheterminalmaysupportTouchScreenFDKEmulationinsteadof
regularFDKs.Inthiscase,eightfixedtouchareasaredefinedon
screen,whichthecardholdertouchesinsteadofpressingthe
correspondingFDK.Thetouchareasareenabled/disabledinexactly
thesamewayastheFDKs.Fordetails,seetheFDKEmulation
sectioninChapter 4,KeyboardDataandLayouts.
Alternatively,theterminalmaysupportfulltouchscreen
keyboards.Inthiscase,touchareasaredefinedonthescreenforall
therequiredkeys.Thecardholdertouchestheseinsteadofpressing
akeyonthekeypadoranFDK.Fordetails,seeChapter 4,
KeyboardDataandLayouts.
Inavoiceguidedsession,Centralcansendamessagewithoneof
twoformatsusedinfieldj,asfollows:

DirectAudioTextformat.
Thetexttobespokenisincludedinthefield.Thetextmustnot
containspecialcharacters,suchasscreencontrolcharacters.The
specifiedtextisnotrepeated.Torepeatthetext,itmustbe
repeatedinthisfield.Fieldiisnotadjustedforavoiceguided
session.

IndirectAudioTextformat.
ThetexttobespokeniscontainedinthevoiceguidanceXML
configurationfileandreferencedfromthisfield.Thetext
specifiedintheXMLfileisnotrepeated.Torepeatthetext,
multipleTextelementsmustbeusedortherecordedvoicefile
mustcontainrepeatedaudiomessages.Fieldiisadjustedas
specifiedintheXMLconfigurationfile.FordetailsoftheXML
configurationfile,refertotheAPTRAAdvanceNDC,Developers
Guide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-77

Central to Terminal Messages


Interactive Transaction Response
Table 10-32
Interactive Transaction Response
Field

Number of
Characters

Mandatory/Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
3DataCommand

ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.

FS

FieldSeparator.

LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuseand
isignoredbytheterminal.

FS

FieldSeparator.

MessageSequenceNumber.Thisfieldisincludedforfutureuseandis
ignoredbytheterminal.

FS

FieldSeparator.

MessageSubClass.Themessagesubclassis:
2InteractiveTransactionResponse

DisplayFlag.Thisonecharacterfieldinstructstheterminaldisplayas
follows:
0donotdisplaycardholderkeyboardentry
1displaycardholderkeyboardentry
2display*forcardholderkeyboardentry
ThekeyedresponseisstoredinGeneralPurposeBufferB(minimum
datalength1character),whichistheonlybufferincludedina
TransactionRequestmessagefollowingtheInteractiveTransaction
Response.
FormoreinformationongeneralpurposebuffersrefertotheAPTRA
AdvanceNDC,DevelopersGuide.

Var(10)

ActiveKeys/TouchAreas.Thisisavariablelengthfieldwhich
activatestherequiredkeysortouchareasforcardholderresponsesas
follows:
0deactivatekeys/touchareas
1activatekeys/touchareas
Thefirstcharacterofthisfieldeitheractivatesordeactivatesall
numerickeys.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-78

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Interactive Transaction Response

Field

Number of
Characters

Mandatory/Optional

Description
Char

All Numeric Keys

Numerickeysactivator(09)

Thenextninecharacterseitheractivateordeactivatethefunction
keysortouchareasasfollows:
Char

Function Keys or Touch Areas

FDKA/FDKAtouchareaandEnterKey

FDKB/FDKBtoucharea

FDKC/FDKCtoucharea

FDKD/FDKDtoucharea

CancelKeyE

FDKF/FDKFtoucharea

FDKG/FDKGtoucharea

FDKH/FDKHtoucharea

10

FDKI/FDKItoucharea

Trailing0charactersmaybeomittedfromthisfield.
Note: IfnumerickeysareactiveandFDKAisalsoactive(orFDKIif
theoptionenablingthekeystotheleftofthecardholderscreenisset),
theEnterkeywillbeactiveandequivalenttoFDKAorFDKI.
Duringavoiceguidedsession,theFDK,numeric,Clear,Canceland
Enterkeyscanbeused.Ifthismessageindicatesthatoneormore
FDKsareactive,theactiveFDKsaremappedtothenumerickeyboard
asfollows:
FDK

Numeric Key

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-79

Central to Terminal Messages


Interactive Transaction Response

Field

Number of
Characters

Mandatory/Optional

Description

IfthismessagedefinesbothFDKsandnumerickeysasactive,this
mappingisnotdoneandtheFDKsmustbeusedduringthe
voiceguidedsession.
FS

FieldSeparator.

ScreenTimerField.Thisthreecharacterfieldcontainsthetimeout
intervalsfromthecardholderscreendisplay.Thevalidrangeis
001255ticks,togiveatimeoutfrom0.8to204seconds.Entering000
givesindefinitedisplay.Ifthetimerexpires,acodeofTisstoredin
thebufferandaTransactionRequestmessageissent.

FS

FieldSeparator.

j1

Var

ScreenDataField.Thisisavariablelengthfieldthatrepresentsdatato
bedisplayedonthescreen.
Duringavoiceguidedsession,thecontentofthisfielddependsonthe
formatused,asfollows:

DirectAudioTextformatthisfieldcontainsaudiodatatousein
placeofthescreendisplaydata.Thedataistreatedasastringto
bespoken,nothingisdisplayedontheSSTscreen.Thisfieldmust
containthetexttobespoken,andnotreferenceanyaudioID
subelementsinthevoiceguidanceXMLconfigurationfile.No
specialcharacterscanbeusedinthetext.

IndirectAudioTextformatthisfieldcontainsdynamicaudio
datawithscreennumberandanyotheroptionalscreendata.The
ScreenDataFieldmustcontainareferencetoabasescreenwith
anyotheroptionalscreendataanddynamicvoicedata.Thebase
screenbeingupdatedmustincludeplaceholdertagsto
accommodatethedynamicaudioplaceholderdata.Theremustbe
acorrespondingaudioIDsubelementdefinedinthevoice
guidanceXMLconfigurationfile.
FordetailsofthevoiceguidanceXMLconfigurationfile,refertothe
APTRAAdvanceNDC,DevelopersGuide.

GS

GroupSeparator.

j2

Var

ScreenUpdateDataField.Thismustbepresentiftheprecedinggroup
separatorispresent.Thisfieldrepresentsdatawhichisdisplayedon
theSSTscreenwhentheDirectAudioTextformatisused.

Var

Trailer.Protocoldependent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-80

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


EJ Commands

EJCommands

10

ThissectioncontainsdetailsoftheEJCommands:

EJOptionsandTimers
AcknowledgeEJUploadBlock
AcknowledgeandStopEJ

Theformatandcontentofeachcommandisdescribedinthe
followingpassages,alongwithanexplanationofcontinuousand
batchuploadmethods.
Note:IftheEJisnotconfigured,anyEJcommandssentwillbe
rejectedwithacommandreject.
FordetailsoftheSSTtoCentraluploadmessage,seetheUploadEJ
DataMessageinChapter 9,TerminaltoCentralMessages.

EJOptionsandTimers

10

ThiscommandmaybesentbyCentralatanytimetoenable
electronicjournalupload,andtospecifytheoptionsandtimer
valuestobeused.Itmayalsobesentafterreceivingapowerfail
messagefromtheSSTtoreinstatetheEJuploadfeature.

Table 10-33
EJ Options and Timers
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
6ElectronicJournal

FS

FieldSeparator

FS

FieldSeparator

FS

FieldSeparator

CommandType.Thecommandtypeis:
3OptionsandTimers

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-81

Central to Terminal Messages


EJ Commands

Field

Number of
Characters

Mandatory/ Optional

Description

OptionNumber.Possiblevaluesare:
Option60EJUploadBlockSize.Maximumsizeofthedataportionof
theEJUploadblock.Fordetails,seetheUploadEJDataMessage
sectioninChapter 9,TerminaltoCentralMessages.
Option61RetryThreshold.Thenumberofattemptstosuccessfully
sendanEJUploadblockbeforetheEJisautomaticallydisabled.
SeeTableNote95.

OptionValue.
ForOption60,thevaluerangeis001350.Defaultis200.
ForOption61,thevaluerangeis000999.Defaultis000(infinite
retries).

Fieldsdandearerepeatedifbothoptionsarebeingsentinthesamemessage.Nofieldseparatorisrequired
betweenoptions,butafieldseparatorismandatorybeforefieldf,TimerNumber.
FS

FieldSeparator.

TimerNumber.Possiblevalueis:
Timer60EJAcknowledgementTimer.Maximumtimeinsecondsto
waitforanacknowledgementmessagefromCentralbeforeresending
theblock.

TimerValue.
Range000255.Defaultis255,000isinfinite.

TableNote95:IfthevaluesentforOption60isoutofthepossible
range,thesafetyvalueof350issubstituted.Thesafetyvaluesfor
Option61andTimer60arethesameasthedefaultvalues.

AcknowledgeEJUpload
Block

10

ThiscommandshouldbesentbyCentraleachtimeablockof
electronicjournaldataisreceivedfromtheSST.Itcanalsobesent
unsolicitedatanytimetoenabletheEJuploadfunction.Ifthis
commandisusedtoenableEJuploadinsteadoftheEJOptionsand
Timerscommand,thenthedefaultoptionandtimervalueswillbe
used.
IfaftersendinganEJblocktoCentral,theSSTdoesnotreceivean
acknowledgementwithinthespecifiedtime,theSSTwillsendthe
blockagain.Onreceiptoftheacknowledgementmessageforthe
finalEJdatablocktobesent,theSSTwillerasetheacknowledged
datafromitsejdata.logfile.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-82

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


EJ Commands
Table 10-34
Acknowledge EJ Upload Block
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
6ElectronicJournal

FS

FieldSeparator

FS

FieldSeparator

FS

FieldSeparator

CommandType.Thecommandtypeis:
1AcknowledgeUploadBlock
SeeTableNote97

LastCharacterReceived.Range000000999999.
SeeTableNote96.
ThevalueinthisfieldshouldbethesameasthevalueintheLast
CharacterThisBlockfieldinthelastUploadEJDatamessagesentby
theSST(seepage 978).
IftheLastCharacterReceivedisnotequaltothevalueoftheLast
CharacterThisBlockinthelastuploadblocksentbytheSST,andifEJ
uploadisinprogress,theSSTwillnotcountthisasan
acknowledgment,andwillcontinuetowaitforanacknowledgment
withoutresettingitstimer.IftheLastCharacterReceivedfield
contains000000thenAdvanceNDCwillresendthelastblockagain.

TableNote96:TheLastCharPreviousBlockandLastCharThis
Blockvaluesarebasedonamodulus1,000,000charactercount
whichstartsatzerofollowingacoldstartoftheSST.Thecountis
incrementedforeachcharacterwrittentotheelectronicjournal.The
countisnotresetforawarmstart,thatis,apowerfailorreset
duringwhichthepersistentmemoryispreserved.
TableNote97:IftheAcknowledgeEJBlockcommandisbeingsent
toenabletheEJuploadfunctionafterapowerfailora
communicationslossthentheLastCharacterReceivedfieldcanbe
anyvalue,buttherecommendedvalueis000000.Thiswillcause
theSSTtoenabletheEJuploadfunction,thentransmititscurrentEJ
data,startingfromthelastunacknowledgedblock.

AcknowledgeandStopEJ

10

ThiscommandacknowledgesthelastEJuploadblockreceivedby
Central,andinadditionindicatesthatEJuploadistocease.This
willdisabletheEJuploadfunctionuntilCentralsendsanew

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-83

Central to Terminal Messages


EJ Commands

AcknowledgeEJUploadBlockcommandorEJOptionsandTimers
command.
TheAcknowledgeandStopEJcommandmayalsobesenttodisable
EJuploadatanytime(thatis,notinresponsetoanupload
message).
IfCentraldisablesEJupload,EJdatawillaccumulateattheSST
untilCentralreenablestheuploadfunction.Thisprocedurecanbe
usedtocontroltheuploadofEJdataatpeaklineloadtimes,ascan
lengtheningthetimeperiodbeforesendinganacknowledgement
message.ThistimedelayisconfiguredintheEJOptionsandTimers
command.
Table 10-35
Acknowledge and Stop EJ
Field

Number of
Characters

Mandatory/ Optional

Description

Var

Header.Protocoldependent.

MessageClass.Themessageclassis:
6ElectronicJournal

FS

FieldSeparator.

FS

FieldSeparator.

FS

FieldSeparator.

CommandType.Thecommandtypeis:
2AcknowledgeandStopEJ

LastCharacterReceived.Range000000999999.SeeTableNote98.
ThevalueinthisfieldshouldbethesameasthevalueintheLast
CharacterThisBlockfieldinthelastUploadEJDatamessagesentby
theSST.Ifitisnot,EJuploadwillbedisabledandwhenitis
reenabledtheSSTwillsendthelastuploadblockagain.

TableNote98:TheLastCharPreviousBlockandLastCharThis
Blockvaluesarebasedonamodulus1,000,000charactercount
whichstartsatzerofollowingacoldstartoftheSST.Thecountis
incrementedforeachcharacterwrittentotheelectronicjournal.The
countisnotresetforawarmstart,thatis,apowerfailorreset
duringwhichthepersistentmemoryispreserved.

ContinuousandBatch
UploadMethods

10

ContinuousuploadisthenormalmethodofoperationwhentheEJ
uploadfunctionhasbeenenabled.Centralshouldacknowledge
eachuploadedblockassoonasitisknowntobeproperlystored,
andtheSSTshouldmarkEJdataintheejdata.logfileasbeingsentas

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-84

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


EJ Commands

soonasithasbeenproperlyacknowledged.Thenthenextblockof
EJdatawillbesentassoonastheSSTisabletodoso.
Undernormalcircumstances,theonlyoccasionforCentraltobe
involvedinarecoverysituationisiftheSSTRetryCount(option61
inEJOptionsandTimerscommand)isotherthan000infinite.In
thissituationtheSSTmayautomaticallydisableEJuploadafterthe
specifiednumberoffailedattemptstotransmitadatablock.Central
mustbeabletorecognisethiseventandreenableEJupload.An
automaticdisablementmaybeidentifiedbythefactthat
transactionsarebeingreceivedbutnoaccompanyinguploaddatais
seen.
BatchuploadcanbeusedtorestrictEJuploadtocertaintimesofthe
day,outsideofwhichEJuploadisdisabled.Therecommended
approachtousingbatchuploadisasfollows:

CentralputstheSSToutofservice,toensurethatnomore
transactiondatacanbeputintotheelectronicjournallogfile
whiletheuploadisinprogress.
CentralthenenablesEJupload.
Uploadproceeds,pacedbyCentralsacknowledgement
messages,untilalltheEJdatahasbeensenttoCentral.
Whenthelastmessagehasbeenreceived,Centralacknowledges
themessageandthendisablesEJupload.
Thelastmessagecanusuallyberecognisedbythefactthatitis
theonlymessagewithablocklengthlessthanthemaximum
blocklengthsetintheEJOptionsandTimersmessage.Itis
feasiblethatthelastmessagecouldbeexactlythesamelengthas
themaximumblocklengthset,inthiscasetheEJuploadwould
beterminatedduetoatimeout.SeeNote:below.
OnceEJuploadisdisabled,CentralreturnstheSSTtoInservice
mode.

Note:Ifduringthebatchupload,theSSTfailstosendanewupload
blockwithinareasonabletime,thismaybeevidenceofeithera
communicationsfailureorofthefinaldatablockbeingexactlyequal
tothemaximumblocklength,andthereforenotrecognisedasbeing
thefinalblock.Ineithercase,CentralshouldsendaPrintImmediate
commandtotheSSTwithashortmessage,suchasENDOFDAY,
tobeprintedonthejournal.
CentralshouldthenwaitforthisdatatobesentbackinanUpload
EJDatamessagewithashortblocksize.Ifthemessageisreceived,
EJuploadcanterminatenormallyasdescribedabove.Ifnothingis
received,itisevidenceofacommunicationsproblem.Inthiscase
eithertheuploadcanbeterminatedoranotherPrintImmediate
attempted.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-85

Central to Terminal Messages


Message Validation

MessageValidation

10

Validationchecksareperformedonallmessagesreceivedfrom
Central.

ValidMessageClasses

10

ThefollowingarethevalidmessageclassesthatcomefromtheSST
tocentralandfromthecentraltoSST.

SSTtoCentral

10

ThevalidmessageclassesthataresentfromtheSSTtoCentralare1,
2,5and8.

CentraltoSST

10

ThevalidmessageclassesthataresentfromtheSSTtoCentralare1.
3,4,6,7and8.
Note:Messageclass8enablesEMVsmartcardconfiguration.
Fordetails,refertotheEMVIntegratedCircuitCard(ICC)
ReferenceManual

CommandRejectCauses

Thesituationswhichcauseacommandrejectareasfollows:
10

Illegalmessagesubclass
Illegalmessageidentifier
Illegalterminalcommandcode
Illegalterminalcommandmodifier
Fieldseparatorinillegalposition
Insufficientfieldsinmessage
InsufficientmemorytoholdFITentry(FITnumbertoolarge)
Thedispenseamountrequestedislargerthanthenumberof
notesand/orcoinsreportedintheHardwareConfiguration
message
ThemessagecoordinationnumberinaTransactionReply
messagedoesnotmatchthenumberintheTransactionRequest,
andisnot0
IllegalfunctionIDinTransactionReplycommand.Anillegal
functionIDisonewhichisnotsupportedbytheNDCsoftware
oronewhichrequirestheuseofadevicewhichisnotpartofthe
hardwareconfiguration.
Note:Commandsrequestingreceiptorjournalprintwillnotbe
rejectedbecauseofanunconfiguredprinter.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-86

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Validation

Anencryptionkeychangemessageisreceivedbeforethe
originalkeyhasbeenenteredattheterminal
Morethan13printfieldsinaTransactionReplycommand
Date/Timedatainvalidindateandtimeloadcommand.

Whenthespecificcommandrejectoptionisset,theseerrorswill
generateanequivalentspecificcommandreject.
Defaultoperationsincludethefollowing:
EntrytodefaultClosestate.Forexample,nonexistentstate
number
Conversionofillegalparameterstodefaultlegalvalues.For
example,nonnumericASCIIcharacterschangedtonumeric
valuesbyconvertingthetopfourbitsto3hex.A(41hex)
becomes1(31hex)
Redundantinformationisignored.Forexample,nonexistent
timer
Defaultdisplay.Forexample,ifthescreendoesnotexistthe
screennumberisdisplayedonthecardholderscreen.

Thefollowingaretheconditionsunderwhichthespecificcommand
rejectvalue/qualifiercombinationsareproduced.
Table 10-36
Specific Command Reject Value/Qualifier
Combinations

Value

Qualifier

Description

Messageformaterrors.
01

Messagelengtherror.Anincompletemessageis
foundunderthefollowingconditions:
ReportLogs/Talliesmissingthegroupnumber.
LoadconfigurationIDincompleteormissingID
field.
Option/Timerincompletenumber/valuefieldin
configurationmessage.
TruncatedMACFieldSelectionLoad,withexpected
MACdatamissing.
TheDispenserCurrencyCassetteMappingTableis
incomplete.

02

FieldSeparatornotfoundorfoundunexpectedlyin
thefollowingcircumstances:
Foundinthemiddleofanoption/timernumberand
valuefieldinconfigurationmessage.
Notfoundwhenskippingthefirstthreefield
separatorsinaTransactionReplymessage.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-87

Central to Terminal Messages


Message Validation
Value

Qualifier

Description

Notfoundattheendofthecoinagefield.
NotfoundinMACFieldSelectionLoadData.
Mandatorylastfieldseparatornotfoundorfound
unexpectedlyinaTransactionReplymessage.
03

ToomanyprintgroupsintheTransactionReply
message.Morethan13printgroupsarepresentina
TransactionReplymessage.

04

Agroupseparatorismissingorfoundunexpectedly.
Agroupseparatorisrequiredbetweenfieldsjand
j1aswellasbetweenaf2andaf3ofthe
TransactionReplymessage.

06

Invaliddispensemessage,wrongformatforcurrent
modeorarequesthasbeenmadetodispensefrom
multipledispensers.

07

MalformedXML

08

XMLdoesnotconformtoXMLschema

09

Inconsistentconfigurationdownload,forexamplea
messagepartreceivedoutoforder.
Thedownloadmustberestarted.

FieldValueErrors.
01

IllegalMessageClass.Messageclasswasnot1,2,
3,4,6or7,ormessageclasswas7andexit
supportwasnotdetected.
IfanSSTisnotconfiguredforEMV,messageclass
8isnotsupported.

02

IllegalMessageSubClassorIdentifierona
ConfigurationLoadMessagewithclass3.The
followingwillcausethisreport:
Messagesubclassoutsidetherange14.
Messageidentifieroutsidetherange16,A C
orE.

03

IllegalLoadKeyMessageIdentifier.Withinaload
encryptionkeydatamessage:
Themodifierfieldisoutsidetherange19.

04

IllegalTerminalCommandCode:
Returnedifthecommandcodeisoutsidetherange
1?.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-88

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Validation
Value

Qualifier

Description

05

IllegalTerminalCommandModifier.Withinalegal
terminalcommand,ifamodifierisrequired:
ReporttalliesmodifieroutsidetherangeANor
VorYor\or[.
ReporterrorlogmodifieroutsidetherangeAC.
Theterminalcommandcodeis7andthecommand
modifierisoutsidetherange07.

06

IllegalFunctionIDinTransactionReplycommand:
FunctionIDoutsidetherange19,A,B,C,F,
O,P,Q,S,T,*,,or:.

07

DataFieldcontainsnonnumericdata.Thisisfound
inthefollowingcircumstances:
Encryptionkeychangemessagekeydata.
Coinagefieldhasatleastonenonnumericcharacter
present.
Option/Timernumberorvalueinconfiguration
message.
Fieldsae5ae10,af2oras2intheTransaction
Replymessagecontainanonnumericdigit.

08

Numericvalueoutofrange.
InaFITmessage,FITdatavalueisgreaterthan255.
Fieldsae3ae10oraf2intheTransactionReply
messagecontainavalueexceedingtheirmaximum
values.

09

InvalidMessageCoOrdinationNumber.Ina
TransactionReplymessage,thecoordination
numberisnotzeroanddoesnotmatchthe
transmittedvalue.

10

IllegalFITnumber.AFITinaFITloadmessageis
notintherangeofthereservedpoolsize.Legal
valuesare000999.

11

ToomanynotesinTransactionReplycommand.The
totalnumberofnotesrequestedexceedsthelimitof
40.

12

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-89

Central to Terminal Messages


Message Validation
Value

Qualifier

Description

13

Unrecognisedchequedestination.Returnedifthe
destinationspecifiedinfieldas2oftheTransaction
Replyisnotoneoftheallowedvalues,orifthefield
isnull.

14

Reserved

15

Unrecognisedbufferidentifier.Returnedifthe
TransactionReplycontainsabufferidentifiernot
currentlysupported.

1619

Reserved

20

Nodatasuppliedtoendorsechequeincheque
processor.

21

Reserved

22

InvalidkeysizesentinanEncryptionKeyChange
message,oranExtendedEncryptionKeyChange
message.Thekeysizemaybeincorrect(not018hex,
030hexor120hex),notmatchingthekeydata
length,orinvalidforthecurrentkeyentrymode.

23

RSASignatureVerificationFailed.

24

SignatureorEncryptionKeyPKCS#1PackingFailed.

25

SignatureorEncryptionKeyPKCS#1Unpacking
Failed.

26

InvalidSignatureorEncryptionKeyPKCS#1Pad
BlockType.

27

FixedHeaderDecryptionFailed.

28

NullByteAfterPaddingMissing.

29

InvalidPadByteCount.

33

InvalidCassetteType(range1to255).

34

Invalid/IncompleteChequeIdentifiers

35

PassbookUpdatenotSupportedinSpecified
TransactionReplyFunction

IllegalMessageTypeforCurrentMode.
01

Messagetypeonlyacceptedwhileterminalisin
InServicemodeandisexpectingaTransaction
Reply.Therejectiscausedbyreceiptofa
TransactionReplyatothertimeswhiletheterminal
isInService.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-90

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Validation
Value

Qualifier

Description

02

Messagecannotbeacceptedwhilediagnosticsisin
progress.Thisreplyisdesignedtodrawattentionto
thefactthattheseprogramsarebeingexecuted.It
appliestothefollowingmessages:
Downloadmessagesforcustomisation.
TransactionReplies(notPrintImmediate).

03

MessagecannotbeacceptedwhileinOutofService
orSupplymodes.Thefollowingmessagescannotbe
acceptedinthesemodes:
TransactionReplies(notPrintImmediate).
InteractiveTransactionResponse.

04

Messageunacceptableincurrentmode.
Thefollowingmessagescannotbeacceptedwhilein
InServicemode:
Terminalcommands4,5,6,8,9,:.
InteractiveTransactionResponsewhennotin
TransactionRequestState.
Alsoappliestoterminalcommand?when
attemptingtoenableSupervisorDumpImagesbut
terminalisperformingatransaction.
DispenserCurrencyCassetteMappingtable.

0509

Reserved.

10

Messagenotacceptedwhileprocessinga
TransactionReply.

11

Reserved.

12

Cannotprocessadocumentwhileastatementprint
functionisbeingcarriedout.Reportedon5665only.

13

Cannotperformastatementprintfunctionwhile
processingadocument.Reportedon5665only.

14

Reserved.

15

Cannotperformacommunicationsencryptionkey
changeduringacardholdertransaction,orwhenthe
terminalisinsuspendmode,orwhentheoperatoris
initiatingtheexecutionofsupervisoryorsettlement
transactions.

16

Reserved.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-91

Central to Terminal Messages


Message Validation
Value

Qualifier

Description

17

Keychangeoperationcannotbeacceptedin
restrictedmode.

18

Keyentrymodenotauthorised

HardwareFailure.
01

EncryptionFailureduringkeychangemessage.

02

TimeofDayclockfailureduringdata/timeset
commandorinvaliddatasent.

0305

Reserved.

06

Insufficientdiskspace.

07

FileI/OError

08

FileNotFound

NotSupported.
01

Notsupportedbysoftware:
Therequestedfunctionisnotsupportedbythe
softwareversioninuse.
VISAPINverificationkeytableloadviaEncryption
keychangemessage.
ThereceivedcommunicationsEncryptionKey
Changemessagecontainsaninvalidmodifier
(between5and9).
MACFieldselectionload.
ADLLrequiredtocompletethetransactionreply
processingismissing

02

Notsupportedbyhardware:
BunchNoteAcceptor(BNA)functionhasbeen
requestedbuttheBNAisnotavailable.
Sidewaysprintingonreceipthasbeenrequestedbut
theoptionisnotavailable.

0304

Reserved.

05

Journalprinterbackupisinactive.

06

Theresponsemessageformatdefinitionisnot
compatiblewiththedataformat/lengththathasto
bereturnedinresponsetoacommandrequest.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-92

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Message Validation

OtherInvalidParameters

10

Anyotherinvalidparameterinareceivedmessagewillbeaccepted
andtheappropriatedefaultoperationwilloccur,butsystem
integritywillnotbelost.Astheoperationislargelyunpredictable,
NCRrecommendsthatyouensurethatCentralvalidationoccurs
beforeamessageissent,orchecktheterminaloperationbefore
goinglive.

Exits

10

IfarulefilespecifiesaDLLthatcannotbeloaded,oraroutinethat
cannotbeaccessed,thefollowingwilloccur:

Theerroristraced,usingtracemessagesT93orT94.
SeeAppendix A,ReservedScreens.
IftheerroroccursduringtheexecutionofauserdefinedExit
State,AdvanceNDCwillalsoputtheterminalintoadefault
Closestate.

Thiswillaffectthefollowing:

Messagesofclass7,subclass1,fromCentraltoanExit,ifthefile
MISCONTspecifiesaninaccessibleDLLnameorroutinename
withPointofUse7
Messagesofclasses1,2,3or4ifthefileVCCONTspecifiesan
inaccessibleDLLnameorroutinenameasaninterceptroutine.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-93

Central to Terminal Messages


Messages Received in Wrong Operational Mode

MessagesReceivedinWrong
OperationalMode

10

Thefollowingtablesdescribewhatactionistakenifamessageis
receivedbytheterminalwhenitisinoneofthefollowingmodes:

PowerUp
OutofService
Supply
InService

Theactiontakenwilldependonwhichmodetheterminalisinat
thetimeofreceivingthemessage.Themessagesinclude:

CustomisationData
Commands

CustomisationDataCommands
TransactionReplyCommands
TerminalCommands.

Formoredetailsofthesecommands,seeCustomisationData
Commandsonpage 106.
10

Table 10-37
Actions for Customisation Data Commands

Command Mode

Power-Up

Out-of-Serv
ice

Supply

In-Service

StateTableLoad

Screen/KeyboardData
Load

Configuration
ParametersLoad

Interactive
TransactionResponse

A2

FITDataLoad

EncryptionKey
Change

A3

ExtendedEncryption
KeyChange

A3

ConfigurationID
NumberLoad

Enhanced
Configuration
ParametersLoad

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-94

APTRA Advance NDC, Reference Manual

Central to Terminal Messages


Messages Received in Wrong Operational Mode

Command Mode

Power-Up

Out-of-Serv
ice

Supply

In-Service

PINDataLoad

DateandTimeLoad

MACFieldSelection
Load

DispenserCurrency
CassetteMapping
TableLoad

RCommandReject.
AAcceptforprocessing.ResponseisReady(9)status.
A2Acceptforprocessing.ResponseisTransactionRequestifin
TransactionRequeststate,elseresponseisCommandReject.
A3AcceptinInServicemodeonlyifatransactionisnottaking
place.

TransactionReply
Command
Table 10-38
Actions for Transaction Reply Commands

Formoredetailsofthiscommand,seetheearlierTransaction
ReplyCommandsectioninthischapter.
10

Command Mode

Power-Up

Out-of-Se
rvice

Supply

In-Service
(Not Tran. Req.
State)

In-Service
(Tran. Req.
State)

Print
Immediate

A1

Other

RCommandReject.
AAcceptforprocessing.Ifcompletedsuccessfully,theresponseis
aReady9orReadyBstatus.Ifadeviceerror,theresponseisa
devicefaultstatusmessage.Ifaformaterror,theresponseisa
CommandReject.
A1IfthemodewasenteredfromOutofService,holduntil
OutofServiceisreenteredandthenprocessasA.Otherwise,the
responseisaCommandReject.IfanotherPrintImmediateis
received,thefirstoneisoverwritten.Thereisnoadditional
response.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

10-95

Central to Terminal Messages


Messages Received in Wrong Operational Mode

TerminalCommands
Table 10-39
Actions for Terminal Commands

10

Formoredetailsofthesecommands,seetheTerminalCommands
sectiononpage 102.
Command Mode

Power-Up

Out-OfService

Supply

In-Service

GoInService

A1

A2

GoOutofService

A2

A3

ConfigurationID
Request

Configuration
InformationRequest

CountersRequest

Date/TimeRequest

DResponseisrequestedinformation.
PHolduntilsupplymodeisexitedandthenprocessaccordingto
themodeentered.Notethatthemessagesarenotstackedandanew
requestoverwritesthepreviousrequesttowhichnoresponseis
sent.
RResponseisCommandReject.Inordertousetheserequests,the
terminalshouldbeputoutofservice.Thisistoavoidthe
informationbeingupdatedbycardholderactivitywhilethe
messagesarebeingcreated.
AResponseisReady(9)status.
A1ChangemodetoInService.ResponseisReady(9)status.
A2HolduntilSupplymodeisexitedandthenprocess.Responseis
Ready(9)status.Notethatifmorethanonecommandisreceived
whileinSupplymode,onlythelastisrecognised.Theothersare
dropped,andnoresponseisgiven.
A3ModechangetoOutofServicewhenterminalisidleatthe
CardReadstate.ResponseisReady(9).
CResponseistheterminalstatemessagecontainingthe
ConfigurationID.
Note:WhileInService,areceivedConfigIDrequestwillbe
processedandrespondedtoimmediately,whethertheSSTisinidle
oracardholdersession.Allotherterminalcommandsarehelduntil
theterminalisidleandthenprocessed.Commandsarenotstacked
andanewrequest,otherthanaConfigID,overridestheprevious
requesttowhichnoresponseissent.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

10-96

APTRA Advance NDC, Reference Manual

Table of Contents
Security Features

Chapter 11

SecurityFeatures
Overview

111

BAPESecurity

112

EPPSecurity

113

RemotePINBlock
FITFields
PINBlockFormats
DieboldPINBlock
ISOPINBlockFormat0(ANSI)
ISOPINBlockFormat1
ISOPINBlockFormat3
BANKSYSPINBlock
PANBlock
PINBlockEncryption

114
114
114
115
115
116
116
116
117
118

MessageAuthentication
MessageAuthenticationCode
DoublelengthKeys
SendingtheMACFieldfromtheTerminaltoCentral
SendingtheMACFieldfromCentraltotheTerminal
TimeVariantNumber
FullMessageAuthentication
SelectiveMessageAuthentication
UsingSelectiveMessageAuthentication

1110
1110
1111
1111
1111
1111
1111
1113
1115

KeyVerificationValues
DeterminingEncryptorKeyStatus

1117
1117

RSAInitialKeyLoading
EPPAuthenticationProcess
AuthenticationMessageSequence

1118
1118
1122

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Security Features

ChangingtheEncryptionKeyEntryMode
LoadingDESKeys
RSAEncryptedDESKeyFormat
SignatureFormat
Base94EncodingandDecoding
Encoding
Decoding

1123
1124
1125
1125
1126
1126
1127

DoubleLengthKeys
GeneralGuidelines
AdvanceNDCGuidelines
DoubleLengthRestrictedKeyEntryMode

1128
1128
1128
1129

JournalPrinterBackup

1130

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Security Features
Overview

Overview

11

ThischapterdescribesthesecurityfeaturesinAdvanceNDCand
providesguidelinesunderthefollowingtopics:

BAPEandEPPsecurity
RemotePINblock
Messageauthentication
KVVs
InitialRSAloading
Doublelengthkeys
Journalprinterbackup

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-1

Security Features
BAPE Security

BAPESecurity

11

TheBasicAlphaPINpadandEncryptor(BAPE)providesan
intermediatelevelofsecurityforkeysandPINsenteredatthe
keyboard,withthefollowingfeatures:

Supervisorentryofinitialkeyvalues
StoringofdownloadedMasterKey,CommunicationsKey,VISA
masterkey,VISAtablekeysandMACkey
MACgeneration
SecurePINentryandPINblockgenerationforremoteschemes
withVISAandANSIPINblocks.Secureentryisnotallowedfor
touchscreendata.
SecurePINentryforlocalVISAandDESschemes.SecurePIN
entryforthelocalDESschemeisnotsupportediftheterminalis
indoublelengthkeymodeandthePANPDintheFITspecifies
usingtheMasterkey.
ISOFormat0remoteverificationschemes,andDESandVISA
localschemes,areemulatedinsoftware.

PINblocksorkeydataarestoredinthePCcoreprotectedbysingle
encryption,andneverincleartext.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-2

APTRA Advance NDC, Reference Manual

Security Features
EPP Security

EPPSecurity

11

WhenpresentonanNCRterminal,theEncryptingPINPad(EPP)
providesahighlevelofsecurityforkeysandPINsenteredatthe
keyboard,withthefollowingfeatures:

Supervisorentryofinitialkeyvalues
StoringofdownloadedMasterKey,CommunicationsKey,VISA
masterkey,VISAtablekeysandMACkey
MACgeneration
SecurePINentryandPINblockgenerationforremoteschemes
withVISAandANSIPINblocks.Secureentryisnotallowedfor
touchscreendata.
TripleDESencryption
SecurePINentryforlocalVISAandDESschemes.SecurePIN
entryforthelocalDESschemeisnotsupportediftheterminalis
indoublelengthkeymodeandthePANPDintheFITspecifies
usingtheMasterkey.
Securedoublelengthkeyoperationsinhardware
ISOFormat0andISOFormat3remoteverificationschemes,
andDESandVISAlocalschemes,areemulatedinsoftware
SecurekeyentryenabledthroughCENXFS.

ForguidelinesoneffectivesecuritywiththeEPP,see
DoubleLengthKeysonpage 1128.
ForinformationonkeymodesupportonothervendorsEPPs,refer
toChapter2,SupportforAdvanceNDCFeaturesintheAPTRA
AdvanceNDC,MultiVendorSupportReference.Forinformationon
anynecessaryconfigurationforothervendorsEPPs,referto
Chapter6,InstallingandConfiguringOtherVendorsHardware
intheAPTRAAdvanceNDC,MultiVendorSupportReference.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-3

Security Features
Remote PIN Block

RemotePINBlock

11

TheremotePINblockisformattedandencryptedasdescribedin
thefollowingpassages:

FITFields

11

FITFields
PINBlockFormats
PINBlockEncryption.

ThefollowingFITfieldsareusedtodefinethePINblockformatand
PINblockencryption:

PBFMT(PINBlockFormat)
PMXPN(MaximumPINDigitsEnteredandPINblockformat)
PINPD(PINPad)

FordetailsoftheseFITfielddefinitions,seethefollowingsectionsin
Chapter 8,FinancialInstitutionTables:

PBFMT(PINBlockFormat)onpage 811
PMXPN(MaximumPINDigitsEntered)onpage 85
PINPD(PINPad)onpage 86.

TheseFITfieldsenableselectionof:

PINblockformat,asdefinedbyPBFMTorPMXPN
PADdigit,asdefinedbyPINPD
PINblockencryptionmode.

FordetailsofthePINblockencryption,seePINBlockEncryption.

PINBlockFormats

11

TheAdvanceNDCsoftwaresupportsthefollowingPINBlock
formats:

Diebold
ISOFormat0(ANSI)
ISOFormat1
ISOFormat3
BANKSYS.

AllPINblocksconsistof16digits,althoughthePINlengthvaries.
ThePINBlockformatsareshowninthefollowingsections.
FormoreinformationabouttheISOPINblockformats,refertothe
ISOpublicationBankingPersonalIdentificationNumberManagement
andSecurity(Part1:PINProtectionPrinciplesandTechniques)
ISO/CD95641.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-4

APTRA Advance NDC, Reference Manual

Security Features
Remote PIN Block

DieboldPINBlock

11

TheDieboldPINBlockconsistsof16hexadecimaldigits.As
AdvanceNDCdoesnotsupportthemessagecoordinationnumber,
itisnotincluded.
Figure 11-1
Diebold PIN Block

PIN field (16 digits)

PIN

PIN digits or PAD digits,


depending on PIN length

MinimumPINlength=4;maximumPINlength=16.

ISOPINBlockFormat0(ANSI)

11

ISOPINBlockFormat0consistsof16hexadecimaldigits,and
conformstoANSIstandardX9.8.
ISOPINBlockFormat0iscreatedbyXORingtogetherthePIN
blockandthePANblock.FordetailsofthePANblock,seePAN
Block.
ISOPINBlockFormat0isasfollows:
Figure 11-2
ISO PIN Block Format 0

PIN field (16 digits)

Control
Field "0
PIN length,
4 to 12

PIN digits
PIN digits or
PAD digits,
depending on
PIN length

PAD digits,
always 15

MinimumPINlength=4;maximumPINlength=12.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-5

Security Features
Remote PIN Block

ISOPINBlockFormat1

11

ISOPINBlockFormat1isasshownbelow:
Figure 11-3
ISO PIN Block Format 1

PIN field (16 digits)

Control
Field "1

PIN digits
PIN digits or
transaction digits,
depending on
PIN length

PIN length,
4 to 12

Transaction
digits,
random 0 to 15

MinimumPINlength=4;maximumPINlength=12.

ISOPINBlockFormat3

11

ISOPINBlockFormat3iscreatedbyXORingtogetherthePIN
blockandthePANblock.FordetailsofthePANblock,seePAN
Block.
ISOPINBlockFormat3isasshownbelow:
Figure 11-4
ISO PIN Block Format 3

PIN field (16 digits)

Control
Field "3

PIN digits

PIN length,
4 to 12

PIN digits or
PAD digits,
depending on
PIN length

PAD digits,
randomly
selected in
range 10
to 15

MinimumPINlength=4;maximumPINlength=12.

BANKSYSPINBlock
TheBANKSYSPINblockiscreatedbyXORingtogetherthePIN
blockandthePANblock.FordetailsofthePANblock,seePAN
Block.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-6

APTRA Advance NDC, Reference Manual

11

Security Features
Remote PIN Block

TheBANKSYSPINblockisasfollows:
Figure 11-5
BANKSYS PIN Block

PIN field (16 digits)

PIN digits or
PAD digit,
randomly selected
pad with 0 up to
in range 0 to 15
maximum PIN
length defined PIN digits or
PIN length, by PMXPN
PAD digit,
4 to 12
field in FIT
depending on

Control
Field "1"

PIN length

MinimumPINlength=4;maximumPINlength=12.
WhenthecardholderentersthePIN,thedigitsarepaddedtothe
rightwith0hexadecimaltothemaximumdefinedbythefiveleast
significantbitsofthePMXPNfield.Theblockiscompletedby
paddingtherestoftheblockwithapseudorandomdigitbasedon
time.

PANBlock

11

APANblockisbuiltforISOFormat0(ANSI),ISOFormat3and
BANKSYSPINblocks.
ThePANblockismadeupof16hexadecimaldigits,andcontains
thePANdigitsselectedfromthecardholderscardusingtheFIT
parametersPANDXandPINDX.
ThePANislocatedinthecarddatabyusingthePANDXFITentry,
whichindicatesthestartofthePAN.TheendofthePANisfound
bysearchingforthenextfieldseparator,ortheendofthetrackdata.
ThecheckdigitattheendofthePANisdiscardedandthentheleast
significant12digitsareextractedtoformthePANblock.Thisblock
ispaddedtotheleftwith0hexadecimalinordertocreatethefull16
digits.
Figure 11-6
PAN Block

PAD Digits

PAN Digits

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-7

Security Features
Remote PIN Block

Asamaximumof12PANdigitsareplacedinthePANblock,the
firstfourdigitsarealways0hexadecimal.
ThePINandPANblocksarethenXORedtogether,tocreatethe
PIN/PANblock.ThisisencryptedasdefinedbytheFITfieldPINPD
andplacedintheTransactionRequestmessage.

PINBlockEncryption

11

ForallPINblocks,thefirstdigitofthePINPDFITfieldspecifiesthe
methodofencryptionandtheencryptionkey.
TheseconddigitisthedigitusedtopadthePIN.
Thefirstdigitisbinaryencoded.
Thesignificanceofeachbitinthefirstdigitisasfollows:

Table 11-1
PINPD First Digit Bit Significance

Table 11-2
PINPD FIT Field

Bit0
(1hex)

Doubleencryptionsequence:
0MASTCOM
1PEKEYCOM

Bit1
(2hex)

Double/singledesignator:
0single
1double

Bit2
(4hex)

Encryption/noencryption:
0encrypt
1noencrypt

Bit3
(8hex)

Coordinationnumber/nocoordinationnumber:
0nocoordinationnumber
1coordinationnumberincluded
ThisbithasnoeffectifthePINblockformatisspecified
usingthePBFMTfield.

Hexadecimal
Value

Type Of Encryption

Encryption Key and Sequence


First

Second

Single

COM

Double
SeeTableNote2.

MASTER

COM

Double

PEKEY

COM

(None)
SeeTableNote1.

Single

COM

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-8

APTRA Advance NDC, Reference Manual

Security Features
Remote PIN Block
Hexadecimal
Value

Type Of Encryption

Encryption Key and Sequence


First

Second

Double

MASTER

COM

Double

PEKEY

COM

(None)
SeeTableNote1.

TableNote1:Theencryptioncommands4andChexadecimal,
whichcallfortransmittinganunencryptedPINarenotsecure,and
arenotsupportedbyAdvanceNDC.
TableNote2:DoubleencryptioninvolvesencryptingthePINfield
usingthefirstencryptionkey,thenencryptingtheencryptedPIN
fieldusingthesecondencryptionkey.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-9

Security Features
Message Authentication

MessageAuthentication

11

WhenMessageAuthenticationisused,eitherCentralorthe
terminalsendingthemessageappendsaMessageAuthentication
Code(MAC)totheendofthemessage.TheMACiscalculatedfrom
themessagecontent,andisthereforespecifictothemessagethatit
iscreatedfrom.
ForsingleDESMACing,themessageauthenticationprocedure
conformstoANSIstandardX9.9.TripleDESMACingconformsto
ANSIstandardX9.19.

MessageAuthentication
Code

11

TheMessageAuthenticationCodefieldcanbeaddedtoTransaction
Request,SolicitedStatus(bothdevicefaultandterminalstate),
TransactionReply,StateTable,FITLoad,MACFieldSelection
Load,DispenserCurrencyCassetteMappingTableandEMV
Configurationmessages.
Ifthetransmissioncodeisadifferentformat,theMACcalculations
areperformedonthedataasfollows:

Forreceivedmessages,afterconversiontoASCII
Forsentmessages,beforeconversiontothedifferentformat

Forexample,ifthetransmissioncodeofareceivedmessageis
EBCDIC,thenthedataisconvertedtoASCIIbeforeaMAC
calculationisperformed.
TheMACcalculationisperformedoverthewholemessage,starting
fromthefirstfieldfollowingtheprotocoldependentheader,upto
thefieldseparatorprecedingtheMACfield,oronselectedfieldsof
themessagethatarespecifiedbytheMACfieldselectiontable.
Whenselectedfieldsareused,theyaretakeninsequencefromthe
startofthemessageandaddedtogethertoformthedatastringthat
isusedforMessageAuthentication.Ifthisresultsinanullstring,
theMessageAuthenticationcodeissetto00000000.Forallother
cases,theMessageAuthenticationcodeisgeneratedinthe
followingway:
1

Thefirsteightbytesofthedataareextractedandencrypted
usingtheMACkey.

TheencryptedeightbytesareXORedwiththenexteightbytes
extractedfromthedata.Iffewerthaneightbytesremain,they
arepaddedtotherightwith0hexadecimal.

ThisvalueisthenencryptedusingtheMACkey.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-10

APTRA Advance NDC, Reference Manual

Security Features
Message Authentication

Steps2and3arerepeateduntilallthedatahasbeendealtwith.

ThefirstfourbytesofthefinalencryptionformtheMACfield.It
isregardedaseighthexadecimaldigits,eachofwhichis
convertedtoacharacterintherange09,AF.

DoublelengthKeys

11

IftheMACkeyisdoublelength,steps1to4areperformedusing
thefirsthalfofthekey.Thefinalresultisthendecryptedusingthe
secondhalfofthekey,andencryptedagainusingthefirsthalf.
Step5isthenperformedtoextracttheMAC.
Note:AdvanceNDConlysupports/usestheLastBlockmethodto
calculatedoublelengthkeyMACs.

SendingtheMACFieldfromtheTerminaltoCentral

11

TheMACfieldiscalculatedbytheterminalandplacedattheendof
themessage.ThemessageissenttoCentralwherethesame
calculationisperformed.ThetransmittedandcalculatedMAC
fieldsarecompared.Iftheyareequal,Centralcontinueswiththe
processing.Iftheyareunequal,Centraltreatsthisasaninvalid
requestandactsaccordingly.

SendingtheMACFieldfromCentraltotheTerminal

11

TheMACfieldiscalculatedbyCentralandplacedattheendofthe
message.Themessageissenttotheterminalwherethesame
calculationisperformed.ThetransmittedandcalculatedMAC
fieldsarecompared.Iftheyareequal,theterminalcontinueswith
theprocessing.Iftheyareunequal,theterminalsendsaspecific
commandrejectsolicitedstatusmessagetoCentral,andbehavesas
thoughanormalcommandrejecthasbeensent.

TimeVariantNumber

11

Thetimevariantnumber,TVN,isanadditionalsecurityfeaturethat
isavailablewhenMessageAuthenticationisused.Itcanbeusedin
TransactionRequestandSolicitedstatusmessages.
Whenthisfeatureisused,theterminalcalculatestheTVNfromthe
terminaltime,andsendsitinthemessage.Centralshouldsendthe
sameTVNbacktotheterminal.IftheMACinthemessageis
verified,theterminalcomparesthereceivedTVNtotheoneitsent.
IftheTVNisthesame,themessageisacceptedandprocessed.If
not,aspecificcommandreject(c2)solicitedstatusmessageissent
andafurtherreplyawaited.

FullMessage
Authentication

MessageAuthenticationiscontrolledbytheentryofinformation
intotheterminalaspartoftheconfigurationprocess.Refertothe
11

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-11

Security Features
Message Authentication

APTRAAdvanceNDC,SupervisorsGuidefordetails.This
informationcontainsflagsthataredescribedinthefollowingtables.
Table 11-3
Message Authentication Configuration
Flag 1

Table 11-4
Message Authentication Configuration
Flag 2

Flag 1

DonotcheckthetimevariantnumberinTransactionReply
messages,ortheMACinTransactionReply,StateTable,FIT
LoadorDispenserCurrencyCassetteMappingTable
messages.

CheckthetimevariantnumberinTransactionReply
messages,andtheMACinTransactionReply,StateTable,FIT
LoadandDispenserCurrencyCassetteMappingTable
messages.

Flag 2

DonotsendthetimevariantnumberandtheMACdatain
TransactionRequestmessages.

SendthetimevariantnumberandtheMACdatain
TransactionRequestmessages.

Legalcombinationsoftheseflagsare00,01and11.Whentheflag
combination01isused,MACandtimevariantfieldsarestill
expectedinthespecifiedmessagesfromCentral,buttheyarenot
checked.
Table 11-5
Message Authentication Configuration
Flag 8

Table 11-6
Message Authentication Configuration
Flag 9

Table 11-7
Message Authentication Configuration
Flag 10

Flag 8

DonotchecktheSecurityTerminalNumberinTransaction
Replymessages.

ChecktheSecurityTerminalNumberinTransactionReply
messages.

Flag 9

TheMACcalculationisperformedonthewholemessage.

TheMACcalculationisperformedonthefieldsthatare
specifiedintheMACfieldselectiontable.

Flag 10

DonotsendthetimevariantnumberandtheMACon
Soliciteddevicestatusmessages.

SendthetimevariantnumberandMAConSoliciteddevice
statusmessages(excludingRDY),ifFlag2isset.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-12

APTRA Advance NDC, Reference Manual

Security Features
Message Authentication

Flags37arenotused,andmustbezerowhenFlags9and10are
used.
Flags1,2and10determinewhethertheMACistobeperformed.
Flag9determinesthetypeofMACtouse.
Flag8isusedtodetermineifthereceivedmessageisforthis
terminal.

SelectiveMessage
Authentication

11

Inlongmessages,suchasmessagescontainingprinterdata,
generatingtheMACcanaddseveralsecondstothetransaction
time.Therefore,toderivethebenefitofMessageAuthentication
withoutthetimepenalty,MessageAuthenticationacrossselected
fieldscanbeperformed.
Afieldselectiontableisusedtoidentify,foreachmessagetype,the
fieldsthataretobeincludedintheMAC.Flag9intheMACflags
indicateswhetherafullorselectiveMACistobeused.
Thefieldselectiontableconsistsoffourfields,oneeachfor
TransactionRequest,TransactionReply,andSolicitedStatus
messages,andonecombinedfieldforothertypesofmessage.These
arefollowedbythreefields,oneeachforTrack1,Track2and
Track3datafromthemagneticcardstripe.Afurtherfieldispresent
foraSmartCard.FordetailsofTransactionRequestand
TransactionReplyoffsets,seeMessageAuthenticationField
SelectionLoadonpage 1025.

Table 11-8
MAC Field Selection: Solicited Status
Message

Solicited Status Message


Offset

Meaning

0MACcompletemessage.Ignoretheremainingdigits.
1SelectivelyMACthefieldsbelow.SeeTableNote3.

Fieldsbandc

Fieldd

Reserved

Fielde

Fieldf

Fieldg1

Fieldg2.SeeTableNote4.

Fieldg3

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-13

Security Features
Message Authentication
Solicited Status Message
Offset

Meaning

Fieldg4

10

Fieldg5

TableNote3:FieldsareselectedforinclusionintheMACifthe
relevantoffsetbyteissetto1.
TableNote4:Whenfieldg2issettobeMACedselectively,any
groupseparatorswithinthatfieldwillnotbeMACed.
Table 11-9
MAC Field Selection - Other Messages

Table 11-10
MAC Field Selection - Track 1, Track 2,
Track 3

Other Messages
Offset

Meaning

0DonotMACFITLoadmessages.
1MACFITLoadmessages.

0DonotMACStateTableLoadmessages.
1MACStateTableLoadmessages.

0DonotMACTerminalStatemessages.
1MACTerminalStatemessages.

0DonotMACDispenserCurrencyCassetteMappingTable
messages.
1MACDispenserCurrencyCassetteMappingTable
messages.

Track 1, Track 2, Track 3


Offset

Meaning

0MACfulltrack.Ignorebytes1n.
1SelectivelyMACthefieldsbelow.SeeTableNote5.

Subfield1(includingstartsentinel)

2n

Subfields2n

TableNote5:SubfieldsareselectedforinclusionintheMACifthe
relevantoffsetbyteissetto1.
AmaximumoffivefieldsispossibleonTracks1and2,andtenon
Track3.
Iftherearefewerthanthemaximumnumberofsubfieldspresent
onthecard,theexcessbytesaresettozero.Thelastsubfield
containstheendsentinel.Ifthesubfieldsthatcontainthestartand
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-14

APTRA Advance NDC, Reference Manual

Security Features
Message Authentication

endsentinelsarespecifiedforinclusionintheMAC,thenthe
sentinelsareincluded.
Thetrackfieldsareonlyexaminediftherelevantoffsetbyteissetin
theTransactionRequest/Replyfield.
ThefollowingtableisonlyrelevantifyouareusinganEMV
IntegratedCircuitCard(ICCorSmartCard):
Table 11-11
MAC Field Selection For EMV ICC
Configuration Messages

UsingSelectiveMessage
Authentication
Table 11-12
Selective MAC Default Field Values

EMV ICC (Smart Card) Configuration Messages


Offset

Meaning

0DonotMACICCCurrencyDataObjectsTablemessages.
1MACICCCurrencyDataObjectsTablemessages.

0DonotMACICCTransactionDataObjectsTablemessages.
1MACICCTransactionDataObjectsTablemessages.

0DonotMACICCLanguageSupportTablemessages.
1MACICCLanguageSupportTablemessages.

0DonotMACICCTerminalDataObjectsTablemessages.
1MACICCTerminalDataObjectsTablemessages.

0DonotMACICCTerminalAcceptableAIDsTable
messages.
1MACICCTerminalAcceptableAIDsTablemessages.

Asetofdefaultfieldvaluesareprovided.Theseareasfollows:
11

TransactionRequest

SelectiveMAConfieldse,h(subfieldl),j,k,l,
bd.

TransactionReply

SelectiveMAConfieldse,g,h,i,j,j1j4,k,l,at.

SolicitedStatus

FullMAC.

FIT/Statetables

FullMAC.

TerminalState

NoMAC.

Track1

FullMAC.

Track2

SelectiveMAConfirstsubfield.

Track3

FullMAC.

DispenserCurrency
CassetteMapping

FullMAC.

EMVICC
Configuration

FullMAC.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-15

Security Features
Message Authentication

TableNote6:Thesedefaultscanbechangedbyadownload
configurationmessage.
TableNote7:Whenselectivefieldsareused,theyaretakenin
sequencefromthemessagetobuildasingledatastring.Fieldand
groupseparatorsarenotincluded.Emptyfieldsareomitted.Ifthe
completedatastringisempty,noauthenticationisattemptedand
theMACissettozero.
TableNote8:TheselectiveMACiscalculatedinthesamewayas
forfullMessageAuthentication.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-16

APTRA Advance NDC, Reference Manual

Security Features
Key Verification Values

KeyVerificationValues

11

KeyVerificationValues(KVVs)givepositiveconfirmationofthe
correctloadingofanencryptionkey.
TheKVViscreatedbyencryptingeightzerobytes,takingthefirst
(leftmost)threebytesoftheresultandconvertingthistosix
hexadecimaldigits.
Fordoublelengthkeys,atripleDESencryptionisperformed.
TheVISAkeytableistreatedas12singlelengthkeysgiving12
separateKVVs.

DeterminingEncryptor
KeyStatus
Figure 11-7
Obtain Key Status Message Exchange

Thehost(Central)candeterminethestatusofkeysintheencryptor
withthefollowingmessageexchange:
11

Host

Terminal
EEKC, 'H' - Send all KVVs

EID, '4' - KVV table

Where:
EEKC=ExtendedEncryptionKeyChange(fordetails,seethe
ExtendedEncryptionKeyChangesectioninChapter 10,Central
toTerminalMessages).
EID=EncryptorInitialisationData(fordetails,seetheEncryptor
InitialisationDatasectioninChapter 9,TerminaltoCentral
Messages).
KVV=KeyVerificationValue.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-17

Security Features
RSA Initial Key Loading

RSAInitialKeyLoading

11

WhenanSSTisfittedwiththeEncryptingPINPad(EPP),the
AdvanceNDCapplicationsupportstheloadingoftheinitial
encryptionkeys(Akey,BkeyandVkey)usingRSAencryption,
insteadoflocalentryinSupervisormode.
ForfurtherdetailsoftheRSAencryptionandsignatureschemes,see
theRSALaboratoriesCryptographicTokenInterfaceStandardPKCS#1
v2.0.
BeforeusingRSAencryption,theHostSecurityModule(HSM)at
thehostandtheEPPintheterminalmustperformanauthentication
processwhichsatisfiestheconditionsgiveninthefollowing
passage.

EPPAuthentication
Process

11

TheobjectiveofinitialkeydownloadistotransferaDESencryption
keyfromtheHSMatthehosttotheEPPintheterminal.Thereare
threeimportantconditionstothistransfer:
1

TheDESkeymustremainsecret.OnlythesourceHSMand
targetedEPPcanknowthekey.

TheEPPmustonlyacceptakeyfromanHSMidentifiedas
authentic.

TheHSMmustonlysendthekeytoanEPPidentifiedas
authentic.

RSAencryptionisusedtomeettheseconditions.RSAencryptionis
anasymmetricencryptionschemewhichusesapairofkeys;one
keyisusedforencryption,andtheotherkeyisusedfordecryption.
Oneofthekeysiskeptsecret(theSecretKey,SK)andtheotherkey
ismadepublic(thePublicKey,PK).Duringtheauthentication
process,RSAencryptionisusedforencryptingsecretdataandfor
signingdata.
WithRSAencryption,anybodycanencryptdatausingthepublic
key,butonlytheholderofthesecretkeycandecryptthedata.
Signaturesareusedtopreventmessagesfrombeingchanged
duringtransmissionandthesenderfrombeingimpersonated.A
SecureHashingAlgorithm(SHA)isappliedtothemessageand
thentheresultisencrypted.WithRSAencryption,thesecretkeyis
usedforgeneratingthesignature.Onlytheholderofthesecretkey
cangeneratethesignature,butanybodycanverifythesignature
usingthepublickey.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-18

APTRA Advance NDC, Reference Manual

Security Features
RSA Initial Key Loading

Inthefollowingprocess,[message]PKisusedtorepresenta
messageencryptedwithPublicKeyPK,while(message)*SK
representsamessagesignatureusingSecretKeySK.
TwopairsofRSAkeysareusedtotransferaninitialDESkey
(Akey)fromtheHSMtoanEPP.Onepairofkeysisassociated
withtheHSM(SKHSMandPKHSM);theHSMretainsSKHSM
andsendsPKHSMtotheEPP.Theotherpairisassociatedwiththe
EPP(SKEPPandPKEPP);theEPPretainsSKEPPandsends
PKEPPtotheHSM.
TheHSMcannowusePKEPPtoencryptAkey,represented
[Akey]PKEPP,sothatonlytheEPPcandecryptitusingSKEPP.
TheHSMthensignsthemessageusingSKHSM,represented
([Akey]PKEPP)*SKHSM,sothattheEPPcanverifythatthe
messagecamefromtheHSMandhasnotbeenaltered.Thisis
summarisedinthefollowingdiagram:
Figure 11-8
HSM - EPP A-key message exchange

HSM

EPP
PK-EPP

PK-HSM

Host encrypts A-key using PK-EPP


and signs using SK-HSM

[A-key] PK-EPP + ([A-key] PK-EPP) * SK-HSM

Therearestillacoupleofproblemstosolve:
1

WhentheHSMreceivesPKEPP,howdoesitcheckthatPKEPP
camefromanauthenticEPP,ratherthananimpostortryingto
stealtheAkey?

WhentheEPPreceivesPKHSM,howdoesitcheckthat
PKHSMcamefromanauthenticHSM,ratherthananimpostor
attemptingtoloadtheirownkeys?

AfurtherstepisthusrequiredtoauthenticatetheEPPandHSM
publickeys.ThisusesathirdpairofRSAkeysgeneratedbyNCR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-19

Security Features
RSA Initial Key Loading

(SKNCRandPKNCR).SKNCRwillbekeptinasecuritymodule
inahighlysecurelocationwithinNCR.
WhenPKEPPandSKEPParegeneratedandwrittentotheEPP
duringtheEPPmanufacturingprocess,SKNCRisusedtosign
PKEPPtogive(PKEPP)*SKNCR.ThissignatureandPKNCRis
alsowrittentotheEPP.
Usingsomeothersecurechannel,PKHSMwillarriveattheNCR
securelocationandbesignedusingSKNCRtogive(PKHSM)*
SKNCR.Usingasecurechannel,thissignatureandPKNCRwill
bewrittentotheHSM.
SigningtheHSMpublickeyisaoneoffoperation,sothetransferof
thekeyandsignaturecanbeperformedmanually.Althoughthe
datatransferredisnotsecret,asecuretransferisrequiredto
authenticatethepartiesinvolved.
Thisissummarisedinthefollowingdiagram:
Figure 11-9
Authentication of EPP/HSM Public Keys

NCR Security
Module
Secure channel

PK-HSM

During manufacture

PK-NCR,
(PK-HSM) * SK-NCR

HSM

SK-EPP, PK-EPP,
(PK-EPP) * SK-NCR

New EPP

ThuswhentheHSMandEPPexchangepublickeys,thesignatures
createdusingSKNCRarealsoexchanged.
TheHSMandEPPcaneachauthenticatetheotherspublickeyby
verifyingthesignaturesusingNCRPK.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-20

APTRA Advance NDC, Reference Manual

Security Features
RSA Initial Key Loading

Thisissummarisedinthefollowingdiagram:
Figure 11-10
HSM/EPP Key Authentication/Exchange

HSM

EPP
PK-EPP + (PK-EPP) * SK-NCR

HSM verifies (PK-EPP) * SK-NCR


using PK-NCR

PK-HSM + (PK-HSM) * SK-NCR

EPP verifies (PK-HSM) * SK-NCR


using PK-NCR

Asanadditionalauthenticationmeasure,everyEPPhasaunique
serialnumberSNEPPwhichiswrittentoitduringmanufacture.
TheserialnumberisalsosignedwithSKNCRandcanbe
transmittedtothehostandthehostsHSM.
AnewlyinstalledEPPrequiresanexchangeoftheabovemessages
withthehost,toauthenticatetheEPPtotheHSMandtheHSMto
theEPP.Oncetheauthenticationiscomplete,RSAencryptioncan
beusedtoloadtheinitialkeys(A,BandV)intotheEPP.
Note:Untiltheinitialkeyshavebeenloadedintotheencryptor,
AdvanceNDCisrestrictedintheoperationsitcanperform.In
particular,itcannotMACanymessageswithoutaMACkeyorB
key;thereforetheauthenticationprocesscannotusemessage
formatswhichwouldnormallyhaveaMAC.
TheExtendedEncryptionKeychangemessageisusedforsending
informationtotheterminal,andanewmessageformat(Encryptor
InitialisationData)isusedforsendinginformationfromthe
terminaltothehost.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-21

Security Features
RSA Initial Key Loading

AuthenticationMessageSequence

11

ThemessagesequencetoauthenticateanEPPinAdvanceNDCisas
showninthefollowingdiagram:
Figure 11-11
EPP Authentication Message Sequence

Host

Terminal
EEKC, 'F' - Send EPP serial number
EID, '1' - EPP serial number and signature or Reject

EEKC, 'B' - Load HSM public key and signature

EID, '5' - Key loaded or Reject

EEKC, 'G'

- Send EPP public key

EID, '2' - EPP public key and signature or Reject

Where:
EEKC=ExtendedEncryptionKeyChange(fordetails,seethe
ExtendedEncryptionKeyChangesectioninChapter 10,Central
toTerminalMessages).
EID=EncryptorInitialisationData(fordetails,seetheEncryptor
InitialisationDatasectioninChapter 9,TerminaltoCentral
Messages).
Note:IftheterminaldoesnotcontainanEPP,themessageswillbe
rejectedwitharejectreasonofE02Functionnotsupportedby
hardware.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-22

APTRA Advance NDC, Reference Manual

Security Features
RSA Initial Key Loading

ChangingtheEncryption
KeyEntryMode

Aftertheauthenticationsequenceisperformed,theencryptionkey
entrymodecanbechangedremotelyusingthefollowingsequence:
11

Figure 11-12
Key Entry Mode Remote Change
Sequence

Host

Terminal
EEKC, 'J' - Set Key Entry Mode

EID, '6' - Key Entry Mode

Where:
EEKC=ExtendedEncryptionKeyChange(fordetails,seethe
ExtendedEncryptionKeyChangesectioninChapter 10,Central
toTerminalMessages).
EID=EncryptorInitialisationData(fordetails,seetheEncryptor
InitialisationDatasectioninChapter 9,TerminaltoCentral
Messages).
Warning:

ChangingthekeyentrymodedeletesalltheDESkeysinthe
encryptor.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-23

Security Features
RSA Initial Key Loading

LoadingDESKeys
Figure 11-13
DES Key Load Message Sequence

11

AfterperformingtheEPPAuthenticationProcess,theDESkeyscan
beloadedusingthefollowingmessagesequence:

Host

Terminal

EEKC, 'C' - Load initial master key (A - key) with RSA key
EID, '3' - New master keys KVV

EEKC, '2' - Load comms key with Master key

EID, '3' - New comms keys KVV

EEKC, '5'

- Load MAC key with Master key

EID, 3' - New MAC keys KVV

EEKC, 'A'

- Load V key with Master key

EID, 3' - New V keys KVV

EEKC, '9'

- Load VISA key table with V key

EID, 3' - New VISA keys KVVs

Where:
EEKC=ExtendedEncryptionKeyChange(fordetails,seethe
ExtendedEncryptionKeyChangesectioninChapter 10,Central
toTerminalMessages).
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-24

APTRA Advance NDC, Reference Manual

Security Features
RSA Initial Key Loading

EID=EncryptorInitialisationData(fordetails,seetheEncryptor
InitialisationDatasectioninChapter 9,TerminaltoCentral
Messages).
KVV=KeyVerificationValue(seetheKeyVerification
Valuessection).

RSAEncryptedDESKey
Format

11

WhenloadinganinitialDESkeyusingRSAencryption,the8or16
bytesofthekeyareencryptedusingtheRSAESPKCS1v1_5
schemedescribedintheRSALaboratoriesCryptographicToken
InterfaceStandard(PKCS#1v2.0).
Theterminalwilldecodetheblockasasingleordoublelengthkey,
dependingonthekeyentrymodeselectedinSupervisormode.
Fortransmissiontotheterminal,thedataisencodedasdescribedin
Base94EncodingandDecoding.

SignatureFormat

11

MessagesignaturesaregeneratedusingtheRSASSAPKCS1v1_5
schemedescribedintheRSALaboratoriesCryptographicToken
InterfaceStandard(PKCS#1v2.0).TheSecureHashAlgorithm
(SHA1)isappliedtothemessage,andtheresultisencrypted.
SHA1isdescribedintheFederalInformationProcessingStandard
(FIPS1801)SecureHashStandard.
FortransmissionbetweenCentralandtheterminal,thesignatureis
encodedasdescribedinBase94EncodingandDecoding.
Note:WhenapublickeyistransmittedfromNDCtoCentral,only
256bytesofthemodulusaresent.Thebytesdescribingthe
containingstructureandtheexponentofthekeyneverchange,so
theyarenottransmitted.Thecompletekeystructureshownbelow
mustbereconstitutedbeforethesigningprocess.
3082010ATag:structure,length266bytes
02820101Tag:integer,length257bytes
00Leading00ensuresmodulusispositive
MM..MM256bytemodulus
0203Tag:integer,length3bytes
010001Exponent(always65537)

Therefore,toreconstitutethekey,bracketthemodulus(MM..MM)
withthefollowingbytesequences:
3082010A0282010100MM..MM0203010001

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-25

Security Features
RSA Initial Key Loading

Base94Encodingand
Decoding

Base94encodinganddecodinghasbeenintroducedtosatisfythe
followingconstraints:
11

Publickeys,RSAencrypteddataandsignaturesconsistof
blocksof256bytes.
DuringtheinitialisationoftheEPP,bothencryptedkeysand
signaturesmustbeexchangedwiththeHSMinthehost.
Onlygraphiccharacterscanbetransmitted,asthecontrol
charactersareusedforthecommunicationsprotocoland
messageformatting.

Currently,NDCuseshexadecimalordecimalencodingtotransmit
binarydata.However,hexadecimalencodingdoublesthenumber
ofbytes,anddecimalencodingtriplesthenumberofbytes.Clearly,
giventheblocksizeandthemessagelengthconstraints,neither
encodingmethodissuitableforRSAblocks;anewencoding
methodisrequired.
Thereare94graphiccharacterswhichcanbeincludedinthefields
ofanNDCmessage.ThesehaveASCIIcodesintherange20
hexadecimal(space)to7E(tilde).Usingthesecharacters,itis
possibletoperformabase94encoding,whichisfarmoreefficient
thanabase16orbase10encoding.
Unlikedecimalorhexadecimalencoding,theresultisunreadable.
However,theoriginalencryptedblockwasalreadyunreadable,so
thismakesnodifference.
Thefollowingbase94encodingschemegivesaratioforencoded
bytestobinarybytesof5to4.Thusa256byteRSAblockcanbe
transmittedin320bytes.

Encoding
Inbase94encoding,256bytesofsourcedataareencodedinto320
bytesofencodeddata.Everyfourbytesofbinarydatabecomefive
charactersofencodeddata.
Thebase94encodingprocessisasfollows:
1

Takeeachsetoffourbytesofsourcedata(src_data)andforma
32bitword(acc),suchthatthefirstbyte(src_data[0])becomes
theleastsignificantbyteofacc.SeeNote1:
acc = 0
for i = 0 to 3
{
acc = acc * 256 + src_data [3 - i]
}

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-26

APTRA Advance NDC, Reference Manual

11

Security Features
RSA Initial Key Loading

Convertaccintofivebase94digits,bydividingby94andtaking
themodulus.Toshifteachdigitintotheusablecharacterrange,
add32(ASCIIspace).Savethedigitsintheencodeddata.The
firstdigitistheleastsignificant.
for i = 0 to 4
{
enc_data [i] = acc % 94 + 32
acc = acc / 94
}

Note1:Theorderingofbytesisselectedsothattheconversion
betweena32bitwordandfourbytesofdatacanbeimplemented
efficientlyonanIntelprocessor,byforcingthedatatyperatherthan
usingaloop.
Note2:WhenEBCDICisusedfortransmission,theencodingis
stillperformedusingtheASCIIcharactersetandthentheresultis
convertedtoEBCDIC.

Decoding

11

Inbase94decoding,320bytesofencodeddataaredecodedinto256
bytesofbinarydata.Everyfivedigitsofencodeddatabecomefour
bytesofbinarydata.
Thebase94decodingprocessisasfollows:
1

Takeeachsetoffivedigitsofencodeddata(enc_data)and
convertfrombase94tocreatea32bitword(acc).Eachdigitis
shiftedintotherange0to93,bysubtracting32.Thefirstdigitis
theleastsignificant.
acc = 0
for i = 0 to 4
{
acc = acc * 94 + enc_data [4 - i] - 32
}

Splitaccupintofourbytesofdestinationdata(dst_data).The
leastsignificantbyeofaccbecomesdst_data[0].
for i = 0 to 3
{
dst_data [i] = acc % 256
acc = acc / 256
}

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-27

Security Features
Double-Length Keys

DoubleLengthKeys

11

Forgreatersecurity,NCRrecommendsthatdoublelengthkeysare
used.ForeffectivePINandencryptionkeymanagement,the
followinggeneralandAdvanceNDCspecificguidelinesshouldbe
followed:

GeneralGuidelines

Thefollowinggeneralsecurityguidelinesshouldbeapplied:
11

AdvanceNDCGuidelines

11

Toprotectsensitiveinformation,allDESkeysshouldbedouble
lengthtosupporttripleDESencryption.KeysusedforPIN
blockencryptioncanstillbesinglelength.
PINsandencryptionkeysshouldbetripleDESencryptedwhen
outsidetheterminalssecuritymodule.
Keysshouldnothavemultipleuses.Forexample,thekeyused
toprotectotherkeysduringtransfershouldnotbeusedfor
transferringPINblocksorforlocalPINverification.
Initialkeysshouldbeloadedorentereddirectlyintothe
encryptormoduleintwoormorefulllengthcomponents,and
thenXORedtogethertocreatethekey.
PINblocksshouldbeISOformat3,unlessthePINblock
encryptionkeysarechangedregularly,inwhichcaseISO
format0(ANSI)PINblockisacceptable.
MACingshouldbeusedtopreventmodificationofsensitive
dataduringtransmission.

Fromrelease2.04onwards,AdvanceNDCsupportstheEncrypting
PINPad(EPP)anddoublelengthkeys.
Theaboveguidelinescanbemetbyusingthefollowingmodesof
operationwithAdvanceNDC2.04orabovewithanEPP:

Allkeysusedshouldbedoublelength,includingthemasterkey
(Akey),communicationskey(andBkey),MACkeyandVISA
masterkey.
Useonlythemasterkeyforloadingotherencryptionkeys,and
donotusethemasterkeyforanyotherpurpose.
UsethecommunicationskeyforPINblockencryptionandISO
format3PINblock.
PerformMACingintripleDESmode.
Loadtheinitialmasterkey(AKey)intotheencryptor,andthen
usethemasterkeytoloadalltheotherrequiredkeys.Donotuse
themasterkeyaspartofthelocalPINverificationorforPIN
blockencryption.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-28

APTRA Advance NDC, Reference Manual

Security Features
Double-Length Keys

Althoughallkeysusedshouldbedoublelength,itispossibletouse
asinglelengthEncryptedPINKey(PEKEY)providedthePINblock
isalsoencryptedusingthecommunicationskey.
SinglelengthkeyscanstillbeusedforlocalPINverification
schemes.
Forstrictadherencetotheguidelines,noothermodeofoperation
shouldbepossible.However,forbackwardscompatibilityall
currentoperationsaresupported,withalocallyconfigurableoption
torestrictthefunctionalitytotherecommendedmodes.
TheseguidelinescanonlybefullyfollowedifanEPPispresentin
theterminal.ThesecurityfeaturesprovidedusingaBAPEandan
EPParelistedinBAPESecurityandEPPSecurityrespectively,
earlierinthischapter.

DoubleLengthRestricted
KeyEntryMode
11

TheKeyEntrymenu,availablefromAccessMenuoption25,canbe
usedtosetthekeyentrymodetooption4Doublelength
restricted.
Note:OnlyKeyAandKeyVcanbeenteredlocallywhenusingkey
mode4.
Thisrestricteddoublelengthkeyentrymodepreventsthe
followingsecurityviolations:

DecipheringanewCommunicationskeywiththecurrent
Communicationskey
DecipheringanewMessageAuthenticationCode(MAC)key
withthecurrentCommunicationskey
UsingaCommunicationskeyasthecurrentMACkey
SendingaPINblockunencrypted
Usingsinglelengthkeys,exceptforPEKEYifthePINblockis
alsoencryptedusingthecommunicationskey.

Inthiskeyentrymode,anymessagesfromCentralwhichrequest
theseoperationsarerejectedasMessageillegalinrestricted
encryptionmode.
Ifanattemptismadetoimportakeywiththesamevalueasthe
currentlyloadedkey,theimportisrejectedwithanEncryption
keychangefailedmessage.
Forfurtherdetailsofthemenuoptions,refertotheAPTRAAdvance
NDC,SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

11-29

Security Features
Journal Printer Backup

JournalPrinterBackup

11

Journalprinterbackupletsjournallingcontinueevenwhenthe
journalprinterisinafatalstate.Tosettheoption,setoneorbothof
options16and17intheEnhancedConfigurationParametersLoad
message.
Note:Options16and17arenotsupportedwhendualmodeis
activeontheSST.Iftheoptionsaresent,theyareignored.
Option16specifiesthemaximumtimeinhoursthatjournalprinter
backupisallowedbeforealljournallingisdiscontinued.Option17
specifiesthemaximumnumberofprintoperations(inhundreds)to
bebufferedwhilethejournalprinterisfatal.Fordetailsofhowto
settheseoptions,seetheEnhancedConfigurationParameters
LoadsectioninChapter 10,CentraltoTerminalMessages.
Ifjournalprinterbackupissetandthejournalprinterentersafatal
state,journallingcontinues,usingthejournalbackupmodeandthe
bufferfileresidentonthesystemdisk.Thejournallingincludesthe
textofthelastjournalprintercommandsenttothejournalprinter
beforeitenteredthefatalstate.
Fordetailsofwhathappenstothedatawhenthejournalprinter
becomesoperationalagain,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
Forsecurityreasons,reprintingfromthejournalbackuplogtothe
journalprinterissuspendediftheSSTgoesoffline,butcontinuesas
soonascommunicationshavebeenreestablished.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

11-30

APTRA Advance NDC, Reference Manual

Table of Contents
EMV Smart Card Handling

Chapter 12

EMVSmartCardHandling
Overview

121

AcceptingandReadingCards
MotorisedReaders
DIPReaders
ReadConditionsandFITMatch
MotorisedReaders
DIPReaders

122
122
122
122
122
123

UsingEMV/CAM2ExitsforAdvanceNDC
ExampleChipDataReadState
GuidelinesforHandlingSmartCardTransactions
MagneticSmartCard,FITCheckonMagneticData
MagneticSmartData,FITCheckonSmartData
Recommendations

124
126
126
127
127
128

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
EMV Smart Card Handling

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

EMV Smart Card Handling


Overview
L

Overview

12

Thesmartcardhandlingdescribedinthischapterillustrateshow
EMVsmartcardscanbeusedwithAdvanceNDC.
ForfurtherdetailsofusingEMVsmartcards,refertotheEMV
IntegratedCircuitCard(ICC)ReferenceManual(B0066297).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

12-1

EMV Smart Card Handling


Accepting and Reading Cards

AcceptingandReadingCards

12

Theprocessforacceptingcardsintothereadervariesdependingthe
typeofreader,andwhethersmartcardsaresupportedandrequired
bythereadconditions.

MotorisedReaders

DIPReaders

12

12

Formotorisedreaders(SDCMCRW,RS232orUSBIMCRW),
AdvanceNDCsupportsnonmagneticaccept,whichpermitsacard
withoutamagneticstripe(asmartcard)tobeinsertedintothe
reader.
WithaDIPreader,thereisnocontroloverwhattypeofcardis
insertedintothereader.ExceptfortheDASHreaderincertain
conditions,thecardholderisexpectedtodipthecard,thatis,insert
andremovethecard.Thecardisreadasitisremoved.
ForaDASHreaderthecardwillbelatchedonentryifthefollowing
conditionsaremet:

ThestatetypeisT
Thechipconnectbitissetto1.

Note:IfusingaDASHreaderandstatetypeT,butnochip
connectbitisset,theDASHwillbehaveasastandardDIPreader.
Onceasmartreadhasbeendetermined,nomagneticreadis
performed.
Forinformationonadditionalfatal/suspendhandlingavailablefor
DASHreaders,refertotheAPTRAAdvanceNDC,DevelopersGuide.

ReadConditionsandFIT
Match

12

Theprocessingofthereadconditionsvaries,dependingontheuse
ofthechipconnectbitinthereadconditions,andonthetypeof
cardreader.
Ifnoneofthereadconditionshasthechipconnectbitset(orthe
readerdoesnotsupportsmartcards)thentheprocessingisthe
sameforalltypesofreader.Thecardreadstatewillprocesstheread
conditionsinorderandreadtherequiredtrackstosatisfythem.
Ifanyreadconditionhasthechipconnectbitset(andthereader
supportssmartcards)thentheprocessingvariesbetweenmotorised
readers(MCRWorIMCRW)andDIPreaders(forexample,DASH).

MotorisedReaders
Formotorisedreaders,theconditionsareprocessedinorderuntil
thefirstconditionwhichhasthechipconnectbitset.Atthispoint
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

12-2

APTRA Advance NDC, Reference Manual

12

EMV Smart Card Handling


Accepting and Reading Cards

allremainingtracksthatmayberequiredtosatisfytheremaining
readconditionsareread.
Ifasmartcardisfound,thenextstatewillbetheNoFITMatchnext
state.Ifnosmartcardisfoundbutoneofthereadconditionshas
beensatisfiedusingmagnetictracks,aFITsearchisperformed.
Dependingontheresultofthesearch,eithertheFITMatchorNo
FITMatchnextstatenumberwillbeused.
IftheSmartChipstateisreadfirst,theMagneticTrackDataisnever
readandthereforetheSmartChipstate(008)shouldalwaysbethe
laststatetobedefinedintheReadConditions.

DIPReaders

12

ForaDIPreader,themagnetictracksarereadoncardremoval.
IftheSSThasaDASHcardreader,andanyoftheCardRead
ConditionshastheChipConnectBitsetto1,thecardislatchedon
entrytotheDASHcardreader.Latchingthecardonentrytothe
readerallowsEMVprocessingtobegin.
IftheAnswerToResetfromthechiponthecardissuccessful,the
NoFITMatchnextstateistakenandnomagnetictrackdatawillbe
available.Itis,however,possibletoreverttomagneticstripe
processinguponachiperrorbyusingtheEMVSmartDIPTake
CardState.
Note: IfusingaDASHreaderandCardReadStateA,orCardRead
StateTwithnochipconnectbitset,theDASHwillbehaveasa
standardDIPreader.
IftheAnswertoResetfromthechiponthecardfails,theDASH
cardreaderwillunlatchthecardandthecardholderisaskedto
removethecard.Oncethecardisremoved,normalmagneticstripe
processingcommencesandthecardreadconditionsarechecked.If
oneofthereadconditionsissatisfiedusingmagnetictracks,aFIT
searchisperformed.Dependingontheresultofthesearch,either
theFITMatchorNoFitMatchnextstatenumberwillbeused.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

12-3

EMV Smart Card Handling


Using EMV/CAM2 Exits for Advance NDC

UsingEMV/CAM2ExitsforAdvance
NDC
12

IfyouareusingyourownExitstoprocesssmartcardsinsteadof
EMV/CAM2ExitsforAPTRAAdvanceNDC,theNoFITMatch
nextstatehastobeaCExitstatewithtwofunctions,asfollows:

Ifachiphasbeendetected,itreadsanychipdataandplacethe
datainthemagnetictrackbuffersbeforeswitchingtotheSmart
FITCheckstate.
Ifnochiphasbeendetected,orthecardfailedamagneticFIT
checkwithinstateA,thentheNoFITMatchstateexits,probably
toaClosestate.

FordetailsofcreatingCExitstates,refertothepublicationAPTRA
AdvanceNDC,ExtendingtheProduct.FordetailsofhowaNoFIT
Matchnextstatemightwork,seeExampleChipDataReadState
onpage 126.
Ifchipdatahasbeensuccessfullyreadfromthecard,andplaced
intothemagnetictrackbuffersbytheCExitstate,theSmartFIT
Checkstate(k)willperformaFITcheckonthatdata.Fordetailsof
thisstate,seekSmartFITCheckStateinChapter 2,State
Tables.
Thereadstatehandlingisshowninthefollowingillustration.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

12-4

APTRA Advance NDC, Reference Manual

EMV Smart Card Handling


Using EMV/CAM2 Exits for Advance NDC
Figure 12-1 Smart Card Handling

Exits Card Read State


Magnetic FIT
Check Passed

Chip
detected

Good Read Next State

No chip detected or
Magnetic FIT check failed

No FIT Match Next State (C-Exit)

Read smart data and


place in track buffers

Smart FIT Check State ('k')

Smart FIT
Check Passed

Perform Smart
FIT check

Good Read Next State

No FIT Match Next State

Smart FIT
Check Failed

No FIT Match Next State

Rest of transaction

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

12-5

EMV Smart Card Handling


Using EMV/CAM2 Exits for Advance NDC

ExampleChipDataRead
State

12

ThisstateisanexampleofaCExitcreatedtoallowFITcheckstobe
performedonsmartdata.ItwouldbedefinedastheNoFITMatch
nextstateenteredfromtheCardReadstate.
TheChipDataReadstatehastwodistinctfunctions,asfollows:

TohandlefailedmagneticdataFITchecksfromwithintheCard
ReadState.
Toreadsmartcarddataandplaceitinthethreedatabuffers
readyfortheSmartFITCheckstatetoperformaFITcheck.

ThepositionofthecardonentrytotheChipDataReadstatewill
indicatewhichfunctionisrequired.
Thestatetablebelowshowstherecommendedparametersfora
ChipDataReadstate,buttheexactfunctionalitywillbedetermined
byindividualcustomers,accordingtotheirneeds.Fourfurther
parametersareavailableifrequired.
Table 12-1
Chip Data Read State
Table
Entry

Number of
Characters

Contents

Description

StateType

Thisshouldbealetterchosenfromthoseavailable
forCExitStates.Foralistofstatetypes,see
Chapter 2,StateTables.

GoodChipReadNextState

Statetowhichtheterminalproceedsifchipdatais
successfullyreadandthetrackbuffersaresetup.
ThisshouldnormallybeaSmartFITCheckState.

CardRejectNextState

Statetowhichtheterminalproceedsifeitheracard
hasfailedamagneticcardFITcheckcarriedoutin
StateA,orreadconditionshadthechipconnectbit
setbutnochipcouldbefound.

NoCardDataNextState

Statetowhichtheterminalproceedsiftheaccept
commandwasfornonmagneticcards,andnochip
dataormagneticdatawasfound.Thisstatecould
indicatetothecardholderthatthecardhas
probablybeeninsertedwiththewrongorientation.

CancelNextStateNumber

Statetowhichtheterminalproceedsifthe
cardholderpressestheCancelkey.

GuidelinesforHandling
SmartCardTransactions

12

Thissectionprovidesrecommendationsandguidelinesonhowto
handlesomeofthepossibletransactionsinvolvingsmartcards.
Notethatthedifferentscenarioswillrequiredifferentvaluestobe
setinEnhancedConfigurationParametersLoadoption39
(NonmagneticCardAccept).Thesettingchosenwillbedetermined

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

12-6

APTRA Advance NDC, Reference Manual

EMV Smart Card Handling


Using EMV/CAM2 Exits for Advance NDC

bythetypeofcardstobeacceptedandwhetherornotyouare
operatinganSSTnetworkwithamixtureofsmartandnonsmart
cardreaders.

MagneticSmartCard,FITCheckonMagneticData

12

Thistransactioninvolvesamagneticsmartcardonly.AFITcheckis
performedonthemagneticdata.

CardReadState(AorT)cardholderentersamagneticsmart
card,andaFITcheckisperformedsuccessfullyonmagnetic
datatracksasdefinedbythereadconditions.
PINEntryState(B)cardholderentersPIN,whichisverified.
FDKSelectionState(EorY)cardholderselectstodoasmart
cardtransaction.
SmartCardTransactionState(auserdefinedCExitstate)the
smartcardisstagedand,ifachipisdetected,amenuofsmart
cardtransactionoptionsisdisplayed.FurtherAdvanceNDC
andCExitstatesmaythenbeexecuted.SeeNotebelow.
CloseState(J)cardisreturnedtothecardholderandthe
transactionends.

Note:Whereasmartcardismovedtoorfromthestagedposition
withinaCExitstate,itisimportanttoupdatetheshareddata
valuesbeforereturningcontrolofthetransactiontoAdvanceNDC.

MagneticSmartData,FITCheckonSmartData

12

Thistransactioninvolvesamagneticsmartcardonly.AFITcheckis
performedonthesmartdata.

CardReadState(AorT)cardholderentersamagneticsmart
card.Firstreadconditionhaschipconnectbitsetsomagnetic
dataisreadandthenthecardisstagedinthesmartcard
position.Achipissuccessfullydetected,andsothenextstateis
settoaChipDataReadstate.
Note:IfusingaDASHreaderandCardReadStateA,orCard
ReadStateTwithnochipconnectbitset,theDASHwillbehave
asastandardDIPreader.

ChipDataReadState(auserdefinedCExitstate)chipdatais
readandplacedinthemagneticcardreadbuffers.
SmartFITCheckState(k)aFITcheckisperformed
successfullyonthemagneticreadbuffers.
PINEntryState(B)cardholderentersPIN,whichisverified.
TransactionStatetransactioniscarriedout.Furtherstandard
AdvanceNDCandCExitstatesmaythenbeexecuted.SeeNote
above.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

12-7

EMV Smart Card Handling


Using EMV/CAM2 Exits for Advance NDC

CloseState(J)cardisreturnedtothecardholderandthe
transactionends.

Recommendations

12

Donotusenonmagneticcardacceptcommandsunlessyouhaveto
handlenonmagneticsmartcards.
Duringnonmagneticsmartcardaccept,ifnomagneticorchipdata
isfound,displayascreenduringtheClosestateindicatingtothe
cardholderthecorrectorientationforenteringcards.
WherethesamereadconditionsaretobeusedonSSTswitha
mixtureofmagneticcardreadersandsmartcardreaders,makesure
thatthereisatleastonemagneticdataonlyreadconditioninthe
CardReadState.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

12-8

APTRA Advance NDC, Reference Manual

Table of Contents
CCM VISA2 Dialup System

Chapter 13

CCMVISA2DialupSystem
Overview

131

DialupSystemSetup
BaudRate
DialupTimers
ModemTimers
ApplicationTimers
PreDialandNormal
EJUpload

132
132
132
132
133
133
133

DialupMessages:SSTtoCentral
ImAliveMessage
ActivityTimer
ErrorRedialTimer
TransactionCompletion
MessageonCP
MessageSuppression

134
135
135
136
136
136
136

DialupMessages:CentraltoSST
DisconnectMessage
NoOpMessage
ExampleUsageoftheNoOpCommand
GoOutofService(SupervisorMode)

137
137
138
139
139

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
CCM VISA2 Dialup System

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

CCM VISA2 Dialup System


Overview
M

Overview

13

Withadialupsystem,theapplicationbehaviourisnotalwaysthe
sameasinothersystems.Thischapterdiscusseshowmessagesare
handledonSSTsthatuseCCMVISA2dialupcommunicationswith
Central.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

13-1

CCM VISA2 Dialup System


Dialup System Setup

DialupSystemSetup

13

Dialupfunctionalityisenabledthroughtheregistryandconfigured
throughtheDialupConfigurationmenuinSupervisor.

BaudRate

13

DialupTimers

13

AsSSTtransactionmessagesforatransactionsessionaresmallin
sizeandfewinnumber,connectingquicklyismoreimportantthan
highspeeddatatransfer.Therefore,NCRrecommendsafixed,
lowspeedbaudratetoreducediallingtimeandminimize
retransmissionforerrorcorrection.
TimersdeterminethewaythattheDialupcomponentworksand
theymustbesettothecorrectvaluesforittofunctioncorrectly.

ModemTimers

13

Thelowerlevelcommunications(modem)timers,suchasthe
ModemConnecttimer,theModemCommandResponsetimerand
theDialonSendtimer,affectthevaluesfortheapplicationlevel
timerssuchasTimer3,andtheErrorRedialTimer.
Table 13-1
Modem Timers
Modem Timer

Description

ModemConnect

TheamountoftimeCCMVISA2willwaitforaconnectionattempttoahostmodemtobe
successfulbeforetryingtoconnectagain

ModemCommand
Response

TheamountoftimeCCMVISA2willwaitforaresponseacknowledgmentfromthehost
beforetryingtosendthecommandresponseagain.

DialonSend

WhentheSSTsendsamessagesuchasanunsolicitedmessage,anEJupload,ora
responsetoterminalcommand,thisisdoneaccordingtotheDialonSendtimer.
ThedialupconnectionismaintaineduntileithertheDialonSendtimerexpiresorthehost
terminatestheconnection.Thedurationofthistimershouldthereforebeshort,butlong
enoughtosendthelongestmessageandallowtimeforanyhostreply.Thistimeris
configurablethroughSupervisor.Thedefaultis20secondsbutforsystemswithlong
downloadmessages,suchasscreenorstatemessagesorEMVsystems,thiswillprobably
needtobeincreasedtoatleast30seconds

ThemodemtimersarealsoaffectedbythenumberoftimesCCM
VISA2willretryfailedconnectionsorunacknowledgedmessagesto
thehost.ThissettingcanbeconfiguredinSupervisor.Thedefault
settingis2.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

13-2

APTRA Advance NDC, Reference Manual

CCM VISA2 Dialup System


Dialup System Setup

ApplicationTimers

13

Theapplicationleveltimersmustbeconfiguredaccordingtothe
modemtimersasdescribedinthefollowingtable.These
calculationsrepresenttheminimumrecommendedvalueforthese
timers,andtheycanbeincreased.
Table 13-2
Application Timer Settings for Dialup
Application
Timers

Setting Calculation

Description

Timer3

(NumberofRetries+1)x(ModemConnect
timer+ModemCommandResponse
timer)

Allowstimeformodemerrorprocessingtobe
completedifaTransactionRequestfailstobesentor
aconnectionfailstobeestablished.Theusualvalue
forthisonothersystems(about2025seconds)will
probablynotbelongenoughforadialupsystem.

Error
Redial
Timer

(NumberofRetries+1)x(ModemConnect
timer+ModemCommandResponse
timer)

Canbeanylengthoftimedependingonhowoften
retriesarerequiredwhenalineerroroccurs;butfor
themodemlinktoperformerrorrecovery,itmust
neverbelessthanthiscalculation

PreDialandNormal

13

TwooptionsareavailableinSupervisortoconfigurewhentheSST
willdialCentral,asfollows:

EJUpload

13

Normal
DialonlywhentheTransactionRequestisreadytobesent.This
isthedefault.
Predial
Dialoncardentry.

Normally,EJuploadacknowledgementsmustbereceivedwithin
theEJtimerperiod.Foradialupsystem,theacknowledgement
mustbereceivedwithintheDialonSendtimerperiod.NCRadvises
thattheEJtimeristhesamelengthoftimeastheDialonSendtimer.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

13-3

CCM VISA2 Dialup System


Dialup Messages: SST to Central

DialupMessages:SSTtoCentral

13

Inadialupsystem,messagesfromtheSSTtoCentralalwayshavea
header,withthefollowingformat:
Table 13-3
SST Messages Header Format
Field

Number of
Characters

Type

Contents

Description

Device
Type

Alphan
umeric

50

ModifiedVISAIIprotocol.

BIN

Alphan
umeric

xxxxxxx

Routinginformationforcommunicationsaccess;
configurableinSupervisor.

Terminal
ID

12

Alphan
umeric

xxxxxxxxxxxx

TerminalID,12charactersequencecomprisedofthe
following:

Positions1to2:Thefirst2charactersofthe
sixdigitTerminalIDasenteredinSupervisor
(DialupConfigmenu)

Positions3to8:sixdigitmachinenumberas
enteredinSupervisor(Configuremenu)

Positions9to12:Characters3to6ofthe
sixcharacterTerminalIDasenteredinSupervisor
(DialupConfigmenu).

FS

Byte

1Ch

Fieldseparator.

RQorEQ
SeeTableNote1

Transactionrequestmessage.

CPorEP
SeeTableNote1

CommunicationComplete.Usedwithasolicited
statusReadymessagetocompleteanormal
transaction(withdrawal,balance,transfer)and
disconnect.Alsousedinastatusresponsetoanew
operationalcommandwithadisconnectcommand
code.

CCorEC
SeeTableNote1

ConnectContinuation.Usedtomaintainaconnection
withthehostwhenthecurrentsequenceofmessages
isnotcomplete;forexample,withunsolicitedstatus
messages,orwitharesponsetoaWriteCommand
(OARordownloading).

Message
Type

Message
Text

var.

Alphan
umeric

SSTtextmessage.SeeTableNote2.

TableNote1:Whenthesystemisconfiguredtosendatransaction
completionmessagetoCentral,RQ,CCandCPareused;when
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

13-4

APTRA Advance NDC, Reference Manual

CCM VISA2 Dialup System


Dialup Messages: SST to Central

itisnotconfiguredtosendacompletionmessagetoCentral,EQ,
ECandEPareused.ThisallowsCentraltoidentifywhichmode
theSSTisoperatingin.
TableNote2:Onlynumericdatacanbeenteredthroughthe
Supervisormenus.Forwaysofprovidingalphabeticdata,referto
theAPTRAAdvanceNDC,DevelopersGuide.

ImAliveMessage

13

TheImAlivemessageisasolicitedstatusmessagewithastatus
descriptorofFandamessageidentifierof6.Thismessageissent
asifanetworkoperationalcommandmessagewithacommand
codeof3requestingconfigurationIDhasbeenreceivedandis
controlledbytwotimers:theActivitytimerandtheErrorRedial
timer.

Table 13-4
Im Alive Message Format
Field

Number of Bytes

Mandatory/
Optional

Description

Var

HeaderProtocoldependent.

MessageClass.Themessageclassis:
2Solicitedmessage.

MessageSubClass.Themessagesubclassis:
2Statusmessage.

FS

FieldSeparator.

3or9

LogicalUnitNumber(LUNO).ThisNumberisdefinedina
fieldtransmittedtotheterminalinaConfigurationParameters
Loadmessage.Thedefaultnumberis000.Ifthedatasecurity
featureisconfigured,anadditionalsixcharactersarepresent
thatcontainthemachinenumber.

FS

FieldSeparator.

FS

FieldSeparator.

StatusDescriptor.Describesthestatusmessageasfollows:
FTerminalState.

FS

FieldSeparator.

Var

Statusinformation.

ActivityTimer

13

TheActivitytimerdeterminesthelengthoftimetowaitbefore
sendinganImAlivemessage.Thetimerisstartedondisconnection
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

13-5

CCM VISA2 Dialup System


Dialup Messages: SST to Central

ofthelinetoCentralandstoppedonconnection.Ifthetimer
expires,theSSTattemptstoestablishaconnection.Iftheattempt
succeeds,anImAlivemessageissent.Thetimerisconfigurable
throughtheDialupConfigmenuinSupervisor.

ErrorRedialTimer

13

Whenanerrorisencounteredontheline,theSSTgoesofflinefor
theperiodoftheErrorRedialtimer,afterwhichitdialsupand
attemptstosendanImAlivemessage.Iftheattemptsucceeds,the
SSTwillgoinservice.Iftheattemptfails,theSSTremainsoffline
andrestartsthetimer.ThetimerisconfigurablethroughtheDialup
ConfigmenuinSupervisor.

TransactionCompletion

MessageonCP

13

13

MessageSuppression

13

Normally,anSSTrespondstoatransactionreplywithaReady
message.Inadialupsystem,thedefaultbehaviourisforaReady
messagetotriggeradisconnection.However,Transaction
CompletioncanbedisabledthroughSupervisor.Inthiscase,
CentralwillbeexpectedtodisconnectassoonastheTransaction
ReplyhasbeenacknowledgedbytheSSTandnoReadymessage
willbesent.AsolicitederrororrejectmessagewillcausetheSSTto
redialCentral.
WhenaCPmessageissenttoCentral,theconnectionisnormally
terminatedbyCentral.However,ifCentraldoesnotterminatethe
connectionandMessageonCPisenabled,theconnectionis
maintainedaftertheCPmessageissent,forthedurationoftheCP
Messagetimer.ThisallowsCentraltosendanyadditionalmessages
suchastheNOOPmessage,andallowstheconnectiontobe
maintainedoverchainedtransactions.TheCPMessagetimeris
configurablethroughSupervisor.
Messagesuppressionisdisabledbydefaultbutcanbeenabled
throughSupervisor.ItallowssuppressionofAlarmsand
SupervisorKeyPressesmessagesexceptforSupervisorEntryand
Exitmessages,whicharealwayssent.Thesuppressedmessages
willstillbejournalled.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

13-6

APTRA Advance NDC, Reference Manual

CCM VISA2 Dialup System


Dialup Messages: Central to SST

DialupMessages:CentraltoSST

13

SomeCentralapplicationssendmessageswithaheaderinthe
followingformat.TheheaderallowsCentraltorequesttheSSTto
dialwhenitisidle.
IfaheaderispresentonmessagesfromCentral,theHostMessage
HeaderoptionmustbeenabledthroughSupervisor(Dialup
configurationmenu).
Table 13-5
Central Messages Header Format
Field

Number of Characters

Type

Contents

Description

Command
Pending
Flag

Alphan
umeric

AcommandispendingatCentral

Space

NocommandinpendingatCentral

Reserved

Spaces

Reservedforfutureuse.

Alphan
umeric

DisconnectMessage

13

CentralcansendaterminalcommandwithacommandcodeofF
todisconnecttheline.WhentheSSTsendsamessagetoCentraland
CentraldoesnothaveanymessagestosendtotheSST,Centralwill
sendthedisconnectcommandtotheSST.IftheSSThasanother
messagetosendtothehost,thatmessagewillbesent.IftheSST
doesnothaveanyothermessagestosendwhenthedisconnect
commentisreceived,theSSTwillsendaReadymessagetotrigger
disconnection.

Table 13-6
Disconnect Message Format
Field

Number of Bytes

Mandatory
/Optional

Description

Var

HeaderProtocoldependent.

MessageClass.Themessageclassis:
1TerminalCommand.

FS

FieldSeparator.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

13-7

CCM VISA2 Dialup System


Dialup Messages: Central to SST

Field

Number of Bytes

Mandatory
/Optional

3or9

LogicalUnitNumber(LUNO).ThisNumberisdefinedina
fieldtransmittedtotheterminalinaConfigurationParameters
Loadmessage.Thedefaultnumberis000.Ifthedatasecurity
featureisconfigured,anadditionalsixcharactersarepresent
thatcontainthemachinenumber.

FS

FieldSeparator.

FS

FieldSeparator.

Commandcode.Onecharacterfieldusedtoidentifythetypeof
TerminalCommandcode.Thecodeusedinthisfieldis:

Description

FDisconnect.

NoOpMessage

13

TheNoOpterminalcommand,withacommandcodeG,can
optionallybesenttotheSST.Thiscommandcanbeusedtotransfer
controlofthelinebacktotheSSTafteraCPorEP/Readymessage,
andretaintheconnection.Nomessageissentinresponsetothis
command.

Table 13-7
No-Op Message Format

Field

Number of Bytes

Mandatory/
Optional

Description

Var

HeaderProtocoldependent.

MessageClass.Themessageclassis:
1TerminalCommand.

FS

FieldSeparator.

3or9

LogicalUnitNumber(LUNO).ThisNumberisdefinedina
fieldtransmittedtotheterminalinaConfigurationParameters
LoadMessage.Thedefaultnumberis000.Ifthedatasecurity
featureisconfigured,anadditionalsixcharactersarepresent
containingthemachinenumber.

FS

FieldSeparator.

FS

FieldSeparator.

Commandcode.Onecharacterfieldusedtoidentifythetypeof
TerminalCommandcode.Thecodeusedinthisfieldis:
GMaintainconnectiontocompletetransaction(NoOp).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

13-8

APTRA Advance NDC, Reference Manual

CCM VISA2 Dialup System


Dialup Messages: Central to SST

ExampleUsageoftheNoOpCommand

13

Oneexampleofthisuseiswhereacustomertransactionrequires
tworequest/replycompletiontransmissionsinordertocomplete
thetransaction.TheNoOpcommandsentafterthefirstcompletion
allowsthesecondrequesttobesentwithouttheSSThangingup
andredialling.MessageonCPmustbeenabledthroughSupervisor
toallowamessagetobesentaftertheCPmessage.

GoOutofService
(SupervisorMode)

13

IfthehostsendsaGoOutofServicecommandtotheSSTwhilethe
SSTisinSupervisormode,theSSTwillsendaReadymessage
immediately.Thisisdifferentfromaleasedlinesystem,wherethe
commandisqueuedattheSSTandnotprocesseduntiltheSSTexits
Supervisormode.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

13-9

CCM VISA2 Dialup System


Dialup Messages: Central to SST

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

13-10

APTRA Advance NDC, Reference Manual

Table of Contents
Reserved Screens

Appendix A

ReservedScreens
Overview

A1

ASupervisorAcknowledgements

A2

EErrorScreens

A4

ISupervisorInformation

A17

MandmSupervisorMenus

A24

PSupervisorPrompts

A40

SSupervisorInformationLines

A46

TandtJournalTraceInformation

A50

UCheque,EMVSmartCardandBNA

A60

dSupervisorDiagnosticScreens

A66

iSupervisorTCP/IP

A68

iSupervisorDialup

A71

iSupervisorBNA

A84

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Reserved Screens

iSupervisorSettlementScreens

A89

jSupervisorMiscellaneousScreens

A92

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Reserved Screens
Overview

Overview

Thetablesinthisappendixillustratethedefaulttextforthe
Supervisormenuscreens,andtheotherreservedscreensnot
coveredinChapter 3,ScreenData.Forallthereservedscreens,
refertotheresrvd.deffileprovidedwithAdvanceNDC.
Somescreenscontainlongcontrolsequencesaswellasscreentext,
forexample,screenM06.Themeaningofthecontrolisexplainedin
thetable,insteadofthecontrolitself,whichyoucanseeinresrvd.def.
Otherscreenshaveprintercontrolsequences,forexample,M15.For
these,theASCIItextequivalentisshowninthetable,withan
explanationofwhatthecontroldoes.
Inresrvd.def,thepercentsign(%)isoftenusedtoindicatethestartof
textthatisdynamicallyeditedbytheterminalbeforethescreenis
displayedorprinted.Forscreensthatusethisconvention,the
percentsignactsasaplaceholderandshouldbeleftinplaceifyou
editorlocalisethetext.Thedataisdisplayedwithoutpadding.In
thetables,thepercentsignisusedtoshowthestartandextentofthe
spaceusedbythedynamicallyediteddata.
Foreachreservedscreen,thetablesidentifythescreennumberand
thepositionofthetextwithinthescreendata(thisisnotnecessarily
thefinalpositiondisplayedonthecardholderscreen/enhanced
operatorinterface).Textpositionisdisplayedbytherowand
columnpositionsforeachscreen,startingfromrow1,column1in
thetopleftcorner.Operatorscreensare16rowsby32columnsand
printerscreensare16by40.
Screenswithanasterisk(*)afterthescreennumberindicatethe
screensareusedonlyonothervendorsSSTs.Formoreinformation,
refertotheAPTRAAdvanceNDC,MultiVendorSupportReference
Manual.
Screensstartingwithalowercaseletterapplytofunctionality
developedforAdvanceNDCandareplacedafterscreensstarting
withanuppercaseletter,whichapplytobothAdvanceNDCand
NDC+.AdditionalSupervisormenusandfunctionsforTCP/IPand
Dialupcommunications,BNAandSettlementstartwitha
lowercasei,andaregroupedattheendoftheappendix.
Note:Sidewaysprintingonthereceiptisnotsupportedwhen
printingSupervisorreservedscreens.
ForinformationonthescreensusedinSupervisormodeandfor
journaling,refertotheAPTRAAdvanceNDC,SupervisorsGuide.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-1

Reserved Screens
A Supervisor Acknowledgements

ASupervisorAcknowledgements
Ascreensincludeacknowledgementlinesforthecardholderand
enhancedoperator(EOP)interfaces.
Fordetails,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
Table A-1
Supervisor Acknowledgement Screens

Column Position
Screen
Number

Row
Position

1
2
3
12345678901234567890123456789012

AcknowledgementLines
A00A0
3

Reserved

A04

SUPPLY STATE PRINTD

A05

ALL COUNTERS PRINTD

A06

PRINTER INITIALISED

A07

Reserved

A08

CONFIG PRINTED

A09

KEY A ENTERED

A10

KEY A STORED CHKSUM =

A11

KEY B ENTERED

A12

KEY B STORED CHKSUM =

A13

Reserved

A14

KEY V ENTERED

A15

KEY V STORED

A16

Reserved

A17

ACCESS DATA PRINTED

A18

ACCESS SET

A19

DEFAULT SET

A20

FUNCTION DONE

A21

FUNCTION CANCELLED

A22

E/JOURNAL ACTIVE

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-2

APTRA Advance NDC, Reference Manual

Reserved Screens
A Supervisor Acknowledgements
Column Position
Screen
Number

Row
Position

A23

A24
A40
A41

1
2
3
12345678901234567890123456789012
EJ LOG COPIED OK
Reserved

A42

COIN COUNTS CLEARED


Reserved

A43

ENVELOPE TAKEN

A44

CAMERA INITIALISED

A45

DEPOSIT INITIALISED

A46

FUNCTION EXITED

A47
A51
A52

Reserved
1

A53
A60
A61

EJ LOG RECOPIED OK
Reserved

A62
A69

EJ & JOURNAL ACTIVE


Reserved

A70

KEY A STORED

A71

KEY B STORED

A72
A88

Reserved

A89

KEY LOADED

A90

SILENTDEBUG STARTED

A91

SILENTDEBUG STOPPED

A92

SILENTDEBUG LOGS DELETED

A93

SILENTDEBUG LOGS COPIED

A94

SILENTDEBUG CONFIGURED

A95

STARTED

A96

STOPPED

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-3

Reserved Screens
E Error Screens

EErrorScreens

Eorescreensareerrormessagesthatappearonthecardholder
screenorenhancedoperatorinterface.
Fordetails,seetheAPTRAAdvanceNDC,SupervisorsGuide.
Note:TheExxxxscreensforpassbookprintersareshownonthe
faultdisplayindependentlyofthepresenceofpassbookauthored
flows.Ifapassbookprinterisattached,thefaultdisplayshowsany
passbookdeviceerrors.
Table A-2
Error Screens

Column Position
Screen
Number

Row
Position

E0000

EC00

E0001

EC01

E0002

EC02

E0003

EC03

E0004

ILLEGAL EKC KEYSPCE (notsupported)

E0005

NO HALLMARK KEY(notsupported)

E0006
E0009

1
2
3
12345678901234567890123456789012

Reserved

E0010

NO DISK IN DRIVE

E0011

FLOPPY PROTECTED

E0012
E0015
E0016

Reserved
1

E0017

EJ NOT PRESENT
Reserved

E0018

TOO MANY DIGITS

E0019

NOT ENOUGH DIGITS

E0020

INVALID VALUE

E0021

Reserved

E0022

DEVICE NOT PRESENT

E0023

DISK I/O ERROR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-4

APTRA Advance NDC, Reference Manual

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E0024

1
2
3
12345678901234567890123456789012
Reserved

E0025

COMMAND NOT ALLOWED

E0026

COINS EXCEED LIMIT OF 65534

E0027
E0031

Reserved

E0032

CAMERA FAILURE (notsupported)

E0033

INVALID MEI OPTION

E0034
E0035
E0036

Reserved
1

E0037

FILE ALREADY EXISTS


Reserved

E0038

EJ BACKUP INVALID

E0039

FRONT FEATURE ONLY

E0040

DCS FAILURE

E0041
E0042

Reserved
1

E0043
E0046

LOAD ERROR
Reserved

E0047

CALL ERROR

E0048

JRNL PRNTR PRESENT

E0049
E0050

Reserved
1

E0051
E0052
E0053

NO PART 1 SET
Reserved

PART 1 ALREADY SET

E0054

JRNL LEVEL MUST BE <= EJ LEVEL

E0055
E0059

Reserved

E0060

CASH IN ERROR

E0061

CASH OUT ERROR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-5

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E0062
E0069
E0070

1
2
3
12345678901234567890123456789012
Reserved

E0071
E0099

DRIVE INVALID
Reserved

E0100

INVALID FUNCTION

E0101

INVALID SELECTION

E0102

INCOMPLETE DATA

E0103

INVALID COMBINATION

E0104

INITIALISATION FAILURE

E0105

NO JOURNAL DEVICE

E0106

EJ ALREADY ACTIVE

E0107

PAPER JOURNAL ACTIVE

E0108

ERROR DURING ACTIVATION

E0109

COPY TO DRIVE FAILED

E0110

KEY DATA NOT PRESENT

E0111

INVALID KEY DATA

E0112

FAILED TO STORE KEY V

E0113

FAILED TO STORE KEY A

E0114

FAILED TO STORE KEY B

E0115

NO VALID DATA PRESENT

E0116

PRINT FAILURE

E0117

EKC TIMEOUT (notsupported)

E0118
E0119

Reserved
1

E0120
E1099

INVALID MODE
Reserved

E1100

CARD READER

E1101

CARD READER ERROR

E1102

CARD READER FATAL

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-6

APTRA Advance NDC, Reference Manual

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1103

CARD JAM

E1104

CARD POS UNKNOWN

E1105

SEC MOD NOT READY

E1106

CAPTURE BIN FULL

E1107

CAPT BIN FULL SOON

E1108
E1199

1
2
3
12345678901234567890123456789012

Reserved

E1200

CASH HANDLER

E1201

CASH HANDLER ERROR

E1202

CASH HANDLER FATAL

E1203

SAFE DOOR OPEN

E1204

SAFE DOOR UNLOCKED

E1205

SAFE DOOR ERROR

E1206

CASH UNITS FATAL

E1207

CASH UNITS ERROR

E1208

STACKER ERROR

E1209

SHUTTER JAMMED

E1210

SHUTTER ERROR

E1211

PRESENTER ERROR

E1212

TRANSPORT FATAL

E1213

TRANSPORT ERROR

E1214

TOP

E1215

SECOND

E1216

THIRD

E1217

FOURTH

E1218

REJECT

E1219

ERROR

E1220

VALS ERR

E1221

NOTE ERR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-7

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1222

REMOVED

E1223

FULL

E1224

FULL SOON

E1225

LOW

E1226

EMPTY

E1227

INTERLOCK OPEN

E1228

MANIPULATED

E1229

FIFTH

E1230
E1249

1
2
3
12345678901234567890123456789012

Reserved

E1250

CDM 01

E1251

CDM 01 ERROR

E1252

CDM 01 FATAL

E1253
E1263

Reserved

E1264

C1

E1265

C2

E1266

CDM 02

E1267

CDM 02 ERROR

E1268

CDM 02 FATAL

E1269
E1299

Reserved

E1300

PINPAD

E1301

PINPAD ERROR

E1302

PINPAD FATAL

E1303

ENC NOT INITIALISED

E1304

ENC STATE UNKNOWN

E1305

ENC NOT READY

E1306

ENC BUSY

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-8

APTRA Advance NDC, Reference Manual

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1307
E1399

1
2
3
12345678901234567890123456789012
Reserved

E1400

RECEIPT PRINTER

E1401

JOURNAL PRINTER

E1402

RECEIPT ERROR

E1403

JOURNAL ERROR

E1404

RECEIPT FATAL

E1405

JOURNAL FATAL

E1406

MEDIA JAMMED

E1407

MEDIA NOT PRESENT

E1408

PAPER LOW

E1409

PAPER OUT

E1410

TONER LOW

E1411

TONER OUT

E1412

INK LOW

E1413

INK OUT

E1414

LAMP ERROR

E1415

RETRACT BIN FULL

E1416

PRINTHEAD LOW

E1417

PRINTHEAD OUT

E1418

KNIFE LOW

E1419

KNIFE OUT

E1420

STATEMENT PRINTER

E1421

STATEMENT ERROR

E1422

STATEMENT FATAL

E1423
E1429

Reserved

E1430

PASSBOOK

E1431

PASSBOOK ERROR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-9

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1432

E1433
E1499

1
2
3
12345678901234567890123456789012
PASSBOOK FATAL
Reserved

E1500

ENV DISPENSER

E1501

ENV DEPOSITORY

E1502

ENV DISP/DEPOSITORY

E1503

ENV DISPENSER ERROR

E1504

ENV DEPOSIT ERROR

E1505

ENV DISPENSER FATAL

E1506

ENV DEPOSIT FATAL

E1507

CONTAINER ERROR

E1508

CONTAINER MISSING

E1509

CONTAINER FULL SOON

E1510

CONTAINER FULL

E1511

TRANSPORT ERROR

E1512

TRANSPORT UNKNOWN

E1513

DISPENSER EMPTY

E1514

DISPENSER LOW

E1515

DISPENSER FULL

E1516

DISPENSER ERROR

E1517

DISPENSER UNKNOWN

E1518

ENV UNIT MISSING

E1519

PRINTER ERROR

E1520

PRINTER UNKNOWN

E1521

SHUTTER OPEN

E1522

SHUTTER JAMMED

E1523

SHUTTER UNKNOWN

E1524

NO DISPENSER

E1525

TONER LOW

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-10

APTRA Advance NDC, Reference Manual

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1526

E1527
E1599
E1600

1
2
3
12345678901234567890123456789012
TONER EMPTY
Reserved

E1601
E1649

NIGHT SAFE DEPOSITORY


Reserved

E1650

COIN DISPENSER

E1651

COIN DISPENSER ERROR

E1652

COIN DISPENSER FATAL

E1653

RACKING ERROR

E1654

RACKING OUT

E1655

HOPPERS FATAL

E1656

HOPPERS ERROR

E1657

COIN HOPPER 1

E1658

COIN HOPPER 2

E1659

COIN HOPPER 3

E1660

COIN HOPPER 4

E1661

COIN HOPPER 5

E1662

COIN HOPPER 6

E1663

COIN HOPPER 7

E1664

COIN HOPPER 8

E1665

GOOD

E1666
E1699

Reserved

E1700

BARCODE READER

E1701

BARCODE READER FATAL

E1702
E1709

Reserved

E1710

CHEQUE PROCESSOR

E1711

CHEQUE PROCESSOR FATAL

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-11

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1712
E1719

1
2
3
12345678901234567890123456789012
Reserved

E1720

POSSIBLE TAMPERING

E1721

MEDIA JAMMED

E1722

TONER OUT

E1723

INK OUT

E1724

BIN 1 FULL

E1725

BIN 2 FULL

E1726

BIN 3 FULL

E1727

TONER LOW

E1728

INK LOW

E1729

Reserved

E1730

BIN 1 REMOVED

E1731

BIN 2 REMOVED

E1732

BIN 3 REMOVED

E1733

BIN 1 FULL SOON

E1734

BIN 2 FULL SOON

E1735

BIN 3 FULL SOON

E1736
E1749

Reserved

E1750

CAMERA

E1751

CAMERA ERROR

E1752

CAMERA FATAL

E1753

CAPACITY NEARLY EXHAUSTED

E1754

CAPACITY EXHAUSTED

E1755

ROOM CAMERA

E1756

PERSON CAMERA

E1757

EXITSLOT CAMERA

E1758
E1800

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-12

APTRA Advance NDC, Reference Manual

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E1801

COMMUNICATIONS CLOSED

E1802

COMMUNICATIONS FATAL

E1803

COMMUNICATIONS DOWN

E1804
E1809

1
2
3
12345678901234567890123456789012

Reserved

E1810

STANDARD AUDIO FATAL

E1811

ENHANCED AUDIO FATAL

E1812
E1900

Reserved

E1901

POSSIBLE TAMPERING

E1902

POSSIBLE JAM

E1903

NUMBER OF FAULTS = %

E1904

<PRESS CANCEL TO EXIT>

E1905
E1908
E1909

Reserved
1

E1910
E1999

HARDWARE ERROR
Reserved

E2000

BUNCH NOTE ACCEPTOR

E2001

CASSETTE 1

E2002

CASSETTE 2

E2003

CASSETTE 3

E2004

CASSETTE 4

E2005

REJECT BIN

E2006

REMOVED

E2007

FULL

E2008

FULL SOON

E2009

ROUTINE

E2010

WARNING

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-13

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

E2011

SUSPEND

E2012

FATAL

E2013

RETRACT BIN

E2014

COUNTERFEIT BIN

E2015

INSERTED

E2016

RCNL LIST EMPTY - CNTRS CLEARED

E2100

UNKNOWN ERROR

E2101

INVALID USERNAME / PASSWORD

E2102

ROLE INFORMATION UNAVAILABLE

E2103

INCORRECT USER ROLE

E2104

INVALID MACHINE ACCOUNT

E2105

ERROR PASSWORD EXPIRED

E2106

ERROR ACCOUNT DISABLED

E2107

INCORRECT LOGON TYPE

E2108

FIRST LOGON INVALID PASSWORD

E2109

ACCOUNT LOCKED OUT

E2110

NO USERNAME/PASSWORD SUPPLIED

E2111

PASSWORD CHANGE DENIED

E2112

INTERNAL ERROR

E2113

INVALID NEW PASSWORD

E2114

INVALID PASSWORD COMPLEXITY

E2115

INVALID SUPPLIED USERNAME

E2116

PASSWORD HISTORY TOO RECENT

F2117

DEVICE OFFLINE

e00

NOT CONFIGURED

e01

BIN NOT PRESENT

e02

FAILED TO CREATE CHECKSUM

e03

FAILED TO UPDATE CURRENCY

1
2
3
12345678901234567890123456789012

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-14

APTRA Advance NDC, Reference Manual

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

e04

FAILED TO UPDATE THRESHOLD

e05

DUPLICATE ENTRY - CASS % & %

e06*

FAILED TO UPDATE CONFIGURATION

e07*

FAILED TO CALIBRATE CASSETTE

e08

1
2
3
4
5

1
2
3
12345678901234567890123456789012

UNKNOWN OR SAME ORIENTATION


PRESS ENTER TO INSERT NOTE
OR CANCEL TO EXIT FUNCTION

e09

1
2

EJ UPLOAD MAY BE IN PROGRESS


PRESS 1- CONTINUE 0-CANCEL

e10

INVALID, EJ MODE IS STANDARD

e11

INVALID;MAX POSSIBLE VALUE=%

e12

INSUFFICIENT HARD DISK SPACE

e13

FAILED TO OVERWRITE IN CDRW

e15

XML FILE ERROR

e16

e17

SCHEDULED INIT NOT CONFIGURED

e18

INVALID PSWD (MIN 4,MAX 20 CHARS)

e19

AUTO INIT COPY DRIVE FAILED

e20

NO DRIVES AVAILABLE

e21

CHECKSUM FAILED

e22

COMPRESSION FAILED

e23

AUTO INIT COPY DRIVE NOT CONFIGURED

e24

SILENTDEBUG NOT STARTED

e25

SILENTDEBUG NOT STOPPED

e26

SILENTDEBUG LOGS NOT DELETED

e27

SILENTDEBUG LOGS NOT COPIED

e28

NO DRIVES SUITABLE FOR COPY

e29

SILENTDEBUG ALREADY STARTED

FILE NOT FOUND

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-15

Reserved Screens
E Error Screens
Column Position
Screen
Number

Row
Position

e30

SILENTDEBUG ALREADY STOPPED

e31

SILENTDEBUG CONFIG INVALID

e32

INVALID:MAX VALUE=%%%%%

e33

NO SILENTDEBUG LOGS TO COPY

e34

INVALID XML FILE

e35

FAILED TO EXECUTE TASK

e36

TASK TIMED OUT

1
2
3
12345678901234567890123456789012

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-16

APTRA Advance NDC, Reference Manual

Reserved Screens
I Supervisor Information

ISupervisorInformation

Iscreenscontainthefollowinginformation:

Encryptionkeys
Cashandcounterdisplays
Configurationdata
Multiplecardimageselectionforrearsettlement
EJlogfileinspection.

Fordetails,seetheAPTRAAdvanceNDC,SupervisorsGuide.
Table A-3
Supervisor Information Screens
Column Position
Screen Number

Row Position

I00

1
2
3
4
5
6

ENCRYPTION KEY A

1
2
3
4
5
6

ENCRYPTION KEY B

I01

I02
I03

1
2
3
4
1234567890123456789012345678901234567890

Reserved
1
2
3
4
5
6
7
8
9
10
11
12
13
14

%
CASSETTE
+REJECTED
=REMAINING
+DISPENSED
=TOTAL

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

CASSETTE
+REJECTED
=REMAINING
+DISPENSED
=TOTAL
LAST CLEARED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%:%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-17

Reserved Screens
I Supervisor Information
Column Position
Screen Number

Row Position

I04

1
2
3
4
5
6
7
8

1
2
3
4
1234567890123456789012345678901234567890

CARDS CAPTURED
%%%%%
LAST CLEARED %%/%%/%% %%:%%
DEPOSITS MADE
%%%%%
LAST CLEARED %%/%%/%% %%:%%
ACTIVITY COUNT =

%%%%%%%

I05

*SUPPLIES STATUS*

I06
SeeMand
m
Supervisor
Menus

1
2
3
4
5
6
7
8
9
10
11
12
13

*CONFIGURATION DATA*
ROLL WIDTH
= %%
JRNL=%%%%%
LEFT COLUMN = %%
JRNL LVL=%
TRACK 1 TYPE = %%%%%% EJ LVL=%
MESSAGE MODE = %%%%%%%%%%%%%%%%%
MACHINE NO
= %%%%%%%%%%%%%%%%%
DATE = %%/%%/%% TIME = %%:%%:%%
COUNT PRNTR = %%%%%%%
RESTART MODE = %%%%%%%
EJ BKUP=%
NO. BKUPS=%%%%
VOLUME SST=0
VOLUME JACK=0
POWERUP MSG = %%%%%%%%
MAX STATEMENT LENGTH = %%

I07

*CASH TEST*

I08

CURRENT SCREEN = %%%

I09

1
2
3
4
5
6

ENCRYPTION KEY V

I10

1
2
3
4
5
6
7
8
9
10

*ACCESS DATA*
INITIAL ENT
INITIAL DISP
EXIT MODE
MAC NUMBER
A KEY KVV
B KEY KVV
V KEY KVV
COMS KEY KVV
MAC KEY KVV

=
=
=
=
=
=
=
=
=

%%%%%%
%%%%%
%%%%%%%%%%
%%%%%%%%%%%%%%%%
%%%%
%%%%
%%%%
%%%%
%%%%

Note: Digitsinpositions1732ofmessagemodeareonlydisplayedifthecorrespondingdigitsareentered.
Trailingdigitswithdefault0valuesareomitted.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-18

APTRA Advance NDC, Reference Manual

Reserved Screens
I Supervisor Information
Column Position
Screen Number

Row Position

I11

1
2
3
4
5
6
7
8
9
10
11
12
13

1
2
3
4
1234567890123456789012345678901234567890
*HALLMARK VERIFICATION*

HMQ = %%%%%%%%%%%%%%%%%%%%
HMA = %%%%%%%%
FAV = %%%%%%%%
PEC = %
IPE = %
ROM FIRMWARE = %%%%%%%
RAM FIRMWARE = %%%%%%%
SERIAL NUMBER = %%%%%%%%
PRESS <ENT> FOR MENU OR

Note:FromAdvanceNDC2.06,hallmarkverificationisnotsupported.
I12I14

Reserved

I15

PAPER

I16

DISK

I17

NONE

I18

1
2
3
4
5
6
7
8
9
10
11
12
13

<<A

B>>

<<C

D>>

<<E

F>>

I19

I20

1
2
3
4
5
6
7
8
9
10

<<A

B>>
CURRENT DIGIT = %

<<C

D>>

<<E

F>>

Reserved
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-19

Reserved Screens
I Supervisor Information
Column Position
Screen Number

Row Position

I21

I22I26
I27

I30

I31

* M/C

DD/MM/YY HH:MM:SS *

Reserved
1

I28
I29

1
2
3
4
1234567890123456789012345678901234567890

MODULE = 2
Reserved

1
2
3
4
5
6
7
8
9
10
11
12

1
2
3
4

=
=
=
=

SINGLE
SINGLE
DOUBLE
DOUBLE

LENGTH
LENGTH
LENGTH
LENGTH

WITHOUT XOR
WITH XOR
WITH XOR
WITHOUT XOR

CURRENT MODE = %
NEW MODE = %
CHANGING MODE WILL
DESTROY ALL KEYS

1
2
3
4
5
6
7
8
9
10
11
12
13

ENTER SECURE KEY


NCR PHYSICAL KEYBOARD LAYOUT
+---------------+
| 1 | 2 | 3 | A |
|---------------|
| 4 | 5 | 6 | B |
|---------------|
| 7 | 8 | 9 | C |
|---------------|
| D | 0 | E | F |
+---------------+

1
2
3
4
5
6
7
8
9
10
11
12
13

ENTER SECURE KEY


PHYSICAL KEYBOARD LAYOUT
+-----------------------------+
| 1(B) | 2(C) | 3(D) | CLEAR |
|-------+------+------+-------|
| 4(E) | 5(F) | 6
| CANCEL|
|-------+------+------+-------|
|
7
| 8
| 9
| ENTER |
|-------+------+------+-------|
| SHIFT | 0(A) |
|
|
+-----------------------------+

CURRENT DIGIT =

CURRENT DIGIT =

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-20

APTRA Advance NDC, Reference Manual

Reserved Screens
I Supervisor Information
Column Position
Screen Number

Row Position

I32
I33

1
2
3
4
1234567890123456789012345678901234567890
Reserved

1
2
3
4
5
6
7
8
9
10
11
12
13
14

I34I36

*EJ CONFIGURATION DATA*


JRNL MODE = %
EJ MODE = %
MAX EJ BACKUPS = %%%%%
MULTIPLE DESTINATIONS = %%%%%
CUTOVER= %%%%%
SCHEDINIT= %%%%%
PATTERN=%%%%%%%
AGENT = %%%%%
SETTLMNT INIT=%
AUTOMATIC INIT COPY DRIVE=%%%
COMPRESSION=%%%%%
PRIVACY PASSWORD=%%%%%%%%
EJ FILE SIZE(KB) = %%%%%
HOST CONTROL EJ MODE=%%%%%
Reserved

I37

*CASH TEST* MODULE = 1

I38

SWITCHED ON

I39

SWITCHED OFF

I40

1
2
3
4

THE CARD IMAGES PRESENT ARE


MARKED WITH AN X:

I41
I42

I43

0 1 2 3 4 5 6 7 8 9
Reserved

1
2
3
4
5
6
7
8
9
10
11
12
13

COIN DISPENSER

REMAINING
+DISPENSED
=TOTAL COINS

HOPPER %
%%%%%
%%%%%
%%%%%

HOPPER %
%%%%%
%%%%%
%%%%%

REMAINING
+DISPENSED
=TOTAL COINS
LAST CLEARED

HOPPER %
HOPPER %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
dd/mm/yy
hh:mm

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-21

Reserved Screens
I Supervisor Information
Column Position
Screen Number

Row Position

I44

1
2
3
4

I45

I46I65
I63

1
2
3
4
5
6

DUAL

*CONFIGURATION DATA*
STANDARD COIN COUNTS
HOPPER 1= %%%%% HOPPER
HOPPER 3= %%%%% HOPPER
HOPPER 5= %%%%% HOPPER
HOPPER 7= %%%%% HOPPER

2=
4=
6=
8=

%%%%%
%%%%%
%%%%%
%%%%%

Reserved
1
2
3
4
5
6
7
8
9

I71I95
I96

*CHECK COIN*

Reserved

I67I69
I70

*CONFIGURATION DATA*
STANDARD COIN COUNTS
HOPPER 1= %%%%% HOPPER 2= %%%%%
HOPPER 3= %%%%% HOPPER 4= %%%%%

Reserved

I64I65
I66

1
2
3
4
1234567890123456789012345678901234567890

CARDS CAPTURED
%%%%%
LAST CLEARED %%/%%/%% %%:%%

ACTIVITY COUNT =

%%%%%%%

Reserved
1
2

KVV VALUE = %%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-22

APTRA Advance NDC, Reference Manual

Reserved Screens
I Supervisor Information
Column Position
Screen Number

Row Position

I97

1
2
3
4
5
6
7
8

I98

I99

1
2
3
4
5
6
7
8
9
10
11
12
1
2
3

1
2
3
4
1234567890123456789012345678901234567890
SELECT TO ENTER KEY
OR CHANGE KEY MODE
0 ENTER KEY A
1 ENTER KEY B
2 ENTER KEY V
9 CHANGE KEY ENTRY MODE
1 = SINGLE LENGTH WITHOUT XOR
2 = SINGLE LENGTH WITH XOR

CURRENT MODE = %
NEW MODE = %
CHANGING MODE WILL
DESTROY ALL KEYS
3 = DOUBLE LENGTH WITH XOR
4 = DOUBLE LENGTH RESTRICTED

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-23

Reserved Screens
M and m Supervisor Menus

MandmSupervisorMenus
Mandmscreenscontaininformationonkeyboardsandthe
followingmenus:
Select
Replenish
Configure
Access

FordetailsoftheSupervisormenus,refertotheAPTRAAdvance
NDC,SupervisorsGuide.
Note:OntheAccessmenu,option14HALLMARKisnot
supportedinAdvanceNDC.

.
Table A-4
Supervisor Menu Screens

Column Position
Screen
Number

Row
Position

M01

1
2
3
4
5
6
7
8
9
10
11
12
13

M02

1
2
3
4
5
6
7
8
9
10
11
12
13

1
2
3
12345678901234567890123456789012

REPLENISH
0
2
4
6
8
10
13
18
20
99

DISP SPPLY
DISP CASH
PRNT CNTRS
CLR CARDS
ADD CASH
TEST CASH
INIT STMNT
DISP COINS
ADD COINS
MORE

1
3
5
7
9
12
15
19
21

PRNT SPPLY
DISP CNTRS
CLR CASH
CLR DEPOS
INIT RECPT
STD CASH
SPVR TRANS
CLR COINS
STD COINS

CONFIGURE
0
2
4
6
8
10
12
14
31
33

DISP CONFIG
TRACK 1
MACHINE NO
MSG MODE
SET PRINT
RST MODE
TRACE ON
SET COINS
VOLUME SST
DISBL JRNL

1
3
5
7
9
11
13
30
32
99

PRNT CONFIG
ROLL WIDTH
DATE/TIME
DISP SCRN
SET CASH
SET DEFAULT
TRACE OFF
SET JRNL
VOLUME JACK
MORE

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-24

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

M03
M05

Reserved

M06

1
2

M07

1
2
3
4
5
6
7
8
9
10
11
12
13

M08

STD NON-SUP KEYBOARD NO. 0


SetsthestandardTransactionProcessing
keyboard0layout.Fordetails,seeStandard
KeyboardLayoutsinChapter 4,KeyboardData
andLayouts.
REPLENISH
40
42
44
47
49
51
53
55
58
99

INIT EJRNL
41 FILL ENV
SECURITY CAM 43 INIT DEPOS
CLR BINS
45 CHECK COIN
DUMP IMAGES 48 DSP BNA RCNL
PRN BNA RCNL 50 RCOPY EJRNL
DIRECT EJ BACKUP
CLR BNA
54 INIT BNA
CREATE SIGS 56 EXTRACT SIGS
DSP BNA CNTS 59 PRN BNA CNTS
MORE

Reserved

M09

1
2

M12

1
2
3
4
5
6
7
8

M15

1
2
3
12345678901234567890123456789012

ALT NON-SUP KEYBOARD NO. 1


SetsthealternativeTransactionProcessing
keyboard1layout.Fordetails,seeStandard
KeyboardLayoutsinChapter 4,KeyboardData
andLayouts.
SELECT
4
6
8
26
90

REPLENISH
5 CONFIGURE
ACCESS
7 DIAGNOSTIC
TRANSFER
9 EXIT
FAULT DISPLAY
MISC FUNCS

ESC[00p ESC(1 ESC)6


Setstheleftmarginandtheprimaryand
secondarycharactersets.Fordetails,seethe
ControlCodesforSpecialFeaturessectionin
Chapter 3,ScreenData.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-25

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

M16

1
2
3
12345678901234567890123456789012
DC2 ESC[00m ESCPi0 ESC\ FF
Setscolourstodefault,screenblinkingoff,clears
thescreen,setsthecursortothetoplefthand
cornerandresetsthedisplaymodetotheNDC+
default.Fordetails,seetheControlCharacters
andControlCodesforSpecialFeaturessections
inChapter 3,ScreenData.

M60

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

%
+-----------------------+
|
1
|
2
|
3
|
| _#() | abc | def |
|-------+-------+-------|
|
4
|
5
|
6
|
| ghi | jkl | mno |
|-------+-------+-------|
|
7
|
8
|
9
|
| pqrs | tuv | wxyz |
+-------+-------+-------+
|
0
|
| -?!@ |
CAPS >>
+-------+

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-26

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

M61

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

%
+-----------------------+
|
1
|
2
|
3
|
| _#() | ABC | DEF |
|-------+-------+-------|
|
4
|
5
|
6
|
| GHI | JKL | MNO |
|-------+-------+-------|
|
7
|
8
|
9
|
| PQRS | TUV | WXYZ |
+-------+-------+-------+
|
0
|
| -?!@ |
CAPS >>
+-------+

m00

1
2
3
4
5
6
7
8
9
10
11
12
13

TCP/IP CONFIG

m01

1
2
3
4
5
6
7
8
9
10
11
12

1
2
3
12345678901234567890123456789012

0
2
4
6
8
10
12
14
16
17
19

RMT ADDRESS
1
LCL ADDRESS
3
CONFIG AS SRV 5
DISP TCP/IP
7
PING
9
SUBNET MASK 11
WINS ADDRESS 13
FIREWALL
15
NAMED RMT HOST
XP KEEP ALIV 18
DHCP

RMT PORT NO
LCL PORT NO
ADVANCED
PRINT TCP/IP
GATEWAY
DNS ADDRESS
COMP NAME
MULTI HOST
SSL CONFIG

ADVANCED TCP/IP CONFIG


0
2
4
6
8

MSG FORMAT
LEN FORMAT
LEN OFFSET
RCV TIMEOUT
KEEP ALIVE

1
3
5
7
9

LEN SIZE
LEN ADJUST
LEN EMBED
RETRY TIMER
RECON CLOSE

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-27

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m02

1
2
3
4
5
6
7
8
9
10
11
12
13

m03

1
2
3
4
5
6
7
8
9
10
11
12

m04
m05

m06

1
2
3
12345678901234567890123456789012

CONFIGURE
34
37
39
45
46
47
80
81
84

EJ OPTIONS
35 JOURNAL LVL
TCPIP CONFIG 38 DIALUP CONFG
GBXX CONFIG 44 TROUBLESHOOT
MAX STATEMENT LENGTH
SELECT COMMS TYPE
EXTENDED ADD CASH
DISP CSH/ACC CONFIG
PRNT CSH/ACC CONFIG
POWERUP MSG
99 MORE

0
2
4
6
8
10
12
14
15
21

ACCESS
DISP ACCESS
1 PRNT ACCESS
SET PASSWRD
3 INIT ENTRY
INIT DISPLY
5 EXIT MODE
ENTER V
7 WRITE V
ENTER A
9 WRITE A
ENTER B
11 WRITE B
ENTER MAC
13 SET ACCESS
HALLMARK
PROMOTE/COPYFILE
RELATE MENU 25 KEY ENTRY

Reserved
1
2
3
4
5
6
1
2
3
4
5
6
7
8
9
10
11
12

MISC FUNCS
0 PRNT CMPNT VERS
1 PRNT SCRW VERS

ADD CASH
0
1
2
3
4
5

EXCHANGE CASH UNITS


CONFIGURE CASH UNITS
CLEAR CASH
ADD CASH
CALIBRATE CASH UNITS
TEST CASH

6 UPDATE NOTE TYPES


7 SET REJECT THRESHOLD

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-28

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m07

1
2
3
4
5
6
7
8
9
10
11

m08

m09

1
2
3
4
5
6
7
8
9
10
1
2
3
4
5
6

m10
m11

m12

1
2
3
12345678901234567890123456789012

UPDATE CURRENCY ID
CURRENT SETTING
CASSETTE %
CURRENCY = %
1.
2.
3.
4.

%
%
%
%
UPDATE MEDIA TYPE

CURRENT SETTING
CASSETTE %
MEDIA = %
1. CASH (3)
2. COUPON/VOUCHER (7)
3. DOCUMENT (8)
UPDATE MEDIA VALUE
CURRENT SETTING
CASSETTE %
VALUE = %
Reserved

1
2
3
4
5
6
7
1
2
3
4
5
6

UPDATE REJECT BIN


THRESHOLD
CURRENT SETTING
THRESHOLD = %
TROUBLESHOOTING
1
2
3

PD INVESTIGATION
SILENT DEBUG
RETRIEVE ARCHIVE

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-29

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m13

1
2
3
4
5
6
7
8
9
10
11
12

m14

m15

m16

1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
1
2
3
4
5
6
7
8
9
10
11
12
13

1
2
3
12345678901234567890123456789012

SELECT DRIVE
%
%
%
%
%
%
%

CALIBRATE CASH UNIT


%
TO BE CALIBRATED
WITH 8 - 12 NOTES
CALIBRATE CASH UNIT
1.
2.
3.
4.

TOP
SECOND
THIRD
FOURTH

UPDATE SP CURRENCY ID
CURRENT SETTING
%
CURRENCY = %
1.
2.
3.
4.

%
%
%
%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-30

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m17

1
2
3
4
5
6
7

m18
m19

m20

m21

m22

1
2
3
12345678901234567890123456789012

UPDATE SP MEDIA VALUE


CURRENT SETTING
%
VALUE = %
Reserved

1
2
3
4
5

NOTE SIGNATURES

1
2
3
4
5

NOTE SIGNATURES

ENTER NOTE IN
FRONT AND TOP
ORIENTATION

ENTER NOTE IN
FRONT AND BOTTOM
ORIENTATION

1
2
3
4
5

NOTE SIGNATURES

1
2
3
4
5

NOTE SIGNATURES

ENTER NOTE IN
BACK AND TOP
ORIENTATION

ENTER NOTE IN
BACK AND BOTTOM
ORIENTATION

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-31

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m23

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

m24

m25

m26

1
2
3
4
5
6
7
8
9
10
11
1
2
3
4
5
6
7
8
1
2
3
4
5
6

1
2
3
12345678901234567890123456789012

RCOPY
1
2
3
4
5
6
7
8
9
10

EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%
EJ%%%%%%.%%%

%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%
%%/%%/%%

SELECT FROM LIST TO COPY:


OR PRESS ENTER TO SEARCH:
CONFIGURE EJ
0
1
2
3
4
5
6
7
8

DISP EJ CONFIG
EJ BACKUP MODE
MAX NO OF BACKUPS
ENABLE MULTIPLE DESTINATIONS
AUTO INIT EJ OPTIONS
COMPRESSION
MAX FILE SIZE
DSBL HOST CNTRL OF EJ MODE
PRIVACY OPTIONS
CONFIGURE EJ MODE

0 STANDARD EJ
1 MULTIPLE EJ

CURRENT = %
RCOPY
1 DISPLAY EJ FILES
2 SEARCH EJ BY DATE
3 SEARCH EJ BY EXTENSION

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-32

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m28

1
2
3
4
5
6
7
8
9
10
11

m29

m30

m31

1
2
3
4
5
6
7
8
9
10
11
1
2
3
4
5
6
7
8
9
10
11
1
2
3
4
5
6
7
8
9
10
11
12

1
2
3
12345678901234567890123456789012

SCHEDULED INIT OPTIONS


1 ENABLE/DISABLE EJ SCHEDULED INIT
2 SCHEDULED INIT PATTERN

SCHEDULED INIT PATTERN


1 DAILY
2 WEEKLY
3 MONTHLY

PRIVACY OPTIONS
1 DISABLE EJ PRIVACY
2 SET EJ PASSWORD

AUTHENTICATION-EJ PRIVACY
+--------------+
|1ABC|2DEF|3GHI|
|----|----|----|
|4JKL|5MNO|6PQR|
|----|----|----|
|7STU|8VWX|9YZ*|
+----|----|----+
|0(#)|
+----+
%%%%%%%%%%%%%%%%%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-33

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m32

1
2
3
4
5
6
7
8
9
10
11
12

m33
m35
m36

m37

m38

1
2
3
12345678901234567890123456789012
SET EJ PASSWORD
+--------------+
|1ABC|2DEF|3GHI|
|----|----|----|
|4JKL|5MNO|6PQR|
|----|----|----|
|7STU|8VWX|9YZ*|
+----|----|----+
|0(#)|
+----+
%%%%%%%%%%%%%%%%%%%%
Reserved

1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
8
9
10
11
12
13

ENTER SEARCH OPTION


0
1
2
3

ALL ARCHIVES
LAST 7 DAYS ARCHIVES
LAST 24 HRS ARCHIVES
SPECIFY DATE

RETRIEVE ARCHIVE
0
1
2
3

SEARCH BY FILE
SEARCH BY GROUP
ARCHIVE NOW AND EXPORT
EXPORT CONFIGURED ARCHIVES

PD INVESTIGATION
1
2
3
4
5
6
7
8
9
10

START INVESTIGATION
STOP INVESTIGATION
EXPORT INVESTIGATION
PAUSE INVESTIGATION
RESUME INVESTIGATION
ABANDON INVESTIGATION
DELETE INVESTIGATION
IMPORT TEMPLATE
DELETE TEMPLATE
INVESTIGATION STATUS

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-34

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

1
2
3
12345678901234567890123456789012

m39
2
3
4
5
6
7
8
9
10
11
12
13
14
m40

m41

1
2
3
4
5
6
7
8
9
10
11
12
13
1
2
3
4
5
6

SILENT DEBUG: %%%%%%%


1
2
2
2
2

START
STOP
RECONFIGURE
COPY LOGS
DELETE LOGS

SELECT JOURNAL LEVEL

CURRENT JOURNAL LEVEL = %


CURRENT EJ LEVEL = %

1
2
3

SET JOURNAL AND EJ LEVEL


SET JOURNAL LEVEL ONLY
SET EJ LEVEL ONLY

REMOTE HOST IP
1 ADD REMOTE HOST IP
2 REMOVE REMOTE HOST IP

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-35

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m42

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

m43

m44

m45

m46

1
2
3
4
5
6
1
2
3
4
5
6
7
1
2
3
4
5
7
7
1
2
3
4
5
6
7

1
2
3
12345678901234567890123456789012

1
2
3
4
5
6
7
8
9
10
11
12

SSL CONFIG MENU


KEY RENEGOTIATION INTRVL
CHECK CRL FOR RECEIVED CERT
CIPHER SUIT ALGORITHM
RECEIVED CERT ISSUER
RECEIVED CERT SUBJECT
SECURE HANDSHAKE TIMEOUT
SECURE PROTOCOL TYPE
SESSION RENEGOT. INTERVAL
SUPPLIED CERT ID
SUPPLIED CERT SUB
CLOSE NOTIFICATION TOKEN
VALIDATION ON CHAIN POLICY

WINS CONFIG
1 ENTER PRIMARY WINS
2 ENTER SECONDARY WINS

SSL MENU

1 ENBL/DSBL SSL
2 CONFIGURE SSL

RETRIEVE CONFIGURED ARCHIVES


1 EXPORT ALL ARCHIVES
2 EXPORT LAST 7 DAYS ARCHIVES
3 EXPORT LAST 24 HRS ARCHIVES

CONFIG AS SRV

0 CLIENT
1 SERVER

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-36

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m47

1
2
3
4
5

m48
m49

RELATE MENU
1 ENABLE/DISABLE RELATE
Reserved

1
2
3
4
5
6
7
8
9
10
11
12
13
14

m50
m54
m55

1
2
3
12345678901234567890123456789012

MS FIREWALL CONFIG
1
2
3
4
5
6
7
8
9
10

ENABLE FIREWALL
DISABLE FIREWALL
ADD FIREWALL ADV. SETTINGS
DEL FIREWALL ADV. SETTINGS
ENABLE ICMP ECHO
DISABLE ICMP ECHO
ADD PROGRAM TO EXCEP. LIST
DELETE PROGRAM FROM EXCEP. LIST
DISPLAY FIREWALL CONFIG
PRINT FIREWALL CONFIG

Reserved
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

* TCP/IP CONFIGURATION DATA *


CONFIG SERVER = %
REMOTE ADDR
= %
REMOTE PORT
= %
LOCAL PORT
= %
KEEP ALIVE
= %
RETRY TIMER
= %
RECON CLOSE
= %
MSG FORMAT
= %
LEN SIZE
= %
LEN FORMAT
= %
LEN ADJUST
= %
LEN OFFSET
= %
LEN EMBED
= %
RCV TIMEOUT
= %

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-37

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m56

1
2
3
4
5
6
7
8

m57
m59
m60

1
2
3
12345678901234567890123456789012

DNS CONFIG
1
2
3
4

ENTER PRIMARY DNS


ENTER SECONDARY DNS
COPY DNS SUFFIX FROM DISK
ENTER DNS SUFFIX

Reserved
1
2
3
4
5
6
7
8
9
10
11

m61

1
2

m62

1
2
3
4
5
6
7
8
9
10
11
12

AUTO INIT EJ OPTIONS


1
2
3
4
5

CUTOVER
SCHEDULED INIT OPTIONS
AGENT
AUTOMATIC INIT COPY DRIVE
INIT AFTER SETTLEMENT

SERVICE
ASSIST
SECURITY CAMERA
1 TEST CAMERA
2 COPY SNAPSHOTS
3 DELETE SNAPSHOTS

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-38

APTRA Advance NDC, Reference Manual

Reserved Screens
M and m Supervisor Menus
Column Position
Screen
Number

Row
Position

m63

1
2
3
4
5
6
7
8
9
10
11
12

m64
m66
m67

1
2
3
12345678901234567890123456789012

COPY SNAPSHOTS
SNAPSHOTS ARE AVAILABLE
FROM %
TO %

Reserved
1
2
3
4
5
6
7
8
9
10
11

m68
m89

SELECT COMMS TYPE


CURRENT COMMS %
SELECT NEW COMMS TYPE
1 - TCPIP
2 - PCCM
3 - DIALUP VISA2
SELECT OPTION Reserved

m90

m91

m92

0 CLEAR ALL

m93

0 CLEAR ALL

m94

26 FAULT DISPLAY

m95

THERE ARE NO DEVICES CONFIGURED

m96

1
2
3
4
5
6

MV DIAGNOSTICS
DEVICE

FITNESS
8 BACK

9 NEXT

91 SHUTDOWN

DEVICE SELF TEST


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-39

Reserved Screens
P Supervisor Prompts

PSupervisorPrompts
Porpscreensarepromptlinesthatappearonthecardholder
screenandenhancedoperatorinterface.
Fordetails,seetheAPTRAAdvanceNDC,SupervisorsGuide.
Table A-5
Supervisor Prompts Screens

Column Position
Screen
Number

Row
Position

P00

P01

1
2
3
12345678901234567890123456789012
SELECT FUNCTIONReserved

P02

ENTER CASSETTE TYPE-

P03

ENTER NO. OF NOTES-

P04

ENTER TRACK1 FORMAT-

P05

ENTER MACHINE NO. -

P06

ENTER DATE (YYMMDD) -

P07

ENTER TIME (HHMM) -

P08

P09

ENTER LEFT COLUMN -

P10

ENTER NO. OF COLUMNS -

P11

ENTER KEY A -

P12

ENTER KEY B -

P13

ENTER SCREEN NO -

P14

ENTER PRINTER -

P15

ENTER INITIAL DISPLAY -

P16

ENTER INITIAL MENU -

P17

ENTER EXIT TYPE -

P18

ENTER MAC -

P19

ENTER PASSWORD -

P20

ENTER NEW PASSWORD -

P21

ENTER KEY V -

P22

ENTER RESTART MODE -

ENTER MSG MODE-

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-40

APTRA Advance NDC, Reference Manual

Reserved Screens
P Supervisor Prompts
Column Position
Screen
Number

Row
Position

P23

ENTER HALLMARK QUESTION (notsupported)

P24

PLEASE WAIT FOR HALLMARK


(notsupported)

P25
P26

1
2
3
12345678901234567890123456789012

Reserved
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

P27P33

PLEASE SELECT DRIVE


%
%
%
%
%
%
%
%
%
%

%
%
%
%
%
%
%
%
%
%

SELECT DRIVE
Reserved

P34

PRESS <AUX> FOR HELP

P35

PRESS <ENT> FOR MORE

P36

ENTER COIN HOPPER

P37

ENTER NO. OF COINS

P38

PRESS <AUX> TO EXIT HELP MODE

P39P41
P42

Reserved
1

P43P52

SET JOURNAL OPTION Reserved

P53

KEY -

P54

ENTER KEY PART 1 -

P55

ENTER KEY PART 2 -

P56

CONFIRM KEY PART 1 -

P57

6 = CONFIRM NEW MODE -

P58

NEW KEY MODE -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-41

Reserved Screens
P Supervisor Prompts
Column Position
Screen
Number

Row
Position

P59

P60P72
P73*

P74*

P75

1
2
3
12345678901234567890123456789012
COMPONENT (1,2,3)Reserved

1
2
3
4
5
6
7

IN EXCHANGE MODE

1
2
3

EXCHANGE MODE FAILED

REMOVE OLD CASSETTES NOW


AND REPLACE WITH NEW ONES
WHEN REPLENISHMENT COMPLETE
PRESS ENTER TO CONTINUE

PRESS ENTER TO CONTINUE

1
2
3
4
5

PRESS ENTER TO SHUTDOWN ATM

P76

ATM IS SHUTTING DOWN...

P77

PLEASE WAIT...

P78

1
2

RESTART REQUIRED

PRESS CANCEL TO RETURN TO MENU

PRESS ENTER TO RESTART ATM


4
5

PRESS CANCEL TO RESTART LATER

P79P80

Reserved

P81

PLEASE WAIT...

Note:Thisscreencontainscontrolcharactersandotherdisplaydatathat
mustnotbeedited.
P82

CONFIRM KEY PART 2

P83

CONFIRM KEY

P84

PRESS <ENTER> OR PRESS <CANCEL>

P85

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-42

APTRA Advance NDC, Reference Manual

Reserved Screens
P Supervisor Prompts
Column Position
Screen
Number

Row
Position

P88

1
2
3
4
5
6

P89

1
2
3
4
5

P93

P94

P95P96
P97

1
2
3
12345678901234567890123456789012
PLEASE WAIT

THIS PROCEDURE MAY TAKE


UP TO 5 MINUTES
REGISTRY UPDATED
SELECT GBRU/GBNA CONFIGURATION
AGAIN AFTER REBOOTING
PRESS ENTER TO CONTINUE
CONFIRM PASSWORD ENTER JOURNAL LEVEL Reserved

1
2
3
4
5
6
7
8
9

TO ENTER DIAGNOSTICS
SET THE MODE SWITCH TO SUPERVISOR

PRESS CANCEL FOR PREVIOUS MENU

P98

ENTER JOURNAL & EJ LEVEL -

P99

ENTER EJ LEVEL -

p00

p01

ENTER PORT NO -

p02

ENTER NEW CONFIG -

p03

ENTER MSG FORMAT -

p04

ENTER LEN SIZE -

p05

ENTER LEN FORMAT -

p06

ENTER LEN ADJUST -

p07

ENTER LEN OFFSET -

p08

ENTER LEN EMBED -

p09

ENTER RCVD TIMEOUT -

PRESS ENTER EVERY 3 DIGITS -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-43

Reserved Screens
P Supervisor Prompts
Column Position
Screen
Number

Row
Position

p10

ENTER RETRY TIMER -

p11

ENTER KEEP ALIVE

p12

ENTER RECONN CLS -

p13

ENTER GROUP RETRY SZ -

p14

ENTER MAXIMUM RETRYS -

p15

ENTER GROUP INTERVAL -

p16

ENTER RETRY INTERVAL -

p17

SELECT BIN -

p18

ENTER OFFLINE TIMER

p19

1
2
3
12345678901234567890123456789012

Reserved

p20*

ENTER CURRENCY ID -

p21*

ENTER MEDIA TYPE -

p22*

ENTER MEDIA VALUE -

p23*

ENTER NEW THRESHOLD -

p24*

1
2
3

PRESS ANY <KEY> TO LOAD

SELECT CASSETTE POSITION -

p25
p26p29

PRESS <CANCEL> FOR MAIN MENU

Reserved

p30

p31

p32

STANDARD MODE ALREADY ACTIVE


ENTER MAX EJ BACKUPSReserved

p33

ENTER MAXIMUM STMNT LENGTH-

p34

PRESS 1 TO ENABLE/0 TO DISABLE

p35

MULTIPLE DESTINATIONS ENABLED

p36

MULTIPLE DESTINATIONS DISABLED

p37

1
2

BACKUP FILES WILL BE DELETED


PRESS 1 TO DELETE, 0 TO RETAIN

p38

1
2

SOME BACKUPS MAY BE DELETED


PRESS 1 TO CONTINUE, 0 TO CANCEL

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-44

APTRA Advance NDC, Reference Manual

Reserved Screens
P Supervisor Prompts
Column Position
Screen
Number

Row
Position

p39

SELECT DATE (MMDDYY):

p40

SELECT EXTENSION NO:

p41

CDM% ENTER CASSETTE TYPE-

p42p50

1
2
3
12345678901234567890123456789012

Reserved

p51

SET DAY OF THE WEEK-

p52

SET DAY OF THE MONTH-

p53

ENTER EJ FILE SIZE(KB)-

p54p55

Reserved

p56

1
2

PRESS ENTER TO CONTINUE INIT


OR CANCEL TO STOP

p57

PRESS ENTER TO DELETE LOGS -

p58p63
p64

p65p77

Reserved
1
2
3

TO EXIT SUPERVISOR
SET MODE SWITCH TO NORMAL
Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-45

Reserved Screens
S Supervisor Information Lines

SSupervisorInformationLines
Sorsscreenscontainthefollowingmessages:

Mediastatus
Testcash.

Fordetails,seetheAPTRAAdvanceNDC,SupervisorsGuide.
Table A-6
Supervisor Information Lines Screens

Column Position
Screen
Number

Row
Position

S00

ALL SUPPLIES GOOD

S01

TYPE 1 CASH LOW

S02

TYPE 2 CASH LOW

S03

TYPE 3 CASH LOW

S04

TYPE 4 CASH LOW

S05

TYPE 1 CASH EMPTY/MISSING

S06

TYPE 2 CASH EMPTY/MISSING

S07

TYPE 3 CASH EMPTY/MISSING

S08

TYPE 4 CASH EMPTY/MISSING

S09

JOURNAL PAPER EXHAUSTED

S10

RECEIPT PAPER EXHAUSTED

S11

CASH REJECT BIN OVERFILL

S12

CARD BIN OVERFILL

S13

DEPOSIT BIN OVERFILL

S14

NO GOOD CASSETTES

S15

TOP CASSETTE GOOD

S16

SECOND CASSETTE GOOD

S17

THIRD CASSETTE GOOD

S18

FOURTH CASSETTE GOOD

S19

JOURNAL PAPER LOW

S20

RECEIPT PAPER LOW

S21

STATEMENT PAPER EXHAUSTED

1
2
3
12345678901234567890123456789012

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-46

APTRA Advance NDC, Reference Manual

Reserved Screens
S Supervisor Information Lines
Column Position
Screen
Number

Row
Position

S22

STATEMENT PAPER LOW

S23

STATEMENT RIBBON EXHAUSTED

S24

STATEMENT RIBBON LOW

S25

DISPENSER FAULT

S26

NIGHT DEPOSIT OVERFILL

S27
S28
S29

1
2
3
12345678901234567890123456789012

Reserved
1

S30

RECEIPT CAPTURE BIN OVERFILL


Reserved

S31

RECEIPT RIBBON EXHAUSTED

S32

RECEIPT RIBBON LOW

S33

RECEIPT HEAD EXHAUSTED

S34

RECEIPT HEAD LOW

S35

RECEIPT KNIFE EXHAUSTED

S36

RECEIPT KNIFE LOW

S37

JOURNAL RIBBON EXHAUSTED

S38

JOURNAL RIBBON LOW

S39

JOURNAL HEAD EXHAUSTED

S40

JOURNAL HEAD LOW

S41

STATEMENT HEAD EXHAUSTED

S42

STATEMENT HEAD LOW

S43

STATEMENT KNIFE EXHAUSTED

S44

STATEMENT KNIFE LOW

S45

STATEMENT BIN OVERFILL

S46

COIN HOPPER % GOOD

S47
S49
S50
S51
S53

Reserved
1

COIN HOPPER % JAM


Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-47

Reserved Screens
S Supervisor Information Lines
Column Position
Screen
Number

Row
Position

S54

S55
S57

1
2
3
12345678901234567890123456789012
COIN HOPPER % MISSING
Reserved

S58

TRANSPORT CHUTE GOOD

S59

TRANSPORT CHUTE JAMMED

S60

E/JOURNAL LOG FULL

S61

E/JOURNAL LOG SPACE LOW

S62

CAN'T WRITE TO E/JOURNAL

S63

COIN HOPPER % LOW

S64
S66
S67

Reserved
1

S68
S78
S79

COIN HOPPER % OUT


Reserved

S80
S83

COIN LOWS NOT SET UP


Reserved

S84

ENVELOPE DISPENSER LOW

S85

ENVELOPE DISPENSER EXHAUSTED

S86

CAPACITY NEARLY EXHAUSTED

S87

CAPACITY EXHAUSTED

S88
S96

Reserved

S97

CASH REJECT BIN HIGH

S98

CARD CAPTURE BIN HIGH

s00

BNA COUNTERFEIT BIN OVERFILL

s01

BNA RETRACT BIN MISSING

s02

BNA COUNTERFEIT BIN NEARLY FULL

s03
s05
s06

Reserved
1

TYPE % CASH LOW

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-48

APTRA Advance NDC, Reference Manual

Reserved Screens
S Supervisor Information Lines
Column Position
Screen
Number

Row
Position

s07

s08
s20

1
2
3
12345678901234567890123456789012
TYPE % CASH EMPTY/MISSING
Reserved

s21

C1

s22

C2

s23

ENDORSER RIBBON NEARLY EXHAUSTED

s24

ENDORSER RIBBON EXHAUSTED

s25

CHEQUE PROCESSOR STAMP INK LOW

s26

CHEQUE PROCESSOR STAMP INK EMPTY

s27

CHEQUE PROCESSOR BIN % OVERFILL

s28

CHEQUE PROCESSOR BIN % NEARLY FULL

s29

RECEIPT CAPTURE BIN OVERFILL

s30

BNA CASSETTE % OVERFILL

s31

BNA CASSETTE % MISSING

s32

BNA CASSETTE % NEARLY FULL

s33

BNA REJECT BIN OVERFILL

s34

BN REJECT BIN MISSING

s35

BNA REJECT BIN NEARLY FULL

s36

BNA RETRACT BIN OVERFILL

s37

BNA RETRACT BIN MISSING

s38

BNA RETRACT BIN NEARLY FULL

s40

FIFTH CASSETTE GOOD

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-49

Reserved Screens
T and t Journal Trace Information

TandtJournalTraceInformation
Tandtscreenscontainthefollowingmessages:

Envelopeserialnumber
Securitytrace
Presentererror
Envelopelength
Journalreprint.

Fordetails,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
Table A-7
Journal Trace Screens
Column Position
Screen
Number

Row
Position

T00

*ENVELOPE NUMBER = %%%% *

T01

CARD BIN REMOVED

T02

CARD BIN INSERTED

T03

REJECT BIN REMOVED

T04

REJECT BIN INSERTED

T05

TOP CASSETTE REMOVED

T06

TOP CASSETTE INSERTED

T07

SECOND CASSETTE REMOVED

T08

SECOND CASSETTE INSERTED

T09

THIRD CASSETTE REMOVED

T10

THIRD CASSETTE INSERTED

T11

FOURTH CASSETTE REMOVED

T12

FOURTH CASSETTE INSERTED

1
2
3
4
1234567890123456789012345678901234567890

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-50

APTRA Advance NDC, Reference Manual

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

T13

1
2
3
4
5
6
7
8

DIAGNOSTIC DISPENSE REPORT


CASH HANDLER %
NOTES DISPENSED (DELTA)
TYPE 1 = %%
TYPE 2 = %%
TYPE 3 = %%
TYPE 4 = %%
NOTES REJECTED (DELTA)
TYPE 1 = %%
TYPE 2 = %%
TYPE 3 = %%
TYPE 4 = %%

T14

POWER-UP/RESET

T15

SUPERVISOR MODE ENTRY

T16

SUPERVISOR MODE EXIT

T17

1
2
3
4
5
6
7
8

CASH
CASH
TYPE
TYPE

CASH REMAINING
TYPE 1 = %%%%%
TYPE 3 = %%%%%

TYPE 2 = %%%%%
TYPE 4 = %%%%%

T18

CARDS CLEARED

= %%%%%

T19

DEPOSITS CLEARED = %%%%%

T20

1
2
3

CASH ADDED
TYPE 1 = %%%%%
TYPE 3 = %%%%%

T21

ENVELOPE NUMBER RESET

T22

KEY A STORED

T23

KEY B STORED

T24

TIME AND DATE SET

T25

DEPOSIT BIN REMOVED

T26

DEPOSIT BIN INSERTED

T27

CARD/DEPOSIT BIN REMOVED

T28

CARD/DEPOSIT BIN INSERTED

T29

KEY V STORED

T30

PRESENTER ERROR

T31

PASSWORD CHANGED

1
2
3
4
1234567890123456789012345678901234567890

COUNTS CLEARED
DISPENSED
1 = %%%%% TYPE 2 = %%%%%
3 = %%%%% TYPE 4 = %%%%%

TYPE 2 = %%%%%
TYPE 4 = %%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-51

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

T32

PASSWORD ERROR

T33

ENVELOPE LENGTH ERROR

T34

DISK NOT AUTHORISED

T35

CARD CAPTURED A/C NO. UNKNOWN

T36

CARD CAPTURED A/C %%%%%%%%%%%%%%

T37

SST OFF-LINE

T38

SST ON-LINE

1
2
3
4
1234567890123456789012345678901234567890

T39

CARD REMOVED MANUALLY

T40T42

Reserved

T43

EJ STARTED BY OPERATOR

T44

EJ LOG INITIALISED OK

T45

EJ LOG COPIED OK

T46

DUAL STARTED BY OPERATOR

T47

**** COMMENCING REPRINT ****

T48

**** REPRINT COMPLETED OK ****

T49T50

Reserved

T51

**** REPRINT HALTED ****

T52

>>

T53

<<

T54

**** JOURNAL BACKUP STARTED ****

T55

**** JOURNAL LIMIT EXCEEDED ****

T56T57
T58

Reserved
1
2
3
4
5
6
7
8

COIN COUNTS CLEARED


COINS DISPENSED
HOPPER 1 = %%%%% HOPPER 2 = %%%%%
HOPPER 3 = %%%%% HOPPER 4 = %%%%%
COINS REMAINING
HOPPER 1 = %%%%%
HOPPER 3 = %%%%%

HOPPER 2 = %%%%%
HOPPER 4 = %%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-52

APTRA Advance NDC, Reference Manual

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

T59

1
2
3

T60

1
2
3
4
1234567890123456789012345678901234567890
COINS ADDED
HOPPER 1 = %%%%%
HOPPER 3 = %%%%%

HOPPER 2 = %%%%%
HOPPER 4 = %%%%%

Reserved

T61

COIN DISPENSER REMOVED

T62

COIN DISPENSER INSERTED

T63

COIN HOPPER % REMOVED

T64

COIN HOPPER % INSERTED

T65T75
T76

Reserved
1
2
3
4
5
6
7
8

T77T82

POWER INTERRUPTION DURING


DISPENSE
NOTES DISPENSED
TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
NOTES REMAINING
TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
Reserved

T83

EJ LOG RECOPIED OK

T84

RCOPY LOG FAIL

T86

BAD TIMEOUT KBD

T87

BAD SUPVSR KBD

T88

BAD HEX KBD

T89T91

Reserved

T92

ACCOUNT NOT KNOWN

T93

DLL LOAD ERROR

T94

DLL CALL ERROR

T95

VAULTED NOTES COUNT

t01

CHEQUE PROCESSOR CLEARED

t02

CPM PCKT 1 CLRD = %%

t03

CPM PCKT 2/REJ BIN CLRD = %%

t04

CPM PCKT 3 CLRD = %%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-53

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

t05

CHEQUE PROCESSOR INITIALISED

t06

CHEQUE TRANSPORT CLEARED

t07*

1
2
3
45

CASSETTE %
CURRENCYID
MEDIA TYPE
VALUE

t08

1
2

REJECT BIN THESHOLD


UPDATED = %

t09

FIFTH CASSETTE REMOVED

t10

1
2
3
4
5

CASH
TYPE
TYPE
TYPE
TYPE

ADDED
1 = %%%%%
3 = %%%%%
5 = %%%%%
7 = %%%%%

1
2
3
4
5
6
7
8
9
10
11
12

CASH
CASH
TYPE
TYPE
TYPE
TYPE

COUNTS CLEARED
DISPENSED
1 = %%%%% TYPE 2 = %%%%%
3 = %%%%% TYPE 4 = %%%%%
5 = %%%%% TYPE 6 = %%%%%
7 = %%%%%

CASH
TYPE
TYPE
TYPE
TYPE

REMAINING
1 = %%%%%
3 = %%%%%
5 = %%%%%
7 = %%%%%

t11

t12
t13

1
2
3
4
1234567890123456789012345678901234567890

UPDATED
= %
= %
= %

TYPE 2 = %%%%%
TYPE 4 = %%%%%
TYPE 6 = %%%%%

TYPE 2 = %%%%%
TYPE 4 = %%%%%
TYPE 6 = %%%%%

Reserved
1
2
3
4
5
6
7
8
9
10
11
12

DIAGNOSTIC DISPENSE REPORT


CASH HANDLER %
NOTES DISPENSED (DELTA)
TYPE 1 = %%
TYPE 2 = %%
TYPE 3 = %%
TYPE 4 = %%
TYPE 5 = %%
TYPE 6 = %%
TYPE 7 = %%
NOTES REJECTED (DELTA)
TYPE 1 = %%
TYPE 2 = %%
TYPE 3 = %%
TYPE 4 = %%
TYPE 5 = %%
TYPE 6 = %%
TYPE 7 = %%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-54

APTRA Advance NDC, Reference Manual

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

t14

1
2
3
4

SP UPDATE - NEW VALUE FOR


%
CURRENCYID = %
VALUE
= %

t15

1
2

CARD: %%%%%%%%%%%%%%%%%%%%%
DATE %%/%%/%%
TIME = %%:%%:%%

t16t18

1
2
3
4
1234567890123456789012345678901234567890

Reserved

t19

ESCROW FULL

t20

NOTE ERROR OCCURRED:REASON:<ErrorReason%>


--<ErrorDescription%>

t21

Reserved

t22

TRANSACTION START

t23

CARDLESS TRANSACTION START

t24

PIN ENTERED

t25

CARD INSERTED

t26

NOTES STACKED

t27

CARD TAKEN

t28

NOTES PRESENTED %

t29

NOTES TAKEN

t30

TRANSACTION END

t31

FGRPRINT X CAPTURED

t32

FGRPRINT NOT CAPTURED

t33

Reserved

t34

1
2

CONFIGURE NOTE TYPES FAILED :


REASON:%%%-%%%%%%%%%%%%%%%%%%

t35

CUTOVER IS %%%%%%%

t36

SCHEDULED INIT IS %%%%%%%

t37

AGENT IS %%%%%%%

t38

COMPRESSION IS %%%%%%%

t39

AUTO INIT COPY DRIVE SET TO %

t40

ENABLED

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-55

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

t41

DISABLED

t42

CURRENT EJFILE SIZE(KB)-%%%%%

t43

EJ BACKUP MODE %

t44

NO OF EJ BACKUPS %%%%%

t45

HOST CONTROL EJ MODE IS %%%%%%%%

t46

INVALID-AUTO EJ INIT IN PROGRESS

t47

DIRECT EJ INIT PERFORMED

t48

DAY OF THE MONTH CHANGED TO %%

t49

SCHEDULED INIT TIME CHANGED TO %%%%

t50

DAILY

t51

WEEKLY

t52

MONTHLY

t53

INIT BY SUPERVISOR

t54

DAY OF THE WEEK CHANGED TO %%%

t5557

1
2
3
4
1234567890123456789012345678901234567890

Reserved

t58

CPM BIN % INSERTED

t59

CPM BIN % REMOVED

t60

SST IN SERVICE

t61

SST OUT OF SERVICE

t62

SST IN SUSPEND MODE

t63

SST OUT OF SUSPEND MODE

t64

1
2
3

TEST PRINT
!"%$@#0123456789:;<=>?@ABCDEFGHIJKLMNOPQ
STUVWXYZ[\]^abcdefghijklmnopqrstuvwxyz

t65

ENV DEPOSITED IN DIAG = %

t66t67
t68
t69

Reserved
1

HOST TX TIMEOUT
INPUT:%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-56

APTRA Advance NDC, Reference Manual

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

t70

1
2
3
4
5
6
7
8
9
10
11
12

COINS COUNT CLEARED


COINS DISPENSED
HOPPER 1 = %%%%% HOPPER
HOPPER 3 = %%%%% HOPPER
HOPPER 5 = %%%%% HOPPER
HOPPER 7 = %%%%% HOPPER

2
4
6
8

=
=
=
=

%%%%%
%%%%%
%%%%%
%%%%%

COINS REMAINING
HOPPER 1 = %%%%%
HOPPER 3 = %%%%%
HOPPER 5 = %%%%%
HOPPER 7 = %%%%%

HOPPER
HOPPER
HOPPER
HOPPER

2
4
6
8

=
=
=
=

%%%%%
%%%%%
%%%%%
%%%%%

1
2
3
4
5

COINS ADDED
HOPPER 1 = %%%%%
HOPPER 3 = %%%%%
HOPPER 5 = %%%%%
HOPPER 7 = %%%%%

HOPPER
HOPPER
HOPPER
HOPPER

2
4
6
8

=
=
=
=

%%%%%
%%%%%
%%%%%
%%%%%

t71

t72
t73

FGRPRINT DATA SENT


1

t74
t75

1
2
3
4
1234567890123456789012345678901234567890

CONSUMER RESOURCE RELINQUISHED


INIT AFTER SETTLEMENT %

1
2
3
4
5
6
7
8
9
10
11
12

POWER INTERRUPTION DURING


DISPENSE
COINS DISPENSED %%%%%
HOPPER 1 = %%%%% HOPPER 2
HOPPER 3 = %%%%% HOPPER 4
HOPPER 5 = %%%%% HOPPER 6
HOPPER 7 = %%%%% HOPPER 8
COINS REMAINING
HOPPER 1 = %%%%% HOPPER 2
HOPPER 3 = %%%%% HOPPER 4
HOPPER 5 = %%%%% HOPPER 6
HOPPER 7 = %%%%% HOPPER 8

=
=
=
=

%%%%%
%%%%%
%%%%%
%%%%%

=
=
=
=

%%%%%
%%%%%
%%%%%
%%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-57

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

t76

1
2
3
4
5
6
7
8
9
10
11
12

t77

1
2
3
4
1234567890123456789012345678901234567890
POWER INTERRUPTION DURING
DISPENSE
NOTES DISPENSED %%%%%
TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
TYPE 5 = %%%%% TYPE 6 = %%%%%
TYPE 7 = %%%%%
NOTES REMAINING
TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
TYPE 5 = %%%%% TYPE 6 = %%%%%
TYPE 7 = %%%%%
Reserved

t78

CDM 1

t79

CDM 2

t80

C1

t81

C2

t82

RESET TO RETRACT AREA SUCCESSFUL

t83

RESET TO RETRACT AREA FAILED

t84

RESET TO REJECT AREA SUCCESSFUL

t85

RESET TO REJECT AREA FAILED

t86

CASH DISPENSE ERROR

t87

CASH ACCEPT ERROR

t88

<HARDCOPY BACKUP: NO CHEQUE IMAGE>

t89

INIT AFTER SETTLEMENT

t90

LAST TRANSACTION FLOW

t91

FIFTH CASSETTE INSERTED

t92

SNAPSHOTS COPIED TO %

t93

SNAPSHOTS DELETED

t94

EJ PRIVACY IS %

t95

BUNCH NOTE ACCEPTOR INITIALISED

t97

INIT BY EJ CUTOVER

t98

INIT BY EJ AGENT

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-58

APTRA Advance NDC, Reference Manual

Reserved Screens
T and t Journal Trace Information
Column Position
Screen
Number

Row
Position

t99

1
2
3
4
1234567890123456789012345678901234567890
INIT BY SCHEDULED INIT

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-59

Reserved Screens
U Cheque, EMV Smart Card and BNA

UCheque,EMVSmartCardand
BNA
Thecheque,EMVSmartCardandBNAUscreensareasfollows.
Table A-8
Cheque, EMV Smart Card and BNA
Screens

Column Position
Screen
Number

Row
Position

U0000
U0056

1
2
3
12345678901234567890123456789012345
Reserved

U0057

U0058

1
2
3

CHEQUE CAPTURED
TSN: %%%%
CARD: %%%%%%%%%%%%%%%%%%%%%%

U0059

1
2
3

CHEQUE CAPTURE FAILED


TSN: %%%%
CARD: %%%%%%%%%%%%%%%%%%%%%%

U0060
U0066

%%%%%% %%%%%%%%%%%%%%%%%%%%%%
CAPTURED %%/%%/%% %%/%%/%%

Reserved

U0067

EXTERNAL AUTHENTICATE: NO ARPC

U0068

EXTERNAL AUTHENTICATE: INVALID ARPC

U0069

SMART CARD READER NOT PRESENT

U0070

CARD INITIALISE ATTEMPT = X

U0071

COMPONENT VERSIONS

U0072

SCRW VERSION

U0073

SMART

U0074

**** CARD DETAILS UNKNOWN ****

U0075

**** AID NOT SELECTED ****

U0076
U0079

Reserved

U0080

CHIP NOT ATTEMPTED

U0081

ATR RECEIVED T=*

U0082

CANDIDATE LIST * APPS

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-60

APTRA Advance NDC, Reference Manual

Reserved Screens
U Cheque, EMV Smart Card and BNA
Column Position
Screen
Number

Row
Position

U0083

APPLICATION SELECTED

U0084

GENAC 1 : *

U0085

APP NOT USABLE

U0086

PROCESSING * SCRIPT

U0087

GENAC 2 : *

U0088

1
2
3

U0089
U0099
U0100

U0101

U0102

U0103

U0107

U0108

CHEQUE EJECT FAILED


TSN
%
CARD: %
Reserved

1
2
3
1
2
3
1
2
3
1
2
3

U0104
U0105
U0106

1
2
3
12345678901234567890123456789012345

BNA CASSETTE COUNTERS


DENOM

%%%%%

%%%%%

BNA AMOUNTS PER CASSETTE


DENOM

%%%%%

%%%%%

TOTAL AMOUNTS PER DENOM


DENOM

TOTAL

TOTAL AMOUNTS PER CURRENCY


CURRENCY

TOTAL

Reserved
1
2
3
4
5

TOO MANY ITEMS ENTERED


PRESS ENTER TO INSERT NOTE
OR
PRESS CANCEL TO EXIT

1
2
3
4
5

NO ITEMS ENTERED

CASHINACTIVE PERFORM INIT BNA

PRESS ENTER TO INSERT NOTE


OR
PRESS CANCEL TO EXIT

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-61

Reserved Screens
U Cheque, EMV Smart Card and BNA
Column Position
Screen
Number

Row
Position

U0109

1
2
3
4
5

1
2
3
12345678901234567890123456789012345
TIMEOUT OCURRED
PRESS ENTER TO INSERT NOTE
OR
PRESS CANCEL TO EXIT

U0110

USER ERROR - TRY AGAIN

U0111

NOT SUPPORTED BY THIS DEVICE

U0112

CREATE SIGS SUCCESSFUL

U0113

1
2
3

PLEASE REMOVE NOTE

U0114

DEVICE NOT READY

U0115

CASHIN RECOVERY STARTED - %%%%%%%%%%

U0116

CASHIN COUNTS MAY BE INACCURATE

U0117

CASH IN RECOVERY OK

U0118

CASH IN RECOVERY FAILED - %%%%%%%%%%

U0119

SERIAL NUMBERS:
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

U0120

FAILED SERIAL NUMBER READS: %%%%

U0121

BNA CASSETTE RECONFIGURATION STARTED

U0122

BNA CASSETTE RECONFIGURATION COMPLETE

U0123

BNA CASSETTE RECONFIGURATION ERROR

U0124

FAILED SIGNATURES: CAT2: %%%%%

U0125

FAILED SIGNATURES: CAT3: %%%%%

U0126

1
2

MISRECOGNITION ERROR/NOTES IN REJECT


BIN

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-62

APTRA Advance NDC, Reference Manual

Reserved Screens
U Cheque, EMV Smart Card and BNA
Column Position
Screen
Number

Row
Position

U0127

1
2
3
12345678901234567890123456789012345

2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

*<TSN%>*<MessageClass%>*<ESC>(Iw<ESC
>(1*<TransCode%>,
M-<DiagnosticData%>, R-<SuppliesEx%>
A/C: <AccountNo%>
<Description%>
ESC: <EscrowedTotalCount%>
<EscrowedCounts%>
VAL: <VaultedTotalCount%>
<VaultedCounts%
REF: <RefundedTotalCount%>
<RefundedCounts%>
REJECTS:<RejectedTotalCount%>
<Cat2TotalCount%>
<Cat2Counts%>
<Cat3TotalCount%>
<Cat3Counts%>
<BS>*<ESC>(1
<ESC>(S

U0128

CASHIN ADD MORE NOTES SELECTED

U0129

1
2

CLOSE STATE WITH NOTES PRESENT REFUND

U0130

1
2

CLOSE STATE WITH NOTES PRESENT ENCASH

U0131

1
2

CLOSE STATE WITH NOTES PRESENT NOTES LEFT IN ESCROW

U0132
U0133

Reserved
1
2

U0134

RETRACT NO: %%%%%, TOT: %%%%% ITEMS:


%%%%%
ESC: %%%%%%%%%%%
%%%%%%%%%%%
VAL: %%%%%%%%%%%
%%%%%%%%%%%
REF: %%%%%%%%%%%
%%%%%%%%%%%
REJECTS: %%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%

U0135

NOTES DETECTED AT EXIT SLOT

U0136

INIT BNA STARTED - %%%%%%%%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-63

Reserved Screens
U Cheque, EMV Smart Card and BNA
Column Position
Screen
Number

Row
Position

U0137

MONEY FOUND

U0138

MONEY FOUND (ENCASH AUTHORISED)

U0139

1
2
3
12345678901234567890123456789012345

Reserved

U0140

CASHIN SUSPEND RECOVERY STARTED

U0141

1
2
3

* (IW (1*%%%%%, M-%%%%%, R-%%%%%


A/C %%%%%%%%%%%%%%%%
COUNTERFEIT NOTES PRESENT

U0142

1
2
3

* (IW (1*%%%%%, M-%%%%%, R-%%%%%


A/C %%%%%%%%%%%%%%%%
SUSPECT NOTES PRESENT

U0143

BNA %%%%%%%%%%%%%%% INSERTED

U0142

BNA %%%%%%%%%%%%%%% REMOVED

U0145

<ESC>(I *%%%%*1*P*6%%%%%%,M-<ESC>(1

U00146

MONEY FOUND (OFFLINE ENCASH)

U0147
U0149

Reserved

U0150

NOTE TYPE MAPPING ERROR

U0151

COUNTS MAY BE INACCURATE

U0152

CASHIN MESSAGE COUNTERS EXCEEDED


ERROR

U0153

CASHIN ECB6 SCREEN CONTINUE SELECTED

U0154

CASHIN ECB6 SCREEN CANCEL SELECTED

U0155

CASHIN DEPOSIT SELECTED

U0156

CASHIN REFUND SELECTED

U0157

CASHIN CONFIRMATION SCREEN TIMEOUT

U0158

CASHIN ECB6 SCREEN TIMEOUT

U0159

CASHIN NOTE INSERTION TIMEOUT

U0160

CIM-DEPOSIT COMPLETION FAILED

U0161

1
2

CIM-DEPOSIT COMPLETED-ITEMS REFUND


FAILED

U0162

CIM-NO ITEMS TO DEPOSIT

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-64

APTRA Advance NDC, Reference Manual

Reserved Screens
U Cheque, EMV Smart Card and BNA
Column Position
Screen
Number

Row
Position

U0163

CIM-NO ITEMS TO REFUND

U0164

CASHIN NOTE INSERTION CANCELLED

U0165

1
2

CASHIN NOTE INSERTION TIMEOUT


CANCELLED

1
2
3
12345678901234567890123456789012345

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-65

Reserved Screens
d Supervisor Diagnostic Screens

dSupervisorDiagnosticScreens
ThefollowingdSupervisorDiagnosticscreensaredisplayed:
Table A-9
Supervisor Diagnostic Screens

Column Position
Screen
Number

Row
Position

d10

N/A

d11

GOOD

d12

ROUTINE

d13

WARNING

d14

SUSPEND

d15

FATAL

d16d1
9

1
2
3
12345678901234567890123456789012

Reserved

d20

CASH HANDLER 1

d21

CASH HANDLER 2

d22

COIN DISPENSER

d23

CARD READER

d24

NOTE ACCEPTOR

d25

ENVELOPE DEPOSITORY

d26

CHEQUE PROCESSOR

d27

PAPER JOURNAL PTR

d28

RECEIPT PRINTER

d29

STATEMENT PRINTER

d30

ENVELOPE DISPENSER

d31

ENCRYPTOR

d32

NIGHT SAFE

d33

BARCODE READER

d34d4
9
d50

Reserved
1

TEST TIMED OUT

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-66

APTRA Advance NDC, Reference Manual

Reserved Screens
d Supervisor Diagnostic Screens
Column Position
Screen
Number

Row
Position

d51

TEST FAILED

d52

INITIALISING...

d53

SELF TEST...

d54

TEST COMPLETE

d55d5
9

1
2
3
12345678901234567890123456789012

Reserved

d60

ENTER CARD OR WAIT FOR TIMEOUT

d61

TAKE CARD

d62

CAPTURING CARD

d63

PRINT TEST

d64

DEPOSIT ENVELOPE

d65

ENV TEST PRINT

d66

1
2
3
4
5
6
7
8

SELECT
4
6
8
26
90

REPLENISH
5
ACCESS
7
TRANSFER
9
FAULT DISPLAY 27
MISC FUNCS

d67

CASH RECYCLER

d68

ENTER CHEQUE

d69

1
2
3
4

TAKE CHEQUE OR
WAIT FOR CAPTURE
CODELINE =
[%]

d70

CHEQUE CAPTURE

CONFIGURE
DIAGNOSTIC
EXIT
MV DIAG

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-67

Reserved Screens
i Supervisor TCP/IP

iSupervisorTCP/IP
ThefollowingiSupervisorTCP/IPscreensaredisplayed:
Table A-10
Supervisor TCP/IP Screens

Column Position
Screen
Number

Row
Position

i00

1
2
3
4
5

i01

i02

i03

i04

i05

i06

1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5

1
2
3
12345678901234567890123456789012

CURRENT TCP/IP CONFIG


REMOTE IP ADDRESS:

CURRENT TCP/IP CONFIG


REMOTE PORT NO:

CURRENT TCP/IP CONFIG


LOCAL IP ADDRESS:

CURRENT TCP/IP CONFIG


LOCAL PORT NO:

CURRENT TCP/IP CONFIG


CONFIG AS SRVR:

CURRENT TCP/IP CONFIG


MESSAGE FORMAT:

CURRENT TCP/IP CONFIG


LENGTH SIZE:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-68

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor TCP/IP
Column Position
Screen
Number

Row
Position

i07

1
2
3
4
5

i08

i09

i10

i11

i12

i13

i14

1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5

1
2
3
12345678901234567890123456789012

CURRENT TCP/IP CONFIG


LENGTH FORMAT:

CURRENT TCP/IP CONFIG


LENGTH ADJUST:

CURRENT TCP/IP CONFIG


LENGTH OFFSET:

CURRENT TCP/IP CONFIG


LENGTH EMBED:

CURRENT TCP/IP CONFIG


RCVD TIMEOUT:

CURRENT TCP/IP CONFIG


HRTBT INTERVAL:

CURRENT TCP/IP CONFIG


DWNBT INTERVAL:

CURRENT TCP/IP CONFIG


MAX ROUNDTRP:

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-69

Reserved Screens
i Supervisor TCP/IP
Column Position
Screen
Number

Row
Position

i15

1
2
3
4
5

i16

i17

i18

i29

i39

i41

1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
6
7
1
2
3
4
5
6

1
2
3
12345678901234567890123456789012

CURRENT TCP/IP CONFIG


RECONN ON CLS:

CURRENT TCP/IP CONFIG


MAXIMUM RETRYS:

CURRENT TCP/IP CONFIG


KEEP ALIVE:

CURRENT TCP/IP CONFIG


RETRY INTERVAL:

CURRENT TCP/IP CONFIG


RETRY TIMER:
CONFIGURE SSL
OPTIONAL PARAMETERS
1 ADD
2 EDIT
3 DELETE
CONFIGURE SSL
OPTIONAL PARAMETERS

1 ADD/EDIT
2 DELETE

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-70

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup

iSupervisorDialup

ThefollowingiSupervisorDialupscreensaredisplayed:
Table A-11
Supervisor Dialup Screens

Column Position
Screen
Number

Row
Position

i46

1
2
3
4
5

i47

i48

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

i49

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

1
2
3
12345678901234567890123456789012

NETWORK ADDRESS
1 N/A OPTION
3 N/A RSP TMR

2 N/A DLY TMR


4 N/A STRING

CHOOSE AN OPTION CURRENT APPLICATION CONFIG


CURRENT BIN+--------------+
|1ABC|2DEF|3GHI|
------+ |----|----|----| +-----%()*+,| |4JKL|5MNO|6PQR| |!"#$%&
------+ |----|----|----| +-----------+ |7STU|8VWX|9YZ.| +-----/;<]^_| +----|----|----+ |=>?@[\
------+
|0- :|
+-----+----+
ENTER BINPRESS ENTER TO ACCEPT CHARACTER
PRESS ENTER AGAIN WHEN DONE
CURRENT APPLICATION CONFIG
CURRENT TID -

------+
%()*+,|
------+
------+
/;<]^_|
-----+
ENTER 6

+--------------+
|1ABC|2DEF|3GHI|
|----|----|----|
|4JKL|5MNO|6PQR|
|----|----|----|
|7STU|8VWX|9YZ.|
+----|----|----+
|0- :|
+----+'
DIGIT TID-

+-----|!"#$%&
+-----+-----|=>?@[\
+------

PRESS ENTER TO ACCEPT CHARACTER


PRESS ENTER AGAIN WHEN DONE

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-71

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i50

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i51

i52

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

CURRENT APPLICATION CONFIG


TRAN CMP MSG :

1 - ENABLED
0 - DISABLED

ENTER TRAN CMP MSG CURRENT APPLICATION CONFIG


MSG SUPPRESS :

1 - ENABLED
0 - DISABLED

ENTER MSG SUPPRESS CURRENT APPLICATION CONFIG


ACTIVITY TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 25500 SECONDS

ENTER ACTIVITY TIMER -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-72

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i53

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

i54

i55

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

CURRENT APPLICATION CONFIG


MSG ON CP:

1 - ENABLED
0 - DISABLED

ENTER MSG ON CP CURRENT APPLICATION CONFIG


CP MSG TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 255 SECONDS

ENTER CP MSG TIMER CURRENT APPLICATION CONFIG


ERROR REDIAL TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 2550 SECONDS'

ENTER ERROR REDIAL TMR -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-73

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i56

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i57

i58

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

CURRENT SERIAL LINK CONFIG


COM PORT :

ENTER COM PORT CURRENT SERIAL LINK CONFIG


BAUD RATE :

1 = 300

2 = 1200'

3 = 2400

4 = 4800'

5 = 96OO

6 = 14400'

CHOOSE AN OPTION CURRENT SERIAL LINK CONFIG


DATA BITS :

ENTER A VALUE OF 7 OR 8

ENTER DATA BITS -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-74

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i59

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i60

i61

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14

1
2
3
12345678901234567890123456789012

CURRENT SERIAL LINK CONFIG


PARITY :

1 = NONE

2 = ODD

3 = EVEN

4 = MARK

5 = SPACE
CHOOSE AN OPTION CURRENT SERIAL LINK CONFIG
STOP BITS :

ENTER A VALUE OF 1 OR 2

ENTER STOP BITS CURRENT MODEM LINK CONFIG


PRIMARY NUMBER :
+-----------+
| 1 | 2 | 3 |
|---|---|---|
| 4 | 5 | 6 |
|---|---|---|
| 7 | 8 | 9 |
+-----------+
| 0 |
+---+

+------'
|COMMA>'
+------'

ENTER PRIMARY NUMBER-

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-75

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i62

1
2
3
4
5
6
7
8
9
10
11
12
13
14

i63

i64

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012
MODEM LINK SECONDARY NUMBER
PRESS <ENTER> FOR NO VALUE
+-----------+
| 1 | 2 | 3 |
|---|---|---|
| 4 | 5 | 6 |
|---|---|---|
| 7 | 8 | 9 |
+-----+-----------+
|COMMA>
| 0 |
+-----+---+
ENTER SECONDARY NUMBERCURRENT MODEM LINK CONFIG
MODEM CONNECT TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 255 SECONDS

ENTER CONNECT TIMER CURRENT MODEM LINK CONFIG


DIAL MODE :

1 - TONE
0 - PULSE

ENTER DIAL MODE -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-76

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i65

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i66

i67

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

CURRENT MODEM LINK CONFIG


MODEM COMMAND RESPONSE TIMER :

PLEASE ENTER A VALUE BETWEEN


1 AND 20 SECONDS

ENTER CMD RSP TIMER CURRENT VISA 2 CONFIG


ENQ TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 255 SECONDS

ENTER ENQ TIMER CURRENT VISA 2 CONFIG


MESSAGE RETRIES :

PLEASE ENTER A VALUE BETWEEN


0 AND 9

ENTER MSG RETRIES -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-77

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i68

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i69

i70

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

CURRENT VISA 2 CONFIG


ACK TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 255 SECONDS

ENTER ACK TIMER CURRENT VISA 2 CONFIG


ENQ AFTER ACK :

1 - ENABLED
0 - DISABLED

ENTER ENQ AFTER ACK CURRENT VISA 2 CONFIG


CONNECT LIFE TIME :

1 = NORMAL

2 = PREDIAL

CHOOSE AN OPTION -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-78

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i71

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i72

i73

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

CURRENT VISA 2 CONFIG


DIAL ON SEND TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 255 SECONDS

ENTER DIAL ON SND TMR CURRENT NETWORK ADDRESS CONFIG


NETWORK ADDRESS OPTION :

1 - ENABLED
0 - DISABLED

ENTER N/A OPTION CURRENT NETWORK ADDRESS CONFIG


N/A DELAY TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 1000 MILLISECONDS

ENTER N/A DELAY TMR -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-79

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i74

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

i75

1
2
3
12345678901234567890123456789012

CURRENT NETWORK ADDRESS CONFIG


N/A RESPONSE TIMER :

PLEASE ENTER A VALUE BETWEEN


0 AND 5000 MILLISECONDS

ENTER N/A RESPONSE TMR -

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

CHOOSE AN OPTION -

i76

FILE OR DISK NOT PRESENT

i77

DISK NOT PRESENT IN DRIVE A

COPY DIALUP CONFIG

DIALUP CONFIG
1 = COPY ON

2 = COPY OFF

APPLICATION SETTINGS
3 = COPY ON

4 = COPY OFF

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-80

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i78

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

i79

i80

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1

1
2
3
12345678901234567890123456789012
CURRENT MODEM STRING

------+
%()*+,|
------+
------+
/;<]^_|
------+

|1ABC|2DEF|3GHI|
|----|----|----|
|4JKL|5MNO|6PQR|
|----|----|----|
|7STU|8VWX|9YZ.|
+----|----|----+
0- :

+------'
|!"#$%&'
+------'
+------'
|=>?@[\'
+------'

ENTER STRING:

PRESS ENTER TO ACCEPT CHARACTER


PRESS ENTER AGAIN WHEN DONE
CURRENT APPLICATION CONFIG
HOST MESSAGE HEADER :

1 - ENABLED
0 - DISABLED

ENTER HOST MSG HEADER FILE COPIED

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-81

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i81

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

i82

i83

i84

1
2
3
4
5
6
7
8
9
10
11
12
1
2
3
4
5
6
7
8
9
1
2
3
4
5
6
7

1
2
3
12345678901234567890123456789012
CURRENT NETWORK STRING

+--------------+
|1ABC|2DEF|3GHI|
------+ |----|----|----|
%()*+,| |4JKL|5MNO|6PQR|
------+ |----|----|----|
------+ |7STU|8VWX|9YZ.|
/;<]^_| +----|----|----+
-----+
|0- :|
+----+
ENTER STRING:

PRESS ENTER TO ACCEPT CHARACTER


PRESS ENTER AGAIN WHEN DONE
DIALUP
1
3
5
7

APPL PARAM
MODEM LINK
NETWORK ADD
DIAGNOSTICS

2 SERIAL LINK
4 VISA 2
6 COPY ON/OFF

APPLICATION PARAMETERS
1
3
5
7
9

BIN
2
TRAN CMP MSG 4
ACT TIMER
6
MSG ON CP
8
ERR REDIAL
10

TID
HOST MSG HEAD
MSG SUPPRESS
CP MSG TMR
SUPP CASH LOW

MODEM LINK
1 PRIMARY NO
3 CONNECT TMR
5 CMD RSP TMR

2 SECONDARY NO
4 DIAL MODE
6 MODEM INI STR

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-82

+-----|!"#$%&
+-----+-----|=>?@[\
+------

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Dialup
Column Position
Screen
Number

Row
Position

i85

1
2
3
4
5
6
7

i86

i87

1
2
3
4
5
6
7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

1
2
3
12345678901234567890123456789012

SERIAL LINK
1 COM PORT
3 DATA BITS
5 STOP BITS

2 BAUD RATE
4 PARITY

VISA 2
1
3
5
7

ENQ TMR
2 MSG RETRIES
ACK TIMER
4 ENQ AFTR ACK
CNT LIFE TIME 6 DIAL SND TMR
BACKOFF TMR
CURRENT VISA 2 CONFIG

BACKOFF TIMER :

PLEASE ENTER A VALUE BETWEEN


100 AND 10000 MILLISECONDS

ENTER BACKOFF TIMER -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-83

Reserved Screens
i Supervisor BNA

iSupervisorBNA

ThefollowingiSupervisorBunchNoteAcceptor(BNA)screens
aredisplayed:
Table A-12
Supervisor BNA Screens

Column Position
Screen
Number

Row
Position

i19

1
2
3
4
5
6
7
8
9
10
11
12

i20

i21

1
2
3
4
5
6
7
8
9
10
11
12
1
2
3
4
5
6
7
8
9
10
11

1
2
3
12345678901234567890123456789012

BUNCH NOTE ACCEPTOR COUNTS


TYPE
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%

CONFIG
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%

DEPOSIT COUNT
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%

BUNCH NOTE ACCEPTOR COUNTS


LAST CLEARED : %%/%%/%% %%:%%
TYPE
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%

CONFIG
%%%%%%
%%%%%%
%%%%%%
%%%%%%
%%%%%%
%%%%%%

COUNT
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%

BNA CNTRS
LAST CLEARED : %%/%%/%% %%:%%

ENCASHED
REJECTED

COUNT
%%%%%
%%%%%

ESCRW DEPS
ESCRW RFND

%%%%%
%%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-84

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor BNA
Column Position
Screen
Number

Row
Position

i22

1
2
3
4
5
6
7
8
9
10
11
12
13

i23

1
2
3
4
5
67

i24

1
2
3
4
5
6
7
8
9
10
11
12

i25

1
2
3
4
5
6
7
8
9
10
11
12

1
2
3
12345678901234567890123456789012

BUNCH NOTE ACCEPTOR CONFIG


TYPE CONFIG

ACT/INACT

%%
%%
%%
%%
%%
%%
%%
%%

%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%

%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%

ENCASHED
REJECTED

COUNT
%%%%%
%%%%%

ESCRW DEPS
ESCRW RFND

%%%%%
%%%%%

%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%
%%

%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%
%%%%%%%%

%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%
%%%%%%%%%

CARDS CAPTURED
%%%%%
LAST CLEARED %%/%%/%% %%:%%
DEPOSITS MADE
%%%%%
LAST CLEARED %%/%%/%% %%:%%
ACTIVITY COUNT = %%%%%%%
PKT 1 %%%%% CLRD %%/%%/%% %%:%%
PKT 2 / REJECT BIN
%%%%% CLRD %%/%%/%% %%:%%
PKT 3 %%%%% CLRD %%/%%/%% %%:%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-85

Reserved Screens
i Supervisor BNA
Column Position
Screen
Number

Row
Position

i26

1
2
3
4
5
6
7
8
9
10
11
12

i27

i28

1
2
3
4
5
6
7

i30i32
i33

CARDS CAPTURED
%%%%%
LAST CLEARED %%/%%/%% %%:%%

ACTIVITY COUNT = %%%%%%%


PKT 1 %%%%% CLRD %%/%%/%% %%:%%
PKT 2 / REJECT BIN
%%%%% CLRD %%/%%/%% %%:%%
PKT 3 %%%%% CLRD %%/%%/%% %%:%%
CURRENT PATTERN - %%%%%%%
CLEAR DEPOSITORY COUNTERS
0:
1:
2:
3:

ALL POCKETS/BINS
POCKET 1
POCKET 2 / REJECT
POCKET 3

1
2

CHECKSUM VALUE =

Reserved
1
2
3
4
5
6
7
8
9
10
11
12

CASSETTE
CURRENCY ID
MEDIA TYPE
MEDIA VALUE

TYPE 1
%%%%%
%%%%%
%%%%%

TYPE 2
%%%%%
%%%%%
%%%%%

CURRENCY ID
MEDIA TYPE
MEDIA VALUE

TYPE 3
%%%%%
%%%%%
%%%%%

TYPE 4
%%%%%
%%%%%
%%%%%

REJECT BIN THRESHOLD = %%

i38

1
2
3

i40

i41

Reserved

ENTER START DATE (DDMMYY)


ENTER END DATE (DDMMYY)
.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-86

= %%%%%
= %%%%%
= %%%%%

Reserved

i34i36
i37

1
2
3
12345678901234567890123456789012

APTRA Advance NDC, Reference Manual

/
/

/
/

Reserved Screens
i Supervisor BNA
Column Position
Screen
Number

Row
Position

i43

1
2
3
4
5
6
7
8
9
10
11

1
2
3
12345678901234567890123456789012

CASSETTE
+RETRACT
+RECYCLED
=DEPOSITED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%

CASSETTE
+RETRACT
+RECYCLED
=DEPOSITED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%

i76

FILE OR DISK NOT PRESENT

i88

CURRENT DAY - %%%%%%%%

i89

CURRENT CONFIG TIME - %%%%%%

i90

1
2

(
0-SUN 1-MON 2-TUE
3-WED 4-THU 5-FRI 6-SAT)

i91

1
2
3
4
5
6
7
8
9
10
11
12
13

i92

1
2
3
4
5
6
7
8
9
10
11
12
13

BNA CNTRS
LAST CLEARED : %%/%%/%% %%:%%
COUNT
ENCASHED
%%%%%
REJECTED
%%%%%
RETRACTED
%%%%%
NOTES IN TRANSPORT
ESCRW DEPS
ESCRW RFND

%%%%%

%%%%%
%%%%%

CASSETTE MAPPING

TYPE
TYPE
TYPE
TYPE
1.
2.
3.
4.

1
2
3
4

TOP
2ND
3RD
4TH

CUR
%
%
%
%

VALUE
%
%
%
%

%
%
%
%

%
%
%
%

TYPE
%
%
%
%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-87

Reserved Screens
i Supervisor BNA

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-88

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Settlement Screens

iSupervisorSettlementScreens

ThefollowingiSupervisorSettlementscreensaredisplayed:
Table A-13
Supervisor Settlement Screens

Column Position
Screen
Number

Row
Position

i93

1
2
3
4
5
6
7
8
9
10
11
12
13

i94

i95

1
2
3
4
5
6
7
8
9
10
11
12
13
1
2
3
4
5
6
7
8
9
10
11
12
13

1
2
3
12345678901234567890123456789012

SETTLEMENT

FUNCSETTLEMENT

ENTER BUFFER BSETTLEMENT

ENTER BUFFER C-

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-89

Reserved Screens
i Supervisor Settlement Screens
Column Position
Screen
Number

Row
Position

i96

1
2
3
4
5
6
7
8
9
10
11
12
13

i97

i98

1
2
3
4
5
6
7
8
9
10
11
12
13
1
2
3
4
5
6
7
8
9
10
11
12
13

1
2
3
12345678901234567890123456789012

SETTLEMENT

ENTER PINSETTLEMENT

PLEASE WAIT...
SETTLEMENT

CASH-

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-90

APTRA Advance NDC, Reference Manual

Reserved Screens
i Supervisor Settlement Screens
Column Position
Screen
Number

Row
Position

i99

1
2
3
4
5
6
7
8
9
10
11
12
13

1
2
3
12345678901234567890123456789012

SETTLEMENT

FAIL %

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-91

Reserved Screens
j Supervisor Miscellaneous Screens

jSupervisorMiscellaneousScreens
ThefollowingjSupervisormiscellaneousscreensaredisplayed:
Table A-14
Supervisor Miscellaneous Screens

Column Position
Screen
Number

Row
Position

j0000

1
2
3
4
5
6
7
8
9
10
11
12
13
14

1
2
3
4
5
6
7
8

j0001

j0002

1
2
3
4
5
6
7
8

1
2
3
12345678901234567890123456789012

CASSETTE
+REJECTED
=REMAINING
+DISPENSED
=TOTAL

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

CASSETTE
+REJECTED
=REMAINING
+DISPENSED
=TOTAL
LAST CLEARED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%

%%:%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

%%/%%/%%

%%:%%

CASSETTE
+REJECTED
=REMAINING
+DISPENSED
=TOTAL
LAST CLEARED
CASSETTE
+REJECTED
=REMAINING
+DISPENSED
=TOTAL
LAST CLEARED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-92

APTRA Advance NDC, Reference Manual

%%:%%

Reserved Screens
j Supervisor Miscellaneous Screens
Column Position
Screen
Number

Row
Position

j0003

1
2
3
4

1
2
3
12345678901234567890123456789012
*CONFIGURATION DATA*
STANDARD NOTE COUNTS
T1=%%%%%
T2=%%%%%
T3=%%%%%
T4=%%%%%

Note:Ifdualcashhandlersareusedwithseparatedcounters,the
standardnotecountsaredisplayedwiththeprimarycashhandlercount
first(P),thenthesecondarycashhandlercount(S),asfollows:

j0004

T1=PPPPPP SSSSSS T2=PPPPPP SSSSSS


T3=PPPPPP SSSSSS T4=PPPPPP SSSSSS
1
2
3
4
5
6

*CONFIGURATION DATA*
STANDARD NOTE COUNTS
T1=%%%%%
T2= %%%%%
T3=%%%%%
T4= %%%%%
T5=%%%%%
T6= %%%%%
T7=%%%%%

Note:Ifdualcashhandlersareusedwithseparatedcounters,the
standardnotecountsaredisplayedwiththeprimarycashhandlercount
first(P),thenthesecondarycashhandlercount(S),asfollows:

T1=PPPPPP SSSSSS T2=PPPPPP SSSSSS


T3=PPPPPP SSSSSS T4=PPPPPP SSSSSS

IfEnhancedConfigurationoption76issetto001,thedisplaywillbeas
follows:
T1=PPPPPP
T3=PPPPPP
T5=PPPPPP
T7=PPPPPP
j0005
j0006

SSSSSS T2=PPPPPP SSSSSS


SSSSSS T4=PPPPPP SSSSSS
SSSSSS T6=PPPPPP SSSSSS
SSSSSS

Reserved
1
2
3
4
5
6
7
8
9
10
11
12
13
14

%
CASSETTE
+REJECTED
+DISPENSED
-DEPOSITED
=TOTAL

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

CASSETTE
+REJECTED
+DISPENSED
-DEPOSITED
=TOTAL
LAST CLEARED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%:%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-93

Reserved Screens
j Supervisor Miscellaneous Screens
Column Position
Screen
Number

Row
Position

j0007

1
2
3
4
5
6
7
8
9
10
11
12
13
14

1
2
3
4
5
6
7
8

1
2
3
4
5
6
7
8

1
2
3
4
5
6
7
8
9
10
11
12
13
14

CURRENT APPLICATION CONFIG

j0008

j0009

j0010

1
2
3
12345678901234567890123456789012

CASSETTE
+REJECTED
+DISPENSED
-DEPOSITED
=TOTAL

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

CASSETTE
+REJECTED
+DISPENSED
-DEPOSITED
=TOTAL
LAST CLEARED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%

%%%%%
%%%%%
%%%%%
%%:%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%

%%/%%/%%

%%:%%

CASSETTE
+REJECTED
+DISPENSED
-DEPOSITED
=TOTAL
LAST CLEARED
CASSETTE
+REJECTED
+DISPENSED
-DEPOSITED
=TOTAL
LAST CLEARED

TYPE %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%

SUPPRESS CASH LOW:

PLEASE ENTER A VALUE BETWEEN


0 AND 9

ENTER SUPP CASH LOW -

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-94

%%:%%

APTRA Advance NDC, Reference Manual

Reserved Screens
j Supervisor Miscellaneous Screens
Column Position
Screen
Number

Row
Position

j0011
j0019
j0020

j0021

1
2
3
12345678901234567890123456789012
Reserved

1
2
3
4
5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

CONFIGURE
89 NO HOST CHG VG
91 ALPHANUMERIC MACHINE NUMBER
99 MORE
CURRENT CONFIG - %%%%%%
PRESS KEY REPEATEDLY TO
CYCLE THROUGH VALUES
PRESS ENTER TO ACCEPT CHARACTER
PRESS ENTER AGAIN WHEN DONE
+--------------+
|QZ.1|ABC2|DEF3|
|----+----+----|
|GHI4|JKL5|MNO6|
|----+----+----|
|PRS7|TUV8|WXY9|
+----+----+----+
|<SPACE>_-0|
+----------+
ENTER MACHINE NO-

j0022

NOTES RETRACTED %%%%


TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
UNKNOWN= %%%%%
LAST CLEARED %%/%%/%%
%%:%%

j0023

NOTES RETRACTED %%%%


TYPE 1 = %%%%% TYPE 2 =
TYPE 3 = %%%%% TYPE 4 =
TYPE 5 = %%%%% TYPE 6 =
TYPE 7 = %%%%% UNKNOWN=
LAST CLEARED %%/%%/%%

%%%%%
%%%%%
%%%%%
%%%%%
%%:%%

j0024

1
2
3
4

NOTES RETRACTED %%%%


TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
UNKNOWN= %%%%%

j0025

1
2
3
4
5

NOTES RETRACTED %%%%


TYPE 1 = %%%%% TYPE 2 =
TYPE 3 = %%%%% TYPE 4 =
TYPE 5 = %%%%% TYPE 6 =
TYPE 7 = %%%%% UNKNOWN=

%%%%%
%%%%%
%%%%%
%%%%%

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-95

Reserved Screens
j Supervisor Miscellaneous Screens
Column Position
Screen
Number

Row
Position

j0026
j3999

1
2
3
12345678901234567890123456789012
Reserved

j4000

MACHINE NO =%

j4001

DATE-TIME

j4010

j4011
j4014
j4013

=%

Reserved
1
2
3
4
5
6
7
8
9
10
11
12

<Title%>
<LabelLink1%>
<LabelLink2%>
<LabelLink3%>
<LabelLink4%>
<LabelLink5%>
<LabelLink6%>
<LabelLink7%>
<LabelLink8%>
<End%>'

:<Item1%>'
:<Item2%>'
:<Item3%>'
:<Item4%>'
:<Item5%>'
:<Item6%>'
:<Item7%>'
:<Item8%>'

1
2
3
4
5
6
7
8
9
10
11
12

<Title%>
<LabelLink1%>
<LabelLink2%>
<LabelLink3%>
<LabelLink4%>
<LabelLink5%>
<LabelLink6%>
<LabelLink7%>
<LabelLink8%>
<End%>'

:<Item1%>'
:<Item2%>'
:<Item3%>'
:<Item4%>'
:<Item5%>'
:<Item6%>'
:<Item7%>'
:<Item8%>'

j4015

TCPIP ENABLED

j4016

PCCM ENABLED

j4017

DIALUP VISA2 ENABLED

j4018

CIM-DEPOSIT ACTIVATED

j4019

CIM-SHUTTER OPENED

j4020

CIM-ITEMS INSERTED

j4021

CIM-INPUT REFUSED, REASON %%%%%%%%%%%

j4014

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-96

APTRA Advance NDC, Reference Manual

Reserved Screens
j Supervisor Miscellaneous Screens
Column Position
Screen
Number

Row
Position

j4022

CIM-ITEMS PRESENTED

j4023

CIM-ITEMS TAKEN

j4024

CIM-DEPOSIT COMPLETED

j4025
j4031
j4032

j4035

1
2
3
12345678901234567890123456789012

Reserved
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1

CONFIGURE NHC VG
0 DISABLE'
1 ENABLE'

CURRENT = %

PRESS 1 TO ENABLE/0 TO DISABLE


CIM-DEPOSIT COMPLETED-ITEMS REFUNDED

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

A-97

Reserved Screens
j Supervisor Miscellaneous Screens

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

A-98

APTRA Advance NDC, Reference Manual

Table of Contents
Character Sets

Appendix B

CharacterSets
Overview

B1

CharacterSets
USBPrintersandDownloadableCharacterSets
StatementCodeSets

B2
B4
B5

CodePages
OS/2CodePages
USBReceiptandJournalCodePages

B7
B7
B7

MappingFiles

B8

FontIDMappingTable

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B12

Table of Contents
Character Sets

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Character Sets
Overview

Overview

Thisappendixgivesdetailsofthedefaultcharactersetsprovided
forprintersandcardholderscreens.Italsodescribesthefollowing:

Codepagecharactersetsforthethermalprinter.
Usingamappingfiletoassignanunknowncharactersettoone
thatisrecognised
CommonCharacterSetsandISO8859charactersetswithfont
IDs

Ifyouwish,youcanalsocreateoruseyourownfonts.For
guidelinesonfontdefinition,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
Note:ToenableanEMVIntegratedCircuitCard(ICCorsmart
card)tobeused,additionalfontsandfontdesignatorsareprovided
withAdvanceNDC.IfyouwishtouseanEMVICC,refertothe
EMVIntegratedCircuitCard(ICC)ReferenceManualprovidedwith
theEMV/CAM2ExitsforAPTRAAdvanceNDCproduct.The
publicationliststheadditionalEMVfontsandfontdesignators.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B-1

Character Sets
Character Sets

CharacterSets

ForformsbasedprintingonUniversalSerialBus(USB)printers,
youcanusetheWindowsTrueTypefontfilesprovidedwith
AdvanceNDC.TheyareprovidedforcharactersetsAlpha1
(NDCAlpha1.ttf)toAlpha6(NDCAlpha6.ttf)andArabic1
(NDCArabic1.ttf)toArabic6(NDCArabic6.ttf),andlocatedin
C:\windows\fonts.
Fordetailsofthesupportedcharacterssetsforrawdataprinting,
refertotheAPTRAonlinedocumentationforyourprinterunder
APTRAXFS|ProgrammersReference|XFSServiceProviders.
Figure B-1
Alpha 1

! " # $ % & ( )

+ , - . /

0 1 2 3 4 5 6 7 8 9 : ; < = > ?

@A B C D E F G H I J K L M N O

P Q R S T U V
_

N
_ _
n E E

6
7

WX Y Z [ \ ] ^ _
_ _
/
O A C G
S/
7

S G I cr dr r
9

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

B-2

APTRA Advance NDC, Reference Manual

Character Sets
Character Sets
Table B-1
Character Sets

Character Set

Designator

Number Of Characters Supported


CRT

PPD

R/J

SingleSizeAlpha1/
SingleSizeArabic1

96

96

96

SingleSizeAlpha2/
SingleSizeArabic2

96

96

SingleSizeAlpha3/
SingleSizeArabic3

64

96

SingleSizeAlpha4/
SingleSizeArabic4

96

SingleSizeAlpha5/
SingleSizeArabic5

96

SingleSizeAlpha6/
SingleSizeArabic6

StandardGraphics1

64

StandardGraphics2

64

StandardGraphics3

64

DoubleSizeAlpha1/
DoubleSizeArabic1

>

96

96

DoubleSizeAlpha2/
DoubleSizeArabic2

96

96

DoubleSizeAlpha3/
DoubleSizeArabic3

64

96

DoubleSizeAlpha4/
DoubleSizeArabic4

96

DoubleSizeAlpha5/
DoubleSizeArabic5

96

DoubleSizeAlpha6/
DoubleSizeArabic6

CondensedSizeAlpha1/
CondensedSizeArabic1

96

CondensedSizeAlpha2/
CondensedSizeArabic2

96

CondensedSizeAlpha3/
CondensedSizeArabic3

96

CondensedSizeAlpha4/
CondensedSizeArabic4

96

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B-3

Character Sets
Character Sets
Character Set

Designator

Number Of Characters Supported


CRT

PPD

R/J

CondensedSizeAlpha5/
CondensedSizeArabic5

96

CondensedSizeAlpha6/
CondensedSizeArabic6

Chinese1

64

Chinese2

64

Note1:Condensedprintisnotsupportedforthereceiptand
journalprinters.Itissupportedforthethermalreceiptinsideways
modeonly.
Note2:Doublesizesetsarenotsupportedbythereceiptprinterin
sidewaysprintingmodeandreceiptofthesedesignatorswillnot
changethecurrentselectedcodeset.
Note3:Forprintingrawdata,theUSBreceiptandjournalprinters
usecodepagesthataremappedtothecharacterset.Fordetailsof
themappingfile,seeMappingFilesonpage B8.
Note4:StandardGraphics2(designator4)mapstoCustomer
Graphics2(designator7)andisadisplayonlyfont,reflectingthe
rangeandlookofcharactersthatarerequiredinanSSTapplication.
Formoreinformation,seeFormattingRulesforCardholder
DisplayScreensonpage 314.

USBPrintersand
DownloadableCharacter
Sets

NCRrecommendstheuseofformsbasedprintingwithaWindows
fontfilerepresentingtherequiredfontsonUSBreceiptandjournal
printers.Formoreinformation,seeCharacterSetsonpage B2
B

However,userdefineddownloadablecharactersetscanbeusedto
printrawdata,andaresentasactualbitstotheprinter.
Existingdownloadablecharactersetsmustbemodifiedtoallowfor
theresolutionchangefrom150dpito203dpi.Thischangeresultsin
alargercharactercellsizeon203dpiprinters.
Thefontdefinitionforthedownloadablecharactersetshouldbe
updatedfor203dpi,asfollows:
1

Changethenumberofbytesforacharactercellfrom2 x xto
3 x x

Changetheheaderfrom1D2602to1D2603

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

B-4

APTRA Advance NDC, Reference Manual

Character Sets
Character Sets

StatementCodeSets

Changethenumberofcolumnsvalueprecedingeachcharacter
definitionasfollows:
Forstandardpitch,from0Bto0E
Forcompressedpitch,from08to0A.

Thestatementprinter(SDC)supportseithersixInternationalAlpha
setsorsixArabicsets.Youcanselectthesebyahardwareswitch.
Note:ThisdoesnotapplytotheopendocumentandUSB
statementprintervariantsasformsbasedprintingusesthe
WindowsfontssuppliedwithAdvanceNDC.

Table B-2
Statement Printer Character Sets

Character Sets

Designator

Number Of Characters Supported

SingleSizeAlpha1/
SingleSizeArabic1

96

SingleSizeAlpha2/
SingleSizeArabic2

96

SingleSizeAlpha3/
SingleSizeArabic3

96

SingleSizeAlpha4/
SingleSizeArabic4

96

SingleSizeAlpha5/
SingleSizeArabic5

96

SingleSizeAlpha6/
SingleSizeArabic6

DoubleSizeAlpha1/
DoubleSizeArabic1

>

96

DoubleSizeAlpha2/
DoubleSizeArabic2

96

DoubleSizeAlpha3/
DoubleSizeArabic3

96

DoubleSizeAlpha4/
DoubleSizeArabic4

96

DoubleSizeAlpha5/
DoubleSizeArabic5

96

DoubleSizeAlpha6/
DoubleSizeArabic6

CondensedSizeAlpha1/
CondensedSizeArabic1

96

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B-5

Character Sets
Character Sets
Character Sets

Designator

Number Of Characters Supported

CondensedSizeAlpha2/
CondensedSizeArabic2

96

CondensedSizeAlpha3/
CondensedSizeArabic3

96

12cpiSizeAlpha1

96

12cpiSizeAlpha2

96

12cpiSizeAlpha3

96

CondensedSizeAlpha4/
CondensedSizeArabic4

96

CondensedSizeAlpha5/
CondensedSizeArabic5

96

12cpiSizeAlpha4

96

12cpiSizeAlpha5

96

CondensedSizeAlpha6/
CondensedSizeArabic6

12cpiSizeAlpha6

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

B-6

APTRA Advance NDC, Reference Manual

Character Sets
Code Pages

CodePages

Fordetailsofthesupportedcharacterssets,refertotheAPTRA
onlinedocumentationforyourprinterunderAPTRAXFS|
ProgrammersReference|XFSServiceProviders.

OS/2CodePages

Thefollowingcontrolsequenceallowstheselectionofoneofthe
supportedOS/2codepagesandsetstheprintertocodepagemode:
ControlCode:1BH25H3xH3yH3zH
where3xH3yH3zHrepresentsthethreebyteASCIIvalueofthe
codepage.
Validcodepagesare:000,437,850,851,852,855,857,860,861,862,
863,864and866.
Codepage000istheuserdefineddownloadablecharactersetcode
page.TheDefineDownloadableCharacterSetcontrolsequence
describedinChapter5mustbeissuedbeforetheSelectOS/2Code
Pagecontrolsequence.
Codepages851,855and866cannotbeusedincondensedprint
mode.
Forfurtherinformationaboutcodepages,refertotheSelfService
PlatformSoftwareProgrammersManualforthe40ColumnPrinterand
theAPTRAonlinedocumentationunderAPTRAXFS|
ProgrammersReference|XFSServiceProviders.

USBReceiptandJournal
CodePages

USBreceiptandjournalprinterssupportcodepagesratherthan
charactersets.However,thecodepagescontainthesame
characters.
Whencharactermappingisenabled,andthehostrequestsan
ArabicorInternationalcharacterset,thecorrespondingsectionis
locatedinthemappingfile.Iffound,thespecifiedcharactersetis
used,otherwisethecontrolsequenceissentdirectlytotheprinter.
Fordetailsofthemappingfile,seeMappingFiles.
Validcodepagesare437,737,850,851,852,855,857,858,860,861,
862,863,864,865,866,and1251

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B-7

Character Sets
Mapping Files

MappingFiles

Forrawdataprinting,AdvanceNDCcanusemappingfilesto
translateanunknowncharactertoaknowncharacter.
Note:Formsbasedprintingdoesnotusemappingfiles.
Thesuppliedmappingfiletousedependsonyourprinter,and
requirements,asfollows:

ForUSBreceiptorjournalprinterswhencharactermappingis
enabled,userdefinedfontsandArabicandInternational
charactersetsareselectedusingtheUniversalCharSets.txt
mappingfile.ThisfileislocatedinC:\ProgramFiles\NCR
APTRA\AdvanceNDC\Config.
Forotherreceiptorjournalprinters,userdefinedfontsare
selectedusingthePersonasCharSets.txtmappingfile.Thisfileis
locatedinC:\ProgramFiles\NCRAPTRA\AdvanceNDC\data.

Thesefilescanbeeditedasrequiredtodefineuserspecified
charactermapping.
Thenameofthemappingfiletouseisheldinthefollowingregistry
key:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
CHAR_MAP_FILENAME

Bydefault,thevalueisUniversalCharSets.txt.
Whenacharactersetisrequested,itisidentifiedusingthefile
definitionfile.Whetherthemappingfileischeckedfora
correspondingsectionissetusingtheMAP_REQUIRED registry
settingunderHKLM\SOFTWARE\NCR\Advance
NDC\PRINTING\<printer>,where<printer> isRECEIPT,or
JOURNAL.
Note:Charactermappingisnotavailableforstatementprinters.If
yourequiredafontforusewithformsonthestatementprinter,you
mustcreatethefont.Fordetailsofcreatingfonts,refertoAppendix
D,FontDefinitionintheAPTRAAdvanceNDC,DevelopersGuide.
Validvaluesareasfollows:

0ifmappingisnotrequired.Themappingfileisneverchecked
1ifmappingisrequired.Themappingfileisalwayschecked.

Ifthesectionislocated,theSelectCodepagecontrolsequenceis
usedtomaptheprintabledata.Ifthesectionisnotlocated,the
requestispasseddirectlytotheprinter.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

B-8

APTRA Advance NDC, Reference Manual

Character Sets
Mapping Files

Forinformationontheprintercontrolcodes,seePrinterControl
Charactersonpage 56.
Thecharacterdesignatorsentbythehosttoselectuserdefinedfonts
mustmatchthatheldintheappropriateregistrykeyfortheprinter
type,asfollows:
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
RECEIPT\CHAR_MAP_DESIGNATOR
HKLM\SOFTWARE\NCR\Advance NDC\PRINTING\
JOURNAL\CHAR_MAP_DESIGNATOR

Bydefault,theseregistrykeysareblank,sonouserspecified
charactermappingoccurs.
Themappingfile,illustratedinFigure B2,usestheconventions
describedinTable B3.
Table B-3
Mapping File Conventions
Convention

Example

Ifthecharacterdoesnotrequiremapping,itdoesnot
needtobeincludedinthemappingfile

Ifcharacteristhesamewhethermappedornot,
thereisnoneedtoincludealineconvertingit,as
follows:
20H=20H

Thesourcecharacter,orrangeofcharacters,isgivenon
theleftoftheequalssign

20H=
6A6D=

Thisisthecharacterthatyouwanttomapfrom
Thetargetcharacterisgivenontherightoftheequals
sign

=20H

Thisisthecharacterthatyouwanttomapto
Sourcecharactersmustbewithinthedefinedrange

ForInternationalandArabiccharactersets,20Hto
7FH

Outofrangecharactersareignored
Foruserdefinedcharactersets,20HtoFFH
Targetcharactersmustbewithinthedefinedrange

20HtoFFH

Outofrangecharactersareignored
Anylinestartingwitha/isacomment

/MappingfileforInternationalcharacterset1

Textwithinsquarebracketsidentifiesasection

[International1]

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B-9

Character Sets
Mapping Files
Convention

Example

Themappingfilewillhavesectionsforeachcharacterset
inbothArabicandInternationalcharactertypes,plus
anysectionsforuserdefinedfonts.
AlinestartingwithCP=issettingthedefaultcodepage

CP=437

Alinewithaa=bbconvertscharacter0xaato0xbbusing
thedefaultcodepage

60=9C

Alinewithaa=bb,cccconvertscharacter0xaato
character0xbbusingcodepageccc

65=83,737

Alinewithaa1aa2=bbconvertstherangeofcharacters
0xaa1to0xaa2tothecharacter0xbbusingthedefault
codepage

6062=9D

Alinewithaa1aa2=bb,cccconvertstherangeof
characters0xaa1to0xaa2tothecharacter0xbbusing
codepageccc

6A6D=8F,852

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

B-10

APTRA Advance NDC, Reference Manual

Character Sets
Mapping Files
Figure B-2
Example Mapping File

/Mapping file for the international character set 1

[International]
CP=437
60=9C
61=92
62=9B
63=8F
64=8E
65=83,737
.
.
.
6A=8F,852
6C=99,852
6D=D3,852
6E=D3,850
6F=90,852
.
.
.
7F=72
/MappingfilefortheuserdefinedcharactersetR
[UserR]
60=9D
61=88
62=94
63=91
64=82
.
.
.
7F=9E

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

B-11

Character Sets
Font ID Mapping Table

FontIDMappingTable

Thefollowingtablemapscharactersets,includingISO8859
charactersets29,tothefontIDssupportedbyAPTRAAdvance
NDC.
Table B-4
Font ID Mapping Table

Font Size

Font ID
(decimal value)

Lucida Console
Latin1(WestEuropean)

Single

`(96)

Double

a(97)

Lucida Console
Latin1(WestEuropean)

Single

b(98)

Double

c(99)

ISO 8859-2
Latin2(CentralEuropean)

Single

d(100)

Double

e(101)

ISO 8859-3
Latin3(SouthEuropean)

Single

f(102)

Double

g(103)

ISO 8859-4
Latin4(NorthEuropean)

Single

h(104)

Double

i(105)

ISO 8859-5
Latin/Cyrillic

Single

j(106)

Double

k(107)

ISO 8859-6
Latin/Arabic

Single

l(108)

Double

m(109)

ISO 8859-7
Latin/Greek

Single

n(110)

Double

o(111)

ISO 8859-8
Latin/Hebrew

Single

p(112)

Double

q(113)

ISO 8859-9
Latin5(Turkish)

Single

r(114)

Double

s(115)

NDC Alphanumeric 1

Single

t(116)

Double

u(117)

Character Set/Type face

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

B-12

APTRA Advance NDC, Reference Manual

Table of Contents
Cardholder Screen Graphics

Appendix C

CardholderScreenGraphics
Overview

C1

CardholderExampleGraphics
InsertCard(g00.png)
PressKey(g01.png)
MakeaDeposit(g03.png)
TakeReceipt(g04.png)
TakeCash(g05.png)
TakeStatement(g06.png)
ScanBarcode(g10.png)

C2
C3
C4
C5
C6
C7
C8
C9

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Cardholder Screen Graphics

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Cardholder Screen Graphics


Overview

Overview

TwosetsofcardholderscreengraphicsareprovidedwithAdvance
NDC:fileswithnamesintheformatofg<nn>.pngandthesamefiles
withnamesintheformatofPIC0<nn>.png.Thevariablenn
representsanumberintherange01to10.
Thisappendixliststheexamplecardholderscreengraphicsforthe
g<nn>.pngsetofgraphics.
Note:Thesegraphicsareprovidedasexamplesonly;youwill
probablyneedtoreplaceoramendthemasrequired.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

C-1

Cardholder Screen Graphics


Cardholder Example Graphics

CardholderExampleGraphics

AlltheexamplesofcardholdergraphicsusedbyAdvanceNDCare
locatedasfollows:

OnthedevelopmentPCin
<installdrive:>\<global>\final\xfs\dll
<installdrive:>\<global>\test\xfs\dll
OntheSSTin
C:\ProgramFiles\NCRAPTRA\AdvanceNDC\Media

Thefollowingcardholdergraphicfiles(*.png)areprovidedwith
AdvanceNDCandshowninthisappendix:

InsertCard(ScreenG00)
PressKey(ScreenG01)
MakeaDeposit(ScreenG03)
TakeReceipt(ScreenG04)
TakeCash(ScreenG05)
TakeStatement(ScreenG06)
ScanBarcode(ScreenG10).

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

C-2

APTRA Advance NDC, Reference Manual

Cardholder Screen Graphics


Cardholder Example Graphics

InsertCard(g00.png)

Figure C-1
Insert Card (g00.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

C-3

Cardholder Screen Graphics


Cardholder Example Graphics

PressKey(g01.png)

Figure C-2
Press Key (g01.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

C-4

APTRA Advance NDC, Reference Manual

Cardholder Screen Graphics


Cardholder Example Graphics

MakeaDeposit(g03.png)

Figure C-3
Make a Deposit (g03.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

C-5

Cardholder Screen Graphics


Cardholder Example Graphics

TakeReceipt(g04.png)

Figure C-4
Take Receipt (g04.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

C-6

APTRA Advance NDC, Reference Manual

Cardholder Screen Graphics


Cardholder Example Graphics

TakeCash(g05.png)

Figure C-5
Take Cash (g05.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

C-7

Cardholder Screen Graphics


Cardholder Example Graphics

TakeStatement(g06.png)

Figure C-6
Take Statement (g06.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

C-8

APTRA Advance NDC, Reference Manual

Cardholder Screen Graphics


Cardholder Example Graphics

ScanBarcode(g10.png)

Figure C-7
Scan Barcode (g10.png)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

C-9

Cardholder Screen Graphics


Cardholder Example Graphics

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

C-10

APTRA Advance NDC, Reference Manual

Table of Contents
Quick Reference to Message Types

Appendix D

QuickReferencetoMessageTypes
Overview

QuickReferencetoMessageTypes
TransactionRequest
UnsolicitedStatusMessages
SolicitedStatusMessages
EncryptorInitialisationData
UploadEJDataMessage
TerminalCommands
CustomisationDataCommands
TransactionReply
AcknowledgeEJUploadBlockCommand
AcknowledgeandStopEJCommand
EJOptionsandTimersCommand

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D1

D2
D3
D7
D8
D9
D9
D10
D12
D14
D20
D20
D20

Table of Contents
Quick Reference to Message Types

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Overview

Overview

ThisappendixisforprogrammersdesigningtheCentralcontrol
application.Itprovidesaquickreferencetothetypesofmessage
sentbetweenCentralandtheterminal.Foreachmessagetype,the
messageclassandsubclassareshown,andeachfieldwithinthe
message.Thiswillhelpyoutoquicklyidentifythemessagesthat
passtoandfromCentral.
Thisappendixdoesnotincludeinformationonthe
protocoldependentheadersandtrailers.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-1

Quick Reference to Message Types


Quick Reference to Message Types

QuickReferencetoMessageTypes
Table D-1
Quick Reference to Message Types
Message
Class

Message
Sub-Class

000

~~~

000

LUNO

Message

Destination

...

TransactionRequest

Central

~~

...

UnsolicitedStatus

Central

000

~~

...

SolicitedStatus

Central

000

~~

...

EncryptorInitialisationData

Central

~~

...

TMAlert
NotsupportedbyAdvanceNDC

Central

~~

...

UploadEJData

Central

~~

...

TerminalCommands

Terminal

1or3

~~

...

CustomisationDataCommands

Terminal

~~

...

InteractiveTransactionResponse

Terminal

~~

...

ExtendedEncryptionKeyChange

Terminal

000

...

TransactionReply

Terminal

~~

...

TMAlert
NotsupportedbyAdvanceNDC

Terminal

...

AcknowledgeEJUploadBlock

Terminal

...

AcknowledgeandStopEJ

Terminal

...

EJOptionsandTimers

Terminal

~ fieldseparator
... fields(eachfieldisidentifiedinthefollowingpages)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-2

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types

TransactionRequest
Table D-2
Transaction Request Message Format

Transaction Request

11~000~~~...

Field

Description

Length

Topofreceipttransactionflag:

0willnotprintdataatthetopofreceipt
1willprintdataatthetopofreceipt
g

Messagecoordinationnumber

FS

Fieldseparator

Track2data

Var(39)

FS

Fieldseparator

Track3data

Var(106)

FS

Fieldseparator

Operationcodedata

FS

Fieldseparator

Amountentered

8or12

FS

Fieldseparator

PINbufferA

Var(32)

FS

Fieldseparator

GeneralpurposebufferB.
Minimumdatalengthis3digits.

Var(32)

FS

Fieldseparator

GeneralpurposebufferC

Var(32)

FS

Fieldseparator

Track1identifier

Track1data

Var(78)

FS

Fieldseparator

Transactionstatusdataidentifier

Lasttransactionstatusdata

Var(65)

FS

Fieldseparator

av1

CSPDataIDU

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-3

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Request

11~000~~~...

Field

Description

Length

av2

CSPData

Var(16)

FS

Fieldseparator

aw1

ConfirmationCSPDataIDV

aw2

ConfirmationCSPData

Var(16)

FS

Fieldseparator

ax1

VCdataIDW

ax2

VCdata

FS

Fieldseparator

ay1

VCdataIDX

ay2

VCdata

FS

Fieldseparator

az1

VCdataIDY

az2

VCdata

FS

Fieldseparator

ba1

VCdataIDZ

ba2

VCdata

FS

Fieldseparator

bb1

VCdataID[

bb2

VCdataID

FS

Fieldseparator

bc1

VCdataID\

bc2

VCdata

FS

Fieldseparator

bd1

SmartCarddataID5(EMV/CAM2)

bd2

SmartCarddata

FS

Fieldseparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-4

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Request

11~000~~~...

Field

Description

Length

ca1

DeviceIDwforBNA/GBRU

ca2*

NoteTypeinhex(0132);upto50types

ca3**

Numberofnotesinescrowforca2

2or3

*ca2andca3mayberepeatedforupto50
**thelengthdependsonoption45configuration.
FS

Fieldseparator

cb1

SingleChequeDepositDataIDa

cb2

MagneticInkCodeRecognition(MICR)
/CodeLinedetected

cb3

MICR/CodeLinevalue

Var(256)

ce1

FieldIDeshowsthatbarcodedatais
beingreported

ce2

BarcodeFormatidentifiergiveninASCII
hex.Ifnotknownfieldissetto0

ce4

Scannedbarcodedata

Var

cf1*

Fieldidf.Thevaluefinthisfieldshows
thatmorethanfourcoinhoppertypesare
beingreported.

*Note:Thecffieldsareonlypresentwhenbuffer
fisusedbecausemorethanfourhoppertypesare
configured.Otherwise,countsareshowninfield
r
cf2

Numberofcoinsdispensedfromhopper
type1

cf3

Numberofcoinsdispensedfromhopper
type2

cf4

Numberofcoinsdispensedfromhopper
type3

:
ThefieldisrepeatedforeachhoppertypespecifiedintheTransaction
Replymessage
:
cf<n
+1>

Numberofcoinsdispensedfromhopper
typen

FS

Fieldseparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-5

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Request

11~000~~~...

Field

Description

Length

cg1

FieldIDgforabunchchequedeposit

cg2

TotalChequestoReturn

cg3

Mustbe0000

cg4

DepositCurrency

cg5

AmountExponentSign

cg6

AmountExponentValue

cg7

TotalCustomerAmount

12

cg8

TotalDerivedAmount

12

cg9

Mustbe0000

cg10

ChequeIdentifier

cg11

CustomerChequeAmount

12

cg12

DerivedChequeAmount

12

cg13

CodelineLength

cg14

CodelineData

var

cg15

Groupseparator

cg16

Groupseparator

FS

FieldSeparator

ci1

DataID<VoiceGuidance

ci2

VoiceGuidanceLanguageIdentifier

GS

Groupseparator

Fieldseparator

Dataidentifier

Data

Var

FS

Fieldseparator

MessageAuthenticationCodedata

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-6

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types

UnsolicitedStatus
Messages
Table D-3
Unsolicited Status Message Format

Unsolicited Status Messages

12~000~~(e1)...

Field

Description

Length

e1

Statusidentifier

ATimeofdayclock
BPowerfailure
DCardreader/writer
ECashhandler
FDepository
GReceiptprinter
HJournalprinter
HElectronicjournalprinter
KNightsafedepository
LEncryptor
MCamera
NDooraccess(notsupported)
PSensors
QTouchscreenkeyboard
RSupervisorkeys
VStatementprinter
wBunchNoteAcceptor(BNA)
YCoindispenser
\Envelopedispenser
qChequeprocessor

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-7

Quick Reference to Message Types


Quick Reference to Message Types

SolicitedStatusMessages
Table D-4
Solicited Status Message Fields

Table D-5
Solicited Status Message Field Values

Solicited Status Messages

22~000~~f~(g1)...

Field

Description

Length

Statusdescriptor

Statusinformation

g1

Description

Devicefault

Cardreader/writer

Cashhandler

Depository

Nightsafedepository

Statementprinter

BunchNoteAcceptor(BNA)

Coindispenser

Envelopedispenser

Chequeprocessor

Ready

Commandreject

Ready(transactionreply)

Specificcommandreject
1

MACfailure

Timevariantnumberfailure

Securityterminalnumbermismatch

Messageformaterror

Fieldvalueerror

Illegalmessagetype

Hardwarefailure

Notsupported

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-8

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types

EncryptorInitialisation
Data

g1

Description

Terminalstate
1

Sendconfigurationinformation

Sendsupplycounters

Sendtallyinformation

Senderrorloginformation

Senddate/timeinformation

SendconfigurationID

EKCretrievehallmarkkey(unsupported)

Hardwareconfigurationdata

Suppliesdata

Fitnessdata

Tamperandsensorstatusdata

SoftwareIDandreleasenumberdata

Localconfigurationoptiondigits

Table D-6
Encryptor Initialisation Data

Encryptor Initialisation Data

UploadEJDataMessage
Table D-7
Upload EJ Data Message

Field

Description

Length

InformationIdentifier

EncryptorInformation

Var

Upload EJ Data Message

61~~~~d

Field

Description

Length

MachineNumber

Date

Time

LastCharacterPreviousBlock

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-9

Quick Reference to Message Types


Quick Reference to Message Types

TerminalCommands
Table D-8
Terminal Command Fields

Table D-9
Field Values for Terminal Commands

Upload EJ Data Message

61~~~~d

Field

Description

Length

LastCharacterThisBlock

BlockLength

ResponseData

Var(1to
350)

Terminal Commands

1~~~fg

Field

Description

Length

Commandcode

Commandmodifier

Description

Goinservice

Gooutofservice
0

Standardoutofservicescreendisplayed

Temporaryoutofservicescreendisplayed

SendconfigurationID

Sendsupplycounters
None

Sendbasicsupplycountersmessage

Sendbasicsupplycountersmessage

Sendextendedsupplycountersmessage

Sendtallyinformation
A

Processorandsystem

Communications

Systemdisk

Cardreader/writer

Cashhandler

Depository

Receiptprinter

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-10

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types
f

Description

Journalprinter

Reserved

Reserved

Nightsafe

Encryptor

Camera

Dooraccess(notsupported)

Offlinedisk

Statementprinter

Coindispenser

Envelopedispenser

Senderrorloginformation
A

Processorandsystem

Communications

SSTdevices

Sendconfigurationinformation
0

Sendconfigurationinformation

Sendhardwareinformationonly

Sendsuppliesdataonly

Sendfitnessdataonly

Sendtamperandsensorstatusdataonly

SendsoftwareIDandreleasenumberdataonly

Sendenhancedconfigurationdata

Sendlocalconfigurationoptiondigits

SendBNAnotedefinitions

Senddateandtimeinformation

Reserved

Reserved

Reserved

EKCretrievehallmarkkey(notsupported)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-11

Quick Reference to Message Types


Quick Reference to Message Types

CustomisationData
Commands
Table D-10
Customisation Data Command Fields

Table D-11
Field Values for Data Commands

Description

<

Reserved

>

EnableFREEJDATA

Enableimagedumping(notsupported)
0

DonotallowaccesstoDumpImages

AllowaccesstoDumpImages

Customisation Data Commands

3~~~fg

Field

Description

Length

Messagesubclass

Messageidentifier

Description

Customisationdata
1

Screenand/orkeyboarddataload

Statetablesload

Configurationparametersload

Reserved

FITdataload

ConfigurationIDnumberload

Enhancedconfigurationparametersload

MACfieldselectionload

Dateandtimeload

Reserved

Dispensercurrencycassettemappingtable

InitialiseEKC(notsupported)

Overridereservedscreenscommand

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-12

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types
f

Interactivetransactionresponse

Description

Donotdisplaycardholderkeyboardentry

Displaycardholderkeyboardentry

Display*forcardholderkeyboardentry

Encryptionkeychange
1

Deciphernewmasterkeywithcurrentmasterkey

Deciphernewcommunicationskeywithcurrent
masterkey

Deciphernewcommunicationskeywithcurrent
communicationskey

Uselocallyenteredcommunicationskey(Bkey)as
currentMACkey

DeciphernewMACkeywithcurrentmasterkey

DeciphernewMACkeywithcurrent
communicationskey

Uselocallyenteredcommunicationskey(Bkey)as
currentMACkey

DeciphernewVISAmasterkeywithcurrentVISA
masterkey

KeydataisnewVISAkeytable

Extendedencryptionkeychange
1

Deciphernewmasterkeywithcurrentmasterkey

Deciphernewcommunicationskeywithcurrent
masterkey

Deciphernewcommunicationskeywithcurrent
communicationskey

Uselocallyenteredcommunicationskey(Bkey)as
currentMACkey

DeciphernewMACkeywithcurrentmasterkey

DeciphernewMACkeywithcurrent
communicationskey

Uselocallyenteredcommunicationskey(Bkey)as
currentMACkey

DeciphernewVISAmasterkeywithcurrentVISA
masterkey

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-13

Quick Reference to Message Types


Quick Reference to Message Types
f

TransactionReply
Table D-12
Transaction Reply

Description

KeydataisnewVISAkeytable

DeciphernewVISAmasterkeywithcurrentmaster
key

LoadHostSecurityModule(HSM)publickeyand
signature

Loadinitialmasterkey(Akey)withRSAkey

Loadnewinitialcommunicationskey(Bkey)with
RSAkey

LoadnewinitialVISAmasterkey(Vkey)withRSA
key

SendEncryptingPINPad(EPP)serialnumber

SendEPPpublickey

SendallKeyVerificationValues(KVVs)

Reserved

Setkeyentrymode

Sendcurrentkeyentrymode

SendrandomATMnumber

Sendencryptorcapabilitiesandstate

LoadNCRSubpublickeyandsignature

DeleteHSMpublickey

DeleteNCRSubpublickey

SendEPPattributes

SendvariablelengthEPPserialnumber

Transaction Reply

4~000~...

Field

Description

Length

Messagesequencenumber

3or8

FS

Fieldseparator

Nextstateidentifier

FS

Fieldseparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-14

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Reply

4~000~...

Field

Description

Length

g1

Numberoftype1notestodispense

g2

Numberoftype2notestodispense

g3

Numberoftype3notestodispense

g4

Numberoftype4notestodispense

g5

Numberoftype5notestodispense

g6

Numberoftype6notestodispense

g7

Numberoftype7notestodispense

GS

Groupseparator

j1

Numberofhopper1coinstodispense

j2

Numberofhopper2coinstodispense

j3

Numberofhopper3coinstodispense

j4

Numberofhopper4coinstodispense

j5

Numberofhopper5coinstodispense

...
jn

Numberofhopperncoinstodispense

FS

Fieldseparator

Transactionserialnumber

Functionidentifier:

1Depositandprint
2Dispenseandprint
3Displayandprint
4Printimmediate
5Setnextstateandprint
6Nightsafedepositandprint
7Depositandprint
8Dispenseandprint
9Displayandprint
AEjectcard,dispenseandprint
BParalleldispense,printandcardeject

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-15

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Reply

4~000~...

Field

Length

Description

CParalleldispense,printandcardeject
EReserved
FCardbeforeparalleldispenseandprint
OReserved
PPrintstatementandwait
QPrintstatementandsetnextstate
RReserved
SProcessdocumentwithcash(not
supported)
TDPMdepositenvelope(notsupported)
*Refundnotesandprint
Depositnotesandprint
Depositnotesandwait
:Processcheque
bDispensenotesthendispensecoinsand
processchequeinparallel
cProcessmultiplecheques
m

Screennumber

Screendisplayupdate

Var

FS

FieldSeparator

Messagecoordinationnumber

Cardreturn/retainflag:

0ReturncardduringClosestate
1RetaincardduringClosestate
q

Printerflag:
0Donotprint
1Printonjournalonly
2Printonreceiptonly
3Printonreceiptandjournal
4PrintonPPDifFunctionIDis1or7

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-16

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Reply

4~000~...

Field

Length

Description

5PrintonPPDandjournalifFunctionID
is1or7
8Printonstatementonly
9Reserved
:Reserved
=Sidewaysprintingonreceiptif
FunctionIDisPorQ
>orwIdentifiesaudiodatafora
voiceguidedsession
aStampcheque,withoutprinterdata,if
theFunctionIDis:(Processcheque).
bEndorsecheque,withprinterdata,if
theFunctionIDis:(Processcheque)
r

Printerdata

Var(500)

GS

Groupseparator

Printerflag

Printerdata

Var(500)

GS

Groupseparator

Printerflag

Printerdata

Var(500)

GS

Groupseparator

v1

Printerflag

v2

Printerdata

Var(500)

:
GS,v1andv2mayberepeateduptonine
furthertimes
:
FS

Fieldseparator

Bufferidentifier

Track3data

Var(106)

FS

Fieldseparator

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-17

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Reply

4~000~...

Field

Description

Length

ak1

BufferidentifierK

ak2

Track1Data

Var(78)

FS

FieldSeparator

al1

BufferidentifierL

al2

Track2Data

Var(39)

FS

FieldSeparator

am1

VCdataIDM.

am2

VCdata

Var

FS

FieldSeparator

an1

VCdataIDN.

an2

VCdata

Var

FS

FieldSeparator

ao1

VCdataIDO.

Var

ao2

VCdata

Var

FS

FieldSeparator

ap1

VCdataIDP.

ap2

VCdata

Var

FS

FieldSeparator

aq1

VCdataIDQ.

aq2

VCdata

Var

FS

FieldSeparator

ar1

VCdataIDR.

ar2

VCdata

Var

FS

FieldSeparator

as1

BufferidentifierS

as2

Cashhandlernumber(0or1)

as3

1stcassettetypeinspecifiedcashhandler

as4

Numberofbillstodispensefrom1sttype

as5

2ndcassettetypeinspecifiedcashhandler

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-18

APTRA Advance NDC, Reference Manual

Quick Reference to Message Types


Quick Reference to Message Types
Transaction Reply

4~000~...

Field

Description

Length

as6

Numberofbillstodispensefrom2ndtype

as7

3rdcassettetypeinspecifiedcashhandler

as8

Numberofbillstodispensefrom3rdtype

as9

4thcassettetypeinspecifiedcashhandler

as10

Numberofbillstodispensefrom4thtype

as(n)

Lastcassettetypeinspecifiedcashhandler

as(n
+1)

Numberofbillstodispensefromlasttype

FS

FieldSeparator

at1

SmartcarddataID5

at2

Smartcarddata

FS

FieldSeparator

ba1

Cheque(s)destinationdataIDa

ba2

Cheque(s)destinationdata

...

1Depositcheque(s)intopocket1
2Depositcheque(s)intopocket2
3Depositcheque(s)intopocket3
4to9Depositcheque(s)intopocket4to9
(notsupported)
atofDepositcheque(s)intopocket10to
15(notsupported)
EEjectthecheque(s)
FS

FieldSeparator

bb1

BufferidentifierB

bb2

Chequeidentifier

bb3

Chequedestination

bb4

Chequestamp

bb5

Reserved

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

D-19

Quick Reference to Message Types


Quick Reference to Message Types

AcknowledgeEJUpload
BlockCommand

Table D-15
EJ Options and Timers Command

Field

Description

Length

bb6

Chequeendorsetext

Var

FS

FieldSeparator

MACdata

Acknowledge EJ Upload Block command

6~~~1d.

Field

Description

Length

LastCharacterReceived

Table D-14
Acknowledge and Stop EJ Command

EJOptionsandTimers
Command

4~000~...

Table D-13
Acknowledge EJ Upload Block Command

AcknowledgeandStopEJ
Command

Transaction Reply

Acknowledge and Stop EJ command

6~~~2d.

Field

Description

Length

LastCharacterReceived

EJ Options and Timers command

6~~~3d.

Field

Description

Length

OptionNumber

OptionValue

TimerNumber

TimerValue

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

D-20

APTRA Advance NDC, Reference Manual

Table of Contents
Device Identifiers

Appendix E

DeviceIdentifiers
Overview

E1

HardwareConfigurationData

E2

SuppliesData
CashAcceptorSupplies(DIGw)
DoNotUseExtendedMessageFormat(Bit3=0)
UseExtendedMessageFormat(Bit3=1)
NoChangeReporting

E11
E16
E16
E17
E18

FitnessData
CashAcceptorFitness(DIGw)

E19
E23

TamperData

E25

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Device Identifiers

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Device Identifiers
Overview

Overview

DeviceidentifiersaregenerallyknownasDIGs(deviceidentifier
graphics).TheyarereturnedintheStatusInformationfieldof
solicitedorunsoliciteddevicestatusmessagesandindicatethe
devicetowhichthefollowingdatainthemessageapplies.
ThetablesinthisappendixshowwhichSSTdevicetheDIGsrelate
to,thevaluestheycantakeandthedataaccompanyingthem.
FormoreinformationabouttheStatusInformationfield,seethe
followingsectionsinChapter 9,TerminaltoCentralMessages:

Forsolicitedstatusinformation,seeDeviceFaultStatus
InformationFieldonpage 970
UnsolicitedStatusInformationFieldonpage 982

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-1

Device Identifiers
Hardware Configuration Data

HardwareConfigurationData

Thefollowingtablesummarisesthehardwareconfigurationdata
associatedwitheachdevice.
Note:AlthoughthePassbookPrinterisnotsupportedinAdvance
NDC,theapplicationcanbeenhancedorextendedforit.
Table E-1
Device Hardware Configuration Data
DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

41

TimeofDayClock

Data Length

ThisDIGisneverreturnedintheconfigurationfield
B

42

Communications
ThisDIGisneverreturnedintheconfigurationfield

43

SystemDisk
00
01
02

44

var(2)
Harddiskdrivepresent
Reserved
Reserved

MagneticCardReader/Writer
00
01
03
05
07
08
09
0A
0B
0C
10
11
1D
1E
1F
20

Nocardreaderattached
Track2(readonly)
Track1/2/3MCRW(writeontrack3only)
(Alsoreturnedifcardreadercannotbeidentified)
PCDipReader
3TrackWriteMCRW
Track2SmartCardReader
Track1/2/3SmartCardReader
3TrackWriteSmartCardReader
Track1/2andTrack2/3DipMSR
Track1/2/3CIM86MCRW
Track1/2DipMSR
Track1/2SwipeReader
DASHReader
Track1/2/3withMM
Track1/2/3SmartwithMM
Track3SmartwithMM

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-2

APTRA Advance NDC, Reference Manual

var(2)

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

45

CashHandler

var(2)

00
01
02
03
04

Notconfigured
Stackingcashhandler
Spraydispenser
Stackingcashhandlerwithrecyclecapabilities.On
NCRSSTs,thisisknownastheGBRU
Stackingcashhandlercapableofrecyclingbutthe
recyclecapabilitiesaredisabled.OnNCRSSTs,thisis
knownastheGBRU.

SeeTable
Note4

Note1:Whetherrecyclingisenabledordisabled,the
MStatusvaluesreportedindevicestatusmessagesfor
theGBRUarecompatiblewiththeGBXXfamily.
Note2:Foradualdispensersystem,whatisreported
hereisthesameasDIGdtheprimarydispenser
Ifextendedcassettesaresupported,thefollowingisalsoreported:
MaximumItemsDispense
040070
F

46

47

Thetotalnumberofnotesthatcanbedispensedfora
transaction.

EnvelopeDepository
00
01
02
03
04

var(2)

Notconfigured
Reserved
Programmableprintingdepository
Reserved
Reserved

ReceiptPrinter
00
01
02
03
04
05
06
07
08

var(3)

var(2)

Notconfigured
Plainpaper
Blackdotpaper
Sidewaysprinting,noblackmark
Sidewaysprinting,blackmark
Thermalprinternoblackmark
Thermalprinterblackmark
Thermalprintersidewaysprinting,noblackmark
Thermalprintersidewaysprinting,blackmark

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-3

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

48

JournalPrinter

var(2)

Notconfigured
Integraljournalprinter
Reserved
Thermalprinter
Electronicjournal
Electronicjournalandintegraljournalprinter
Reserved
Electronicjournalandthermalprinter
Reserved

00
01
02
03
80
81
82
83
99
I

49

Reserved
ThisDIGisneverreturnedintheconfigurationfield

4A

Reserved
ThisDIGisneverreturnedintheconfigurationfield

4B

NightSafeDepository
00
01
02

4C

4D

Notconfigured
Configured
Reserved

Encryptor
?0
?1
02
03
04
05
06
?7

var(2)
Notconfigured
BAPEencryptor.
Reserved
Reserved
Reserved
Reserved
Reserved
EPPencryptor
?=SSTkeyentrymode(0,B,CorD)where:
0=singlelengthkeyswithoutXORkeyentry
B=singlelengthkeysusingXORkeyentry
C=doublelengthkeys
D=doublelengthkeys,restrictedmode
Forexample,C7=doublelengthkeyentrywithanEPPencryptor.

SecurityCamera
00
01
02
03
04

Notconfigured
Fixedformat
Variableformat
Reserved
Digital

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-4

var(2)

APTRA Advance NDC, Reference Manual

var(2)

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

4E

DoorAccessSystem(notsupported)

var(2)

00
O

4F

Notconfigured

OffLineFlexDisk
00
01
02

50

var(2)

Notconfigured
1.44MBflexdiskdrive
2.88MBflexdiskdrive

TIBins(Alarms)

var(2)

NoTIBinspresent
Securecash,insecurecards,andeitherinsecuredepositbinorno
depository
Securecash,insecurecards,andsecuredepositbin
Securecash,securecards,andeithersecuredepositbinorno
depository.

00
01
02
03

Note:Todetermineifasecuredepositbinisfitted,youneedtocheckDIGFforaPPDdepository(02).
Q

51

CardholderKeyboard
00
01
02

52

Reserved
Standard(BAPE)keyboard
EPPkeyboard

OperatorKeyboard
00
01
02

53

54

var(2)

Notconfigured
Standardkeyboard(basic)
KeyboardplusFDKs(enhanced)

CardholderDisplay

var(2)

Alwayszero
Alwayszero
0novoice
1voicesupportedifdigitalaudiopresent
0standardFDKs
1touchscreen
0(reservedalwayszero)

BIT0
BIT1
BIT2
BIT2
BIT3
BIT3
BITs47
T

var(2)

Reserved
ThisDIGisneverreturnedintheconfigurationfield

55

Reserved
ThisDIGisneverreturnedintheconfigurationfield

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-5

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

56

StatementPrinter

var(2)

Notconfigured
Configured
Reserved
Reserved
Reserved
Reserved
Enhancedthermalstatementprinter(SDC+)

00
01
02
03
04
05
09
W

57

Reserved
ThisDIGisneverreturnedintheconfigurationfield

58

Passbook
(notsupported)
BIT0
BIT1
BIT2
BIT3
BIT4
BIT5
BITs616

59

5A

5B

1=Passbookprinterpresent
1=Passbookprintercanreadmagneticstripe
1=Passbookprintercanwritemagneticstripe
1=Passbookprintercanreadpagenumber
1=Passbookprintercanscanfornextblankline
1=Passbookprintercanturnpages
Reserved

CoinDispenser
Byte

Description

12

00Notconfigured
01Reserved
02Coindispenserwithuptofourhoppertypes
03Coindispenserwithmorethanfourhoppertypes

Byte

Description

34

Numberofhoppertypes.Thisisatwodigitdecimal
number.

57

Totalnumberofcoinsthatcanbedispensedper
transaction.Thisisathreedigitdecimalnumber.

SystemDisplay
00
01
02

Notconfigured
Configured

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-6

var(7)

SeeTable
Note1

var(2)

Notconfigured
Reserved
Configured(16x32)

MediaEntryIndicators
00
01

var(4)

APTRA Advance NDC, Reference Manual

var(2)

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

5C

EnvelopeDispenser

var(2)

00
01
02
03
a

61

VoiceGuidance
00
01
02

64

Notconfigured
Configured
Reserved
Reserved

Notpresent
AudiopresentorStandardaudiopresent
Enhancedaudio

CashHandler0
00
01
02
03
04

var(2)

var(5)

Notconfigured
Stackingcashhandler
Spraydispenser
Stackingcashhandlerwithrecyclecapabilities.On
NCRSSTs,thisisknownastheGBRU
Stackingcashhandlercapableofrecyclingbutthe
recyclecapabilitiesaredisabled.OnNCRSSTs,thisis
knownastheGBRU.
Note:Whetherrecyclingisenabledordisabled,the
MStatusvaluesreportedindevicestatusmessagesfor
theGBRUarecompatiblewiththeGBXXfamily.

MaximumItemsDispense
040070

Thetotalnumberofnotesthatcanbedispensedfora
transaction.

ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.
e

65

CashHandler1
00
01
02
03
04

var(5)

Notconfigured
Stackingcashhandler
Spraydispenser
Stackingcashhandlerwithrecyclecapabilities.On
NCRSSTs,thisisknownastheGBRU
Stackingcashhandlercapableofrecyclingbutthe
recyclecapabilitiesaredisabled.OnNCRSSTs,thisis
knownastheGBRU.
Note:Whetherrecyclingisenabledordisabled,the
MStatusvaluesreportedindevicestatusmessagesfor
theGBRUarecompatiblewiththeGBXXfamily.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-7

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

MaximumItemsDispense
040070

Thetotalnumberofnotesthatcanbedispensedfora
transaction.

ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.
f

66

BarcodeReader
0001

71

Barcodereaderconfigured

ChequeProcessor
Configurationdatalengthvar(4)isanASCIIrepresentationofa
hexadecimalnumber.
0000
00xx

Notconfigured
Configured

WhenOption83is000thefollowingisreturned:
Bit0=1
Bit1=1
Bit2=0
Bit3=1
Bit4=1
Bits5to6
Bits7to15

MICRreaderissupported
Rearprinterissupported
Iscurrentlyreservedandisalways0
Frontscannerissupported
Rearscannerissupported
Numberofbins(13),withbit5aslowbit.
Reservedandarealways0

Forexample,006BindicatesCPMconfiguredwithMICRreader,
rearprinter,frontscannerandthreebins.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-8

var(4)

APTRA Advance NDC, Reference Manual

var(4)

Device Identifiers
Hardware Configuration Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data (Continued)

Data Length

WhenOption83is001thefollowingisreturned:
Bit0=1
Bit1=1
Bit2=1
Bit3=1
Bit4=1
Bits5to8
Bit9=1
Bit10=1

Bit11=1

Bit12=1
Bit13=1
Bit14=1
Bit15

MICRreaderissupported
Rearprinterissupported
Chequestamperissupported
Frontscannerissupported
Rearscannerissupported
Containsthenumberofbins.Bit8isthehighbitand
bit5isthelowbit
Deviceisabunchchequeacceptor(ifnotset,deviceis
aCPM)
Deviceisabunchchequeacceptorthatcanalsoaccept
cash.Eithercashorchequescanbeacceptedinasingle
transaction,butnotboth
Deviceisabunchchequeacceptorthatcanalsoaccept
cash.Cashandchequescanbeacceptedtogetheras
partofasingletransaction(notsupported)
OCRcodelinereadissupported
MICRreadersupportsE13B
MICRreadersupportsCMC7
Reserved

SeeTable
Note2
andTable
Note3

Forexample,20ABindicatesCPMconfiguredwithE13BMICR
readerwith5bins,frontscannerandrearprinter.
w

77

NoteAcceptor

var(2)

00
03
04

SeeTable
Note4

Notconfigured
BunchNoteAcceptor
BunchNoteAcceptorwithrecyclecapabilities.For
NCRSSTs,thisisknownastheGBRU.TheMStatus
valuesreportedindevicestatusmessagesare
compatiblewiththeGBXXfamilyofdevices

05

BunchNoteAcceptorreportingMStatusvalues
compatiblewiththeGBXXfamilyofdevices.ForNCR
SSTsthisisknownastheGBNA;itcanalsobe
reportedwhenaGBRUispresentwithrecycling
disabled.

06

BunchNoteAcceptorthatcanalsoacceptcheques.
Eithercashorchequescanbeacceptedinasingle
transactionbutnotboth.TheNCRSDMcanbe
configuredasthistypeofdevice.

07

Deviceisabunchchequeacceptorthatcanalsoaccept
cash.Cashandchequescanbeacceptedtogetheras
partofasingletransaction(notsupported)
Singlenoteacceptor

08

SeeTable
Note2

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-9

Device Identifiers
Hardware Configuration Data

TableNote1:IfOption79issetto000,onlythefirsttwobytesare
reported.IfOption79issetto00,1allsevenbytesarereported.
TableNote2:YoucanconfigureanNCRscalabledepositmodule
(SDM)asachequeprocessorthatcanacceptcashandchequesoras
acashacceptorthatcanaccepteithercashorchequesbutnotbothin
asingletransaction.
TableNote3:Bits10and11aremutuallyexclusive.
TableNote4:Forarecyclingunit,thecashhandlervariantis
reportedas03andthecashacceptorvariantisreportedas04onlyif
recyclingmodeisenabled.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-10

APTRA Advance NDC, Reference Manual

Device Identifiers
Supplies Data

SuppliesData

Thefollowingtablesummarisesthesuppliesdataassociatedwith
eachdevice.
Note:Forthe40columnjournalprinter,onlythreevalues(paper,
ribbonandprinthead)arereturnedinasuppliesresponse,unlike
unsolicitedstatusmessages,whichalwaysincludeavalueofOKfor
theknife.
Table E-2
Device Supplies Data
DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

41

TimeofDayClock

Data Length

ThisDIGisneverreturnedinthesuppliesfield
B

42

Communications
ThisDIGisneverreturnedinthesuppliesfield

43

SystemDisk
ThisDIGisneverreturnedinthesuppliesfield

44

45

MagneticCardReader/Writer

var(1)

Cardcapturebin

CashHandler

var(5)

Cashhandlerrejectbin
Cashhandlercassettetype1
Cashhandlercassettetype2
Cashhandlercassettetype3
Cashhandlercassettetype4

1
1
1
1
1

Ifextendedcassettesaresupported,thisisextendedtoincludethe
following:

46

Cashhandlercassettetype5
Cashhandlercassettetype6
Cashhandlercassettetype7

1
1
1
SeeTable
Note7

EnvelopeDepository

var(1)

Envelopedepositbin

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-11

Device Identifiers
Supplies Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

47

ReceiptPrinter

var(5)

Receiptprinterpaper
Receiptprinterribbon

1
1SeeTable
Note5
1
1
1SeeTable
Note6

Receiptprinterprinthead
Receiptprinterknife
Receiptprintercapturebin
H

48

JournalPrinter

var(3)

Journalprinterpaper
Journalprinterribbon

1
1SeeTable
Note5
1

Journalprinterprinthead
I

49

Reserved
ThisDIGisneverreturnedinthesuppliesfield

4A

Reserved
ThisDIGisneverreturnedinthesuppliesfield

4B

4C

NightSafeDepository

var(1)

Nightsafebin

Encryptor
ThisDIGisneverreturnedinthesuppliesfield

4D

SecurityCamera

var(1)

Securitycamerafilm

4E

DoorAccessSystem(notsupported)

4F

OffLineDisk
ThisDIGisneverreturnedinthesuppliesfield

50

TIBins(Alarms)
ThisDIGisneverreturnedinthesuppliesfield

51

CardholderKeyboard
ThisDIGisneverreturnedinthesuppliesfield

52

OperatorKeyboard
ThisDIGisneverreturnedinthesuppliesfield

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-12

APTRA Advance NDC, Reference Manual

Device Identifiers
Supplies Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

53

CardholderDisplay

Data Length

ThisDIGisneverreturnedinthesuppliesfield
T

54

Reserved
ThisDIGisneverreturnedinthesuppliesfield

55

Reserved
ThisDIGisneverreturnedinthesuppliesfield

56

57

StatementPrinter

var(5)

Statementprinterpaper
Statementprinterribbon
Statementprinterprinthead
Statementprinterknife
Statementprintercapturebin

1
1
1
1
1

Reserved
ThisDIGisneverreturnedinthesuppliesfield

58

59

5A

PassbookPrinter
(notsupported)

var(5)

Reserved
Passbookprinterribbon
Passbookprinterprinthead
Reserved
Passbookprintercapturebin

1
1
1
1
1

CoinDispenser*

var(4)

Coindispenserhoppertype1
Coindispenserhoppertype2
Coindispenserhoppertype3
Coindispenserhoppertype4
:
Coindispenserhoppertypen

1
1
1
1
1
SeeTable
Note10

SystemDisplay
ThisDIGisneverreturnedinthesuppliesfield

5B

MediaEntryIndicators
ThisDIGisneverreturnedinthesuppliesfield

5C

EnvelopeDispenser

var(1)

Envelopedispenserhopper

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-13

Device Identifiers
Supplies Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

64

CashHandler0

var(29)

Rejectbin
Cassettetype1
Cassettetype1suppliesstatus
Cassettetype2
Cassettetype2suppliesstatus
Cassettetype3
Cassettetype3suppliesstatus
Cassettetype4
Cassettetype4suppliesstatus
Cassettetype5
Cassettetype5suppliesstatus
Cassettetype6
Cassettetype6suppliesstatus
Cassettetype7
Cassettetype7suppliesstatus
ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.

1
3
1
3
1
3
1
3
1
3
1
3
1
3
1
SeeTable
Note7and
TableNote8

CashHandler1

var(29)

Rejectbin
Cassettetype1
Cassettetype1suppliesstatus
Cassettetype2
Cassettetype2suppliesstatus
Cassettetype3
Cassettetype3suppliesstatus
Cassettetype4
Cassettetype4suppliesstatus
Cassettetype5
Cassettetype5suppliesstatus
Cassettetype6
Cassettetype6suppliesstatus
Cassettetype7
Cassettetype7suppliesstatus

1
3
1
3
1
3
1
3
1
3
1
3
1
3
1
SeeTable
Note7and
TableNote8

65

ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-14

APTRA Advance NDC, Reference Manual

Device Identifiers
Supplies Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

71

ChequeProcessor

var(1)

WhenOption83is000suppliesinformationisnotreportedto
thehostforthechequeprocessor.DIGqwillnotbepresent.
WhenOption83is001or002thefollowingisreturned:
1
1
1
1
1
1
:
1

Endorseprinter
Stamper
Reserved
Reserved
Bin1
Bin2
:
Binn
SeeTableNote9
w

77

BunchNoteAcceptor(BNA)

var(1)

BNACashBin
Fordetailsofthesuppliesstatusofallcassettes,seeCash
AcceptorSupplies(DIGw)onpageE16

TableNote5:Always1(GoodState)forThermalprinters.
TableNote6:Iftheprinterdoesnothaveacapturebin,thevalueis
always0.
TableNote7:Whenextendedcassettetypesaresupported,using
EnhancedConfigurationoption76,DIGEreportsthecombined
suppliesstatus.Separatecashhandlersuppliesstatusisgivenin
DIGdandDIGe.
TableNote8:Therejectbinsuppliesstatusreportsthecombined
statusforboththerejectbinandtheretractbin,wherepresent.The
statustakesthevalueofthefullestbin,asanoverfilloneitherwill
preventfurtheruseoftheSST.
TableNote9:Asuppliesvalueisreportedforthenumberofbins
reportedwithinthechequeprocessordatainthehardware
configurationmessage.Inadditiontothestandardsuppliesvalues
0to4,thefollowingsuppliesvalueisalsopossible:
Supplies Status Data Value

Description

Mediahigh(almostfull)

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-15

Device Identifiers
Supplies Data

TableNote10:Hopperpositions1to4arealwayspresent,hopper
positions5tonareonlypresentwhenmorethanfourhoppertypes
areconfigured.

CashAcceptorSupplies
(DIGw)

ThereportingofthestatusofaBNAorGBXXdeviceisconfigured
usingenhancedconfigurationoption45.Fordetailsofthesettings,
seeOption45BNASettingsonpage 713.
ThestatesreportedforallcassettesintheBNAareasfollows:

Table E-3
Supplies Status of all BNA Cassettes

Code

Description

Notconfigured

Goodstate

Binout(missingorremoved)

Mediahigh(nearlyfull)

Mediafull(overfull)

Whateverthesettingsofoption45,theoverallretractbinsupplies
statusiscalculatedasdescribedinTable E4.
Table E-4
Overall BNA Retract Bin Status Reporting

Overall Status

Description

Good

AllretractbinshaveasuppliesstatusofGood

Overfill

AnyretractbinhasasuppliesstatusofOverfill

BinOut

AnyretractbinhasasuppliesstatusofBinOutandnone
haveasuppliesstatusofOverfill

Nearly
Full

AnyretractbinhasasuppliesstatusofNearlyFulland
nonehaveasuppliesstatusofOverfillorBinOut

Themessageformatdependsontheextendedmessageformat
setting(bit3),asdescribedinthefollowingsections.

DoNotUseExtendedMessageFormat(Bit3=0)

Ifoption45specifiesthattheextendedmessageformatisnottobe
used,howthestatusisreporteddependsontheoption45settingfor
notereporting(bit4).Whentheextendedmessageformatisnot
used,theBNAdataisasinglebyte.
Bit4=0 Ifoption45specifiesthatasuppliesstatusistobe
reportedwhenthefirstcassetteisfullornearlyfull,themostsevere
statusofanycassetteisreported.Themostseveresuppliesstatusis
calculatedasdescribedinTable E5.
5

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-16

APTRA Advance NDC, Reference Manual

Device Identifiers
Supplies Data
Table E-5
Most Severe BNA Supplies Status
Reporting

Overall Status

Description

Good

AllcassetteshaveasuppliesstatusofGood

Overfill

AnycassettehasasuppliesstatusofOverfill

BinOut

AnycassettehasasuppliesstatusofBinOutandnone
haveasuppliesstatusofOverfill

Nearly
Full

AnycassettehasasuppliesstatusofNearlyFullandnone
haveasuppliesstatusofOverfillorBinOut

Bit4=1 Ifoption45specifiesthatasuppliesstatusistobe
reportedwhenoneretractbinorallcashincassettesarefull,the
followingarecomparedandthemostseverestatusreported:
Theleastseverestatusofanycashincassette,calculatedas
describedinTable E6.Suppliesseveritiesfromleasttomost
severeare:Good;NearlyFull;BinOut;Overfill
Theoverallretractstatus,calculatedasdescribedinTable E4.

Table E-6
Least Severe BNA Supplies Status
Reporting

Overall Status

Description

Good

AnycassettehasasuppliesstatusofGood

Overfill

AllcassetteshaveasuppliesstatusofOverfillorBinOut

BinOut

AllcassetteshaveasuppliesstatusofBinOut

Nearly
Full

AnycassettehasasuppliesstatusofNearlyFullandnone
haveasuppliesstatusofGood

UseExtendedMessageFormat(Bit3=1)

Withoption45settoenabletheextendedmessageformat,theBNA
dataisextendedtoreportmultiplecassettesfortheBNAasfollows:
Table E-7
BNA Supplies: Extended Message Format

Character

Description

Retract/Reject/Level2Bin
Thelevel2binisforECB6category2notes;
alsoreferredtoasthecounterfeitbin

13

001
Thefirstlogicalcassettetype

SuppliesstateofCassetteType1

57

002
Thesecondlogicalcassettetype

SuppliesstateofCassetteType2

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-17

Device Identifiers
Supplies Data
Character

Description

911

003
Thethirdlogicalcassettetype

12

SuppliesstateofCassetteType3

1315

004
Thefourthlogicalcassettetype

16

SuppliesstateofCassetteType4

NoChangeReporting

IntheBNAdevicestatusmessage,asuppliesstatusof0No
Changeisreportedinthefollowingsituations:

Whenathresholdorcashuniterrorhasoccurred,theextended
messageformatisenabled,andthecashincassetteorretractbin
wasnotusedinthelasttransaction
Whennothresholdorcashuniterrorhasoccurredandthe
cashincassetteorretractbinwasnotusedinthelast
transaction.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-18

APTRA Advance NDC, Reference Manual

Device Identifiers
Fitness Data

FitnessData

Thefollowingtablesummarisesthefitnessdataassociatedwith
eachdevice.Whereadevicehasmultipleseverities,theyaregiven
intheorderinwhichtheyappearinthemessage.
Table E-8
Device Fitness Data
DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

41

TimeofDayClock

var(1)

FitnessTimeofDayClock

Communications

var(1)

FitnessCommunications

SystemDisk

var(1)

Fitnesssystemdisk

MagneticCardReader/Writer

var(1)

Fitnessmagneticcard

CashHandler

var(5)

Fitnesscashhandler
Fitnesscassettetype1
Fitnesscassettetype2
Fitnesscassettetype3
Fitnesscassettetype4

1
1
1
1
1

42

43

44

45

Ifextendedcassettesaresupported,thisisextendedtoincludethe
following:

46

Cashhandlercassettetype5
Cashhandlercassettetype6
Cashhandlercassettetype7

1
1
1
SeeTable
Note11

EnvelopeDepository

var(1)

Fitnessdepository

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-19

Device Identifiers
Fitness Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

47

ReceiptPrinter

var(2)

Fitnessreceiptprinter

Fitnesscapturebin

1
SeeTable
Note12

JournalPrinter

var(1)

Fitnessjournalprinter

48

49

Reserved
ThisDIGisneverreturnedinthefitnessfield

4A

Reserved
ThisDIGisneverreturnedinthefitnessfield

4B

4C

4D

NightSafeDepository

var(1)

Fitnessnightsafedepository

Encryptor

var(1)

Fitnessencryptor

SecurityCamera

var(1)

Fitnesssecuritycamera

4E

DoorAccessSystem(notsupported)

4F

OffLineFlexDisk

var(1)

Fitnessofflineflexdisk

50

TIBins(Alarms)
ThisDIGisneverreturnedinthefitnessfield

51

52

CardholderKeyboard

var(1)

Fitnesscardholderkeyboard

OperatorKeyboard
ThisDIGisneverreturnedinthefitnessfield

53

CardholderDisplay
ThisDIGisneverreturnedinthefitnessfield

54

Reserved
ThisDIGisneverreturnedinthefitnessfield

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-20

APTRA Advance NDC, Reference Manual

Device Identifiers
Fitness Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

55

Reserved

Data Length

ThisDIGisneverreturnedinthefitnessfield
V

56

StatementPrinter

var(1)

Fitnessstatementprinter

Reserved
ThisDIGisneverreturnedinthefitnessfield

58

Passbook
(notsupported)

var(1)

Fitnesspassbookprinter
Y

59

CoinDispenser*

var(5)

Fitnesscoindispenser
Fitnesshopper11
Fitnesshopper2
Fitnesshopper3
Fitnesshopper4
Fitnesshopper5
Fitnesshoppern2

1
1
1
1
1
1
1

Note:Hopperreferstoasinglehopperoralogicalcombinationof
physicalhoppers(ahoppertype)dependingonthehardware
configuration.
2
Note:Hopperpositions1to4arealwayspresent,hopper
positions5tonareonlypresentwhenmorethanfourhoppertypes
areconfigured.
Z

5A

SystemDisplay
ThisDIGisneverreturnedinthefitnessfield

5B

MediaEntryIndicators
ThisDIGisneverreturnedinthefitnessfield

5C

61

EnvelopeDispenser

var(1)

Fitnessenvelopedispenser

VoiceGuidance

var(1)

Theaudiodevicereturnsthefollowingfitnessstatuses:
0NoErrors
2Warning
4Fatal

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-21

Device Identifiers
Fitness Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

64

CashHandler0

var(29)

Fitnesscashacceptor
Cassettetype1(intherange001999)
Cassettetype1fitnessstatus
Cassettetype2(intherange001999)
Cassettetype2fitnessstatus
Cassettetype3(intherange001999)
Cassettetype3fitnessstatus
Cassettetype4(intherange001999)
Cassettetype4fitnessstatus
Cassettetype5(intherange001999)
Cassettetype5fitnessstatus
Cassettetype6(intherange001999)
Cassettetype6fitnessstatus
Cassettetype7(intherange001999)
Cassettetype7fitnessstatus

1
3
1
3
1
3
1
3
1
3
1
3
1
3
1

ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.

SeeTable
Note11

CashHandler1

var(29)

Fitnesscashacceptor
Cassettetype1(intherange001999)
Cassettetype1fitnessstatus
Cassettetype2(intherange001999)
Cassettetype2fitnessstatus
Cassettetype3(intherange001999)
Cassettetype3fitnessstatus
Cassettetype4(intherange001999)
Cassettetype4fitnessstatus
Cassettetype5(intherange001999)
Cassettetype5fitnessstatus
Cassettetype6(intherange001999)
Cassettetype6fitnessstatus
Cassettetype7(intherange001999)
Cassettetype7fitnessstatus

1
3
1
3
1
3
1
3
1
3
1
3
1
3
1

ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.

SeeTable
Note11

BarcodeReader

var(1)

Fitnessbarcodereader

ChequeProcessor

var(1)

65

66

71

WhenOption83is000thefollowingisreturned:
Fitnesschequeprocessor

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-22

APTRA Advance NDC, Reference Manual

Device Identifiers
Fitness Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

WhenOption83is001thefollowingisreturned:
Fitnesschequeprocessor
Endorseprinter
Stamper
Escrow/Rebuncher
Reserved
Bin1
Bin2
Binn

1
1
1
1
1
1
1
1

SeeTableNote13
w

77

BunchNoteAcceptor(BNA)

var(1)

Fitnessbunchnoteacceptor
SeeCashAcceptorFitness(DIGw)

TableNote11:Whenextendedcassettetypesaresupported,using
EnhancedConfigurationoption76,DIGEreportsthecombined
fitnessstatus.SeparatecashhandlerfitnessstatusisgiveninDIGd
andDIGe.
TableNote12:Iftheprinterdoesnothaveacapturebin,thevalue
isalways0.
TableNote13:Afitnessvalueisreportedforthenumberofbins
reportedwithinthechequeprocessordatainthehardware
configurationmessage.

CashAcceptorFitness
(DIGw)

ThereportingofthestatusofaBNAorGBXXdeviceisconfigured
usingenhancedconfigurationoption45.Fordetailsofthesettings,
seeOption45BNASettingsonpage 713.
Ifthedevicecontainsintelligentcassettes,thecommunications
connectionisdroppedwhentheinnercoverisopened.Thisisdone
toprotecttheonboardprocessors,however,itmeansthatthe
fitnessofthecassettescannotbedetermined.
Whateverthesettingsofoption45,theoverallfitnessstatusis
calculatedasfollows:

Ifthecashacceptserviceisnotavailable,theoverallfitnessisa
fatalcondition
IfanycashincassettehasafitnessofFatalbutthisisnotdueto
acassettebeingeitherfullormissing,theoverallfitnessisa
warningcondition

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-23

Device Identifiers
Fitness Data

Ifasuspendconditionhasbeenreportedinastatusmessage
andthecashacceptserviceisstillreportedinastatusmessage
asavailable,theoverallfitnessisawarningcondition.

Withoption45settodisabletheextendedmessageformat,thisfield
isasinglebyteandreportstheoverallfitness.
Withoption45settoenabletheextendedmessageformat,thisfield
isextendedtoreportmultiplecassettesasfollows:
Table E-9
BNA Fitness: Extended Message Format

Character

Description

Retract/Reject/Level2Binandoverallfitness

13

001
Thefirstlogicalcassettetype

FitnessofCassetteType1

57

002
Thesecondlogicalcassettetype,ifpresent

FitnessofCassetteType2

911

003
Thethirdlogicalcassettetype,ifpresent

12

FitnessofCassetteType3

1315

004
Thefourthlogicalcassettetype,ifpresent

16

FitnessofCassetteType4

nm

Logicalcassettetypeidentifier

Fitnessoftheidentifiedcassettetype

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-24

APTRA Advance NDC, Reference Manual

Device Identifiers
Tamper Data

TamperData

Thefollowingtablesummarisesthetamperdataassociatedwith
eachdevicewhenenhancedconfigurationoption24issettosend
extendedtamperdata.
Fordetailsofoption24,seeOption24Enhanced/TISensorStatus
UnsolicitedMessageonpage 79.
Table E-10
Device Tamper Data
DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

44

MagneticCardReader/Writer

var(1)

Cardcapturebin

CashHandler

var(0)

45

Thisisnotreported.
Cashhandler0isreportedusingDIGd.SeeCashHandler0on
pageE26
Cashhandler1isreportedusingDIGe.SeeCashHandler1on
pageE27
F

46

47

4B

50

SeeTableNote14,Table
Note15,TableNote16
andTableNote17

EnvelopeDepository

var(4)

EnvelopeDepositModuleIdentifier.Always001Envelope
DepositBin
EnvelopeDepositModuleState

ReceiptPrinter

var(102)

NumberofRetractpositions.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

NightSafeDepository

var(4)

NightSafeModuleIdentifier.Always001NightSafeBin
NightSafeModuleState

3
1

TIBins(Alarms)

var(240)

SensorType1
SensorState1.Always001

3
3

SensorType n
SensorStaten

3
3

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-25

Device Identifiers
Tamper Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

56

StatementPrinter

var(102)

NumberofRetractpositions.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

Passbook(notsupported)

var

NumberofRetractposition.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

CoinDispenser

var

NumberofRejectpositions.Thisisintherange00to99
Rejectposition1
:
Rejectpositionn

2
1

NumberofRetractpositions.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

NumberofHopperpositions.Thisisintherange00to99
Hopperposition1
:
Hopperpositionn

2
1

CashHandler0

var

NumberofRejectpositions.Thisisintherange00to99
Rejectposition1
:
Rejectpositionn

2
1

NumberofRetractpositions.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

NumberofCassettepositions.Thisisintherange00to99
Cassetteposition1
:
Cassettepositionn

2
1

58

59

SeeTableNote18and
TableNote19

64

SeeTableNote20,Table
Note21andTableNote22

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-26

APTRA Advance NDC, Reference Manual

Device Identifiers
Tamper Data

DIG

ASCII Value
(Hex)

Device Name and Associated Configuration Data

Data Length

65

CashHandler1

var

NumberofRejectpositions.Thisisintherange00to99
Rejectposition1
:
Rejectpositionn

2
1

NumberofRetractpositions.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

NumberofCassettepositions.Thisisintherange00to99
Cassetteposition1
:
Cassettepositionn

2
1

SeeTableNote20,Table
Note21,TableNote22
andTableNote23.

77

CashAcceptor
NumberofRetractpositions.Thisisintherange00to99
Retractposition1
:
Retractpositionn

2
1

NumberofCassettepositions.Thisisintherange00to99
Cassetteposition1
:
Cassettepositionn

2
1

71

ChequeProcessor

var(102)

SeeTable
Note29

Numberofbins.Thisisintherange00to99
Binposition1
:
Binpositionn

2
1

SeeTableNote24,Table
Note25,TableNote26,
TableNote27andTable
Note28

TableNote14:Onlythealarmsandsensorsarereportedusingthis
field.
TableNote15:Sensortypes001,002,003,and004mustbereported
withinthisfield,asdefinedinTable E11.
TableNote16:Sensorstatescanbeeither000noalert(normal),
or001alert.
TableNote17:Values010to020arereservedforfrauddetection
devicesensors.
TableNote18:Thecoindispenserfieldcontainsanorderedlistof
coincontainers,includinghoppers,retractandrejectbins.Thelistis
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-27

Device Identifiers
Tamper Data

orderedbyphysicaltypethenphysicalposition.Thereporting
orderis:rejectbins,retractbins,thenhoppers.Thelimitonthe
numberofphysicalcontainerswithineachcategoryisthemaximum
possiblemessagelength.
TableNote19:Ifthecoindispenseispartofacompounddispense
ordepositdevice,thisfieldreportsthestateofallphysicalcassettes,
includingdeposit.
TableNote20:Thecashhandlerfieldcontainsanorderedlistof
cassettesandbins.Thelistisorderedbyphysicaltypethenphysical
position.Thereportingorderis:rejectbins,retractbins,then
cassettes.Thelimitonthenumberofphysicalcontainerswithin
eachcategoryisthemaximumpossiblemessagelength.
TableNote21:Ifthecashhandlerispartofacompounddispense
anddepositdevice,thisfieldreportsthestateofallphysical
cassettes,includingdeposit.
TableNote22position5orgreaterisnotreported
TableNote23:Thecashhandler1fieldisonlyreportedaspartofa
dualcashhandlersystem.
TableNote24:Thecashacceptormusthaveremovablecassettes
withcorrespondingsensors.
TableNote25:Thecashacceptorfieldcontainsanorderedlistof
cassettesandbins.Thelistisorderedbyphysicaltypethenphysical
position.Thereportingorderisretractbinsfollowedbycassettes.
Thelimitonthenumberofphysicalcontainerswithineachcategory
isthemaximumpossiblemessagelength.
TableNote26:Ifthecashhandlerispartofacompounddevice
withdispenseanddepositfeatures,thisfieldincludestamper
indicationdataforallphysicalcassettes,includingdeposit.
TableNote27:Cassettestatusisreportedasaccuratelyaspossible,
dependingonthecapabilityofthecashacceptortoreporttamper
indication.
TableNote28:Tamperindicationisnotsupportedforcash
acceptorsduringdiagnostics.
TableNote29:Onbunchchequeacceptors,theinsertionor
removalofabinisreportedaswellastheopeningorclosureofthe
bindoor.Asingleunsolicitedmessageissentwhenthebindooris
openedtoreportthebinsasremoved.Asingleunsolicitedmessage

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-28

APTRA Advance NDC, Reference Manual

Device Identifiers
Tamper Data

issentwhenthebindoorisclosedtoreportthebinsasinserted.
Theseeventsarealsojournaledusingreservedscreenst58andt59.
Table E-11
TI Bins (Alarms) Sensor Types

SensorType

Description

001

Vibrationand/orheatsensor

002

Doorcontactsensor

003

Silentsignalsensor

004

Electronicsenclosuresensor

005

Reserved

006

Reserved

010to020

Frauddetectiondevices:

010

MediaInSensor

011

MediaOutSensor

012

CardholderSensor

013

ServiceSensor

014

EnvironmentSensor

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

E-29

Device Identifiers
Tamper Data

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

E-30

APTRA Advance NDC, Reference Manual

Table of Contents
ASCII/EBCDIC Conversion Table

Appendix F

ASCII/EBCDICConversionTable
Overview

F1

CodeConversionTable

F2

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
ASCII/EBCDIC Conversion Table

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

ASCII/EBCDIC Conversion Table


Overview

Overview

Thisappendixprovidesaconversiontableshowingthemappingof
ASCIIcharactercodestoEBCDICandASCIIhexadecimalcodes.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

F-1

ASCII/EBCDIC Conversion Table


Code Conversion Table

CodeConversionTable

ThefollowingtableliststheASCIIcontrolcodesandcharactersand
theirequivalentinEBCDICandASCIIhexadecimalcodes:
Table F-1
ASCII to EBCDIC Code Conversion

ASCII Control Codes


and Characters

EBCDIC
(Hex)

ASCII
(Hex)

NUL

00

00

SOH

01

01

STX

02

02

ETX

03

03

EOT

37

04

ENQ

2D

05

ACK

2E

06

BEL

2F

07

BS

08

08

HT

05

09

LF

25

0A

VT

0B

0B

FF

0C

0C

CR

0D

0D

SO

0E

0E

SI

0F

0F

DLE

10

10

DC1

11

11

DC2

12

12

DC3

13

13

DC4

3C

14

NAK

3D

15

SYN

32

16

ETB

26

17

CAN

18

18

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

F-2

APTRA Advance NDC, Reference Manual

ASCII/EBCDIC Conversion Table


Code Conversion Table
ASCII Control Codes
and Characters

EBCDIC
(Hex)

ASCII
(Hex)

EM

19

19

SUB

3F

1A

ESC

27

1B

FS

1C

1C

GS

1D

1D

RS

1E

1E

US

1F

1F

SP

40

20

4F

21

7F

22

7B

23

5B

24

6C

25

&

50

26

(apostropheorsinglequote)

7D

27

4D

28

5D

29

5C

2A

4E

2B

6B

2C

60

2D

4B

2E

61

2F

F0

30

F1

31

F2

32

F3

33

F4

34

F5

35

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

F-3

ASCII/EBCDIC Conversion Table


Code Conversion Table
ASCII Control Codes
and Characters

EBCDIC
(Hex)

ASCII
(Hex)

F6

36

F7

37

F8

38

F9

39

7A

3A

5E

3B

<

4C

3C

7E

3D

>

6E

3E

6F

3F

7C

40

C1

41

C2

42

C3

43

C4

44

C5

45

C6

46

C7

47

C8

48

C9

49

D1

4A

D2

4B

D3

4C

D4

4D

D5

4E

D6

4F

D7

50

D8

51

D9

52

E2

53

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

F-4

APTRA Advance NDC, Reference Manual

ASCII/EBCDIC Conversion Table


Code Conversion Table
ASCII Control Codes
and Characters

EBCDIC
(Hex)

ASCII
(Hex)

E3

54

E4

55

E5

56

E6

57

E7

58

E8

59

E9

5A

4A

5B

EO

5C

5A

5D

^
(caretorcircumflex)

5F

5E

6D

5F

`
(graveaccent)

79

60

81

61

82

62

83

63

84

64

85

65

86

66

87

67

88

68

89

69

91

6A

92

6B

93

6C

94

6D

95

6E

96

6F

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

F-5

ASCII/EBCDIC Conversion Table


Code Conversion Table
ASCII Control Codes
and Characters

EBCDIC
(Hex)

ASCII
(Hex)

97

70

98

71

99

72

A2

73

A3

74

A4

75

A5

76

A6

77

A7

78

A8

79

A9

7A

C0

7B

|
(verticalbar)

6A

7C

D0

7D

~
(tilde)

A1

7E

DEL

07

7F

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

F-6

APTRA Advance NDC, Reference Manual

Table of Contents
Related Documentation

Appendix G

RelatedDocumentation
Overview

G1

AdvanceNDCDocumentation

G2

APTRAAuthorDocumentation

G3

NDC+Documentation

G5

OtherNCRDocumentation

G6

MiscellaneousDocumentation

G7

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Table of Contents
Related Documentation

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Related Documentation
Overview
G

Overview

Thisappendixliststhefollowingdocumentation:

DocumentationprovidedontheAdvanceNDCCDROM
DocumentationthatishistoricallylinkedtoAdvanceNDC,but
notprovidedontheAdvanceNDCCDROM
Documentationfromothersources,suchasoptional
componentsandstandardsbodies.Thisdocumentationisnot
providedontheAdvanceNDCCDROM.

ToreadtheAdobeAcrobatPortableDocumentFormat(PDF)
documentation,youneedAdobeReaderversion5.0orlater.The
latestversionisavailablefreefromwww.adobe.com.
Onadevelopmentsystem,thedocumentationcanbeinstalledalone
orinstalledwiththeAdvanceNDCsoftware.Thedocumentationis
notinstalledonaruntimesystem.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

G-1

Related Documentation
Advance NDC Documentation

AdvanceNDCDocumentation
ThefollowingpublicationsareprovidedontheAdvanceNDC
CDROM.PrintedversionscanbeorderedfromtheNCR
Publicationswebsite.
Table G-1
Advance NDC Documentation
Title

Format

Description

APTRAAdvanceNDC,Overview
B0066597

PDF/Paper

ProvidesanintroductiontoAdvanceNDC,
includingoverviewsofthecomponents
containedintheAdvanceNDCproductand
providedaspartoftheANDCPackageon
CDROM.

APTRAAdvanceNDC,DevelopersGuide
B0066046

PDF/Paper

DescribeshowtoconfigureAdvanceNDC;
upgradefrompreviousreleasesandmigrate
fromNDC+.Italsoidentifiesthefunctionality
offeredbyAdvanceNDCandhowtoenhanceit.

APTRAAdvanceNDC,ReferenceManual
B0066180

PDF/Paper

Providesapplicationprogrammerswith
referenceinformationforAdvanceNDC,
includingStates,Screens,andthemessage
formatsbetweenCentralandtheterminal.

APTRAAdvanceNDC,MultiVendorSupport
ReferenceManual
B0066344

PDF/Paper

Providesuserswithinformationaboutrunning
theAdvanceNDCapplicationonothervendors
SSTs,describingthedifferencesbetween
AdvanceNDConNCRSSTsandothervendors
SSTs.

APTRAAdvanceNDC,SupervisorsGuide
B0066062

PDF/Paper

DescribestheSupervisorinterface,howtosetup
theterminalslocalconfigurationparameters,
andhowtoreplenishtheterminal.

APTRAAdvanceNDC,ExtendingtheProduct
B0066926

PDF/Paper

DescribeshowtomodifyAdvanceNDCto
enhanceorextenditsfunctionality.This
publicationreplacesNCRDirectConnect(NDC),
UsingNDCExits,B0065102

APTRAAdvanceNDC,UserGuidefor
DisplayManager
B0066796

PDF/Paper

DescribeshowtousetheDisplayManagerfor
HTMLpagestoreplaceoroverlayNDCscreens

APTRAAdvanceNDC,PaymentApplication
DataSecurityStandard
ImplementationGuide
B0066861

PDF/Paper

Providesinformationonimplementingan
AdvanceNDCsolutionincompliancewithPCI
DSS

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

G-2

APTRA Advance NDC, Reference Manual

Related Documentation
APTRA Author Documentation

APTRAAuthorDocumentation

ThetitleslistedinTable G2areprovidedontheAdvanceNDC
CDROMtoaspartoftheAPTRAAuthor,whichisusedinthe
developmentofAdvanceNDCandcanbeusedtomodifythe
application.
AprintedversionofthePDFfilescanbeorderedfromtheNCR
Publicationswebsite.
Table G-2
Provided APTRA Author Documentation
Title

Format

Description

APTRAAuthor,UsersGuide
B0066038

PDF/Paper

DescribeshowtoinstallandusetheAuthorandRuntime
Componentstodesign,developandmaintainaselfservice
application.

APTRAAuthorHelp

Windows
Help

ContextsensitivehelpfortheAuthoruserinterfaceand
authoringerrors.

RuntimeCoreHelp

Windows
Help

ContextsensitivehelpfortheRuntimeCoreAuthoring
componentsandruntimeerrors.

GUIHelp

Windows
Help

ContextsensitivehelpfortheGUIAuthoringcomponents.

SelfServiceCoreHelp

Windows
Help

ContextsensitivehelpfortheSelfServiceCoreAuthoring
components.

ActiveXHelp

Windows
Help

ContextsensitivehelpfortheActiveXAuthoring
componentsandruntimeerrors.

BasicSelfServiceHelp

Windows
Help

ContextsensitivehelpfortheAuthoringcomponentsand
runtimeerrorsprovidedwithBasicSelfService.

ATMHelp

Windows
Help

ContextsensitivehelpfortheAuthoringcomponentsand
runtimeerrorsprovidedwithATM.

SpecialSelfServiceHelp

Windows
Help

ContextsensitivehelpfortheAuthoringcomponentsand
runtimeerrorsprovidedwithSpecialSelfService.

StatementPrinterHelp

Windows
Help

ContextsensitivehelpfortheAuthoringcomponentsand
runtimeerrorsprovidedwithStatementPrinter.

AdvanceNDCHelp

Windows
Help

ContextsensitivehelpfortheAdvanceNDCAuthoring
components(excludingApplicationCorecomponents).

AdvanceNDCApplicationCore
Help

Windows
Help

ContextsensitivehelpfortheApplicationCore/Supervisor
Authoringcomponents.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

G-3

Related Documentation
APTRA Author Documentation

ThePDFpublicationsinTable G3belowarenotprovidedonthe
AdvanceNDCCDROM.Thesepublicationshavenotbeen
updated,butmaybeusefulifyouareusingtheauthoring
environmenttoextendAdvanceNDC.Printedversionscanbe
orderedfromtheNCRPublicationswebsite.
Note:NCRrecommendstheuseofCExitstoextendAdvance
NDC.
Table G-3
Other Authoring Environment
Documentation
Title

Format

Description

APTRAAdvanceADE,Programmers
Guide
B0066042

PDF/Paper

Describeshowapplicationprogrammersshouldcreate
theirownC++WorkerClasses.Italsocontains
informationonusingCroutinestomanipulatedata.

APTRAAdvanceADE,C++Class
Reference
B0066043

PDF/Paper

Providesapplicationprogrammerswithdefinitionsfor
anumberofC++RuntimeandUtilityWorkerClasses
providedbyNCR.

APTRAAdvanceADE,LocalLanguage
CustomisationGuide
B0066037

PDF/Paper

DescribeshowtocustomisetheAPTRAAdvanceADE
productintoalocallanguage.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

G-4

APTRA Advance NDC, Reference Manual

Related Documentation
NDC+ Documentation

NDC+Documentation

Thepublicationsinthefollowingtablearenotprovidedonthe
AdvanceNDCCDROM.Printedversionscanbeorderedfromthe
NCRPublicationswebsite.

Table G-4
Additional NDC+ Documentation
Title

Format

Description

NDC,ProgrammersOverview
B0062485

PDF/
Paper

Providesanintroductionto,andoverview
of,theNDCsoftware.

NDC+,ProgrammersReferenceManual
B0062486

PDF/
Paper

Aimedatprogrammerswhowritehostor
switchapplicationstosupportNDC+
terminals,orwhocreatetheterminal
configurationthatcustomisesNDC+.

NDC,MessageFormatsForHostApplication
Developers
B0064201

PDF/
Paper

DesignedforCentralcontrolapplication
developersworkingwithNDCRMX,
NDCxaorNDC+.Intendedtohelpin
creatingacontrolprogramthathandlesall
theNDCvariants.

NDC+,SupervisorsReferenceManual
B0062487

PDF/
Paper

Designedforthosepeoplewhoare
responsibleforsettinguptheterminals
localconfigurationparameters,orfor
routinereplenishmentoftheterminal.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

G-5

Related Documentation
Other NCR Documentation

OtherNCRDocumentation
Thepublicationsinthefollowingtableareprovidedwiththe
softwareproductorcomponenttowhichtheyrefer.Printed
versionsofthePDFscanbeorderedfromtheNCRPublicationsweb
site.

Table G-5
Other NCR Documentation
Product

Title

Format

Description

APTRAXFS

NCRAPTRAXFSOverview
B0066166

PDF/Paper

ProvidesinformationaboutAPTRAXFS,its
featuresandfunctionality,andthe
requirementsforitsuse.

EMV/CAM2
ExitsforAPTRA
AdvanceNDC

EMVIntegratedCircuitCard
(ICC)ReferenceManual
B0066297

PDF/Paper

Providesreferenceinformationforany
AdvanceNDCdeveloperwhowishestoadd
EMVIntegratedCircuitCard(ICC)Card
AuthenticationMethod(CAM)functionality
totheirAdvanceNDCapplication.

NCRXFS
Simulatorfor
APTRA

XFSSimulatorforAPTRA

Microsoft
HTML
Help
(CHM)

Contextsensitivehelpandreferenceforthe
NCRXFSSimulator.

40Column
Printer

SelfServicePlatformSoftware
ProgrammersManualforthe
40ColumnPrinter
B0064612

PDF/Paper

Providesinformationaboutcodepagesfor
the40columnprinter.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

G-6

APTRA Advance NDC, Reference Manual

Related Documentation
Miscellaneous Documentation

MiscellaneousDocumentation

Thissectionlistsanythirdpartymanualsanddocumentsthatare
referencedinthetext.MoreinformationaboutCENXFS
specificationsisavailableathttp://www.cen.eu/cen/pages/default.aspx.
Youcansearchforspecificdocumentsat
http://www.cenorm.be/cenorm/search.htm.
Table G-6
CEN-XFS Documentation
Title

Format

Description

ExtensionsforFinancialServices(XFS)interface
specification
(CWA14050)

PDForzippedPDF

Providesreferenceinformationforthe
CENXFSspecificationsrelease3.0x
(3.10fortheItemProcessingModule).

XFSClarificationsforDeviceClass
Interfaces

Word

Providesadditionalinformation
fortheCENXFSspecifications

ActiveXFSInterfaceSpecification
(CWA13849)

PDForzippedPDF

Providesreferenceinformationforthe
ActiveXFSspecifications.

Table G-7
ISO Documentation
Title

Reference

BankingPersonalIdentificationNumberManagementandSecurity
(Part1:PINProtectionPrinciplesandTechniques)

ISO95641

InformationaboutISOstandardsisavailableathttp://www.iso.org.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

G-7

Related Documentation
Miscellaneous Documentation

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

G-8

APTRA Advance NDC, Reference Manual

Glossary

Glossary
A

ABA AmericanBankersAssociation.
ActiveX Control AtypeofCOMcomponentwhichimplements
standardinterfaces,andcanbeincludedinawebpageandusedin
languagessuchasVBScript.
Advance NDC NCRsimplementationofNDCforaWindows
environment.
API ApplicationProgrammingInterface.
Application Core InAdvanceNDC,anauthoredapplicationthat
performstheSSTmodehandlingandmessageprocessingfunctions.
APTRA Author Toolthatallowsyoutovisuallydesignanddevelopa
selfserviceapplication.
ARPC AuthorisationResponseCryptogram.AnICCapplication
cryptogramproducedbyCentralforsubmissiontotheICC,to
proveitisagenuinehost.
ASCII AmericanStandardCodeforInformationInterchange.Thisis
acomputercodeforrepresentingalphanumericcharacters.
ATM AutomatedTellerMachine.SeeSST.
ATR AnswertoReset.Usedinchipprocessingforsmartcards.
Audio Guidance SeeVoice Guidance.
Authored Application IntheAPTRAAuthor,acollectionofWorkers
thatcanbebuilttocreateanexecutable.SeeSelfService
Application.

BAPE BasicAlphaPINpadandEncryptor.CombinedPINpadand
encryptor.SupportssinglelengthDESencryptionwithvariouslocal
andremotePINverificationschemes.
Basic Remote Key Protocol Aminimumcommandsetforremotekey
managementthatcomplieswiththemandatoryrequirementsof
ANSX9.24.2004part2.
Bills Alternativetermforcurrencynotes.
BNA BunchNoteAcceptor.AnNCRdevicevariantthatallowsa
consumertodepositanumberofbanknotesinabundlewithout
usinganenvelope.SeeCash acceptor
BOP BasicOperatorPanel.NotsupportedbyAdvanceNDC.See
EOP.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Glossary-1

Glossary

CAM CardAuthenticationMethod.
Cardholder SeeConsumer.
Cash acceptor AgenerictermforanySSTdevicethataccepts
banknotedeposits.
SeealsoBNA,GBNA,GBRUandGBXX
Cash recycler AgenerictermforanySSTdevicethatrecycles
banknotes.
Cash recycling Theprocessofreusingdepositedcashfordispense
operationsonasingleSST.
Catalog IntheAPTRAAuthor,ameansoforganisingworkersor
applicationsintomanageablegroups.
CDM CashDispenserModule.CENXFSclassnamefortheCash
Dispenserservice.
CEN ComitEuropendeNormalisation(EuropeanCommitteefor
Standardization).ResponsiblefortheXFSinterfacespecification.
Central Thecontrolapplicationonthehostorswitchthatsends
commandstotheSSTandrespondstorequestsfromtheSST.
Cheque Processor CPMandbunchchequeacceptor.
Codeline ThesetofcharactersprintedonachequeinaMICRfont.
Coin Hopper Aphysicalcontainerholdingcoins.
Coin Hopper Type AlogicalrepresentationofoneormoreCoin
Hopperscontainingthesametypeofcoin.ACoinHopperType
mapstoonelogicalXFSCDMCashUnit.
Cold Start Thefirsttimetheterminalispoweredup,withno
previouslydownloadedsoftware.
COM CommonObjectModel.Anopenarchitecturefor
crossplatformdevelopmentofclient/serverapplicationsbasedon
objectorientedtechnology.Clientshaveaccesstoanobjectthrough
interfacesimplementedontheobject(forexample,accessto
Methods,PropertiesandEvents).
Control File AfilethattellsAdvanceNDCwhichSupervisor
functionsorstatesareNDCstandard,whichareuserwritten,and
wheretheuserwrittenroutinesaretobefound.Acontrolfilealso
givesinformationaboutthechainingofVirtualControllersand
Hooks
Consumer Thecustomerofabank,orotherfinancialinstitution,
whohasoneormoreaccountsandusesSSTstoaccessandmanage
moneyinthem.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Glossary-2

APTRA Advance NDC, Reference Manual

Glossary

Counterfeit note Anotewithauthenticationfeaturesmissingorout


oftolerance,whichthecashdepositdeviceclassifiesasapotential
forgery.Thisisthesameasacategory2note,asdefinedintheECB
6regulation.
cpi charactersperinch.
CPM ChequeProcessingModule.Usedforsinglecheques.
SeealsoCheque Processor.
CR CarriageReturn.
CROPF CardReturnonPowerFail.
CRT Cathoderaytube.Atypeofscreenusedforcardholder
displayonthefrontinterfaceofanSST.
CSP CustomerSelectablePIN.
Currency Mediumofexchangeinacountry,forexampleAmerican
dollars(USD)orBritishpounds(GBP).
Customisation Layer TheCustomisationLayerperformstheIn
Serviceactivitiesassociatedwiththecardholder.

D/A Digital/Analog.
DAPI DirectApplicationProgrammingInterface.
DASH DipAndSmartHardware.SupportedinDipemulation
modeonly.
DCC DynamicCurrencyConversion.
DCS DigitalCameraService(notsupportedinAdvanceNDC)
DEA2 DataEncryptionAlgorithm2.
Denomination Thevaluesofthemonetaryunitsinaseries.
DES DataEncryptionScheme.
DES encryption, Triple SeeTriple DES encryption.
Device ID Deviceidentifier.AnothertermforDIG.
DIG DeviceIdentifierGraphic.
Direct Deposit Depositmodewherecashisdepositeddirectlytothe
cassetteswithoutbeingheldintheescrow.Cashcannotberefunded
tothecardholder.
DLL DynamicallyLinkedLibrary.
Dynamic Condition Theresultofanoperationthatcanonlybe
determinedatruntimebytheapplication.Theoperationresultisan
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Glossary-3

Glossary

indexintoanarrayofscreenfragmentsusedtoinformthe
cardholderoftheexactconditionsthathaveoccurred.

EBCDIC ExtendedBinaryCodedDecimalInterchangeCode.An
eightbitcharactercode.
EJ ElectronicJournal.TheEJlogemulatestheprintedjournal.All
thedatanormallyrecordedonthejournalprinteriswrittentotheEJ
logontheterminalssystemdisk.
EKC EncryptorKeyboardController.Amorecomplexandsecure
versionoftheBAPE,fittedtosometerminals.Notsupportedin
AdvanceNDC2.06orlater.
EMV Europay,Mastercard,VISA.Aconsortiumresponsibleforthe
theEMVstandardforsmartcards.
Encash AnothertermforVault.
Enhanced Remote Key Protocol Acommandsetforremotekey
managementthatallowsthefinancialinstitutiontoimplementsome
ofthebestpracticesrecommendedbutnotrequiredinX9.24.2004
part2.
EOP EnhancedOperatorPanel.
EPP EncryptingPINPad.AnewcombinedPINpadandencryptor,
supportingtripleDESencryption.
Escrow Theareawherenotesareheldaftervalidationandbefore
beingvaultedorreturnedtothecardholder.
Exit Ageneraltermcoveringuserdefinedstates,Supervisor
features,virtualcontrollers,andspecialsynchronisationroutines
calledhooks.
Exit State Astatedefinedandprogrammedbytheuser.
Exit Supervisor ASupervisorfunctiondefinedandprogrammedby
theuser.

Facia ThefrontofanSST.
FDK FunctionDisplayKey.Thesekeysarelocatedoneachsideof
thefaciascreenandenablevariousoptionstobechosen.Some
screenshavetouchscreenareaswhichemulateFDKfunctions.
FIID FinancialInstitutionIDentificationnumber.
FIT FinancialInstitutionTable.Thiscontainsdetailsofwhereand
howinformationisstoredonthecardandhowatransactionshould
beprocessed.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Glossary-4

APTRA Advance NDC, Reference Manual

Glossary

Forms-based printing FormsbasedprintingutilisestheWindows


printingenvironment,removingtheneedtoknowdetailsofthe
printer,andisimplementedusingXFSforms,whicharegenerated
dynamicallybytheapplication.

GBNA GlobalBunchNoteAcceptor.AnNCRdevicevariantthat
allowsaconsumertodepositanumberofbanknotesinabundle
withoutusinganenvelope.SeealsoCash acceptor
GBRU GlobalBillRecyclingUnit.AnNCRdevicethatallowsa
consumertodepositanumberofbanknotesinabundlewithout
usinganenvelope.Thedevicecanalsodispensenotesandrecycle
depositednotes(thatis,dispensethedepositednotes).
SeeRecyclingunit.
GBXX ANCRtermforGBNA(cashacceptor)orGBRU(recycler)
withconfigurablecassetteswherethespecificdeviceisnot
significant.
GIF GraphicsInterchangeformat.

Hex Shortformofhexadecimal.
HRI HumanReadableInterpretationofabarcode.
Hooks Generaltermformiscellaneoususerdefinedroutines
detailedintheMISCONTfile.
SeealsoExit

ICC IntegratedCircuitCard.Acardcontaininganintegrated
circuit.Alsoknownasasmartcard.
ID Identifier.
IMCRW IntegratedMagneticCardReader/Writer.
Intercept routine Anothernameforvirtualcontroller.
Invalid notes SeeRejecteditems
IQA ImageQualityAssessment
ISO InternationalStandardsOrganisation.

JIF JPEGInterchangeFormat.
JPEG JointPhotographicExpertsGroup.
lpi linesperinch.
LUNO LogicalUnitNumber.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Glossary-5

Glossary

MAC MessageAuthenticationCode.Amethodofprotecting
messagespassingbetweentheterminalandCentralfrom
tampering.
MCN MessageCoordinationNumber.
MCRW MagneticCardReader/Writer.Thisisusedtoreaddatafrom
astandardmagneticstripecardand,dependingontheMCRW
variant,writedatatooneofthetracksonthecardsmagneticstripe.
MEI MediaEntry/ExitIndicator.
MICR MagneticInkCharacterRecognition.Acharacterrecognition
technologyused,forexample,toreadthecodelineprintedon
cheques.
MISCONT AcontrolfiledetailingmiscellaneousExitsorHooks.
SeealsoControl File
MSR MagneticStripeReader.Thisisusedtoreaddatafromthe
tracksofamagneticstripecard.Itprovidesasubsetofthefeatures
oftheMagneticCardReader/Writer.
Multiple EJ Backup AlternativesettingforEJbackup.Allows
multipleEJbackupfilestoberetained,asdefinedbythenumberof
multiplebackupsettings.

NBS NationalBureauforStandards.
NDC NCRDirectConnect.AnNCRapplicationthatworksin
conjunctionwithaCentralapplicationtoperformselfservice
transactionsonSSTs.
Nibble Thefirstorsecondfourbitsofabyte(thatis,halfofabyte).
Canberepresentedbyonehexadecimaldigit.
Note type Thecurrency,valueandversionofanote.Forexample,
anEnglishfivepoundnoteandaScottishfivepoundnotehavethe
samecurrencyidentifier(GBP)anddenomination(unitvalueof5),
butdifferentversions.Alsoknownasbilltype.
NVRAM SeePersistent memory.

O
P

OpCode ShortformofOperationCode.
PAN PrimaryAccountNumber.
PCX PictureExchange.
PDF PortableDocumentFormat.TheAdobefileformatfor
documentsviewableinAdobeReader.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Glossary-6

APTRA Advance NDC, Reference Manual

Glossary

Persistent memory Thistypeofmemoryretainsinformationwhen


thepowerisswitchedofforlost.Alsoknownaspersistentstorage.
PIN PersonalIdentificationNumber.Asecretidentificationnumber
thatisissuedtoeachcardholder.
PPD ProgrammablePrintingDepository.Oneofthetypesofprinter
supportedbyAdvanceNDC.
PVKI PINVerificationKeyIndicator.PartofthePINoffsetdata
usedinVISAPINverification.
PVV PINVerificationValue.AnotherpartofthePINoffsetdata
usedinVISAPINverification.

Raw data printing Amethodofprintingwhereprinterspecific


controlcodesaresentdirectlytotheprinter.
Recycler SeeRecycling unit
Recycling unit Adevicethatallowsaconsumertodepositanumber
ofbanknotesinabundlewithoutusinganenvelope.Thedevicecan
alsodispensenotesandrecycledepositednotes(thatis,dispense
thedepositednotes).
Refundable Deposit Depositmodewherecashisheldintheescrow,
fromwhereitcanberefundedtothecardholderbeforethedeposit
iscompleted.
Refused notes Anothertermforrejecteditems.
Rejected items Itemsthatareunrecognizedasnotes;eithertheyare
notnotesorcannotberecognizedasnotes.Suchitemscannotbe
acceptedfordepositandarereturnedimmediatelytotheconsumer.
RSA encryption Anasymmetricencryptionschemeusingprivate
andpublickeys,devisedbyRivest,ShamirandAdleman.
Rule File SeeControl File

SCRW SmartCardReaderWriter.Adevicewhichcaninteractwith
anICC.
SDC SerialDistributedControl.
SDM ScalableDepositModule
Self-Service Application ThisistheapplicationwhichrunsonanSST
andprocessesallthenecessarytransactions.
Self-Service Support A32bitopensoftwareplatformsuppliedby
NCRforuseonSSTs.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Glossary-7

Glossary

Smart Card Commonnameforacardwhichusesanintegrated


circuit(microchip)ratherthanamagneticstripe.SeeICC.
SMS Shortmessageservice.
SO ShiftOut.
SST SelfServiceTerminal.Alsoknownasaterminal.
Standard Cash Handler Afourcassettestackingdispenser.
Standard EJ Backup ThedefaultsettingforEJbackup.Createsa
singleelectronicjournalbackupfile.
Standard Output Thedestinationwheretowhichoutputissent.
Unlessredirected,forexampletoafile,standardoutputisthe
commandwindowfromwhichtheprogramwasinitiated.
STCONT AcontrolfiledefinedbyExitswhenuserdefinedstatesare
added.
SeealsoControl File
SUPCTR AcontrolfileusedbyExitswhenuserdefinedSupervisor
featuresareadded.
SeealsoControl File
Supervisor TheSupervisorapplicationperformstheoutofservice
operationsneededtomaintainandrunSSTs.
Suspect note Anotewithrecognisedauthenticationfeaturesbut
qualityand/ortolerancedeviations.Inmostcases,thismeansa
damagedorsoiledbanknote.Thisisthesameasacategory3note,
asdefinedintheECB6regulation.

TABS TotalAutomaticBankingServices.
TCM TerminalControlModule.
TI TamperIndication.
TIFF TaggedImageFileFormat.
ToD TimeofDay.
TPA TransactionProcessingApplication(NDCApplication).
Triple DES encryption DESencryptionperformedthreetimes
successively,forgreatersecurity.
TSN TransactionSerialNumber.
TVN TimeVariantNumber.

USB UniversalSerialBus.Ahardwareinterfaceforattaching
peripheraldevices,suchasdiskdrives.
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Glossary-8

APTRA Advance NDC, Reference Manual

Glossary

Vault Todepositnotesinacassetteorbinasthefinalstageina
transaction,afterwhichthenotescannolongerbereturnedtothe
cardholder.
VC VirtualController(orinterceptroutine).Auserwrittenroutine
tointerceptandrespondtomessages.
SeealsoExit
VCCONT AcontrolfileusedbyExitswhenvirtualcontrollersare
added.
SeealsoControl File
VDM VendorDependentMode.
Voice Guidance Termusedtodescribetheuseofspeechtoguidea
cardholderthroughatransaction.

WAVE WAVEor.WAV(WaveformAudio).AstandardWindows
basedsoundformat.
Windows XP MicrosoftWindowsXPProfessionaloperatingsystem.
Work Group IntheAPTRAAuthor,aworkgroupcontainsa
collectionofWorkerswithsimilarrolesintheworkerhierarchy.
Workers GraphicalbuildingblocksusedintheAPTRAAuthorto
developaselfserviceapplication.
Worker class Everyworkerbelongstoaworkerclass,whichdefines
thecharacteristicsandfunctionsthatanygivenworkerwillhave.

XFS EXtensionsforFinancialServices.Applicationandservice
providerinterfacespecificationsfromCEN.

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Glossary-9

Glossary

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Glossary-10

APTRA Advance NDC, Reference Manual

Index

Index
A

Abbreviationsusedinthemanual lxxv
AcknowledgeandStopEJ 1083
AcknowledgeEJUploadBlock 1082
Activitytimerindialup 135
AdvanceNDC
documentation G2
Alphanumericstatenumbers 24
Amountcheckstate 223
Amountentrystate 220
Animation 344
Applicationtimersfordialup 133
Audienceforthismanual lxxi
Autovoice(option2) 1017
Backgroundcolourcontrolcommands 328
BANKSYSPINblock 117
BAPEsecurity 112
Barcodereader
Option48 716,1018
state 2143
Base94encodinganddecoding 1126
Baudratefordialupconnection 132
Blinkingcommands 327
BNASeeBunchNoteAcceptor
Buffervalidationstate 2140
Buffers
Amount 220
FDK 274
FDKswitchstate 273
Generalpurpose 229
Operationcode 215,277
Track3data 248,250
Bunchchequeamountdisplaycontrolsequence 337
Bunchchequecodelinedisplaysequence 337
Bunchchequeimagedisplaysequence 335
Bunchchequevaluedisplaycontrolsequence 338
BunchNoteAcceptor
Cashacceptstate 293
Closestate 240
Encash 1073
Encash,printandsetnextstate 1073
fitnessreporting E23
Journalnotescount(option44) 713
Journalvaultednotescount(option44) 1018
Messagesettings(option45,bit1) 9111
Messagesettings(option45) 713,96
Notedefinitionssolicitedstatusmessage 951

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-1

Index

Option45inEnhancedConfigurationParametersLoadmessage 1018
Refundandsetnextstate 1072
suppliesreporting E16

Cameracontrolstate 253
Cardbeforecashfunction 1067
Cardbeforeparalleldispenseandprintfunction 1070
CardreadPINentryinitiationstate 261
Cardreadstate 26
Cardreader/writer(solicited/unsolicitedmessage) 985
Cardwritestate 248
Cardholderdisplayreservedscreens 36
Internationalcurrencydisplayformat 344
Cardholderverificationstate 254
Cardlesstransactions(option77) 1018
Cashacceptstate 293
CashDepositRetractDestination(option74) 1018
Cashhandler(solicited/unsolicitedmessage) 986
Cashhandlers
(option76) 1018
CCMVISA2dialupsystem 131
CellBody
BITs47 E5,E6
CentraltoSST
Dialupmessages 137
Centraltoterminalmessages
Customisationdatacommands 106
EJcommands 1081
AcknowledgeandStopEJ 1083
AcknowledgeEJUploadBlock 1082
EJOptionsandTimers 1081
Messageexceptionhandling 1086
NDCconfigurationcommand 106
Terminalcommands 102
Changingdisplayinidle 330
Charactersets B2
downloadable B4
ISO8859 B12
Chequeimagecontrol 335
ChequeProcessor
Chequeacceptstate 2105
Option83 1018
ClearingPersistentMemory(NVRAM) 14
Closestate 238
Coindispenser
option79 95,1018
solicited/unsolicitedmessage 9119
Commandrejectcauses 1086
Communications
CCMVISA2dialup 131
ConfigurationIDnumberloadmessage 1023
Configurationparameters
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-2

APTRA Advance NDC, Reference Manual

Index

Configurationparametersloadmessage 1014
Introduction 71
Configurationparametersloadmessage
LogicalunitnumberLUNO 73
Numberof800millisecondtickspertimerfield 74
Timernumber 73
Controlcharacters
CRTscreenactivity 316
Digitalaudiocontrol 323
CRTdisplaycharacters 314
Customerscreengroups 33
CustomerselectablePINstate 282
Customisationdatacommands
ConfigurationIDnumberload 1023
Configurationparametersload 1014
Dateandtimeload 1032
Dispensercurrencycassettemappingtable 1043
Encryptionkeychange 1033
Enhancedconfigurationparametersload 1016
FITdataload 1021
Messageauthenticationfieldselectionload 1025
Screen/keyboarddataload 1010
Statetablesload 108
Typesof 106
Customisedscreensdefinition 33

D,SSTkeyentrymode 935
DAPI7andrearsettlement 351
DASHcardreader 262
Dateandtimeloadmessage 1032
Dateformat(option3) 1017
Decoding,Base94 1126
Definingakeyboard
Example 416
Deletingpersistentmemory 14
Depositandprintfunction 1063
Depository(solicited/unsolicitedmessage) 991,9115
DESkeyformat,RSAencrypted 1125
Devicefaults 969
Devicefitnessstate 266
Deviceidentifiers
Fitnessdata E19
Hardwareconfigurationdata E2
Suppliesdata E11
Devicestatusinformation
BarcodeReader(solicited/unsolicited) 9122
Camera(unsolicited) 999
Cardreader/writer(solicited/unsolicited) 985
Cashacceptor(solicited/unsolicited) 9109
Cashhandler(solicited/unsolicited) 986
Chequeprocessor(solicited/unsolicited) 9115
Coindispener(solicited/unsolicited) 9119
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-3

Index

Depository(solicited/unsolicited) 991,9109,9115
Electronicjournalprinter(unsolicited) 995
Encryptor(unsolicited) 999
Envelopedispenser(unsolicited) 9114
Journalprinter(unsolicited) 993
Nightsafedepository(solicited/unsolicited) 998
Powerfailure(unsolicited) 984
Receiptprinter(solicited/unsolicited) 992
Sensors(unsolicited) 9100
Statementprinter(solicited/unsolicited) 9106
Supervisorkeys(unsolicited) 9103
Timeofdayclock(unsolicited) 984
Touchscreenkeyboard(unsolicited) 9103
Voiceguidance(solicited/unsolicited) 9107
Dialup
MessageonCP 136
Messagesuppression 136
Systemsetup 132
Transactioncompletion 136
Dialupmessageheaderformat 134,137
Dialupmessages
CentraltoSST 137
SSTtoCentral 134
Dialuptimers 132
Digitalaudiocontrol 323
Screenupdateinatransactionreply 324
Usinganestedscreen 325
usingdynamicplaceholderdata 326
Dispenseandprintfunction 1064
Dispensercurrencycassettemappingtablemessage 1043
Displayandprintfunction 1065
Displaydynamictextdictionarysequence 339
Displayimagefilescontrol 334
Dynamicbuttonscontrol 341
Dynamictextdefinition 343
Dynamictextdictionarysequence
BunchChequeAcceptrefusereason 2118
BunchChequeAcceptrejectreason 2118
CashAcceptrefusereason 2104

e5 992
EightFDKselectionfunctionstate 277
EJcommands
AcknowledgeandStopEJ 1083
AcknowledgeEJUploadBlock 1082
EJOptionsandTimers 1081
EJOptionsandTimers 1081
EJUpload D2
EJUploadMessage 978
EJupload,dialup 133
Electronicjournalprinter(unsolicitedmessage) 995
EMVmessageclass 101,1086
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-4

APTRA Advance NDC, Reference Manual

Index

EMVsmartcard(option70) 1018
EMVsmartcardextendedstatus(option69) 1018
Encoding,Base94 1126
Encryptionkeychangemessage 1033
Encryptionkeyentry 413
Encryptorinitialisationdata 973
Enhancedamountentrystate 255
Enhancedconfigurationparametersload
optionnumbers,enhancedconfigurationparameterload 1016
Enhancedconfigurationparametersloadmessage
AlphanumericStateEntry 719
Autovoice 77
BarcodeReader 716
BNAJournalNotesCount 713
BNAMessageSettings 713
CashHandlers 717
chequeprocessor 719
coindispenser 719
Dateformat 77
EMVSmartCardExtendedStatusoption 716
EMVSmartCardoption 716
Enhancedcarddevicesecurityoption 716
EnhancedEJbackup 712
Envelopedispenserstatusoption 79
GBRUmstatusandvariantreporting 718
Journalprinterbackupprintoperationsoption 78
Journalprinterbackuptimeoption 78
Leftcolumn 77
MCNRange 711
Mediaentryindicatorsflashrateoption 710
Numberofsecondspertimerfield 720
PrintTrack2toJournal 712,713
Remoterelayoption 710
ReportdualmodeEJandhardcopybackupunsolicitedmessages 712
Rollwidth 77
Sendenhanced/TIsensorstatusunsolicitedmessageoption 79
Simulatesupervisormodeentry/exitoption 711
Specificcommandrejectoption 78
Track1format 78
Transactionstatusinformationoption 78
EnhancedEJbackup(option36) 1018
EnhancedPINentrystate 250
EnhancedPrinterControlCodes
DefineDownloadableBitImage 516
DefineDownloadableCharacterSet 515
PrintBarcode 512
PrintDownloadableBitImage 510
PrintEpsonGraphics 513
SelectArabicCharacterSets 510
SelectHorizontalHeightofBarcode 517
SelectInternationalCharacterSet 59
SelectOS/2CodePage 59
SelectPrintingPositionofHRICharacters 516
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-5

Index

SelectWidthofBarcode 517
SetLeftMargin 57
SetRightMargin 58
EnhancedTI/sensorstatus(option24) 1017
Envelopedispenser(unsolicitedmessage) 9114
Envelopedispenserstate 214
Envelopedispenserstatus(option23) 9114,1017
EPPauthenticationprocess 1118
EPPsecurity 113
ErrorRedialtimer 136
Examplemessages
digitalaudiocontrolinatransactionreply 324,326
Exitstates 21,285
Extendedencryptionkeychangemessage 1036
ExtendedscreencontrolsreservedscreensK 38
Extensionstates 25
ExtensiontoStateY 281

FDKinformationentrystate 274
FDKswitchstate 273
FinancialInstitutionTables
Data 82
Fields 84
Introduction 81
FITdataloadmessage 1021
FITfields 114
Algorithm/bankIDindex(PAGDX) 84
Decimalisationtable(PDCTB) 89
EncryptedPINkey(PEKEY) 89
Indexreferencepoint(PINDX) 810
Indirectnextstateindex(PSTDX) 84
InstitutionID(PFIID) 84
InstitutionIDindex(PIDDX) 84
Languagecodeindex(PLNDX) 811
MaximumPINdigitschecked(PCKLN) 85
MaximumPINdigitsentered(PMXPN) 85
MMsensorflag(PMMSR) 811
PANdataindex(PANDX) 87
PANdatalength(PANLN) 88
PANpad(PANPD) 88
PINblockformat(PBFMT) 811
PINoffsetdata(POFDX) 89
PINpad(PINPD) 86
Track3PIN(PRCNT) 89
FITswitchstate 245
FontIDmappingtable B12
Foregroundcolourcontrolcommands 328
FourFDKselectionfunctionstate 218
FunctionIDs
FunctionID 1052,1089,D16
FunctionID* 1052,1089,D16
FunctionID1 1051,1055,1089,D15,D16,D17,D19
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-6

APTRA Advance NDC, Reference Manual

Index

FunctionID2 1051,D15
FunctionID3 1051,D15
FunctionID4 1051,D15
FunctionID5 1052,D15
FunctionID6 1052,D15
FunctionID7 1051,1055,D15,D16,D17,D19
FunctionID8 1051,D15
FunctionID9 1051,1089,D15
FunctionIDA 1052,1054,1089,D15
FunctionIDB 1052,1054,1055,1089,D15
FunctionIDC 1052,1054,1055,1089,D16
FunctionIDE 1052,D16
FunctionIDF 1052,1089,D16
FunctionIDO 1052,1089,D16
FunctionIDP 1052,1055,1089,D16
FunctionIDQ 1052,1055,1089,D16
FunctionIDR 1052,D16
FunctionIDS 1052,1089,D16
FunctionIDT 1052,1089,D16
FunctionID 1052,1089,D16
FunctionIDc 1052
FunctionIDcolon 1052,1055,1089,D16,D17

GBRU
Option78 718,1018
GraphicpicturesreservedscreensG 38
Graphicspictures C2
ImAlivemessage 135
Informationentrystate 228
InsertCardState 2136
Interactivetransactionresponse,formatof 1077
Internationalcurrencydisplayformat 344
ISO8859charactersets B12
Journalprinter(unsolicitedmessage) 993
Journalprinterbackup 1130
Journalprinterbackuplogtamper(option22) 995
Journalprinterbackupprintoperations(option17) 1017,1130
Journalprinterbackuptime(option16) 1017,1130
KeyentrymodeD 935
Keyloading,RSAinitial 1118
Keyverificationvalues 1117
Keyboarddata
Encryptionkeyentry 413
Introduction 42
Securekeyentry 413
Statesandkeyboards 48
Supervisormode 412

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-7

Index

Traditionalkeyboardlayouts 410
Transactionprocessing 410,411
Keyboards
Fulltouchscreens 416
instates 48
Nested(notsupported) 42
Operation 49
Operator 414
physical 42
SecurePINentry 49
Supervisormode 412
Touchscreen 42
Transactionprocessing 410

Languagecodeswitchstate 258
Languageselectfromcardstate 272
Leftmargincontrol 332
Leftprintcolumn(option5) 1017
Liftchequeimagecontrol 335
LinkedFITs 813
Logocontrol 333
Logosreservedscreens 312
MCNrange(option34) 1018
MCRWECDsecurityjitter(option46) 1018
Mediaentry/exitindicatorsflashrate(option25) 1017
Messageauthentication 1110
Messageauthenticationcode
Fullmessageauthentication 1112
Generation 1110
Selectivemessageauthentication 1113
SendingtheMACfieldfromCentraltotheterminal 1111
SendingtheMACfieldfromtheterminaltoCentral 1111
Timevariantnumber 1111
Messageauthenticationfieldselectionloadmessage 1025
Messageexceptionhandling
Reasonsforacommandreject 1086
MessageonCPoptionindialup 136
Messagesuppressionindialup 136
Messagetypes
Quickreference D2
Acknowledgeandstopcommand D20
AcknowledgeEJuploadblockcommand D20
Customisationdatacommands D12
EJoptionsandtimerscommand D20
Solicitedstatus D8
Terminalcommands D10
TMAlert D2
Transactionreply D14
Transactionrequest D3
Unsolicitedstatus D7
UploadEJdata D9
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-8

APTRA Advance NDC, Reference Manual

Index

Messages
ImAlive 135
Messagesreceivedinwrongoperationalmode
Actiontaken 1094
Customisationdatacommands 1094
Terminalcommands 1096
Transactionreplycommand 1095
Modemtimers 132
Multilanguagescreens 347

Navigatingthepublication lxxv
NCRdocumentation,other G6
NCRXFSsimulator G6
Nestedkeyboards,notsupported 42
Nightsafe
Depositandprintfunction 1067
Nightsafedepository(solicited/unsolicitedmessage) 998
NightSafeDepositandPrint 1067
Operatorinterfacedisplaycharacters 315
OperatorKeyboard 414
Option34MCNRange 711
Optionnumbers
EJoption60 1082
EJoption61 1082,1085
Enhancedconfigurationparametersloadoptions
Option0(cameracontrol) 72
Option1(ready/supply/amountbuffer) 1017
Option12(specificcommandreject) 78,1017
Option15(transactionstatusinformation) 78,1017
Option16(journalprinterbackuptime) 78,1017,1130
Option 17 (journal printer backup print operations) 78, 1017,
1130
Option2(autovoice) 77,1017
Option22(journalprinterbackuplogtamper) 995
Option23(envelopedispenserstatus) 79,9114,1017
Option24(enhancedTI/sensorstatus) 79,1017
Option25(mediaentry/exitindicatorsflashrate) 710,1017
Option27(remoterelay) 710,1017
Option3(dateformat) 77,1017
Option33(simulatesupervisormodeentry/exit) 711,1018
Option34(MCNrange) 711,1018
Option35(reportdualmodeEJ) 712,997,1018
Option36(enhancedEJbackup) 712,1018
Option37(printtrack2tojournal) 712,1018
Option4(rollwidth) 77,1017
Option44(BNAjournalnotescount) 713
Option44(BNAjournalvaultednotescount) 1018
Option45(BNAmessagesettings) 96,9111,1018
Option45(BNAsettings) 713
Option46(MCRWECDsecurityjitter) 716,1018
Option48(barcodereader) 716,1018
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-9

Index

Option5(leftprintcolumn) 77,1017
Option69(EMVsmartcardextendedstatus) 716,1018
Option7(track1format) 78,1017
Option70(EMVsmartcard) 1018
Option76(cashhandlers) 717,1018
Option77(Cardlesstransactionsnextstate) 1018
Option77(nextstatenumber) 718,1018
Option78(GBRUvariantreporting) 718,1018
Option79(coindispenser) 719,95,1018
Option80(alphanumericstateentry) 719,1018
Option83(chequeprocessor) 719,1018

PAGDX 84
PANblock 117
PANDX 87
PANLN 88
PANPD 88
Paralleleject/dispenseandprint(fastcash)function 1069
PBFMT 812
PCKLN 85
PDCTB 89
PEKEY 89
PFIID 84
Physicalkeyboards 42
Picturecontrol 333
PIDDX 84
PINblocks
BANKSYS 116
ISOformat0(ANSI) 115
ISOformat3 116
PINentrystate 211
PINDX 810
PINPD 86
PLNDX 811
PMXPN 85
POFDX 89
Powerfailure(unsolicitedmessage) 985
PPDdefaultprint
Eightcharacteramountbuffer 54
Twelvecharacteramountbuffer 55
PRCNT 89
PreDialandNormaloptionsfordialup 133
Presetoperationcodebufferstate 215
Printimmediatefunction 1066
Printstatementandsetnextstatefunction 1071
Printtrack2tojournal(option37) 1018
Printerdata
Charactersets 519
PPDdefaultprint 54
Printercontrolcharacters 56
PrintertypessupportedbyAdvanceNDC 52
Simulatedpreprintedreceiptmessages 524
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-10

APTRA Advance NDC, Reference Manual

Index

PSTDX 84

Readconditionvalues 28
Ready(B) 921
Ready/supply/amountbuffer(option1) 1017
Rearsettlementrestrictions 351
Receiptprinter(solicited/unsolicitedmessage) 992
Relateddocumentation
overview G1
RemotePINblock 114
Remoterelay(option27) 1017
ReportdualmodeEJ(option35) 997,1018
Reserved 727
Reservedparameters
ConfigurationParametersLoadmessage 75
Reservedscreens
Cardholderdisplay 36
Definition 34
Extendedscreencontrols 38
Graphicpictures 38
Logos 312
Supervisormenus 312
Typesof 35
Reservedscreensdefaulttext
AAcknowledgements A2
dDiagnostic A66
EErrors A4
iBNA A84
IInformation A17
iSettlement A89
iTCP/IP A68,A71
jMisc A92
MMenus A24
PPrompts A40
SInformationlines A46
TTrace A50
UEMVSmartCard A60
Reservedtimers
EnhancedConfigurationParametersLoadmessage 727
Rollwidth(option4) 1017
RSAencryptedDESkeyformat 1125
RSAinitialkeyloading 1118
Screens
Calculatingtouchscreenpositions 417
Customised 32
Definition 32
invalidcontrolsequenceinnamedisplay 320
Multilanguagescreens 347
Reserved 33
screenblinkingandcolourcontrol 327
Screendisplayconsiderations 349
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-11

Index

Screen/keyboarddataloadmessage 1010
specialfeatures 320
Securekeyentry 413
SecurePINEntry
Keyboards 49
Securityfeatures
BANKSYSPINblock 117
BAPEsecurity 112
EPPsecurity 113
Journalprinterbackup 1130
Keyverificationvalues 1117
Messageauthentication 1110
Full 1111
Selective 1113
Messageauthenticationcode(MAC) 1110
RemotePINblock 114
RSAinitialkeyloading 1118
Selectprimarycharacterset 331
Selectsecondarycharacterset 331
Sensors(unsolicitedmessage) 9100
Setnextstateandprintfunction 1066
Signatureformat 1125
Simulatesupervisormodeentry/exit(option33) 1018
Simulatedpreprintedreceiptmessages 524
SimulatorforAPTRA G6
Smartcardhandling 121
SmartFITCheckstate 286
SMSstyledataentry 229
Solicitedstatusmessages
Encryptorinitialisationdata 973
Exits 918
Fitnessdata 946
Hardwareconfigurationdata 940
Introduction 918
Localconfigurationoptiondigits 951
Ready(B) 921
SendconfigurationID 968
Sendconfigurationinformation 927
Senddate/timeinformation 967
Sendenhancedconfigurationinformation 950
Sendsupplycounters 953
Sendtallyinformation 966
SoftwareIDandreleasenumberdata 950
Specificcommandreject 923
Statusdescriptorfield 918
Statusinformationfield 918
Suppliesdata 944
Tamperandsensorstatusdata 948
Specialfeatures
Animation 342,344
Bunchchequeamountdisplay 337
Bunchchequecodelinedisplay 337
Bunchchequeimagedisplay 335
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-12

APTRA Advance NDC, Reference Manual

Index

Bunchchequevaluedisplay 338
Changingdisplayinidle 330
Digitalaudiocontrol 323
Displaydynamictextdictionary 339
Displayimagefilescontrol 334
Dynamictextdictionary
BunchChequeAcceptrefusereason 2118
BunchChequeAcceptrejectreason 2118
CashAcceptrefusereason 2104
Chequeacceptancestates 2129
Leftmargincontrol 332
Liftchequeimagecontrol 335
Logocontrol 333
Picturecontrol 333
Screenblinkingandcolourcontrol 327
Selectprimarycharacterset 331
Selectsecondarycharacterset 331
Setdisplaymodecontrol 332
Specificcommandreject 923
Specificcommandreject(option12) 1017
SSTtoCentraldialupmessages 134
Statenumbers 24
Statetables 22
Amountcheckstate 224
Amountentrystate 220
Barcodereaderstate 2143
BufferValidationstate 2140
BunchChequeAcceptstate 2113
BunchChequeHandlingstate 2120
Cameracontrolstate 253
CardreadPINentryinitiationstate 261
Cardreadstate 26
Cardwritestate 248
Cashacceptstate 293
Chequeacceptstate 2105
ChequeDetailDisplaystate 2124
Closestate 238
CustomerselectablePINstate 282
Devicefitness 266
DisplayChequeSummarystate 2130
EightFDKselectionfunctionstate 277
Enhancedamountentrystate 254,255
EnhancedPINentrystate 250
Envelopedispenserstate 214
ExitStates 285
ExpandedFITswitchstate 246
FDKinformationentrystate 274
FDKswitchstate 273
FITswitchstate 245
FourFDKselectionstate 218
Informationentrystate 228
Languagecodeswitchstate 258
Languageselectfromcardstate 272
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-13

Index

MasterExpansionstate 2112
PINentrystate 211
Presetoperationcodebufferstate 215
SmartFITCheckstate 286
Timeoutstate 2148
Transactionrequeststate 232
Typesof 23
Statetablesloadmessage 108
Statementprinter(solicited/unsolicitedmessage) 9106
Statementprintercontrols
Leftmargincontrol 522
Lines/inchcontrol 523
Margincontroluse 523
Rightmargincontrol 522
Statesandkeyboards 48
States,userwritten 21
Statusdescriptorfield 919,10861093
Supervisorkeys(unsolicitedmessage) 9103
Supervisormenusreservedscreens 312
Supervisormessages
Automaticscreenediting 64
Charactersets 62
Controlcodes 62
CRTlayout 63
Introduction 13
Mediastatusmessages 64
Printerlayout 64
Screensizelimitations 63
Testcashreport 64
Supportinformation lxxvii
Systemsetupfordialupconnections 132

Tamperandsensorstatusdatamessage 948
Terminal
Commandformat 102,1047
Howtheterminaloperates 12
Terminalcommands
Disconnectmessage 137
NoOpmessage 138
TerminaltoCentralmessages
EJUploadmessage 978
Transactionrequestmessage 92
Unsolicitedstatusmessages 981
Timeofdayclock(unsolicitedmessage) 984
Timeoutstate 2148
TimeOutStateentry(option71) 1018
Timers
adjustingforvoiceguidance 722
reservedinEnhancedConfigurationParametersLoadmessage 727
Timer00 2148,74,722,1018
Timer01 74,722,1018
Timer02 27,238,37,74,723,1019,1064,1067,1069,1070
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-14

APTRA Advance NDC, Reference Manual

Index

Timer03 232,74,723,1019
Timer04 2109,2148,74,1019,1063
Timer05 74,723,1019,1065,1068
Timer06 74,724,1019
Timer07 74,724,1019,1064,1065,1066,1068,1069,1070,1071
Timer08 2148,74,724,999,1019,1067
Timer09 27,238,240,74,724,1019,1064,1067,1070
Timer10 74,725,1065
Timer60 978,1082
Timer61 2148,74,725
Timer63 725
Timer68 74,725,1019
Timer69 74,725
Timer72 263,264,74,726,1019
Timer77 299,2104,74,726
Timer78 74
Timer87 2108,74,726,1019
Timer91 74,727
Timer92 74,726,1019
Timer94 242,2109,74,1020,1074,1075
Timer95 238,74,1020
Timer96 74,1020,1071
Timer97(unsupported) 74,728
Timersfordialup
Application 133
Modem 132
Timers,unsupported 727
TouchscreenFDKemulation
Amountentrystate 220
EightFDKselectionfunctionstate 277
FDKinformationentrystate 274
FourFDKselectionstate 218
Informationentrystate 228
PINentrystate 211
Timeoutstate 2150
Touchscreenkeyboards 42
Amountentrystate 220
EightFDKselectionfunctionstate 277
FDKinformationentrystate 274
FourFDKselectionfunctionstate 218
Informationentrystate 229
Resetconsiderations 350
Timeoutstate 2150
Unsolicitedmessage 9103
Track1format(option7) 1017
Track1namedisplay
ABAformatcards 320
Autoselectbackwardssearch 319
Autoselectforwardssearch 320
Formats 318
ISOformatcards 319
Namedisplay 320
VISAformatcards 319
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

APTRA Advance NDC, Reference Manual

Index-15

Index

TransactionCompletionoptionindialup 136
Transactionprocessingkeyboard 410
Transactionreplycommands
Interactivetransactionresponse 1077
Transactionreplyformat 1049
Transactionreplyfunctions
BNAencash 1073
BNAencash,printandsetnextstate 1073
BNArefundandsetnextstate 1072
Cardbeforecash 1067
Cardbeforeparalleldispenseandprint 1070
Depositandprint 1063
Dispenseandprint 1064
Displayandprint 1065
Nightsafedepositandprint 1067
Paralleleject/dispenseandprint(fastcash) 1069
Printimmediate 1066
Printstatementandsetnextstate 1071
Printstatementandwait 1071
Setnextstateandprint 1066
Transactionrequestmessage
Format 92
Introduction 92
Transactionrequeststate 232
Transactionstatusinformation(option15) 1017

V
X
Z

Unsolicitedstatusmessages
Conditionsforsending 981
Format 982
Unsupportedparameters
ConfigurationParametersLoadmessage 75
EnhancedConfigurationParametersLoadmessage 720
Unsupportedtimers 727
UploadEJData 978
Usingthepublication lxxiv
Voiceguidance,adjustingtimers 722
XFSSimulatorforAPTRA G6
z008InsertCardstate 2136

ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.

Index-16

APTRA Advance NDC, Reference Manual

Cut

UserFeedbackForm

Title:

APTRAAdvanceNDC,ReferenceManual

Number:

B0066180N000

Release: Issue1

Date:July2011

NCRwelcomesyourfeedbackonthispublication.Yourcommentscanbeofgreatvalueinhelpingusimprove
ourinformationproducts.
Youmaysendyourcommentstouselectronically.Seeoverfordetails.

Circlethenumbersbelowthatbestrepresentyouropinionofthispublication.
Easeofuse

Accuracy

Clarity

Completeness

Organisation

Appearance

Examples

Illustrations

Jobperformance

Questionresolution

Overallsatisfaction

5
4
3
2
1

=
=
=
=
=

Excellent
Good
Adequate
Fair
Poor

0 = Notapplicable

Indicatethewaysyoufeelwecouldimprovethispublication.

Improvethetableofcontents
Improvetheoverview/introduction
Improvetheorganisation
Improvetheindex

Makeitlesstechnical
Makeitmoreconcise/brief

Addmore/betterquickreferenceaids
Addmoreexamples
Addmoreillustrations
Addmorestepbystepprocedures

Addmoretroubleshootinginformation
Addmoredetail

Write any additional comments you may have below and on additional sheets, if necessary. Include page
numberswhereapplicable.

Usethefollowingaddressestosendyourcommentstouselectronically:
[email protected]
Cut

Web(withinfirewall)http://www.dundee.ncr.com/infoprod/rcomment/newform/webform99.htm
Fold

Ifwemaycontactyouconcerningyourcomments,pleasefillintheinformationbelow:
Name:
Organisation:
Company:
Address:

Phone:

Fax:

Thankyouforyourevaluationofthispublication.Foldtheformwhereindicated,tape(pleasedonotstaple),
anddropinthemail.
F87630695
Fold

Affix
Postage
Stamp
Here

NCR Financial Solutions Group Ltd.


Information Solutions Feedback
Discovery Centre
3 Fulton Road
Dundee, Scotland
DD2 4SW

You might also like