B 66180

APTRAAdvanceNDC
ReferenceManual
B0066180P000
Issue1
January2013
ConfidentialandproprietaryinformationofNCR.
Unauthoriseduse,reproductionand/ordistributionisstrictlyprohibited.
TheproductdescribedinthisbookisalicensedproductofNCRCorporation.
NCR,APTRAandSelfServaretrademarksofNCRCorporation.
Microsoft,WindowsandActiveXareregisteredtrademarksofMicrosoftCorporationintheUnitedStatesand/orother
countries.
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
20002013
ByNCRCorporation
Duluth,GeorgiaU.S.A.
AllRightsReserved
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.
APTRA Advance NDC, Reference Manual
iii
Federal Communications Commission (FCC) Radio Frequency Interference Statement
iv
Revision Record
RevisionRecord
Date
Page
Jan2013
Description of Change
NewrevisionforAdvanceNDC4.02
lviii
Addedsectiononthetermsusedtodescribecash
acceptors
24
Addedstatesz010,z013,z014andz017tothe
standardstatetypes
25
Addedsectiononscreennumberparametersin
statetables,withtherangeupdatedfrom000999
to000Z99
221
Addedacrossreferencetostatez017ifamount
entryistobeaccompaniedbynotemixselection
229,230 Addedthattheparametersdefinedintableentry9
and232
oftheInformationEntrystatecanbeoverriddenby
alocalXMLfile
236
IntheInteractiveTransactionRequeststate,added
bitvaluestotableentry6,SendOptionalData,for
notetypecountsofcounterfeitandsuspectnotes
239
Describedhowreceiptsofdifferentlengthare
handled
240
AddedanoteonwhytheReceiptDeliveredScreen
isnotdisplayed
242,245
Minoramendmentstotableentries
244
Addedthatthesettingofextensionstateentry8is
ignoredifretracttoescrowhasoccurred
244
Addedthatifreturnednotesaretakenlate,after
theretractoperationhasstarted,now7messageis
sent
262
RestructuredtheinformationasPINentry
initiationisnowoptional
263
ClarifiedhowPINentryishandledthroughuseof
thelengthparametersintheFIT
265
AddedthatifthePINentryscreenisnotrequired,
extensiontableentry2mustbesetto000
Date
Page
273,279, Addedinformationonlanguageselectionduring
voiceguidedsessions
274
Addedinformationonextendedscreengroupsize
andmultilanguagescreens
283,294
Addedinformationonextendedscreenbasesize
andmultilanguagescreens
297
AddednoteexplainingAdvanceNDCbehaviour
whenrejectednotesaretakenastheretract
operationstarts
2105
AddedthatifECB6supportisenabled,Enhanced
Configurationoption45mustbesettoallowmore
than90notes
2144
Addedstatez017totheexamplesofstatesthat
requiredataentry
2145
Amendedexampleruleset
2147
Addedstatez010,LocalCashDispense,forlocal
cashdispensing
2154
Addedastatetohandledatacopyingand
comparison
2154
Addedstatez013,DataCopyandCompareto
validatedatalocallywithouthostinteraction
2158
Addedstatez014,CashDepositHandlingto
handleofflinedepositandrefundoperationsfor
cashintransactionswithouthostinteraction
2161
Addedz017,NoteMixSelectionstate,tohandle
amountentryallowingtheconsumertoselectnote
denominationsforthecashtobedispensed
33
Updateddescriptionofscreengroups
34
Addednotetoemphasisethatconsumerscreens
mustnotbedefinedinresrvd.def
310
Addednotethatthereceipttopmarginregistry
entrywillbeoverriddenifsetthroughthe
Supervisor
333
ClarifiedthatthePCXfileformatisnotsupported
andexplainedhowlegacygraphicsfilesare
handled
335
Addedthatthedisplayofchequeimagesforboth
singleandbunchedchequescanbecontrolled
locally
vi
Date
Page
338
Addeddetailsofconfigurableformatforthe
displayofbunchchequeamounts
345
Clarifiedhowcurrencyamountsaredisplayed
348
Updatedexamplesformultilanguagescreens
352
AddedinformationabouttheuseoftheSWFfile
formatonSSTs
537
Addedatablenotethattheregistryentryforthe
firstlinepositionprintercontrolisoverriddenby
anyvalidvalueenteredusingtheReceiptTop
MarginoptioninSupervisor
76,722
AddedsectionsforEnhancedConfigurationoption
01andfieldk
77
optioncodes003and004asnotsupportedfor
EnhancedConfigurationoption03
711
Addedbitvaluesforadditionalconfigurationfor
TREP/ITRhandling
713
Clarifiedthattheprintformatforjournalingtrack2
carddataisdefinedusingreservedscreent15
714
AddeddetailsofEnhancedConfigurationoption
41
715
Updatednoteintabletoindicatethatnumberof
notesmustbesettomorethan90ifECB6support
isenabled
719
AddedthatEnhancedConfigurationoption77
doesnotrequiretheSSTtoberestarted
726
UpdatedthedefaultvalueforTimer6to204
seconds.
726
RestructuredTimer7,Note2forreadability
93
AddedITRandEnhancedConfigurationoption34
detailstofieldgdescriptionforreplymessage
handling
95
AddedacrossreferenceandTableNote6onthe
treatmentoftheLastTransactioncountsfollowing
apowerfailure
95
Inthetableentryforfieldraddedcrossreference
toTableNote7explainingwhencoincountsare
reportedinLastTransactionStatusmessages
vii
Date
Page
910
InthemessageformatforTransactionRequests,
addeddetailsoftheoptionalfields(cc1tocc4and
cd1tocd4)toincludenotetypecountsforECB6
compliantinstitutions(suspectandcounterfeit
notes)
910
Providedfurtherinformationforcb2andcb3fields
923,924
Addedsectionsonsubfieldg3toclarifycassette
mappingforrecycling
925
UpdatedthevalidCIMNDCcassettetyperange
925
Updatedtoindicaterejectednotescountis
returnedinReadyBmessage
927
AddedSpecificCommandReject11foraninvalid
dispensemix
929
ClarifiedthatSpecificCommandRejectE01
indicatesthatthefunctionisnotsupportedbythe
software
935,944
AddedSelfServ14tothelistofproductclasses
950
movedtablenotecrossreferencefromfieldg4for
valuesGS,DIGandTamperStatusasthesefields
areoptionalAddedatablenotecrossreferenceto
thevaluesforfieldg5
959
UpdatedTableNote64toclarifythatitapplies
onlytobasicmessageGSfields
959
Addedanexampleofmessageanalysisfora
solicitedstatusmessage
965
Increasednumberofcharactersforfieldg48from1
to5
989
Addeddetailsoftheextrafieldsusedtoinclude
trackdatawhenacardisretracted
994
Clarifiedthereportingofarecyclingcassettethat
hasbeenreplenishedduringadeposittransaction
996
Addedconfigurationinformationtoreportreceipt
capturebinstatusinreceiptprinterstatus
messages
9106
Addedthatbyte8inasensorsunsolicitedstatus
messagealwaysreturnsavalueof0
9113
Addeddetailsofthenotecountsreturnedinstatus
messagesfornoteacceptors
viii
Date
Page
9114
Addeddescriptionofascenariowhenan
unsolicitedmessagereportsthatcountsmaybe
inaccurate
9114
Addedexplanationofhowdirectdepositand
escrowdepositcountsarereportedinunsolicited
ECB6messages
9115
AddedcrossreferenceandTableNote113for
refundednotestakenlate
9115to
9116
Addedcashacceptortransactionerrorcodesthat
areusedonlyinlegacysoftwareimplementations
(2,9andAtoD)
9115
AddedcrossreferenceandTableNote111forw3
messagenotsent
9115
AddedcrossreferenceandTableNote112thatif
notesareretractedtotheescrow,thecashacceptor
willbereportedasfatal
9115
AddedcrossreferenceandTableNote113forw7
messagenotsent
1042
Addeddetailsofencryptionkeydatafor
certificates
1043
UpdatedthetablenoteformodifiersC,D,and
Etoincludedetailsofthedataandalgorithm
usedforthekeydata.Addthatallofthedata
returnedintheSSTrandomnumbermustbeused.
1057
UpdatedfieldpCardReturn/RetainFlag,for
dispenseanddepositoperationsduringvaluable
mediaexchange
1061
AddedthatbufferSisreservedforinternaluse
1065
AddedfunctionIDsb,DispenseCashFirst
DuringValuableMediaExchange,andf,Deposit
MediaFirstDuringValuableMediaExchange
1075
AddedTableNote93forrefundednotestakenlate
1076,1077 UpdatedthenamesofthefunctionIDtablesforthe
andfunctionidentifiersintheTransaction
Reply
1077
UpdatedtheProcessChequefunctionfor
endorsementonsinglechequeacceptors
1078
AddedtableforfunctionIDb,DispenseCash
FirstDuringValuableMediaExchange
ix
Date
Page
1082
AddedtableforfunctionIDf,DepositMediaFirst
DuringValuableMediaExchange
1087,
1096
AddeddetailsoftheMCNinITRs
1096
AddedincompleteITRasanexampleofSpecific
CommandRejectA02
10102
AddedtostatusqualifierE01thattherequested
actionisnotsupportedbythesoftware
1121to
1128
Updatedallsectionstoincludemoreinformation
aboutenhancedsignatureremotekeyload.
1133to
1136
AddeddetailsofRSAinitialkeyloadfor
certificates
A1
Improvedtheintroductiontothereservedscreens
andaddedinformationonformattingusedfor
dynamic.NETdata
A14,A23, Addednewscreens(E1910,I45andj0021toj0058)
A98to
forenabling/disablingcardlessfunctionality
A100
A19
UpdatedscreenI10toshowsixdigitsforKVVs
A22
Addedscreenusedtoidentifycashhandler2with
separatedcounters
A26
Addedoptions52and60totheSupervisor
Replenishmenu(M07)
A28
Addedoption20totheTCP/IPConfiguration
menu(m00)fortheInternetprotocolversion
A29
Updatedscreenm02toincludetheBNACASS
CFGoption
A29,A38 AddedsoftwareupdateoptiontotheSupervisor
MiscFuncsmenu(m05)andnewmenu(m48)
A38
Addedtheupdateserviceprovidercashunit
identifierscreen(m50)
A39
Addedtheupdatecashunitidentifierscreen(m51)
A40
Addednewscreen(m57)forIPversion
configuration
A41
Addedscreenm64forseparatedcountersinthe
ClearCashoptionandscreenm65forseparated
countersintheStandardCashoption
A48
Addedtheupdatecashunitidentifierscreen(p65)
Date
Page
A68
AddedscreenU0167tojournalthatthelimithas
beenreachedforthenumberoftimesnote
insertioncanbeattempted
A68
Addednewjournalscreens(U0168toU0170)used
torecordofflineprinting
A68
AddedscreensU0171andU0172usedwhennotes
aredetectedintheescrowandretracted
A68
Addednewjournalscreens(U0300toU0303)to
recordtimeoutsandcardholdercancel
A90
Updatedtheupdatenotetypescreen(i37)
A91
Updatedthecashacceptorcountsscreen(i43)
A91
Updatedthecassettemappingscreen(i92)
A99
Addedscreenj0026tojournalthatthelast
dispensednotecountsareunknown
A99
Addedscreensj0027toj0032usedtojournalcash
counts
A99
Addedscreenj033tojournaltheoperationcode
(OpCode)andupdatedchaptertitle
A100
Addedjournalingscreensj0040toj0058forlocal
cashdispensingtransactions
A102
Addedscreensj4055toj4061fortheCashDeposit
Handlingstate
D2
AddedTableNote1toTableNote3toexplainthe
formattingconventionsusedintheappendixanda
crossreferencetodetailsoftheITR,Encryption
KeyChangeandExtendedEncryptionKeyChange
D9
AddedtheinformationidentifierstotheEncryptor
InitialisationDatamessage
D18
Updatedtoaddvaluesbandftofunctionl
(letterell)
D20
AddedthatbufferSisreservedforinternaluse
E5,E25, UpdatedvaluesreturnedforTIBINS(Alarms)
E29
(DIGP)
E15
UpdatedTableNote6toaddconfiguration
informationforsuppliesstatusreportingofthe
capturebinforthereceiptprinter(DIGG)
xi
Date
Page
E20,E23 UpdatedtableandTableNote13toadd
configurationinformationforfitnessstatus
reportingofthecardholderdisplay(DIGS)
E23
UpdatedTableNote12toaddconfiguration
informationforfitnessstatusreportingofthe
capturebinforthereceiptprinter(DIGG)
E28
UpdatedTableNote21andTableNote22for
recyclersandretract/rejectcassettes(cashhandler
DIGsdande)
Glossary
AddedEEKC,EID,encryptioncertificate,HSM,
RKM,screenbase,screengroupandverification
certificate
Updateddefinitionsforallcashacceptorterms
Jul2011
243
AddedinformationaboutscreenU0088forcheque
ejectfailure
244
UpdatedtheClosestatefordirectdeposits
298,2100, UpdatedtheCashAcceptstatefordirectdeposits
2102,
2104,2105
299
Removedunsupportedstatementasselectionof
theAddMoreNotesFDKisnowjournaled
2104
ClarifiedtheCounterfeitNotesRetainedScreen
tableentryintheCashAcceptstate
2106
Updatedtheinformationabouttheconfirmation
screenintheCashAcceptstate
2121
Updatedfield7oftablez001BunchCheque
AcceptState
2173
UpdatedtheTimeOutstate
311
AddedreferencetoXFSonlinedocumentfor
controlsequencesforUSBprinters
714
Addedthatmorethan90notesmustbeacceptedif
theSSTisconfiguredfordirectdepositmode
719
ClarifiedthedescriptionofEnhanced
Configurationoption76
722
ClarifiedOptionCode001and002ofOption83
ChequeProcessor
727
Updatedthedescriptionofthedefaultvalueof
timer63
xii
Date
Page
728
Timer78updatedasitnowappliesonany
hardware
94
AddedtablenotecrossreferenceforFSpreceding
fieldsoandqinTransactionRequestMessage
Formattable
910
Updatedtheca3fieldoftheTransactionRequest
messagefordirectdeposits
933
BNAandCPM,addedcrossreferencestotable
noteexplainingwhentheirdetailsarereturnedin
configurationinformation
935
AddedproductclassesforSelfServ16,SelfServ42,
SelfServ4andSelfServ8
937
tablenoteaddedfordoublelengthrestrictedentry
mode
940
Addedsinglenoteacceptorvarianttothe
hardwareconfigurationsubfield
980
Amendeddetailsofthefieldsforinformation
identifierEinsolicitedEncryptorInitialisation
Datamessages
986
Addedfielde6inUnsolicitedStatus:Status
InformationFieldtable
9105
UpdatedinformationforSupervisormodeentry
andexitstatusmessages(P20andP21)
9113
UpdatedtheBunchNoteAcceptorstatusmessage
forECB6support
9118
Addedthatdepositednotesarereportedasescrow
countsregardlessoftheirphysicalposition.
1038
Addedthatthehostmustensurethatanyrequired
ExtendedEncryptionKeyChangemessagesare
sent
1061
Addedthatsmartcarddataotherthan
EMV/CAM2specificdatamaybereturnedinfield
at2
1075,1077 Updatedthecashacceptorterminalfunctionsfor
directdeposits
1090
Updatedfieldj1andaddedfieldj2intable
InteractiveTransactionResponse
1138
Addeddetailsoferrorifanattemptismadeto
importakeythatisalreadyloaded
xiii
Date
Page
A8,A9, UpdatedscreenstouseFOURTHinsteadofBOTTOM
A31,A49, incassettedescriptions
A53
A26
RemoveddetailsofscreenM03asithasbeen
replacedbyscreenm03.
A48
Addedscreenp64forSupervisormodechange
message
A52,A57, Addedscreenss40,t09andt91for5thcassette
A61
handlingforTI
A58
Updatedthescreenjournaledwhentheescrow
becomesfull
A58
Updatedthescreenusedtorecordanerrorduring
acashintransaction
A58
Updatedthescreenusedtorecordthefailureofthe
notetypeconfiguration
A64
AddedscreenU0088forchequeejectfailure
A64
RemovedscreensU0104andU0105astheyareno
longerused
A65
Addedandupdatedthescreensusedtojournal
failedsignaturesundertheECB6regulations
A65
Updatedthescreensusedwhenreadingserial
numbersfromnotes
A67
Addedscreensusedtojournalpointsinacash
deposittransaction
A66
Addedscreenusedtojournaltheselectionofthe
AddMoreNotesFDK
A66
Addedscreenusedtojournalnotesdetectedinthe
cashacceptorduringtheClosestate
A66
Addedscreenusedtojournalthatnotesare
detectedattheexitduringAERoncashacceptors
A67
Addedscreenusedtojournalsuspendcondition
handlingforcashacceptors
Addedscreenstojournalnotesidentifiedas
counterfeitorsuspectundertheECB6regulations
A67
Addedscreensforjournalingtheinsertionand
removalofBNAcassettes
A67
Addedscreensusedincashinextendedjournaling
xiv
Date
Page
A74
Addedscreensi39andi41forconfigurationof
SSLoptionalparameters
A91
Updatedscreeni92
A98
Addedscreensforjournalingretractnotesin
recyclingmode
C1
SuppliedgraphicshavePNGformat.
D20
Updatedfieldat2tobemoregeneric
E10
Addeddevicevariantforasinglenoteacceptor
Glossary4 Addeddirectdeposittotheglossary
Glossary5 Addedescrowdeposittotheglossary
Oct2010
All
Replacedallreferencestodeviceidentification
graphicwithdeviceidentifiergraphicasthe
fullformofDIGandalignedusageofthetermand
acronym
Chapter 1 Restructuredfollowingtheremovalofconceptual
information,includingtherelocationof
informationonclearingpersistentmemoryand
SNMPtrapstotheDevelopersGuide
Chapter 2 StandardizedreferencestoEMVandEMV/CAM2
23
RemovedUfromthelistofreservedstatesasitis
nowusedfortheDeviceFitnessFlowControlState
25
AddedinformationontheuseofExtensionStates
28
Addedinformationabouterrorhandingwhena
cardjamoccurs
212
RemovedthenoteabouttouchFDKsclearingthe
PINbufferasitdoesnotapply
215
AddedthatAdvanceNDCdoesnotattemptto
dispenseenvelopesunlessenvelopesarepresentin
theenvelopedispenser
230
Addedexplanationofwhathappenswhengeneral
purposebufferBdataexceedsthelimitduringthe
InformationEntrystate
237
UpdateddescriptionofEMV/CAM2processing
flaganditsvalues
242
Addedautomaticerrorrecoveryinformationfor
cashacceptorrecovery
xv
Date
Page
244
Addedthatacardholdercancellationoratimeout
duringatransactioninvolvingmorethanacash
depositisjournaledduringtheClosestate
267
AddeddetailsoftheDeviceFitnessFlowControl
State
296
AddedthatreservedscreenU0128isjournaled
whenAddMoreisselectedduringcashacceptance
(unsupportedinAdvanceNDC4.00)
2103
RemovednotefromtheDeviceErrorNextState
tableentry,asallrelevantinformationisincluded
inthetable
AddednoteonfunctionalityifCancelisselected
afterAddMoreNotes
2106
Updatedthedescriptionofthebasicconfirmation
screensasreservedscreensarenolongerused
2121
UpdatedtheCancelNextStateNumberand
TimeoutNextStateNumberfieldsfortheBunch
ChequeState
2140
Addeddetailsofz008InsertCardState
2144
Addeddetailsofz009BufferValidationstate
311
NotedthatchangestothedefaultvalueofSetFirst
LinePositionmustbeamultipleof18
342,343
Addeddetailsofcontrolsfordynamicbuttonsand
dynamictextdefinition
344
Updateddetailsofsupportformultimediafile
formats
352
Updateddetailsofsupportforimagefiles
43
Addedthatabeepcanbeconfiguredforemulated
FDKs
45to47
UpdatedTable42toclarifythephysicallayout
andCENXFSliteralkeys.UpdatedTable43to
clarifyitisthekeycodewhichisaltered.Added
clarificationthatifakeyboarddoesnotenablethe
requirednumberofkeysthedefaultkeyboardis
used.CompletelyupdatedtheKeyboardMapping
examplestoshowthemessagecontentsandFDK
keysreassignments
414
Addeddetailsontheremappingofkeyboard
layoutsforsecurekeyentry
54,55
Amendeddetailsofdateformat
xvi
Date
Page
533
RemovedreferencetoTableNote17fromSetFirst
LinePositionControlCodeasthisinformationwas
incorrect
534
AddedthattheCHEQUEregistryentryisthesame
regardlessofprintertype
79
Removedmentionofremotestatusindicatorand
remoterelaycontrolfromEnhancedConfiguration
option23asitonlycontrolsthesendingof
envelopedispensermessages
79
Updatedinformationforvalue002intable
Enhanced/TISensorStatusUnsolicitedMessage
Values
718
StandardisedreferencestoEMV/CAM2and
removeddetailsofEnhancedConfigurationoption
70asitisnotsupportedinAdvanceNDC
719
ClarifieduseofEnhancedConfigurationoption77
721
Addedthatforoption80,theEnhanced
ConfigurationLoadParametersmessageshouldbe
sentbeforetheStateTablesLoadmessage
725
Amendedusageoftimer05
726
Addedfurtherinformationabouttheuseoftimer
07
95
Addedcrossreferenceinfieldrandupdateddata
detailsforLastTransactionStatusData
912
Updatedfieldcg2andaddedatablenote
crossreference
914
Addedatablenotecrossreferenceforfieldso
andpandtheprecedingfieldseparator
914
Clarifieduseofthefieldseparator
916
Addeddetailstotablenoteofmessagefieldsent
whenallchequesaretobereturnedtothe
cardholder
919
Addednoteexplainingwhathappenswhen
generalpurposebufferBdataexceedsthelimit
duringaninteractivetransactionresponse
931
Amendedtablenoteonmessagemodeoptions
931
Addedthatthedeviceandmodulefitnessdata
returnedinsubfieldg3providesanoverallview
ofthestateoftheSST
xvii
Date
Page
933
Addedthatthejournalprinterwillbereportedas
fatalifitrunsoutofpaper,evenindualmode
937
AddedinformationonthereportingofRestricted
Mode
940,E9
AddednewvariantsfortheBNAandcheque
processorDIG
952
AddedasectionfortheEnhancedConfiguration
Datasolicitedmessagetoclarifythecontentwhen
commandcode7issentwithacommandmodifier
of6
974
Amendedthedescriptionofthestatusdataina
soliciteddevicefaultmessagereturnedforanEPP
977
UpdateddescriptionsforfieldsC,DandE.
979
AddedinformationonEPPVariableLengthSerial
NumberCapabilityandInformationIdentifierE.
994
Addedthatallcassettessupplystatusesare
reportedfollowingaretractoperation
996
Updatedfieldse3ande5oftableReceiptPrinter
Status
9101
ClarifiedthatanH0messageissentwhenthe
journalprinterpaperrunsout
9106and Addedbyte19forUnsolicitedSensorsmessage
9107
andupdatedstatementaboutExtendedTamper
Indicationdata
987to
9127
Clarifiedwhensolicitedandunsolicitedmessages
aresenttoreportdevicestatus
Chapter 10 StandardisedreferencestoEMVandEMV/CAM2.
RemovedsectiononhosttoExitmessages
1010and AddedadditionalTableNotestoexplainthe
1021
relationshipbetweenStateTablesLoadand
EnhancedConfigurationParametersLoad
messages
1012
Removedrestrictiononkeyboarddefinition
numbersinfieldj1asAdvanceNDConly
recognisesFDKmappings
1041
AddedinformationonmodifierU.
1043
AddeddescriptionintablenoteformodifierS,
T,UandV.
xviii
Date
Page
1055to
1058and
1065
UpdatedTransactionReplydescriptionfieldsm,
qandrforvoicedatadescriptionandaddeda
tablenotereference.
1070
Updatednotefortimer05functionality
1070
Updatednumberoflinesforacompletepagein
tableCardBeforeParallelDispenseandPrint.
1093
Updatedfielddasitisnow
mandatory;updateddetailsofresendingthelastEJ
datablock.
10106
Removedrowintable1040forBNARetrieveNote
Definitionscommandasthisisprocessedasa
ConfigurationInformationRequestcommand
113
UpdatedEPPinformation.Addedcrossreferences
totheAPTRAAdvanceNDC,MultiVendorSupport
ReferenceforothervendorsEPPinformation
1110
AmendedtheMACverificationformat,whichis
alwaysASCII
1121
ClarifiedthatRSAinitialkeyloadingissupported
onallSSTsthatcanrunAdvanceNDC
124
StandardisedreferencestoEMVandEMV/CAM2
A14
AmendedmessageE1902fromUNKNOWN
ERRORtoPOSSIBLEJAM
A19
UpdatedscreenI06forEJlevel
A26
RemovedscreensM10,M11,M13andM14asthe
cashincomponentisnolongerusingthemasbasic
confirmationscreens
A29,A35 Updatedreservedscreensm02andm38
A35,A37 Addedreservedscreensm36,m37andm45
A46
AddedreservedscreenP97
A48
AddedreservedscreenS29
A50
AddedreservedscreenS29
A58
Updatedscreenst15fromresrvd.def
A61
Addedreservedscreent90
A63
UpdatedscreensU0057,U0058,andU0059from
resrvd.def
A65A67, UpdatedscreensusedbytheCashIncomponent
A101
xix
Date
Page
A100
Addedreservedscreensj0020andj4032
A98
Addedreservedscreenj0021
B8
AmendedthepathfortheUniversalCharSets.txt
mappingfile
D6
Updateddescriptionoffieldcg2
D16
UpdateddescriptionsofmodifiersKandN,and
QtoV.
E3,E7
RemovedreferencestoBNAfromcashhandler
sectionoftable
E5
AddedBITs470(reservedalwayszero)
E6,E13, AddeddetailsofDIGXforthepassbookprinter
E21,E26
E19
UpdatedtableDeviceFitnessData;added
informationaboutDIGsandtheirfitnessdata.
E24
Updatedthemethodsusedtocalculatetheoverall
fitnessforacashacceptor
E27
Addedatablenoteonvalues010to020.
F2
Added25htothecodeconversiontable
xx
Table of Contents
Contents
Preface
Audience ...........................................................................................liii
HowtoUseThisPublication ................................................................liv
ContentsofthePublication ............................................................liv
RoadmaptothePublication ...........................................................lvi
NavigatingthePublication........................................................... lvii
ConventionsandAbbreviationsUsedinthePublication........ lvii
WhatElseShouldIRead?...............................................................lix
SupportInformation ............................................................................... lx
Chapter 1
IntroducingtheAdvanceNDCSystem
Overview ................................................................................................11
HowtheSSTOperates ..........................................................................12
CreatingtheCustomisationData........................................................14
RoleoftheCentralControlApplication ............................................15
Chapter 2
StateTables
Overview ................................................................................................21
IntroductiontoStateTables .................................................................22
InvalidStateHandling ...................................................................22
CustomisingStates..........................................................................22
UnsupportedStateTypes ..............................................................22
ReservedStates................................................................................23
ExitStates .........................................................................................23
StandardStateTypes......................................................................23
StateNumbers .................................................................................24
ScreenNumbers ..............................................................................25
ExtensionStates...............................................................................25
ACardReadState ...............................................................................27
xxi
Table of Contents
ReadConditionValues ..................................................................29
BPINEntryState...............................................................................212
CEnvelopeDispenserState.............................................................215
DPreSetOperationCodeBufferState ..........................................216
EFourFDKSelectionFunctionState .............................................219
FAmountEntryState .......................................................................221
VoiceGuidedSessionsandDataEntry .....................................221
StateProcessing.............................................................................221
BufferClearingandAppendBuffer.xml ........................................221
TouchScreenEmulation..............................................................221
GAmountCheckState .....................................................................224
HInformationEntryState................................................................229
DataEntry ......................................................................................229
ExitingtheInformationEntryState ...........................................229
ClearFunctionKeyandGeneralPurposeBuffers...................230
ITransactionRequestState..............................................................233
JCloseState ........................................................................................239
FunctionOperations .....................................................................239
KFITSwitchState .............................................................................246
_ExpandedFITSwitchState ...........................................................247
LCardWriteState.............................................................................249
MEnhancedPINEntryState...........................................................251
NCameraControlState ...................................................................254
REnhancedAmountEntryState ....................................................256
SLanguageCodeSwitchState ........................................................259
TCardReadPINEntryInitiationState .......................................262
PINEntryEnabled ........................................................................263
PINEntryDisabled.......................................................................263
AudioSupport...............................................................................263
SmartDipCardReader ................................................................263
UDeviceFitnessFlowSelectState.................................................267
SupportedDevices ........................................................................269
VLanguageSelectFromCardState ...............................................273
WFDKSwitchState..........................................................................275
XFDKInformationEntryState .......................................................276
YEightFDKSelectionFunctionState ............................................279
LanguageSelectioninVoiceGuidedSessions .........................279
bCustomerSelectablePINState.....................................................284
d...gandzExitStates ......................................................................287
kSmartFITCheckState ...................................................................288
mPIN&LanguageSelectState.......................................................289
ConsiderationsforVoiceGuidedSessions ...............................290
xxii
Table of Contents
>CashAcceptState...........................................................................296
ConfirmationScreen...................................................................2106
DynamicTextDefinitions..........................................................2107
wChequeAcceptState...................................................................2109
zMasterExpansionState ..............................................................2116
z001BunchChequeAcceptState .................................................2117
DefiningDynamicTextforChequeRejection ........................2122
DefiningDynamicTextforChequeRefusal ...........................2122
z002BunchChequeHandlingState ............................................2124
z003ChequeDetailDisplayState ................................................2128
DefiningDynamicDataforChequeDepositStatus ..............2133
z004DisplayChequeSummaryState..........................................2134
CurrentChequeIndex................................................................2135
z008InsertCardState ....................................................................2140
z009BufferValidationState..........................................................2144
DateValidationScenario ...........................................................2145
z010LocalCashDispenseState....................................................2147
CardlessTransactions.................................................................2147
DispenseFunctionality...............................................................2147
ForeignCurrencyExchangeTransactions...............................2147
StateFlowafteraSuccessfulDispense ....................................2147
StateFlowafteraShortDispense .............................................2148
StateFlowafteraFailedDispense............................................2148
StateFlowafteranUnknownDispense ..................................2149
StateFlowonCardEjection ......................................................2149
StateOperation............................................................................2149
MessageHandling ......................................................................2151
z013DataCopyandCompareState ............................................2154
CopyOperations .........................................................................2156
CompareOperations ..................................................................2157
z014CashDepositHandlingState...............................................2158
z017NoteMixSelectionState ........................................................2161
&BarcodeReadState .....................................................................2168
TimeOutState ...................................................................................2173
Chapter 3
ScreenData
Overview ................................................................................................31
TheScreenInterface ..............................................................................32
CustomerScreens............................................................................32
ReservedScreens.............................................................................34
xxiii
Table of Contents
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 ....................................345
MultiLanguageScreens .....................................................................348
MultiLanguageScreenNumbering ..........................................348
RedefiningReservedScreens ......................................................351
DisplayingPictures .............................................................................352
PictureResolution .........................................................................352
GuidelinesforPictures.................................................................352
ScreenReset ..........................................................................................353
SupervisorSettlementScreens...........................................................354
UsingtheFrontorRearInterfaceforSettlement .....................354
SupervisorSettlementTransactions ...........................................355
TransactionsParameterScreens(C09C19) ..............................356
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
xxiv
Table of Contents
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.......................................................................................520
StatementPrinterControls.................................................................523
LeftMarginControl......................................................................523
RightMarginControl ...................................................................523
MarginControlUse ......................................................................524
LinesPerInchControl..................................................................524
SimulatedPreprintedReceiptMessages ........................................525
PrintingImagesUsingScreensR00andR01........................525
OtherUsesofScreensR00andR01 .......................................526
SidewaysPrintingonReceipt............................................................529
UnsupportedFunctions ...............................................................529
PrinterControlSequencesandRegistrySettings ...........................530
Chapter 6
SupervisorMessages
Overview ................................................................................................61
SupervisorMessages.............................................................................62
CharacterSets ..................................................................................62
ControlCodes..................................................................................62
ScreenSizeLimitations ..................................................................63
CardholderScreen/EnhancedOperatorInterfaceLayout .......63
PrinterLayout..................................................................................64
AutomaticScreenEditing..............................................................64
MediaStatusMessages ..................................................................64
xxv
Table of Contents
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
Option01SupplyMode,ReadyStatus,&AmountBuffer
Length.............................................................................................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 ......................................................................................713
Option36EnhancedEJBackup ...............................................713
Option37PrintTrack2toJournal...........................................713
Option41SendTrackDetailsonCardRetract......................714
Option44BNAJournalNotesCount......................................714
xxvi
Table of Contents
Option45BNASettings ............................................................714
Option46MCRWEnhancedCardDeviceSecurityJitter ....717
Option48BarcodeReader ........................................................717
Option69EMVSmartCardExtendedStatus........................718
Option70EMVSmartCard .....................................................718
Option71TimeOutStateEntry ..............................................718
Option74DestinationforCashDepositRetract ...................718
Option76CashHandlers..........................................................719
Option77NextStateNumber..................................................719
Option78GBRUMStatusReporting.....................................720
Option79CoinDispenser.........................................................721
Option80AlphanumericStateEntry......................................721
Option83ChequeProcessor ....................................................721
TimerNumberFieldk ............................................................722
NumberofSecondsperTimerFieldFieldl.........................722
UnsupportedParameters.............................................................722
Timers....................................................................................................724
TimeUnitsforTimers ..................................................................724
TimerDescriptions .......................................................................724
ReservedTimers............................................................................729
UnsupportedTimers ....................................................................730
Chapter 8
FinancialInstitutionTables
Overview ................................................................................................81
FITData...................................................................................................82
FITFields..........................................................................................83
LinkedFITs...........................................................................................812
Chapter 9
TerminaltoCentralMessages
Overview ................................................................................................91
TransactionRequestMessages ............................................................92
TransactionRequestMessageFormat .........................................92
SSTReplytoInteractiveTransactionResponse .......................919
SolicitedStatusMessages ...................................................................920
ContentofSolicitedStatusMessages.........................................920
StatusInformation ........................................................................922
SolicitedDeviceFaultStatus..............................................................972
DeviceFaultStatusResponses....................................................972
xxvii
Table of Contents
DeviceFaultStatusInformationField .......................................973
OtherSolicitedMessages....................................................................976
EncryptorInitialisationData .......................................................976
UploadEJDataMessage..............................................................981
UnsolicitedStatusMessages ..............................................................984
ConditionsforSendingUnsolicitedMessages .........................984
UnsolicitedStatusInformationField .........................................985
DeviceStatusInformation..................................................................987
TimeOfDayClock(Unsolicited)...............................................987
PowerFailure(Unsolicited).........................................................987
CardReader/Writer(Solicited/Unsolicited)..............................988
CashHandler(Solicited/Unsolicited) ........................................990
Depository(Solicited/Unsolicited) .............................................995
ReceiptPrinter(Solicited/Unsolicited).......................................996
JournalPrinter(Unsolicited) .......................................................997
ElectronicJournalPrinter(Unsolicited).....................................999
NightSafeDepository(Solicited/Unsolicited)........................9102
Encryptor(Unsolicited)..............................................................9103
Camera(Unsolicited)..................................................................9104
Sensors(Unsolicited) ..................................................................9105
TouchScreenKeyboard(Unsolicited) .....................................9107
SupervisorKeys(Unsolicited)...................................................9108
CardholderDisplayAlarm(Unsolicited) ................................9110
StatementPrinter(Solicited/Unsolicited) ................................9110
VoiceGuidance(Unsolicited)....................................................9112
NoteAcceptor(Solicited/Unsolicited) .....................................9113
EnvelopeDispenser(Unsolicited) ............................................9120
ChequeProcessor(Solicited/Unsolicited) ...............................9121
CoinDispenser(Solicited/Unsolicited)....................................9125
BarcodeReader(Unsolicited)....................................................9127
Chapter 10
CentraltoTerminalMessages
Overview ..............................................................................................101
CommandLimitations ........................................................................102
TerminalCommandLimitations ................................................102
CustomisationDataCommandLimitations .............................102
EMVMessageClassSupport ......................................................102
TerminalCommands ..........................................................................103
CustomisationDataCommands .......................................................107
StateTablesLoad .................................................................................109
xxviii
Table of Contents
Screen/KeyboardDataLoad ............................................................1011
ManagingKeyboardsandAssociations ..................................1013
ConfigurationParametersLoad......................................................1015
EnhancedConfigurationParametersLoad ...................................1017
FITDataLoad ....................................................................................1022
ConfigurationIDNumberLoad .....................................................1024
MessageAuthenticationFieldSelectionLoad ..............................1026
DateandTimeLoad..........................................................................1033
EncryptionKeyChange....................................................................1034
ExtendedEncryptionKeyChange..................................................1037
DispenserCurrencyCassetteMappingTable...............................1045
XMLConfigurationDownload .......................................................1048
TransactionReplyCommand..........................................................1051
TerminalFunctionsforTransactionCompletion ...................1065
InteractiveTransactionResponse ...................................................1086
SupportforTouchScreenEmulation ......................................1086
SupportforVoiceGuidedSessions .........................................1086
MessageCoordinationNumber(MCN)..................................1087
EJCommands.....................................................................................1091
EJOptionsandTimers ...............................................................1091
AcknowledgeEJUploadBlock.................................................1092
AcknowledgeandStopEJ .........................................................1093
ContinuousandBatchUploadMethods .................................1094
MessageValidation ...........................................................................1096
ValidMessageClasses ...............................................................1096
CommandRejectCauses ...........................................................1096
OtherInvalidParameters ........................................................10102
MessagesReceivedinWrongOperationalMode.......................10104
CustomisationDataCommands.............................................10104
TransactionReplyCommand .................................................10105
TerminalCommands................................................................10106
Chapter 11
SecurityFeatures
Overview ..............................................................................................111
BAPESecurity ......................................................................................112
EPPSecurity .........................................................................................113
RemotePINBlock................................................................................114
FITFields........................................................................................114
PINBlockFormats ........................................................................114
PINBlockEncryption...................................................................118
xxix
Table of Contents
MessageAuthentication ...................................................................1110
MessageAuthenticationCode ..................................................1110
FullMessageAuthentication.....................................................1112
SelectiveMessageAuthentication ............................................1113
UsingSelectiveMessageAuthentication.................................1116
KeyVerificationValues ....................................................................1117
DeterminingEncryptorKeyStatus ..........................................1117
RSAInitialKeyLoading...................................................................1118
IdentifyEPPandDetermineEPPCapabilities .......................1118
RSAInitialKeyLoadingforSignatures .........................................1121
EPPAuthenticationProcess ......................................................1121
LoadingInitialDESKeys...........................................................1126
RSAEncryptedDESKeyFormat..............................................1129
SignatureFormat.........................................................................1130
Base94EncodingandDecoding...............................................1130
ChangingtheEncryptionKeyEntryMode.............................1132
RSAInitialKeyLoadingforCertificates........................................1133
ExchangeCertificates .................................................................1133
LoadaDESKeyforCertificates................................................1135
ReplaceaCertificate ...................................................................1135
PrimaryandSecondaryKeys ....................................................1136
DoubleLengthKeys .........................................................................1137
GeneralGuidelines .....................................................................1137
AdvanceNDCGuidelines .........................................................1137
DoubleLengthRestrictedKeyEntryMode..........................1138
JournalPrinterBackup .....................................................................1139
Chapter 12
EMVSmartCardHandling
Overview ..............................................................................................121
AcceptingandReadingCards ...........................................................122
MotorisedReaders ........................................................................122
DIPReaders ...................................................................................122
ReadConditionsandFITMatch.................................................122
UsingEMV/CAM2ExitsforAdvanceNDC....................................124
ExampleChipDataReadState ...................................................126
GuidelinesforHandlingSmartCardTransactions .................126
xxx
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
ScreenContent................................................................................A1
UnderstandingtheTables.............................................................A1
ASupervisorAcknowledgements ...................................................A3
EErrorScreens....................................................................................A5
ISupervisorInformation.................................................................A18
MandmSupervisorMenus .........................................................A25
PSupervisorPrompts......................................................................A43
SSupervisorInformationLines .....................................................A49
TandtJournalTraceInformation ...............................................A53
UCheque,EMVSmartCardandBNA.........................................A63
dSupervisorDiagnosticScreens....................................................A70
iSupervisorTCP/IP..........................................................................A72
iSupervisorDialup ..........................................................................A75
iSupervisorBNA .............................................................................A88
iSupervisorSettlementScreens .....................................................A92
jSupervisorandJournalMiscellaneousScreens .........................A95
xxxi
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.............................................................D10
TerminalCommands...................................................................D10
CustomisationDataCommands................................................D13
TransactionReply ........................................................................D16
AcknowledgeEJUploadBlockCommand ..............................D21
xxxii
Table of Contents
AcknowledgeandStopEJCommand ......................................D22
EJOptionsandTimersCommand ............................................D22
Appendix E
DeviceIdentifiers
Overview ............................................................................................... E1
HardwareConfigurationData ........................................................... E2
SuppliesData ...................................................................................... E11
CashAcceptorSupplies(DIGw) ............................................ E16
FitnessData ......................................................................................... E19
CashAcceptorFitness(DIGw) ............................................... E24
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
xxxiii
Table of Contents
xxxiv
List of Figures
ListofFigures
Chapter 1
Figure 11
StartupSequence...........................................................12
Chapter 2
StateTables
Figure 21
ReadConditionFlow...................................................211
Chapter 3
ScreenData
Figure 31
Cardholder/EOPScreenLayout...................................32
Chapter 4
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
APTRA Advance NDC Reference Manual
xxxv
List of Figures
Figure 412 CalculateCoordinate ..................................................420
Chapter 5
PrinterData
Figure 51
Figure 52
ScreenTextInterlacing ................................................526
FinalSimulatedPreprintedReceipt .........................528
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
Figure 1114
Figure 1115
Figure 1116
Figure 1117
Figure 1118
Figure 1119
Figure 1120
Figure 1121
DieboldPINBlock........................................................115
ISOPINBlockFormat0 ..............................................115
BANKSYSPINBlock ...................................................117
PANBlock .....................................................................117
ObtainKeyStatusMessageExchange ....................1117
IdentifyEPPandDetermineEPPCapabilities.......1119
HSMEPPAkeyMessageExchangeinStandard
Mode ..........................................................................1122
AuthenticationofEPP/HSMPublicKeysinStandard
Mode ..........................................................................1123
HSM/EPPSignatureVerificationinStandardMode .....
1123
EPPAuthenticationMessageSequenceinStandard
Mode ..........................................................................1124
AuthenticationofEPP/HSMPublicKeysinEnhanced
Mode ..........................................................................1125
EPPAuthenticationMessageSequenceinEnhanced
Mode ..........................................................................1126
DESKeyLoadStandardMessageSequence ..........1127
DESKeyLoadEnhancedMessageSequence.........1128
EnhancedSignatureRemoteKeyLoadMode:Delete
PKHOST...................................................................1129
EnhancedSignatureRemoteKeyLoadMode:Delete
PKHOSTRoot...........................................................1129
KeyEntryModeRemoteChangeSequence...........1132
ExchangeCertificates.................................................1134
LoadaCertificateDESKey.......................................1135
xxxvi
List of Figures
Figure 1122 ReplaceaCertificate ..................................................1135
Chapter 12
Figure 121 SmartCardHandling ..................................................125
Appendix B
CharacterSets
Figure B1
Figure B2
Alpha1............................................................................ B2
ExampleMappingFile ............................................... B11
Appendix C
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
xxxvii
List of Figures
xxxviii
List of Tables
ListofTables
Preface
Table Pref1 NavigationAids ..............................................................lix
Table Pref2 AbbreviationsUsedinthePublication ......................... lx
Chapter 1
Table 11
Table 12
CustomisationData .......................................................14
CentralControlCommandsandMessages................15
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 .......................................27
ACardReadState........................................................29
ReadConditionBitInformation ..................................29
BPinEntryState ........................................................212
CEnvelopeDispenserState .....................................215
DPresetOperationCodeBufferState ...................216
ExtensiontoStateD .....................................................217
EFourFDKSelectionFunctionState ......................220
FAmountEntryState................................................222
GAmountCheckState..............................................225
AmountCheckErrorState..........................................226
AmountCheckErrorStateDCCMT.....................227
HInformationEntryState ........................................231
ITransactionRequestState ......................................233
Track2DataSendModifier........................................234
Track1/3DataSendModifier.....................................234
TableEntry8forBufferA...........................................235
xxxix
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....................................................235
Extension2toStateI....................................................238
JCloseState.................................................................240
ExtensionState1toStateJ ..........................................242
ExtensionState2(JCloseState) ...............................245
KFITSwitchState......................................................246
_ExpandedFITSwitchState....................................247
ExtensiontoState_ ......................................................248
LCardWriteState......................................................250
MEnhancedPINEntryState ...................................252
SecurityCameraImageFilenameFormat ................254
NCameraControlState ............................................255
REnhancedAmountEntryState.............................257
ExtensiontoStateR......................................................257
SLanguageCodeSwitchState.................................259
ExtensiontoStateS ......................................................261
TCardReadPINEntryInitiationState................264
ExtensiontoStateT......................................................265
UDeviceFitnessFlowSelectState .........................267
StateUSupportedDevices.....................................269
CashHandlerFitnessExamples.................................272
VLanguageSelectfromCardState.........................273
WFDKSwitchState...................................................275
XFDKInformationEntryState................................276
ExtensiontoStateX......................................................278
YEightFDKSelectionFunctionState.....................280
Extension1toStateY...................................................282
Extension2toStateY...................................................283
bCustomerSelectablePINState .............................284
ExtensiontoStateb ......................................................286
kSmartFITCheckState ............................................288
mPIN&LanguageSelectState ...............................290
PIN&LanguageFDKActiveMask...........................292
Extension1toStatem..................................................292
>CashAcceptState....................................................297
Extension1toState>(CashAccept) .........................299
Extension2toState>(CashAccept) .......................2101
RejectedNotesDynamicText...................................2107
xl
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
Table 291
Table 292
Table 293
Table 294
Table 295
Table 296
Table 297
Table 298
Table 299
Table 2100
wChequeAcceptState ...........................................2109
Extension1toStatew................................................2112
Extension2toStatew................................................2114
zMasterExpansionState........................................2116
z001BunchChequeAcceptState ..........................2117
Extension1toStatez001 ...........................................2119
RejectedReasons ........................................................2122
RefusedReasons.........................................................2122
z002BunchChequeHandlingState......................2124
z003ChequeDetailDisplayState..........................2129
ChequeAcceptanceStates ........................................2133
z003ChequeDetailDisplayState..........................2135
z008InsertCardState.............................................2141
ExtensiontoStatez008 ..............................................2142
z009BufferValidationState ..................................2145
z010LocalCashDispenseState ............................2151
z013DataCopyandCompareState.....................2154
z014OfflineEncash/RefundState.........................2159
z017NoteMixSelectionState .................................2161
&BarcodeReaderState...........................................2168
Extension1toState& ................................................2170
Extensions28toState& ........................................2171
EntryConditionsfortheTimeOutState................2173
ActionTakenonSelectionofFDKBforEachEntry
Condition...................................................................2174
xli
List of Tables
Table 2101 ActionTakenonSelectionoftheCancelKeyforEach

EntryCondition........................................................2175
Chapter 3
ScreenData
Table 31
Table 32
Table 33
Table 34
Table 35
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
KExtendedScreenControls:RestoringSettings ....39
ScreenContentsK01 ....................................................39
ScreenContentsK09 ..................................................310
ScreenContentsK010 ................................................310
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 .....................336
BunchChequeCodelineDisplayControl.................337
BunchChequeAmountDisplayControl..................337
BunchChequeValueDisplayControl ......................338
DisplayDynamicTextDictionaryControl...............340
xlii
List of Tables
Table 336
Table 337
Table 338
Table 339
Table 340
Table 341
Table 342
DynamicButtonDefinition.........................................342
SyntaxofConditionalExpressions............................343
DynamicTextDefinition.............................................344
VideoandAnimationFileFormats ...........................345
CurrencyEchoExample..............................................346
DefaultEchoDisplayFormat .....................................347
FieldDefinitionsforScreensC09C19 ......................356
Chapter 4
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
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
xliii
List of Tables
Table 514
Table 515
Table 516
Table 517
Table 518
Table 519
Table 520
Table 521
Table 522
Table 523
Table 524
Table 525
Table 526
Table 527
Table 528
Table 529
Table 530
SelectHRICharacterPrintingPosition .....................517
SelectBarcodeWidth ...................................................517
SelectBarcodeHorizontalHeight..............................518
SelectDualsidedPrinting ..........................................518
CharacterSetDesignators ...........................................520
SelectPrimaryPrintPage............................................522
SelectSecondaryPrintPage........................................522
SetLeftMargin(StatementPrinter)...........................523
SetRightMargin(StatementPrinter) ........................523
SwitchLinesPerInch(6/8)..........................................524
LineSpacingValues.....................................................524
InvalidControlSequencesforScreenR01................526
ScreenR00Data ............................................................527
ScreenR01DataandInterlacedDatafromCentral 527
PrinterControlSequencesandRegistrySettings ....530
PrintChequeImageVariableData ............................535
USBReceiptandJournalPrinter:BarcodeTypes,
Length,andData........................................................536
Chapter 6
SupervisorMessages
Table 61
Table 62
ScreenSizeLimits...........................................................63
DisplayPositions............................................................63
Chapter 7
Table 738
Table 739
Table 740
Table 741
Table 742
Table 743
Table 744
Table 745
Table 746
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
xliv
List of Tables
Table 747
Table 748
Table 749
Table 750
Table 751
Table 752
Table 753
Table 754
Table 755
Table 756
Table 757
Table 758
Table 759
Table 760
Table 761
Table 762
Table 763
Table 764
Table 765
Table 766
Table 767
Table 768
Table 769
Table 770
Table 771
Table 772
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
Option34:MCNRangeOptionCodeExamples .....712
Option35:ReportDualMode&HardcopyB/U
UnsolicitedMessageValues.....................................713
Option36:EnhancedEJBackupValues ...................713
Option37:PrintTrack2toJournal............................713
Option41:SendTrackDetailsonCardRetract .......714
Option44:BNAJournalNotes
CountValues ..............................................................714
Option45:BNASettingsBitValues ..........................715
ExampleOption45:BNASettingsValues................717
Option46:MCRWEnhancedCardDeviceSecurity
JitterValues.................................................................717
Option48:BarcodeReaderValues ............................718
Option71:TimeOutStateEntry ...............................718
Option74:DestinationValuesforRetractedNotes
DuringCashDeposit .................................................718
Option76:CashHandlers...........................................719
Option77:NextStateNumberValues......................720
Option78:GBRUMStatusReporting ......................720
Option79:CoinDispenser..........................................721
Option80:AlphanumericStateEntry.......................721
Option83:ChequeProcessor .....................................721
UnsupportedParameters ............................................722
Chapter 8
Table 81
Table 82
Table 83
Table 84
Table 85
FITFields .........................................................................82
PINBlockTypeSelection ..............................................85
PINPDBitEncodingSignificance ................................86
PINPDFirstDigitCoding .............................................86
PINDXIndexReferencePoint ....................................810
xlv
List of Tables
Table 86
PINDXDigitAssignment............................................810
Chapter 9
Table 91
Table 92
Table 93
Table 94
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
TransactionRequestMessageFormat.........................92
E13BCodelineEncoding .............................................917
CMC7CodelineEncoding ..........................................917
TransactionRequestinReplytoanInteractive
TransactionResponse ................................................919
SolicitedStatusMessageFormat................................920
Ready(B)StatusInformation.................................923
CashDeposit:RecycleData ........................................924
RecycleCassette:DispenseData ................................925
SpecificCommandRejectStatusInformation .......926
TerminalStateStatusInformationSubFieldg1 .929
SendConfigurationInformationResponse..............930
HardwareFitnessSubFieldg3................................932
HardwareFitnessSeverityValues.............................933
HardwareConfigurationData:SubFieldg4.........934
SuppliesStatusSubFieldg5 ....................................941
SuppliesStatusValues.................................................942
HardwareConfigurationDataResponse .................943
SuppliesDataResponse ..............................................945
FitnessDataResponse .................................................948
TamperandSensorDataResponse ...........................949
SoftwareIDandReleaseNumberDataResponse ..952
LocalConfigurationOptionDigitsResponse ..........953
NoteDefinitions(BNA)Response .............................954
SendSupplyCountersResponse ...............................956
StatusMessageDescription ........................................960
SendSupplyCounters:ExtendedResponse ............961
SendTallyInformationResponse..............................968
SendErrorLogInformationResponse......................969
SendDate/TimeInformationResponse ....................970
SendConfigurationIDResponse...............................971
DeviceFaultStatusinResponsetoTransactionReply
Commands ..................................................................972
DeviceFaultStatusInformationField ......................973
EncryptorInitialisationDataResponse ....................976
FormatoftheUploadEJDataMessage ....................982
xlvi
List of Tables
Table 935
Table 936
Table 937
Table 938
Table 939
Table 940
Table 941
Table 942
Table 943
Table 944
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
Table 960
Table 961
UnsolicitedStatus:MessageFormat..........................985
UnsolicitedStatus:StatusInformationField............986
TimeOfDayClockStatus ..........................................987
PowerFailureStatus ....................................................988
CardReader/WriterStatus..........................................988
AdditionalTrackDataonCardRetract ....................989
CashHandlerStatus ....................................................990
DepositoryStatus .........................................................995
ReceiptPrinterStatus ..................................................996
JournalPrinterStatus...................................................998
ElectronicJournalPrinterStatus ..............................9100
UnsolicitedMessageSequencesforOption35(EJDual
Mode).........................................................................9101
NightSafeDepositoryStatus ...................................9102
EncryptorStatus .........................................................9103
CameraStatus .............................................................9104
SensorsStatus .............................................................9105
TouchScreenKeyboardStatus.................................9107
SupervisorKeysStatus..............................................9108
CardholderDisplayAlarmStatus ...........................9110
StatementPrinterStatus............................................9110
VoiceGuidanceStatus...............................................9112
BunchNoteAcceptorStatus.....................................9115
AdditionalCardholderData ....................................9119
EnvelopeDispenserStatus .......................................9120
ChequeProcessorStatus ...........................................9121
CoinDispenserStatus................................................9125
BarcodeReaderStatus ...............................................9128
Chapter 10
Table 101
Table 102
Table 103
Table 104
Table 105
Table 106
Table 107
Table 108
Table 109
TerminalCommands ...................................................103
CustomisationDataCommands................................107
StateTablesLoad .........................................................109
Screen/keyboardDataLoad .....................................1011
ConfigurationParametersLoad...............................1015
EnhancedConfigurationParametersLoad ............1017
FITDataLoad .............................................................1022
ConfigurationIDNumberLoad ..............................1024
MessageAuthenticationFieldSelectionLoad .......1026
xlvii
List of Tables
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
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
Table 1037
Table 1038
Table 1039
Table 1040
Table 1041
Table 1042
DataandTimeLoad ..................................................1033
EncryptionKeyChange ............................................1035
ExtendedEncryptionKeyChange ..........................1038
DispenserCurrencyCassetteMapping ..................1045
XMLConfigurationDownloadMessageFormat ..1049
TransactionReplyCommand:MessageFormat....1051
DepositandPrint(FunctionID1or7) ...............1066
DispenseandPrint(FunctionID2or8) .............1067
DisplayandPrint(FunctionID3or9) ...............1068
PrintImmediate(FunctionID4)............................1069
SetNextStateandPrint(FunctionID5)...............1069
NightSafeDepositandPrint
(FunctionID6)........................................................1069
CardBeforeCash(FunctionIDA) ........................1070
ParallelEject/DispenseandPrint
FastCash(FunctionIDBorC) ..........................1071
CardBeforeParallelDispenseandPrint
(FunctionIDF) .......................................................1072
PrintStatementandWait
(FunctionIDP) .......................................................1073
PrintStatementandSetNextState
(FunctionIDQ) ......................................................1074
RefundNotesandSetNextState
(FunctionID*) ........................................................1075
DepositNotesandPrint ............................................1076
DepositNotesandWait ............................................1077
ProcessCheque(FunctionID:)..............................1077
DispenseCashFirstDuringValuableMediaExchange
(FunctionIDb) .......................................................1078
DispenseCashFirstDuringValuableMediaExchange:
OperationalFlow .....................................................1080
ProcessMultipleCheques(FunctionIDc) ...........1081
DepositMediaFirstDuringValuableMediaExchange
(FunctionIDf) ........................................................1082
DepositMediaFirstDuringValuableMediaExchange:
OperationalFlow .....................................................1084
InteractiveTransactionResponse ............................1087
EJOptionsandTimers...............................................1091
AcknowledgeEJUploadBlock ................................1093
AcknowledgeandStopEJ.........................................1094
SpecificCommandRejectValue/Qualifier
Combinations............................................................1097
ActionsforCustomisationDataCommands .......10104
ActionsforTransactionReplyCommands ..........10105
xlviii
List of Tables
Table 1043 ActionsforTerminalCommands ..........................10106
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
MessageAuthenticationConfigurationFlag10 ....1113
MACFieldSelection:SolicitedStatusMessage.....1114
MACFieldSelectionOtherMessages...................1114
MACFieldSelectionTrack1,Track2,Track3....1115
MACFieldSelectionForEMVICCConfiguration
Messages....................................................................1115
Table 1112 SelectiveMACDefaultFieldValues .......................1116
Chapter 12
Table 121
ChipDataReadState...................................................126
Chapter 13
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
xlix
List of Tables
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 .....................A3
ErrorScreens ..................................................................A5
SupervisorInformationScreens................................A18
SupervisorMenuScreens...........................................A25
SupervisorPromptsScreens ......................................A43
SupervisorInformationLinesScreens .....................A49
JournalTraceScreens..................................................A53
Cheque,EMVSmartCardandBNAScreens..........A63
SupervisorDiagnosticScreens ..................................A70
SupervisorTCP/IPScreens ........................................A72
SupervisorDialupScreens.........................................A75
SupervisorBNAScreens ............................................A88
SupervisorSettlementScreens ..................................A92
SupervisorMiscellaneousScreens ............................A95
Appendix B
CharacterSets
Table B1
Table B2
Table B3
Table B4
CharacterSets ................................................................ B3
StatementPrinterCharacterSets ................................ B5
MappingFileConventions .......................................... B9
FontIDMappingTable .............................................. B12
Appendix D
Table D1
Table D2
Table D3
Table D4
Table D5
Table D6
Table D7
Table D8
Table D9
QuickReferencetoMessageTypes ............................D2
TransactionRequestMessageFormat........................D3
UnsolicitedStatusMessageFormat............................D7
SolicitedStatusMessageFields...................................D8
SolicitedStatusMessageFieldValues .......................D8
EncryptorInitialisationData .......................................D9
UploadEJDataMessage ............................................D10
TerminalCommandFields ........................................D10
FieldValuesforTerminalCommands .....................D10
List of Tables
Table D10
Table D11
Table D12
Table D13
Table D14
Table D15
CustomisationDataCommandFields .....................D13
FieldValuesforDataCommands.............................D14
TransactionReply .......................................................D16
AcknowledgeEJUploadBlockCommand .............D21
AcknowledgeandStopEJCommand......................D22
EJOptionsandTimersCommand............................D22
Appendix E
DeviceIdentifiers
Table E1
Table E2
Table E3
Table E4
Table E5
Table E6
Table E7
Table E8
Table E9
Table E10
Table E11
DeviceHardwareConfigurationData....................... E2
DeviceSuppliesData.................................................. E11
SuppliesStatusofallBNACassettes ....................... E16
OverallBNARetractBinStatusReporting ............. E16
MostSevereBNASuppliesStatusReporting ......... E17
LeastSevereBNASuppliesStatusReporting......... E17
BNASupplies:ExtendedMessageFormat.............. E18
DeviceFitnessData..................................................... E19
BNAFitness:ExtendedMessageFormat................. E24
DeviceTamperData ................................................... E25
TIBins(Alarms)SensorTypes .................................. E29
Appendix F
Table F1
ASCIItoEBCDICCodeConversion............................F2
Appendix G
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
li
List of Tables
lii
Preface
Purpose and Audience
PurposeandAudience
ThepublicationprovidesreferencedataforstandardNDCstate
tables,screen,keyboardandprinterdata,Supervisormessages,
configurationparameters,FinancialInstitutionTables(FITs),
terminaltoCentral/Centraltoterminalmessages,securityfeatures
andreservedscreens.
Audience
Thepublicationisintendedforthefollowing:
Developerswhohavecustomised,orwishtocustomise,the
selfserviceterminal(SST)configurationorthemessages
betweentheSSTandCentral
Programmersresponsiblefortheterminalconfigurationthat
customisestheAPTRAAdvanceNDCsoftware
ProgrammerswhowriteormodifyCentralcontrolapplications
tosupportSSTsrunningAdvanceNDC.
Advance NDCAPTRA Advance NDC, Reference Manual
liii
Preface
How to Use This Publication
HowtoUseThisPublication
ThissectionsummarisesthecontentsoftheAdvanceNDC,Reference
Manual,andhowtouseitfordifferentpurposes.Italsoexplainsthe
navigationalaidsprovided,theconventionsusedandwhereto
obtainsupport.
ContentsofthePublication
Thepublicationcontainsthefollowinginformation:
Chapter 1,IntroducingtheAdvanceNDCSystem
ProvidesanoutlineoftheAdvanceNDCsoftware,withreferences
totheAPTRAAdvanceNDC,OverviewandtheAPTRAAdvance
NDC,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.
liv
Preface
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.
lv
Preface
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.
lvi
Preface
NavigatingthePublication
ThepublicationcanbeviewedonscreenorprintedwiththeAdobe
Reader.
Thefollowingareavailableonscreen:
Hyperlinkedpagereferences,forexample,fromthetableof
contentsandindex
Hyperlinkednotesreferencedintables;thetablenotesaregiven
attheendoftherelevanttableandnumberedconsecutively
withineachchapter
HyperlinkedbookmarksinthePDFBookmarkspane;the
bookmarksgivethestructureofthepublicationdowntothree
headinglevels.
Thestructureofthepublicationcontainsthefollowingtohelpyou
findinformation,orsubmitcomments:
Table Pref-1
Navigation Aids
Conventionsand
AbbreviationsUsedinthe
Publication
Element
Description
Revision
Record
Listsupdatesfor4.0xreleasesinpageorderwith
pagereferences.Themostrecentrevisionislisted
first.Thepagereferencesforthecurrentrevision
arehyperlinked;pagereferencesforearlier
revisionsarenotalwayshyperlinked.
Tableof
Contents
Liststhefirsttwoheadinglevelsinpageorderwith
pagereferences.
TableofContents
forchapteror
appendix
Liststhefirstthreeheadinglevelsinpageorder
withpagereferences.
Glossary
Providesanalphabeticallistofterms,acronyms,
andabbreviationswiththeirmeaning.
Index
Providesanalphabeticallistoftopics,keywords,
concepts,anddatareferenceswithpagereferences.
UserFeedback
Form
Allowsyoutocommentonthepublicationby:
Printingtheformtofillinandpost
Selectingtheemaillink
Selectingtheweblink.
AllreferencestoUSBprinters(receipt,journalandstatement),refer
todevicesrunningontheNCRrangeofSelfServSSTs.
lvii
Preface
Abbreviations
Thefollowingabbreviationsareusedthroughoutthepublication:
Table Pref-2
Abbreviations Used in the Publication
Full Form
Abbreviated Form
Europay,Mastercard,VISA
EMV
CPMandbunchchequeacceptor
Chequeprocessor(whenthe
informationappliestoboth
devices)
IntegratedCircuitCard
ICC
MicrosoftWindowsXP
Professional,MicrosoftWindows7
andPOSReady7
Windows
Foralistoftermsandabbreviationsusedinthepublication,seethe
Glossary.
TermsforCashAcceptors
Therearedifferenttypesofcashacceptorsasfollows:
Devicesthatallowonlysinglenotestobedeposited
Devicesthatallowbunchesofnotestobedeposited
Devicesthatallowbunchesofnotesand/orchequestobe
deposited
Devicesthatallownotestobedepositedandcanalsoallow
notestobedispensedfromseparatecassettes(cashin/cashout)
Devicesthatallownotestobedepositedandcanalsoallow
notestobedispensedfromthesamecassette(recycling).
Thefollowingtabledescribesthetermsusedinthispublication
whenreferringtocashacceptorsandtheirvariants:
Term
Refers to...
Cashacceptor
Generictermforanydevicethatacceptsnote
deposits
SeeNote1:
Recycling
unit/Recycler
Generictermsforanydevicethatcanacceptnote
depositsandalsodispensenotesandrecycle
depositednotes(thatis,dispensethedeposited
notes)
SNA
Singlenoteacceptor
AnNCRdevicethatacceptsdepositsofmultiple
notesonebyone
SeeNote2:
lviii
Preface
Term
Refers to...
BNA
Bunchnoteacceptor
AnNCRdevicethatacceptsdepositsofbunchesof
notes
SeeNote2:andNote3:
SDM
Scalabledepositmodule
AnNCRdevicethatcanacceptdepositsofnotesor
chequesinasingletransaction.
SeeNote1:andNote2:
GBNA
Globalbanknoteacceptor
AnNCRdevicewithconfigurablecassettesthatcan
acceptnotedepositsandcandispensenotesfrom
separatecassettes
GBRU
Globalbillrecyclingunit
AnNCRdevicethatacceptsnotedepositsandcan
dispensenotesusingthesamecassettes
GBXX
AnNCRtermusedwhenreferringtoboththeGBNA
andGBRUdevices
SeeNote3:
Note1:Somecashacceptorscanalsoacceptcheques.
Note2:WheneveraBNAismentioned,theinformationalso
appliestotheSNAandSDMunlessexplicitlystated.
Note3:OccasionallyBNAandGBXXareusedtorefertoall
vendorsdevices,suchasinsomeSupervisormenuoptions.Whena
termisusedgenerically,thisisexplainedintheassociatedtext.
WhatElseShouldIRead?
NCRrecommendsyoufirstreadtheAPTRAAdvanceNDC,
Overview(B0066597)andtheAPTRAAdvanceNDC,Developers
Guide(B0066046).
IfyouareworkingwithAdvanceNDConothervendorsSSTs,you
willalsoneedtheAPTRAAdvanceNDC,MultiVendorSupport
ReferenceManual(B0066344).
IfyouwanttoextendthefunctionalityoftheAdvanceNDC
application,readAPTRAAdvanceNDC,ExtendingtheProduct
(B0066926).
AllthedocumentationrelatedtoAdvanceNDCislistedand
describedinAppendix G,RelatedDocumentation.
lix
Preface
Support Information
SupportInformation
Ifyouhaveaproblemusingthesoftware,pleasecontactyour
internalsupportdepartment,oryourlocalNCRrepresentative.
NCRprovidesawiderangeofsupportprogrammesformore
information,contactyourlocalaccountteam.
Ifyouhaveanyproblemsusingthispublication,seetheUser
FeedbackFormatthebackofthepublication,forourelectronic
andpostaladdresses.Pleasetakethetimetoreply;yourcomments
areappreciated.
lx
Table of Contents
Introducing the Advance NDC System
Chapter 1
IntroducingtheAdvanceNDC
System
Overview
11
HowtheSSTOperates
12
CreatingtheCustomisationData
14
RoleoftheCentralControlApplication
15
Table of Contents

Overview
Overview
ThischapterintroducesAdvanceNDCunderthefollowingtopics:
HowtheSSToperates
SSToperatingmodes
Creatingthecustomisationdata.
Roleofthecontrolapplicationonthehostorswitch(Central)
Forinformationonclearingpersistentmemory,refertotheAPTRA
AdvanceNDC,DevelopersGuide.
1-1

How the SST Operates
HowtheSSTOperates
WhentheSSTisswitchedon,afterloadingitwiththeAdvance
NDCsoftware,apowerupmessageissenttoCentral.Central
downloadsanynecessarydatatotheSSTinaseriesofmessages.
Aftereachmessageissent,theSSTsendsanacknowledgementto
Central.WhenCentralhassentallthedatasuccessfully,itputsthe
SSTintoservice,asshowninFigure 11StartupSequence.
Figure 1-1
Start-up Sequence
Host
SST
Power-up Unsolicited Status Message
Terminal Command to Request Config ID
Solicited Status with Config ID
Extended Encryption Key Change Message
Encryptor Initialisation Data Message
Data Load Message
Ready Solicited Status Message
Continue until required customisation data

has been downloaded to the SST
Data Load Message
Go In Service Command Message
1-2

How the SST Operates
Whenatransactionisprocessed,thefollowingoperationsare
completed:
1
TheSSTgathersdetailsfromtheconsumerandcard(ifacardis
used).
TheSSTsendstheinformationinaTransactionRequest
messagetoCentral.
CentralsendsaTransactionReplycommand.
TheSSTcompletesthetransaction.
Ifafaultoccurs,theSSTsendsamessagetoCentralandwaitsfora
furtherTransactionReplycommandbeforecompletingthe
transaction.Oncethetransactionhasbeencompletedsuccessfully,
theSSTsendsamessagetoCentraltoconfirmit.
1-3

Creating the Customisation Data
CreatingtheCustomisationData
Table 11,CustomisationDatabelow,describesthetypesof
customisationdataandwheretofindfurtherinformationinthis
publication.
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.
LocalconfigurationparameterssuchasAmountBuffersize,card
reader/writererrorthresholds,andtimers.Fordetails,seeChapter 7,
ConfigurationParameters.
FinancialInstitutionTables(FITs)
ThefinancialinstitutionstheSSTsupports.Foreachinstitution,thetable
defineswhetherPINverificationislocalorremote,thetypeofdata
encryption,andthepositionofdetailsonthecard.Fordetails,see
Chapter 8,FinancialInstitutionTables.
1-4

Role of the Central Control Application
RoleoftheCentralControl
Application
Table 12CentralControlCommandsandMessagesbelow
describesthecommandsandmessagessentbyCentral.
Table 1-2
Central Control Commands and Messages
Command/Message
Description
TerminalCommands
InstructionssenttotheSST.
SeeTerminalCommandsonpage 103.
TransactionReplyCommands
ResponsesfromCentraltoaTransactionRequestmessagefromtheSST,
tellingtheSSThowtocompletethetransaction.
SeeTransactionReplyCommandonpage 1051.
CustomisationDataCommands
CustomisationdatasenttotheSST.
SeeCustomisationDataCommandsonpage 107.
MessagestotheSSTtoprompttheconsumerformoreinformation.
SeeInteractiveTransactionResponseonpage 1086.
1-5

Role of the Central Control Application
1-6
Table of Contents
State Tables
Chapter 2
StateTables
Overview
21
IntroductiontoStateTables
InvalidStateHandling
CustomisingStates
UnsupportedStateTypes
ReservedStates
ExitStates
StandardStateTypes
StateNumbers
ScreenNumbers
ExtensionStates
TableEntryValue255
TableEntryValue000
22
22
22
22
23
23
23
24
25
25
25
26
ACardReadState
ReadConditionValues
27
29
BPINEntryState
212
CEnvelopeDispenserState
215
DPreSetOperationCodeBufferState
216
EFourFDKSelectionFunctionState
219
FAmountEntryState
VoiceGuidedSessionsandDataEntry
StateProcessing
BufferClearingandAppendBuffer.xml
TouchScreenEmulation
221
221
221
221
221
Table of Contents
State Tables
GAmountCheckState
224
HInformationEntryState
DataEntry
OverridingEntryMode,BufferandDisplayParameters
DataEntryandVoiceGuidance
ExitingtheInformationEntryState
EmulatedFDKsandTouchscreenKeyboards
ClearFunctionKeyandGeneralPurposeBuffers
229
229
229
229
229
230
230
ITransactionRequestState
233
JCloseState
FunctionOperations
Receipts,StatementsandEnvelopes
Cards
CardlessTransactions
Audio
239
239
239
239
240
240
KFITSwitchState
246
_ExpandedFITSwitchState
247
LCardWriteState
249
MEnhancedPINEntryState
251
NCameraControlState
254
REnhancedAmountEntryState
256
SLanguageCodeSwitchState
259
TCardReadPINEntryInitiationState
262
Table of Contents
State Tables
PINEntryEnabled
PINEntryDisabled
AudioSupport
SmartDipCardReader
263
263
263
263
UDeviceFitnessFlowSelectState
SupportedDevices
CashHandlers
267
269
272
VLanguageSelectFromCardState
273
WFDKSwitchState
275
XFDKInformationEntryState
276
YEightFDKSelectionFunctionState
LanguageSelectioninVoiceGuidedSessions
279
279
bCustomerSelectablePINState
284
d...gandzExitStates
287
kSmartFITCheckState
288
mPIN&LanguageSelectState
ConsiderationsforVoiceGuidedSessions
289
290
>CashAcceptState
ConfirmationScreen
RefundableDeposits
DirectDeposits
DynamicTextDefinitions
DefiningReasonsforNoteRefusal
296
2106
2107
2107
2107
2107
wChequeAcceptState
2109
Table of Contents
State Tables
zMasterExpansionState
2116
z001BunchChequeAcceptState
DefiningDynamicTextforChequeRejection
DefiningDynamicTextforChequeRefusal
2117
2122
2122
z002BunchChequeHandlingState
2124
z003ChequeDetailDisplayState
DefiningDynamicDataforChequeDepositStatus
2128
2133
z004DisplayChequeSummaryState
CurrentChequeIndex
2134
2135
z008InsertCardState
2140
z009BufferValidationState
DateValidationScenario
2144
2145
z010LocalCashDispenseState
DispenseFunctionality
ForeignCurrencyExchangeTransactions
StateFlowafteraSuccessfulDispense
SuccessfulDispenseExamples
StateFlowafteraShortDispense
StateFlowafteraFailedDispense
StateFlowafteranUnknownDispense
StateFlowonCardEjection
StateOperation
CDIStores
JournalingandPrinting
StatusUpdatesandCounts
MessageHandling
UnsolicitedStatusMessages
Counts
2147
2147
2147
2147
2147
2148
2148
2148
2149
2149
2149
2149
2150
2150
2151
2151
2151
Table of Contents
State Tables
z013DataCopyandCompareState
CopyOperations
CompareOperations
2154
2156
2157
z014CashDepositHandlingState
Journaling
DataPrinting
2158
2158
2158
z017NoteMixSelectionState
2161
&BarcodeReadState
2168
TimeOutState
2173
Table of Contents
State Tables
State Tables
Overview
Overview
Statescontroltheinformationgatheringpartofconsumer
transactions.AdvanceNDCprovidesasetofstandardstates,and
mechanismsforreplacingstandardstatesoraddingnewones.
StatesthatyouwriteyourselfarecalledExitStates.
Thischapterdescribesthefunctionandformatofeachofthe
standardstatetabletypessupportedinAdvanceNDC.
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
2-2
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
2-3
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
z010
LocalCashDispenseState
z013
DataCopyandCompareState
z014
CashDepositHandlingState
z017
NoteMixSelectionState
z900toz999
AvailableasidentifiersforExitStates
Note1:Duringtransactionprocessing,beforeentrytoeachstate,
AdvanceNDCchecksthekeyboardlayouttobeused.Ifthescreen
thatisabouttobeusedreferencesatouchscreenkeyboardnumber
butthetouchscreenkeyboardlayoutdoesnotprovidedefinitions
ofalltherequiredkeys,thetransactionflowgoestothedefault
Closestate.
StateNumbers
Alphanumeric(base36)numbersinstatetableentriesaresupported
aswellasdecimal(base10).Usingalphanumericdataprovides
supportforupto46655statenumbers,withoutchangingthetable
entrylength.InpreviousreleasesofAdvanceNDConlydecimal
(base10)numbersweresupported,providingamaximumof999
statenumbers.Thecharacterfieldinthestateentriescontainseither
adecimaloralphanumericnumber,dependingonthevalueof
2-4
State Tables
Option80.Fordetails,seeOption80AlphanumericStateEntry
onpage 721.
Decimalnumbersareintherange000to999.
Alphanumericnumbersareintherange000toZZZ.
Thevalue255isalwaysreservedunlessstatedotherwiseinthe
tableentry.
ScreenNumbers
Upto999screenscanbespecifiedinstatetableentriesforscreens
usingtherange000to999.Usinganuppercasealphanumeric
characterintherangeAtoZinsteadofthefirstdigitextends
supporttomorethan999screens,includingmultilanguagescreens,
withoutchangingthetableentrylength.
Screennumbersareintherange000toZ99.
ThealphanumericcharactersaremappedtodigitsstartingwithA,
whichisequalto10,andincreasingbyoneuntilZ,whichisequalto
35.
Forexample,ascreendefinedasA34ismappedto1034anda
screendefinedasZ34ismappedto3534.Theactualscreens
displayeddependonthespecificationofthefirstscreen(thescreen
base)ineachrangeofscreensfortheselectedlanguage(screen
group).
Typically,thefullrangeof9999screenssupportedbyAdvance
NDCcanbeaccessedbysettinganoffsettoselectalanguage.
Formoreinformationonthewayinwhichthescreennumberingis
affectedbytheuseofoffsets,thescreenbaseandlanguageselection,
seeMultiLanguageScreensonpage 348.
ExtensionStates
Manystatetypesallowtheuseofextensionstates(statetypeZ).
Theuseofeachextensionstateisdescribedinthestatetables.
TableEntryValue255
Unlessspecifiedinthestatetabledescription,thevalue255is
reserved.Usingavalueof255whennotexplicitlyspecifiedinthe
statetabledescriptioncanresultinunintendedconsequences
duringstateexecution.
2-5
State Tables
TableEntryValue000
Whetheranextensionstateisoptionalormandatorydependsonthe
contextandconditionsofthetransactionflow.Conditionsforthe
useofvalue000areasfollows:
Ifanextensionstateisnotmandatoryandnotusedinthe
transactionflow,usethevalue000unlessadifferentvalueis
explicitlyspecifiedinthestatetabledescription.
Ifanextensionstateismandatory,donotusethe000value.
2-6
State Tables
A - Card Read State
ACardReadState
WhenyouusetheCardReadstatetable,ensureitisthefirsttable
usedduringtransactionprocessingbyassigningstatenumber000
toit.TheSSTautomaticallyentersstate000whenputInService.
CardlesstransactionscanbeinitiatedinthisstateifEnhanced
ConfigurationParameteroption77isused.Fordetails,seeOption
77NextStateNumberonpage 719.
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
2-7
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.
2-8
State Tables
A - Card Read State
Table 2-3
A - Card Read State
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
Displayscreenthatpromptstheconsumertoenter
thecard.WhiletheSSTiswaitingforcardentry,
thisscreenisdisplayed.
GoodReadNextStateNumber
(Base10range000254or
256999)
256ZZZ)
StatenumbertowhichtheSSTgoes:
1.FollowingagoodreadofthecardifFITsarenot
used(Tableentry9=000)
or
2.IftheFinancialInstitutionnumberonthecard
matchesaFinancialInstitutionnumberinaFIT.
Error(Misread)ScreenNumber
(Range000Z99)
Ifthereadconditionsarenotsatisfiedduetoabad
cardoramechanismerror,thecardisejectedand
thisscreenisdisplayed.
ReadCondition1
ReadCondition2
ReadCondition3
Thesethreeentriesspecifywhichcardtrack(s)
and/orchipdatawillberead.Thepossiblevalues
fortheseentriesareshowninTable 24inthenext
section.
CardReturnFlag
TellstheSSTwhenthecardshouldbereturnedto
theconsumer:
000ejectthecardimmediately.
001returnthecardasspecifiedbyaTransaction
Replycommandmessage.
NoFITMatchNextState
Number
256999)
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
2-9
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 211.Forreadconditionoperations
wherethechipconnectbitissetinoneormorereadconditions,see
Chapter 12,EMVSmartCardHandling.
2-10
State Tables
A - Card Read State
Figure 2-1
Read Condition Flow
Evaluate Read
Condition 1
Y
Satisfied?
N
Evaluate Read
Condition 2
Good Read Next State Number

(table entry 3)
Satisfied?
N
Evaluate Read
Condition 3
Y
Satisfied?
N
Error Screen Number (table
entry 4)
2-11
State Tables
B - PIN Entry State
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 1022)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
(Range000Z99)
thePINthefirsttime.Thisscreen,whichis
displayedonenteringthePINEntrystate,must
leavetheconsumerscreencursoratthestartofthe
PINEntrydisplayarea.AnXisdisplayedforeach
keypressed.
TimeOutNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumer
doesnotenterthePINwithinthepermittedtime
limit.Enter255ifthetimeoutfunctionisnot
required.
2-12
State Tables
B - PIN Entry State
Table
Entry
Number of
Characters
Contents
Description
CancelNextStateNumber
256999)
256ZZZ)
pressestheCancelkeybeforethemaximumnumber
ofdigitsspecifiedforthePINhavebeenentered.
LocalPINCheckGoodPIN
NextStateNumber
256999)
256ZZZ)
SeeTableNote2.
StatenumbertowhichtheSSTgoesafter
verificationofacorrectPINentry.APreSet
OperationCodeBufferstate(clearingthefunction
keybufferbeforeTransactionSelection)usually
followsacorrectPINentry.
LocalPINCheckMaximumBad
PINsNextStateNumber
256999)
256ZZZ)
SeeTableNote1,TableNote2.
StatenumbertowhichtheSSTgoesifthecorrect
PINhasnotbeenenteredafterthenumberof
attemptsallowedbytableentry9.TheSST
normallyentersaClosestateifthisoccurs.
LocalPINCheckErrorScreen
Number
(Range000Z99)
Displayscreenthatpromptstheconsumerto
reenterthePIN.Thisscreenisdisplayedaftereach
incorrectPINentryattempt.AnXisdisplayedfor
eachkeypressed.Afterthenumberofreentry
attemptsallowedbytableentry9,theSSTenters
thestatedeterminedbytableentry6.
RemotePINCheckNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoeswhenlocalPIN
verificationisnotperformed.
LocalPINCheckMaximumPIN
retries
(Range001009)
MaximumnumberofincorrectPINentriesallowed
beforetheSSTentersthestatedeterminedbytable
entry6.
TableNote1:TheseLocalPINfields(6,7and9)arealsoused
whentheCheckRemotePINminimumlengthoptionisused;they
areusedinthesamewayasforLocalPINverification.Anincorrect
PINisonewhichislessthantheminimumlength.
AstheseLocalPINfieldscanbeusedwithRemotePINverification,
theymustcontainvalidentrieswheneitherRemoteorLocalPIN
verificationisused.
2-13
State Tables
B - PIN Entry State
TableNote2:TosupportsecurePINencryption,fields5,6,7and9
mustalwaysbesetup,astheyareusedtocontrolthenumberof
allowedPINretrieswhenfewerthanfourPINdigitsareentered.
WithsecurePINencryption,acheckfortheminimumfourPIN
digitsisperformedregardlessofwhethertheFITspecifiestocheck
forshorterPINsornot.
ForFITdatadetails,seeChapter 8,FinancialInstitutionTables.
2-14
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
256999)
256ZZZ)
StatenumberthattheSSTentersimmediatelyor
afteranenvelopeispresented.
39
21
Mustbe000.
Reserved
2-15
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
256999)
256ZZZ)
presettingtheOperationCodebuffer.
ClearMask
(Range000255)
SpecifiesbytesofOperationCodebuffertobe
clearedtographicspace.Eachbitrelatestoabyte
intheOperationCodebuffer.Ifabitiszero,the
correspondingentryiscleared.Ifabitisone,the
correspondingentryisunchanged.
SeeTableNote3.
APreSetMask
(Range000255)
Thebuffercontainseightbytes.Thisentrysetsthe
specifiedbytestoA.Ifabitisone,the
correspondingentryissettoA.Ifabitiszero,the
SeeTableNote3.
BPreSetMask
(Range000255)
specifiedbytestoB.Ifabitisone,the
correspondingentryissettoB.Ifabitiszero,the
SeeTableNote3.
CPreSetMask
(Range000255)
specifiedbytestoC.Ifabitisone,the
correspondingentryissettoC.Ifabitiszero,the
SeeTableNote3.
2-16
State Tables
Table
Entry
Number of
Characters
Contents
Description
DPreSetMask
(Range000255)
specifiedbytestoD.Ifabitisone,the
correspondingentryissettoD.Ifabitiszero,the
SeeTableNote3.
Mustbe000.
Reserved
ExtensionStateNumber
256999)
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)
specifiedbytestoF.Ifabitisone,the
correspondingentryissettoF.Ifabitiszero,the
SeeTableNote3.
GPreSetMask
(Range000255)
specifiedbytestoG.Ifabitisone,the
correspondingentryissettoG.Ifabitiszero,the
SeeTableNote3.
HPreSetMask
(Range000255)
specifiedbytestoH.Ifabitisone,the
correspondingentryissettoH.Ifabitiszero,the
SeeTableNote3.
IPreSetMask
(Range000255)
specifiedbytestoI.Ifabitisone,the
correspondingentryissettoI.Ifabitiszero,the
SeeTableNote3.
69
12
Mustbe000.
Reserved
2-17
State Tables
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.
2-18
State Tables
E - Four FDK Selection Function State
EFourFDKSelectionFunction
State
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 220,
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.
2-19
State Tables
Table 2-9
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
Displayscreenthatrequeststheconsumerto
choosebetweentransactiontypes,accountnames,
andsoon.Thisscreenmustbealignedwiththe
activeFDKs,andisdisplayedwhentheSSTenters
theFourFDKSelectionFunctionstate.Fordetails,
seetheCCardholderDisplaysectionin
Chapter 3,ScreenData.
256999)
256ZZZ)
doesnotrespondtothescreenmessagewithinthe
permittedtimelimit.Enter255ifthetimeout
functionisnotrequired.
256999)
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
2-20
State Tables
F - Amount Entry State
FAmountEntryState
Thisstatereadstheamountenteredbytheconsumer,displaysiton
theconsumerscreen,andsavesitintheAmountbuffer.The
standardfieldlengthforthisbufferiseightdigits,ortwelveif
EnhancedConfigurationParameteroption1isused;butthebuffer
lengthcanalsobeconfiguredforanynumberofcharactersuptoa
maximumoftwelve,throughaparameterinAppendBuffer.xml.
Note:Ifyourequiremultilingualsupportforamountentry,seeR
EnhancedAmountEntryStateonpage 256.Ifyouwanttoallow
theconsumertoselectthenotemixtobedispensed,seez017Note
MixSelectionStateonpage 2161.
VoiceGuidedSessionsand
DataEntry
2
StateProcessing
Fordetailsoftheissuestobeconsideredwhenaaconsumerselects
avoiceguidedsession,seeDataEntryandVoiceGuidanceon
page 229.
TheSSTexitsfromtheAmountEntrystateoncetheconsumer
pressesanactiveFDKortheCancelkey.Italsoexitsfromthisstateif
theconsumerdoesnotpressakeywithinthespecifiedtimelimit.
Fordetailsoftimers,seetheConfigurationParametersLoad
sectioninChapter 10,CentraltoTerminalMessages.
IftheconsumerpressestheEnterkey,ithasthesameeffectas
pressingFDKA(orFDKIifMessageModeoptiondigit7aisset).
Formoreinformation,seeEFourFDKSelectionFunctionState
onpage 219.
IftheconsumerpressestheClearkey,whichisalwaysactive,the
amountbufferandthescreenechofieldareclearedonecharacterat
atime.Thisallowstheconsumertoreenterthecorrectamount.
BufferClearingand
AppendBuffer.xml
Oncetheconfigurednumberofcharactersisreached,thenextkey
clearsthebuffer,resettingthevalueto0andrestartingtheentry
fromthebeginning.AparameterinAppendBuffer.xmlcanbe
conLfiguredtopreventclearingoftheamountwhentheconfigured
limitisreached.
AppendBuffer.xmlcanbedownloadedasdescribedinXML
ConfigurationDownloadonpage 1048orinstalledlocally.For
detailsofAppendBuffer.xml,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
TouchScreenEmulation
IftheSSTsupportstouchscreenFDKemulationinsteadofphysical
FDKs,eightfixedtouchareasaredefinedonthescreen,whichthe
2-21
State Tables
consumertouchesinsteadofpressingthecorrespondingFDK.The
touchareasareenabledanddisabledinexactlythesamewayasthe
FDKs.Fordetails,seeFDKEmulationonpage 42ofChapter 4,
KeyboardDataandLayouts.
Layouts.
Note:Inavoiceguidedsession,keyboardechoingisavailablebut
.wavfilesarenotsupportedforamountentryechoing.
Table 2-10
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
anamount.ThisscreenisdisplayedwhentheSST
enterstheAmountEntrystate.
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheamount
entryisnotmadewithinthepermittedtimelimit.
Enter255ifthetimeoutfunctionisnotrequired.
256999)
256ZZZ)
keyispressed.
FDKA(orI)
NextStateNumber
FDKB(orH)
NextStateNumber
FDKC(orG)
NextStateNumber
FDKD(orF)
NextStateNumber
pressesanFDKortoucharea.NormallyoneFDK
ortouchareaisdesignatedforcorrectamount
entriesandanotherforincorrectamountentries.
TheremainingtwoFDKsortouchareasare
inactive.
Enter255todeactivateanFDKortoucharea.
2-22
State Tables
Table
Entry
Number of
Characters
Contents
Description
AmountDisplayScreen
Number
(Range000Z99)
Overlayscreenforsettingtheconsumerscreen
cursorposition.SeeTableNote4
Additionalzeroescanbeaddedautomaticallyto
theamountbuffer.SeeTableNote5.
Thedefaultechofieldforeightdigitsis:
bbbbb$b0.00
whereb=space.
Thedefaultechofieldfortwelvedigitsis:
bbbbbbbbb$b0.00
whereb=space.
TableNote4:Thisscreenoptionallydefinestheinitialdisplay
formatbeforeamountentrybytheconsumer.Thecursorshouldbe
setonthelefthandsideoftheechofieldonthescreen.Thisisspace
filleduntiltherequiredstartpositionforthecurrencycharacteris
reached.Fordetails,seeInternationalCurrencyDisplayFormat
onpage344.
TableNote5:Ifrequiredbythehost,thescreencanbeconfigured
toaddextrazerosautomaticallytotheamountbuffer,afterthe
decimalpoint.ThisconfigurationisdefinedintheAppendBuffer.xml
file.
2-23
State Tables
G - Amount Check State
GAmountCheckState
Thisstatecheckswhethertheamountenteredcanbedispensed.
Thisdoesnotcheckforcoins.Twochecksareperformed:
Whethertheamountheldwithinaspecifiedbufferisamultiple
ofanidentifiedvalue.
Whethertheamountheldwithinaspecifiedbufferis
dispensablewhentakingintoaccountthecurrencyrequired,
denominationsavailable,dispenserstatusandcassettestatus.
Notecountsareignored.
Note:Fordualcashhandlers,thisstateisnotsupportedwhenthe
AmountCheckCondition(Range000003)onpage 226issetto
003.
Tobeabletocheckthatanamountisdispensable,Centralmust
havedownloadedtheDispenserCurrencyCassetteMappingTable,
whichassociatesthecurrencytype,cassettetypeanddenomination
forthehostandSST(seepage 1045).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.
2-24
State Tables
Table 2-11
G
- Amount Check State
Table
Entry
Number of
Characters
Contents
Description
StateType
AmountCheckConditionTrue
NextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoeswhenthe
amountcheckconditionindicatedbytableentry8
evaluatestoTRUE.
AmountCheckConditionFalse
NextStateNumber
256999)
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.
2-25
State Tables
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
2-26
State Tables
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
ThespecificcommandrejectreceivedbyCentral
indicatesamessagelengtherror
ERRORInvalidValue<fieldh1value>foundin
fieldh1ofDispenserCurrencyCassetteMapping
Table
Thevalueofsubfieldh1mustbeatwodigitASCIIhex
valueintherange01toFFinclusive.Ifitisnot,the
commandrejectB08Fieldvalueerror,datafieldvalue
outofrangeisreturned.
2-27
State Tables
Error Message
Cause(s)
fieldh2(atposition<value>)ofDispenser
Thevalueofsubfieldh2mustbeatwodigitASCIIhex
valueintherange01toFFinclusive.Ifitisnot,the
outofrangeisreturned.TheerroroutputtotheDebug
LoggivesthepositionoftheerrorintheDispenser
CurrencyCassetteMappingTablemessage.Thevalue
givenisthenumberofcharactersfromthebeginningof
themessagetowherethesubfieldstarts.
Thevalueofsubfieldh3mustbeasingledigitASCIIhex
valueintherange0toFinclusive.Ifitisnot,the
outofrangeisreturned.TheerroroutputtotheDebug
LoggivesthepositionoftheerrorintheDispenser
CurrencyCassetteMappingTablemessage.Thevalue
givenisthenumberofcharactersfromthebeginningof
themessagetowherethesubfieldstarts.
Thevalueofsubfieldh4mustbeafivedigitASCII
numericvalueintherange00000to99999inclusive.Ifit
isnot,thecommandrejectB08Fieldvalueerror,data
fieldvalueoutofrangeisreturned.Theerroroutputto
theDebugLoggivesthepositionoftheerrorinthe
DispenserCurrencyCassetteMappingTablemessage.
Thevaluegivenisthenumberofcharactersfromthe
beginningofthemessagetowherethesubfieldstarts.
2-28
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.
OverridingEntryMode,BufferandDisplayParameters
Theparametersspecifiedintableentry9canbeoverriddenusing
theDisplayDataFormat.xmlfile.Fordetails,refertoChapter5,
ConfiguringAdvanceNDCandAssociatedComponentsinthe
APTRAAdvanceNDCDevelopersGuide.
DataEntryandVoiceGuidance
Iftheconsumerhasselectedavoiceguidedsession,thefollowing
pointsmustbeconsidered:
ExitingtheInformation
EntryState
Iftheentereddataismaskedonthescreeninthisstate,theSST
willechokeyselectionwithabeeponly
IftheHideScreenoptionisselectedbytheconsumer,entered
dataisnotdisplayed,butonlyvoicedexceptwhenmasked
IfthisstaterequiresbothFDKsandnumerickeys,the
voiceguidedsessioncannotmaptheFDKstothenumeric
keypad.
TheSSTexitsfromtheInformationEntrystateoncetheconsumer
pressesanactiveFDKortheCancelkey.Italsoexitsfromthisstateif
theconsumerdoesnotpressakeywithinthespecifiedtimelimit.If
theconsumerpressestheEnterkey,ithasthesameeffectas
pressingFDKA(orFDKIifoptiondigit7aisset).Fordetails,see
EFourFDKSelectionFunctionStateonpage 219.
2-29
State Tables
EmulatedFDKsandTouchscreenKeyboards
TheSSTmaysupporttouchscreenFDKemulationinsteadof
physicalFDKs.Inthiscase,eightfixedtouchareasaredefinedon
thescreen,whichtheconsumertouchesinsteadofpressingthe
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
bufferspecifiedintableentry9ortheDisplayDataFormat.xmlfile
containsthedatathattheconsumerhasentered.Iftheconsumerhas
notenteredanydata,thebufferwillbeempty.Fordetailsofthe
generalpurposebuffersrefertotheAPTRAAdvanceNDC,
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,the
consumercanenterupto32charactersduringtheInformation
Entrystate.Thecharacterswillbeechoedonthescreenand
formattedasdefinedintheDisplayDataFormat.xmlfileortableentry
9.
2-30
State Tables
Table 2-14
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
data.Thisscreenisdisplayedonenteringthe
InformationEntrystate,andmustleavethecursorat
thestartofthedisplayarea.
256999)
256ZZZ)
doesnotrespondtotheconsumerscreenmessage
withinthepermittedtimelimit.Enter255ifthe
timeoutfunctionisnotrequired.SeeTableNote6.
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheCancelkeyis
pressed.
FDKA(orI)
NextStateNumber
FDKB(orH)
NextStateNumber
FDKC(orG)
NextStateNumber
pressesanFDKortoucharea.Enter255tomakean
FDKortouchareainactivewhiletheSSTisinthe
InformationEntrystate.
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.
2-31
State Tables
Table
Entry
Number of
Characters
Contents
Description
D=1Displaydataaskeyedin.Storedataingeneral
purposebufferC.
D=2DisplayXforeachnumerickeypressed.Store
dataingeneralpurposebufferB.
D=3Displaydataaskeyedin.Storedataingeneral
purposebufferB.
SeeTableNote9andTableNote10.
TableNote6:Whenatimeoutoccurs,theconsumerisasked
whethermoretimeisneeded.Iftheresponseisyes,theconsumer
canenterdataagain,butallpreviouslyentereddataislost.
TableNote7:Ifrequired,theSMSstylealphanumerickeyboard
layoutcanbeinstalledorconfiguredeitherbyediting
NDCKeyboard.xmlanddownloadingitduringsoftwaredistribution,
orbyusingtheXMLconfigurationdownloadmessage,describedin
XMLConfigurationDownloadonpage 1048.Fordetailsof
NDCKeyboard.xml,refertotheAPTRAAdvanceNDC,Developers
Guide.
TheXMLschemadefinitionprovidedwithAdvanceNDCisusedto
validatetheXMLfile.IftheXMLfileisnotvalid,AdvanceNDC
goestothedefaultClosestate.
TableNote8:AdvanceNDCdoesnotsupportmaskingof
charactersforSMSstyleentry,onlyforPCkeyboardentry.
TableNote9:WhenusedinstateH,thebufferidentifieswherethe
inputdataisstoredforfurtherprocessing,thatis,inthetransaction
requestsenttothehost.
TableNote10Ifrequired,theDisplayDataFormat.xmlfilecanbe
usedtooverridetheparametersdefinedintableentry9.Fordetails
oftheDisplayDataFormat.xmlfile,refertoChapter5,Configuring
AdvanceNDCandAssociatedComponentsintheAPTRAAdvance
NDCDevelopersGuide.
2-32
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
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
Displayscreenshownontheconsumerscreen
whiletheSSTsendsaTransactionRequestto
CentralandwaitsforaTransactionReply
command.ThisisusuallyaPleaseWaitscreen.
CentralResponseTimeoutNext
StateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifCentralfails
toreplytotheTransactionRequestwithinthe
permittedtimeinterval(timer03).
SendTrack2Data
SeeTableNote11.
SendTrack1and/orTrack3Data
SeeTableNote12.
SendOperationCodeData
SeeTableNote11.
2-33
State Tables
Table
Entry
Number of
Characters
Contents
Description
SendAmountData
SeeTableNote11.
SendPINBuffer(BufferA)Data/
SelectExtendedformat
SendGeneralPurposeBufferB
and/orGeneralPurposeBufferC
or
000254,256999)
000254,256ZZZ)
Tosendthegeneralpurposebuffer,thefollowing
valuesapply:
000Sendnobuffers
001SendBufferB.
002SendBufferC
003SendBuffersBandC
004007Reserved
Iftheextendedformatisselectedintableentry8,
thisentryisanExtensionstatenumber.Formore
informationaboutextensionstates,seeExtension
Statesonpage 25.
SeeTableNote13.
TableNote11:Thefollowingvaluesdeterminewhetherornotthe
specifieddataisincludedinthecorrespondingTransactionRequest
messagefieldsenttoCentral:
Table 2-16
Track 2 Data Send Modifier
Value
Send Data
000
No
001
Yes
TableNote12: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
2-34
State Tables
TableNote13:Theleastsignificantbitoftableentry8isusedto
indicatewhetherBufferAistobesentintheTransactionRequest
message.Bit7isusedtoselectanextendedformatforthe
TransactionRequeststateparametertablewhichallowstableentry
9toholdthestatenumberoftheassociatedextensionstatenumber,
asshowninthefollowingtable:
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
2-35
State Tables
Table
Entry
Number of
Characters
Contents
Description
SendOptionalDataFields
I L
(Range000015)
Thisentryisasfortableentry3butthedatafields
areasfollows:
SendOptionalDataFieldsQ to
V,wanda
(Range000255)
SendOptionalData.
(Range000255)
Bit
Field ID
1
2
3
4
5
6
7
8
I
J
K
L
ReservedforM
ReservedforN
ReservedforO
ReservedforP
areasfollows:
Bit
Field ID
1
2
3
4
5
6
7
8
Q
R
S
ReservedforT
U
V
w(CashDepositData)
a(ChequeprocessorMICR/codeline)
SeeTableNote14andTableNote15
areasfollows:
Bit
Field ID
1
2
UserDataFields
b(Countofgoodnotesandsuspectnotes
inescrowordirectlydepositedtocassette)
c(Notetypecountsforsuspectnotes)
d(Notetypecountsforcounterfeitnotes)
e(Barcodedata)
g(Bunchchequedepositdata)
SeeTableNote14
Reserved
Reserved
3
4
5
6
7
8
7
Mustbe000
Reserved
2-36
State Tables
Table
Entry
Number of
Characters
Contents
Description
EMV/CAM2ProcessingFlag
(Range000003)
Thisentryisbitencodedtocontrolthelevelof
EMV/CAM2processingtobeperformed,as
follows:
(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
SeeTableNote16
3
4
5
6
7
8
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
StatenumberofExtensionstate2.
Avalueof000disablesthisextension.
Ifavalueof255isusedforthisentry,the
applicationgoestothedefaultClosestate.
TableNote14:ChequeProcessorbufferaandBunchCheque
Depositbuffergaremutuallyexclusive.Ifbothareset,bufferg
takesprecedenceandbufferaisnotincludedintheTransaction
Request.
TableNote15:IfChequeProcessorbufferaisusedtodeposita
bunchofcheques,thecodelinesarenotincludedintheTransaction
Request,thatis,theMICR/codelinedetectedfieldissetto0andthe
MICR/codelinefieldisempty.
TableNote16:Ifbit2(partialEMV/CAM2processing)isset,the
EMV/CAM2bufferissenttoCentralwithallcurrentlyknowndata
requestedbyCentralbutwithoutanyEMVpreauthorisation
2-37
State Tables
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
2-38
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 221,JCloseStateon
page 240,isdisplayedontheconsumerscreen.
Ifastatementispresentedandnottakenbytheconsumerthenafter
Timer02(page 725)hasexpiredandpriortostateexit,Timer95
(page 729)isstarted.Whenthistimerexpires,thestatementis
captured(thisdoesnotapplytoreceiptsidewaysprinting).Ifthe
statementistaken,thetimerisstopped.Whilethetimerisrunning
anduntilthenextstatementisstagedaftercapture,exitfromthe
Closestateisdelayed.Ifnostatementispresented,Timer95isnot
startedandexitfromtheClosestateisdelayeduntilthenext
statementisstaged.
IfthereceiptprintersupportsretractandTimer69(describedon
page 728)expires,anyreceiptthathasnotbeenremovedishandled
asfollows:
Alongreceiptsisnotretracted.
Anormallengthreceiptishandledaccordingtotheregistry
configurationforhandlingreceipts.Fordetails,refertothe
APTRAAdvanceNDCDevelopersGuide.
OnanSSTwithanenvelopedispenser,anyenvelopethatisnot
takenbytheconsumerisretracted.Whentheenvelopeistakenor
retracted,theMEIisswitchedoff.
Cards
Ifthecardcannotbeejected,itiscapturedandscreenC04is
displayedfortheperiodspecifiedbyTimer02.Ifthecardisejected
butnottakenwithinthetimeperiodspecifiedbyTimer09
(page 727),itiscaptured.Fordetailsofconsumerdisplayscreens,
2-39
State Tables
J - Close State
seeCCardholderDisplayonpage 36.Fordetailsoftimer
formatinamessage,seeConfigurationParametersLoadon
page 1015.
Whenacardisejected,orifnocardispresentwhentheClosestate
isentered,Timer02isstarted.TheSSTdoesnotexitfromtheClose
stateuntilthistimerexpires.Thistimerprovidesaguaranteed
minimumdisplaytimefortheclosescreen.
Whenacardisejected,thebeeperissoundedtoremindthe
consumertotakethecard.Ifyoudonotwanttousethisfeature,
youcansetMessageModeoption4btoinhibitthebeeper.For
detailsoftheoption,refertotheAPTRAAdvanceNDC,Supervisors
Guide.
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
(Range000Z99)
ScreendisplayedonentrytotheClosestate.Thisis
onlydisplayedifareceiptisdeliveredintheClose
stateandtheSSThasnotbeeninstructedbythelast
TransactionReplymessagetocapturethecard.The
lastTransactionReplyCommandperformed
determinesthescreentextasfollows:
CardBeforeCashTakecashandreceipt
FastCashTakecard,cashandreceipt
OtherCommandsTakecardandreceipt
Note:Ifthereceiptisejectedbeforereachingthe
Closestate,theReceiptDeliveredScreenisnot
displayed.
2-40
State Tables
J - Close State
Table
Entry
Number of
Characters
Contents
Description
NextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesafterthestate
iscompleted.
NoReceiptDeliveredScreen
Number
(Range000Z99)
ScreendisplayedonentrytotheClosestate.Thisis
onlydisplayedifnoreceiptisdeliveredinthe
ClosestateandtheSSThasnotbeeninstructedby
thelastTransactionReplymessagetocapturethe
card.ThelastTransactionReplyCommand
performeddeterminesthescreentextasfollows:
CardBeforeCashTakecash
FastCashTakecashandcard
OtherCommandsTakecard
CardRetainedScreenNumber
(Range000Z99)
ScreendisplayedonentrytotheClosestate,
informingtheconsumerthatthecardhasbeen
retained.ThisisonlydisplayediftheSSThasbeen
instructedbythelastTransactionReplymessageto
capturethecardduringtheClosestate.Thisscreen
isalsodisplayedforfoursecondsifthecardis
capturedduetotimer09expiring(cardnottaken).
StatementDeliveredScreen
Number
(Range000Z99)
Displayscreentobeoverlaidwheneitherthe
receiptisdelivered(entry2)orthereisnoreceipt
delivery(entry4).Thisscreenisonlydisplayedif
thestatementiscutanddeliveredinaClosestate
andtheSSThasnotbeeninstructedbythelast
TransactionReplymessagetocapturethecard.
Mustbe000
Reserved
BNANotesReturnedScreen
Number
(Range000Z99)
ScreendisplayedonentrytotheClosestate,
informingtheconsumerthattheBunchNote
Acceptor(BNA)notesarebeingreturned.
256999)
256ZZZ)
Thestatenumberoftheoptionalextensionstate1.
SeeTableNote17.
TableNote17:Youcanuseeitherofthefollowingmethodsto
processCardBeforeCashandFastCashtransactions:
UsedifferentClosestates
SendascreenmodificationwiththeTransactionReply
command.
2-41
State Tables
J - Close State
FordetailsofCardBeforeCash,FastCashandProcess
DocumentWithCashtransactions,seetheTerminalFunctionsfor
TransactionCompletionsectioninChapter 10,Centralto
TerminalMessages.
Table 2-22
Extension State 1 to State J
Table
Entry
Number Of
Characters
Contents
Description
StateType
ChequeProcessorTake
DocumentScreenNumber
(Range000Z99)
Screennumberrequiredfortheerrorrecovery
actionswhichmaytakeplaceinthisstateifthe
chequeprocessorispresentandtheCheque
ProcessorDocumentReturn/RetainFlagissetto
either001or002.
ChequeProcessorDocument
Return/RetainFlag
(Range000002)
Thisflagcontrolstheerrorrecoveryactionswhich
maytakeplaceinthisstateifthechequeprocessor
ispresent.
Theflagcanbesetasfollows:
000Retain
001Returnandretractifnottaken
002Returnanddonotretractifnottaken.
SeeTableNote18.
Mustbe000
Reserved
Extensionstate2.Thisvalueis000ifthe
parametersintheextensionstatearenotapplicable
orrequired.
SeeTableNote19.
67
Mustbe000
Reserved
BNANotesReturn/Retain/
LeaveFlag
(Range000002)
Thisflagcontrolstheerrorrecoveryactionswhich
maytakeplaceinthisstateifaBNAispresent.
Theflagcanbesetasfollows:
000Return
001Retain
002Leavenotesintheescrow.Ifthisisset,the
INITBNASupervisoroptionmustbeusedtoclear
thedevice,dependingonhowautomaticerror
recoveryisconfigured.
SeeTableNote20,TableNote21andTableNote22.
Mustsbe000
Reserved.
TableNote18:OnentrytotheClosestate,theapplication
determineswhetherachequeprocessorisconfigured,andifso,
2-42
State Tables
J - Close State
whetheranyerrorrecoveryactionisrequired.Ifthedevicehasa
recoverableerrorconditionandstillhasachequewithinit,itwill
attempttoretain/captureorreturnthedocumentasdefinedby
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
2-43
State Tables
J - Close State
doesnothaveaccess,screenU0059isjournaledtogetherwiththe
securitytraceheader.
Ifanerroroccurswhilemovingthedocumenttobin2,an
unsolicitedmessageissenttothehost.Iftheerrorhasanassociated
severityoffatal,thenanyfurtherattemptstousethedevicewill
yieldanerrormessage.
Allchequedataisdeletedwhenthisstateistaken,includingfiles
thathavebeencopiedandrenamedforusebytheImageMark
PassportATMImageAgent.
TableNote19:Ifanextensionstateisnotincluded,thedefault
actionforthechequeprocessordocumenterrorrecoveryistoretain
anychequefoundintheClosestate.
TableNote20:OnentrytotheClosestate,theSSTwilldetect
whetheracashacceptororarecyclingunitisconfigured.Ifthe
deviceisinarecoverablestateandstillhasnotesintheescrowora
directdepositisstillinprogress,theactiondefinedinextension
stateentry8(BNAReturn/Retain/LeaveFlag)isattempted.Ifa
directdepositisinprogress,thenotescannotbereturned.
Ifreturnednotesnottakenbytheconsumerhavebeenretractedto
theescrow,thenotesarenotmovedfromtheescrowwhateverthe
settingofextensionstateentry8.Fordetailsofconfiguringnote
retracttotheescrow,refertoChapter5,ConfiguringAdvance
NDCandAssociatedComponentsintheAPTRAAdvanceNDC,
DevelopersGuide.
Ifthereturnednotesaretakenlatebytheconsumer,thatis,justas
theretractoperationstarts,AdvanceNDCdoesnotsendan
unsolicited(w7)messagebutanyconfiguredretractnotesscreenis
displayedwhentheretractoperationstarts.
Notecountsarejournaledasfollows:
Ifthedepositusestheescrow,theescrownotecountsare
journaled
Ifthedepositdoesnotusetheescrow,thevaultednotecounts
arejournaled.
Iferrorconditionsaredetected,automaticerrorrecovery(AER)is
startedattheendoftheClosestateafterthecardhasbeenreturned
totheconsumer.Automaticerrorrecoveryisconfigurablethrough
theClassConfigurator.Fordetails,refertotheAPTRAAdvance
NDCDevelopersGuide.
TableNote21:IftheClosestateextensionstateentry8(BNANotes
Return/Retain/LeaveFlag)issetto001(Retain)andtheTransaction
Requestislostonthenetwork,thereisnowaytoidentifythe
2-44
State Tables
J - Close State
consumertowhomthenotesbelongduetothemaskingofthecard
number.ThisisincompliancewithPaymentCardIndustry(PCI)
rules.
TableNote22:IfAERisenabledandnotesareleftintheescrowin
theClosestate,thenoteswillbeprocessedaspartofAER.Tomake
surenotesareleftintheescrow,AERmustbeturnedoffor
configuredtoleavenotesintheescrow.FordetailsofAER
configuration,refertoChapter5,ConfiguringAdvanceNDCand
AssociatedComponentsoftheAPTRAAdvanceNDCDevelopers
Guide.
Table 2-23
Extension State 2 (J - Close State)
Table
Entry
Number Of
Characters
Contents
Description
StateType
ZExtensiontype
ChequeProcessorWaitfor
ChequesScreenNumber(range
000Z99)
Thisscreenisusedtoaskthecustomertowaitfor
additionalchequestobereturnedwhenmorethan
onebunchofchequesistobereturned.Ifthisvalue
is000orthisextensionstateisnotpresent,the
ChequeProcessorTakeDocumentScreenis
displayeduntilallbuncheshavebeentaken
RetractingPresentedMedia
ScreenNumber(range000Z99)
Screendisplayedifmediapresentedwithinthis
statearenottakenandarebeingretracted.This
screendoesnotapplytocardsorpassbooks,which
havespecificscreensdefinedforthispurpose.
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
2-45
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.
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
2-46
State Tables
_ - Expanded FIT Switch State
_ExpandedFITSwitchState
ThisstateoperatesasstatetypeK,describedonthepreviouspage,
exceptthatmoreswitchcapacityhasbeenaddedthrougha
mandatoryextensionstate.Forexample,iftheFITidentifiedduring
theCardReadstatecontainsanextstateindexof3,thenextstate
numberisfoundintableentry5.
Table 2-25
Table
Entry
Index
Number
of Chars
Contents
Description
StateType
_
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
NextStateNumber
256999)
256ZZZ)
StatenumberofthemandatoryExtensionstate.
2-47
State Tables
Table 2-26
Extension to State _
Table
Entry
Index
Number
of Chars
Contents
Description
StateType
Z
NextStateNumber
NextStateNumber
NextStateNumber
10
NextStateNumber
11
NextStateNumber
12
NextStateNumber
13
NextStateNumber
14
NextStateNumber
2-48
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.
2-49
State Tables
Table 2-27
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
ScreendisplayedduringaCardWriteoperation.
GoodWriteNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesaftera
satisfactoryTrackwriteoperation.
BadWriteNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheTrack
writeisunsuccessful.
NoWriteAttemptedNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifnodataor
invaliddataispresentintheTrackbuffer.This
stateisalsousedifastartand/orendsentinelis
missing,ortheTrackdatabuffersaretoolong.
69
12
Mustbe000foreachtableentry
Reserved
2-50
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.
message7isplayedonentrytothisstate.Fordetails,seethe
ControlCodesforSpecialFeaturessectioninChapter 3,Screen
Data.
2-51
State Tables
Table 2-28
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
thePINthefirsttime.Thisscreenisdisplayedon
enteringthePINEntrystate.Itmustleavethe
cursoratthestartofthePINEntrydisplayarea.An
Xisdisplayedforeachkeypressed.
256999)
256ZZZ)
doesnotenterthePINwithinthepermittedtime
limit.Enterstatenumber255ifthetimeout
256999)
256ZZZ)
pressestheCancelkeybeforethemaximum
numberofdigitsspecifiedforthePINhavebeen
entered.
NextStateNumber
256999)
256ZZZ)
verificationofacorrectPINentry.APreSet
OperationCodebufferstate(clearingthefunction
keybufferbeforeTransactionSelection)usually
followsacorrectPINentry.SeeTableNote25.
LocalPINCheckMaximumBad
PINsNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthecorrect
PINhasnotbeenenteredafterthenumberof
attemptsallowedbytableentry9.Thiscouldbea
CardWritestateinordertoupdatetheTrack3PIN
retryfield.
SeeTableNote23,TableNote24,andTableNote
25.
2-52
State Tables
Table
Entry
Number of
Characters
Contents
Description
LocalPINCheckErrorScreen
Number
(Range000Z99)
Displayscreenthatpromptstheconsumerto
reenterthePIN.Thisscreenisdisplayedaftereach
incorrectPINentryattempt.AnXisdisplayedfor
eachkeypressed.Afterthenumberofreentry
attemptsallowedbytableentry9,theSSTenters
thestatedeterminedbytableentry6.
Number
256999)
256ZZZ)
LocalPINCheckMaximumPIN
CheckRetries
(Range001009)
MaximumnumberofincorrectPINentriesbefore
theSSTentersthestatedeterminedbytableentry6.
ThisentryisusedasthePINretrycountifthePIN
retrycountisnotonthecard(FITentryPRCNT=
FF).SeeTableNote23andTableNote25.
TableNote23:ThesefieldsarealsousedwhentheCheckRemote
PINminimumlengthoptionintheFITisused.(Thehighorder
threebitsofPANLNarenot0andcontainavaluelessthanorequal
toPMXPN.PANLNdoesnotcontainFFhex.)Thefieldsareusedin
thesamewayasforlocalverification.AnincorrectPINisonethatis
lessthantheminimumlength.
TableNote24:TheLocalPINCheckMaximumBadPINsNext
StateNumbershouldbesettoanonzerovalidvalue,oranerror
willoccur.
TableNote25:TosupportsecurePINencryption,fields5,6,7and
9mustalwaysbesetup,astheyareusedtocontrolthenumberof
allowedPINretrieswhenfewerthanfourPINdigitsareentered.
WithsecurePINencryption,acheckfortheminimumfourPIN
digitsisperformedwhetherornottheFITspecifiestocheckfor
shorterPINs.
2-53
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.
2-54
State Tables
Whetherunsolicitedmessagesarereporteddependsonenhanced
configurationparameteroption32.Fordetails,seeOption32
UnsolicitedReportingControlonpage 710.
Table 2-30
Table
Entry
Number of
Characters
Contents
Description
StateType
PictureType
(Range000001)
SpecifiestheSSTsupplieddatatosuperimposeon
theimage
000picturetype0
001picturetype1
NextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesaftertakingthe
picture
49
18
Mustbe000foreachtableentry
Reserved
TableNote26:InAdvanceNDC,thereisnodifferenceinthetwo
picturetypes.
TableNote27OnNCRSSTs,itisnotpossibletosuperimposeSST
dataontheimagebecauseAPTRAXFSdoesnotsupportthis
feature.However,theinformationisincludedinthefilenameofthe
savedimage.Fordetailsofsuperimposeddatasupportonother
vendorshardware,refertotheAPTRAAdvanceNDC,MultiVendor
SupportReferenceManual.
2-55
State Tables
R - Enhanced Amount Entry State
REnhancedAmountEntryState
Usethisstateifyouwishtousemultilanguagescreensfor
enhancedamountentry.Thestandardfieldlengthforthisbufferis
eightdigits,ortwelveifEnhancedConfigurationParameteroption
1isused;butitcanbeconfiguredforanynumberuptotwelve
digitsthroughAppendBuffer.xml.
Note:Ifyouwanttoallowtheconsumertoselectthenotemixtobe
dispensed,seez017NoteMixSelectionStateonpage 2161.
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
canbedownloaded,asdescribedinXMLConfiguration
Downloadonpage 1048,orcanbeinstalledlocally.
FordetailsofAppendBuffer.xml,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
2-56
State Tables
Table 2-31
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
Numberofdisplayscreenpromptinganamount
entry.
256ZZZ)
Statenumbertowhichtheapplicationgoesifthe
consumerfailstoentertheamountwithinthe
specifiedtimelimit.Enter255ifthetimeout
256ZZZ)
Statenumbertowhichtheapplicationgoesifthe
consumerpressestheCancel key.
FDKA(orI)
NextStateNumber
FDKB(orH)
NextStateNumber
FDKC(orG)
NextStateNumber
pressesthespecifiedFDK.NormallyoneFDKis
usedtospecifywhethertheamountentryiscorrect
andanothertospecifyincorrect.Theotherkeysare
inactive.Enter255todeactivateanyFDKortouch
area.
FDKD(orF)
NextStateNumber
256ZZZ)
StatenumberoftheExtensionstate.
Table 2-32
Extension to State R
Table
Entry
Number of
Characters
Contents
Description
StateType
DocumentAmountBuffer
(Range000002)
Thisfielddetermineswhichbuffertheamount
enteredwillbestoredin:
000Amountbuffer
001BufferB.
002BufferC
2-57
State Tables
Table
Entry
Number of
Characters
Contents
Description
AmountDisplayScreen
Number
(Range000Z99)
SeeTableNote28.
Overlayscreenforsettingthecursorpositionon
theconsumerscreen.Thisscreenoptionallydefines
theinitialdisplayformatbeforeamountentryby
theconsumer.Thecursorshouldbesetonthe
lefthandsideoftheechofieldonthescreen.Thisis
spacefilleduntiltherequiredstartpositionforthe
currencycharacterisreached.Fordetails,see
InternationalCurrencyDisplayFormaton
page 345.
Thedefaultechofieldforeightdigitsis:
bbbbb$b0.00
whereb=space.
Thedefaultechofieldfortwelvedigitsis:
bbbbbbbbb$b0.00
whereb=space.
StartCAVcommand
(Range000001)
NotusedbyAdvanceNDC.
LanguageDependentScreen
Flag
(Range000001)
Thisflagdeterminesifthescreendefinedintable
entry3ofthisextensionstateislanguage
dependent:
000Notlanguagedependent
001Languagedependent,regardlessoflanguage
groupsize.
69
12
Mustbe000
Reserved
TableNote28:TheAmountEntryScreenwillnotbeadjustedfor
language,unlessalanguagehasbeenselectedandthelanguage
groupsizeis1000orgreater.Ifthelanguageadjustedscreenhasnot
beenloaded,theunadjustedscreenwillbeusedinstead.
2-58
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
Table
Entry
Number of
Characters
Contents
Description
StateType
NoLanguageCodeNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthelanguage
codeisillegalorcannotberead.
LanguageCode=0NextState
256999)
256ZZZ)
codeis0.
256999)
256ZZZ)
codeis1.
2-59
State Tables
Table
Entry
Number of
Characters
Contents
Description
256999)
256ZZZ)
codeis2.
256999)
256ZZZ)
codeis3.
256999)
256ZZZ)
codeis4.
256999)
256ZZZ)
codeis5.
Extensionstatenumber
(Range000999or000ZZZ)
StatenumberoftheExtensionstatecontainingthe
nextstatesforlanguagecodes69.
Avalueof255meansthatthereisnoExtension
state,andlanguagecodes69causetheNo
LanguageCodenextstateexittobetaken.
2-60
State Tables
Table 2-34
Extension to State S
Table
Entry
Number of
Characters
Contents
Description
StateType
256999)
256ZZZ)
codeis6.
256999)
256ZZZ)
codeis7.
256999)
256ZZZ)
codeis8.
256999)
256ZZZ)
codeis9.
69
Mustbe000
Reserved
2-61
State Tables
T - Card Read - PIN Entry Initiation State
TCardReadPINEntryInitiation
State
YoucanusethisstateinsteadoftheCardReadstateandoptionally
initiatePINentrybytheconsumeratthesametimeasthecardis
read.
Thisstatemustbeusedifasmartdipcardreaderisusedandsmart
cardsaretobeaccepted.However,ifthesmartdipcardreaderis
usedwithoutthechipconnectbitbeingset,itwillbehaveasa
standarddipreader.Inthiscase,CardReadstateAcanalsobe
used.
AdifferencebetweenthisstateandtheCardReadstateisthatthis
statedoesnotallowthecardtobereturnedearlyusingtheCard
ReturnFlagintableentry8.
Whenused,thisstatemustbethefirststatetableusedduring
transactionprocessingbyassigningstatenumber000toit.TheSST
automaticallyentersstate000whenputintoservice.
ThisstateperformsthesamefunctionsastheACardReadstate
andoptionallyenablesthekeyboardforPINentrywhilethecardis
beingread,asfollows:
TheSSTdisplaysascreenpromptingtheconsumertoentera
card
Optionally,theSSTdisplaysascreenpromptingtheconsumer
toenteraPINwhilethecardisread
ThestatetableidentifiesthenextstatenumberthattheSSTgoes
tofollowingasuccessfulcardread
TheSSTdisplaysanerrorscreenifthecardcannotberead
Thestatetablespecifieswhichcardtracksaretoberead.
IfPINentryisenabledwhilethecardisbeingread,thekeyboardis
enabledforamaximumnumberofnumerickeys(16).Youcan
specifywhichFDKsaretobeactiveasAccept orClear keys.TheClear
keyitselfisalwaysactiveduringPINentry.TheEnter keyisactiveif
youspecifyFDKAasanAcceptkey.
Note1:TheBAPE(BasicAlphanumericPINpadEncryptor)does
notsupportthisearlyenablingofthekeyboardwithsecurePIN
entry.WhentheBAPEisconfigured,thekeyboardisnotenabledfor
PINentryinthisstate;thekeyboardisenabledonlyinthePIN
Entrystate.
2-62
State Tables
Note2:Thisstatealsosupportssmartcards.Fordetailsofhow
smartcardsarehandled,seetheACardReadStatesection.
Oncethecardhasbeenreadsuccessfully,processingcontinuesto
thenextstate.
PINEntryEnabled
IfPINentryinitiationisenabled,thenextstatemustbeaPINEntry
state.AninterveningFITSwitchstateisallowed.
TheminimumandmaximumPINentrylengthisobtainedfromthe
FITbeforePINentrycommences.Iftheconsumerfailstoinputthe
PINquicklyenough,thetransactionflowwillproceedtothe
Timeoutstate.
Thelayoutofassociatedkeyboardsmustbeidenticaltothose
specifiedforthestatethatfollowstheCardReadPINEntry
Initiationstate.
Forsecurityreasons,itissafertoenterthePINusingthephysical
keyboardratherthanatouchscreenkeyboard.
PINEntryDisabled
AudioSupport
SmartDipCardReader
IfPINentryinitiationisdisabled,therearenorestrictionsonthe
followingstateandPINentrycantakeplacelaterundernormal
stateflowcontrol,forexample,afterlanguageselectionorjust
beforetheTransactionRequestmessageissent.
message7isplayedassoonasthecardisdetectedbytheSST.For
details,seetheControlCodesforSpecialFeaturessectionin
Chapter 3,ScreenData.
StateTsupportsthesmartdipcardreaderforEMVprocessing.If
theSSThasasmartdipcardreaderandoneormoreoftheCard
ReadConditions(stateentries57)hastheChipConnectBitset,
thenthecardislatchedonentrytothereaderandanattemptis
madetopoweronthechiponthesmartcard.
Ifthepoweronattemptissuccessful,thentheNoFITMatchnext
stateistakenandnomagneticstripeinformationwillberead.
Ifthepoweronattemptfails,thereaderunlatchesthecardandthe
consumerisaskedtoremovethecardandwait.Thescreendefined
inExtensionstateentry6isavailableforthis.Ifthecardisremoved,
themagneticstripedataisread,magneticstripeprocessing
commencesandthecardreadconditionsarechecked.
Note1:Ifthestateisconfiguredtolatchthecardandthepoweron
issuccessful,thePINentryscreenisneverdisplayedandPINentry
initiationwillcommenceifenabled.
2-63
State Tables
Note2:Ifasmartdipreaderisused,butnochipconnectbitisset,
thesmartdipreaderbehavesasastandarddipreader.
FormoreinformationaboutsmartcardhandlinginAdvanceNDC,
seeChapter 12,EMVSmartCardHandling.
Table 2-35
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
acard.WhiletheSSTiswaitingforacardentry,
thisscreenwillbedisplayed.
GoodReadNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoes:
1.FollowingagoodreadofthecardifFITsarenot
used(TableEntry3inExtensionstate=000)
or
2.IftheFinancialInstitutionnumberonthecard
matchesaFinancialInstitutionnumberinaFIT.
Error(Misread)ScreenNumber
(Range000Z99)
Screenthatisdisplayedifanunsuccessfulread
occurs;orforasmartdipcard,theconsumerfails
totakethecardbeforetimer72expires.
ReadCondition1
ReadCondition2
ReadCondition3
Thesethreeentriesspecifywhichcardtrack(s)and
/orchipdatawillberead.Thepossiblevaluesfor
theseentriesarethesameasfortheACardRead
stateinTable 24onpage 29.
Reserved
Thisfieldisnotused.Theearlycardejectfeatureis
notsupportedbythisstate.
256999)
256ZZZ)
StatenumberoftheExtensionstatecontaining
informationforparallelPINentry.
2-64
State Tables
Table 2-36
Extension to State T
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
DisplayscreenthatpromptstheconsumertoenteraPIN.
Thisscreenisdisplayedoncardentry.Thescreenmustleave
thecursorpositionedatthebeginningofthePINEntry
displayarea.AnXisdisplayedforeachkeypressed.The
Track1namecannotbedisplayedatthistimebecausethe
cardhasnotbeenread.
Ifthisentryis000,PINentryinitiationisnotenabled.
NoFITMatchNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthefinancialinstitution
numberonthecarddoesnotmatchanyFIT.IfFITsarenot
used,thisentrymustbe000.TheNoFITmatchexitisalso
takeniftheSSThasasmartdipreader,oneofthechip
connectbitsisset,andtheATRsucceeds.
ClearKeyMask
(Range000255)
AbinaryencodedvaluespecifyingtheFDKsortouchareas
thatareactiveasClearkeysduringPINentry.Eachbitrelates
toanFDKortoucharea.Bit0relatestoFDKA(orFDKA
toucharea);bit7relatestoFDKI(orFDKItoucharea).Ifa
bitis1,therelativeFDKortouchareaisactive.Ifabitis0,
therelativeFDKortouchareaisinactive.
SeeTableNote29.
AcceptKeyMask
(Range000255)
AbinaryencodedvaluewhichspecifiestheFDKsortouch
areasthatareactiveasAcceptkeysduringPINentry.Eachbit
relatestoanFDKortoucharea.Bit0relatestoFDKA(or
FDKAtoucharea);bit7relatestoFDKI(orFDKItouch
area).Ifabitis1,therelativeFDKortouchareaisactive.Ifa
bitis0,therelativeFDKortouchareaisinactive.
SeeTableNote29.
ScreenNumber
(Range000Z99)
Displayscreenthatpromptstheconsumertoremovethecard
andwaitifthecardreaderisasmartdipcardreader,anda
chipconnectbitisset,buttheATRfails.Thisscreenis
displayeduntiltheconsumerremovesthecardortimer72
expires.
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
2-65
State Tables
TableNote29:Theeightbitsrepresentthebinaryequivalentofan
AcceptkeyorClearkeymask.
Forexample,inthefollowingmask:
b7
b6
b5
b4
b3
b2
b1
b0
thethreedecimalcharactersintableentry4or5are018andthe
activeFDKsortouchareasareBandF.
2-66
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 269.
Table 2-37
Table
Entry
Number of
Characters
Contents
Description
StateType
DeviceNumber
Devicenumberor000(undefined)
Fordetailsofthesupporteddevicesandtheir
associateddevicenumbers,seeSupported
Devicesonpage 269
Ifthisisdefined,itisusedtoidentifythedevice,
otherwisetableentry4(DeviceIdentifierGraphic)
isused
TheDeviceUnavailableNextStateistakenifthe
identifieddeviceisnotpresentornotsupported,or
ifthedevicenumberisinvalid
SeeTableNote30,TableNote31andTableNote32
DeviceAvailableNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthedevice
andoptionalsubcomponentareinagood
condition
2-67
State Tables
Table
Entry
Number of
Characters
Contents
Description
DeviceIdentifierGraphic(DIG)
DecimalrepresentationoftheDIG
Fordetailsofthesupporteddevicesandtheir
associatedDIGs,seeSupportedDeviceson
page 269
Thisisusedonlyiftableentry2(DeviceNumber)
isundefined(000)
TheDeviceUnavailableNextStateistakenifthe
identifieddeviceisnotpresent,notsupported,or
itsDIGisinvalid
DeviceUnavailableNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthedeviceis
inafatalorsuspendconditionorisnotpresent
SeeTableNote32
DeviceSubComponent
Identifier
Indexofthesubcomponentasreportedwithinthe
FitnessDatasolicitedstatusmessageforthe
specifiedDIGor000(overalldevice)
Identifiesthesubcomponentofadevice
Thisisusedonlywhentableentry4(Device
IdentifierGraphic)hasbeenusedtoidentifya
deviceandappliesonlytocashhandlers
000
Reserved
000
Reserved
000
Reserved
TableNote30:Youcanspecifythedeviceforwhichyouwantto
querythefitnessinthefollowingways:
Usingtableentry2(DeviceNumber)tospecifythedevice
number
Usingtableentry4(DIG),andoptionallytableentry6
(SubComponentIdentifier)forcashdispensers,tospecify
theDIG.
NCRrecommendsthatyouusetheDIGtoidentifythedevice.
2-68
State Tables
TableNote31: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 719.
TableNote32:TheSubComponentIdentifierisonlyusedwhen
queryingacashhandlerforthefitnessofacassettetype.Ifthe
cassettetypeisnotpresent,itisreportedasunavailable.
SupportedDevices
Thefollowingtableliststhesupporteddevicesandtheassociated
DeviceNumberandDIGforuseintheDeviceFitnessFlowSelect
state:
Table 2-38
State U - Supported Devices
Device
Device Number
(table entry 2)
Decimal Value of DIG (table entry 4) and Subcomponent Index (table entry 6)
CardReader/Writer
003
068=D
CashHandler
SeeTableNote33
004
069=E
EnvelopeDepository
005
070=F
ReceiptPrinter
006
071=G
JournalPrinter
SeeTableNote34
007
072=H
NightSafe
010
075=K
2-69
State Tables
Device
CassetteType1
SeeTableNote35
Device Number
(table entry 2)
015
Dependingondeviceconfiguration,asfollows:
Tableentry4:
69=E(singlecashhandlerordualcashhandleremulating
asinglecashhandler)
100=d(primarycashhandler)
101=e(secondarycashhandler)
Tableentry6:
001
CassetteType2
SeeTableNote35
016
Tableentry4:
asinglecashhandler)
Tableentry6:
002
CassetteType3
SeeTableNote35
017
Tableentry4:
asinglecashhandler)
Tableentry6:
003
CassetteType4
SeeTableNote35
018
Tableentry4:
asinglecashhandler)
Tableentry6:
004
CassetteType5
SeeTableNote35
095
Tableentry4:
asinglecashhandler)
Tableentry6:
005
2-70
State Tables
Device Number
(table entry 2)
Device
CassetteType6
SeeTableNote35
096
Fortableentry4:
E=69Singlecashhandlerordualcashhandleremulating
asinglecashhandler
Fortableentry6:
006
CassetteType7
SeeTableNote35
097
Tableentry4:
asinglecashhandler)
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.
TableNote33:IfEnhancedConfigurationOption76issetto000,
queryingthedevicefitnessreportsthecombinedfitnessofthecash
handlerandcassettes.
TableNote34:IfEnhancedConfigurationOption35issetto001
(EJonly)or002(dualmode),thejournalprinterfitnessisreported
asgoodiftheEJlogfileisinagoodconditionevenifthehardcopy
journalprinterisinafatalcondition.
2-71
State Tables
TableNote35:ThisisavailableonlywhenEnhanced
Configurationoption76issetto001
CashHandlers
Thefollowingtablegivesexamplesofthetableentriesusedinthe
DeviceFitnessFlowSelectstatetoquerythefitnessofdifferentcash
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:
Tableentry4identifiesthedeviceasasinglecashhandler
ordualcashhandlerconfiguredtoemulateasinglecash
handler
Tableentry6identifiescassettetype1
Tableentry2identifiescassettetype3,sotableentry4is
notchecked
Tableentry6isnotcheckedbecausetableentry4isnot
used
Tableentry2identifiescassettetype3,sotableentry4is
notchecked
Tableentry6isnotcheckedbecausetableentry4isnot
used
Queriesthefitnessofcassettetype3intheprimarycash
handlerasfollows:
Tableentry4identifiesthedeviceastheprimarycash
handler
Tableentry6identifiescassettetype3
2-72
State Tables
V - Language Select From Card State
VLanguageSelectFromCardState
Inthisstateyoucanuseonesetofstatetablestodisplayscreensin
differentlanguageswithinthesametransaction.Thisisdetermined
byacodeontheconsumerscard.Thecodeisaonecharacterfield
andislocatedusingtheLanguageCodeIndexparameter(PLNDX)
intheFIT.Formoredetails,seeChapter 8,FinancialInstitution
Tables.
Note:Alanguageselectedbytheconsumerontheinitiationofa
voiceguidedsessiontakesprecedenceoverthelanguageselected
fromthecard.
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
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesafterselecting
thescreengroup.
LanguageCode
(Range09)
Decimalnumberintherange09identifyingthe
codeforscreengroup1.
LanguageCode
(Range09)
LanguageCode
(Range09)
LanguageCode
(Range09)
2-73
State Tables
V - Language Select From Card State
Table
Entry
Number of
Characters
Contents
Description
LanguageCode
(Range09)
LanguageCode
(Range09)
ScreenGroupSize
(Range000400)
Numberofscreensineachlanguagegroup.
Whenamultilanguagescreenbaseintherange
001to009isspecified,thevalueismultipliedby
1000togive1000,2000,....9000.
Ifextendedscreengroupsareenabledandavalue
intherange010to099isspecified,thevalueis
multipliedby100togive1000,1100,1200....9900.
Tospecify1000screens,setavalueof001.
Ifextendedscreengroupsareenabledyoucan
specifyascreengroupsizebetween1000and5000
usingthevalues010to050.Thesevaluesare
multipliedby100togivethescreengroupsize.
Forinformationonenablingextendedscreen
groups,refertoChapter5,ConfiguringAdvance
NDCandAssociatedComponentsintheAPTRA
2-74
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
(Base36range000254or256ZZZ).
FDKDNextStateNumber
FDKFNextStateNumber
FDKGNextStateNumber
FDKHNextStateNumber
FDKINextStateNumber
2-75
State Tables
X - FDK Information Entry State
XFDKInformationEntryState
Tableentries29intheExtensiontothisstatecontainvaluesrelating
toFDKsAI.WhentheconsumerselectsanFDK,thisstate
placesthecorrespondingvalueintheGeneralPurposebufferor
AmountbufferthatyouhavespecifiedinTableEntry7.
Youcanusethisfunction,forexample,whenascreenoffersa
selectionoffixedamountsthattheconsumercanselectbypressing
aparticularFDK.ThisstatetranslatestheFDKselectedbythe
consumerintoavaluethatisplacedinthespecifiedbuffer.
TheFDKkeycodeisstoredintheFDKbufferforusebyanFDK
Switchstate.
Layouts.
Note:Iftheconsumerhasselectedavoiceguidedsession,thisstate
checksAudioGuidanceData.xmltoidentifythenumerickeysusedto
representtheFDKs,whicharealsoactiveunlesstheconsumerhas
chosentohidescreens.
Table 2-42
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
Displayscreenthatpromptskeyselectionby
consumer.
256999)
256ZZZ)
failstorespondtothemessagewithinthe
permittedtimelimit.Enter255ifthetimeout
2-76
State Tables
Table
Entry
Number of
Characters
Contents
Description
256999)
256ZZZ)
keyispressed.
FDKNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifanFDKor
touchareaispressed.
256999)
256ZZZ)
StatenumberofExtensionstatecontaining
assignedvaluesfortheeightFDKsortouchareas.
BufferID
(Range010039)
Identifieswhichbufferistobeeditedandthe
numberofzerostobeaddedtothevaluesspecified
intheExtensionstate:
01XGeneralpurposebufferB.
02XGeneralpurposebufferC
03XAmountbuffer.SeeTableNote37and
Table 230.
Xspecifiesthenumberofzerosintherange09
FDKsActiveMask
(Range000255)
SpecifiestheFDKsortouchareasthatareactive
duringthisstate.EachbitrelatestoanFDKor
toucharea.Bit0relatestoFDKA(orFDKA
toucharea);bit7relatestoFDKI(orFDKItouch
area).Ifabitis1therelativeFDKortouchareais
active.Ifabitis0therelativeFDKortouchareais
inactive.SeeTableNote36.
Mustbe000
Reserved
FDKActiveMask.Forexample,inthefollowingmask
b7
b6
b5
b4
b3
b2
b1
b0
thethreedecimalcharactersintableentry8are060andtheactive
FDKsortouchareasareC,D,FandG.
2-77
State Tables
TableNote37:Ifused,theAmountbufferwillcontainuptotwelve
digits,dependingontheoptionselected.Ifthisstateisfollowedby
anAmountCheckstatewithanAmountCheckConditionsetto
000,theamountenteredisassumedtobeawholeamount.
TableNote38:Ifrequiredbythehost,thescreencanbe
configuredtoaddextrazerosautomaticallytotheamountbuffer,
afterthedecimalpoint.Thisconfigurationisdefinedinthe
AppendBuffer.xmlfiledescribedintheAPTRAAdvanceNDC,
DevelopersGuide.Thefilecanbedownloaded,asdescribedinXML
ConfigurationDownloadonpage 1048,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
2-78
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.
Layouts.
Note:Iftheconsumerhasselectedavoiceguidedsession,thisstate
checksAudioGuidanceData.xmltoidentifythenumerickeysusedto
representtheFDKs,whicharealsoactiveunlesstheconsumerhas
chosentohidescreens.
LanguageSelectionin
VoiceGuidedSessions
Nolanguageselectionisrequiredinthisstateiftheconsumer
previouslyselectedalanguagewheninitiatingavoiceguided
session.Ifthissinglelanguageselectionisdisabled,theconsumer
willberequiredtoselectthelanguagemultipletimesduringtheir
session.
Thefollowingmustbeconsideredwhenvoiceguidanceisenabled:
Thescreenoffsetvaluesusedinthisstatemustmatchthescreen
OffsetsubelementdefinedintheXMLconfigurationfilefor
voiceguidance.Thesecondarylanguagesmustmatchtheoffset
valuesusedinthescreensandstatesdownloadedfromCentral.
2-79
State Tables
Thelanguageselectedbytheconsumerduringtheinitiationofa
voiceguidedsessiondeterminesthelanguageoffsetusedfor
thetransactionscreens
Forinformationonconfiguringvoiceguidance,refertoChapter6,
ConfiguringVoiceGuidanceintheAPTRAAdvanceNDC,
DevelopersGuide.
Table 2-44
Table
Entry
Number of
Characters
Contents
Description
StateType
ScreenNumber
(Range000Z99)
Displayscreenthatpromptstheconsumertoselect
keys.
256999)
256ZZZ)
doesnotrespondtothemessagewithinthe
specifiedtimelimit.Enter255ifthetimeout
256999)
256ZZZ)
pressestheCancelkey.
FDKNextStateNumber
256999)
256ZZZ)
pressesanFDKortoucharea.
256999)
256ZZZ)
StatenumberofExtensionstatecontaining
assignedoperationcodesfortheeightFDKsor
touchareas.IfthereisnoExtensionstate,enter255.
Bufferpositions
(Range000777)
IfthereisnoExtensionstate,thisdefinesthe
OperationCodebufferpositiontobeeditedbya
valueintherange000to007.
2-80
State Tables
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.
SeeTableNote39.
MultiLanguageScreens
SelectionExtensionState
Number
256999)
256ZZZ)
Ifthestateselectsthemultilanguagescreenbase,
thiscontainstheExtensionstatenumber.Ifthereis
noExtensionstate,enter000or255.
FDKActiveMask.Forexample,inthefollowingmask:
b7
b6
b5
b4
b3
b2
b1
b0
thethreedecimalcharactersintableentry8are060andtheactive
FDKsortouchareasareC,D,FandG.
2-81
State Tables
Table 2-45
Extension 1 to State Y
Table
Entry
Number of
Characters
Contents
Description
StateType
OperationCodestoredifFDK
AorFDKAtouchareais
pressed.
BorFDKBtouchareais
pressed.
CorFDKCtouchareais
pressed.
DorFDKDtouchareais
pressed.
ForFDKFtouchareais
pressed.
GorFDKGtouchareais
pressed.
HorFDKHtouchareais
pressed.
IorFDKItouchareais
pressed.
EachtableentrycontainstheOperationCode
characterstobewrittentotheOperationCode
bufferifthespecifiedFDKortouchareaispressed.
Threecharactersarespecifiedforeachcode,which
mustbeintherangeAI.Theyarewritten,in
order,tothethreepositionsspecifiedinthe
associatedEightFDKSelectionFunctionstatetable
(tableentry7).Enter@ifnocharacteristobe
writtentoaspecifiedpositioninthebuffer.
SeeTableNote40
TableNote40:IfspecifyingcharactersintherangeAtoIand@
causesdifficultieswiththestatetableeditor,youcanusevalues1
to9and0instead
2-82
State Tables
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.
SeeTableNote41
ScreenBaseifFDKCorFDK
Ctouchareaispressed
ScreenBaseifFDKDorFDK
Dtouchareaispressed
ScreenBaseifFDKForFDK
Ftouchareaispressed
ScreenBaseifFDKGorFDK
Gtouchareaispressed
ScreenBaseifFDKHorFDK
Htouchareaispressed
ScreenBaseifFDKIorFDKI
touchareaispressed
TableNote41:Whenamultilanguagescreenbaseintherange001
to009isspecified,itismultipliedby1000togive1000,2000,
3000....9000.Ifextendedscreengroupsareenabledandavaluein
therange010to099isspecified,itismultipliedby100togive1000,
1100,1200....9900.Forinformationonenablingextendedscreen
groups,refertoChapter5,ConfiguringAdvanceNDCand
AssociatedComponentsintheAPTRAAdvanceNDC,Developers
Guide.
2-83
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
Table
Entry
Number of
Characters
Contents
Description
StateType
FirstEntryScreenNumber
(Range000Z99)
thePINthefirsttime.
256999)
256ZZZ)
doesnotmakeaCSPentrywithinthespecified
timelimit.Enter255ifthetimeoutfunctionisnot
required.
256999)
256ZZZ)
pressestheCancelkeytostoptheCSPtransaction.
2-84
State Tables
Table
Entry
Number of
Characters
Contents
Description
GoodNextStateNumber
256999)
256ZZZ)
entersamatchingpairofnewPINvalues.
CSPFailNextStateNumber
256999)
256ZZZ)
failstoenteramatchingpairofnewPINdigitsor
themaximumnumberofretriesforlocalPIN
checkingisreached.
Thisisalsotakenif:
ThereisnoFITmatch.
PINblockgenerationfails.Notethattheoption
tosendthePINbufferirrespectiveoffailure
doesnotoperate.
SecondEntryScreenNumber
(Range000Z99)
Displayscreenusedtoaskforconfirmationofthe
CSP.
MisMatchFirstEntryScreen
Number
Range(000Z99)
Displayscreenthatreplacesthescreenfortable
entry2oneachattemptafteraCSPpairattempt
didnotmatchoranerrorhasoccurredandthere
arestillfurtherretriesallowed.
256999)
256ZZZ)
StatenumberoftheExtensionstate.
2-85
State Tables
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.
SeeTableNote42
49
18
Mustbe000
Reserved.
TableNote42:IflocalcheckforshortPINsisspecified,itis
possibletohavetheCSPfailurescreendisplayedafterashortfirst
PINentry.ThewordingoftheCSPfailscreenshouldavoid
confusion,forexample,ThereisaproblemwiththenewPIN
pleasereenterwiththesecondPINentryscreenwordedPlease
reenterPINtoconfirmnewnumber.
2-86
State Tables
d ... g and z - Exit States
d...gandzExitStates
StateidentificationlettersdtogarereservedforExitstates.For
furtherinformation,refertotheNCRpublicationAPTRAAdvance
NDC,ExtendingtheProduct.
Substates900to999underMasterExpansionstatezarealso
reservedforcustomerExitstates.Fordetails,seezMaster
ExpansionStateonpage 2116.
2-87
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.
2-88
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,theSSTuses
thefirstactiveFDK.
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 212.FormoreinformationaboutEightFDK
SelectionFunctionstate,seeYEightFDKSelectionFunction
Stateonpage 279.
2-89
State Tables
Considerationsfor
VoiceGuidedSessions
Iftheconsumerhasselectedavoiceguidedsession,thisstateis
usedonlyforPINentryandnotforlanguageselection.Fordetails
ofthevoiceguidanceXMLconfigurationfile,refertotheAPTRA
AdvanceNDC,DevelopersGuide.Thefollowingmustbeconsidered
whenvoiceguidanceisenabled:
Thescreenoffsetvaluesusedinthisstatemustmatchthescreen
OffsetsubelementdefinedintheXMLconfigurationfilefor
voiceguidance.Thesecondarylanguagesmustmatchtheoffset
usedinthescreensandstatesdownloadedfromCentral.
Thelanguageselection,performedaspartofinitialisationofa
voiceguidedsession,determinesthelanguageoffsetusedfor
thetransactionscreens
TheEnterkeymustbeactiveinthisstate
IftheopCodePossubelementisusedintheXMLconfiguration
file,thisstatemustusethesamebufferpositionintableentry7.
TheXMLconfigurationfilecanuseadifferentvaluethanthat
usedinthisstatetoidentifywhetherthesessionisa
voiceguidedsession
TheSSTwillechokeyselectionwithabeeponlyifthe
informationisnotdisplayedonthescreen
IfthisstaterequiresbothFDKsandnumerickeys,the
voiceguidedsessioncannotmaptheFDKstothenumeric
keypad.
Table 2-50
Table
Entry
No of
Chars
Contents
Description
StateType
m(ASCII6d,EBCDIC94)
ScreenNumber
(Range000Z99)
DisplayscreenthatpromptstheconsumertoenterthePINand
selectalanguageforthefirsttime.Thisscreen,whichis
displayedonenteringthePIN&LanguageSelectstate,must
leavethecursoratthestartofthePINEntrydisplayarea.An
asterisk(*)isdisplayedforeachkeypressed.
TimeOutNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerdoesnot
enterthePINwithinthepermittedtimelimit.Ifthetimeout
functionisnotrequired,enterstatenumber255.
2-90
State Tables
Table
Entry
No of
Chars
Contents
Description
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerpressesthe
Cancelkeybeforethemaximumnumberofdigitsspecifiedfor
thePINhavebeenentered.
NextStateOptions
256999)
256ZZZ)
StatenumberofExtensionstatecontainingthePINoptions;
theNextStatenumbersthattheSSTentersafterthePINis
entered;andtheFDKsEnterKeyMask.
Formoreinformationaboutextensionstates,seeExtension
Statesonpage 25.
OperationCodesExtension
StateNumber
256999)
256ZZZ)
ThisentryisthesameasstateY,tableentry6.
StatenumberoftheExtensionstatecontainingassigned
operationcodesfortheeightFDKsortouchareas.
IfthereisnoExtensionstate,enter255.
Statesonpage 25.
BufferPositions
(Range000777)
IfthereisnoExtensionstate,thisdefinestheOperationCode
bufferpositiontobeeditedbyavalueintherange000to007.
IfthereisanExtensionstate,thisspecifiesthreebytesofthe
OperationCodebuffertobesettothevaluesspecifiedinthe
Extensionstate.Threenumericvalues,eachintherange0to7,
arespecifiedtodefinethreepositionsinthe8byteOperation
Codebuffertobeedited.Thesethreevaluesmustbeorderedto
correspondwiththeeditcharactersintheExtensionstate.Ifno
bufferpositionsorfewerthanthreebufferpositionsaretobe
edited,thisisspecifiedintheExtensionstate.Valuesgreater
than7willbeignored.
FDKsActiveMask
(Range000255)
SpecifiestheFDKsortouchareasthatareactiveduringthis
state.EachbitrelatestoanFDKortoucharea.
Bit0relatestoFDKA(orFDKAtoucharea);bit7relatesto
FDKI(orFDKItoucharea).Ifabitis1therelativeFDKor
touchareaisactive.Ifabitis0therelativeFDKortouchareais
inactive.Valuesabove255willbeaccepted,butonlybits07
willbeused.
SeeTableNote43.
SelectionExtensionState
Number
256999)
256ZZZ)
ThisentryisthesameasStateY,tableentry9.
Ifthestateselectsthemultilanguagescreenbase,thiscontains
theExtensionstatenumber.IfthereisnoExtensionstate,enter
000or255.
Statesonpage 25.
2-91
State Tables
FDKActiveMask.Forexample,inthefollowingmask,thethree
decimalcharactersintableentry8are060andtheactiveFDKsor
touchareasareC,D,FandG:
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
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerdoes
notenteraPIN,butselectsalanguagefromanactiveFDK
ortoucharea.TheSSTnormallyentersthePINEntrystate
(stateBorM)ifthisoccurs.
NextStateNumber
256999)
256ZZZ)
ThisentryisthesameasstateB,tableentry5.
StatenumbertowhichtheSSTgoesafterverificationofa
correctPINentry.
LocalPINCheckMaximum
BadPINsNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthecorrectPINhas
notbeenenteredafterthenumberofattemptsallowedby
tableentry7.TheSSTnormallyentersaClosestateifthis
occurs.
SeeTableNote44.
LocalPINCheckErrorNext
StateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifanincorrectPINis
entered.TheSSTnormallyentersthePINEntrystate(state
BorM)inthelanguageselectedfromthisstateasyou
cannotgobacktothemstate,sincethereisnoerrorscreen
forbadPINentry.Thisstatetypeshouldmatchthestate
typeidentifiedintableentry8below.
Number
256999)
256ZZZ)
2-92
State Tables
Table
Entry
No of
Chars
Contents
Description
LocalPINCheckMaximum
PINRetries(Range001009)
MaximumnumberofincorrectPINentriesallowedbefore
theSSTentersthestatedeterminedbytableentry4.
SeeTableNote44.
StateBorMOption
(Range000001)
SpecifieswhethertouseTrack3retriesonthecardorfrom
thestatetable.Enter000ifPINEntrystateBfunctionality
isneeded.Enter001ifEnhancedPINEntrystateM
functionalityisneeded.
FDKEnterKeyDefaultMask
(Range000128)
SpecifiestheFDKortouchareathatisthedefaultlanguage
iftheEnterkeyonthekeypadispressedinsteadofanFDK.
EachbitrelatestoanFDKortoucharea.Bit0relatestoFDK
A(orFDKAtoucharea);bit7relatestoFDKI(orFDKI
toucharea).Setthebittoa1tomakethatFDKthedefault
Enterkeyvalue.ThemappedFDKwillbesetevenifthe
FDKisinactive.Onlyonebitshouldbesetto1;allother
bitsshouldbe0.Ifallbitsaresetto0,theEnterkeywill
notbeactive.
TableNote44: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
2-93
State Tables
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
SeeTableNote45
TableNote45:ThisExtensionstateisthesameastheExtension2
tostateY,Table 246onpage 283.
Whenamultilanguagescreenbaseintherange001to009is
specified,itismultipliedby1000togive1000,2000,3000,9000.If
extendedscreengroupsareenabledandavalueintherange010to
099isspecified,itismultipliedby100togive1000,1100,
1200....9900.Forinformationonenablingextendedscreengroups,
2-94
State Tables
refertoChapter5,ConfiguringAdvanceNDCandAssociated
ComponentsintheAPTRAAdvanceNDC,DevelopersGuide.
2-95
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
Activatesanddeactivatesacceptablenotetypesaccordingto
thestateparameters(SetNDCnotetype112...4950)in
Table 258Extension3toState>(CashAccept)onpage 2103.
Note:Extension3ismandatoryfortheCashAcceptstate.
Acceptsasinglenoteorabunchofnotesdependingonthe
devicetype.
Note:Whetherthebunchofnotesisstoredintheescrow
(refundabledeposit)ordepositeddirectlytothecassettes(direct
deposit)isdefinedintableentry5ofextensionstate4.For
details,seeTable 259,Extension4toState>(CashAccept)on
page 2105.
Identifiesthenotes.
Checksthenotetypeanddenominationareactive;thatis,that
thenotetypeanddenominationareacceptedbyCentral.
Returnsinvalidorinactivenotestotheconsumer.
Processesanynotesidentifiedascategory2(suspect)or
category3(counterfeit).
Ifrefundabledepositisconfigured,refundsnotesifthereare
morenotesthantheescrowcapacityortheconsumerchoosesa
refundofanygoodnotesintheescrow.
2-96
State Tables
Ifthecashacceptorhasretractcapabilitiesandretractisenabled,
retractsreturnednotesthathavenotbeentakenwithinthetime
specifiedbytheretracttimer.
Note:Ifrejectednotesaretakenlate,justastheretract
operationstarts,AdvanceNDCdoesnotsendaw7messagebut
remainsintheCashAcceptstate.
Whenextendedjournalingisenabledwithjournallevel3set,
journalseachconsumerinteraction,includingtimeouts.For
moreinformationaboutextendedjournalingandjournallevels,
refertotheAPTRAAdvanceNDC,SupervisorsGuide.
10 Onasinglenoteacceptor,foreachprocessednote,journalsthe
cumulativecountsandsendsanunsolicitedstatusmessagewith
thesamedetails.Onbunchnoteacceptors,doesthesamefor
eachprocessedbunchofnotes.
Iftheconsumercancelsthetransaction,CANCELisjournaled.
Ifthetransactiontimesout,CUSTOMER TIMEOUTisjournaled.
Table 2-55
Table
Entry
No. of
Chars
Contents
Description
Statetype
>(6EH)
CancelKeyMask
SpecifiestheCancel FDKwhichisactivewhenthePleaseEnter
Notesscreen,Confirmationscreen,CounterfeitNotesRetained
screenorEscrowFullscreenisdisplayed.
DepositKeyMask
SpecifiestheDeposit FDKwhichisactivewhentheConfirmation
screen,CounterfeitNotesRetainedscreenorEscrowFullscreenis
displayed.
AddMoreKeyMask
SpecifiestheAdd More FDKwhichisactivewhentheConfirmation

screenisdisplayed.Forbothtypesofdeposit,whenanAdd More
FDKisenabled(AddMoreKeyMaskisnot000),thecashacceptor
isnotenabledwhiletheConfirmationscreenisdisplayed.
Fordirectdeposit,whennokeyisenabled(AddMoreKeyMaskis
000)andtheCashInAutoEnabledpropertyissetin
CashInCustom.accfg,thecashacceptorisenabledwhilethe
Confirmationscreenisdisplayed.
RefundKeyMask
SpecifiestheRefundFDKwhichisactivewhentheConfirmation
screenorEscrowFullscreenisdisplayed.
Fordirectdeposits,thisvalueisignored
2-97
State Tables
Table
Entry
No. of
Chars
Contents
Description
ExtensionState1
Base10range000254or
256999)
(Base36range000254
or256ZZZ)
Statenumberforextension1
SeeExtension1toState>(CashAccept)
ExtensionState2
Base10range000254or
256999)
(Base36range000254
or256ZZZ)
SeeExtension2toState>(CashAccept)onpage 2101
ExtensionState3
Base10range000254or
256999)
(Base36range000254
or256ZZZ)
ExtensionState4
Base10range000254or
256999)
(Base36range000254
or256ZZZ)
Formoreinformationaboutextensionstates,seeExtensionStates
onpage 25.
onpage 25.
onpage 25.
onpage 25.
TableNote46:EachbitrelatestoanFDK;Bit0relatestoFDKA,
Bit7relatestoFDKI.Ifabitis1,thecorrespondingFDKisactive.If
abitis0,thecorrespondingFDKisinactive.ThesameFDKshould
bedefinedonlyinonekeymaskthatisactiveatthesametimeas
otherkeymasks.Forexample,intheConfirmationscreen,thekey
masksusedfortheCancel,Deposit,Add MoreandRefundfunctions
shouldeachactivateadifferentkey.
TableNote47:IftheCancelkeyispressedbeforenotesareentered,
theCancelNextStateNumbertableentryistaken.IftheCancelkey
ispressedintheEnterNotesscreenwhentherearenotesinthe
escrow,theConfirmationscreenisdisplayed.IftheCancelkeyis
pressedattheConfirmationscreen,thenotesarerefundedandthe
CancelNextStateNumbertableentryistaken.
TableNote48:Ifdirectdepositisconfigured,theCancelkeyisnot
enabledintheConfirmationorEscrowFullscreens.Thisisthecase
whethertheCancelkeyisconfiguredasanFDKorPINPadkey.
TableNote49:Ifdirectdepositisconfigured,theAdd Morekeycan
beenabledbutisnotrequired.
TableNote50:Ifdirectdepositisconfigured,theRefundkeyisnot
enabled.
2-98
State Tables
TableNote51:IftheFDKspecifiedintheDepositKeyMasktable
entryisselectedfromtheConfirmationScreen,theGoodNextState
Numbertableentrywillbetaken.
Table 2-56
Extension 1 to State > (Cash Accept)
Table
Entry
No of
Chars
Contents
Description
Statetype
PleaseEnterNotesScreen
(Range000Z99)
Thisscreenisdisplayedwhenthecashacceptorhasbeen
successfullyenabled(orreenabled)toacceptacashdeposit
fromtheconsumer.
SeeTableNote52
PleaseRemoveNotes
Screen
(Range000Z99)
Thisscreenisdisplayedwhenthecashacceptorhasrefundedor
rejectednotestotheconsumer.
SeeTableNote53
ConfirmationScreen
(Range000Z99)
Thisscreenisdisplayedwhenallthenoteshavebeenprocessed
andarevalidoridentifiedassuspectorcounterfeitnotesunder
ECB6.
Thescreenshowshowmanynotesofeachdenominationare
validorareretainedundertheECB6regulations,withfurther
optionsfortheconsumer.Dependingonthedisplaymodeand
confirmationscreenconfiguration,itcanalsodisplaythetotal
amounttobedepositedorthenotesstillremainingtobe
deposited.Whensuspectorcounterfeitnotesaredetected,this
screenisprecededbytheCounterfeitNotesRetainedscreen.
SeeTableNote54andConfirmationScreenonpage 2106
HardwareErrorScreen
(Range000Z99)
Thisscreenisdisplayedforthetimespecifiedbytimer63(by
default,15seconds)whenahardwareerror(forexampleanote
jam)occurs,sothatthetransactioncannotcontinue.
SeeTableNote55
EscrowFullScreen
(Range000Z99)
Thisscreenisdisplayedwhenthemaximumnumberofnotes
thatcanbeheldintheescrowisreached.
Ifdirectdepositisconfigured,thisisdisplayedwhenthedirect
depositlimitisreached.
SeeTableNote56
2-99
State Tables
Table
Entry
No of
Chars
Contents
Description
ProcessingNotesScreen
(Range000Z99)
Thisscreenisdisplayedwhilenotesarebeingprocessedafter
entrytothecashacceptor.
PleaseRemoveMorethan
90NotesScreen(Range
000Z99)
Thisscreenisdisplayedwhenthecashacceptorrefundsnotesto
theconsumerbecausethenumbernotesintheescrowexceeds
thesetcapacity.Thisscreenisdisplayedwhenallthenotesare
refundedtotheconsumerbecausemorethan90noteshavebeen
insertedbutsupportformorethan90notesisnotenabledas
describedinOption45:BNASettingsBitValueson
page 715.
SeeTableNote57
PleaseWaitScreen(Range
000Z99)
Thisscreenisdisplayedasfollows:
Untilthecashacceptorisreadytoacceptnotes.
WhentheRefundkeyisselectedanduntilthenotesare
readytobetaken
Whennoteinsertioniscancelled
WhentheMore Timekeyisselectedduringnoteentry.
Ifthisscreenissetto000,oneofthefollowingoccurs:
ThegenericPleaseWaitscreen(C20)isdisplayedifitis
defined
Thescreendisplayedbeforeentrytothisstatecontinuesto
bedisplayedifthegenericPleaseWaitscreenisnot
defined.
TableNote52:Ifthecashacceptorissuccessfullyenabled,the
screendefinedbythePleaseEnterNotesscreenwillbedisplayed,
andtheCancelKeyMaskwillbeused.Whenthecashacceptoris
reenabled,forexample,bypressingtheAdd Morekeyonthe
Confirmationscreen,pressingtheCancelkeyreturnscontroltothe
Confirmationscreen.
TableNote53:IftheRemoveRefusedNotesscreenisdefined(see
tableentry8inExtension3toState>(CashAccept)on
page 2103)andnotesareautomaticallyrejectedortheconsumer
requestsarefundwhenallthenotesareintheescrow,thePlease
RemoveNotesscreenwillbedisplayedwhenthenotesareatthe
refundslot.
TableNote54:Theformatofthedynamicdataforthe
ConfirmationandEscrowFullscreensisdefinedinthe
CashInCustom.accfgconfigurationfile.Thedynamicdatacanbe
adjustedforthetransactionlanguageasmultilingualsupportis
provided.Thesedefaultscreenscontaindisplaysofthe
denominationsintheescrowcountsor,ifdirectdepositis
configured,thevaultedcounts.Ifdirectdepositisconfiguredand
2-100
State Tables
dependingontheconfigurationdescribedintheAddMoreKey
Maskfieldofthe>CashAcceptStateonpage 297,thecash
acceptorisenabledwhilethescreenisdisplayed.Formore
informationabouttheconfigurationofdynamicdata,refertothe
APTRAAdvanceNDCDevelopersGuide,chapter5,Configuring
AdvanceNDCandAssociatedComponents.
TableNote55:Ifadeviceerrorsuchasanotejamoccurs,the
followingisperformed:
1
ThescreendefinedbytheHardwareErrorScreentableentryis
displayed.
AnunsolicitedstatusmessageissenttoCentralcontainingthe
errorinformation.
Timer63expires.
TheDeviceErrorNextStateNumbertableentryistaken.
TableNote56:Ifthemaximumnumberofnotesthatcanbeheldin
theescrowisreached,theEscrowFullscreenisdisplayed,andthe
Add Morekeyisnotenabled.Ifdirectdepositisconfigured,notes
cannotberefundedsonotallkeysinthescreenwillbeenabled.
TableNote57:Ifdirectdepositisconfigured,thisscreenisnot
used.
Table 2-57
Table
Entry
No of
Chars
Contents
Description
Statetype
GoodNextStateNumber
256999)
256ZZZ)
StatenumbertheSSTgoestowhentheDepositkeyisselected.
256999)
256ZZZ)
StatenumbertheSSTgoestoiftheconsumerpressestheCancel
keytostoptheCashDeposittransactionorselectsRefundon
theConfirmationscreenandtakesthenotesorthenotesare
retracted.
2-101
State Tables
Table
Entry
No of
Chars
Contents
Description
DeviceErrorNextState
Number
256999)
256ZZZ)
StatenumbertheSSTgoestoifanerroroccursthatmayrequire
subsequentactionbyCentral.
TimeoutNextState
Number
256999)
256ZZZ)
StatenumbertheSSTgoestoiftheconsumerfailstoenternotes
intotheBNAbeforetimer77expires,orfailstorespondtothe
promptsontheTimeoutscreen.
SeeTableNote60
NotesatRefundSlotNext
StateNumber
256999)
256ZZZ)
StatenumbertheSSTgoestoifthenotesremainattherefund
slotaftertimer78expires.Applicableonlyiftheretractoptionis
notconfigured.
Reserved(000)
Reservedforfutureuse.
Reserved(000)
RetractingNotesScreen
(Range000Z99)
Thisscreenisdisplayedwhenretractoperationsareenabledby
Option45andnotespresentedforremovalarebeingretracted.
Ifthisissetto000,thegenericPleaseWaitscreen(C20)screen
isdisplayedifitisdefined
TableNote58:Ifrefundabledepositisconfigured,andtheCancel
keyortheRefundkeyispressedafterthenoteshavebeenentered
andnosuspectorcounterfeitnotesaredetected,thenotesare
returnedtotheconsumerandthisnextstateistaken.Inaddition,if
suspectorcounterfeitnotesaredetected,theyareprocessed
accordingtothelevelofECB6regulationenabledthroughthe
GBXXconfigurationfile.Fordetails,refertoChapter5,
ConfiguringAdvanceNDCandSupportApplicationsinthe
APTRAAdvanceNDC,DevelopersGuide.Ifdirectdepositis
configured,theCancelNextStateNumberexitcanonlybetaken
beforevalidnotesareinserted.
TableNote59:IftheCancelkeyispressedafterselectingtheAdd
MoreFDK,thePleaseWaitscreenmaybedisplayedbeforethe
screendefinedbytheConfirmationscreen(tableentry4in
Extension1toState>(CashAccept))isredisplayed.
2-102
State Tables
TableNote60:Ifnotesareintheescrowwhenatimeoutoccurs,
theTimeoutNextStateexitistaken.WhentheClosestateis
reached,theBNANotesReturn/Retain/LeaveFlagintheExtension
totheClosestatedefineswhethernotesareleftintheescrow,
refunded,orvaulted.Thehostisthereforeincontrolofwhat
happens,eitherdirectlythroughatransactionrequeststate,or
indirectlybyspecifyingaClosestate.Indirectdeposits,somenotes
mayhavebeenalreadydepositedwhenthisexitistaken.
Table 2-58
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.
Hexvalues10Earebrokendowntobinaryasfollows:
1
0
E
0001 00001110
Takingindex1astherightmostdigitandindex12astheleft
mostdigit,theactivenotessetwillbenotesindexed2,3,4and
9.
SeeTableNote63
SetNDCnotetype
1324
ThethreeASCIIcharactersrepresentthreebitmaps,starting
fromtherightmostcharacter.TheindividualbitssettheNDC
notetypestoactiveorinactive.ThebitsmaptoNDCnotetypes
13to24.
SeeTableNote62
SetNDCnotetype
2536
25to36.
SeeTableNote62
SetNDCnotetype
3748
37to48.
SeeTableNote62
2-103
State Tables
Table
Entry
No of
Chars
Contents
Description
SetNDCnotetype
4950
notetypestoactiveorinactive.Bits48and49maptoNDCnote
types49and50respectively.
SeeTableNote62
Reserved(000)
RemoveRefusedNotes
Screen
(Range000Z99)
Displayedwhennotesarerefusedbythedeviceandreturnedto
theconsumer.
Ifthisissetto000,thescreenidentifiedinthePleaseRemove
NotesScreenisdisplayed.
Ifthereasonfortherefusalistobedisplayed,thereasonsmust
bedefinedinadisplaydynamictextdictionarycontrol
sequencewithinthisscreendefinition.Thereasonsfornote
refusalmustbeincludedasdescribedinDefiningReasonsfor
NoteRefusalonpage 2107
SeeTableNote64
CounterfeitNotesRetained
Screen
(Range000Z99)
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 2106).
TableNote61:Iftheenableissuccessful,thesubsetofactiveNDC
notetypesheldbytheapplicationwillberedefinedbytheSetNDC
NoteTypestableentry.
TableNote62:IfExtension3tostate>issettoallzeros,itis
ignoredandthepreviousdownloadisretained.
TableNote63:Thereisadependencyonwhichnotesarereported
throughtheSSTCommand,SendConfigurationNoteDefinitions
2-104
State Tables
astowhatactualindexwillbereportedasactive(fordetails,see
ReportCashDepositDefinitioninChapter 9,Terminalto
CentralMessages).
TableNote64:Fordetailsofdefiningadynamictextdictionary
controlsequence,seeDisplayDynamicTextDictionaryControl
Sequenceonpage 339.Thereasonsaredisplayedfromthefinal
cursorpositionafterthebasescreenisdisplayed.Ifthedynamictext
dictionarycontrolsequenceisnotdefined,noreasonisdisplayed.
TableNote65:ThenumberofnotesretainedunderECB6
regulationsincludesthenotesidentifiedascounterfeit.Ifthe
retentionofsuspectnotesisalsoconfigured,thenumberofnotes
identifiedassuspectisaddedtothecounterfeitcount.
TableNote66:IfECB6supportisenabled,Enhanced
Configurationoption45mustbesettoacceptmorethan90notes.If
option45isnotsetandmorethan90notesareinserted,notesare
returnedtotheconsumerunlesstheyaretoberetainedunderthe
ECB6regulations.TheCounterfeitNotesRetainedscreenmustbe
definedtoinformconsumersofanyretainednotes.Fordetailsof
settingoption45,seeOption45BNASettingsonpage 714.
Table 2-59
Table
Entry
No. of
Chars
Contents
Description
Statetype
Reserved(000)
Reserved(000)
Reserved(000)
DirectDepositControl
(Range000001)
Determineswhethernotesareplacedintheescrowordeposited
directlyintothecassettes.
Validvaluesareasfollows:
000Placeinsertednotesintheescrow(refundabledeposit)
001Depositinsertednotesdirectlyintothecassettes(direct
deposit).
2-105
State Tables
6
DirectDepositLimit
(Range000999)
Definesthenumberofnotesthatcanbeinsertedwhennotesare
depositeddirectlyintothecassettes.
Oncethislimitisreached,nofurthernoteswillbeaccepted,but
notesinsertedbeforethelimitisreachedwillbeprocessed.
Whenthevalueis000,thedefaultmaximumnumberofnotesforthe
hardwareisapplied.Forinformationondefiningthedefault
maximumnumberofnotes,refertoChapter5,Configuring
AdvanceNDCandAssociatedComponentsintheAPTRAAdvance
NDC,DevelopersGuide.
Reserved(000)
Reserved(000)
Reserved(000)
TableNote67:Ifthisextensionisnotincludedinthestatetable
downloadorifitistruncatedbeforetableentry5,depositswilluse
theescrow.
TableNote68:Ifthedevicedoesnotsupporttheconfigured
DepositControl,theDeviceErrorNextStateNumberistakenas
describedintableentry4ofExtension2toState>(CashAccept)
onpage 2101.
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 297)areusedtodefine
theactiveFDKs.
Note:Ifdirectdepositisconfigured,theRefundkeyisnotenabled
evenifitisconfiguredandthecashacceptorwillbeenabledwhile
theConfirmationscreendefinedintableentry4inExtension1to
State>(CashAccept)isdisplayedonlyifthevalueofAddMore
KeyMaskis000andtheCashInAutoEnabledpropertyistrue.
2-106
State Tables
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.
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
2-107
State Tables
Enumerated Value
Definition
004
Adepositfailedforareasonnotcoveredbytheother
reasonsandthefailureisnotafatalhardwareproblem
005
Failureofacommoninputcomponentthatisshared
byallcashunits
006
Theintermediatestackerisfull
007
Foreignitemshavebeendetectedintheinputposition
Note:Tousevalue007,theserviceprovidermust
supporttheXFS3.10standard
999
Defaulttexttodisplaywhenspecifictextisnot
provided
2-108
State Tables
w - Cheque Accept State
wChequeAcceptState
Ifachequeprocessorispresent,thisstatecanbeusedtoallow
chequestobeenteredintothechequeprocessor.
Understatetablecontrol,theChequeAcceptstate:
Acceptscheques
Returnsphysicallyunacceptablecheques
Returnsincorrectlyorientatedcheques
Liftsfullfrontand/orrearimages
Readsthecodeline,forCentralauthorisation
Capturesejectedchequesthatarenottaken
Reportsunsolicitedevents.
Table 2-61
Table
Entry
No. of
Chars
Contents
Description
Statetype
w(77H)
Reserved(000)
Reservedforfutureuse
Leave/CaptureOption
Thisentrydefinestheactiontotakeifaphysicallyunacceptableor
jammedchequeispresentedforreturn,butnottaken:
000Leaveatthroat
001Captureunacceptablechequetobin1
Ifthereturnedchequeisunacceptablebecauseitistooshortandthe
tableentryissettocapturethereturnedcheque,ajammayoccurin
thereartransport.
2-109
State Tables
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.
SeeTableNote76.
ImageLift
(000003)
Specifieswhetherafrontand/orrearimageistobelifted,if
hardwarecapabilitiesallow.
000Nochequeimagesarelifted
001Animageofthefrontofthechequeislifted
002Animageofthebackofthechequeislifted
003Animageofthefrontandbackofthechequeislifted
Bydefaultthefrontimageofthechequeisdisplayed.ScreenC07
canbemodifiedtodisplaytherearimage.
Liftedfrontandrearimagesaredeletedfromthesystemduringthe
Closestate.
SeeTableNote69.
ExtensionState1
(Range000999or
000ZZZ)
Statenumberforextensionstate1.
SeeExtension1toStatewonpage 2112.
Ifavalueof255isusedforthisentry,thisindicatesthereisno
extensionstate1.
onpage 25.
ExtensionState2
(Base10range000254
or256999)
(Base36range000254
or256ZZZ)
SeeExtension2toStatewonpage 2114.
extensionstate2.
onpage 25.
2-110
State Tables
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.
SeeTableNote70.
TableNote69:IftheliftingofimagesisrequestedbytheImageLift
entryinthestatetable,thentheseimagesarelifted.
TheimageisstoredinC:\ProgramFiles\NCRAPTRA\Advance
NDC\Data.Thiscanbechangedusingtheregistry,asdescribedin
theAPTRAAdvanceNDC,DevelopersGuide.
IftheimageistobedisplayedinanInformationEntrystate,the
imagecanbedisplayedinanassociatedscreenusingastandard
displayescapesequence,orbyreferencingscreenC07todisplaythe
imageaspartoftheFurtherProcessingScreen.
TableNote70:IftheDepositKeyMaskissetto000,thefurther
processingscreenisskippedandtheGoodDepositnextstateis
2-111
State Tables
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
(Range000Z99)
Thisscreenisdisplayedwhenthechequeprocessorhasbeen
successfullyenabled(orreenabled)toacceptacustomerscheque.
SeeTableNote71
ProcessingCheque
Screen
(Range000Z99)
Thisscreenisdisplayedwhenthechequehasbeensuccessfully
enteredintothechequeprocessor.
UnacceptableCheque
Screen
(Range000Z99)
Thisscreenisdisplayedwhenachequecannotbeacceptedbythe
chequeprocessor.
SeeTableNote72
IncorrectOrientation
Screen
(Range000Z99)
Thisscreenisdisplayedwhenanincorrectlyorientatedchequehas
beenenteredandretriesstillremain.
FurtherProcessing
Screen
(Range000Z99)
ThisscreenisdisplayedaftertheProcessingChequescreen,and
maybeusedtodisplaytheliftedimages.
ChequeCaptured
Screen
(Range000Z99)
Thisscreenisdisplayedwhenachequehasbeencaptured.
Typicallyachequeiscapturedifitisreturnedtotheconsumerbut
nottaken.
Thisscreenisdisplayedfortheperioddefinedbytimer87.
SeeTableNote73
DeviceErrorScreen
(Range000Z99)
Thisscreenisdisplayedwhenahardwareerrorsuchasacheque
jamconditionoccurs,preventingthetransactionfrombeing
continued.
Thisscreenisdisplayedforafixedtimeof15seconds.
PleaseRemoveCheque
Screen
(Range000Z99)
Thisscreenisdisplayedwhenthechequeisreturned,andiswaiting
tobetakenbytheconsumer.
2-112
State Tables
TableNote71: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.
TableNote72: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
2-113
State Tables
journaledatthispointtoindicatethattheclearingactionhastaken
place.
Iftheconsumerretrievesthecheque,thechequeprocessoris
reenabledifthereareretriesleft,asdefinedbytheChequeEntry
Retriesentryinthestatetable.
Iftheconsumerretrievesthechequebuttherearenoretriesleft,the
chequeprocessorisnotreenabled,andthestateexitstothestate
definedbytheCancel/TimeOutnextstateexit.
TableNote73:Whenachequeiscaptured,itisendorsedwiththe
locallycustomisabledatausingreservedscreenU0057.Fordetails
ofthelocallycustomisable,refertoChapter5,Configuring
AdvanceNDCandAssociatedComponents,theAPTRAAdvance
Table 2-63
Extension 2 to State w
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
ChequeAlreadyPresent
NextStateExit
256999)
256ZZZ)
Thisexitistakenifachequeisdetectedasalreadypresentinthe
chequeprocessor.TherecommendednextstateistheClosestate,to
performerrorrecovery.
NoExceptionNextState
Exit
256999)
256ZZZ)
Thisexitistakenifthechequeisacceptedandprocessedwithout
error,althoughthecodelinemaynothavebeenread.The
recommendednextstateisanInformationEntrystate,which
promptstheconsumertoentertheamountonthecheque,and
optionallydisplaystheimageliftedfromthecheque.
SeeTableNote72
ExceptionNextStateExit
256999)
256ZZZ)
Thisexitistakenwhenanexceptionhasoccurred(thatis,adevice
failureoccursinthechequeprocessor).Therecommendednext
stateistheClosestate,toperformerrorrecovery.
CustomerCancel/
TimeoutNextStateExit
256999)
256ZZZ)
Thisexitistakenwhentheconsumerfailstoinsertaphysically
acceptablechequewithintherequiredtimeornumberofretries.
Therecommendednextstateisthe4or8FDKSelectionFunction
statefromwhichtheChequeDeposittransactionwasselected.
SeeTableNote74
SeeTableNote75.
2-114
State Tables
Table
Entry
No. of
Chars
Contents
Description
ChequeCapturedExit
256999)
256ZZZ)
Thisexitistakenwhentheconsumerfailstotakeareturned
cheque,whichisthenclearedtothechequeprocessorrejectbin.
SeeTableNote76
Reserved(000)
Reserved(000)
Reserved(000)
TableNote74:Ifajamoccursduringchequeprocessing,an
unsolicitedmessagewitherrorcode5issent.Ifanerroroccurs
duringchequeprocessing,anunsolicitedmessagewitherrorcode
4issent.Ineithersituation,thestatetakestheExceptionnextstate
exit.FordetailsofthemessageseeChequeProcessor
(Solicited/Unsolicited)onpage 9121.
TableNote75:Whenatimeoutoccurswhenthechequeprocessor
isenabled(timer94orhardwareinternaltimer)orduringthe
FurtherProcessingscreen(timer0),AdvanceNDCactivatesthe
TimeOutstatetodisplaytheDoyouneedmoretimescreen.The
CustomerCancel/Timeoutnextstateexitistakenifthecustomer
selectsNoorCancel,orfailstorespondbeforetimer01expires.
TableNote76: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.
2-115
State Tables
z Master Expansion State
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
2-116
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.
EnableImageProcessing
(Range000003)
Specifiesthelevelofprocessingtobecarriedoutonthecheque
images,asfollows:
000noprocessing
001applyimagequalityassessment(IQA)teststodetermine
chequeacceptability
002attempttoobtaintheamountforeachcheque
Thisfieldisabitmaskandeachbitenablesafeaturewith
combinationsofbitsenablingmultiplefeatures.Forexample,
003appliesIQAtestsandobtainstheamountforeachcheque
2-117
State Tables
Table
Entry
No. of
Chars
Contents
Description
MaxItems
(Range000999)
Specifiesthemaximumnumberofchequesthatcanbeaccepted
intothedevice
If000isspecifiedorthespecifiedvalueisgreaterthanthe
maximumacceptedbythedevice,thedevicemaximumisused
ExtensionState1
256999)
256ZZZ)
Statenumberforextensionstate1
SeeExtension1toStatez001onpage 2119
ExtensionState2
256999)
256ZZZ)
ExtensionState3
256999)
256ZZZ)
Mustbe000
Ifavalueof255isusedforthisentry,thedefaultClosestateis
taken
Statesonpage 25.
extensionstate2
Statesonpage 25.
extensionstate3
Statesonpage 25.
Reserved
TableNote77:EachbitisassociatedwithanFDK;frombit0FDK
Atobit7FDKI.Ifabitis1,thecorrespondingFDKisactive.Ifa
bitis0,thecorrespondingFDKisinactive.IfthesameFDKis
definedinmorethanonemask,thelatestkeymaskisused.
TableNote78:TheCancelkeyonthePINpadwillbeactive,evenif
noFDKisdefinedasCancel.
2-118
State Tables
Table 2-66
Extension 1 to State z001
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
PleaseWaitforDevice
Screen
(Range000Z99)
Promptstheconsumertowaitforthedevicetobereadytoaccept
cheques
Ifthescreenisnottobechangedwhilewaitingforthedevice,set
thisfieldto000
PleaseInsertCheques
Screen
(Range000Z99)
Promptstheconsumertoenterchequeswhenthedeviceis
successfullyenabled,orreenabled,toacceptachequedeposit
ProcessingCheques
Screen
(Range000Z99)
ReplacesthePleaseInsertChequesscreenwhilethedevice
processestheinsertedcheques
PleaseWaitforRefused
ChequesScreen
(Range000Z99)
Promptstheconsumertowaitwhilerefusedchequesarereturned
Ifmultiplebunchesarereturned,thisscreencanbedisplayed
multipletimes
RetractingCheques
Screen
(Range000Z99)
Informstheconsumerthatreturnedcheques,whichhavenotbeen
taken,arebeingretracted
TheretractisinitiatedifTimer94expiresbeforethechequesare
taken
SeeTableNote79
DeviceUnavailable
Screen
(Range000Z99)
Informstheconsumerthatthedeviceisunavailablewhenthe
BunchChequeAcceptstateisentered
ThescreenisdisplayedforthetimedefinedbyTimer63
SeeTableNote79
HardwareErrorScreen
(Range000Z99)
Informstheconsumerthatthetransactioncannotcontinuebecause
ahardwareerror,suchasachequejam,hasoccurred
SeeTableNote79
Stacker/EscrowFull
Screen
(Range000Z99)
Informstheconsumerthatthestackerisalreadyfullwhenentering
theBunchChequeAcceptstate
Ifthetimerexpires,theGoodExitistaken
SeeTableNote79
TableNote79:Fordetailsofthetimers,seeTimersonpage 724.
2-119
State Tables
Table 2-67
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
PleaseRemoveRejected
ChequesScreen
(Range000Z99)
Informstheconsumerthatchequeshavebeenrejectedbeforethey
werefullyinserted.
Ifthereasonfortherejectionistobedisplayed,itmustbedefined
inadisplaydynamictextdictionarycontrolsequencewithinthis
screendefinition.Thereasonisdisplayedatthescreenposition
wherethedictionaryisdefined.Thereasonsforrejectionthatmust
beincludedinthedictionaryaredescribedinDefiningDynamic
TextforChequeRejectiononpage 2122
SeeTableNote80
PleaseRemoveRefused
ChequesScreen
(Range000Z99)
Informstheconsumerthatchequeshavebeenrefusedafterbeing
successfullyinserted
Ifthereasonfortherefusalistobedisplayed,itmustbedefinedin
adisplaydynamictextdictionarycontrolsequencewithinthis
screendefinition.Thereasonisdisplayedatthescreenposition
wherethedictionaryisdefined.Thereasonsforrefusalmustbe
includedinthedictionaryaredescribedinDefiningDynamicText
forChequeRefusalonpage 2122
SeeTableNote80
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
cursorpositionafterthebasescreenisdisplayed.Ifthedictionary
controlsequencedynamictextisnotdefined,noreasonis
displayed.
2-120
State Tables
Table 2-68
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
GoodNextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifatleastonechequehasbeen
successfullyacceptedintothedeviceandanyrefusedchequeshave
beentakenbytheconsumer
Ifallchequeshavebeeneitherrefusedorrejected,thestatedoesnot
takeanexitandthedeviceisreenabledforchequeinsertion
CancelNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheCancelkeyispressedto
stopthechequedepositorNoisselectedfromtheTimeoutscreen.
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifanexceptionhasoccurred
whichmayrequiresubsequentactionbyCentral
TimeoutNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerfailstoenter
anychequesbeforeTimer04expires
ChequesRetractedNext
StateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifrefusedchequesare
subsequentlysuccessfullyretracted
Allcheques,notjustthosethathavebeenrejected,areretracted.All
chequesmustberetractedbecausethereisnoconsumerinteraction
tocontinuewiththedepositofchequesthathavebeeninsertedbut
notrejected
TheretractisinitiatedafterTimer94expires
GoodwithRefused
25699)
256ZZZ)
StatenumbertowhichtheSSTgoesifatleastonechequeis
refused,andtakenwhenreturned,andatleastonegoodchequeis
accepted.
Ifthisstateparameterisnotspecified,theSSTgoestotheGood
NextStateNumber.
Mustbe000
Reserved
Mustbe000
Reserved
2-121
State Tables
DefiningDynamicTextfor
ChequeRejection
2
Todefinethetexttobedisplayedwhenachequeisrejectedduring
theBunchChequeAcceptstate,theenumeratedvaluesand
definitionsmustbedefined.Thesevaluesanddefinitionsare
includedinadynamictextdictionarycontrolsequencewitha
DictionaryIDof000.Fordetailsofthiscontrolsequence,see
DisplayDynamicTextDictionaryControlSequenceonpage 339.
Table 2-69
Rejected Reasons
DefiningDynamicTextfor
ChequeRefusal
2
Enumerated Value
Definition
001
Therejecteditemistoolong
002
Therejecteditemistoothick
003
Morethanoneitemhasbeendetected
004
Theitemhasbeenremoved
005
Metalhasbeendetectedintheinputposition
006
999
Optionaldefaulttexttodisplaywhenspecifictextis
notprovided
Todefinethetexttobedisplayedwhenabunchofchequesis
refusedduringtheBunchChequeAcceptstate,theenumerated
valuesanddefinitionsmustbedefined.Thesevaluesand
definitionsareincludedinadynamictextdictionarycontrol
sequencewithaDictionaryIDof001.Fordetailsofthiscontrol
sequence,seeDisplayDynamicTextDictionaryControlSequence
onpage 339.
Table 2-70
Refused Reasons
Enumerated Value
Definition
001
Thechequehasbeenrefusedasaresultofcheque
validation
002
003
Theescrowisfullorthemaximumnumberofitems
thattheapplicationallowsinescrowhasbeenreached
004
Thecodelinedatahasbeenfound,butwasinvalid
2-122
State Tables
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
2-123
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)
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 729
DepositBinNumber
(Range000999)
Specifiesthebinnumberintowhichthechequeistobe
deposited
ThisonlyapplieswhentheMediaControlfieldissetto000
Ifaninvalidbinnumberisused,suchas003whenthereare
only2bins,avalueof001isused(bin1)
EndorseText
(Range000Z99)
Specifiesthescreencontainingthetextusedtoendorsethe
cheques
IfendorsementisnotrequiredortheEndorseControldefines
analternativesourcefortheendorsementdata,setthisto000
2-124
State Tables
Table
Entry
No. of
Chars
Contents
Description
StampFlag
(Range000001)
Specifieswhethertostampthecheques,asfollows:
000donotstampthecheques
001stampthecheques
Thisonlyappliesifthedevicesupportsstamping
Mustbe000
Reserved
ExtensionState1
256999)
256ZZZ)
SeeExtension1toStatez002
ExtensionState2
256999)
256ZZZ)
Statesonpage 25
Statesonpage 25.
Table 2-72
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
PleaseWaitProcessing
ChequesScreen
(Range000Z99)
Promptstheconsumertowaitwhiletheactionspecifiedinthe
MediaControlfieldiscarriedout
PleaseRemoveReturned
ChequesScreen
(Range000Z99)
Promptstheconsumertoremovechequesthathavebeenreturned
PleaseWaitforMore
ReturnedChequesScreen
(Range000Z99)
Promptstheconsumertowaitforfurtherchequestobereturned
PleaseWaitRetracting
ChequesScreen
(Range000Z99)
Informstheconsumerthatreturnedchequesthathavenotbeen
takenarebeingretracted
DeviceUnavailable
Screen
(Range000Z99)
Informstheconsumerthatthedeviceisunavailablewhenthe
BunchChequeHandlingstateisentered
ThescreenisdisplayedforthetimedefinedbyTimer63,described
onpage 727
2-125
State Tables
Table
Entry
No. of
Chars
Contents
Description
HardwareErrorScreen
(Range000Z99)
Informstheconsumerthatthetransactioncannotcontinuebecause
ahardwareerror,suchasachequejam,hasoccurred
Mustbe000
Reserved
Mustbe000
Reserved
Table 2-73
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
GoodOperationNext
StateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthechequeshavebeen
successfullyprocessedasdefinedintheMediaControlfield,as
follows:
IfMediaControlis000,themediahasbeendepositedintothe
specifiedbinandanyreturnedchequeshavebeentakenbythe
consumer
IfMediaControlis001or002,themediahasbeenreturnedand
takenbytheconsumer
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifanexceptionhasoccurred
whichmayrequiresubsequentactionbyCentral
CustomerTimeoutNext
StateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerhasnottaken
thereturnedcheques
IfMediaControlis002,thisexitistakenafterTimer94expires,
otherwiseitistakenafteranyreturnedchequesaresuccessfully
retracted
EndorseControl
(Range000001)
Defineswhereandhowthedatausedtoendorsethechequeis
defined,asfollows:
000TheEndorseTexttableentry(tableentry5).Ifboth
parametersaredefinedas000,theendorsementtextisnotsetusing
thisstate
001Createdusingdynamicdataelementsdefinedinthelocal
dynamicendorseconfigurationfile(notsupported)
Mustbe000
Reserved
2-126
State Tables
Table
Entry
No. of
Chars
Contents
Description
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-127
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
nounsolicitedmessageissenttoCentralorjournaled.
2-128
State Tables
Table 2-74
z003 - Cheque Detail Display State
Table
Entry
No. of
Chars
Contents
Description
z(7AH)
Statesubtype
003
OperationMode
(Range001003)
Specifiesthemodeofoperation,asfollows:
001displaydetailsofthecurrentchequeandallowthe
consumertonavigatethroughallthechequesandeditthe
amounts.Adescriptionofthecurrentcheque(for
informationonthecurrentcheque,seeCurrentCheque
Indexonpage 2135)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.
2-129
State Tables
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
(Range000Z99)
Informstheconsumerofthechequedetailsandallowsan
amounttobeenteredoredited
Ifthechequedepositstatusistobedisplayed,acontrol
sequenceforadynamictextdictionarymustbedefinedwithin
thisscreen.Fordetailsofthecontrolsequence,seeDisplay
DynamicTextDictionaryControlSequenceonpage 339.The
statusvaluesthatmustbeincludedinthedictionaryare
describedinDefiningDynamicDataforChequeDeposit
Statusonpage 2133
AmountDisplayScreen
Number
(Range000Z99)
Overlayscreentosetthecursorpositionandoptionallydefines
theinitialdisplayformatbeforeamountentryoreditbythe
consumer
Thecursormustbesettotheleftsideoftheechofieldonthe
display,whichisspacefilleduntiltherequiredstartposition
forthecurrencycharacterisreached
ThedefaultechofieldisbbbbbSb0.00,wherebrepresentsa
space
Formoreinformationonamountdisplay,seeInternational
CurrencyDisplayFormatonpage 345
ZeroAmountErrorScreen
(Range000Z99)
Overlayscreentoprompttheconsumertoprovideanonzero
amountforthedisplayedcheque
ExtensionState1
256999)
256ZZZ)
ExtensionState2
256999)
256ZZZ)
Statesonpage 25.
Statesonpage 25.
2-130
State Tables
cursorpositionafterthebasescreenisdisplayed.Ifthedynamictext
dictionarycontrolsequenceisnotdefined,nostatusisdisplayed.
Table 2-75
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
ProceedNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifthechequesdepositedhave
mettheconditionsofthetransactionandwantstoproceed
CancelNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheCancelkeyispressed
IfanyamounthasbeenmodifiedduringthisstatebeforetheCancel
keyispressed,themodifiedamountisretained
TimeoutNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerfailstorespond
withinthespecifiedtimelimit
Enter255ifthetimeoutfunctionisnotrequired
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-131
State Tables
Table 2-76
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
ProceedKeyMask
SpecifiestheFDKsortouchscreenareasthatareactiveasProceed
keys
IftheProceedkeyortouchscreenareaispressedwhileenteringan
amount,theamountisacceptedbeforethenormalproceed
functionalityiscompleted
IfOperationMode(tableentry3)issetto002or003andzero
amountsareallowed,thisFDKnavigatestothenextchequeuntil
thelastchequeisdisplayed
SeeTableNote82
CancelKeyMask
SpecifiestheFDKsortouchscreenareasthatareactiveasCancel
keys
TheCancelFDKortouchscreenareaisactiveonallscreens
IftheCancelkeyortouchscreenareaispressedwhileenteringan
amount,theamountbeingenteredisdiscarded
SeeTableNote82
ReturnChequeKeyMask
SpecifiestheFDKsortouchscreenareasthatareassociatedwith
theoptiontoreturnthechequetotheconsumerandnottoprovide
anamount
WhentheReturnChequeKeyortouchscreenareaisused,the
statusofthechequeistoggledbetweenreturnanddeposit
Pressingthiskeydoesnotcausethenextchequetobedisplayed
SeeTableNote82
NextChequeKeyMask
theoptiontomovetothenextchequeinthelist
ThisisnotusedwhentheOperationModefield(tableentry3)isset
to002or003,asnonavigationispossibleinthesemodes
IftheNextChequeKeyortouchscreenareaispressedwhile
enteringanamount,theamountisacceptedbeforethenormalnext
chequefunctionalityiscompleted
Ifthechequedisplayedisthelastcheque,pressingthiskey
displaysthefirstcheque
SeeTableNote82
PreviousChequeKey
Mask
theoptiontomovetothepreviouschequeinthelist
ThisisnotusedwhentheOperationModefieldissetto002or003,
asnonavigationispossibleinthesemodes
IfthePreviousChequeKeyortouchscreenareaispressedwhile
enteringanamount,theamountisacceptedbeforethenormal
previouschequefunctionalityiscompleted
Ifthechequedisplayedisthefirstcheque,pressingthiskey
displaysthelastcheque
SeeTableNote82
2-132
State Tables
Table
Entry
No. of
Chars
Contents
Description
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
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
2-133
State Tables
z004 Display Cheque Summary State
z004DisplayChequeSummary
State
TheDisplayChequeSummarystatedisplaysasummaryofthe
chequesthathavebeenacceptedduringtheBunchChequeAccept
state(seepage 2117).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
nounsolicitedmessageissenttoCentralorjournaled.
Enablingkeypadkeystoallowtheconsumertoselectacheque
toviewingreaterdetailusingtheChequeDetailDisplaystate.
Whileviewingthedetaileddisplay,theconsumercaneditthe
amountofthedisplayedcheque.Eachchequedisplayedinthe
summaryscreenisassociatedwithoneofthe1to9keypadkeys.
SelectinganumerickeycausestheViewChequeDetailsState
exittobetakenwiththecurrentchequesettothecheque
associatedwiththeselectedkey.Ifnochequeisassociatedwith
theselectednumerickey,thereisabeeptoacknowledgethekey
pressbutnothingelseoccurs.
Ifnochequesareavailablefordisplay,onlytheChequeSummary
screenisdisplayed.
2-134
State Tables
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)
Statesubtype
004
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-135
State Tables
Table
Entry
No. of
Chars
Contents
Description
ExtensionState1
256999)
256ZZZ)
ExtensionState2
256999)
256ZZZ)
ExtensionState3
256999)
256ZZZ)
Statesonpage 25.
Statesonpage 25.
Statesonpage 25.
Table 2-79
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
ChequeSummaryScreen
(Range000Z99)
Containsthebackgroundforthechequesummarydisplay
NextFDKScreen
(Range000Z99)
NestedscreentooverlaytheChequeSummaryscreenwhenthe
NextFDKkeyortouchscreenareaisenabledbecausethereare
morechequestodisplaythancanfitonasinglescreen
PreviousFDKScreen
(Range000Z99)
PreviousFDKkeyortouchscreenareaisenabledbecausethereare
morechequestodisplaythancanfitonasinglescreen
ChequeDisplayArea
TopRow
(Range000015)
Specifiesthetopoftheareausedtodisplaydynamicchequedata
ChequeDisplayArea
LeftColumn
(Range000031)
Specifiestheleftoftheareausedtodisplaydynamicchequedata
2-136
State Tables
Table
Entry
No. of
Chars
Contents
Description
MaxChequeDetails
(Range00010)
Specifiesthemaximumnumberofchequestodisplayonasingle
screen
ChequeDetailsOverlay
Screen
(Range000Z99)
Overlayscreentodefinewhatisdisplayedforeachcheque.
Ifthechequedepositstatusistobedisplayed,adynamictext
dictionarycontrolsequencemustbedefinedwithinthisscreen.The
statusvaluesthatmustbeincludedinthedictionaryaredescribed
inDefiningDynamicDataforChequeDepositStatuson
page 2133
ChequeDetailsOverlay
Size
(Range000015)
Specifiesthenumberofrowsallocatedforthedisplayofthecheque
details
TableNote83:Anypositioncoordinatesusedintheoverlay
screenarerelative.
TableNote84:Newdisplaycontrolcodesareaddedtoallowthe
displayofdynamicdataassociatedwiththeinsertedcheques.
Table 2-80
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
ChequeDetailArea
BackgroundScreen
(Range000Z99)
Overlayscreentocleartheareaforchequedetaildisplayoninitial
entrytothestateandwheneithertheNextorPreviousFDKor
touchscreenareaisselected
CancelKeyMask
SpecifiestheFDKsortouchscreenareasthatareactiveasCancel
keys
TheCancelFDKisactiveonallscreens
SeeTableNote85
ProceedKeyMask
theoptiontoproceed
SeeTableNote85
NextFDKKeyMask
theoptiontodisplaythenextscreenofcheques
ThisFDKortouchscreenareaisonlyenablediftherearemore
chequestodisplaythanwillfitonasinglescreen
Ifthechequedisplayedisthelastcheque,pressingtheNextkeyor
touchscreenareadisplaysthescreencontainingthefirstcheque
SeeTableNote85
2-137
State Tables
Table
Entry
No. of
Chars
Contents
Description
PreviousFDKKeyMask
theoptiontodisplaythepreviousscreenofcheques
ThisFDKortouchscreenareaisonlyenablediftherearemore
chequestodisplaythanwillfitonasinglescreen
Ifthechequedisplayedisthefirstcheque,pressingthePrevious
keyortouchscreenareadisplaysthescreencontainingthelast
cheque
SeeTableNote85
AddMoreFDKKey
Mask
theoptiontoaddmorecheques
ThisFDKortouchscreenareaisonlyenabledwhenthedevicehas
thecapacitytoacceptadditionalcheques
SeeTableNote85
AddMoreFDKScreen
(Range000Z99)
AddMoreFDKkeyortouchscreenareaisenabled
Mustbe000
Reserved
Atobit7FDKI.Ifabitis1,therelativeFDKortouchareais
active.Ifabitis0,therelativeFDKortouchareaisinactive.
Table 2-81
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
CancelNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheCancelkeyispressed
ProceedNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheProceedkeyispressed
2-138
State Tables
Table
Entry
No. of
Chars
Contents
Description
AddMoreNextState
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheAddMorekeyispressed
TimeoutNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerfailstorespond
inthespecifiedtimelimit
Enter255ifthetimeoutfunctionisnotrequired
ViewChequeDetailState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheconsumerchoosesto
viewthedetailsofacheque
ThisidentifiestheChequeDetailDisplaystate,whichmusthave
theOperationModesetto001
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-139
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.
2-140
State Tables
Table 2-82
z008 - Insert Card State
Table
Entry
No. of
Chars
Contents
Description
StateType
SubType
008
InsertCardScreen
Number
(Range000Z99)
Promptstheconsumertoenteracard.Thisscreenisdisplayed
whiletheSSTiswaitingforcardentry.
GoodReadNextState
Number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesineitherofthefollowing
situations:
AfterasuccessfulreadofthecardifFITsarenotused(Table
entry4intheextensionstate=000).
IftheFinancialInstitutionnumberonthecardmatchesa
FinancialInstitutionnumberinaFIT.
Error(Misread)Screen
Number
(Range000Z99)
Screentodisplayifthereadconditionsarenotsatisfiedduetoan
invalidcardoramechanismerror.
Afterejectingthecard,thecardreaderisreactivatedandwaitsfor
thecardentry.
Readcondition1
Readcondition2
Thesethreeentriesspecifywhichcardtrack(s)and/orchipdatawill
beread.Thepossiblevaluesfortheseentriesareshownin
Table 24,ReadConditionBitInformationonpage 29.
Readcondition3
256999)
256ZZZ)
Statenumberoftheextensionstate.
2-141
State Tables
Table 2-83
Extension to Statez008
Table
Entry
No. of
Chars
Contents
Description
StateType
Cancelnextstatenumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesiftheCancelkeyispressed.
TimeOutNextstate
number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoeswhentimer04expiresorwhen
acardisejectedduetoaninvalidreadbutnottakenbythe
consumer.
Ifthecardisnottakenwithinthedurationoftimer09,thecardis
capturedandtheTimeOutNextStateistaken.
NoFITMatchNextstate
number
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifeithertheFinancial
InstitutionnumberonthecarddoesnotmatchanyFIT,orthecard
readerisasmartcardreaderandthereadconditionbeing
evaluatedhasthechipconnectbitset(bit3).
IfFITsarenotusedthisentrymustbe000.
FatalNextstatenumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesinthefollowingsituations:
Thecardreaderisinafatalcondition
Thecardreaderisoutofoperation
Thereisadeviceerror
Inthesecases,thecardisejectedandsubsequentlycapturedifitis
nottakenbytheconsumer.
6
Enablebeeper
Enablesordisablesthebeeperasfollows:
001Enablesthebeeperwhenwaitingforcardentryandwhen
thecardisejected
000Disablesthebeeper(default).
Thedefaultvalueisusedifthevalueisoutofrange
7
TakeCardscreennumber
(Range000Z99)
Ifthecardreaderisasmartdipreaderandachipconnectbitisset,
buttheATR(AnswertoReset)fails,thisscreenisdisplayedto
prompttheconsumertoremovethecardandwait.Thisscreenis
displayeduntiltheconsumerremovesthecardortimer72expires.
2-142
State Tables
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
2-143
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)
z017(NoteMixSelection).
Thisstateensuresthatvaliddataissenttothehost.Thefollowing
areexamplesofdatathatcanbevalidatedusingtheBuffer
Validationstate:
Dateformats
Thelengthofdata
Thecontentofsomedata.
AdvanceNDCattemptstomatchtheRuleSetIDfromtableentry3
withthesameIDintheXMLconfigurationfile.Ifamatchisfound,
AdvanceNDCreadsthepatternfortheruleset.Iftherulepattern
matchesthebufferdata,theGoodValidationNextStateexitis
taken.Ifthepatterndoesnotmatch,theValidationFailNextState
exitistaken.
2-144
State Tables
Table 2-84
z009 - Buffer Validation State
Table
Entry
No. of
Chars
Contents
Description
StateType
Subtype
009
RuleSetID
(Range001999)
DefinestheruleidentifiertomatchwiththeIDattributeinthe
XMLconfigurationfile.
BufferID
Definesthebuffertobevalidated.
001BufferB
002BufferC
003AmountBuffer
SeeTableNote86
GoodValidationNext
StateNumber
256999)
256ZZZ)
Statenumbertogotoifthedataissuccessfullyvalidated.
ValidationFailNextState
Number
256999)
256ZZZ)
Statenumbertogotoifthedatavalidationfails.
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
TableNote86:Iftheidentifiedbuffercontainsnodata,the
ValidationFailNextStateexitistaken.
DateValidationScenario
ThefollowingscenarioillustrateshowthestatetableandXML
configurationfileareusedtovalidatebufferdata.
Inthisscenario,thefollowingarereadfromthestatetable:
RuleSetID(tableentry3)setto123
Buffer ID(tableentry4)setto001
2-145
State Tables
TheXMLconfigurationfilecontainsthefollowing:
<RuleSet ID="123">

<Rule Pattern="(0[1-9]|1[012])[/.](0[1-9]|[12][0-9]|3[01])[- /.](19|20)\d\d"/>
</RuleSet>
ThePatternattributeisdefinedusingregularexpressions.For
moreinformationaboutdefiningvalidstringformatsusingregular
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.
2-146
State Tables
z010 Local Cash Dispense State
z010LocalCashDispenseState
TheLocalCashDispensestatecanbeusedtodispensecashwithout
theneedforhostauthorisation.Itisusedfortransactionsthatare
authorisedandrecordedthoughsomeothersystem.Thisstatemust
onlybeusedinenvironmentswherethecashcountersare
maintainedontheSSTasCentralisunawareofanycashdispensed
throughthisstate.
DispenseFunctionality
Ifthisstateisusedwithcardlesstransactions,consumer
identificationwillberequiredintheeventofpowerfailureora
shortdispense.Ifcardlesstransactionsareused,itwillbenecessary
toensurethatallsensitivedataiscollectedandprocessedin
compliancewithPADSSrequirements.
Thisstatecandispensenotes,coins,oracombinationofnotesand
coins.Inthisstate,thecashtobedispensedisspecifiedwithinCDI
stores.DatatobeprintedisspecifiedwithinUCDIstores.Ifthe
operationincludesacombinationofnotesandcoins,thenotesmust
besuccessfullydispensedbeforethecoinsaredispensed.
Whennotesandcoinsaretobedispensedbuteitherthecash
dispenserorthecoindispenserisunabletodispense(thedeviceis
notpresent,isfatalorisinasuspendcondition)oroneofthe
devicescannotdispensethecashspecified(cassetteorhopperisnot
present,isemptyorisfatal)neithernotesnorcoinswillbe
dispensed.
Whentheretractoptionisenabled,therequestednotesare
dispensedfirstandafterthenotesaretakenbytheconsumer,the
requestedcoinsaredispensed.Whentheretractoptionisdisabled,
therequestednotesaredispensedfirst,thentherequestedcoinsare
dispensedwithoutwaitingforthenotestobetaken.
ForeignCurrency
ExchangeTransactions
StateFlowaftera
SuccessfulDispense
Atypicaluseofthisstateisinaforeigncurrencyexchange
transaction,wheretheconsumerinitiatesthetransaction(withor
withoutacard)anddepositstheforeigncurrency.Thecurrent
exchangerateisusedtodeterminetheamountoflocalcurrencyto
bedispensed.Inthisscenario,thenoteswouldbedepositedusing
theCashAcceptstate,thecurrencyexchangecalculatedbyanExit
stateandtheLocalCashDispensestatewoulddispensethecash.
Oncethecashhasbeensuccessfullydispensed,thestateflowgoes
totheGoodDispenseNextState.Whenonlynoteshavetobe
dispensed,thepresentationofthenotesistreatedasasuccessful
2-147
State Tables
dispenseandthestateflowgoestotheGoodDispenseNextstate.
Thisapplieswhetherretractisenabledordisabledandnotesare
takenornot.Ifthenotesarenottakenandretractisenabled,the
notesareretractedandthestateflowgoestotheGoodDispense
NextState.
SuccessfulDispenseExamples
StateFlowafteraShort
Dispense
Whennotesandcoinsarerequested,onsuccessfuldispenseof
notesandcoins,thestateflowgoestotheGoodDispenseNext
State.
Whenonlynotesarerequestedandcashdispensertampering
occurswhiletheconsumeristakingthepresentednotes,the
stateflowgoestotheGoodDispenseNextStateastherequested
noteshavebeendispensed.
Whenonlynotesarerequestedandtheconsumerdoesnottake
therequestednotes,thenotesareretractedifretractisenabled
orleftattheSSTthroatifretractisdisabledandthestateflow
goestotheGoodDispenseNextState.
Whenthecashdispensedislessthantheamountofrequestedcash,
thestateflowgoestotheShortDispenseNextState.
2
ShortDispenseExamples
StateFlowafteraFailed
Dispense
Whennotesandcoinsarerequested,butonlynotesare
presentedandnocoinsaredispensedduetothecoindispenser
hoppersrunningoutofcoinsinthecurrenttransaction,thestate
flowgoestotheShortDispenseNextState.
Ifnotesandcoinsarerequestedandtheretractoptionis
enabled,butthepresentednotesarenottakenbytheconsumer,
thenotesareretractedtotheretractbinandthestateflowgoes
totheShortDispenseNextState
Whennocashisdispensed,thestateflowgoestotheNoDispense
NextState.
2
FailedDispenseExamples
WhentheAdvanceNDCCDIstoresspecifythatnonotesor
coinsaretobedispensed,thestateflowgoestotheNoDispense
NextState.
Ifthecashdispenserisnotpresent,isfatalorisinasuspend
conditionwhencashisrequested,thestateflowgoestotheNo
DispenseNextState.
Ifthecashdispenserisavailablebutthecoindispenserisnot
present,isfatal,orisinasuspendconditionwhencoinsornotes
andcoinsarerequested,thestateflowgoestotheNoDispense
NextState.
2-148
State Tables
StateFlowafteran
UnknownDispense
Whennoteshavebeendispensedandthenumberofnotes
dispensedisunknown,thestategoestotheUnknownDispense
NextState.
UnknownDispenseExamples
StateFlowonCard
Ejection
StateOperation
Ifthenumberofnotesdispensedisunknownwhenonlynotes
arerequested,thestateflowgoestotheUnknownDispense
NextState.
Ifthenumberofnotesdispensedisunknownwhennotesand
coinsarerequested,coinswillnotbedispensedandthestate
flowgoestotheUnknownDispenseNextState.
Whenthisstatehastoejectthecardbeforethecashispresented,the
cashispresentedonlyafterthecardistaken.Iftheejectedcardis
nottakenbytheconsumer,thecardisretractedandanycurrently
stackednotesarepurged;thentheNoDispenseNextStateexitis
taken.Ifthecardreaderisnotabletoejectthecard,anycurrently
stackednotesarepurged;thentheNoDispenseNextStateexitis
taken.
ThewayinwhichtheLocalCashDispensestateworksiscontrolled
bystatetableentry7,operationmode.Thestateworksinthesame
wayascorrespondingTransactionReplyFunctionIDsinrelationto
thefollowing:
Cashstacking
Cardejection
Cashpresentation
Coindispense
Printing
Useoftimers.
Forexample,ifthevalueofstatetableentry7is001,eachofthe
abovedeviceoperationsisprocessedinthesamewayasthe
TransactionReplyfunctionDispenseandPrint(2or8).
CDIStores
Beforethisstateisexecuted,theidNotesToDispenseand
idCoinsToDispCDIstoreshavetobepopulatedwiththecountof
notesandcoinstodispenseinthisstate.Theyareclearedonexit
fromthestate.
Cashdispenseisbasedonthevaluesstoredinthe
idNotesToDispense CDIarraystore.Thenumberofnotesto
dispensefromtheNDCcassettetype1isstoredinindex0ofthe
array,thenumberofnotestodispensefromNDCcassettetype2is
storedinindex1ofthearrayandsoon.Tosupportupto7logical
2-149
State Tables
cassettes,EnhancedConfigurationParameteroption76mustbeset
to1.Fordetailsofoption76,seeOption76CashHandlerson
page 719.
CoindispenseisbasedonthevaluesstoredintheidCoinsToDisp
CDIarraystore.ThenumberofcoinstodispensefromNDC
HopperType1isstoredinindex0ofthearray,thenumberofcoins
todispensefromtheNDCHopperType2isstoredinindex1ofthe
arrayandsoon.Tosupportupto8hoppertypes,Enhanced
ConfigurationParameteroption79mustbesetto1.Fordetailsof
option79,seeOption79CoinDispenseronpage 721.
JournalingandPrinting
TheLocalCashDispensestatesupportscameras,APTRAPromote
andcouponprinting.
TheOfflineJournalPrintBuffer,OfflineReceiptPrintBufferand
OfflineStatementPrintBufferUCDIstoreshavetobepopulated
withprintdataifprintingisrequired.Thestateprintsdataonlyif
thedataispresentinthesestoresanditistheapplication
developersresponsibilitytopopulatethem.Printerdatainthese
storescanhaveprintercontrolcharacters.Thestoresareclearedon
exitfromthestate.
Onlyunsolicitedstatusmessagesthatarereportedinanormal
dispensetransactionreplyfunctionarejournaled.Additional
journalingidentifiesthatthetransactionisalocaldispense
operationandprovidesmoreinformationasfollows:
Asecuritytracemessage(*NNN*dd/mm/yy*HH.MM*)isjournaled
followedbyLOCAL CASH DISPENSE STATE.
ExceptforfunctionIDnames,suchasCardBeforeCash,andthe
journalmessageE0022,allmessagesarejournaledwithatimestamp.
Fordetailsoftheadditionaljournalmessages,seejSupervisor
andJournalMiscellaneousScreensonpage A95.
StatusUpdatesandCounts
TheLastTransactionStatusdatathatisreportedinaTransaction
Requestmessageisnotupdatedbythisstate.Thenotesdispensed
countsinunsolicitedmessagesarenotupdatedbythisstate.
Thisstateupdatesthefollowingcountsinthesamewayasnormal
dispenseoperations:
NotesinCassettes
NotesRejected
NotesDispensed
CoinsRemaining
CoinsDispensed.
2-150
State Tables
MessageHandling
TheLocalCashDispensestatedoesnotsendallthestatusmessages
forthecashdispenser,coindispenserandcardreaderiftheirstatus
changesduringadispenseoperation.
Onlyunsolicitedstatusmessagesthatarereportedinanormal
dispensetransactionreplyfunctionaresenttothehost.Unsolicited
messagesforretractoperationsarenotsenttothehostincasethey
areinterpretedasmeaningthatthecashdispensedinthelast
hostcontrolledcashdispensetransactionhasbeenretracted.Forthe
cashdispenserandcoindispenser,additionalunsolicitedmessages
withdevicestatus0maybesent.
SolicitedStatusMessages
Assolicitedstatusmessagesarenotsenttothehostnorjournaled,
someerrorconditionsarenotreported.Forexample,thehostisnot
alwaysinformedwhenadeviceentersafatalcondition;however
thefatalstatuswillbereportedinthenexthostcontrolleddispense
transaction.
Counts
IntheresponsetotheSendSupplyCountersterminalcommand,the
followingfieldsalwaysreportthecurrentcountsintheSST:
NotesinCassettes
NotesRejected
NotesDispensed
CoinsRemaining
CoinsDispensed.
Thefollowingfieldsshouldalwaysreportthedispensedcountsfor
thelasthostcontrolledtransaction,thatis,cashdispensedin
responsetoaTransactionReplyfromthehost:
LastTransactionNotesDispensed
LastTransactionCoinsDispensed.
Table 2-85
Table
Entry
No. of
Chars
Contents
Description
StateType
Subtype
010
PleaseWaitScreen
(Range000Z99)
Displayedwhennotesarebeingstacked.Ifaspraydispenseris
presentthisscreenisnotdisplayed
2-151
State Tables
Table
Entry
No. of
Chars
Contents
Description
TakeCardScreen
(Range000Z99)
Displayedwhenthecardisejected.Thisscreenisnotdisplayedif
thecardisnotreturnedorthereisnocardinthereader
TakeNotesScreen
(Range000Z99)
Displayedwhenthenotesarepresented.Ifaspraydispenseris
present,thisscreenisdisplayedwhenthedispenseoperationstarts
todispensenotes.
TakeCoinsScreen
(Range000Z99)
Displayedwhenthecoinsaredispensed
OperationMode
(Range001to004)
Specifieshowthestateistooperate,asfollows:
001Dispenseandprintwithoutejectingcard
002Ejectcard,thendispenseandprintcardbeforecash
003Cardbeforeparalleldispenseandprint
004Paralleldispense,printandcardeject.
ExtensionState1
Mustbe000
Reserved
Table 2-86
Table
Entry
No. of
Chars
Contents
Description
StateType
GoodDispenseNext
StateNumber
256999
Base36range000254or
256ZZZ)
StatenumbertheSSTgoestowhentheamountofcashrequested
hasbeendispensed
ShortDispenseNext
StateNumber
256999
Base36range000254or
256ZZZ)
StatenumbertheSSTgoestowhenthecashdispensedislessthan
thecashrequested
NoDispenseNextState
Number
256999
Base36range000254or
256ZZZ)
StatenumbertheSSTgoestowhennocashisdispensed.
2-152
State Tables
Table
Entry
No. of
Chars
Contents
Description
UnknownDispenseNext
StateNumber
256999
Base36range000254or
256ZZZ)
StatenumbertheSSTgoestowhenthenumberofnotesdispensed
isunknown
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-153
State Tables
z013 Data Copy and Compare State
z013DataCopyandCompareState
TheDataCopyandComparestateisusedtoprocessthedatain
BufferB,BufferCandtheAmountbufferasfollows:
Tocomparethedataintwobuffersforvalidationpurposes
Tocopythedatainonebuffertoasecondbuffer,thatis,froma
sourcebuffertoadestinationbuffer.
Thisstateallowsdataenteredbytheconsumertobeprocessed
locallyontheSSTratherthanbythehost.
Forexample,whendataisenteredbytheconsumerforthefirsttime
intheInformationEntrystateH,itiscopiedtoonebuffer.When
thedataisreentered,itiscopiedtoanotherbuffer.Thetwobuffers
canthenbecomparedusingtheDataCopyandComparestate.If
thevaluesinthetwobuffersareidentical,thedataisvalid.
Table 2-87
Table
Entry
No. of
Chars
Contents
Description
StateType
Subtype
013DataCopyandCompareState
OperationIdentifier
Specifiesthetypeofoperationtobeperformed.
001Copyfromasourcebuffertoadestinationbuffer(seeCopy
Operationsonpage 2156)
002Comparebuffers(caseinsensitive)
003Comparebuffers(casesensitive)
Copy/CompareGood
NextStateNumber
(Base10,range000254or
256999)
256ZZZ)
StatenumbertowhichtheSSTproceedsaftereitherofthe
following:
ErrorNextStateNumber
256999)
256ZZZ
Asuccessfuldatacopy
Foradatacomparison,thetwobuffershaveidenticalvalues.
StatenumbertowhichtheSSTproceedsifeitherofthefollowing
errorsoccurswhentheOperationIdentifieris001(copy):
Thesourcebufferlengthisgreaterthanthedestinationbuffer
length
Anattempthasbeenmadetocopyalphanumericdatatothe
Amountbuffer.
2-154
State Tables
Table
Entry
No. of
Chars
Contents
Description
ExtensionState1
256999)
256ZZZ)
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Extensionstate1definesBufferID1,BufferID2,andthenextstate
numberstobeusedwhenthebufferdatavaluesarenotidenticalin
datacomparisons.Whenthetwobuffershaveidenticaldataor
whenthedatafromBufferID1iscopiedsuccessfullytoBufferID2,
theSSTproceedstotheCopy/CompareGoodnextstate.
Thefollowingsectionsonthenextpagegivemoreinformation
aboutthetwooperations:
CopyOperations
CompareOperations.
Table 2-88
Table
Entry
No. of
Chars
Contents
Description
Statetype
Z(5AH)
BufferID1
Specifiesthebuffertobeusedasthesourcebufferforacopy
operationorthelefthandsideofacompareoperation.
001BufferB
002BufferC
003Amountbuffer
BufferID2
Specifiesthebuffertobeusedasthedestinationbufferforthecopy
operationortherighthandsideofthecompareoperation.
001BufferB
002BufferC
003Amountbuffer
2-155
State Tables
Table
Entry
No. of
Chars
Contents
Description
BufferID1GreaterThan
BufferID2NextState
Number
256999)
256ZZZ)
Usedonlyfordatacomparisons.
StatenumbertowhichtheSSTproceedswhenthedatavaluein
BufferID1isgreaterthanthedatavalueinBufferID2
BufferID1LessThan
BufferID2NextState
Number
256999)
256ZZZ)
Usedonlyfordatacomparisons
StatenumbertowhichtheSSTproceedswhenthedatavaluein
BufferID1islessthanthedatavalueinBufferID2.
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
CopyOperations
Thefollowingconventionsapplytocopyoperations:
2
OnlynumericdatacanbecopiedtotheAmountbuffer.
IfthedatabeingcopiedtotheAmountbufferislessthanthe
Amountbufferlength,thentherequirednumberofleading
zerosisaddedtomakeitafixedlengthofeither8or12
characters.ThelengthcanbespecifiedthroughAppendBuffer.xml
orEnhancedConfigurationParameteroption1.
IfthedatabeingcopiedfromtheAmountbuffertoBufferBor
BufferCcontainsanyleadingzeros,allthedataincludingthe
zerosiscopiedtothedestinationbuffer.
IfthedatabeingcopiedtotheAmountbufferfromBufferBor
BufferChasoneormoreleadingortrailingspaces,thespaces
areignored.Onlythenumericpartofthedatawithoutspacesis
copiedtotheAmountbuffer
WhendataiscopiedtoBufferBorBufferC,thefullbufferis
copiedincludinganyspaces.
2-156
State Tables
CompareOperations
BuffercomparisonisdonecharacterbycharacterusingtheASCII
valuesofthecharacters.ASCIIvaluesarecheckedfirst,thenlength.
Thefollowingexamplesshowtheoutcomeofpossiblecomparisons:
Datavaluesofdifferenttypes:
BufferID1=1234;BufferID2=xyz
TheASCIIvalueofthefirstnumericcharacterinBufferID1is
lessthantheASCIIvalueofthefirstalphabeticcharacterin
BufferID2sothestatenumberspecifiedintableentry5ofthe
extensionstate(BufferID1LessThanBufferID2)istaken.
Datavaluesofthesametypeandlength
BufferID1=ABC;BufferID2=abc
IftheOperationIdentifier=002,caseisignoredandthedata
valuesaretreatedasidentical,sothestatenumberspecifiedin
tableentry4oftheprimarystatetable(Copy/CompareGood
NextState)istaken.
IftheOperationIdentifier=003,caseistakenintoaccount
duringthecomparison.TheASCIIvalueofthefirstcharacterin
BufferID1islessthantheASCIIvalueofthefirstcharacterin
BufferID2,sothestatenumberspecifiedintableentry5ofthe
extensionstateistaken.
Datavaluesofdifferentlengths:
BufferID1=xyzaa;BufferID2=xyz
AsthereisafourthcharacterinBufferID1butBufferID2does
nothaveafourthcharacter,thevalueinBufferID1isgreater
thanBufferID2sothestatenumberspecifiedintableentry4of
theextensionstate(BufferID1GreaterThanBufferID2)istaken.
2-157
State Tables
z014 Cash Deposit Handling State
z014CashDepositHandlingState
Thisstatesupportsofflinedepositandrefundofnotesduring
cashintransactions,thatis,thesetransactionsarecompleted
withouthostinteraction.Thisstateofferssimilarfunctionalitytothe
DepositMediaandRefundMediatransactionreplyfunctionsto
completeatransactionwherenoteshavebeenacceptedduringthe
CashAcceptState.ItisanalternativetothoseTransactionReply
functions,offeringanofflineoptiontohandlethenotes.
Refundablenotes,thatis,notesstillintheescrow,canberefunded
ordeposited.Fornotesacceptedduringadirectdeposit,therefund
optionisnotavailable.
Thestateflowhastobedesignedtoavoidusingtherefundoption
fordirectdeposittransactionsasthenotesarenotrefundable.
Journaling
Twomessagesarejournaledeachtimethestateisrun.Thefirst
messagejournalsthestartofthestate,whichincludesthefunction
requestedandthesecondgivesthecompletionresult.
Thisjournalingisonlydoneifthejournallevelis3.
DataPrinting
Printdataisoutputinparallelwhenthedevicestartstheencash
operation,andafternotesaretakenintherefundfunction,orafter
anerroroccursduringarefund.
Offlinereceiptprintingiscalledfromthefollowingprintpoints:
OfflineDeposit
OfflineRefundSuccess
OfflineRefundFailed.
Equivalentjournalentriesareoutputbydefault.
Formoreinformationaboutcustomisingorconfiguringthisprint
output,refertoChapter10,DevelopingHooksinAPTRAAdvance
NDC,ExtendingtheProduct.
2-158
State Tables
Table 2-89
z014 Offline Encash/Refund State
Table
Entry
No. of
Chars
Contents
Description
StateType
Subtype
014CashDepositHandlingState
FunctionID(000001)
Specifiesthetypeofoperationtoperform:
000Encash
001Refund
ProcessingItemsScreen
(000Z99)
Thisscreenisdisplayedwhiletheitemsarebeingencashedor
refunded
PleaseRemoveItems
Screen
(000Z99)
ThisscreenisdisplayedwhentheCashAcceptorhasreturned
itemstothecardholder.OnlyusedintheRefundFunction.
RetractingItemsScreen
(000Z99)
ThisscreenisdisplayedduringtheRetractoperation,whichoccurs
ifthePresenteditemsarenottakenbeforeTimer78expires,and
Option45isconfiguredtoenableRetract.OnlyusedintheRefund
Function.
ExtensionState1
(000ZZZ)
Mustbe000
Reserved
Mustbe000
Reserved
Note:Thehandlingofcountsinthisstatematcheshowthecounts
areupdatedintheClosestate.TheLastTransactionCountsarenot
updatedandtheupdatingofcountsisnotauthorisedbythehost.
Fortheencashfunction,thedepositistreatedasauthorisedoffline,
inthesamewayasnotesencashedintheClosestatearetreated.
2-159
State Tables
Table 2-90
Table
Entry
No. of
Chars
Contents
Description
StateType
Z(5AH)
GoodNextStateNumber
(000ZZZ)
StatenumbertheSSTgoestoafterasuccessfullycompleted
operation.
Fortheencashfunction,thisisaftertheencashoperationis
completedsuccessfully.
Fortherefundfunction,thisisafterthefinalbunchofrefunded
itemsistaken.
Number(000ZZZ)
StatenumbertheSSTgoestowhenanerroroccursduringeither
theencashoperationortherefundoperation
TimeoutNextState
Number
(000ZZZ)
StatenumbertheSSTgoestoifitemsarenottaken.Ifretractis
enabled,thisfollowsaftercompletionoftheretractoperation
completes,otherwisethisexitistakenassoonasTimer78expires.
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-160
State Tables
z017- Note Mix Selection State
z017NoteMixSelectionState
Usethisstateifyouwishtoallowtheconsumertoselectthenote
mixtobedispensed.
ThisstatemapsdenominationstoFDKsallowingtheconsumerto
specifytheamountandthenotemixtodispense.Theamountis
increasedbythedenominationmappedtotheFDKeachtimethe
consumerselectsthekey.
ExitfromtheNoteMixSelectionstateoccurswhentheEnterkeyis
pressed,theCancelkeyoraNextStateFDKispressedoratimeout
occurs.TheEnterkeyisdefinedbytableentry4ofextension1.The
Clearkeyisalwaysactive,ifpressedtheamountenteredandthe
screenechoarecleared.
ThestandardfieldlengthfortheAmountbufferiseightdigits,or
twelveifEnhancedConfigurationParameteroption1isused;butit
canbeconfiguredforanynumberuptotwelvedigitsthrough
AppendBuffer.xml.Iftheconsumerselectsfurtherdenomination
FDKsaftertheconfigurednumberofdigitsisreached,thebufferis
clearedandtheamountisresetto0.Aparameterin
AppendBuffer.xmlcanbeconfiguredtopreventclearingofthe
amountwhentheconfiguredlimitisreached.
Ifrequiredbythehost,thescreencanbeconfiguredtoaddextra
zerosautomaticallytotheamountbuffer,afterthedecimalpoint.
ThisconfigurationisdefinedintheAppendBuffer.xmlfile.Thefile
canbedownloaded,asdescribedinXMLConfiguration
Downloadonpage 1048,orcanbeinstalledlocally.
FordetailsofAppendBuffer.xml,refertotheAPTRAAdvanceNDC,
DevelopersGuide.
Table 2-91
Table
Entry
Number of
Characters
Contents
Description
StateType
SubType
017NoteMixSelectionState
ScreenNumber
(Range000Z99)
Numberofdisplayscreenpromptinganamount
entry.
2-161
State Tables
Table
Entry
Number of
Characters
Contents
Description
ExtensionState1
256ZZZ)
ExtensionState2
256ZZZ)
ExtensionState3
256ZZZ)
ExtensionState4
256ZZZ)
Reserved(000)
Reserved(000)
Table 2-92
Table
Entry
Number of
Characters
Contents
Description
StateType
TimeoutNextStateNumber
256999)
256ZZZ)
failstoenteranamountwithinthespecifiedtime
limit.
256999)
256ZZZ)
pressestheCancelkey.
EnterNextStateNumber
256999)
256ZZZ)
pressestheEnterkey.
2-162
State Tables
Table
Entry
Number of
Characters
Contents
Description
NoCassetteTypesAvailable
NextStateNumber
256999)
256ZZZ)
StatenumbertowhichtheSSTgoesifnocassette
typevaluesspecifiedinExtension3toStatez017
areavailable.
Thiscanoccurbecauseofthefollowing:
Nodispenserispresent
Thedispenserisinafatalcondition
Allcassettetypesaremissingorinafatal
condition
Cassettetypes5to7areused,butEnhanced
Configurationoption76issetto000(four
cassettetypes)
Extension3cannotbefound.
KeyboardInputTimeout
(Range000255)
Specifiesthetimeoutvalueforthisstate:
000Usetimer0
001to255Specifiesthetimeouttousein
seconds
Mustbe000
Reserved
Mustbe000
Reserved
Mustbe000
Reserved
2-163
State Tables
Table 2-93
Table
Entry
Number of
Characters
Contents
Description
StateType
NextStateFDKFlags
(Range000255)
ThisfieldspecifiestheFDKsusedtoselectthenext
state
EachbitrelatestoanFDK;Bit0relatestoFDKA,
Bit7relatestoFDKI.
Ifabitis1,thecorrespondingFDKinExtension3
toStatez017specifiesthenextstatenumber.
NoteSelectionFDKFlags
(Range000255)
ThisfieldspecifiestheFDKsusedtoselectNDC
cassettetypes
EachbitrelatestoanFDK;Bit0relatestoFDKA,
Bit7relatestoFDKI.
Ifabitis1,thecorrespondingFDKinExtension3
toStatez017specifiesanNDCcassettetype
AmountDisplayScreen
Number
(Range000Z99)
Overlayscreentosetthecursorpositionand
optionallydefinestheinitialdisplayformatbefore
amountentryoreditbytheconsumer
Thecursormustbesettotheleftsideoftheecho
fieldonthedisplay,whichisspacefilleduntilthe
requiredstartpositionforthecurrencycharacteris
reached
Thedefaultechofieldisbbbbb$b0.00,whereb
representsaspace
IftheoptiontoextendtheAmountbufferto12
digitsisselected,theamountentryscreenposition
mustreflectthis.Thedefaultscreenis
bbbbbbbbb$b0.00,wherebrepresentsaspace.
Theamountentryscreenisnotadjustedfor
languageunlessalanguagehasbeenselectedand
thelanguagegroupsizeisequaltoorgreaterthan
1000.Formoreinformationonlanguagescreens,
Formoreinformationonamountdisplay,see
InternationalCurrencyDisplayFormaton
page 345
2-164
State Tables
Table
Entry
Number of
Characters
Contents
Description
LanguageDependencyand
OverlayScreenFlag
(Range000003)
Thisflagdeterminesifthescreensdefinedintable
entry4ofthisextensionstateandtableentries2to
9ofExtension4toStatez017arelanguage
dependentandwhetheroverlayscreensaretobe
usedforthenoteselectionFDKs:
000Notlanguagedependent.Useoverlayscreens
fornoteselectionFDKs.
groupsize.Useoverlayscreensfornoteselection
FDKs.
002Notlanguagedependent.Donotuseoverlay
screensfornoteselectionFDKs.
groupsize.Donotuseoverlayscreensfornote
selectionFDKs
AmountBuffer
(Range000002)
Thisfielddetermineswhichbuffertheamount
enteredwillbestoredin,asfollows:
000Amountbuffer
001BufferB
002BufferC
NoteMixBuffer
(Range000002)
Thisfielddetermineswhichbufferthenotemix
enteredwillbestoredin,asfollows:
000Notstored
001BufferB
002BufferC
MaximumNumberofNotes
(Range000200)
Thisfielddeterminesthemaximumnumberof
notesthatcanbeincludedinthenotemixwhenthe
noteselectionFDKsareused.Thiseffectively
restrictsthenumberoftimestheFDKscanbe
pressedtoaddnotestothemix.
Ifthisfieldissetto000oravaluegreaterthanthe
devicecansupport,thedevicecapabilitiesdefine
themaximumnumberofnotesthatcanbe
dispensedinasingleoperation.
SeeTableNote89
Mustbe000
Reserved
TableNote87:IfEnhancedConfigurationoption76issetto000,
theformatofthenotemixdataisAAABBBCCCDDD.IfEnhanced
Configurationoption76issetto001,theformatofthenotemixdata
isAAABBBCCCDDDEEEFFFGGG.Eachletterintheseexampleformats
representsacassettetype,forexampleCCC representscassettetype
3.
2-165
State Tables
TableNote88:IfthesamebufferisspecifiedinboththeNoteMix
BufferfieldandtheAmountBufferfield,theamountisstoredinthe
bufferspecifiedintableentry6(theAmountbufferfield)butthe
notemixisnotstored.
TableNote89:IntheTransactionReply,onlytwodigitsare
availableforeachnotetypeinthedispensefunction.
Table 2-94
Table
Entry
Number of
Characters
Contents
Description
StateType
FDKA
(Range000ZZZ)
FDKB
(Range000ZZZ)
Dependingontableentries2and3ofExtension2
toStatez017,containseitheranextstatenumber
oranNDCcassettetype.
FDKC
(Range000ZZZ)
FDKD
(Range000ZZZ)
FDKF
(Range000ZZZ)
FDKG
(Range000ZZZ)
FDKH
(Range000ZZZ)
FDKI
(Range000ZZZ)
IftheFDKspecifiesanextstate,therangeisas
follows:
Base10range000254or256999
Base36range000254or256ZZZ
IftheFDKspecifiesanNDCcassettetype,thevalid
rangeis17andthefollowingapply:
Ifthespecifiedcassettetypeisnotpresentinthe
dispenserorallcassettesofthattypeareinafatal
condition,theFDKisnotenabled
Ifthecassettetypeisintherange57,Enhanced
Configurationoption76mustbesetto001
Ifthecassettetypeisoutsidethevalidrange,the
FDKisnotenabled.
TheFDKisnotenabledinthefollowingsituations:
Itisnotspecifiedineithertableentry2or3of
Extension2toStatez017
Itisspecifiedinbothtableentry2and3of
2-166
State Tables
Table 2-95
Table
Entry
Number of
Characters
Contents
Description
StateType
FDKAOverlayScreen
(Range000Z99)
FDKBOverlayScreen
(Range000Z99)
Specifiestheoverlayscreentodisplaywhentable
entry3ofExtension2toStatez017specifiesthe
FDKasanoteselectionFDK.
FDKCOverlayScreen
(Range000Z99)
FDKDOverlayScreen
(Range000Z99)
FDKFOverlayScreen
(Range000Z99)
FDKGOverlayScreen
(Range000Z99)
FDKHOverlayScreen
(Range000Z99)
FDKIOverlayScreen
(Range000Z99)
TheFDKisenablediftableentry5ofExtension1
toStatez017issetto000or001(useoverlay
screens).
TheFDKisnotenabledandtheoverlayscreenis
notappliediftableentry5ofExtension1toState
z017is002or003(donotuseoverlayscreens).In
thissituation,atextualrepresentationofthe
selectedamountisdisplayednexttotheFDKinthe
currentfont.Thedisplayedamountisthevalueof
thenoteinthecassettetypespecifiedinExtension
3toStatez017.
IftheFDKisnotanoteselectionFDKortheFDKis
notenabled,nooverlayscreenortextual
representationoftheamountisdisplayed.
Nooverlayscreenisappliedinthefollowing
situations:
TheFDKisnotspecifiedintableentry3of
TheFDKisspecifiedinbothtableentry2and3
ofExtension2toStatez017
Theamountentryscreenisnotadjustedfor
languageunlessalanguagehasbeenselectedand
thelanguagegroupsizeisequaltoorgreaterthan
1000.Formoreinformationonlanguagescreens,
2-167
State Tables
& - Barcode Read State
&BarcodeReadState
TheBarcodeReadstateallowsanapplicationtoreadabarcode.
Optionallyafiltercanbeusedtoselectanalternativeflow,basedon
thebarcodecontent.
Whenthisstateisentered,thescreenidentifiedbytableentry1is
displayedandthebarcodereaderisenabled.
Thebarcodefiltersaredefinedinthebarcodereaderconfiguration
file,whichcanbedownloadedusingtheXMLconfiguration
downloaddescribedonpage 1048.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-96
& - Barcode Reader State
Table
Entry
No. of
Chars
Contents
Description
&(26H)
StateType
ScreenNumber(Range
000Z99)
Displayscreenpromptingtheconsumertoscanabarcode.
GoodbarcodeReadState
Number
256999)
256ZZZ)
StatenumbertheSSTgoestoifabarcodehassuccessfullybeen
readandnoBarcodeFiltermatches,orthereisnoexitdefined
fortheBarcodeFilterIndexintheExtensionStates.
2-168
State Tables
Table
Entry
No. of
Chars
Contents
Description
256999)
256ZZZ)
StatenumberthattheSSTgoestoifthebarcodescanwas
cancelledbythecustomer.
ErrorNextStateNumber
256999)
256ZZZ)
StatenumberthattheSSTgoestoifthereisaproblemreading
thebarcode,forexampleabarcodereaderhardwareorbarcode
readerconfigurationerror.
TimeoutNextStateNumber
256999)
256ZZZ)
StatenumberthattheSSTgoestoifthebarcodescantimesout.
BarcodeDataDestination
(07)
Destinationbufferforbarcodedata
SeeTableNote90
SeeTableNote91
SeeTableNote92
Track3buffer(default)(max106bytes)
Track1buffer(max78bytes)
Track2buffer(max39bytes)
GeneralPurposebuffersAandB(max64bytes)
GeneralPurposebuffersBandC(max64bytes)
GeneralPurposebuffersCandA(max64bytes)
Barcodereaderbufferidentifiedbythecharactere(max
sizelimitedbymessagesize)
Amountbuffer(max8or12bytes,dependingon
configuration).
SeeTableNote93,TableNote94,andTableNote95.
8
ActiveCancelFDKkeymask
(Range0255)
TheFDKkeys(s)enabledtocancelthebarcodescanning
process.TheCancelkeyonthePINPadwillalwaysbeenabledif
aCancelexitisdefined.
ExtensionState1
256999)
256ZZZ)
Extensionstate1allowsadditionalparameterstobeaddedin
thefuture,asallparametersinextensionstates2toNcontain
theBarcodeFilterexitvalues.
Statesonpage 25.
TableNote90:TheCancelkeyandassociatedFDKareenabledifa
Cancelnextstateexitisdefined.IftheconsumerpressesCancel,the
deviceisdisabledandtheCancelnextstateexitistaken.
2-169
State Tables
TableNote91:Ifabarcodecannotbereadbecauseofatechnical
problem,orthebarcodereaderisnotpresent,theErrornextstateis
taken.Anunsolicitedstatusmessageissenttoreportthedevice
fault.
TableNote92:IfthetimeoutdefinedbyTimer61expiresora
hardwaretimeoutoccurs,theinternalTimeOutstateistakento
requestmoretime.Iftherequestissuccessfulthebarcodereaderis
enabled.Iftherequestisdenied,thetimeoutnextexitstateistaken.
TableNote93:Ifthescannedbarcodedataexceedsthefixedlength
ofthedestinationbuffersize,itwillbetruncatedtothelengthofthe
buffer.
TableNote94:Ifoption3,4or5isselected,andthelengthofthe
scannedbarcodedataexceeds32bytes,itwillbesplitacrossthetwo
buffersandtruncatedat64bytes.
TableNote95:Whenabarcodeissuccessfullyreaditisplacedin
thebufferspecifiedbyBarcodeDataDestination.Ifthespecified
destinationbufferisunknown,theSSTwillgotoErrorNextState
Number.
TableNote96:Table 2-97
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
256999)
256ZZZ)
Extensionstate,000ifthereisnoextensionstate.
Statesonpage 25.
BarcodeReadExtensionstates28provideamechanismfor
selectingastateflowbranchbasedonthecontentofthebarcode
read.Thebarcodefilters,downloadedusingtheXMLconfiguration
2-170
State Tables
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-98
Extensions 28 to State &
Table
Entry
No. of
Chars
Contents
Description
StateType
NextStateforaBarcode
Filtermatchwithindex=
((ExtensionStaten2)*7).
256999)
256ZZZ)
StatenumberthattheSSTgoestoiftheBarcodematchesthe
BarcodeFilterwithindexequalto((Extensionstaten2)*7).If
thisvalueis000theGoodBarcodeReadNextStateExitis
takenwhenthefiltermatches.
((ExtensionStaten2)*7)+1.
256999)
256ZZZ)
BarcodeFilterwithindexequalto
((Extensionstaten2)*7)+1.
Ifthisvalueis000theDefaultBarcodeReadNextStateExitis
takenwhenthefiltermatches.
256999)
256ZZZ)
Ifthisvalueis000theDefaultBarcodeExitistakenwhenthe
filtermatches.
256999)
256ZZZ)
Ifthisvalueis000theGoodBarcodeExitistakenwhenthe
filtermatches.
2-171
State Tables
Table
Entry
No. of
Chars
Contents
Description
256999)
256ZZZ)
BarcodeFilterwithindexequalto((Extensionstaten 2)*7)+4.
filtermatches.
((ExtensionStaten 2)*7)+5.
256999)
256ZZZ)
((Extensionstaten 2)*7)+5.
filtermatches.
((ExtensionStaten 2)*7)+6.
256999)
256ZZZ)
BarcodeFilterwithindexequalto((Extensionstaten 2)*7)+6.
filtermatches.
NextExtensionState
256999)
256ZZZ)
ExtensionState,000signifiestherearenomoreextension
states.
Statesonpage 25.
2-172
State Tables
Time-Out State
TimeOutState
TheSSThasafixedTimeOutstate.Thisisenteredunderoneofthe
conditionsdescribedinthefollowingtable:
Table 299
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 724and
ConfigurationParametersLoadonpage 1015.
OnentrytotheTimeOutstate,screenC00isdisplayed,givingthe
consumertheoptionofmoretime.Timer01andthefastbeepare
started.FormoredetailsseeRedefiningReservedScreenson
page 351.
YouhavetoensurethattheTimeOutstatedealsappropriatelywith
audiofilesifaforeignlanguagehasbeenselectedinamultiple
languageenvironment.
Dependingonthekeyselectedbytheconsumerandtheentry
conditionthatcausedtheTimeOutstatetobeentered,oneofthe
followingexitscanbetakenfromthestatethatenteredthe
TimeOutstate(thepreviousstate):
TheTimeOutnextstateexit
TheCancelnextstateexit.
2-173
State Tables
Time-Out State
IftheconsumerpressesFDKA(orFDKIiftheoptionthat
enablesthekeystotheleftofthescreenisset)toselectmoretime,
theSSTreturnstothepreviousstate,theoriginaltimerisrestarted,
andbeepingstopsforentryconditions1,4,5or6,oraslowbeep
returnsforconditions2and3.
IftheconsumerpressesFDKB(orFDKH)ortimer01expires,the
beepingstopsandtheactiondescribedinthefollowingtable,
Table 2100,ActionTakenonSelectionofFDKBforEachEntry
Condition,istakenfortheassociatedcondition,describedin
Table 299,EntryConditionsfortheTimeOutStateon
page 2173.
Table 2-100
Action Taken on Selection of FDK B for
Each Entry Condition
Entry
Condition
Action
TheTimeOutnextstateexitfromthepreviousstateistaken
AtimeoutstatusmessageissenttoCentral
TisplacedingeneralpurposebufferB
TheTimeOutnextstateexitfromthepreviousstateistaken
Fordetailsofthesituationsandassociatedactionstaken
whenatimeoutoccursduringaCashAcceptstate,see>
CashAcceptStateonpage 296
whenatimeoutoccursduringaChequeAcceptstate,seew
ChequeAcceptStateonpage 2109
whenatimeoutoccursduringaBunchChequeAcceptstate,
seez001BunchChequeAcceptStateonpage 2117
Enhancedconfigurationparameteroption71controlsthenumberof
timestheTimeOutstatecanbeentered.Fordetails,seeOption71
TimeOutStateEntryonpage 718.
IftheconsumerpressestheCancelkey,thebeepingstopsandthe
actiondescribedinthefollowingtable,Table 2101,ActionTaken
onSelectionoftheCancelKeyforEachEntryCondition,istaken
fortheassociatedconditiondescribedinTable 299,Entry
ConditionsfortheTimeOutStateonpage 2173.
2-174
State Tables
Time-Out State
Table 2-101
Action Taken on Selection of the Cancel
Key for Each Entry Condition
Entry
Condition
Action
TheCancelnextstateexitfromthepreviousstateistaken
EisplacedingeneralpurposebufferB
TheCancelnextstateexitfromthepreviousstateistaken
whenatimeoutoccursduringaCashAcceptstate,see>
CashAcceptStateonpage 296
whenatimeoutoccursduringaChequeAcceptstate,seew
ChequeAcceptStateonpage 2109
whenatimeoutoccursduringaBunchChequeAcceptstate,
seez001BunchChequeAcceptStateonpage 2117
regularFDKs.Inthisstate,twooftheeightpossiblefixedtouch
areasareenabledonthescreenandtheconsumertouchesthem
insteadofpressingthecorrespondingFDK.Thetouchareasare
enabledanddisabledinexactlythesamewayastheFDKs.For
details,seetheFDKEmulationsectioninChapter 4,Keyboard
DataandLayouts.
keypadoranFDK.Ifthekeyboarddefinitionisnotvalidated,the
keyboardlayoutisnotchanged,thekeyboardisdisabledandtrace
messageT86isprintedonthejournal.Fordetails,seeChapter 4,
2-175
State Tables
Time-Out State
2-176
Table of Contents
Screen Data
Chapter 3
ScreenData
Overview
31
TheScreenInterface
CustomerScreens
CustomerScreenGroups
ReservedScreens
32
32
33
34
TypesofReservedScreen
CCardholderDisplay
ScreenC00
ScreenC01
ScreenC02
ScreenC03
ScreenC04
ScreenC05
ScreenC06
ScreenC07
ScreenC20
GGraphicPictures
KExtendedScreenControls
Receipt:K01
Receipt:K09
Journal:K02
Journal:K10
ReceiptandJournal:K07
Statement:K03
ControlSequencesforReceipt,JournalandStatement
Printers
LLogos
MSupervisorMenus
EditingtheContentsofReservedScreens
ReservedScreenConstraints
311
312
312
313
313
FormattingRulesforCardholderDisplayScreens
314
35
36
36
36
36
36
36
37
37
37
37
38
38
39
310
310
310
311
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
MultiLanguageScreenNumbering
ExtendedScreenGroups
ExampleScreenGroupDefinitions
RedefiningReservedScreens
314
315
316
318
319
319
319
320
320
320
320
321
322
323
327
330
331
331
332
332
333
333
334
335
335
337
337
338
339
342
343
343
344
345
346
346
348
348
348
349
351
Table of Contents
Screen Data
DisplayingPictures
PictureResolution
GuidelinesforPictures
352
352
352
ScreenReset
353
SupervisorSettlementScreens
UsingtheFrontorRearInterfaceforSettlement
RearSettlementandInternationalSecurity(DAPI7)
SupervisorSettlementTransactions
ValidCommands
TransactionsParameterScreens(C09C19)
354
354
354
355
355
356
Table of Contents
Screen Data
Screen Data
Overview
Overview
Thischapterprovidesinformationonthefollowingtopics:
Thescreeninterface
Typesofreservedscreen
Formattingrulesforconsumerdisplayscreens
Multilanguagescreens
Picturedisplay
Screenreset
ThescreensusedforSupervisorsettlementtransactions.
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.
3-2
Screen Data
Thedataisdownloadedtotheterminalinascreendataload
message.Formoredetails,seetheScreen/KeyboardDataLoad
sectioninChapter 10,CentraltoTerminalMessages.
Allthescreensthatareaccessedbythestatetablesarestoredinthe
ScreenTable.Eachscreeninthetablehasauniquenumberfrom
0000to9999.Itisthisnumberthatisreferencedbyparametersinthe
statetablesduringtransactionprocessing.
Forfurtherinformationonreferencingscreensfromstatetables,see
ScreenNumbersonpage 25.
Ifyouareimplementingamultilanguagesolution,seeCustomer
ScreenGroupsbelowandMultiLanguageScreensonpage 348.
CustomerScreenGroups
Twoscreengroupsareused,asfollows:
Screengroupuforlanguageindependentscreennumbers.The
screennumbersareaccesseddirectly
Screengrouplforlanguagedependentscreennumbers.The
screennumbersareaccessedindirectlyusinglanguageoffsets.
Thelanguageoffsetisthenumberthatisaddedtothe
languageindependentscreentoidentifytheactualscreento
display.
Screengroupu Thisdefineslanguageindependentnumbers,for
example,u1234.Thisisafourdigitscreengroup,sothefullrangeof
userscreensis0000to9999.Formultilanguageuse,thescreenscan
begroupedintolanguagespecificscreengroups.Whilethesizeof
eachlanguagegroupcanbevaried,themaximumscreengroupsize
is3599.Ascreeningroupucanalsobedefinedasafourdigit
numberindoublequotes,withouttheprefixletter,forexample
1234.
3
Screengroupl Thisdefineslanguagedependentnumbers,for
example,l1234.Thisisafourdigitgroupwithafullrangeof0000to
9999althoughasmallerrangeisgenerallydefinedtosuitthe
numberofavailablelanguages.Thefirstgroupofscreenswhenfour
languagesaretobeused,forexample,couldusetherange0000to
1000.Screengrouplmapstothescreensfromgroupuusingthe
languageoffset.Ifthescreenidentifiedafterapplyingalanguage
offsetisnotfound,thescreenidentifiedbeforeapplyingthe
languageoffsetisused.
3
Forexamplesofscreenmappingwhenmultiplelanguagesare
available,seeExampleScreenGroupDefinitionsonpage 349.
Forcompatibility,thefollowingapply:
Numericscreennumbersintherange000to999canstillbe
specified,forexample123.
3-3
Screen Data
Forstateparameters,thescreennumbersmustbethree
characters.Thefirstcharactercanbealphanumeric,thesecond
andthirdmustbenumericdigits.
Note:Thefullrangeof0000to9999screennumberscanbe
accessedfromstateparametersusinganinitialalphanumeric
characterandscreenoffsets.FordetailsseeScreenNumbers
onpage 25andMultiLanguageScreensonpage 348.
Forexamples,seeMultiLanguageScreensonpage 348.
ReservedScreens
Areservedscreenisascreenthatisalreadydefinedintheresrvd.def
file.Reservedscreenshavefixedfunctions,suchasdisplaying
Supervisorpromptsandmenus,andareonlydisplayedat
predefinedtimes,suchaswhentheterminalisinOutofServiceor
OffLinemode.Somereservedscreensconsistofcontrolsequences
andareusedtomanagedifferentaspectsofthedisplay,for
example,charactersetsandlogos.
Note:Consumerscreensmustnotbeincludedintheresrvd.deffile
astheymaynotdisplaycorrectly.Todefineconsumerscreens
locally,refertoSpecifyingLocalCustomisationDatainChapter5
oftheAPTRAAdvanceNDC,DevelopersGuide.
Thenumberingforreservedscreensconsistsofanalphacharacter
thatdefinesthescreentype,followedbytwonumericdigitsthat
definetheparticularscreen.Theexceptionstothisaretheerror
screens.Theseconsistofanalphacharacterthatdefinesthescreen
type,followedbyfournumericdigitsthatdefinetheparticular
screen.
Note:ForinformationaboutscreendataonothervendorsSSTs,
refertotheScreenDatatopicinChapter3oftheAPTRAAdvance
NDC,MultiVendorSupportReferenceManual.
3-4
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
LLogos
MormSupervisorMenus
PorpSupervisorCRTandEnhancedOperatorInterface
Prompts
RSimulatedReceiptPreprint
SorsSupervisorInformationLines
TortJournalTraceandAcknowledgements
UCheque,EMVSmartCardandBNA
Xscreensprerecordedaudiomessages.
Thissectiondiscussesthefollowingscreentypes:
CCardholderDisplay
GGraphicPictures
LLogos
MSupervisorMenus.
ForinformationaboutRscreens(SimulatedReceiptPreprint),see
SimulatedPreprintedReceiptMessagesonpage 525.
ForinformationaboutthereservedscreensC09toC19,see
SupervisorSettlementScreensonpage 354.
Fordetailsofthedefaultprerecordedaudiomessages,seeControl
CodesforSpecialFeaturesonpage 320.
3-5
Screen Data
FordetailsofthedefaulttextandlayoutforSupervisormenusand
theotherscreentypesnotdiscussedhere,seeAppendix A,
ReservedScreens.
CCardholderDisplay
ScreentypeC,withtheexceptionofscreensC09andC10C19,is
reservedforuseduringcardholdertransactions.Fordetailsof
screensC09andC10C19,seeSupervisorSettlementScreenson
page 354.
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
3-6
Screen Data
newtransactionreplyfromCentral.Fordetails,seetheTerminal
FunctionsforTransactionCompletiononpage 1065.Thisscreenis
displayedfortheamountoftimespecifiedbyTimer02(page 725).
Forthetimerformatinamessage,seeConfigurationParameters
Loadonpage 1015.
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 2109)isset,thisscreenisusedtodisplaythelifted
chequeimage.
ThisscreencontainsthescreencontrolsequencePS,whichisused
todisplaytheliftedchequeimageasdescribedintheLiftCheque
ImageControlsectiononpage 335.
IftheimageisrequiredtobedisplayedinanHInformationEntry
State(seepage 229),theimagecanbedisplayedbyreferencing
screenC07todisplaytheimageaspartoftheFurtherProcessing
Screen.
ScreenC20
ThisisagenericPleaseWaitscreenthatcanbedisplayedwhen
thereisadelayinprocessingandthereisnotamorespecificscreen
defined.Thisscreenshouldcontainasinglereferencetoanested
screen.Thenestedscreenshouldbedefinedinalllanguages
requiredatthecorrectoffsets.Bydefault,thisscreenisundefined.If
C20isnotdefined,nothingisdisplayed.Ifitisdefined,itis
displayed.
3-7
Screen Data
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.
3-8
Screen Data
Tomakesurethatthesettingsarerestoredafterusingtheseoptions,
screensaresenttoeachoftheprintersasfollows:
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
3-9
Screen Data
1B2932
G1set2singlesize
1B5B30303070
Leftmarginzero
1B5B30343071
Rightmargin40characters
0F
SelectG0set
Note:ThetopmarginsuppliedbyscreenK01willbeoverridden
byanyvalidvalueenteredthroughoption92,ReceiptTopMargin
ontheConfiguremenuinSupervisor.Fordetails,refertoChapter4,
ConfigureMenuoftheAPTRAAdvanceNDCSupervisorsGuide.
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
0F
SelectG0set
Journal:K10
Table 3-5
Screen Contents K010
1B6531
PrintPositionofHRIbarcodecharacters
1B7733
Widthofbarcode
1B68313632
Heightofbarcode
1B2A31<image
filename>1B5C
3-10
Screen Data
Table 3-6
Screen Contents K07
PathtotheFinancialInstitutionReceiptand
Journalspecificdata,includingimagefiles,
graphicfilesandcustomerdefinedcode
pages.Maximumlengthis30.Bydefault,
thisisnotdefinedasthedriverwilluseits
ownpathof\40colfil
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
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
3-11
Screen Data
P1=2or3selects6.0lpi
P1=4to7selects5.0lpi
Thefollowingdefaultsettingsapplyforthestatementprinter:
P1=0or1selects8lpi
P1=2or3selects6lpi
P1=4to7areignored
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
3-12
Screen Data
NDC+releasesifyouchoosenottousethetouchscreenkeyboard
features.Theactualscreendisplaydatacontainedinthesescreensis
neverused.
M06Transactionprocessingstandardlayout
M09Transactionprocessingstandardlayoutwith
Clear/Cancelkeysswapped.
Youmayeditthesescreenstocustomisethedefaultlayouts.
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.
3-13
Screen Data
Formatting Rules for Cardholder Display Screens
FormattingRulesforCardholder
DisplayScreens
Theformattingrulesforallscreensthataredisplayedonthe
cardholderscreenduringStateTableprocessingincludethe
following:
Displaycharacters
Controlcharacters
Track1namedisplay
Controlcodesforspecialfeatures
Internationalcurrencydisplayformat.
Forgeneralpointstoconsiderwhenyouarepreparingscreensfor
display,seeDisplayingPicturesonpage 352.
Note:Cardholderscreensmustnotbedefinedintheresrvd.deffile.
CardholderScreen:
DisplayCharacters
Table 3-9
Cardholder Screen: Character Sets
Thecardholderscreencandisplayanycharactercontainedinthe
followingcharactersets:
3
Character Set ID
Number of
Characters
Designator
SingleSizeAlphanumeric1
96
96
StandardGraphics1
64
StandardGraphics2
64
StandardGraphics3
64
DoubleSizeAlphanumeric1
96
>
DoubleSizeAlphanumeric2
96
96
SingleSizeAlphanumeric1isthestandardcharacterset.Other
charactersetscanbeaccessedthroughtheSelectCharacterSet
controlsequence.
StandardGraphics2mapstoCustomerGraphics2(Arabic)andisa
displayonlyfont,reflectingtherangeandlookofcharactersthat
arerequiredinanSSTapplication.Formoreinformationabout
charactersets,seeAppendix B,CharacterSets.
3-14
Screen Data
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
3-15
Screen Data
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,:,;,<,=,>,?
3-16
Screen Data
Character
ASCII Hex
Code
Function
where@isthelefthandcolumnand?isthe
righthandcolumn.Foradiagramshowingthe
cardholderscreenlayoutandFDKalignment,see
Cardholder/EOPScreenLayoutonpage 32.
ForadiagramshowingtheTouchScreenFDK
Emulationarea,seeFDKEmulationon
page 42.
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.
3-17
Screen Data
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
AutoSelectForwardsSearch.
3-18
Screen Data
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).
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).
3-19
Screen Data
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
SpecialfeaturescanbeaccessedbyusingtheESCcharacterand
supplementarycontrolcodes.Thefollowingtableprovideslinksto
detailsofthecontrolcode:
Feature
Introducer
Identifier
Voice(see321)
ESCP
Screenblinkingandcolourcontrol(see327
ESC[
Changingdisplayinidle(see330)
ESC[
3-20
Screen Data
Feature
Introducer
Identifier
Selectprimarycharacterset(see331)
ESC(
Selectsecondarycharacterset(see331)
ESC)
Leftmargincontrol(see332)
ESC[
Logocontrol(see333)
ESCP
Picturecontrol(see333)
ESCP
Setdisplaymodecontrol(see332)
ESCP
Displayimagefilescontrol(see334)
ESCP
Liftchequeimagecontrol(see335)
ESCP
Bunchchequeimagedisplaycontrol
(see335)
ESCP
Bunchchequecodelinedisplaycontrol
(see337)
ESCP
Bunchchequeamountdisplaycontrol
(see337)
ESCP
Bunchchequevaluedisplaycontrol
(see338)
ESCP
Displaydynamictextdictionarycontrol
(see339))
ESCP
Dynamicbuttoncontrol(see342)
ESCb
Dynamictextcontrol(see343)
ESCq
Animation(mayusepicturecontrolor
displayimagefilescontrol)(see344)
MPEG(mayusepicturecontrolordisplay
imagefilescontrol)
Voice
Ifdigitalaudiohardwareisinstalled,theSSTcanprovidethree
typesofspokenmessages:
Autovoiceprerecordedmessagesplayedatpredefinedtimes
Audiocontrolsembeddedinscreenstoplayprerecorded
messages
Voiceguidance.
Note:Ifavoiceguidedsessionisactive,thefirsttwotypesarenot
playedduringthevoiceguidedsession.
3-21
Screen Data
PrerecordedMessages
Makesurethattheprerecordedmessageisbriefenoughtoplay
completelybeforethestateistimedout.Theterminalattemptsto
playmessagesatthefollowingtimes:
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 1017.
Thefollowingtenmessagesaresuppliedasdefaults:
0
Weregretthattheterminalsservicesarenotavailable.
Pleasewaitwhileyourtransactionisprocessing.
3-22
Screen Data
Entertheamountwhenyouareready.
Yourcardandreceiptarereadyforremoval.
Pleaseselecttheservicerequiredandtheaccounttobecharged.
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 1051.
FordetailsoftheXMLconfigurationfileforvoiceguidance,referto
Chapter6,ConfiguringVoiceGuidanceintheAPTRAAdvance
ExamplesofaudiodatasentinTransactionReplymessagesare
givenonpage 325topage 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
3-23
Screen Data
Number of
Characters
Character
Description
Parameter
flag
Adigitifparametersfollow(forexample,
1)
Separator
SeeTableNote2
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.
3-24
Screen Data
Example1:ScreenUpdateinaTransactionReplywithFixed
Data
Thismessageupdatesscreen129,whichisthedisplayscreenfor
Closestate027.Thescreenandcontrolsequenceareshowninbold.
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:

<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:
Thank you for banking with us. </Text></Audio>
<Text lang="en" state="private"> <PlaceHolder/> <PlaceHolder/>
<PlaceHolder/> </Text> </Audio>
Alternatively,theycanbedefinedusinganaudiofile,asfollows:

<Recording file="0129.wav" state="private"/> </Text> </Audio>
3-25
Screen Data
<Text lang="en" state="private"> <PlaceHolder/> <PlaceHolder/>
<PlaceHolder/> </Text> </Audio>
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.
3-26
Screen Data
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
3-27
Screen Data
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)
3-28
80
Screen Data
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
3-29
Screen Data
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[
Variable
DelayTimein100millisecondintervals
(000999)
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
3-30
Screen Data
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(
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)
Variable
3-31
Screen Data
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[
Variable
ColumnNumber(0031)
WhenaLeftMargincontrolsequenceappearsinthescreendata,all
subsequentCRcontrolcharacterswillreturnthecursortothe
columnspecified,untileitherthedatadelimiterattheendofthe
outermostscreenisreachedoruntilanidlescreendisplaysequence
occurs.Theleftmargincontrolwillthendefaulttocolumn00.
SetDisplayModeControl
AdvanceNDCsupportsdisplaymodesof640by480andabove.If
theSetDisplayModecontrolissent,itisignoredasscreen
resolutioncannotbechangedatruntime.Formoreinformation
aboutdisplayresolutionrefertotheAPTRAAdvanceNDC,
DevelopersGuide.
3-32
Screen Data
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>.png)are
numbered000,001,003to006,andarealsodisplayedby
reservedgraphicsscreensG00G01,G03G06.Thepredefined
picturesarestoredinC:\ProgramFiles\NCRAPTRA\Advance
NDC\MediaontheSST.ScreenG02isnotusedandscreensG07
G09arereserved.
Note1:Variousgraphicformatsaresupported,includingPNG,
JPEG,GIF,TIFF,andJIFF.NCRrecommendsthatanuncompressed
bitmapformat,forexampleBMPorPNG,isusedifdisplay
performanceiscritical.Theuseofhighlycompressedformatssuch
asJPEGmayresultindegradationofthedisplayperformance.
Note2:AsAdvanceNDCdoesnotsupportthePCXfileformat,the
PCXextensionisdiscardedandAdvanceNDCsearchesforamatch
onthefilenameandextensionofasupportedformatifahost
3-33
Screen Data
downloadcontainingareferencetoaPCXfileinascreendefinition.
Forexample,image.pcxcanberesolvedasimage.png.Ifamatch
cannotbefound,ascreencontainingtheimagenameisdisplayed.
PictureControlCommand
followingcontrolstring:
Table 3-28
Picture Control Command
Picturescanbedisplayedwiththe
Character
Description
Number of
Characters
ESCP
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
ControlStringID
parameter
Thenameoftheimagefiletobedisplayed
Var
ESC\
StringTerminator
ThefilenameisanASCIIstringcontainingthefilenameand
optionallythepathoftheimagefile.ThedefaultpathisC:\Program
Files\NCRAPTRA\AdvanceNDC\Media.
Note:WhenanAVIfileisdefinedinadownload,AdvanceNDC
expectsthefilenametocontainnomorethaneightcharacters
(<xxxxxxxx>.avi).Ifalongernameisused,anythingaftertheeighth
characterisignored.
3-34
Screen Data
Whenascreencontainingthiscontrolsequenceisdisplayed,the
imageisdrawnstartingfromthecurrentcursorposition.
LiftChequeImageControl
Thiscontrolcodeallowsyoutodisplayaliftedchequeimageonthe
screen,usingthefollowingcontrolstring:
Table 3-30
Display Lifted Cheque Image Command
Character
Description
Number of
Characters
ESCP
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.
chequeimageisdrawnstartingfromthecurrentcursorposition.A
halfinchblackstripeisdrawnatthebottomofthechequetomask
thecodeline.
Howchequeimagesaredisplayedonthescreencanalsobe
controlledbylocalconfigurationparametersontheSST.Fordetails,
refertotheAPTRAAdvanceNDCDevelopersGuide.
BunchChequeImageDisplayControl
Thisdisplaysthefollowingasrequiredduringbunchcheque
acceptance:
Aspecificimageforaspecificcheque
AselectedimagefromtheavailablelistduringtheCheque
SummaryDisplaystate.Fordetails,seez004DisplayCheque
SummaryStateonpage 2134
Howchequeimagesaredisplayedonthescreencanbecontrolled
bylocalconfigurationparametersontheSST.Fordetails,referto
theAPTRAAdvanceNDCDevelopersGuide.
3-35
Screen Data
Table 331
Bunch Cheque Image Display Control
Character
Description
Number of
Characters
ESCP
ControlStringID
Side
Thesideofthechequetodisplayasfollows:
0thefront
1theback
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.
chequeimageisdrawnstartingfromthecurrentcursorposition.A
halfinchblackstripeisdrawnatthebottomofthechequetomask
thecodeline.
3-36
Screen Data
BunchChequeCodelineDisplayControl
Thisdisplaysthecodelineforachequeduringbunchcheque
acceptance.
Note:Ifyouarecomplyingwiththepaymentcardindustry(PCI)
guidelines,youmustnotusethiscontrolsequence.
Table 3-32
Bunch Cheque Codeline Display Control
Character
Description
Number of
Characters
ESCP
ControlStringID
ChequeID
SeeTableNote6
ESC\
StringTerminator
BunchChequeAmountDisplayControl
Thisdisplaystheamountforachequeduringbunchcheque
acceptance.
Table 3-33
Bunch Cheque Amount Display Control
Character
Description
Number of
Characters
ESCP
ControlStringID
ChequeID
SeeTableNote6
Separator
Amount
screen
Selectsthescreenusedtodefinethedisplay
oftheamount
3-37
Screen Data
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
ControlStringID
Value
Selector
Specifiesthevaluetodisplay,asfollows:
000chequeindex
001totalnumberofchequesinserted
002totalnumberofchequesthathavebeen
addedtotheescrow
003reserved
004numberofchequestobereturnedto
thecardholder
005totalamountofthechequestobe
deposited.Thisisthesumoftheindividual
cheques
006contentsoftheAmountBuffer
007contentsofgeneralpurposebufferA
008contentsofgeneralpurposebufferB
009contentsofgeneralpurposebufferC
SeeTableNote6
3-38
Screen Data
Character
Description
Number of
Characters
Separator
Value
Format
Screen
Selectstheoverlayscreenthatdefineshow
thevalueistobedisplayed
Ifthisissetto000,noformattingisapplied
ESC\
StringTerminator
DisplayingtheAmountBufferValue WhentheValueSelectoris
006,thevalueoftheAmountbufferwillbedisplayedintheCheque
DetailDisplayandDisplayChequeSummarystatesaccordingto
thescreendefinitionspecifiedbytheValueFormatScreen.
3
TheValueFormatoverlayscreendefinesthealignment,positioning,
currencysymbolanddecimalpointofthedataintheAmount
buffer.Thealignmentofthedataisdeterminedbythepositionof
theasterisksanddigitsintheoverlayscreen.Thenumberof
asterisksdefinedisvariable.Thecurrencysymbolanddecimal
pointarevariableandoptional.
Ifthescreendefinitionis$*****0.00,theAmountBuffervaluewill
bealignedtotherightofthedisplayareaonthescreenanditwill
expandtotheleft
Ifthescreendefinitionis$0.00*****,theAmountBuffervaluewill
bealignedtotheleftofthedisplayareaonthescreenanditwill
expandtotheright.
Anyotherscreenformatdefinitionisignored.Forexample,ifthe
screendefinitionis$***0.00**,itisignoredandtheAmountBuffer
valuewillbedisplayedalignedtotherightofthedisplayarea.
ExampleofAmountBufferDisplayFormatting IftheIfthe
BunchChequeValueDisplayControlsequenceisthefollowing:
<ESC>Pw006;500<ESC>\
andtheAmountBufferhasavalueof1100200300.45,thescreen
definitioncanbe$*********0.00or$0.00*********.
Ifthescreendefinitionis$*********0.00,theAmountBufferis
alignedtotherightanddisplayedas$ 1100200300.45.
Ifthescreendefinitionis$0.00*********,theAmountBuffervalueis
alignedtotheleftanddisplayedas$1100200300.45 .
DisplayDynamicTextDictionaryControlSequence
Thiscontrolsequencedefinesanddisplaysthetexttobeusedto
communicatedynamicconditionstothecardholder,forexample
thereasonforanerror.Thiscontrolsequenceassociatestextwithan
3-39
Screen Data
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
ControlStringID
Dictionary
ID
Dictionaryidentifier
Range000999
Themeaningisdefinedbythestateusing
thedataandthescopeislimitedtothe
screendefiningthedictionary,thereforethe
sameidentifiercanbeusedinmultiple
screenstorefertodifferentdictionaries
Separator
Enumerated
valuelist0
Definesoneormoreenumeratedvaluesto
whichthetextfollowingthenextSeparator
relates
Thisparameterconsistsofoneormore
threecharacteralphanumericvalueswith
charactersintherange09andAZ.When
multiplevaluesareincludedeachvalueis
separatedbyacomma.Nocommais
requiredafterthelastentryinthelist
Fornumericvalues,forexampleerror
reasons,thevalueislimitedtoarangeof
000999
Fortextbasedvalues,forexamplecurrency
identifiers,alphabeticcharacterscanbeused
Var
Separator
3-40
Screen Data
Number of
Characters
Character
Description
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
relates
Var
Separator
Displaytext
1
enumeratedvalue.
Var
Textterminator
Enumerated
valuelistn
relates
SeeTableNote7
Var
Separator
Displaytext
n
enumeratedvalue
SeeTableNote7
Var
ESC\
StringTerminator
TableNote7:Enumeratedvaluesandrelateddisplaytextare
repeateduntilallrequiredvalueshavebeendefined.
ExampleDisplayText Displayformattingmustbecontainedin
thescreenthatusesthedictionaryvalue,asshowninthefollowing
examples:
TodisplayHELLO,enterthefollowing:
HELLO
3-41
Screen Data
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.
Thefollowingcontrolcodeisavailableforthedefinitionofabutton
withaconditionalexpressionparameterspecifyingtheconditions
thatmustbetrueforthebuttontobeenabled:
Table 3-36
Dynamic Button Definition
Character
Description
Number of
Characters
ESCPb
Fixed
FDKidentifier(F1F8)
Separator
Variable
Texttodisplayonthebutton
Var
Separator
Variable
Iconfilename
Var
Separator
Variable
Indextodynamiccontenthook
Var
3-42
Screen Data
Character
Description
Number of
Characters
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)
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
3-43
Screen Data
dynamicidlesequenceaccuratelyreflectingthesetofoperations
availableforatransactionwithouttakingtheSSToutofserviceto
updatethescreendata.
Note:DynamictextissupportedforNDCformattedscreen
definitionsonly.
Thecontrolcodeforthedefinitionofdynamictexthasamandatory
dataparameter,whichspecifiesthedevicesthatmustbeavailable
forthetexttobedisplayed.Thecontrolcodeisdefinedinthe
followingtable:
Table 3-38
Dynamic Text Definition
Character
Description
Number of
Characters
ESCq
Variable
Texttodisplay
Var
Separator
Variable
Indextodynamiccontenthook
Var
Separator
Variable
Conditionalexpression
Var
ESC\
StringTerminator
Anexampleofthiscontrolisasfollows:
<ESC>qTHIS IS DYNAMIC;002;FALSE<ESC>\
ThedynamiccontenthookisdefinedinDisplayManagerConfig.xml.
Fordetails,refertotheAPTRAAdvanceNDCDevelopersGuide.
Formoreinformationaboutconditionalexpressions,seeSyntaxof
ConditionalExpressionsonpage 343.
AnimationandDigitalVideo
Thisenablesyoutodisplayapredefinedanimationordigitalvideo
sequenceonthescreen.Thissequenceisatypeofpictureandis
displayedasapicture.Fordetails,seePictureControlon
page 333.
3-44
Screen Data
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
fieldformatforamountentry.Thisisasimpletextstringthatis
displayedatthecursorpositiononentryintoanamountentrystate.
Themaximumlengthoftheechofieldis32characters.Thisincludes
upto12dataentrycharacters(*),acharacterdefiningthedecimal
pointposition,zeroprefillcharactersandleadingcurrency
characters.
Theonlyscreencontrolcharactersthatcanappearinthisscreenare
thesetcursorpositioncharacter,andthesecondarycharacterset
introducer(VT)character.Allothercharactersareignored.Ifyou
needtousesomeotherattributefortheamountdisplayscreen,you
mustincludeitinthescreenonwhichtheamountscreenis
superimposed(thescreencalledfromstatetableentry2ofan
amountentrystate).
3-45
Screen Data
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.
Whenconfiguredbyoption01intheEnhancedConfiguration
ParametersLoadmessage,theamountentrybuffercancontainup
totwelvedigits.Fordetails,seetheConfigurationParameters
LoadsectioninChapter 10,CentraltoTerminalMessages.This
affectstheamountechofieldinthefollowingways:
Upto12dataentrycharacters(*)canbeused
thedefaultis$*********0.00ifnoechofieldformatisdefined.
ExampleofDefaultEchoDisplayFormat
Inthefollowingexample,b=space:
3-46
Screen Data
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
3-47
Screen Data
Multi-Language Screens
Youcancreateupto9,999multilanguagecardholderscreenstobe
displayedasrequestedfromoneofthelanguageselectstates.You
dothisbydefiningagroupofscreensforeachlanguage(screen
group).Thefirstscreenineachscreengroupisdefinedbythescreen
base.
Thefollowingrulesmustbeappliedwhencreatingthescreen
groups:
MultiLanguageScreen
Numbering
Allthescreensthatcanbedisplayedinmultiplelanguagesmust
bedefinedineachscreengroup
Theequivalentscreenforeachlanguagemustoccupythesame
relativepositionwithinthescreengroups.Thisensuresthatthe
correctscreenisselectedwhenthelanguageoffsetisapplied.
Nestedscreensmusthaveabsolutepositions.
Thefirstgroupmuststartat000or0000,andcontainthose
screensforwhichlanguageselectionisnotpossible,thatis,screens
displayedfromtheCardReadstateandLanguageSelectFromCard
state.Screensnormallyassociatedwithnotinserviceconditions,
suchasOutofService,SupplyandOffLine,shouldalsobeinthis
groupifthedefaultcardholderdisplayscreens(page 36)areused.
Toallowlanguageselection,youdonotneedtochangethestate
tablesbutyoumustincludealanguageselectionstatesuchasthe
following:
YEightFDKSelectionFunctionState(page 279)
VLanguageSelectFromCardState(page 273)
mPIN&LanguageSelectState(page 289).
ExtendedScreenGroups
Theextendedscreengroupconfigurationchangesthewaythatthe
languageoffsetisdefinedinthelanguageselectionstatesasfollows:
Ifextendedscreengroupsarenotenabled,thescreenoffsetthat
canbeappliedtoscreenswithascreennumberover1000is
incrementedinmultiplesof1000becausethescreenbase
definitionsmustbeintherange001to009.Forexample,you
couldspecify001,002,004and006todefinefourlanguageswith
screenbasesof1000,2000,4000and6000.
Ifextendedscreengroupsareenabled,thescreenoffsetthatcan
beappliedtoscreenswithascreennumberover1000canbe
incrementedinmultiplesof100becausethescreenbase
definitionsmustbeintherange010to099.Thisincreasesthe
3-48
Screen Data
numberofavailablescreens.Forexample,youcouldspecify
010,025,050and075todefinefourlanguageswithscreenbases
of1000,2500,5000and7500.
Forinformationonconfiguringextendedscreengroups,referto
Chapter5,ConfiguringAdvanceNDCandAssociated
ComponentsintheAPTRAAdvanceNDC,DevelopersGuide.
Forfurtherexamplesofthedefinitionofscreengroups,see
ExampleScreenGroupDefinitionsbelow.
ExampleScreenGroupDefinitions
Thefollowingsectionsprovideexamplescreengroupdefinitions.
FourLanguagesWithThreeDigitScreenNumbers Forexample,
iffourlanguagesarerequiredandthreedigitsareusedforthe
screennumbers,thescreengroupbasesdefinedineitherstateYor
statemcouldbeasfollows:
3
LanguageA000
LanguageB100
LanguageC200
LanguageD300
ThescreengroupsizedefinedinstateVwouldbe100.
Ifscreen025isdefinedfromastatetable,thescreenisdisplayedas
follows:
025forlanguageA
125forlanguageB
225forlanguageC
325forlanguageD.
FourLanguageswithExtendedScreenGroupsEnabled Iffour
languagesarerequiredandextendedscreengroupsareenabled,the
screengroupbasesdefinedineitherstateYorstatemcouldbe
thefollowing:
3
LanguageA0000
LanguageB2500
LanguageC5000
LanguageD7500
ThescreengroupsizedefinedinstateVwouldbe025,
representing2500.
3-49
Screen Data
follows:
0025forlanguageA
2525forlanguageB
5025forlanguageC
7525forlanguageD
IfscreenB25isdefinedfromastatetable,thescreenisdisplayedas
follows:
1125forlanguageA
3625forlanguageB
6125forlanguageC
8625forlanguageD
FourlanguageswithExtendedScreenGroupsDisabled Iffour
languagesarerequired,fourdigitsareusedforthescreennumbers
andextendedscreengroupsaredisabled,thescreengroupbases
definedineitherstateYorstatemcouldbeasfollows:
LanguageA0000
LanguageB1000
LanguageC2000
LanguageD3000
ThescreengroupsizedefinedinstateVwouldbe001,
representing1000.
follows:
0025forlanguageA
1025forlanguageB
2025forlanguageC
3025forlanguageD.
3-50
Screen Data
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.
Theusageofeachscreendoesnotchange.
3-51
Screen Data
Displaying Pictures
DisplayingPictures
Thissectiondiscussessomepointstoconsiderwhenyouare
preparingpicturesfordisplayontheterminal.
Thefollowingimageformatsaresupported:
JPEG
GIF(includinganimatedandtransparentGIFs)
PNG(includingtransparentPNGs)
TIFF
SWF.
Note1:TheuseofSWFfilesonSSTsrequiresalicence.AlicenceID
canbepurchasedfromNCR.
Note2:ThePCXfileformatisnotsupportedbyAdvanceNDC.Ifa
hostdownloadcontainsareferencetoaPCXfile,AdvanceNDC
discardstheextensionandsearchesforafilewiththesamename
andasupportedextension.
PictureResolution
GuidelinesforPictures
Thefirstpicturedisplayeddeterminestheamountofstretchingthat
isappliedtoallpictures.Forexample,ifthedesktopresolutionisset
to1024x768andthefirstpicturedisplayedis800x600,thepicture
isscaledupto1024x768.Allsubsequentpictureswillbescaledby
thesameamount.
Thefollowingpointsshouldbeconsideredwhenyouarepreparing
picturesforscreendisplay:
Toavoiddisplayflickerwithafullscreenfile,includeaform
feedatthestartofthescreendefinition
Thesupplymodescreen,C03,isacardholderdisplayused
whentheterminalisinSupervisormode.Itmustbeofthesame
resolutionasthoseusedduringtherestofSupervisormodeif
switchingfrombacktofrontdisplays
Screensusedduringanidlesequenceshouldbeconstructed
usingthesameresolution.
3-52
Screen Data
Screen Reset
ScreenReset
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
Note:AstheFFcontrolclearsthescreen,anymodificationto
screenM16musttakethisintoaccount.Forexample,tomakethe
backgroundtransparent,M16mustbeupdatedasfollows:
DC2 FF ESC[00;80m ESCPi0 ESC\
FormoreinformationaboutFFandcontrolcodes,seeControl
Charactersonpage 316andControlCodesforSpecialFeatures
onpage 320.
3-53
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.
3-54
Screen Data
SupervisorSettlement
Transactions
WhentheoperatorselectstheSupervisorTransactionsfunctionat
theSST,screensC09C19arecheckedforvalidSupervisor
settlementtransactiondata.
Validscreenscontainadefinitionofthecardtrackdatathatwould
beonthesupervisorcard,anddefinitionsforallthedatarequiredto
becollectedbythetransactionflows.Foreachtransaction,the
OperationCodebufferthatwouldhavebeencreatedbythe
transactionflowisalsodefined.Theformatofthescreensisdefined
inTransactionsParameterScreens(C09C19)onpage 356.
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
SettlementScreensonpageA92.
Oncompletionofdataentry,theTransactionRequestmessageis
createdusingthespecifiedTransactionRequeststate,fileand
entereddata,andsenttoCentral(theHost).Fordetailsofthe
TransactionRequeststate,seeITransactionRequestStateon
page 233.
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
3-55
Screen Data
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)
Var(1106)
PINFlag.
0NoPINcollect.
1PINcollect.
TransactionRequestStateNumber.Usedto
createTransactionRequestmessage.
30
NextStateNumberTable.10entries(3bytes
each).Usedforcomparisontonextstatein
transactionreply.
Notusedentries=255.
3-56
Screen Data
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.
3-57
Screen Data
3-58
Table of Contents
Keyboard Data and Layouts
Chapter 4
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
Table of Contents

Overview
Overview
Thischapterprovidesinformationaboutthefollowing:
Thekeyboardinterface
Statesandkeyboards
Standardkeyboardlayouts
Definingfulltouchscreenkeyboards
4-1

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

ThescreensarechangedusingaScreenDataLoadcommandfrom
Central,Fordetailsofthecommand,seetheScreen/KeyboardData
LoadsectioninChapter 10,CentraltoTerminalMessages.
YoucanconfigureAdvanceNDCtosoundabeepwhenan
emulatedFDKisselected.Forconfigurationdetails,refertoChapter
5,ConfiguringAdvanceNDCandAssociatedComponentinthe
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
4-3

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 107.
ThetablebelowshowseachFDKkeywithitskeypositioncode,
defaultkeycode,andtheassociatedCENXFSkeyliteral.
4-4

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(seefieldj1onpage 1012)containspairsofdatainthe
followingform,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
4-5

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

InformationEntryStateExample
Thisexampleshowsthemessagefordownloadingasamplestate
definitionandthemessageforanassociatedscreenandkeyboard
definition.TheScreen/KeyboardDataLoadmessageupdatesthe
screendisplayedonentrytotheInformationEntrystate(seeH
InformationEntryStateonpage 229)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
4-7

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)
CashAccept(>)
ChequeAccept(w)
BarcodeRead(&)
TimeOut.
Keyboardscanalsobeusedbythecardholderduringaninteractive
transactionresponse.
Downloadablekeyboarddefinitions(associatedkeyboards)are
supportedonlyforphysicalandemulatedFDKs.Thefollowing
statetypesdonotsupportdownloadablekeyboarddefinitions:
PINEntry(B)
EnhancedPINEntry(M)
CardReadPINEntryInitiationState(T)
ChequeAcceptState(w)
CashAcceptState(>)
BarcodeState(&)
Cardlesstransactioninitiationdoesnotsupportassociated
keyboards.
4-8

States and Keyboards
AssociatedKeyboardsfor
FDKs
SecurePINEntryand
Keyboards
Ifascreennumberreferencedinoneofthesestatetablesis
associatedwithakeyboardlayout,thelayoutissetup.Optionssuch
asswappingleftandrightFDKsorswappingtheClearandEnterkeys
areignored.Ifakeyboardisnotassociatedwiththescreen,adefault
layoutisused.
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.
4-9

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
4-10
FDKD

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

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

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

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.
assignedfornonnumerickeys,withthecorrespondingCENXFS
commandkeysdefinitionfortheTextTerminalUnit(TTU).
4-14

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

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

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
Exponent
Sign
Mantissa
24 23
31 30
byte 0
8 7
16 15
byte 1
byte 2
0
byte 3
4-17

Acoordinateiscalculatedusingthefollowingformula:
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
4-18

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

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?.
4-20
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
SelectPrintingPositionofHRICharacters
SelectWidthofBarcode
SelectHorizontalHeightofBarcode
SelectDualsidedPrinting
56
57
57
58
59
59
59
510
510
512
513
514
515
516
517
517
518
518
CharacterSets
PrimaryPrintPage
SecondaryPrintPage
520
522
522
StatementPrinterControls
LeftMarginControl
523
523
Table of Contents
Printer Data
RightMarginControl
MarginControlUse
LinesPerInchControl
523
524
524
SimulatedPreprintedReceiptMessages
PrintingImagesUsingScreensR00andR01
ScreenR00
ScreenR01
OtherUsesofScreensR00andR01
525
525
525
525
526
SidewaysPrintingonReceipt
UnsupportedFunctions
529
529
PrinterControlSequencesandRegistrySettings
530
Printer Data
Overview
Overview
Thischapterprovidesinformationonthefollowingtopics:
PrintertypessupportedbyAdvanceNDC
DefaultprintsforProgrammablePrintingDepository(PPD)
Printercontrolcharacters
Charactersets
Statementprintercontrols
Simulatedpreprintedreceiptmessages
Sidewaysprintingonreceiptprinters
Printercontrolregistrysettings.
Note:ThischapterprovidesinformationforNCRprinters.For
differencesthatmightbeexperiencedwithprintersfromother
vendors,refertotheAPTRAAdvanceNDC,MultiVendorSupport
ReferenceManual.
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 529.
WhenprintinginsidewaysmodeontheSDCorRS232receipt
printertheformlengthisnotconfigurable.Areceiptwitha
maximumof20linescontainingupto80columnscanbeprintedin
sidewaysmodeonthereceiptbeforeacut.
Thedatatobeprintedonaparticularprinter,orprinters,mustbe
placedinaprinterdatafieldcontainedinaTransactionReply
Commandmessage.Fordetails,seetheTransactionReply
CommandsectioninChapter 10,CentraltoTerminalMessages.
5-2
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,
refertotheAPTRAAdvanceNDC,SupervisorsGuide.Thisisnot
supportedinsidewaysprintingmodeonthereceiptprinter.
5-3
Printer Data
PPD Default Print
PPDDefaultPrint
IfadepositisrequestedinaTransactionReplycommand,butnone
oftheprinterflagfieldscontainsavalueof4or5,thefollowing
informationisprinted,dependingonwhethertheamountbuffer
lengthiseightortwelvecharacters:
EightCharacterAmount
Buffer
Thefollowingisprintedforthisbuffer:
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
5-4
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
5-5
Printer Data
Printer Control Characters
PrinterControlCharacters
Thesecharactersallowdatatobeformattedforprinting.The
printersvaryinthecontrolcharacterstheysupport.
Thecontrolcharactersareshowninthefollowingtable,withany
specialprintercharacteristicsnoted,otherwisetheyrefertoall
printers:
Table 5-1
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.
5-6
Printer Data
Character
ASCII Code
Function
ESC
1Bhex
Controlcharacterintroducingsupplementarycontrolcodes.Formore
information,seeCharacterSetsonpage 520andStatementPrinter
Controlsonpage 523.
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 530.
SetLeftMargin
Youcansettheindentationofprintcolumnsfromtheleftedgeof
thepapertothevaluegivenbythevariablefieldwiththefollowing
5-7
Printer Data
controlsequence.Theformatofthevariablefieldisaone,twoor
threebyteASCIIvalueintherange000078.
Table 5-3
Set Left Margin Position
Character
Description
Number of
Characters
1BH5BH
(ESC)[
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)[
Variable
Positionoftherightmostprintcolumnfrom
column2
71Hq
EscapeSequenceID
Anattempttoprintbeyondtherightmarginwillresultintheextra
charactersprintingfromtheleftmargin.
Therightmarginsettingmustbeatleasttwogreaterthanthe
currentleftmarginsettingorasquarebracketwillbeprinted.
Thesettingoftherightmarginremainsuntilitiseitherchangedby
thiscontrolsequence,thepowersupplytotheprinteristurnedoff
5-8
Printer Data
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.
TheprinterhardwaresupportsbothInternationalandArabic
charactersetsandanapplicationcanmakeuseoftheInternational
setwiththiscontrolsequencewhichoverridesthecustomisation
switchsetting.
5-9
Printer Data
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.
AnapplicationcanmakeuseoftheArabiccharactersetwiththis
controlsequencewhichoverridesthecustomisationswitchsetting.
Table 5-7
Select Arabic Character Sets
Character
Description
Number of
Characters
1BH(ESC)
33H3
EscapeSequenceID
Thisisnotsupportedincodepagemodeonthethermalprinter.
Note1:WhenthiscontrolsequenceisincludedintheTransaction
Replyprinterdatastream,theprinterdefaultstoArabicCharacter
Set1.IfprintingusinganothercharactersetisrequiredtheSelect
CharacterSetcontrolsequencemustalsobepresentintheprinter
datastream.
Note2:Thiscontrolsequenceshouldnotbeincludedin
TransactionReplyprinterdatawhichistobeinterlacedwith
reservedscreenR01.Fordetails,seetheSimulatedPreprinted
ReceiptMessagessection.
Printingdownloadablebitimagesissupportedusingeitherforms
orrawdataonUSBprinters,andrawdataonthermalreceiptand
5-10
Printer Data
journalprinters(SDC)only.Thecontrolsequenceallowsa
predefinedbitimagetobeprintedinoneoffourformats,asfollows:
Table 5-8
Print Downloadable Bit Image
Character
Description
Number of
Characters
1BH(ESC)
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
5-11
Printer Data
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)
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
5-12
Printer Data
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
<filename>
1BH5CH
ESC\
TheformatfortheEpsongraphicsfileisdescribedinthe
ProgrammersManualforthe40ColumnPrinter(B0064612).
Whendataispresentintheprinterbuffer,thiscommandisignored.
Therefore,NCRrecommendsthatalinefeedissentbefore
attemptingtoprintgraphics.
Thegraphicsfilecanbegeneratedusinganysoftwarepackage
whichsupportstheEpsonprinterdriver.Thedefaultpathnamefor
thefiledefinedinthecontrolsequenceshouldbedefinedinthe
downloadablereservedK07screen.
ThiscontrolsequenceshouldnotbeincludedinTransactionReply
printerdatawhichistobeinterlacedwithreservedscreenR01.For
details,seeSimulatedPreprintedReceiptMessagesonpage 525.
RawData Ifthegraphicsfileismissing,thefilenameandpathare
printed,forexample,
5

NDC\Media\GRAPHIC.PRN
5-13
Printer Data
Forms Forformsbasedprinting,anypredefinedextension,such
as.prn,isconvertedto.bmp.Theextensionisdefinedinthe
followingregistryentry:
HKLM\SOFTWARE\NCR\Advance
NDC\PRINTING\FORMS_GRAPHICS_EXT
Ifthefileismissing,thefilenameandpathareprintedwitha.bmp
extension,forexample:
NDC\Media\GRAPHIC.BMP
Ifnoextensionisset,theoriginalextensionisprinted,forexample:
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)
70Hp
EscapeSequenceID
<side>
Whethertoprintthefrontorbackofthe
cheque
0front
1back
5-14
Printer Data
Character
Description
<codeline
control>
Howthecodelineisprinted
0Printtheimageofthechequewithno
alterations.Thismustbeusedwhenprinting
thebackofthecheque
1Printanimageofthechequewiththe
codelineblackened
2Printanimageofthechequewiththe
codelineremoved.
Number of
Characters
Note:ForPADSScompliance,thecodeline
controlvariablemustbesetto1or2if
<side>issetto0
<image
selector>
Indexidentifyingtheimagetoprint.Thisis
anindexwithinthelistofimagesrequested
foreachcheque
Ifthisfieldisnotpresent,onlythefirst(or
theonly)imageisprinted
<cheque
ID>
Thechequeidentifier.Thisisthesame
chequeidentifierusedinthecgxfieldsof
theTransactionRequestandthebbxfields
oftheTransactionReply
Ifthisfieldisnotpresent,theimageofthe
lastchequeprocessedisprinted
1BH5CH
(ESC)\
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)
5-15
Printer Data
Character
Description
Number of
Character
s
26H&
EscapeSequenceID
<filename>
Nameoffilewiththedatafortheselected
characterset
Variable
1BH5CH
(ESC)\
TheformatforthefilenameisdescribedintheProgrammersManual
forthe40ColumnPrinter(B0064612).
Thiscommandcanbeusedtooverwritesinglecharacters.Theuser
definedcharactersareavailableuntilpowertotheprinteristurned
offoraresetoftheterminaliscarriedout.Thiscontrolsequenceis
definedinKReservedScreenK08.
Thiscontrolsequenceissupportedonthermalreceiptandjournal
printersonly.
Youcanusethiscontrolsequencetodefineanddownloadabit
imagetotheprinter.TheimagecanthenbeprintedusingthePrint
DownloadableBitImagecontrolsequencewithoutresendingthedata.
Table 5-13
Define Downloadable Bit Image
Character
Description
Number of
Characters
1BH(ESC)
2AH*
EscapeSequenceID
Var
1Definebitimageone
2Definebitimagetwo
<ASCII
filename>
Nameoffilewiththedatafortheselectedbit
image
Variable
1BH5CH
(ESC)\
Thiscontrolsequenceissupportedonthermalreceiptandjournal
printersonlyandisdefinedinKReservedScreensK09andK10.
TheformatforthefilenameisdescribedintheProgrammersManual
forthe40ColumnPrinter(B0064612).
Onelargebitimagecanbedefinedandprintedortwosmallerbit
imagescanbedefinedandprinted.Ifonebitimageisrequiredthen
themaximumbitimagedatalengththatcanbesentis17920bytes,
5-16
Printer Data
thatisbitimage1.Iftwobitimagesarerequiredthenthemaximum
bitimagedatalengthofeachis8960bytes,thatisacombinedtotal
of17920bytes.
Defininganewbitimageerasesthepreviousone.Thedownloaded
imageisavailabletotheapplicationuntilitisoverwrittenorpower
totheprinteristurnedoff,unlesstheprinterisaUSBthermal
printer.AUSBprinterretainsbitimageswhenpoweredoff.Areset
oftheterminaldoesnoterasetheimage.
SelectPrintingPositionofHRICharacters
Thiscontrolsequencedefinesthelocationofhumanreadable
interface(HRI)charactersinASCIIcharacterformatwithrespectto
thebarcodetheyrepresent.Thesettingremainsuntileitheritis
changedbythiscontrolsequence,powertotheprinteristurnedoff
ThebarcodecanbeprintedusingthePrintBarcodecontrolsequence
withoutresendingthepositionalinformation.
ThiscontrolsequenceisdefinedinKReservedScreensK09and
K10.
Table 5-14
Select HRI Character Printing Position
Character
Description
Number of
Characters
1BH(ESC)
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)
77Hw
EscapeSequenceID
Var
Barcodeminimumwidth
5-17
Printer Data
Thesettingremainsuntileitheritischangedbythiscontrol
sequence,powertotheprinteristurnedofforaresetoftheterminal
iscarriedout.Thedefaultsettingis3.
K10.
Thisissupportedonthermalreceiptandjournalprintersonly.
SelectHorizontalHeightofBarcode
Thiscontroldefinesthebarcodeheight,asthreeASCIIcharacters,in
dotsorn/150withvalidvaluesofnintherange001255.The
controlissupportedonlyonthermalreceiptandjournalprinters.
Forformsbasedprinting,thiscontrolsequenceisignoredasthe
heightofthebarcodeisfixed.
Table 5-16
Select Barcode Horizontal Height
Character
Description
Number of
Characters
1BH(ESC)
68Hh
EscapeSequenceID
Var
BarcodeHeight
Thesettingremainsuntileitheritischangedbythiscontrol
sequence,powertotheprinteristurnedofforaresetoftheterminal
iscarriedout.Thedefaultsettingis162.
K10.
SelectDualsidedPrinting
OnSelfServSSTs,thiscontrolsequencecanbeusedtoprinton
twosidedpaper.
Table 5-17
Select Dual-sided Printing
Character
Description
Number of
Characters
1BH(ESC)
71Hq
EscapeSequenceID
Var
0Printonfrontofpaper
1Printonbackofpaper
5-18
Printer Data
ThisprintercontrolissupportedonlyonUSBreceiptandstatement
printers.Iftheprinterdoesnotsupportdoublesidedprinting,or
twosidedpaperisnotloaded,thissettingisignored.Atstartof
day,printingdefaultstothefrontofthepaper.
5-19
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
10
10
>
Doublesizealphanumeric1.
SeeTableNote1.
SeeTableNote1.
SeeTableNote1.
17
Condensedalphanumericset1(statement,
thermalreceiptinsidewaysprintonly)
17
5-20
Printer Data
Character Sets
Designator
Characters
Per Inch
17
12
12cpisizealphanumeric1(statementonly)
12
12
10
10
SeeTableNote1.
SeeTableNote1.
17
17
12
12
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.
5-21
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
SecondaryPrintPage
Thedefaultcharactersetisthesinglesizealphanumeric1set.ASCII
charactersintherange207Fhexinvokecharactersfromaset.
Alternativecharactersetsareselectedusingthefollowingsequence:
Table 5-20
Select Secondary Print Page
Character
Description
Number of
Characters
1BH(ESC)
PrivateUseEscapeSequenceIntroducer
EscapeSequenceID
Variable
5-22
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
<ASCIIDATA>
Columnnumberrange
From000to(rightmargin4)
Var(13)
70H
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
<ASCIIDATA>
Columnnumberrange
From(leftmargin+4)to132
Var(13)
71H
Character
1BH
(ESC)
5BH
[
WhenaRightMarginControlsequenceappearsintheprinterdata,
allsubsequentprintingcausesanautomaticLFifprintingis
5-23
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
<ASCIIDATA>
Linesperinchselectorrange(from00
to03)
72H
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.
5-24
Printer Data
Simulated Pre-printed Receipt Messages
SimulatedPreprintedReceipt
Messages
ScreennumbersR00R01arereservedforsimulatedpreprinted
receiptmessages.Thesimulatedpreprintdatacanbedownloaded
asasetofreservedscreens.Thesecanbeinterlacedwithreceipt
printertextsentinaTransactionReplyCommandmessage.
PrintingImagesUsing
ScreensR00andR01
WhenscreenR00isusedtodefineimagestobeprintedonthe
thermalreceiptprinter,theapplicationisnotawareofthesizeofthe
imageorthenumberofprintlines.PrintingofR01and/or
TransactionReplyprintdatawillbeginonthelineaftertheimage
definedinR00.Therefore,ifthenumberoflinesofdataplusthe
numberoflinesusedbytheimageexceedstheconfiguredform
length,thedatawillbeprintedontwoormorereceipts.
ScreenR00
ScreenR00containsthereceiptheader.Thiscantaketheformof
texttobeprintedorcancontainthecontrolsequencewhich
instructsthethermalreceiptprintertoprinttheimagedefinedinthe
controlsequence.ThecontrolsequenceisdefinedinPrint
DownloadableBitImageonpage 510.
Thistextorimageisprintedatthetopofthereceipt,beforeany
printtext.Printingstartsonthefirstavailableprintline.Subsequent
printingoccursonthefirstblanklineafterthepreprintheader.Ifa
receiptiscutattheendofatransactiontheheaderisprintedbefore
authorisationofthenexttransactiontospeeduptransactiontime.
ThereforethereservedscreenR00isnotsupportedinsideways
printingmodeandshouldnotbedownloadedtoaterminalwhich
willbeusedforsidewaysprintingonthereceipt.
ScreenR01
ScreenR01containsthepreprinttexttobeinterlacedwithprint
textfromCentral.Theprinttextiseffectivelyoverlaidlinebyline
onthepreprinttexttoproducethefinalprint(printtexttakes
priority).
5-25
Printer Data
Thefollowingcontrolsequencesshouldnotbeincludedinthe
printerdatatobeinterlacedwithscreenR01sentinthe
TransactionReply:
Table 5-25
Invalid Control Sequences for Screen R01
Character
Description
1BH32H
1BH33H
1BH2FH3xH3yH
1BH6BH3xH<ASCII
Data>1BH5CH
PrintBarcode
1BH47H<filename>
1BH5CH
PrintGraphics
ScreenR01isnotsupportedinsidewaysprintingmode.
OtherUsesofScreensR00
andR01
5
ThisfeatureallowsblankstationerytobeusedwithaCentral
applicationprogramthatwasoriginallydesignedtooperatewith
preprintedstationery.Anotheruseofthesescreensistoalignthe
firstprintlinewithpreprintedheaders.Thisisdonebybuilding
screenR00withtherequirednumberofLF(linefeed)controls.
Thesereservedscreensmustbeconstructedwithnormalprinter
messagecharactersandcontrols.
Thefollowingexampleshowstheinterlacingofthesimulated
preprinttextscreensandthetextreceivedfromCentralina
TransactionReplyCommandmessage.
Figure 5-1
Screen Text Interlacing
5-26
Printer Data
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
5-27
Printer Data
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.
5-28
Printer Data
Sideways Printing on Receipt
SidewaysPrintingonReceipt
Sidewaysprintingonthereceiptprinteriscontrolledthroughthe
useoffunctionidentifiersP(PrintStatementandWait)andQ
(PrintStatementandSetNextState)inconjunctionwiththeprinter
flag=intheTransactionReplymessagesentfromCentral.For
details,seeTransactionReplyCommandonpage 1051.
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.
5-29
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
Sequenceadded
beforeanyprintdata.
Thesequenceisnot
processedby
AdvanceNDC,and
mustthereforeuse
theprintersnative
escapesequences
Footer
FOOTER
Sequenceaddedafter
anyprintdata.
Thesequenceisnot
processedby
AdvanceNDC,and
mustthereforeuse
theprintersnative
escapesequences
Linefeedcharacter
0D
LINE_FEED
0A
5-30
Variable Description
Printer Data
NDC Control Code
(Hex)
Registry Name
USB Control Code

(Hex)
0C
FORM_FEED
1D54191B46
Carriagereturn
character
0D
CR
0A
Horizontaltab
character
09
HT
09
Setleftmargin
1B5Bvar70
LEFT_MARGIN
1D4Cbvar
Columnpositionof
theleftmarginin
standardcharacters,
typicallybetween1
and39
Control
Formfeed
character
SeeTableNote2
SeeTableNote3
SeeTableNote4
FortheUSBReceipt
andJournalprinters,
thisisthecolumn
positionofleft
marginindots
Setrightmargin
1B5Bvar71
RIGHT_MARGIN
Columnpositionof
therightmarginin
standardcharacters,
typicallybetween1
and39
SelectOS2code
page
1B25var
OS2_CODE_PAGE
1B25bvar
Codepagenumber
Copycodepageto
RAM
1B3Avar
COPY_CODE_PAGE
1B3A30bvar30
Codepagenumber
Selectinternational
characterset
1Bvar
INTR_CHAR_SET
1Bvar
ARAB_CHAR_SET
1B2Fvar&
BIT_IMAGE
1D2Fbvar
Bitimageidentifier/
bitimagesize
SeeTableNote3
SelectArabic
characterset
SeeTableNote3
Printdownloaded
bitimage
SeeTableNote5
FortheUSBReceipt
andJournalprinters,
thisisbitimagesize
5-31
Printer Data
Control
NDC Control Code

(Hex)
Registry Name
USB Control Code

(Hex)
Printbarcode
1B6Bvar1B5C&
BARCODE
1D6Bbvar
Barcodetypeand
barcodedata
FortheUSBReceipt
andJournalprinters,
thisisbarcodetype
(tvar),length(lvar),
anddata(dvar).See
Table 530on
page 536fordetails
Printgraphicsfile
1B47var1B5C*
&
GRAPHICS
bvar
Pathandnameof
graphicsfile.
Printlastimage
processed
SeeTableNote6
andTableNote7
1B47var1B5C
$*&
CHEQUE
bvar
$
Sideofchequeto
printandhowthe
codelineisprinted
Selectprimary
charactersetG0
0F
SHIFT_IN
Selectsecondary
charactersetG1
0E
SHIFT_OUT
Selectcharacterset
asactivesetG0
1B28var
CHAR_SET1
Charactersetnumber
Selectcharacterset
asactivesetG1
1B29var
CHAR_SET2
Charactersetnumber
Definecharacterset
1B26var1B5C
DEF_CHAR_SET
var
Path/filename
containingthe
characterset
definition
1B2Avar1B5C
&
DEF_BIT_IMAGE
1D 23 bvar
BitimageIDandthe
path/filename
containingthe
definition
SeeTableNote8
SeeTableNote13
Definebitimage
SeeTableNote5
Positionof
humanreadable
characters
(forbarcode)
1B65var*&
POS_HRI_CHAR
SeeTableNote11
1D48bvar
SeeTableNote12
SeeTableNote9
andTableNote10
5-32
Positionofcharacters
Printer Data
Control
NDC Control Code

(Hex)
USB Control Code

(Hex)
Heightofbarcode
1B68var*&
HZ_HGHT_BARCO
DE
1D 68 bvar
Heightindots
1B77var*&
WIDTH_BARCODE
1D 77 bvar
Widthindots
1B5Bvar73
SET_FORM_LEN
1B 62 bvar
Lengthofformin
rows
Cut
(andfeedonsome
printers)
11
CUT
1D 54 19 1B
46
Sidewaysmodeon
1D
SW_ON
Sidewaysmodeoff
1E
SW_OFF
Verticaltab
0Bvar
VERT_TAB
14bvar
Numberoflinesto
advance
Setextradotrows
1B5Bvar72
EXTRA_DOT_ROW
16bvar
Numberofextrarows
1B5Bvar74
LINE_SPACE
1B33bvar
Linespacing
1B5Bvar75
FIRST_LINE_POS
1B65bvar
Firstlineposition
Selectprintmode
PRNT_MODE
1B21var
Printmodevalue
Selectlogo
SELECT_LOGO
1D23bvar
Bitmapidentifier
Registry Name
SeeTableNote13
Widthofbarcode
SeeTableNote13
Formlength
SeeTableNote14
SeeTableNote15
Setlinespacing
SeeTableNote16
Setfirstline
position
SeeTableNote18
TableNote2:Thisformfeedcontrolcombinestheformfeed(1D
54),thecut(19)andthepresent(1B46)controlcodessothatit
providesthesamefunctionalityastheoriginalformfeedcontrol
(0C).
5-33
Printer Data
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.
TableNote7:Thevariabledatafortheprintchequeimagecontains
thefollowinginformation.Forthereceiptprinter,theprintercontrol
5-34
Printer Data
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.
5-35
Printer Data
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.If,however,aUSBreceiptandjournalprinterisused,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
5-36
Printer Data
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
TableNote18Thefirstlinepositionwillbeoverriddenbyany
validvalueenteredthroughoption92,ReceiptTopMarginonthe
ConfiguremenuinSupervisor.Fordetails,refertoChapter4,
ConfigureMenuoftheAPTRAAdvanceNDCSupervisorsGuide.
5-37
Printer Data
5-38
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
Table of Contents
Supervisor Messages
Supervisor Messages
Overview
Overview
ThischapterdescribestheformattingrulesforSupervisormessages
thatareoutputtotheconsumerscreen(whentheSupervisor
interfacehasbeentransferredtothefront),theoperatorpanel,and
thereceiptandjournalprinters.
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).
6-2
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
Interface/PrinterInformationOutput
14
32
M/m
Interface/PrinterMenus
13
32
P/p
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
6-3
Supervisor Messages
Supervisor Messages
Row16isusedtodisplaykeylegendsforFDKsDandF.Asthese
actasEnterandClearkeysinSupervisormode,columns1to6and27
to32ofLastSupervisorControlKeyscreensmustnotcontain
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
6-4
Supervisor Messages
Supervisor Messages
cassettesareoperational,screenS14isdisplayedonline3,withthe
message:
NO GOOD CASSETTES
Atypicalreportisasfollows:
*CASH TEST*
}ScreenI07
}
TOP CASSETTE GOOD

SECOND CASSETTE GOOD
Ifanexitshutterfaultisdetected,screenS25isdisplayedonthe
CRTafterscreenI07.
6-5
Supervisor Messages
Supervisor Messages
6-6
Table of Contents
Configuration Parameters
Chapter 7
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
Option01SupplyMode,ReadyStatus,&AmountBuffer
Length
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
ExampleValuesforMCN
712
Option35ReportDualModeEJ&HardcopyB/UUnsolicited
Messages
713
Table of Contents
Option36EnhancedEJBackup
Option37PrintTrack2toJournal
Option41SendTrackDetailsonCardRetract
Option44BNAJournalNotesCount
Option45BNASettings
Option46MCRWEnhancedCardDeviceSecurityJitter
Option48BarcodeReader
Option69EMVSmartCardExtendedStatus
Option70EMVSmartCard
Option71TimeOutStateEntry
Option74DestinationforCashDepositRetract
Option76CashHandlers
Option77NextStateNumber
Option78GBRUMStatusReporting
Option79CoinDispenser
Option80AlphanumericStateEntry
Option83ChequeProcessor
TimerNumberFieldk
NumberofSecondsperTimerFieldFieldl
Timers
TimeUnitsforTimers
TimerDescriptions
TimerAdjustmentForVoiceGuidance
Timer00*
Timer01*
Timer02
Timer03
Timer04*
Timer05*
Timer06
Timer07*
Timer08*
Timer09*
Timer10
Timer60
Timer61*
Timer63
Timer68
Timer69
Timer72
Timer77*
Timer78*
713
713
714
714
714
717
717
718
718
718
718
719
719
720
721
721
721
722
722
722
724
724
724
724
724
724
725
725
725
725
726
726
726
727
727
727
727
727
728
728
728
728
728
Table of Contents
Timer87*
Timer92
Timer94*
Timer95*
Timer96*
ReservedTimers
UnsupportedTimers
728
729
729
729
729
729
730
Table of Contents
Overview
G
Overview
TocustomisethewayanSSToperates,inadditiontostates,screens
andprinterdata,youcandownloadeitheraconfiguration
parametermessage,oranenhancedconfigurationparameter
messagewithadditionaloptions,.
Thischapterdescribestheparametersavailableinthesetwo
configurationmessageformats.
Note:TheSSTcanbefurtherconfiguredlocallybytheuseof
messagemodeoptions,whichareaccessedthroughtheSupervisor
Configuremenu.Formoreinformation,refertotheAPTRAAdvance
NDC,SupervisorsGuide.
7-1
Configuration Parameters Load Message
ConfigurationParametersLoad
Message
ThismessagecontainstheparametersusedinNDC+forDiebold
emulation.ThemessageformatissupportedinAdvanceNDC
althoughDieboldemulationmodeisnotsupported.
NotalltheparametersinthismessagearesupportedinAdvance
NDC.Detailsofunsupportedandreservedparametersaregivenin
UnsupportedParametersonpage75.
Fordetailsofthemessageformat,seeConfigurationParameters
Loadonpage1015.
FordetailsofotherparametersthatcanbeusedinAdvanceNDC,
seeEnhancedConfigurationParametersLoadMessageon
page76.
CameraControl(Fieldh)
Table 7-38
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-39
Values for Supply Mode, Ready Status and
Amount Buffer Length
Thissingleparameterisusedtosetthreeconfigurationoptionsand
thevaluetobedownloadedisformedbyaddingthevaluesforthe
threeoptionstogether.Thevaluesforthethreeoptionsareas
follows:
Value
Description
000
Nooptionselected(default)
001
ReadyStatus
SendaseparateReadyBstatusmessagetoCentralin
responsetoaTransactionReplymessage.
7-2
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:IntheEnhancedConfigurationParametersLoadmessage,
thisparameterisfieldh.
TimerNumber(Fieldp)
Thisparametersetsthetimeoutvalueforeachofthetimersthatthe
SSTapplicationuses.Thetimersavailablearethesameforboth
configurationloadandenhancedconfigurationload.
Thefollowingtablesummarisesthetimers.Fordetailed
descriptions,seeTimersonpage724.
Forthelistofreservedtimers,seeReservedTimersonpage729.
Note:InEnhancedConfigurationParametersLoad,thisparameter
isfieldk.
7-3
Table 7-40
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.
7-4
ThefollowingparametersarenotsupportedinAdvanceNDCbut
arereservedinthemessage:
ReservedParameters
CardReadErrorThreshold(Fieldi)
CardWriteErrorThreshold(Fieldl)
Thefollowingparametersarereservedforfutureuse:
7
Fieldj
Fieldk
Fieldn
7-5
Enhanced Configuration Parameters Load Message
EnhancedConfigurationParameters
LoadMessage
TheEnhancedConfigurationParametersLoadmessageformat
containsalltheoptionsavailableinAdvanceNDC.
Mostenhancedconfigurationparametersaredefinedbyanoption
numberinfieldiofthemessage,withfieldjholdingtheoption
code.Thissectiondescribestheoptionsandcodes.
ThefollowingparametersarecommontobothConfiguration
ParametersLoadandEnhancedConfigurationParametersLoad
messageformats,andhavethesamevalues:
SupplyMode,ReadyStatus,AmountBufferLengthand
TransactionStatusData(Option01)
LogicalUnitNumberLUNO
TimerNumber
Theseparametersaredescribedonpage72topage73.
Fordetailsofthemessageformat,seeEnhancedConfiguration
ParametersLoadonpage1017.
ForalistofunsupportedparametersseeUnsupported
Parametersonpage722.
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.
Option01SupplyMode,
ReadyStatus,&Amount
BufferLength
ThisisthesameasoptionmintheConfigurationParametersLoad
message.Fordetails,seeSupplyMode,ReadyStatus&Amount
BufferLength(Fieldm)onpage72.
7
7-6
Option02AutoVoice
Table 7-41
Option 02: Auto Voice Values
IftheSSTisfittedwithanautomaticvoicefeature,thisparameter
setsautovoiceonoroff.Possiblevaluesareasfollows:
Option Code
Description
001
Autovoiceon(default)
002
Autovoiceoff.
Note:Ifthecardholderselectsavoiceguidedsession,thisoptionis
ignoredandautovoicemessagesarenotplayedduringthesession.
Option03DateFormat
Thisparametersetsthedateformat.Valuesareasfollows:
7
Table 7-42
Option 03: Date Formats
Option04RollWidth
Option05LeftPrint
Column
Option Code
Description
001
MMDDYY(default)
002
DDMMYY
003
Notsupported
004
Notsupported
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.
7-7
Option07Track1
Format
Thisparametersetsthemethodofextractingthenameandtitle
fromTrack1dataonthecard.Possiblevaluesareasfollows:
7
Table 7-43
Option 07: Track 1 Format Values
Option12Specific
CommandReject
Description
001
ISOformat(default)
002
VISAformat
003
Autosearchbackwards
004
Autosearchforwards.
ThisparameterdetermineswhethertheSSTtransmitsSpecific
CommandRejectoptions.Possiblevaluesareasfollows:
7
Table 7-44
Option 12: Specific Command Reject
Values
Option15Transaction
StatusInformation
Option Code
Table 7-45
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.
7-8
Note:Ifoptions16and17arebothnonzero,whicheverlimitis
reachedfirstwillbeexecuted.
Option23Envelope
DispenserStatus
Thisoptiondetermineswhetherenvelopedispenserstatus
messagesaresent.Possiblevaluesareasfollows:
7
Table 7-46
Option 23: Envelope Dispenser Status
Values
Option24Enhanced/TI
SensorStatusUnsolicited
Message
Table 7-47
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
andSensorStatusDataonpage949.
7-9
Option25Media
Entry/ExitIndicatorsFlash
Rate
ThisparametersetstheflashratefortheMediaEntry/Exit
Indicators.Theflashratecanrangefrom4.0Hztocontinuouslyon
asfollows:
Table 7-48
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-49
Option 27: Remote Relay
Option30IncludePAN
inDCSData
Table 7-50
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
7-10
(active/inactive)inthecardholderdisplaysensor.Thepossible
valuesareasfollows:
Table 7-51
Option 32: Unsolicited Reporting Control
Option33Simulate
SupervisorMode
Entry/Exit
Table 7-53
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-52
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.
ThisoptiondefinestherangeoftheMessageCoordinationNumber
(MCN)andwhetherTransactionRepliesandInteractive
TransactionResponses(ITRs)arerejectedorignored.Theoption
consistsofabitfieldcombinedfromthefollowingvalues:
Bit
Description
DefinestheMCNrange
0=31Hto3FH(default)
1=31Hto7EH
Reservedandmustbe0
7-11
Bit
Description
DefinesTransactionReplyandITRhandling
0=rejectanymessagewithanincorrectMCN(the
default).
1=ignoreanymessagewithanincorrectMCN
Reservedandmustbe0
Reservedandmustbe0
Reservedandmustbe0
Reservedandmustbe0
Reservedandmustbe0
ExampleValuesforMCN
ThefollowingtableshowsthevaluesfortheMCNRangeoption:
Table 754
Option 34: MCN Range Option Code

Examples
Option Code
Description
000
Rangeis31Hto3FH;rejecttheTransactionReplyorITRif
itsMCNdoesnotmatchtheMCNinthelasttransmitted
TransactionRequestorisnot0
002
Rangeis31Hto7EH;rejecttheTransactionReplyorITRif
itsMCNdoesnotmatchtheMCNinthelasttransmitted
TransactionRequestorisnot0
004
Rangeis31Hto3FH;ignoreTransactionRepliesandITRs
withincorrectMCNs
005
Rangeis31Hto7EH;ignoreTransactionRepliesandITRs
withincorrectMCNs
FormoreinformationabouttheMCNinTransactionRequestsand
InteractiveTransactionResponses,seethefollowing:
Fieldgonpage93ofChapter 9,TerminaltoCentral
Messages
MessageCoordinationNumber(MCN)onpage1087of
Chapter 10,CentraltoTerminalMessages.
7-12
Option35ReportDual
ModeEJ&HardcopyB/U
UnsolicitedMessages
ThisoptioncontrolsthereportingtoCentralofunsoliciteddevice
statusmessagesfordualmodeEJandhardcopybackup.Possible
valuesareasfollows:
7
Table 7-55
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)onpage9101.
Option36EnhancedEJ
Backup
ThisoptiondetermineswhethermultipleorstandardEJbackups
areallowed.Possiblevaluesareasfollows:
7
Table 7-56
Option 36: Enhanced EJ Backup Values
Option Code
Description
000
AllowstandardEJbackup(default)
001
AllowmultipleEJbackup.
Note:Changestooption36canbedisabledthroughSupervisor.
Forfurtherinformation,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
Option37PrintTrack2
toJournal
Table 7-57
Option 37: Print Track 2 to Journal
Thisoptiondetermineswhetherthefirst22charactersofdatafrom
cardtrack2areautomaticallyjournaledwhenacardisread.
Possiblevaluesareasfollows:
Option Code
Description
000
Donotprintdataonthejournal(default)
001
Printdataonthejournal
Theprintformatisdefinedusingreservedscreent15,andbydefault
isasfollows:
CARD: ;XXXXXXXXXXXX1251=09
DATE DD-MM-YY TIME HH:MM:SS
7-13
Option41SendTrack
DetailsonCardRetract
Thisoptiondetermineswhetherdatafromthecardisincludedin
CardReader/Writerstatusmessagessentfollowingacardretract
operation.Possiblevaluesareasfollows:
Table 7-58
Option 41: Send Track Details on Card
Retract
Option Code
Description
000
Donotincludecarddatainmessage(default)
001
IncludealldatareadfromthecardinaCard
Reader/Writerstatusmessagefollowingacardretract
operation
Note:Thehostmaybeunabletoassociatethecapturedcardwitha
transactionifEMVExitsareconfiguredtosendthetrack2
equivalentdatainthestandardtrack2buffer.Thisisbecausethe
datasentintheTransactionRequestcoulddifferfromthedatain
theCardReader/Writerstatusmessage.
Option44BNAJournal
NotesCount
IfaBunchNoteAcceptor(BNA)ispresent,thisoptiondetermines
whethervaultedandrefundednotecountsareautomatically
printedtothejournalprinterfollowingatransactionreply.
NCRrecommendsthatyousetthisoptionifimplementingtheECB
6regulations.Ifthisoptionisnotsetandnotesarerecategorised
duringsecondbillvalidation,ECB6countsmaybeomittedfrom
thejournal.
Table 7-59
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
7-14
Extendedmessageformatoption
Note:WhenCentralsendsaterminalcommandtocheckthe
suppliesandfitnessofthedevice,forexample,onexitfrom
Supervisor,theresponsecanbeusedtotracktheinsertionand
removalofcassetteswhenextendedmessagesareenabled.
Suppliesreportingwhenbit3isnotset
Recyclingoptionconfiguration.
Duetothecomplexityandnumberofsettingscontrolledbythis
parameter,informationisprovidedonthebitsettingsratherthan
theavailableoptioncodes.Theoptioncodeisadecimalvalueof
between000and255.Eachbitcanbesetasdescribedinthe
followingtable:
Table 7-60
Option 45: BNA Settings Bit Values
Bit Number
Description
InclusionofBNAlasttransactionstatuscountsinthe
TransactionRequestmessagesenttoCentral
Validvaluesare:
0Donotincludetransactionstatuscounts
1Includetransactionstatuscounts
Numberofnotestoaccept
Thismustbesetifbit3orbit6issetorifdirectdepositis
configured
Validvaluesare:
0Acceptupto90notes
1Acceptmorethan90notes
Note:IftheSSTisconfiguredfordirectdepositmodeor
ECB6isenabled,youmustsetthenumberofnotesthat
canbeacceptedtomorethan90(EnhancedConfiguration
option45).
Retractoptionconfiguration
Validvaluesare:
0Donotretractnotes
1Retractnotes
7-15
Bit Number
Description
Extendedmessageformatoption
Bit1mustbesetifthisisset
Thismustbesetifbit6isset
Bit4isignoredifthisisset
Validvaluesare:
0Donotuseextendedmessageformat
1Useextendedmessageformat
Fordetailsoftheaffectedmessages,seethefollowing:
SuppliesDataonpage945
FitnessDataonpage948
ExtendedSendSupplyCountersonpage961
NoteAcceptor(Solicited/Unsolicited)onpage9113
Suppliesreportingwhenbit3isnotset
Bit3mustnotbesetifthisisset
Validvaluesare:
0Reportwhenfirstcassetteisfulloralmostfull
1Reportwhenallcashincassettesarefull
Whichevervalueisused,aretractbinisreportedwhenfull
oralmostfull.
EnhancedCashDepositMode
NotsupportedbyAdvanceNDC
Recyclingoptionconfiguration
Bit3mustbesetifthisisset
Value0:
Donotuserecyclingcassettesduringdeposit
transactions
DonotreportNDCcassettestypesthathaveaccepted
notesduringthelastdeposit
Value1:
Userecyclingcassettesduringdeposittransactions
ReportNDCcassettetypesthathaveacceptednotes
duringthelastdeposit
7-16
Thefollowingtableprovidessomeexampleoptioncodes:
Table 7-61
Example Option 45: BNA Settings Values
Option46MCRW
EnhancedCardDevice
SecurityJitter
Description
000
Donotincludelasttransactionstatuscounts
Acceptupto90notes
Donotretractnotes
Donotuseextendedmessageformat
Reportwhenfirstcassetteisfullornearlyfull
(default)
015
Includelasttransactionstatuscounts
Acceptmorethan90notes
Retractnotes
Useextendedmessageformat
Ignorenotereportsettings
023
Includelasttransactionstatuscounts
Retractnotes
Donotuseextendedmessageformat
Reportwhenoneretractbinorallcashincassettesarefull
ornearlyfull
074
Donotincludelasttransactionstatuscounts
Donotretractnotes
Useextendedmessageformat
Ignorenotereportsettings
Userecyclingcassettes
IftheEnhancedCardDevice(ECD)ispresent,thisparametersets
thelevelofECDJittertobeappliedduringcardentry/exit.The
defaultvalueis000.
7
Note:Arebootisrequiredifthisparameterischanged,toallowthe
newsettingtotakeeffectatdevicelevel.
Table 7-62
Option 46: MCRW Enhanced Card Device
Security Jitter Values
Option48Barcode
Reader
Option Code
Option Code
Description
000
NoECDJitter,orECDJitternotrequired(default)
001
StandardECDJitter
002
MaximumECDJitter(butslowercardread/write).
Ifthebarcodereaderispresent,thisoptiondefineswhetherthe
barcodereaderspecificfieldsareincludedinthemessagessentto
thehost.
7-17
Table 7-63
Option 48: Barcode Reader Values
Option69EMVSmart
CardExtendedStatus
Option70EMVSmart
Card
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
Table 7-64
Option 71: Time-Out State Entry
Option74Destinationfor
CashDepositRetract
ThisoptioncontrolsentrytotheTimeOutstateandhowmany
timestheTimeOutstatecanbeenteredforeachcardholderaction.
Oncethespecifiedlimitisreached,thetimeoutactionisperformed.
Option Code
Description
000
TheTimeOutstateisneverentered(themoretime
screenisneverdisplayed)
001to009
TheTimeOutstatecanbeentereduptothespecified
numberoftimes
255
ThenumberoftimestheTimeOutstatecanbeentered
isunlimited(default)
Thisoptionspecifiesthedestinationfornotesretractedduringa
cashdeposittransactionasfollows:
Table 7-65
Option 74: Destination Values for
Retracted Notes During Cash Deposit
Option Code
Description
000
Retractthenotestoaretractbin(default)
001
Retractthenotestothecashincassettedefinedbythe
serviceprovidersettings.
7-18
Option76CashHandlers
Table 7-66
Option 76: Cash Handlers
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.
Note:Asincreasedcashhandlercapacityhasbeenimplemented
withouthostimpact,thehostcannotselectthecashdispensertobe
usedfordispensingcash.
Option77NextState
Number
WhenAdvanceNDCisinstalled,thenextstatenumberisnotset
andcardlesstransactionsaredisabled.Thenextstatenumbercanbe
downloadedremotelyusingthisoptionorsetlocallythroughthe
ConfiguremenuinSupervisor.
IftheSSTiscapableofacceptingcardlesstransactionsandoption77
isused,downloadingavalidNextStateNumberenablescardless
transactionanddefinesthenextstatetogotofromtheinitialCard
Readstateforcardlesstransactions.Anychangetothenextstate
numberiseffectiveimmediatelyandtheSSTdoesnotneedtobe
restarted.
Ifthenextstatenumberissetto000,cardlesstransactionsare
disabled.
Note:Keymasksmustbeconfiguredforcardlesstransactions.For
detailsoftheconfigurationrequired,refertotheCardless
TransactionssectioninChapter5,ConfiguringAdvanceNDC
7-19
andAssociatedComponentsintheAPTRAAdvanceNDC
DevelopersGuide.
Table 7-67
Option 77: Next State Number Values
Option78GBRU
MStatusReporting
Option Code
Description
000
Cardlesstransactionsnotallowed(default)
001254or
256999
StatenumbertogotofromtheCardReadstatewhen
cardlesstransactionsareenabledandwhenEnhanced
ConfigurationParameteroption80issetto0
001254or
256ZZZ
StatenumbertogotofromtheCardReadstatewhen
cardlesstransactionsareenabledandEnhanced
ConfigurationParameteroption80issetto1
ThisoptioncontrolsthereportingoftheMStatusforaGBRUused
asadispenserinthefollowingcases:
7
Inastatusmessage,allfieldsarethesameasforafourcassette
stackingdispenser(standardcashhandler),withthepossible
exceptionoftheMStatus.Fordetails,seeGBRUtoCDM
MStatusMappingonpage975
InresponsetoaTerminalCommand,allfieldsarethesameasa
standardcashhandler.
Note:TheMDataisalwaysGBRUspecificregardlessofthesetting
ofthisoption.
Table 7-68
Option 78: GBRU M-Status Reporting
Option Code
Description
000
ReportaCDMMStatus.
001
ReportaGBRUMStatus.
7-20
Option79Coin
Dispenser
Table 769
Thisoptionallowsthemodificationofthemessageformatto
supportuptoeightcoinhoppertypes.Possiblevaluesareas
follows:
Option Code
Description
000
Coindispensersupportsfourcoinhoppertypesusing
NDC+compatiblemessageformats(default)
001
Coindispensercansupportmorethanfourhopper
typesusingextendedmessageformats.AdvanceNDC
supportsuptoeighthoppertypes
Option 79: Coin Dispenser
Option80Alphanumeric
StateEntry
Thisoptioncontrolswhichnumbersystemisusedtointerpretstate
numberfields.Possiblevaluesareasfollows:
Table 7-70
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
Table 7-71
Option 83: Cheque Processor
Thisoptionallowsthemodificationofthemessageformatto
supportthereportingofbinsinthechequeprocessorandfurther
supportforbunchchequeacceptors.Possiblevaluesareasfollows:
Option Code
Description
000
Chequeprocessorsupportsthereportingofthreebins
usingNDC+compatiblemessageformats(default)
7-21
TimerNumberFieldk
NumberofSecondsper
TimerFieldFieldl
Option Code
Description
001
Chequeprocessorsupportsthereportingofallbinsthat
arepresent,usingtheextendedmessageformat.
Atleastthreebinsarereportedforachequeprocessor.
Thenumberofbinsreporteddependsonthehardware
configuration.
002
Onbunchchequeacceptorsonly,inadditiontothe
informationreportedbyOptionCode001,thedevice
statusmessagealsoincludesthelocationofthe
depositedcheques.
004
Scanschequesafterendorsementwhensupportedby
thehardware.
Thebackofthechequeisscanned
Ifarearimagewasrequestedwhenthechequewas
accepted,theimagefromthescanafterendorsement
replacesthisimage
Ifthechequeisnotendorsed,theimageisnotscanned
ThetimersarethesameasthoseincludedintheConfiguration
ParametersLoadmessage.Fordetails,seeTimerNumber(Field
p)onpage73.
Thisparametersetsthetimeoutvalueinsecondsforthetimer
numberspecifiedinfieldk.Themaximumnumberofsecondsis
255.
ForadescriptionofthefieldintheEnhancedConfiguration
ParametersLoadmessage,seepage1017.
Table 7-72
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
7-22
21
Opticalsensor
22
Journalprinterbackuplogtamper
26
Touchscreenerrorreporting
28
TransactionprocessingapplicationinformedofSM
activity
31
Enableaudibleechoofkeyboard
39
MCRWnonmagneticcardaccept
7-23
Timers
Timers
Thesametimersareavailableinbothconfigurationloadmessages
andenhancedconfigurationloadmessages.
TimeUnitsforTimers
TimerDescriptions
Whenaconfigurationloadmessageissent,thetimervaluesarein
ticks.Atickis800milliseconds.Whenanenhancedconfiguration
messageissent,thevaluesareinseconds.Avalueof30ticksina
configurationloadmessageistheequivalentof24secondsinan
enhancedconfigurationloadmessage.Thevaluesaregivenin
secondsinbothconfigurationloadandenhancedconfigurationload
messages,unlessotherwisestated.
Timersthatarereservedforfutureuseorcurrentlyunsupportedin
AdvanceNDCareallmarkedasreservedinthemessageformat.
Fordetailsofthesetimers,seepage729.
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.
7-24
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
timeoutmessageisjournaled,(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.
7-25
Timers
Timer06
Communicationsconnectionsampleinterval.Thistimerdefinesthe
sampleintervalusedbytheapplicationtomonitorthe
communicationsconnection.Thistimerisnotusedinadialup
environment.Itsdefaultvalueis204seconds.
Note:ForTCP/IPcommunications,youcanreducethisinterval(for
example,to1second)asthetimeittakesfortheTCP/IP
communicationstodetectlossofaconnectioncanbecontrolledvia
theSupervisorTCP/IPConfigurationmenu.Formoreinformation,
Timer07*
Presenttimeout.Thistimerisstartedwhencashhasbeen
dispensedandtheTransactionReplyscreenTakeCashis
displayed.Whenthetimerexpires,thenextstatespecifiedinthe
TransactionReplycommandisentered.Atimeoutintervalofzero
isnotpermitted.Thedefaultvalueis24seconds.
Note1:ThistimerisnotusedforParallelDispense/PrintandEject
transactionsonanSSTconfiguredtostopcashretract.
Note2:Timer07iscombinedwithtimer05inthefollowing:
ParallelEject/DispenseandPrintFastCash
(seeTable 1023onpage 1071)
CardBeforeParallelDispenseandPrint
Thetimerisstartedafternotesaretakeninthefollowing:
DispenseandPrint
CardBeforeCash
(seeTable 1022onpage 1070).
Note3:Incardbeforecashtransactionswhenthenoretractoption
isset,therecommendedminimumvalueofthistimeris5.
Timer08*
Nightsafedeposittimeout.Thistimerisstartedwhenthenight
safedoorisunlockedtoacceptanightsafedeposit.Ifnobagis
detectedandthistimerexpires,theSSTentersthetimeoutstate.If
thebagdetectionmechanismisfaulty,thistimeoutisallowedto
expireinordertogivethecardholdertimetoperformadeposit.
However,theTimeOutstateisnotentered.
7-26
Timers
Timer09*
Cardholdertimeoutintervalbeforecardcaptureattempt.Ifthe
cardispresentedtothecardholderandnotremovedwithinthis
timeperiod,anattemptismadetocapturethecard.Toreducethe
possibilityofacardnotbeingcompletelyejectedatthefirstattempt,
thecardisreejectedafterhalfthetimervaluehasexpired,and
capturedatthefulltimerexpiry.Thedefaultvaluefortimer09is24
seconds.Atimeoutintervalofzeroisnotpermitted.
Timer10
Additionalpresenttimeout.Thistimer,ifconfigured,isaddedto
Timer07toallowanadditionaltimeoutinthefollowingfunctions:
DispenseandPrint.Fordetails,seeDispenseandPrint
(FunctionID2or8)onpage 1067
DisplayandPrint.Fordetails,seeDisplayandPrint(Function
ID3or9)onpage 1068.
Ifatimeoutintervalofzeroisconfigured,Timer07isnotaffected.
Timer60
EJacknowledgementtimer.ThisisusedintheEJOptionsand
Timerscommand(describedinEJOptionsandTimers.onpage
1091)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.
7-27
Timers
Timer68
StatementMEIdurationtimer.ThelengthoftimetheMEIflashes
afterthestatementispresentedtothecardholder.TheMEIstartsto
flashassoonasthedatastartstoprint;thatis,totalMEIflashing
duration=printingduration+cutandejectduration+timer68.The
defaultvaluefortimer68is2seconds;therangeis210.
Timer69
ReceiptMEIdurationtimer.ThelengthoftimetheMEIflashesafter
thereceiptispresentedtothecardholder.TheMEIstartstoflashas
soonasthedatastartstoprint;thatis,TotalMEIflashingduration=
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
7-28
Timers
minimumtimeoutvalueis1second,thedefaultis24andthe
maximumis255.
Timer92
Faultdisplaytimeout.Thistimerdefinestheamountoftimefor
whicheachfaultmessageisdisplayed.Theminimumtimeout
valueis1second,themaximumis255andthedefaultis4(5ticks).
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.
ReservedTimers
Thefollowingtimersarereservedforfutureuse:
7
1159
62
6467
7071
7376
7981
8486
8890
93
7-29
Timers
9899
UnsupportedTimers
Thefollowingtimersareforfunctionsthatarenotsupportedin
AdvanceNDC:
82Cameradelayperiod(seeNote:)
83DigitalCameraService(DCS)fileexpirytimeout(seeNote:)
91EJloginspectiontimeout
97Dooraccessopentimeout.
Note:Forthesecuritycamera,AdvanceNDCusesanXML
configurationfiletocontrolthenumberofimages,whentheyareto
betakenandthestoragecapacitytobeusedforthem.Fordetails,
refertoChapter5,ConfiguringAdvanceNDCandSupport
ApplicationsintheAPTRAAdvanceNDC,DevelopersGuide.
7-30
Table of Contents
Financial Institution Tables
Chapter 8
Overview
81
FITData
FITFields
.PIDDX(InstitutionIDIndex)
PFIID(InstitutionID)
PSTDX(IndirectNextStateIndex)
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
86
87
87
88
88
89
89
89
89
811
811
811
LinkedFITs
812
Table of Contents

Overview
Overview
TheFinancialInstitutionTable(FIT)isanimportantpartofthe
customisationdataforanAdvanceNDCsystem.FITsmayalsobe
downloadedtotheterminalbyamessagefromCentral.TheFIT
containsspecificinformationabouthowaparticularinstitutions
transactionsshouldbeprocessed.
TheSSTmusthaveaFITforeveryinstitutionthatitsupports.
InstitutionsthathavemorethanonetypeofcardmusthaveaFIT
foreachcardtype.
Whenacardisread,theFITissearchedtofindtheFITentrywhich
matchestheFinancialInstitutionIdentificationnumber(FIID)on
thecard.ParametersinthisFITentryandfollowinglinkedFITsare
thenusedforallsubsequentPINandtransactionprocessing.
ThischapterdescribestheFITdataandlinkedFITs.Fordetailsof
theFITmessageformat,seeFITDataLoadonpage 1022.
8-1

FIT Data
FITData
EachFITcontainsthefieldsdescribedhere,andeachfielddefaults
tozeroifnotspecified.Somefieldsholdinformationonhow
transactionswillbeprocessedforthatinstitution.Otherfields
containanoffsettowhereinformationrequiredfortransaction
processingisstoredonthecard.
EachentryintheFITDataloadmessagehasavalueintherange
00FFhexadecimal(hex),andforthepurposesofthisdescriptionis
consideredastwodigits,eachhavingpossiblevaluesintherange
0Fhex.However,theFITdataissenttotheterminalindecimal,so
toconstructtheFITDataloadmessageyouconverteachdigitpair
fromhextodecimaltoproduceathreecharacterstringintherange
000255.
FordetailsoftheFITmessageformat,seeFITDataLoadon
page 1022.
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
NotsupportedaslocalDieboldPINverification
isnotsupported.
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
8-2

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
Notsupported
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
SomeofthefieldsintheFITarenotsupportedandthisisindicated
inthefollowingtext.Thesefieldsareignored
8-3

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/Bank
IDIndex)
TheuseofthisfielddependsonthetypeofPINverificationusedfor
thisFinancialInstitution,asfollows:.
DESverificationthefieldisnotusedandmustbezero.
DieboldverificationthefieldgivestheoffsetoftheAlgorithm
Numberonthecard.Therangeis007Fhex.Ifthevalueinthe
fieldisFFhex,theAlgorithmNumberisnotonthecard,butis
thePANPDfieldcontent,whichisnotsupportedaslocal
DieboldPINverificationisnotsupported.
PMXPN(MaximumPINDigitsEntered)
Thisfieldisatwodigitnumberthatspecifiesthemaximumnumber
ofdigitsthecardholdercanenterashispersonalidentification
number(PIN).Therangeis0410hex.
8-4

FIT Data
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(NotsupportedinAdvanceNDC)
011,100,101,110,111Reserved
ForLocalVISAPINverification(highorder3bits001),thelower
fivebitfieldspecifiesthenumberofenteredPINdigitstocheck.It
mustbeintherange0410hexandlessthanorequaltoPMXPN.
Thevaluealsospecifiesthelengthoftheoffsetnumber.ForDESPIN
verification(highorder3bits000),thelowerfivebitfieldspecifiesif
localorremoteverificationistobeperformed,andthenumberof
enteredPINdigitstocheck.Localverificationisperformedwhen
thelowerfivebitfieldisnonzero,inwhichcaseitmustbeinthe
range0410hexandlessthanorequaltoPMXPN.Thevaluealso
specifiesthelengthoftheoffsetnumber.IfPCKLNiszero,remote
8-5

FIT Data
DESPINverificationisperformedandtheonlysignificantFIT
entriesarea,b,c,e,g,nando.
PINPD(PINPad)
ThisfieldappliesonlytofinancialinstitutionsthatuseDES
encryptionforremoteverification.Thefieldcontainstwodigits,and
therangeis00CFhex.
Thefirstdigitspecifiesthemethodofencryption,theencryption
keyandwhetherthemessagecoordinationnumbershouldbe
includedinthePINblock.
TheseconddigitisthedigitusedtopadthePIN.
Thefirstdigitisbinaryencoded.Thesignificanceofeachbitisas
follows:
Table 8-3
PINPD Bit Encoding Significance
Table 8-4
PINPD First Digit Coding
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.
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.
8-6

FIT Data
First Digit
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.
PANLN(PANDataLength)
Thisfieldspecifiesthenumberofdigitsfromtheoffset,specifiedby
PANDX,thattheterminalwilluseinPINverification.The
permittedvaluedependsonthetypeofPINverificationbeingused:
DEStwodigitsintherange0010hex
VISAtwodigitswithvalues0Dor10hex
PANLNmustbeequaltoorgreaterthanthePINchecklength
specifiedinPCKLN.IfPANLNis1Fhex,allthedigitsofthePAN
areused,startingfromtheoffsetpositiongivenbyPANDXtothe
fieldseparatorfollowingthePAN.
8-7

FIT Data
WhenremotePINverificationisused,thetopthreebitsofthisfield
canbeusedtospecifyiflocalPINcheckingisperformedonashort
PINentry.Ifthevalueofthetopthreebitsequalszeroorisgreater
thanthemaximumPINentrylength,PMXPN,orifPANLNequals
FFhex,nolocalPINcheckingtakesplace.TosupportsecurePIN
encryption,acheckfortheminimumfourdigitsisalways
performedlocally,regardlessofthePANLNsetting.Fordetails.see
Chapter 2,StateTables.
Ifthevalueofthetopthreebitsisnotequaltozeroandislessthan
orequaltothemaximumPINentrylength,PMXPN,localPIN
checkingtakesplace.IfthePINislessthanspecified,alocalPIN
entryerrorisindicated.Fordetails,seeBPINEntryStateon
page 212.
PANPD(PANPad)
Thisisatwodigitfield.TheusedependsonthetypeofPIN
verificationused.
DES Digit1specifieswhethertheencryptionprocessusesthe
MasterkeyorthePEKEYentryintheFITforPINverification.This
digitmustbe0or8:
0usethePEKEYforencryption
8usetheMasterkeyforencryption.
TherangeofPANPDis000Fhexand808Fhex.PANPDonly
appliestolocalPINverification.
Digit2isthedigitusedtopadthePAN.Thismustbethesameas
theonespecifiedinPINPDforencryptingPINs.
VISA
Notused.
PRCNT(Track3PIN)
ThisfieldgivestheoffsetforthePINretrycountfieldonthecard.
ThePINretrycountfieldisatwodigitfield,withvaluesinthe
range007Ehex.
Therearetwodifferentmethodsofcountingretries:
ISOeachtryisdecrementedfromaninitialvalue,untilthe
valuereacheszero.Ifthismethodisused,80hexisaddedtothe
number.
MINTSeachtryincrementsavalueuntilitreachestheretry
value.
TherangeofPRCNTis007EhexforMINTSand80FEhexforISO.
IfyouusetheEnhancedPINEntrystate,butdonotrequireTrack3
retries,thisfieldshouldcontainavalueofFFhex.
8-8

FIT Data
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.
PINDX(IndexReferencePoint)
Thissixdigitfieldisthekeytostartingpointsforalloftheother
cardfieldsreferencedintheFITPIDDX,PAGDX,PANDX,
POFDX,PLNDX,andPRCNT.
PIDDXlocatestheFinancialInstitutionIdentificationNumber
PAGDXlocatestheAlgorithmNumber/BankID.Notsupported
aslocalDieboldPINverificationisnotsupported.
PANDXlocatesthePAN
POFDXlocatesthePINOffsetData
PLNDXlocatestheLanguageCode
PRCNTlocatesthePINRetryCount.
PINDXidentifiesthetrack,thestartingpointandthedirectionto
countintofindthedata.PAGDXandtheotherfieldsidentifyhow
fartocounttothebeginningofthedata.
IfthevalueofPIDDXisgreaterthanorequalto80hex,thePINDX
valueisignoredandallindexreferencingiscarriedoutontrack3in
aforwarddirectionfromthestartsentinel.
8-9

FIT Data
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
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)
NotsupportedaslocalDieboldPIN
verificationisnotsupported
PIDDX
FinancialInstitutionIDnumber
PRCNT
PINretrycount
PANDX
PAN
PLNDX
Languagecode
POFDX
PINoffsetdata
8-10

FIT Data
PLNDX(LanguageCodeIndex)
Thefieldgivestheoffsetforthelanguagecodeonthecard.This
fieldcanbeusedinconjunctionwithaLanguageSelectFromCard
statetosetthescreengroupthatshouldbedisplayed.Theterminal
usesthelanguagecodetodisplaymultilanguagescreensduringa
transaction.
PLNDXisintherange017Fhex.Avalueof00hexisnotallowedif
thelanguagecodeisused.Avalueof7Fhexmeanszeroifthe
languagecodeisusedandthesearchisbackwardsfromanend
sentinelonly.
PMMSR(MMSensorFlag)
ThefielddescribesMMsensorwithCIM86MCRWusage.
TheCIM86MCRWisnotsupported.
ThisfieldspecifiestheformatofthePINblocktobegeneratedfor
remotePINverification,asfollows:
0Dieboldwithoutcoordinationnumber.
1Dieboldwithcoordinationnumber.Notsupported
2ISOformat0(ANSI)
3ISOformat1
4ISOformat3
5BANKSYS.
ThisfieldisusedonlywhenselectedbyPMXPNhavingbit7=0
andbit6=1.
8-11

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.Theindirectnextstateindexisobtainedfromthe
currentlyactiveFIT,whichmeansthatitcanbeobtainedfroma
linkedFITiftheFITSwitchstatefollowsaPINEntrystate.
8-12
Table of Contents
Terminal to Central Messages
Chapter 9
Overview
91
TransactionRequestMessages
TransactionRequestMessageFormat
SSTReplytoInteractiveTransactionResponse
92
92
919
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
ExampleMessageAnalysis
ExtendedSendSupplyCounters
SendTallyInformation
SendErrorLogInformation
SendDate/TimeInformation
SendConfigurationID
920
920
920
920
922
922
923
924
925
929
930
931
934
941
943
945
948
949
952
952
953
953
955
956
959
961
968
969
970
971
Table of Contents
SolicitedDeviceFaultStatus
DeviceFaultStatusResponses
DeviceFaultStatusInformationField
GBRUtoCDMMStatusMapping
972
972
973
975
OtherSolicitedMessages
EncryptorInitialisationData
UploadEJDataMessage
976
976
981
ConditionsforSendingUnsolicitedMessages
UnsolicitedStatusInformationField
984
984
985
DeviceStatusInformation
TimeOfDayClock(Unsolicited)
PowerFailure(Unsolicited)
CardReader/Writer(Solicited/Unsolicited)
CashHandler(Solicited/Unsolicited)
CassetteReenabledDuringDepositTransactions
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)
CountsinECB6UnsolicitedMessages
EnvelopeDispenser(Unsolicited)
ChequeProcessor(Solicited/Unsolicited)
CoinDispenser(Solicited/Unsolicited)
BarcodeReader(Unsolicited)
987
987
987
988
990
994
995
996
997
999
9102
9103
9104
9105
9107
9108
9110
9110
9112
9113
9114
9120
9121
9125
9127

Overview
Overview
Thischapterdescribesthemessagessentfromtheterminalto
Central,asfollows:
Transactionrequestmessages
Solicitedstatusmessages,includingencryptorinitialisationand
EJuploaddata
Unsolicitedstatusmessages
Statusinformationaboutdevicesanddevicefaults
Note:ForanydifferencesonothervendorsSSTs,refertothe
APTRAAdvanceNDC,MultiVendorSupportReferenceManual.
9-1

Transaction Request Messages
TransactionRequestMessages
TransactionRequestmessagesaresentfromtheSSTandcontainthe
datathatCentralrequirestoauthoriseaconsumertransactionatthe
SST.Themessageissentduringaconsumertransaction,eitheron
entrytotheTransactionRequeststateoraspartofanInteractive
Transactionmessagesequence.
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
transmittedtotheSSTinaConfigurationParametersLoadmessage.The
defaultvalueis000.Ifthedatasecurityfeatureisconfigured,an
additionalsixcharactersarepresentwhichcontainthemachinenumber.
FS
FieldSeparator
FS
FieldSeparator
SeeTableNote3
TimeVariantNumber.Thisfieldcancontainaneightdigitnumber
derivedfromthetimeofdaybytheSSTforeachtransactionrequest.The
digitscancontainthecharacters09,AF.
FS
FieldSeparator
TopofReceiptTransactionFlag.InformsCentralifreceiptdataforthis
transactionwillprintatthetopofthereceiptasfollows:
0willnotprintdataforthistransactionatthetopofthereceipt
1willprintdataforthistransactionatthetopofthereceipt.
9-2

Field
Number of
Characters
Mandatory/Optional
Description
MessageCoordinationNumber.ContainsacharacterassignedbytheSST
toeachTransactionRequestmessage.TheSSTassignsadifferent
coordinationnumbertoeachsuccessiveTransactionRequestona
rotatingbasis.Thevalidrangeofthecoordinationnumberis31hexto3F
hex,orifEnhancedConfigurationParameteroption34(MCNRange)is
setto001,from31hexto7Ehex.Centralmustincludethecorresponding
coordinationnumberwhenrespondingwithaTransactionReply
commandandcanoptionallyincludeitinanInteractiveTransaction
Response.
ThisensuresthattheTransactionReplyorInteractiveTransaction
Response(TREP/ITR)correspondstotheTransactionRequest.Ifthe
coordinationnumbersdonotmatch,bydefaulttheSSTsendsasolicited
statusmessagewithaCommandRejectstatus.
CentralcanoverridethisverificationbysendingaMessageCoordination
Numberof0inaTREP/ITR.ThentheSSTwillnotverifythatthe
coordinationnumbermatchestheonesentinthelastTransaction
Requestmessage.
Option34canalsobesetsuchthattheTREP/ITRisnotrejectedwhenthe
coordinationnumberdoesnotmatch.Instead,themessageisignored
andtheSSTcontinueswaitingforaTREP/ITRwiththecorrect
coordinationnumber.IfthemessagefromCentralisignored,the
responsetimerisresetasifaCommandRejecthadbeensent.
FS
FieldSeparator
Var(39)
SeeTableNote1
Track2Data.Containsupto39charactersofTrack2datafromthestart
sentineltotheendsentinelinclusive.Charactersareintherange303F
hex.
FS
FieldSeparator
Var
(106)
SeeTableNote1
sentineltotheendsentinelinclusive.Charactersareintherange303F
hex.
FS
FieldSeparator
SeeTableNote1
OperationCodeData.ContainsthedatacollectedintheOperationCode
bufferasaresultoffunctiondisplaykeyspressed.StatesDPreSet
OperationCodeBufferState,EFourFDKSelectionFunctionState
andYEightFDKSelectionFunctionStatedeterminethecontentsof
thisfield,whichidentifiesthetransactionselectedbythecardholder.
FS
FieldSeparator
9-3

Field
Number of
Characters
Mandatory/Optional
Description
8or12
See
TableNote1
TableNote4
AmountEntryField.Identifiestheamountentrymadeatthekeyboard.
ThecontentofthisfieldisdeterminedbytheAmountEntry,Enhanced
AmountEntryandNoteMixSelectionstates.Thedataisrightjustified
withleadingzerostotheleft.Thisfield,ifrequestedinthetransaction
requeststate,iseithereightortwelvebyteslong.Itwillbezerofilledif
noamountentryhasbeenmadesincethelastCardReadstatewas
executed.ThelengthisselectedintheConfigurationParametersLoad
messageortheEnhancedConfigurationParametersLoadmessage.
FS
FieldSeparator
Var(32)
SeeTableNote1
PINBuffer(BufferA).Containsa16characterPIN,encryptedas
specifiedintheFIT,forremotePINverification.
FS
FieldSeparator
Var(32)
SeeTableNote1
GeneralPurposeBufferB.Containsthekeyboarddataenteredduringthe
InformationEntrystate,orafterreceivinganInteractiveTransaction
Response.ThelastcharacterinthisbufferisagraphicTiftheSSTtimes
outwaitingforthecardholdertorespond(usingthekeyboard)toan
InteractiveTransactionResponse,oragraphicEifthecardholder
pressestheCancelkey.Minimumdatalengthis3characters.Maximum
datalengthis32characters.
MaycontainanamountvalueenteredduringtheEnhancedAmount
Entrystate.Inthiscase,thebufferlengthwillbethesameastheAmount
EntryField.
MaycontainanamountvalueoranotemixspecifiedduringtheNote
MixSelectionstate.
FS
FieldSeparator
Var(32)
SeeTableNote1
GeneralPurposeBufferC.Containskeyboarddataasspecifiedbythe
InformationEntrystate.Datalengthcannotexceed32characters.
MaycontainanamountvalueenteredduringtheEnhancedAmount
Entrystate.Inthiscase,thebufferlengthwillbethesameastheAmount
EntryField.
MaycontainanamountvalueoranotemixspecifiedduringtheNote
MixSelectionstate.
FS
See
TableNote2
TableNote9
FieldSeparator
Track1Identifier.IdentifiesdatainthenextfieldasTrack1data:
1Track1data.
Var(78)
sentineltotheendsentinelinclusive.Thecharacterrangeis205Fhex.
9-4

Field
Number of
Characters
FS
Mandatory/Optional
Description
See
TableNote5&
TableNote9
FieldSeparator
SeeTableNote5
TransactionStatusDataIdentifier.Identifiesthedatathatfollowsinthe
nextfieldasTransactionStatusdata:
2statusdata.
Var(71)
SeeTableNote5,
TableNote6&
TableNote7
LastTransactionStatuscontainsstatusdatarelatingtotheprevious
transactionperformedbytheSST,asfollows:
LastTransactionSerialNumber4bytes
LastStatusIssued1byte.SeeTableNote22.
LastTransactionNotesDispensedData20bytesorVarbytes.SeeTable
Note11.
LastTransactionCoinageAmountDispensed5bytes(always00000)
LastTransactionCoinsDispensedData20bytes
LastTransactionCashDepositData21orVarbytes
LastTransactionSerialNumbercontainsthefourdigitserialnumberof
thelasttransactionpartiallyprocessedbytheSST.Ifthisdoesnotmatch
thelasttransactionserialnumbersentbyCentral,thistransactionwas
notinitiated.
LastStatusIssuedcontainsonebyteidentifyingwhatthelastknown
statusmessagesentfromtheSSTwas(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.
9-5

Field
Number of
Characters
Mandatory/Optional
Description
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.
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.
9-6

Field
Number of
Characters
Mandatory/Optional
Description
NumberofNotes.Consistsofathreedigitdecimalcountofthenumber
ofnotesmovedtotherecyclecassette,intherange001to999.Thisfieldis
repeatedthesamenumberoftimesasthenumberofrecyclecassettes
reported.
Ifnorecyclecassettehasacceptednotes,thisfieldisomitted.
FS
See
TableNote8
TableNote9
FieldSeparator
av1
See
TableNote8
TableNote9
CSPDataIDU.AvalueofU(55H,ASCII)inthisfieldidentifiesthe
followingfieldasthefirstCustomerSelectedPINdata.Ifthisfieldis
selectedintheITransactionRequestStatetable(seeChapter 2,State
Tables)andnoCSPhasbeenrequested,onlythisfieldwillbepresent.
av2
Var(16)
See
TableNote8
TableNote9
CSPData.Thisfieldcontainsanencrypted16characterPIN.SeetheFIT
DatatableinChapter 8,FinancialInstitutionTables.
FS
See
TableNote8
TableNote9
FieldSeparator
aw
1
See
TableNote8
TableNote9
ConfirmationCSPDataIDV.AvalueofV(56H,ASCII)inthisfield
identifiesthefollowingfieldasthesecondCustomerSelectedPINdata.If
thisfieldisselectedintheITransactionRequestStatetable(see
Chapter 2,StateTables)andnoCSPhasbeenrequested,onlythisfield
willbepresent.IftheCSPstateindicatesthatlocalverificationofthetwo
CustomerSelectablePINsistobecarriedout,onlytheidentifierwillbe
sentifrequestedbytheTransactionRequestState.
aw
2
Var(16)
See
TableNote8
TableNote9
ConfirmationCSPData.Thisfieldcontainsanencrypted16character
PIN.Fordetails,seetheFITDatatableinChapter 8,Financial
InstitutionTables.
FS
See
TableNote8
TableNote9
TableNote10
FieldSeparator
ax1
See
TableNote8
TableNote9
TableNote10
VCDataIDW.ThevalueWinthisfieldidentifiesthefollowingfield
ascontainingdatainsertedbyExits.
ax2
Var
See
TableNote8
TableNote9
TableNote10
ThisfieldisavailableforusebyExits.
9-7

Field
Number of
Characters
FS
Mandatory/Optional
Description
See
TableNote8
TableNote9
TableNote10
FieldSeparator
ay1
See
TableNote8
TableNote9
TableNote10
VCDataIDX.ThevalueXinthisfieldidentifiesthefollowingfieldas
containingdatainsertedbyExits.
ay2
Var
See
TableNote8
TableNote9
TableNote10
FS
See
TableNote8
TableNote9
TableNote10
FieldSeparator
az1
See
TableNote8
TableNote9
TableNote10
VCDataIDY.ThevalueYinthisfieldidentifiesthefollowingfieldas
az2
Var
See
TableNote8
TableNote9
TableNote10
FS
See
TableNote8
TableNote9
TableNote10
FieldSeparator
ba1
See
TableNote8
TableNote9
TableNote10
VCDataIDZ.ThevalueZinthisfieldidentifiesthefollowingfieldas
ba2
Var
See
TableNote8
TableNote9
TableNote10
FS
See
TableNote8
TableNote9
TableNote10
FieldSeparator
9-8

Field
Number of
Characters
bb1
Mandatory/Optional
Description
See
TableNote8
TableNote9
TableNote10
VCDataID[.Thevalue[inthisfieldidentifiesthefollowingfieldas
bb2
Var
See
TableNote8
TableNote9
TableNote10
FS
See
TableNote8
TableNote9
TableNote10
FieldSeparator
bc1
See
TableNote8
TableNote9
TableNote10
VCDataID\.Thevalue\inthisfieldidentifiesthefollowingfieldas
bc2
Var
See
TableNote8
TableNote9
TableNote10
FS
See
TableNote8
TableNote9
TableNote10
FieldSeparator
bd1
See
TableNote8
TableNote9
TableNote10
SmartCardDataID5.Thevalue5inthisfieldidentifiesthefollowing
fieldascontainingdatainsertedbyEMV/CAM2Exits.
bd2
Var
See
TableNote8
TableNote9
TableNote10
SmartCardData.ThisfieldisavailableforusebyEMV/CAM2Exits.
FS
See
TableNote12
FieldSeparator
ca1
See
TableNote12
andTableNote
17
DeviceIDw.Thevaluewinthisfieldidentifiesthefollowingtwo
fieldsascontainingcashacceptordata.
ca2
See
TableNote12
andTableNote
17
Twodigithexadecimalnumber(0132)representinganotetype,
allowingupto50notetypestoberepresented.
9-9

Field
Number of
Characters
ca3
Mandatory/Optional
Description
2or3
See
TableNote12
TableNote13
andTableNote
17
Numberofnotesintheescrow,orvaultedifusingdirectdepositto
cassettes,forthenotetypedefinedinca2.
Thisfieldhaseither2or3digits,dependingonwhetheroption45isset
toreportmorethan90notesornot.
Ifoption45isnotsettoreportmorethan90notes,thisisatwodigit
number(0190).
Ifoption45issettoreportmorethan90notes,thisisathreedigit
number(000999).
Fordetailsofthesettingsforoption45,seepage 1017inthetable
EnhancedConfigurationParametersLoad.
FS
See
TableNote14
TableNote16
FieldSeparator
cb1
See
TableNote14
TableNote16
DocumentDataIDa.Thevalueainthisfieldidentifiesthefollowing
fieldascontainingsinglechequedepositdata.
cb2
See
TableNote14
TableNote15
TableNote16
TableNote21
Codelinedetected.
Avalueof1indicatesthataminimumnumberofcodelinecharacters
hasbeendetected,
Avalueof0indicatesthatacodelinehasnotbeendetectedafterall
allowedretries.
cb3
Var(256)
See
TableNote14
TableNote16
Codelinevalue.Thisfieldispresentonlyiffieldcb2hasavalueof1,
andcontainsthecodelinereadfromthecheque.
See
TableNote8
FieldSeparator
See
TableNote17
DataIDcfornotesregardedassuspectundertheECB6regulations.
FS
cc1
cc2
cc3
See
TableNote18
Notetypeidentifierasahexadecimalnumberintherange0001to00FF
cc4
See
TableNote18
Numberofsuspectnotesofthenotetypeidentifiedinfieldcc3,asa
decimalnumberintherange001to999
FS
Thenumberofnotetypeswithnotesidentifiedassuspect;thenotetype
countisadecimalnumberintherange00to99.
Ifnonotetypesareidentified,thisfieldis00andfieldscc3andcc4are
omitted
FieldSeparator
9-10

Field
Number of
Characters
cd1
DataIDdfornotesregardedascounterfeitundertheECB6regulations.
cd2
Thenumberofnotetypeswithnotesidentifiedascounterfeit;thenote
typecountisadecimalnumberintherange00to99.
Ifnonotetypesareidentified,thisfieldis00andfieldscd3andcd4
areomitted
cd3
See
TableNote19
Notetypeidentifier.Thehexadecimalidentifierofthenotetypeinthe
range0001to00FF
cd4
See
TableNote19
Numberofcounterfeitnotesofthenotetypeidentifiedinfieldcd3,asa
decimalnumberintherange001to999
FS
ce1
O
See
TableNote20
DataIDe.Thevalueeinthisfieldshowsthatbarcodedataisbeing
reported.
ce2
ASCIIhexadecimalrepresentationoftheBarcodeFormatidentifier.The
listofbarcodeformatvaluesisbasedontheCENXFSbarcodereader
deviceclass,orthevalue0000ifthebarcodeformatisnotknown.
ce3
Reserved
ce4
Var
Thescannedbarcodedata.Thelengthisdefinedbythebarcodeformat
andthelengthofthescannedbarcode.Thelengthofthewholemessage,
includingthisfield,mustnotexceedthemaximummessagelength,as
definedbytheCOMMSprotocol.
FS
FieldSeparator
cf1
DataIDf.Thevaluefinthisfieldshowsthatmorethanfourcoin
hoppertypesarebeingreported.
cf2
Numberofcoinsdispensedfromhoppertype1
cf3
cf4
cf5
Mandatory/Optional
Description
FieldSeparator
:
Ifacoindispenserispresentandoption79issetto001,theLastTransactionCoinageAmountDispensedis
reportedinfieldscf1tocf<n+1>insteadoffieldrasdescribedonpage 95.
Dependingonthenumberofhoppertypespresent, nisanumberbetween5and8.
:
cf<
n+
1>
Numberofcoinsdispensedfromhoppertypen
9-11

Field
Number of
Characters
FS
Mandatory/Optional
Description
See
TableNote8
TableNote9
FieldSeparator
cg1
See
TableNote8
TableNote9
TableNote23
TableNote24
DataIDg.Thevalueginthisfieldshowsthatabunchchequedeposit
isbeingreported
cg2
SeeTableNote
23
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
Thisfieldisalwayszero.
cg9
Mustbe0000
Mustbe0000
SeeTableNote
23
DepositCurrency.ThisfieldcontainsthethreecharacterISO4217
currencycodeforthedepositedcheques
Ifmultiplecurrenciesaredeposited,fieldscg4tocg16arerepeatedfor
eachdepositedcurrency
9-12

Field
Number of
Characters
Mandatory/Optional
Description
cg1
0
See
TableNote25
ChequeIdentifier.Thisfieldcontainsathreedigitnumberintherange
001999thatidentifiesaspecificchequeinthedepositrequest
Thevaluestartsat001foreachnewtransaction
cg1
1
12
See
TableNote25
CustomerChequeAmount.Thisfieldcontainsthevalueofthecheque
identifiedinfieldcg10asenteredorcorrectedbythecardholder.Ifthe
cardholderhasnotenteredorcorrectedtheamount,thisfieldissetto
zero
Thisfieldsuppliesthe<cheque_amount_reported> valueusedin
calculatingthechequeamountasdescribedinfieldcg6
cg1
2
12
See
TableNote25
DerivedChequeAmount.Thisfieldcontainsthevalueofthecheque
identifiedinfieldcg10asderivedfromimageprocessingtechnologies.If
thereisnoderivedvalue,thisfieldissettozero
Thisfieldsuppliesthe<cheque_amount_reported> valueusedin
calculatingthechequeamountasdescribedinfieldcg6
Thisfieldisalwayszero
cg1
3
See
TableNote25
CodelineLength.Thisfieldcontainsthelengthofthedatareportedin
fieldcg14forthechequeidentifiedinfieldcg10
Thisfieldcontainsadecimalnumberintherange000999
cg1
4
var
See
TableNote26
TableNote27
TableNote25
TableNote28
TableNote29
CodelineData.Thisfieldcontainsthecodelinereadfromthecheque
cg1
5
See
TableNote25
ChequeGroupseparator
cg1
6
See
TableNote24
CurrencyGroupseparator
FS
See
TableNote8
TableNote9
FieldSeparator
ci1
See
TableNote8
TableNote9
TableNote30
FieldID<.Thevalue<inthisfieldshowsthatvoiceguidancedatais
beingreported.
ci2
See
TableNote8
TableNote9
TableNote30
Voiceguidancelanguageidentifier.
9-13

Field
Number of
Characters
Mandatory/Optional
Description
FieldSeparator
Optionaldatafields.Thesefieldswillbeusedforfutureexpansion.
Var
Data.
FS
See
TableNote8&
TableNote9
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
presentonlyifspecifiedbyEnhancedConfigurationOption15.For
details,seetheEnhancedConfigurationParametersLoad
MessagesectioninChapter7andEnhancedConfiguration
ParametersLoadsectioninChapter10.Thefieldseparatormust
alsobepresentifanyofthesucceedingfieldsarepresent.
Table Note 6:Ifnoteswithanunknownpresentedstatusare
detectedfollowingapowerfailure,countsarereportedas
00000000000000000000inthenextmessage.OnDieboldsSSTs,if
noteswithanunknownpresentedstatusfollowingapowerfailure
aretobetreatedaspresented,thecountsarereportedinthenext
message.Forinformationaboutconfiguringthepresentedstatus,
refertoChapter6,AdvanceNDConSpecificVendorsSSTsofthe
APTRAAdvanceNDCMultiVendorSupportReference.
9-14

Table Note 7Coincountsarereportedonlyifoneofthefollowingis

true:
Acoindispenserispresent
Nocoindispenserispresentbutanoteacceptorispresent,in
whichcasethecoincountsareinitialisedtozero.
Table Note 8:Theoptionalfieldsfromav1onwardswiththe

precedingfieldseparatorformfieldgroups.Thenameofeachfield
isgivenbytwoalphabeticcharacterswitheachsubfieldelement
identifiedbyanumericcharacter.Thesefieldsareusedforgeneral
expansionofthetransactionrequestmessage.Eachfieldis
identifiedbyanIDfield.Eachfieldisonlyincludedinthemessage
ifthecorrespondingflagissetintheTransactionRequeststate.If
theTransactionRequeststatespecifiesthatafieldwillbeincluded,
atleastthedataidentifierwillbepresent.Iftheflagforafieldisnot
set,theentirefieldanditsprecedingfieldseparatorarenot
included.
Table Note 9:Ifanyofthefieldsfromav1onwardsareincludedin
themessage,thefieldseparatorsprecedingfieldsopandqr
willbepresenteveniftheassociateddataisnot.
Table Note 10:Fieldsax*tobd*areavailableforusebyExits.
TheymaycontainanysevenbitASCIIdatasubjecttolengthlimits
imposedbythecommunicationprotocolinuse,exceptthatthey
mustnotcontainGroupSeparator(1DH)orFieldSeparator(1CH)
characters.
Table Note 11:TheLastTransactionNotesDispenseddataconsists
of4or7fivedigitdecimalcounts,definingthenotesdispensedin
thelastdispensetransaction.Ifthelastreceivedcommandwasnota
dispensecommand,thesecountswillbezero.
Table Note 12:Ifacashacceptorispresent,theprecedingfield
separatorandoptionalcashacceptorfieldsca1,ca2andca3are
includedasagroup.Whenmultiplenotetypesarereportedinthe
transactionrequestmessage,thesequenceofthesefieldsisca1ca2
ca3ca2ca3....,whereca2andca3arerepeatedforthetypesthat
arepresent,upto50notetypes.
Table Note 13:IfyouuseECB6,thisfieldincludesnotesidentified
assuspectorauthentic,butnotnotesidentifiedascounterfeit.
Suspectnotesaretreatedasauthenticnotes.
Table Note 14:Ifachequeprocessorispresent,theprecedingfield
separatorandoptionalchequeprocessorfieldscb1,cb2andcb3
areincludedasagroup.Thechequeprocessorfieldsareonly
includedinthemessageifthecorrespondingflagissetinthe
TransactionRequeststate,inwhichcaseatleasttheBufferIdentifier
9-15

willbepresent.Whenaflagforafieldisnotset,theentirefieldand
itsprecedingfieldseparatorarenotincluded.
Table Note 15:IfthecorrespondingflagissetintheTransaction
Requeststateandtheoptionalchequeprocessorfieldscb1,cb2
andcb3areusedtoreportabunchchequedeposit,fieldcb2isset
to0.
Table Note 16:Whenanyofthefieldscb1,cb2orcb3aretobe
includedinthemessage,thefieldseparatorsprecedingfieldso
andp,andqandrwillbepresenteveniftheassociateddatais
not.
Table Note 17:Thesuspectnotecountsarealsoincludedintheca1,
ca2andca3fieldsastheyaretreatedasauthentic.
Table Note 18:Fieldscc3andcc4arereportedforeachnotetype
withsuspectnotes.
Table Note 19:Fieldscd3andcd4arereportedforeachnotetype
withcounterfeitnotes.
Table Note 20:Ifabarcodereaderispresent,theprecedingfield
separatorandoptionalbarcodereaderfieldsce1,ce2andce4are
includedasagroup.Thebarcodereaderfieldsareonlyincludedin
themessageifthecorrespondingflagissetintheTransaction
Requeststate,inwhichcaseatleasttheBufferIdentifierwillbe
present.Whenaflagforafieldisnotset,theentirefieldandits
precedingfieldseparatorarenotincluded.
Table Note 21:Ifthecodelineisnotdetectedafterallallowedretries,
itmaynotbepresentonthecheque.Incasethechequecanbe
endorsedwithoutacodeline,thechequedetailsarestillsentto
Central.
Table Note 22:TheLastStatusIssuedbyteappliesonlytosolicited
statusmessages;unsolicitedmessagesarenotpartofthetransaction
status.
Table Note 23:IfthefieldgroupwithDataIDgispresentandall
chequesaretobereturned,onlyfieldcg2isincluded.Ifanyfield
fromcg4onwardsisalsopresent,fieldscg2tocg9aremandatory.
Table Note 24:Tosupportchequedepositsofmorethanone
currency,fieldscg4tocg16arerepeatedforeverycurrency
exceptforthelastcurrencyinthemessagewhenfieldcg16is
omitted.Thetotalsinfieldscg7andcg8containthetotalsforthe
firstcurrencyandarefollowedbythedetailsforthechequesinthe
9-16

firstcurrency.Thisgroupingisrepeatedforeachadditional
currency.
Table Note 25:Thedetailsforeachchequetobedepositedmustbe
providedinthefieldgroupwithDataIDg,withfieldscg10to
cg14repeatedtoreporteverychequetobedepositedinthis
transaction.Thedetailsforeachchequeareseparatedfromthe
previouschequedetailsbyagroupseparator(fieldcg15)andeven
thelastchequehasatrailinggroupseparator.
Table Note 26: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
0x64
Transit
0x2D
Dash
space
0x20
space
Space
0x41
N/A
Reject/Unreadable
Table Note 27: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
9-17

CMC7
Character
NDC Character
Hex Value
CMC7 Meaning
0x2D
space
0x20
space
Space
0x41
N/A
Reject/Unreadable
S3TerminateRouting
Table Note 28:ThecodelinefieldinthefieldgroupwithDataIDg

isemptyifitcannotberead.
Table Note 29:IfthefieldwithDataIDaisusedtodepositabunch
ofcheques(thatis,usingthesinglechequeTransactionRequest
buffer),nocodelinedataisprovidedandfieldcb2inbufferaisset
to0.
Table Note 30:Thevoiceguidancebytesareonlypresentifthe
transactionisavoiceguidedtransactionandthebufferisdefinedin
theXMLconfigurationfile.Ifthevoiceguidancebufferisnotused,
theOperationCodefield(fieldj)canbeusedtoidentify
voiceguidedtransactionsandthelanguageused.
AdvanceNDCalwayssendsasolicitedstatus(errororready)in
responsetoatransactionreply.TheLastStatusIssuedbytevalueof
0willonlybeseeniftheSSTisresetwhileprocessingatransaction
reply,orontheveryfirsttransactionafterpersistentmemoryis
cleared.
Thisfieldispresenttoguardagainstthepreviousresponsebeing
lostduetoacommunicationsfailure,andindicateswhatstatus
AdvanceNDCpreviouslyattemptedtosendtoCentral.Thisisso
thatacommunicationsfailurewillnotcausethevaluetobesetto0.
IfyouhaveproblemsreconcilingtheunsolicitedE5message
(unknownnumberofnotesretracted)withthetransaction,then
messagemodeOptionDigit4Ashouldbeusedtosendadelayed
dispenserstatusmessage.
9-18

SSTReplytoInteractive
TransactionResponse
Thehostcanrequestfurtherinformationduringatransactionusing
anInteractiveTransactionResponse(ITR).Ifthisoccurs,asubsetof
theTransactionRequestmessageisusedtoreplytotherequest.
WhentheTransactionRequestmessageissentinreplytoanITR,it
differsfromthepreviousdescriptioninthatitconsistsonlyofthe
followingfields.
Table 9-4
Transaction Request in Reply to an
Interactive Transaction Response
MessageClass
MessageSubClass
FieldSeparator
LogicalUnitNumber
2FieldSeparators
TimeVariantNumber
FieldSeparator
TopofReceiptTransactionFlag
MessageCoordinationNumber
6FieldSeparators
GeneralPurposeBufferB.Minimumdatalengthis1character
1or2FieldSeparators
SeeTableNote31
MACData
Table Note 31:Iftheamountenteredexceedsthelimitof32bytes,

thenextkeypressclearsthebuffer,resettingthevalueto0and
restartingtheentryfromthebeginning.
Forfurtherinformationaboutgeneralpurposebuffers,refertothe
9-19

Solicited Status Messages
TheSSTrespondstoacommandfromCentralbysendingasolicited
statusmessage.Thissectiongivesinformationabouttheformatand
contentofsolicitedstatusmessages.
ContentofSolicitedStatus
Messages
Theinformationinthestatusmessagedependsonthecommand
receivedandwhetherornottheSSTcanperformthecommand.The
followingfieldsinthestatusmessagecontainthisinformation:
StatusDescriptor
StatusInformation.
Note:Exitscanalsosendsolicitedstatusmessages.Thesehavethe
sameformatasstandardsolicitedstatusmessages,butthecontent
oftheStatusDescriptorandStatusInformationfieldsdependson
theExit.Formoreinformation,refertoAPTRAAdvanceNDC,
ExtendingtheProduct.
StatusDescriptorField
Thestatusdescriptorfieldidentifieswhichofthefollowing
conditionsisbeingreported:
Ready.Thecommandhasbeenperformedsuccessfully
DeviceFault.Adevicefaulthasoccurred
CommandReject/SpecificCommandReject.Thecommandhas
beenrejected
TerminalState.ThevaluesofsupplycountersorSST
configurationareincludedinthemessage.
StatusInformationField
Thestatusinformationfieldcontainsadditionalinformationwhena
DeviceFault,SpecificCommandRejectorTerminalStatedescriptor
isused.Formoredetails,seeStatusInformationonpage 922.
Table 9-5
Solicited Status Message Format
Field
Number of
Characters
Mandatory/Optional
Description
Var
Header.Protocoldependent.
2Solicitedmessage.
9-20

Field
Number of
Characters
Mandatory/Optional
Description
2Statusmessage.
FS
FieldSeparator
3or9
transmittedtotheSSTinaConfigurationParametersLoadmessage.
Thedefaultnumberis000.Ifthedatasecurityfeatureisconfigured,
anadditionalsixcharactersarepresentwhichcontainthemachine
number.Fordetails,seetheAPTRAAdvanceNDC,SupervisorsGuide.
FS
FieldSeparator
FS
FieldSeparator
See
TableNote32
TableNote33
TimeVariantNumber.Containsaneightdigitnumberderivedfrom
thetimeofdaybytheSSTforeachstatusmessage.Thedigitscanbe
09,AF.
FS
See
TableNote32
FieldSeparator
StatusDescriptor.Describesthestatusmessageasfollows:
8
DeviceFaultThisindicatesthatanSSTdeviceisreporting
abnormalstatus.ThisvalueisalsousedinaconfigurationID
statusmessage.
ReadyThisindicatesthattheinstructionwascompleted
successfully.
CommandRejectThisisinsertedintothestatusdescriptor
fieldunderthefollowingconditions:
1.SSTreceivesanillegalcommand.
2.SSTreceivesillegaldatafromCentral.
3.SSTreceivesdatawhilenotinthecorrectmode.
Formoreinformation,seetheMessageValidationsection
inChapter 10,CentraltoTerminalMessages.
ReadyThisindicatesthattheTransactionReplywas
successfullycompleted.(WhenseparateReadyfor
TransactionReplycommandsoptionhasbeenselectedasa
configurationparameter.)
SpecificCommandRejectThisissenttoindicatearejection
ofthemessageforauthenticationfailure,orifthespecific
commandrejectoptionissetandamessageisrejectedthat
wouldotherwisegenerateacommandrejectA.Thestatus
informationfieldidentifiesthereasonforrejection.
9-21

Field
Number of
Characters
Mandatory/Optional
Description
TerminalStateThisissentinresponsetoTerminal
Commandsrequestingsupplycounters,SSTconfiguration
information,orthedateandtime.
FS
See
TableNote34
FieldSeparator
Var
See
TableNote34
StatusInformation.Additionalstatusinformationissentonly
whenthestatusdescriptorcontains8,CorF.
FS
See
TableNote32
TableNote33
FieldSeparator
See
TableNote32
TableNote33
MessageAuthenticationCode(MAC)Data.Containsthe
calculatedvalueforauthenticationofthismessage.The
charactersareintherange09andAF.
Var
Trailer.Protocoldependent.
Table Note 32:ThisisnotsentunlessMessageAuthenticationisin

use,andhasbeenselectedforsolicitedstatusmessages.Fordetails,
seetheMessageAuthenticationFieldSelectionLoadsectionin
Table Note 33:ThisisnotsentiftheStatusDescriptorfieldcontains
9orB.
Table Note 34:ThisisnotsentunlesstheStatusDescriptorfield
contains8,CorF.
StatusInformation
AdditionalinformationcanoptionallybecontainedintheStatus
InformationfieldwhentheBReadystatusdescriptorisused.
AdditionalinformationisalwayscontainedintheStatus
Informationfieldwhenthefollowingstatusdescriptorsareused:
CSpecificCommandReject
FTerminalState
8DeviceFault.
Ready(B)Status
WhentheStatusDescriptorisBandtheReadystatusissetto
includetransactionstatusdata,thefollowinginformationispresent
intheStatusInformationfield.FordetailsofsettingtheReady
statustoincludetransactionstatusdata,seeSupplyMode,Ready
Status&AmountBufferLength(Fieldm)onpage 72.
9-22

Table 9-6
Ready (B) - Status Information
Field
Number of
Characters
Mandatory/Optional
Description
g1
TransactionSerialNumber(TSN).ContainstheTSNofthelast
transactionprocessedbytheSST.
FS
FieldSeparator
SeeTableNote35
g2
DataIdentifier.Identifiesthedatathatfollowsinthenextfieldas
follows:
1RecycleCassetteDepositData
2RecycleCassetteDispenseData
g3
Var
TransactionData.Containsthetransactiondataasfollows:
Foradepositusingrecyclecassettes,seeCashDepositRecycleData
Subfieldg3onpage 923
Foradispenseusingrecyclecassettes,seeRecycleCassetteDispense
DataSubfieldg3onpage 924.
SeeTableNote36
Table Note 35:Ifnoadditionaldataispresent,thefieldseparatoris

omitted.Newdatagroupsmaybeincludedinthefuture.
Table Note 36:Agroupseparatorfollowseachreportedcassette,
exceptthelast.
CashDepositRecycleDataSubfieldg3 Ifthetransactionis
identifiedasadepositusingrecyclingcassettesorhascausedthe
statusoftherecyclingcassettestochange,thedatashownin
Table 97isreturnedintheReadyBmessage.
Note:Forrecyclingcassettes,themappingsbetweenthephysical
cassetteunits,theXFSlogicalcashunitsandtheNDCcassettetypes
canbeconfiguredusingtheregistry.Forfurtherinformation,refer
toConfiguringCashHandlersinChapter5oftheAPTRAAdvance
9-23

Table 9-7
Cash Deposit: Recycle Data
Number of Bytes
Description
NumberofCDMRecycleCassetteTypes
Reported.Thisisintherange01to99.
CDMNDCCassetteType.Consistsofone
threedigitidentifierforthecassettetypebeing
reported.Theidentifiercanbebetween001and
007.
ThisisrepeatedforeachCDMcassettethathas
acceptednotes.SeeTableNote37
NumberofNotesStoredorRetained.Consistsof
athreedigitdecimalcountofthenumberof
notesdeposited.Thisisintherange001to999.
CurrentFitnessStatus.Fordetails,seeFitness
Dataonpage E19.
CurrentSuppliesStatus.Fordetails,see
SuppliesDataonpage E11.Thisfielddoes
notreportnochange.
GS.SeeTableNote37
Table Note 37:IfthenumberofCDMrecyclecassettetypesis

greaterthan1,fieldsCDMNDCCassetteTypetotheGSinclusive
arerepeatedforeveryCDMcassettethathastakennotes.TheGS
forthelastcassettereportedisomitted.
RecycleCassetteDispenseDataSubfieldg3 Ifthe
transactiondataisidentifiedasadispenseusingrecyclecassettesor
hascausedthestatusofrecyclecassettestochange,thedatain
Table 98isreturnedintheReadyBmessage.
9
Note:Theinitialpositionoccupiedbyacassetteisusedtomapthe
cashinNDCcassettetypetotheXFSlogicalcashunit.When
recyclingisenabledonaGBXX,fixedmappingmustbeusedto
reportfixedcassettetypesinaReadyBandotherstatusmessages.
Forfurtherinformation,refertoChapter5,FixedCassetteMapping
forRecyclingintheAPTRAAdvanceNDC,DevelopersGuide.
9-24

Table 9-8
Recycle Cassette: Dispense Data
Number of Bytes
Description
NumberofCIMRecycleCassetteTypes
Reported.Thisisintherange01to99.
CIMNDCCassetteType.Consistsofone
threedigitidentifierforthecassettetypebeing
reported.Theidentifiercanbebetween000and
255.ThisisrepeatedforeachCIMcassettethat
hasdispensednotes.SeeTableNote37
NumberofNotesDispensed.Consistsofa
threedigitdecimalcountofthenumberofnotes
dispensed.Thisisintherange001to999.
ThisisrepeatedforeachCIMcassettethathas
dispensednotes.Rejectednotesaremovedtothe
rejectbinfromthecassetteandareincludedin
thetotalnumberofdispensednotesreturnedin
theReadyBmessage.
SeeTableNote37
CurrentFitnessStatus.Fordetails,seeCash
AcceptorFitness(DIGw)onpage E24.
dispensednotes.SeeTableNote37
CurrentSuppliesStatus.Fordetails,seeCash
AcceptorSupplies(DIGw)onpage E16.This
fielddoesnotreportnochange.
dispensednotes.SeeTableNote37
GS.SeeTableNote37
SpecificCommandReject
WhentheStatusDescriptorisCSpecificCommandReject,the
followinginformationispresentintheStatusInformationfield.For
detailsoftheconditionsunderwhichindividualstatusvaluesare
generated,seeMessageValidationonpage 1096.
9-25

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
heldintheSST.
AMessageFormaterror.
(g2)StatusQualifier:
01
Messagelengtherror.
02
FieldSeparatormissing/unexpectedlyfound.
03
TransactionReplymessagehastoomanyprintgroups.
04
GroupSeparatormissing/unexpectedlyfound.
05
Reserved
06
Invaliddispensemessage,wrongformatforcurrentmodeora
requesthasbeenmadetodispensefrommultipledispensers.Not
supported
07
MalformedXML.
08
XMLdoesnotconformtoXMLschema.
09
InconsistentXMLConfigurationdownload.Notsupported
BFieldValueerror.
01
IllegalMessageClass.
02
IllegalMessageSubClassorIdentifier.
03
IllegalEncryptionKeyChangeorExtendedEncryptionKeyChange
MessageModifier.
04
IllegalTerminalCommandCode.
05
IllegalTerminalCommandModifier.
06
IllegalTransactionReplyFunctionIdentifier.
9-26

Field
Number of
Characters
Mandatory/
Optional
Description
07
Datafieldcontainsnondecimaldigit.
08
Datafieldvalueoutofrange.
09
InvalidMessageCoordinationnumber.
10
IllegalFITnumber.
11
Invaliddispensemixspecified.Nonotesorcoinswerespecifiedor
toomanynotesorcoinswerespecifiedinadispensefunction.
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.
33
InvalidCassetteType.Notsupported
34
Invalid/IncompleteChequeIdentifier(s).
35
PassbookupdatenotsupportedinspecifiedTransactionReply
Function.
9-27

Field
Number of
Characters
Mandatory/
Optional
Description
CIllegalMessagetypeforcurrentmode.
01
MessagetypeonlyacceptedwhileSSTisInServiceandexpectinga
TransactionReply
02
Messagenotacceptedwhilediagnosticsisin progress.Thisis
returnedwhentheapplicationhaspassedcontroltoVDM
03
MessagenotacceptedwhileinOutofServiceorSupplymode
04
MessagenotacceptedwhileinInServicemode
05
MessagenotallowedwhileconfiguredforNCRstatusmessage
mode
06
MessagenotallowedwhileSSTisconfiguredforDieboldstatus
messagemode.Notsupported
0709
Reserved
10
MessagenotacceptedwhileprocessingaTransactionReply.
11
Chequenotpresentinchequeprocessortransportwhileprocessinga
TransactionReply
1214
Reserved
15
EncryptionKeyChangeorExtendedEncryptionKeyChange
messagenotacceptedduringacardholdertransaction,orwhilethe
SSTisinsuspendmode,orwhiletheoperatorisinitiatingthe
executionofsupervisory/settlementtransactions.
16
Reserved
17
Keychangeoperationcannotbeacceptedinrestrictedencryption
mode.ThisapplieswhenanExtendedEncryptionKeyChange
messagewithmodifier3,4,6or7isreceivedinrestrictedmode.
18
Keyentrymodenotauthorised.
DHardwareFailure.
01
EncryptionfailureduringEncryptionKeyChangeorExtended
EncryptionKeyChangemessage.
02
TimeofDayClockfailureorinvaliddatasentduringDate/TimeSet
command
0305
Reserved
06
Insufficientdiskspace.
9-28

Field
Number of
Characters
Mandatory/
Optional
Description
07
FileIOerror.
08
Filenotfound.
EFunctionNotSupported.
g2
01
Functionnotsupportedbysoftware.
Forexample,aDLLrequiredtocompletethetransactionreply
processingismissing.
02
Requireddevicenotconfigured.Also,sidewaysprintonthereceipt
isrequested,buteithertheprinterdoesnothavethecapabilityorhas
notbeenconfiguredforsidewaysprinting.
03
Reserved
04
Reserved
05
Journalprinterbackupinactive
06
Thedatarequestedisnotcompatiblewiththerequiredresponse
message.Notsupported
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.NotSupported
Senderrorloginformation.Notsupported
Senddate/timeinformation
SendconfigurationID
EKCretrievehallmarkkey(unsupported)
9-29

Terminal Command
Sub-Field g1
Hardwareconfigurationdata
Suppliesdata
Fitnessdata
Tamperandsensorstatusdata
SoftwareIDandreleasenumberdata
Localconfigurationoptiondigits
Reportcashdepositdefinition
SendConfigurationInformation
ThissolicitedstatusmessageissenttoCentralinresponsetoaSend
ConfigurationInformationTerminalCommandmessage(a
commandcodeof7withnocommandmodifier,oracommand
modifierof6toincludeenhancedconfigurationinformation).The
responsereturnsalltheconfigurationinformationavailable.
Ifamessagewithacommandcodeof7alsohasacommand
modifier,theresponsereturnstheconfigurationinformation
specifiedbythecommandmodifier.Fordetailsoftheterminal
commandcode,seeConfigurationInformation(CommandCode=
7)onpage 105.
Fortheconfigurationresponseswhenamodifierotherthan6is
included,seesectionsHardwareConfigurationDataonpage 943
toReportCashDepositDefinitiononpage 953.
Table 9-11
Send Configuration Information Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
MessageIdentifier.ThismessageissenttoCentralinresponsetoa
SendConfigurationInformationTerminalCommandmessageandhas
identifier1
g2
ConfigurationID.ContainsthelastfourdigitconfigurationID
numbers(00009999)senttotheSSTfromCentral
FS
FieldSeparator
g3
22or38
HardwareFitness.Containsonebyteforeachdeviceormajordevice
resource.Thepositionofthebyteidentifiesthedevice;thebyte
indicatesthefitnessstatus.Fordetails,seeHardwareFitness
FS
FieldSeparator
9-30

Field
Number of
Characters
Mandatory/Optional
Description
g4
44or76
HardwareConfiguration.Containsinformationforeachdevice
indicatingwhetherornotitisconfigured.Ifconfigured,itgivesdetails
ofwhichoption,ifany,isconfigured.Fordetails,seeHardware
ConfigurationDataSubFieldg4onpage 934.
Note:Asthebytesizeforthisfieldislimited,somenewdevice
configurationscannotbesent,forexamplebarcodereader.
FS
FieldSeparator
g5
23or26
SuppliesStatus.Containsonebytepertypeofmediacontaineror
resource.Thepositionofthebyteidentifiesthemediaresource;the
byteindicatesthesuppliesstatus.Fordetails,seeSuppliesStatus
FS
FieldSeparator
g6
5or12
SensorStatus.Containsonebytepersensorandisidenticaltothe
informationreportedincharacters213ofSensors(Unsolicited)on
page 9105.
Asinthestatusmessages,TIsensorsarereportedonlyiftheTIfeature
isconfigured.
Thenumberofcharactersisalwaystwelveiffieldsg7andg8are
present.ThelastsevenbytesareblankifnoTIispresent
FS
FieldSeparator
g7
AdvanceNDCReleaseNumber.Containsasixdigitdecimalnumber.
Thefirstpairofdigitsrepresentsthereleasenumber.Thesecondpair
ofdigitsrepresentsthepointreleasenumber.Thethirdpairofdigits
representsthepatchreleasenumber.SeeTableNote38.
FS
FieldSeparator
g8
AdvanceNDCSoftwareID.ContainstheAdvanceNDCSoftwareID.
Thefieldtakesthefollowingvalues:
G5310283 (AdvanceNDCpackage)
IftheAdvanceNDCsoftwareIDisunavailable,thisfieldcontains
nineblanks.SeeTableNote38.
Table Note 38:Fieldsg7andg8areincludedonlyifthe

appropriatemessagemodeoptiondigit6Cisset.Fordetailsofthis
optiondigit(6C,addtheAdvanceNDCReleaseNumberand
SoftwareIDfieldstotheConfigurationTerminalStateMessage),
HardwareFitnessSubfieldg3 Thedeviceisidentifiedbythe
positionofthebyte,asshowninthefollowingtable.Thefield
9-31

returnsthefitnessofmostdevicesandmodulesforanoverallview
ofthestateoftheSST.
Table 9-12
Hardware Fitness Sub-Field g3
Byte position
Device indicated
TimeofDayClock,seeTableNote39
HighOrderCommunications
SystemDisk
MagneticCardReader/Writer,seeTableNote39
CashHandler,seeTableNote39
Depository,seeTableNote39
ReceiptPrinter,seeTableNote39
JournalPrinter,seeTableNote39andTableNote40
Reserved
Reserved
10
NightSafeDepository,seeTableNote39
11
Encryptor,seeTableNote39
12
SecurityCamera
13
DoorAccess.Notsupported
14
FlexDisk
15
Cassettetype1
16
Cassettetype2
17
Cassettetype3
18
Cassettetype4
1920
Reservedfornewdevice (=0)
21
StatementPrinter,seeTableNote39
22
SignageDisplay,seeTableNote41
2324
Reserved,seeTableNote41
25
SystemDisplay,seeTableNote41
26
MediaEntryIndicators,seeTableNote41
27
EnvelopeDispenser,seeTableNote39andTable
Note41
28
DocumentProcessingModule.Notsupported
SeeTableNote41
9-32

Byte position
Device indicated
29
CoinDispensingModuleTamperIndication
SeeTableNote41
30
DocumentProcessingModule,ModuleTamper
Indication.Notsupported
SeeTableNote41
31
32
VoiceGuidanceSystem
SeeTableNote41
33
34
BunchNoteAcceptor
SeeTableNote41
35
ChequeProcessor
SeeTableNote41
3637
Table Note 39:TherelationshipbetweentheDeviceIdentifier

Graphic(DIG)inthestatusmessageandtheoffsetintheFitness
tableis:offset = DIG - 41 hex
Table Note 40:WhendualmodeisconfiguredusingEnhanced
ConfigurationParameteroption35,onlythestatusofthephysical
deviceisreported.Fordetailsofoption35,seeOption35Report
DualModeEJ&HardcopyB/UUnsolicitedMessageson
page 713.
Table Note 41:Thesefieldsarereturnedonlyifcommandmodifier
6,Sendenhancedconfigurationdata,isused.Fordetails,see
ConfigurationInformation(CommandCode=7)onpage 105in
tableTerminalCommandsonpage 103.
FitnessSeverity Eachbyteindicatesthecurrentfitnessofthe
devicebyaseverityvalue,asshowninthefollowingtable.Routine,
warningandfatalconditions(severityvalues1,2and4)canonlybe
clearedbylocalsupervisorfunctions.
9
Table 9-13
Hardware Fitness Severity Values
Severity Value
Meaning
Noerror
Routineerrorshaveoccurred
9-33

Severity Value
Meaning
Warningconditionshaveoccurred
investigationrequired
Suspend.Terminaliscurrentlyinsuspendstate
duetosuspectedtamperingwiththisdevice
Fatalerrorconditionexists
HardwareConfigurationDataSubFieldg4 Theconfiguration
dataforeachdeviceisreportedastwohexadecimalcharacters
representingabyteofconfigurationinformation.Thefollowing
tablegivesdetailsofthebytepositionforeachdeviceandthevalue
orbitsignificanceofeachbyteasappropriate.
9
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
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
9-34

Byte
Device
58676622
6624
6626
6628
6631
6632
6634
6638
6625
6618
6636
2012(SelfServ22e)
2016(SelfServ16)
6642(SelfServ42)
2004(SelfServ4)
2008(SelfServ8)
2014(SelfServ14)
Note:ThislistdoesnotimplyAdvanceNDC
supportforalltheseproductclasses.
2A30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
3F
40
7F
SystemDisk
00
01
02
Noconfiguration
Harddiskpresent
Reserved
Reserved
MagneticCardReader/Writer.SeeTableNote42.
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
9-35

Byte
Device
CashHandler.SeeTableNote42,TableNote46andTableNote
47
00
01
02
03
04
EnvelopeDepository.SeeTableNote42.
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.SeeTableNote42.
00
01
02
03
80
81
82
83
Notconfigured
Reserved
ProgrammablePrintingDepository(PPD)
Reserved
Reserved
ReceiptPrinter.SeeTableNote42.
00
01
02
03
04
05
06
07
08
Notconfigured
Stackingcashhandler
Spraycashdispenser
Stackingcashhandlerwithrecyclecapabilities.See
TableNote43
Stackingcashhandlercapableofrecyclingwithrecycle
capabilitiesdisabled.SeeTableNote43
Notconfigured
Reserved
00
Notconfigured
9-36

Byte
Device
10
NightSafeDepository.SeeTableNote42.
00
01
02
11
Encryptor.SeeTableNote42.
?0
?1
02
03
04
05
06
?7
12
13
14
Notconfigured
Configured
Reserved
Notconfigured
BAPEencryptor.
Reserved
Reserved
Reserved
Reserved
Reserved
EPPencryptor
?=SSTkeyentrymode(0,B,CorD)where:
0=singlelengthkeyswithoutXORkeyentry
B=singlelengthkeyswithXORkeyentry
C=doublelengthkeys
D=doublelengthkeys,restrictedmode.SeeTable
Note44
Forexample,C7=doublelengthkeyentrywithanEPP
encryptor.
SecurityCamera
00
Notconfigured
01
Fixedformat
02
Variableformat
03
Reserved
04
Digital
DoorAccess.Notsupported
00
Notconfigured
01
Configured
FlexDisk
00
01
02
Notconfigured
1.44MBflexdiskconnected
2.88MBflexdiskconnected
9-37

Byte
Device
15
TamperIndicating(TI)Bins.SeeTableNote42.
Notcoindispenser
00
01
02
03
16
CardholderKeyboard
00
01
02
17
Reserved
Standard(BAPE)keyboard
EPPkeyboard
OperatorKeyboard
00
01
02
18
Notconfigured
Securecashandinsecurecards,andeitherinsecure
depositbinornoenvelopedepository(PPD).This
valueisalwayssetto01asAdvanceNDCcannot
determineifTIexistsinamultivendorenvironmentas
thiscapabilityisnotsupportedinCENXFS.
Securecash,insecurecardsandsecuredeposits.Not
supported
Securecashandcards,andeitherinsecuredepositbin
ornoenvelopedepository(PPD).Notsupported
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.SeeTableNote42.
00
01
02
03
09
Notconfigured
Standardstatementprinter
Reserved
Reserved
Enhancedthermalstatementprinter(SDC+)
2223
Reserved.SeeTableNote45.
24
CoinDispenser.
9-38

Byte
Device
00
01
02
03
25
SystemDisplay.
SeeTableNote45.
00
01
02
26
Notconfigured
CoinDispensingModuleTamperIndication.
SeeTableNote45.
00
01
30
Notconfigured
Configured
Reserved
Reserved
DocumentProcessingModule.Notsupported.
SeeTableNote45.
00
29
Notconfigured
Configured
EnvelopeDispenser.
00
01
02
03
28
Notconfigured
Reserved
Configured
MediaEntryIndicators.
00
01
27
NotConfigured
Reserved
CoinDispenserwithfourhoppertypes
CoinDispenserwithmorethanfourhoppertypes
Notconfigured
Configured
DocumentProcessingModuleTamperIndication.Not
supported.
SeeTableNote45.
00
Notconfigured
31
32
VoiceGuidance
SeeTableNote45
00
01
02
33
Notconfigured
StandardAudiopresent
EnhancedAudiopresent
9-39

Byte
Device
34
NoteAcceptor
00
01
02
03
04
Notconfigured
Reserved
Reserved
Bunchnoteacceptor
Bunchnoteacceptorwithrecyclecapabilities,also
knownasarecyclingunit.OnNCRSSTsthisiscalleda
GBRU.SeeTableNote43
05
Bunchnoteacceptor.OnNCRSSTs,thisiscalleda
GBNAbutitcanalsobereportedwhenaGBRUwith
recyclingdisabledispresent.SeeTableNote43
06
Bunchnoteacceptorthatcanaccepteithercashor
chequesbutnotbothinasingletransaction.SeeTable
Note47
07
Bunchnoteacceptorthatcanacceptnotesandcheques
separatelyortogetherinasingletransaction.Not
supported.
Singlenoteacceptor
08
35
3637
ChequeProcessor
00
01
02
03
Notconfigured
Singlechequeacceptmodule(CPM)
Bunchchequeacceptor
Bunchchequeacceptorthatcanalsoaccept
cash.Thedevicecanaccepteithercashorchequesbut
notbothinasingletransaction.SeeTableNote47
04
Bunchchequeacceptorthatcanalsoaccept
cash.Thedevicecanacceptbothcashandcheques
separatelyortogetherinasingletransaction.Not
supported.
Table Note 42:TherelationshipbetweentheDIGandthe

configurationtableoffsetis:offset = 2 x (DIG - 41 hex)
Table Note 43TheMStatusvaluesreportedindevicestatus
messagesarecompatiblewiththeGBXXfamilyofdevices.
Table Note 44Ifanattemptismadetoimportakeywiththesame
valueasthecurrentlyloadedkey,theimportisrejectedwith
encryptionfailurereasonD01.
9-40


ConfigurationInformation(CommandCode=7)onpage 105in
tableTerminalCommandsonpage 103.
Table Note 46:Whendualcashhandlersareused,eitherbothcash
handlersmustbestandardcashhandlersoronecashhandlermust
beastandardcashhandlerandtheotheraGBRU.IfaGBRUis
used,itmustbeconfiguredastheprimarycashhandler.
Table Note 47: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
17
18
9-41

Byte position
Device indicated
19
Notused(=0)
20
Notused(=0)
21
StatementPaper
22
StatementRibbon
23
24
25
EnvelopeDispenser,seeTableNote48

ConfigurationInformation(CommandCode=7)onpage 105.
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
9-42

ConfigurationInformationterminalcommandwithacommand
codeof7andacommandmodifierof1.
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.
Var(2)
ProductClass.ThistwocharacterfieldcontainstheProductClass
oftheSST.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
9-43

Field
Number of
Characters
Mandatory/Optional
Description
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)
3F2008(SelfServ8)
402014(SelfServ14)
FS
FieldSeparator
g4
HardwareConfigurationIdentifierC.
Thisfieldcontainshardwareconfigurationinformationforeachof
thedevicespresentintheSST.Itisdividedintoaseriesofsubfields
separatedbygroupseparators.
Ifadeviceisnotpresent,therewillbenocorrespondingDIGinthe
field.
O
See
DeviceIdentifierGraphic(DIG).Thisidentifiesthedevicetowhich
thefollowinghardwareconfigurationdataapplies.Fordetails,see
seeHardwareConfigurationDataonpage E2.
Var
O
See
HardwareConfiguration.Thiscontainsinformationforeachdevice
indicatingwhichvariantofthedeviceisconfiguredandanyother
configurationdataavailable.Fordetails,seeHardware
ConfigurationDataonpage E2.
O
SeeTableNote49
GroupSeparator.
O
SeeTableNote49
DeviceIdentifierGraphic(DIG).
9-44

Field
g5
Number of
Characters
Mandatory/Optional
Description
Var
O
SeeTableNote49
HardwareConfiguration.
O
SeeTableNote50
FieldSeparator.
O
SeeTableNote50
Var
O
SeeTableNote50
Data.
TheDIGanditsassociateddata,togetherwiththeprecedinggroup
separatorformagroup.WhentheDIGispresent,allelementsof
thisgroupmustbepresent.
Table Note 49:TheDIGanditsassociateddata,togetherwiththe
precedinggroupseparatorformagroup.WhentheDIGispresent,
allelementsofthisgroupmustbepresent.Suchgroupsarerepeated
asoftenasnecessarytoensurethatthedatarelatingtoalldevices
presentintheSSTisreported.
Table Note 50:Thesefieldsarereservedforfutureexpansion.
SuppliesData
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.
9-45

Field
Number of
Characters
Mandatory/Optional
Description
Ifadeviceisnotpresent,therewillbenocorrespondingDIGinthe
field.
1
O
SeeTableNote51
thefollowingsuppliesstatusdataapplies.Fordetails,seeChapter E,
DeviceIdentifiers.
Var
O
SeeTableNote51
SuppliesStatus.Thiscontainsinformationforeachdeviceindicating
theconditionofthedevicesreplenishables.Fordetails,see
SuppliesDataonpage E11.
ExceptforcashacceptorsseeCashAcceptorSupplies(DIGw)
onpage E16eachelementofthesuppliesstatusdatawilltakeone
ofthefollowingvalues:
g3
Value
Description
Notconfigured/reserved
Goodstate
Medialow
Mediaout
Overfill
O
SeeTableNote52
GroupSeparator.
O
SeeTableNote52
Var
O
SeeTableNote52
SuppliesStatus.
O
SeeTableNote53
FieldSeparator
O
SeeTableNote53
DataIdentifier.
Var
O
SeeTableNote53
Data.

allelementsofthisgroupmustbepresent.
9-46

Table Note 53:Thesefieldsarereservedforfutureexpansion.
9-47

FitnessData
TerminalMessages.
Table 9-19
Fitness Data Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
MessageIdentifier.ThismessagehasidentifierJ.
g2
HardwareFitnessIdentifierA.
Thisfieldcontainsfitnessinformationforeachofthedevicespresent
intheSST.Itisdividedintoaseriesofsubfieldsseparatedbygroup
separators.
O
SeeTableNote54
thefollowingfitnessdataapplies.Fordetails,seeAppendix E,
DeviceIdentifiers.
Var
O
SeeTableNote54
Fitness.Eachfitnesscharacterisencodedwithoneofthefollowing
errorseverityvalues,indicatingthecurrentfitnessofthedevice:
Char
Severity
Noerror/notsupported
Routineerrorshaveoccurred
Warningconditionshaveoccurredinvestigationis
required
Suspend.TheSSTiscurrentlyinthesuspendstatedueto
suspectedtamperingwiththisdevice
Fatalerrorconditionexistsonthisdevice
Routine,warningandfatalerrorscanonlybeclearedbylocal
Supervisorfunctions.
Fordetails,seeFitnessDataonpage E19.
1
O
SeeTableNote55
GroupSeparator.
O
SeeTableNote55
Var
O
SeeTableNote55
Fitness.
9-48

Field
Number of
Characters
Mandatory/Optional
Description
g3
FieldSeparator.
(Presentforfutureexpansion.)
DataIdentifier
Var
Datapresentforfutureexpansion.

allelementsofthisgroupmustbepresent.
TamperandSensorStatusData
TerminalMessages.Thisstatusmessagereportsphysicalcassettes,
includingcassettesotherthancashincassetteswhenthedeviceisa
combinedcashin/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
9-49

Field
Number of
Characters
Mandatory/Optional
Description
Thecontentsofthetamperstatusdatafieldareasfollows:
Char
Code
17
Identicaltobytes713oftheSensorsStatusmessage,
describedintheSensors(Unsolicited)section.
0CoinDispenserout.
1CoinDispenserin.
0CoinDispenserHopper1out.
1CoinDispenserHopper1in.
10
11
12
13
NotsupportedinAdvanceNDC
Ifadeviceisnotconfigured,anyassociatedTIbytewilltakethevalue
0.
g4
ExtendedTamperIndicatorIdentifierC.SeeTableNote56
SeeTableNote
57andTable
Note58
DeviceIdentifierGraphic(DIG).Thisfieldcontainsdataoneach
devicepresentintheSST.
Var
SeeTableNote
57andTable
Note58
TamperStatus.
ThisfieldcontainstheconditionoftheTIsensors.IftheTIfeatureis
notconfigured,thisfield,withthebufferidentifier,willnotbepresent.
Thelengthoftheconfigurationdatavariesdependingonthedevice
beingreported.
Fordetails,seeTamperIndicatorIdentifierB.
GroupSeparator
DeviceIdentifierGraphic(DIG).Thisfieldcontainsdataoneach
devicepresentintheSST.
Fordetails,seeTamperDataonpage E25.
Var
TamperStatus.ThisfieldcontainstheconditionoftheTIsensors.If
theTIfeatureisnotconfigured,thisfield,withthebufferidentifier,
willnotbepresent.
Fordetails,seeTamperIndicatorIdentifierB.
9-50

Field
Number of
Characters
g5
Mandatory/Optional
Description
SeeTableNote
59
FieldSeparator.
SeeTableNote
59
DataIdentifier.
Var
SeeTableNote
59
Data.
Table Note 56:ThesettingofEnhancedConfigurationoption24

determineswhethertheextendedtamperinformationissent.For
detailsofoption24,seeOption24Enhanced/TISensorStatus
UnsolicitedMessageonpage 79.
Table Note 57:TheDIGandassociateddataareagroup.IftheDIG
ispresent,alltheelementsofthegroupmustalsobepresent.
Table Note 58:ADIGandassociateddataareincludedasoftenas
requiredtoreportonalldevices.
Table Note 59:Thesefieldsarepresentforfutureexpansion.
9-51

SoftwareIDandReleaseNumberData
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
commandcodeof7withacommandmodifierof6).Itreturnsall
theconfigurationinformationavailable.
9-52

Fordetailsofthismessage,seeSendConfigurationInformation
onpage 930.Enhancedinformationisincludedinsubfieldsg3,
g4andg5asdescribedinthefollowingsections:
HardwareFitnessSubfieldg3onpage 931
HardwareConfigurationDataSubFieldg4onpage 934
SuppliesStatusSubfieldg5onpage 941.
commandcodeof7withacommandmodifierof7).
InAdvanceNDC,theoptiondigitsettingsareautomaticallysaved
topersistentstorage,andhenceareusedonpowerfailurerecovery.
Someoptionsarenotsupported.Fordetails,refertotheAPTRA
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
CashDepositDefinitionterminalcommandmessage(acommand
codeof7withacommandmodifierof8).
9-53

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.
FS
SeeTableNote62
g3
ECB6NoteRetentionModeID(D)
ECB6NoteRetentionMode
SeeTableNote62
DataIdentifier.Reservedforfutureexpansion
Var
Data.Reservedforfutureexpansion
FS
Table Note 60:Thisfieldisrepeatedforeachitemtyperecognized

bythedepositmodule.Fornoteacceptors,NDCnotetypemapping
isperformedwhenAdvanceNDCisstarted.Formoreinformation,
refertotheAPTRAAdvanceNDC,DevelopersGuide.
Table Note 61:Eachcashitemtypeconsistsof11byteswiththe
followingformat:
# B B I
S O V A L U E
whichisinterpretedasfollows:
Byte
Meaning
Activeindicator(!=inactive)
Ifthenoteisidentifiedasactive,itcanbeacceptedbythe
BNA.Ifthenoteisidentifiedasinactiveitisrejected.
9-54

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 62:Thefieldseparatorsmustbepresentifanyother

fieldsfollow.
Table Note 63:Ifthefollowingmessageisreturned,useINITBNA
toclearthedeviceandpopulatetheCashItemtypemessage,as
follows:
22<fs>000<fs><fs>F<fs>NA
TheNAattheendofthemessageisreturnedasthedeviceisina
badstateandanattempthasbeenmadetoinitialisethedevice.
SendSupplyCounters
ThisSolicitedStatusmessageissenttoCentralinresponsetoaSend
CountersTerminalCommandmessage.Dependingonthemodifier
usedwiththecommandcodeof4,thebasicorextendedmessageis
used.FordetailsoftheTerminalCommandmessage,seeTerminal
Commandsonpage 103.
Forthebasicmessageformat,seethenextheadingandforthe
extendedmessageformat,seeExtendedSendSupplyCounterson
page 961.
9-55

BasicSendSupplyCounters
thefollowing:
Thebasicmessageformatcanreport
Fourcassettetypes.Inadualcashhandlersystemitreportsthe
combinednumberofnotesforeachcassettetype.
Fourcoinhoppertypes.
Table 9-24
Send Supply Counters Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
MessageIdentifier.Thismessagehasidentifier2.
g2
transactionprocessedbytheSST.Ifthisdoesnotcorrespondto
thelastTSNsentbyCentral,itmeansthatthetransactionhas
notbeeninitiatedandthecountershavenotbeenupdated.
g3
AccumulatedTransactionCount.Definesthetotalnumberof
detectedtransactionattemptssincetheSSTwasinstalledorthe
nonvolatileSSTmemorywaslastcorrupted.Thecountisreset
to0after9,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.
9-56

Field
Number of
Characters
Mandatory/Optional
Description
g5
20
NotesRejected.Consistsoffourfivedigitdecimalcountsofthe
totalnumberofnotesmovedtotherejectbinfromcassette
types1,2,3and4.
Althoughfieldsg4andg5maynotbetotallyaccurate,the
sumofthesecountsforaparticularcassettetypedoes
accuratelyrepresentthedifferencebetweentheoriginal
numberofnotesaddedandthenumberofnotesdispensed.
g6
20
NotesDispensed.Consistsoffourfivedigitdecimalcountsof
thetotalnumberofnotesdispensedfromcassettetypes1,2,3
and4.Thesecountsareconsistentwithnotecountsreported
sincethecountswerelastclearedbyasupervisortransaction.
Ifatransactionisprematurelystoppedbyapowerfailure,
thesecountsareupdatedtoreflectthenumberofnotes
dispenseduptothetimeofpowerfailure.
g7
20
LastTransactionNotesDispensed.Consistsoffourfivedigit
decimalcountsofthenumberofnotesdispensedonthelast
transactionprocessedbytheSST.ThisfieldallowsCentralto
recovernotecountsafterpowerfailure,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
SeeTableNote64
GroupSeparator.
g20g22
Var(15)
Reserved.
9-57

Field
Number of
Characters
Mandatory/Optional
Description
GS
SeeTableNote64
GroupSeparator.
g30g32
Var(15)
Reserved.
GS
SeeTableNote64
GroupSeparator.
g40g4x
Var(x)
Reserved.
GS
SeeTableNote64
GroupSeparator.
g50g53
Var(20)
Reserved.
GS
SeeTableNote64
GroupSeparator.
g60
Var(20)
O
SeeTableNote65
Coinsremaining
g61
Var(20)
O
SeeTableNote65
Coinsdispensed
g62
Var(20)
O
SeeTableNote65
Lasttransactioncoinsdispensed
GS
SeeTableNote64
GroupSeparator.
g70
O
SeeTableNote66
Totalnotesrefunded
g71
O
SeeTableNote66
Totalnotesrejected
g72
O
SeeTableNote66
Totalnotesencashed
g73
O
SeeTableNote66
Totalnotesescrowed
GS
SeeTableNote64
GroupSeparator.
g80g89
Reserved.
GS
SeeTableNote64
GroupSeparator.
g90g99
Reserved.
GS
SeeTableNote64
GroupSeparator.
g100
g109
Reserved.
GS
SeeTableNote64
GroupSeparator.
g110
g119
Reserved.
GS
SeeTableNote64
GroupSeparator.
9-58

Field
Number of
Characters
Mandatory/Optional
Description
g120
ChequeprocessorchequesdepositedintoBIN1
g121
Chequeprocessorchequesdepositedintoreject/retainBIN2
g122
ChequeprocessorchequesdepositedintoBIN3
g12n
ChequeprocessorchequesdepositedintoBINn1
GS
SeeTableNote64
GroupSeparator.
g130
g139
Reserved.
GS
SeeTableNote64
GroupSeparator.
g140
Reserved.
GS
SeeTableNote64
GroupSeparator.
g150
g154
Reserved.
GS
SeeTableNote64
GroupSeparator.
g160
Numberofpassbookscaptured.
Table Note 64:Ifanyoptionalgroupispresent,allofthegroup

separatorsprecedingitwillbeincluded,enablingthehostto
identifythegroupfieldbyitsposition.(Thisappliestothebasic
messageformatonly;thehandlingofgroupseparatorsinthe
extendedmessageformatisdescribedinExtendedSendSupply
Countersonpage 961.)
Table Note 65Fieldsg60g62formagroupandwillonlybe
presentifacoindispenserispresent.
Table Note 66:Fieldsg70g73formagroupandwillonlybe
presentifaBNAispresent.:
Fieldsg120g129formagroupandwillonlybepresentifa
chequeprocessorispresent.
ExampleMessageAnalysis Thefollowingexampleshowsa
messagesentfromanSSTinresponsetoabasicSendSupply
Counterscommandfromthehost.TheSSThasfourcassettetypes
butnocoin,chequeorpassbookcapabilities:
22<FS>000<FS><FS>F<FS>202730000267012670168101629007780000300052000020000200194001330113100
2800000000005000000000000000000000000000000
9-59

Thecontentofthismessageisdescribedinthefollowingtable:
Table 9-25
Status Message Description
Message Content
Field
Description
Asolicitedmessage
Astatusmessage
000
LUNO
SentinresponsetoaTerminalCommandrequestingsupply
counters,terminalconfigurationinformation,orthedateandtime
g1
TheTerminalCommandhasrequestedsupplycounters
0273
g2
TransactionSerialNumber
0000267
g3
Accumulatedtransactioncount
01267
g4
Numberofnotesincassette1
01681
01629
00778
00003
g5
Numberofrejectednotesincassette1
00052
00002
00002
00194
g6
Numberofnotesdispensedfromcassette1
00133
01131
00280
00000
g7
Numberofnotesdispensedfromcassette1inthelasttransaction
00005
00000
00000
00000
g8
Numberofcapturedcards
00000
g9
Numberofdepositedenvelopes
00000
g10
Amountofremainingcamerafilm.Thisisalways00000
00000
g11
LastEnvelopeSerialNumber.Thisisalways00000
9-60

ExtendedSendSupplyCounters Theextendedmessageformat
supportsthereportingofuptoeightcoinhoppers.Thecountsare
groupedandseparatedbygroupseparators.
Table 9-26
Send Supply Counters: Extended
Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
g2
g3
transactionprocessedbytheSST.Ifthisdoesnotcorrespondtothe
lastTSNsentbyCentral,itmeansthatthetransactionhasnotbeen
initiatedandthecountershavenotbeenupdated.
g4
AccumulatedTransactionCount.Definesthetotalnumberof
detectedtransactionattemptssincetheSSTwasinstalledorthe
nonvolatileSSTmemorywaslastcorrupted.Thecountisresetto0
after9,999,999transactions.
TransactiongroupidA.
AtransactionattemptisdetectedwhenitisrecognisedthattheTSN
receivedfromCentralisdifferentfromthepreviouslyreceived
TSN.
GS
SeeTableNote67
GroupSeparator.
g5
SeeTableNote67
CardReaderdatagroupIDB
g6
CardsCaptured.Consistsofonefivedigitdecimalcountofthe
numberofcardscapturedsincethecountwasclearedbya
supervisortransaction.Thecountincludescardscaptureduptoand
includingthetransactiondefinedinfieldg3.
GS
SeeTableNote67
GroupSeparator.
g7
SeeTableNote67
CashHandler0datagroupIDC
g8
SeeTableNote67
andTableNote68
CassetteType.Consistsofonethreedigitidentifierofthecassette
typebeingreportedon.Theidentifiercanbebetween000and007
dependingonthecashhandlerconfiguration.
g9
SeeTableNote67
andTableNote68
NotesInCassettes.Consistsofafivedigitdecimalcountofthe
numberofnotesinthecassette.
9-61

Field
Number of
Characters
g10
Mandatory/Optional
Description
SeeTableNote67
andTableNote68
NotesRejected.Consistsofafivedigitdecimalcountofthenumber
ofrejectnotes.
Althoughfieldsg9andg10maynotbetotallyaccurate,thesum
ofthesecountsaccuratelyrepresentsthedifferencebetweenthe
originalnumberofnotesaddedandthenumberofnotesdispensed.
g11
SeeTableNote67
andTableNote68
NotesDispensed.Consistsofafivedigitdecimalcountofthe
numberofdispensednotes.
Ifatransactionisprematurelystoppedbyapowerfailure,these
countsareupdatedtoreflectthenumberofnotesdispensedupto
thetimeofpowerfailure.
g12
SeeTableNote67
andTableNote68
LastTransactionNotesDispensed.Consistsofafivedigitdecimal
countofthenumberofnotesdispensedduringthelasttransaction.
g13
SeeTableNote67,
TableNote68and
TableNote70
NotesDeposited.Consistsofafivedigitdecimalcountofthetotal
numberofdepositednotes.
GS
SeeTableNote67
GroupSeparator.
g14
SeeTableNote67
CashHandler1datagroupIDD
g15
SeeTableNote67
andTableNote68
CassetteType.Consistsofonethreedigitidentifierofthecassette
typebeingreportedon.Theidentifiercanbebetween000and007
dependingonthecashhandlerconfiguration.
g16
SeeTableNote67
andTableNote68
NotesInCassettes.Consistsofonefivedigitdecimalcountofthe
g17
SeeTableNote67
andTableNote68
ofrejectnotes.
Althoughfieldsg16andg17maynotbetotallyaccurate,thesum
ofthesecountsaccuratelyrepresentsthedifferencebetweenthe
originalnumberofnotesaddedandthenumberofnotesdispensed.
Thisisbecausenotespresentedbutnottakenandthenretractedare
senttotherejectbin.Inthisscenario,theNotesRejectedcountisnot
increased,buttheNotesInCassettescountisdecremented.
g18
SeeTableNote67
andTableNote68
Ifatransactionisprematurelystoppedbyapowerfailure,these
countsareupdatedtoreflectthenumberofnotesdispensedupto
thetimeofpowerfailure.
g19
SeeTableNote67
andTableNote68
9-62

Field
Number of
Characters
g20
Mandatory/Optional
Description
SeeTableNote67,
TableNote68and
TableNote70
NotesDeposited.Consistsofafivedigitdecimalcountofthe
GS
SeeTableNote67
GroupSeparator.
g21
SeeTableNote67
CoindispenserdatagroupIDE
g22
SeeTableNote67
andTableNote69
HopperTypeNumber.Consistsofonetwodigitidentifierofthe
hoppertypebeingreportedon.Theidentifiercanbebetween01
and08dependingonthecoinhopperconfiguration.
g23
SeeTableNote67
andTableNote69
CoinsRemaining.Consistsofafivedigitdecimalcountofthetotal
numberofcoinsremaininginthehoppertypeidentifiedinfield
g22.Thecountsaresetbysupervisorfunctionsandare
decrementedoneachdispensetransaction.Thesecountsarezeroif
notsetbyanAddCoinsorStdCoinssupervisorfunction.The
countissetto65535(thedecimalequivalentof0FFFFhex)ifmore
coinshavebeendispensedfromahopperthanithasbeensetto
contain,orifcoinsaredispensedfromahoppertypethathasnot
beenset.
g24
SeeTableNote67
andTableNote69
CoinsDispensed.Consistsofafivedigitdecimalcountofthetotal
numberofcoinsdispensedfromthehoppertypeidentifiedinfield
g22.Thiscountisconsistentwithcoincountsreportedsincethe
countswerelastclearedbyasupervisortransaction.
g25
SeeTableNote67
andTableNote69
LastTransactionCoinsDispensed.Consistsofafivedigitdecimal
countofthenumberofcoinsdispensedonthelasttransaction
processedbytheSST.ThisfieldallowsCentraltorecovercoin
countsafterpowerfailure,evenifthepowerfailureoccurredinthe
middleofadispenseoperation.
g26
SeeTableNote67,
TableNote69,and
TableNote70
CoinsDeposited.Consistsofafivedigitdecimalcountofthetotal
numberofcoinsdepositedfromthehoppertypeidentifiedinfield
g22.Thiscountisconsistentwithcoincountsreportedsincethe
countswerelastclearedbyasupervisortransaction.
GS
SeeTableNote67
GroupSeparator.
g27
SeeTableNote67
EnvelopeDepositorydatagroupIDF
g28
SeeTableNote67
EnvelopesDeposited.Consistsofonefivedigitdecimalcountofthe
numberofenvelopesdepositedsincethecountwaslastclearedbya
Supervisortransaction.Thecountincludesenvelopesdepositedup
toandincludingthetransactiondefinedinfieldg3.
g29
SeeTableNote67
LastEnvelopeSerialNumber.Thelastenvelopeserialnumberis
always00000.
GS
SeeTableNote67
GroupSeparator.
g30
SeeTableNote67
CameradatagroupIDG.
9-63

Field
Number of
Characters
Mandatory/Optional
Description
g31
SeeTableNote67
CameraFilmRemaining.Thecamerafilmremainingisalways
00000.
GS
SeeTableNote67
GroupSeparator.
g32
SeeTableNote67
DPMdatagroupIDH.Notsupported.
g33
SeeTableNote67
DepositBinIdentifier.Notsupported.
g34
SeeTableNote67
andTableNote97
DocumentsDepositedinBin.Notsupported.
GS
SeeTableNote67
GroupSeparator.
g35
SeeTableNote71
andTableNote72
BNACassetteCountsdatagroupIDI.
g36
SeeTableNote71,
TableNote72
andTableNote73
NDCCassetteType.Consistsofonethreedigitidentifier.The
identifiercanbebetween001and999.
g37
SeeTableNote71,
TableNote72
andTableNote73
TotalNotesInCassette.Consistsofafivedigitdecimalcountofthe
g38
SeeTableNote71,
TableNote72
andTableNote73
NumberofNoteTypesReported.Thisisavalueintherange000
to999
g39
SeeTableNote71,
TableNote72
andTableNote74
NoteTypeIdentifier.Thisisavalueintherange0001toFFFF
g40
SeeTableNote71,
TableNote72,
TableNote74and
TableNote75
Numberofnotesofthetypeidentifiedbythenotetypeidentifierin
fieldg39.Consistsofafivedigitdecimalcountofthenumberof
notesofanidentifiedtype.
GS
SeeTableNote67
GroupSeparator.
g41
SeeTableNote76
ChequeprocessordatagroupIDJ
g42
SeeTableNote76
andTableNote77
BinNumber
g43
SeeTableNote76
andTableNote77
Chequesdepositedinbin
GS
SeeTableNote67
GroupSeparator.
g44
SeeTableNote78
BNAEmulation(andExtendedEmulation)depositdatagroupID
K
g45
SeeTableNote78
andTableNote79
TotalNotesRefunded
9-64

Field
Number of
Characters
g46
Mandatory/Optional
Description
SeeTableNote78,
TableNote79and
TableNote82
TotalNotesReturnedRejected
g47
SeeTableNote78
andTableNote79
TotalNotesEncashed
g48
SeeTableNote78
andTableNote79
TotalNotesEscrowed
GS
SeeTableNote67
GroupSeparator.
g49
SeeTableNote67,
TableNote70and
TableNote80
DualDispensercombineddatagroupIDl
g50
SeeTableNote73
CassetteType.Consistsofonethreedigitidentifier.Theidentifier
canbebetween001and007dependingonthecashhandler
configuration.
g51
SeeTableNote73
NotesinCassette.Consistsofafivedigitdecimalcountofthe
g52
SeeTableNote73
ofrejectnotes.
g53
SeeTableNote73
g54
SeeTableNote73
g55
SeeTableNote73
andTableNote81
NotesDeposited.Consistsofafivedigitdecimalcountofthe
GS
SeeTableNote67
GroupSeparator.
g58
SeeTableNote71
ECB6Category2NotesdatagroupIDN
NotsupportedbyAdvanceNDC.
g59
SeeTableNote71
andTableNote73
NDCCassetteType.Consistsofonethreedigitidentifierofthe
cassettetype.Theidentifiercanbebetween001and999depending
onthecashhandlerconfiguration.
g60
SeeTableNote71
andTableNote73
TotalNumberCategory2Notes.Consistsofafivedigitdecimal
countofthenumberofdepositednotesidentifiedascounterfeit
underECB6.
g61
SeeTableNote71
andTableNote73
NumberofReportedCategory2NoteTypes.Consistsofa
threedigitcountofthenumberofdepositednotetypesbeing
reportedascounterfeitunderECB6.Thecountcanbebetween000
and999.
9-65

Field
Number of
Characters
g62
Mandatory/Optional
Description
SeeTableNote71
andTableNote74
Category2NoteTypeIdentifier.Consistsofonefourdigitidentifier
ofthenotetypereportedascounterfeitunderECB6.Theidentifier
canbebetween0001andFFFF.
g63
SeeTableNote71
andTableNote74
Category2Notes.Consistsofafivedigitdecimalcountofthetotal
numberofnotesofthenotetypeinfieldg62identifiedas
counterfeitunderECB6.
GS
SeeTableNote67
GroupSeparator.
g64
SeeTableNote71
ECB6category3notesgroupdataidO
NotsupportedbyAdvanceNDC.
g65
SeeTableNote71
andTableNote73
NDCCassetteType.Consistsofonethreedigitidentifierofthe
cassettetypebeingreportedon.Theidentifiercanbebetween001
and999dependingonthecashhandlerconfiguration.
g66
SeeTableNote71
andTableNote73
TotalNumberCategory3Notes.Consistsofafivedigitdecimal
countofthenumberofdepositednotesidentifiedascategory3
underECB6.
g67
SeeTableNote71
andTableNote73
NumberofReportedCategory3NoteTypes.Consistsofa
threedigitcountofthenumberofdepositednotetypesbeing
reportedascategory3underECB6.Thecountcanbebetween000
and999.
g68
SeeTableNote71
andTableNote74
Category3NoteTypeIdentifier.Consistsofonefourdigitidentifier
ofthenotetypereportedascategory3underECB6.Theidentifier
canbebetween0001andFFFF.
g69
SeeTableNote71
andTableNote74
Category3Notes.Consistsofafivedigitdecimalcountofthetotal
numberofnotesofthenotetypeidentifiedinfieldg62identifiedas
category3underECB6.
GS
SeeTableNote67
GroupSeparator.
Table Note 67:Fieldsarearrangedingroups.Thegroupsincluded

inthemessagedependonthepresenceofdevicesintheSST.When
agroupispresent,allcountsofthatgroupareincludedandthe
groupisterminatedbyagroupseparator.Infuturereleases,new
groupsmaybeaddedandnewcountsaddedtotheendofexisting
groups.
Table Note 68:Fieldsg8tog13andg15tog20arerepeatedforeach
cassettetypepresentinthedispenser.Theywillberepeatedeither
fourorseventimesdependingonthesettingofEnhanced
Table Note 69:Fieldsg22tog26arerepeatedforeachconfigured
hoppertypeinthecoindispenser.
9-66

Table Note 70:Thesefieldsusedonlyondevicesthatcanrecycle

depositeditems.
Table Note 71:ThesefieldsareincludedinEnhancedCashDeposit
mode.
Table Note 72:Thesefieldsareincludedwhenbit3ofEnhanced
Configurationoption45issetandEnhancedCashDepositisnot
enabled.Fordetailsofoption45,seeOption45BNASettingson
page 714.
Table Note 73:Fieldsg36tog38,g49tog55andg58tog69are
repeatedforeachNDCcassettetype.
Table Note 74:Fieldsg39andg40andg58tog69arerepeatedfor
eachNoteTypeIdentifierwithineachcassette.Thesefieldsarenot
presentiftherearenonotesinthecassette.
Table Note 75:Fieldg40includesallnotesidentifiedascategory2,
category3,orcategory4underECB6.
Table Note 76:Fieldsg41tog43areonlyincludedwhenacheque
processorispresent.
Table Note 77:Fieldsg42andg43reportthenumberofcheques
storedineachbin.
Table Note 78:Fieldsg44tog48areonlyincludedinBNA
Emulationmodes.
Table Note 79:Fieldsg45tog48containthecountsforallnotetypes.
Table Note 80:Fieldsg49tog55areincludedonlywhendualcash
handlersareemulatingasinglecashhandlerasdefinedby
enhancedconfigurationoption76.Fordetailsofoption76,see
Option76CashHandlersonpage 719.
Table Note 81:Fieldg55isusedonlyifrecyclingisenabled.If
recyclingisnotenabled,thisfieldcontains00000.
Table Note 82:Notesreturnedtothecardholderwithoutbeing
processedareunknownunderCENXFS.
9-67

SendTallyInformation
FromAdvanceNDC2.06onwards,tallyreportingisnotsupported.
AdefaultmessageissenttoCentralinresponsetoaSendTally
GroupTerminalCommandmessage(acommandcodeof5).
Thedataisalwaysasshowninthefollowingtable:
Table 9-27
Send Tally Information Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
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
9-68

SendErrorLogInformation
Note:FromAdvanceNDC2.06onwards,errorlogreportingis
notsupported.AdefaultmessageissenttoCentralinresponsetoa
SendErrorLogGroupmessage(acommandcodeof6)
Thedataisalwaysasshowninthefollowingtable:
Table 9-28
Send Error Log Information Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
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)
9-69

SendDate/TimeInformation
DateAndTimemessage(acommandcodeof8).Fordetails,see
theTerminalCommandssectionofChapter 10,Centralto
TerminalMessages.
Table 9-29
Send Date/Time Information Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
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.
9-70

SendConfigurationID
ConfigurationIDterminalcommandmessage(acommandcodeof
3).Fordetails,seetheTerminalCommandssectionof
Table 9-30
Send Configuration ID Response
Field
Number of
Characters
Mandatory/Optional
Description
g1
g2
ConfigurationID.ContainsthelastfourdigitconfigurationID
number(00009999)senttotheSSTfromCentral.
9-71

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-31
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
NightSafe
CardBeforeCash
CardReader/Writer,Cash
Handler,CoinDispenser
FastCash
CashHandler,Coin
Dispenser
CardBeforeParallelDispenseand
Print
CardReader/Writer,Cash
Handler,CoinDispenser
StatementPrinterand
Receiptinsidewaysmode
PrintStatementandSetNextState
StatementPrinterand
Receiptinsidewaysmode
Refund
BunchNoteAcceptor
9-72

DeviceFaultStatus
InformationField
Device Faults
Encash
BunchNoteAcceptor
ProcessCheque
ProcessMultipleCheques
WhentheStatusDescriptoris8DeviceFault,theinformation
giveninTable 932ispresentintheStatusInformationfield.Inthe
NumberofCharacterscolumn,anumberinbracketsindicatesthe
maximumfieldlength.
Thedatareturnedinthefieldsisvariableinlengthasitisdifferent
foreachdevice,buteachdevicewillalwayssendthesamenumber
ofcharacters.Fordetails,seeFitnessDataonpage E19.
Table 9-32
Device Fault Status Information Field
Field
Number of
Characters
Mandatory/Optional
Description
g1
DeviceIdentifierGraphic(DIG).Thedeviceidentifier.
g2
Var(17)
TransactionStatus.Containsinformationrequiredtomakea
transactioncompletiondecision.
FS
SeeTableNote83
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.
9-73

Field
Number of
Characters
Mandatory/Optional
Description
Fatal.Thiscodeindicatesthatthedeviceisoutofserviceand
willcontinuetoreportfatalerroruntiloperatorintervention
attheterminal.Itisrecommendedthattheterminalisput
outofserviceorthattransactionsinvolvingthefaultydevice
arenotallowed.
FS
SeeTableNote83
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 975forthe
MStatusreporting.
Characters3ton(MData)containdetaileddiagnosticinformation
relatedtothedevice.Eachbyteistransmittedastwocharacters.
Thesegivethehexadecimalrepresentationofthevalueofthebyte.
Note:Thedatareturnedfordevicesishardwaredependent,except
fortheEJprinter,wherethedataisapplicationdriven.
Note:WhereanEPPispresent,thedatareturnedinthisfieldisof
theformat00mm.00isalwaysreturnedincharacters1and2,andmm,
incharacters3ton,containsthevaluefrombyte0oftheTdata.
FS
SeeTableNote83
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.
9-74

Field
Number of
Characters
Mandatory/Optional
Description
MediaOut.
Overfill.Thecontainerhassensedafullconditionand
shouldbeemptied.
Ifthisfieldisomitted,itcanbeassumedthatthereisnonewstate
onanycontainer.
Table Note 83:Includedifanyofthesubsequentfieldsarepresent.

Asthefieldlengthsmaychangewiththehardwarebeingused,
Centralshouldnotattempttoanalysethesefieldsbyallocatinga
fixedlengthtoeachdevice.Insteadfieldlengthsshouldbe
determinedbysearchingfortheFS(fieldseparator)characters.
GBRUtoCDMMStatusMapping
ForaGBRUdeviceusedasacashdispenser,youcanchooseto
reporttheMStatus(fieldg4)asaCDMorasaGBRU.Thisisset
usingEnhancedConfigurationoption78;fordetailsseeOption78
GBRUMStatusReportingonpage 720.
ToreportthestatususingtheCDMMStatus,theGBRUMStatusis
mappedtoanequivalentCDMMStatus.
9-75

Other Solicited Messages
OtherSolicitedMessages
Othersolicitedmessagesthatcanbesentfromtheterminalto
Centralareasfollows:
EncryptorInitialisation
Data
UploadEJDataMessage
Thismessageclass/subclassisusedwheninitialisingtheencryptor
module,andisusedinasimilarwaytotheterminalstatemessage.
However,itdoesnotcontainanyofthefieldsassociatedwith
messageauthentication,andisthereforesuitablefortheinitial
exchangeofdatarequiredtoinitialisetheencryptor.
ThissolicitedmessageisreturnedinresponsetoanExtended
EncryptionKeyChangemessage,describedinExtended
EncryptionKeyChangeonpage 1037.
Table 9-33
Encryptor Initialisation Data Response
Field
Number of
Characters
Mandatory/Optional
Description
Var
2Solicitedmessage.
3EncryptorInitialisationData.
FS
FieldSeparator
3or9
transmittedtotheterminalinaConfigurationParametersLoad
message.Thedefaultis000.Ifthedatasecurityfeatureisconfigured,
anadditionalsixcharactersarepresent.Thesecontainthesecurity
terminalnumber.
FS
FieldSeparator
FS
FieldSeparator
InformationIdentifier.Identifiesthetypeofinformationsent,as
follows:
1
EPPserialnumberandsignature
EPPpublickeyandsignature
9-76

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(SNEPP)
320
EPPSerialNumberSignature,createdusingtheRSANCRkey,
(SNEPP)*NCRSK,andbase94encoded.ForfurtherdetailsofEPP
authenticationandbase94encoding,seeEPPAuthentication
Processonpage 1121andBase94EncodingandDecodingon
page 1130.
320
EPPPublicKey(PKEPP),base94encoded.
TheexponentoftheEPPPublicKeyisalways65537,andis
thereforenotsenttoCentral.
320
EPPPublicKeySignature,createdusingtheRSANCRkey,(PKEPP)*
NCRSK,andbase94encoded.ForfurtherdetailsofEPP
authenticationandbase94encoding,seeEPPAuthentication
Processonpage 1121andBase94EncodingandDecodingon
page 1130.
6or72
NewKVVforkeyjustloadedorreactivated
9-77

Field
Number of
Characters
Mandatory/Optional
Description
KeysStatus,containingKVVsasfollows:
6
MasterKeyKVV
CommunicationsKeyKVV
MACKeyKVV
BKeyKVV
Ifakeyhasnotbeenloaded,itsKVVwillbesixzeroes.
IfthehardwaredoesnotallowaKVVtobegenerated,6spaces(0x20)
willbereported
Note:CentralshouldacceptavariablelengthKeyStatusfield,incase
newkeysneedtobeaddedinthefuture.
FordetailsofthecalculationofKVVs,seeKeyVerificationValues
onpage 1117.
ForKeyLoaded,thisfieldisabsent.
KeyEntryMode,asinglecharacterintherange1to4describingthe
keyentrymode,asfollows:
1
SinglelengthwithoutXOR
SinglelengthwithXOR
DoublelengthwithXOR
Doublelength,restricted.
WhenInformationIdentifier=7
3
Binarydatalength
Var
RSAKVVbase94encoded
3
Binarydatalength
Var
SSTcertificatebase94encoded
Var
SSTrandomnumber,ASCIIhexadecimalencoded.
ThismessageisnotrequiredintheBasicSignatureRemoteKey
LoadingSchemeandifreceived,willberejectedwithaspecificreject
codeofE02.
9-78

Field
Number of
Characters
Mandatory/Optional
Description
WhenInformationIdentifier=A
6
KVVofnewDESkey
Binarydatalength
Var
KeyLoadAcknowledgementPacket,base94encoded
SeeTableNote84
WhenInformationIdentifier=B
2
RemoteKeyProtocol.Theremotekeyschemecapabilitiesreportedas
abitmap.Thisisatwodigitdecimalvaluedefinedasfollows:
Bit0
Ifset,theEPPsupportstheSignatureScheme
Bit1
Ifset,theEPPsupportstheCertificateScheme
Bit2
Ifset,theEPPsupportstheEnhancedSignatureScheme
Bits
37
Reservedandmustbe0
Examplesareasfollows:
00
None
01
Signature
02
Certificate
03
Signatureandcertificate
04
Enhancedsignature
06
Enhancedsignatureandcertificate
Certificatestate
00Notreadyornotsupported
01Certificateprimary
02Certificatesecondary
EPPVariableLengthSerialNumberCapability
SeeTableNote85
0
VariablelengthEPPserialnumbersnotsupported
SeeTableNote86
VariablelengthEPPserialnumberssupported
SeeTableNote87
WhenInformationIdentifier=C
ForKeyDeleted,thisfieldisabsent
WhenInformationIdentifier=D
9-79

Field
Number of
Characters
Mandatory/Optional
Description
EPPattributesaredefinedasfollows:
1
Var
EPPVendorCompanyNameIdentifier
AlphanumericcharactersthatdefinetheEPPvendorcompany
nameasregisteredwithPCI
GroupSeparator
Var
EPPModelIdentifierDataIdentifier
AlphanumericcharactersthatdefinetheEPPmodelidentifier
asregisteredwithPCI
GroupSeparator
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 84Thekeyloadacknowledgementpacketis

summarisedasfollows:
(Sign(SKSST)[RHost||RSST||IHost])
Thisisinterpretedasfollows:
SKSST
=SSTsverificationsecretkey
9-80

RHost
=Hostsrandomnumber
RSST
=SSTsrandomnumber.
IHost
=Hostidentifier
Table Note 85Anumberofmessageswereoriginallydefinedwith

an8bytefixedlengthfieldfortheEPPserialnumber.However,8
bytesarenotsufficientforEPPsfromsomevendors.Thisfield
reportswhethervariablelengthserialnumbersaresupported.
WhenvariablelengthEPPserialnumbersaresupported,NCR
recommendsthatthehostusesvariablelengthvariantsof
messages.
Table Note 86:IfvariablelengthEPPserialnumbersarenot
supported,thefollowingconditionsapply:
OnlyEPPswith8byteserialnumberscanbesupported
TheEPPserialnumbercanonlyberequestedthroughthe
ExtendedEncryptionKeyChange(EEKC)commandwitha
modifierofF(theresponseisDataIdentifier1).
Table Note 87IfvariablelengthEPPserialnumbersaresupported

thefollowingapply:
UploadEJDataMessage
EPPswithanylengthofserialnumbercanbesupported
TheEPPserialnumbercanberequestedthroughtheEEKC
commandwithamodifierofF(theresponseisDataIdentifier
1).ThisworksonlyonEPPswith8byteserialnumbers.
TheEPPserialnumbercanberequestedthroughtheEEKC
commandwithamodifierofV(theresponseisDataIdentifier
E).ThisworksonEPPswithserialnumbersofanylength.
TheSSTsendsthissolicitedmessagetoCentralinresponsetoanEJ
Command,takingthedatafromthefileejdata.loginthec:\program
files\ncraptra\advancendc\datadirectoryontheSST.Apointeris
maintainedinpersistentmemorytoindicatethelocationofthenext
blockofdatatobeuploaded.Anybinaryzerosintheelectronic
journaldataarereplacedwithanASCIIquestionmark(?)character
beforetheuploaddataissent.
Thesizeoftheelectronicjournaldatablocksthataresentineach
uploadmessagecanbesetintheEJOptionsandTimerscommand.
FordetailsofEJOptionsandTimersandacknowledgement
messages,seetheEJCommandsonpage 1091.
TheSSTwillcontinuetouploadEJdatablocksaslongasan
acknowledgementmessageisreceivedfromCentralforeach
messagesent.Ifanacknowledgementisnotreceivedwithinthe
9-81

timespecifiedbytimer60,theSSTwillresendthecurrentblockup
tothemaximumnumberofretriessetintheEJOptionsandTimers
message.WhenallEJdataisuploaded,thedataisdeletedfromthe
ejdata.logfile.
TheSSTwillonlysendanUploadEJDatamessage,orprocessanEJ
command,wheninOutofServicemodeorInServicemodewhen
thereisnotransactioninprogress.UploadEJDatamessageswill
notbesentwhentheSSTisinSupervisormode.AnyEJdata
accumulatedintheEJfileejdata.logwhiletheSSTisinSupervisor
modewillbesentatthenextopportunity.
Note:TheSupervisorfunctionINITEJRNLshouldnotbe
performedduringEJupload.Formoreinformation,refertothe
APTRAAdvanceNDC,SupervisorsGuide,Chapter3,Replenish
Menu.
Table 9-34
Format of the Upload EJ Data Message
Field
Number of
Characters
Mandatory/Optional
Description
Var
6ElectronicJournal.
1UploadData.
FS
FieldSeparator
FS
FieldSeparator
FS
FieldSeparator
FS
FieldSeparator
MachineNumber.Range000000to999999.
Date.Range000000to999999intheformatYYMMDD.
Datetheblockwassent,determinedbytheSSTsinternalclock.
Time.Range000000to999999intheformatHHMMSS.
Timetheblockwassent,determinedbytheSSTsinternalclock.
LastCharPreviousBlock.
Range000000to999999.SeeTableNote88.
9-82

Field
Number of
Characters
Mandatory/Optional
Description
LastCharThisBlock.
Range000000to999999.SeeTableNote88.
TheSSTcomparestheLastCharacterReceivedfieldinthe
acknowledgementmessagesentfromthehostwiththeLastCharThis
BlockfieldofthelastUploadEJDatamessageitsenttotheHost.If
thesetwovaluesarenotthesame,theacknowledgementmessageis
ignored.Formoredetails,seetheEJCommandssectionin
TheLastCharacterPreviousBlockfieldcanbeusedbythehostto
checkonthereceivedmessage.
BlockLength.Range001350.Defaultis200.
SetusingtheEJOptionsandTimerscommandmessage;onlythelast
datablocksenttothehostshouldbelessthanthisblocklength.
Var
ResponseData.Range001350asspecifiedbyFieldi.Uploaddata
consistsofASCIItextwithacarriagereturn(CR)attheendofeach
line.Linesareamaximumof40characters.SeeTableNote89.
Table Note 88:TheLastCharPreviousBlockandLastCharThis

Blockvaluesarebasedonamodulus1,000,000charactercount
whichstartsatzerofollowingacoldstartoftheSST.Thecountis
incrementedforeachcharacterwrittentotheelectronicjournal.The
countisnotresetforawarmstart,thatis,apowerfailorreset
duringwhichthepersistentmemoryispreserved.
Table Note 89:Ifthelastblocklengthattheendoffileislessthan
specifiedinFieldi,thatlengthwillbereturned.
9-83

Unsolicited Status Messages
Unsolicitedstatusmessagesareusedtoreportanychangeof
conditionattheSST,suchasthefollowing:
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.
9-84

Table 9-35
Unsolicited Status: Message Format
Field
Number of
Characters
Mandatory/Optional
Description
Var
1Unsolicitedmessage.
2Statusmessage.
FS
FieldSeparator
3or9
SeeTableNote90
transmittedtotheSSTinaConfigurationParametersLoadmessage.
Thedefaultis000.Ifthedatasecurityfeatureisconfigured,an
additionalsixcharactersarepresent.Thesecontainthesecurity
terminalnumber.
FS
FieldSeparator
FS
FieldSeparator
Var
StatusInformation.Thecontentofthisfieldvariesaccordingtothe
messagemodeselectedatinstallationtime.SeeTable936.
Var
Table Note 90:Inpowerupstatusmessages,thisfieldcontains

eithertheLUNOthathasbeenpreviouslydownloaded,or000.
UnsolicitedStatus
InformationField
Oneofthefollowingconditionsmustbesatisfiedbeforean
unsolicitedmessageissent:
9
Devicestatusisnonzero
Errorseverityis2(warning)orgreater
Suppliesstatusis2,3,or4.
Aroutineerrordoesnotgenerateanunsolicitedstatusmessage.
ThefollowingtableshowsthestructureoftheStatusInformation
fieldinunsolicitedstatusmessages.
9-85

Table 9-36
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
SeeTableNote91
FieldSeparator
e3
Var(14)
ErrorSeverity.Asg3inSolicitedmessages.
FS
SeeTableNote91
FieldSeparator
e4
Var
DiagnosticStatus.Asg4inSolicitedmessages.
FS
SeeTableNote91
FieldSeparator
e5
Var(8)
SuppliesStatus.Asg5inSolicitedmessages.
e6
Var
Additionaldataspecifictodevicemessage.Canbeusedtoreport
thecardnumberofacapturedcard.
Table Note 91:Thisfieldseparatorisincludedifanyofthe

followingoptionalfieldsthatfollowitareincluded.
9-86

Device Status Information
DeviceStatusInformation
Solicitedorunsolicitedstatusinformationcanbereportedfor
devicesasdescribedinthefollowingsections.
Forinformationonthejournallingthatoccurs,refertotheAPTRA
TimeOfDayClock
(Unsolicited)
ThismessageindicatesthattheTimeofDayClockisnotavailable.
CentralcaneitherkeeptheSSToutofserviceorreturnittoservice.
9
Table 9-37
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
TerminalCommandmessagetoputtheSSTinservice
9-87

Table 9-38
Power Failure Status
Field
No. of Characters
Content
e1
DeviceIdentifierGraphicB.
e2
DeviceStatus.Thiscontainstheconfigurationidentificationnumber(00009999)of
thecustomisationdatastoredondisk.Centralcanusethisinformationtocheckifa
downloadisneededbeforeputtingtheSSTinservice.Avalueof0000indicatesthat
adownloadmustbeperformed.
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-39
Card Reader/Writer Status
Number of
Characters
Content
g1/
e1
DeviceIdentifierGraphicD.
g2/
e2
Transaction/DeviceStatus.Givesdetailsofanytransactionrelatedexceptioncondition
detectedwhileprocessingacardattheSST.Possiblevaluesare:
Field
Sol/
Unsol
Code
Description
Notransactionexceptionconditionoccurredbutconsultotherfieldsfor
errorseverity,diagnosticstatusorsuppliesstatuschanges.
S/U
Thecardholderdidnottakehiscardwithintheallowedtimeanditwas
capturedorjammed.
9-88

Field
Number of
Characters
Content
S/U
Themechanismfailedtoejectthecard,whichwaseithercapturedor
jammed.
S/U
Themechanismfailedtoupdatetherequestedtracksonthecard.
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 92:Ifacardjamsduringacaptureoperation,multiple

unsolicitedmessagesaresent.Thefinalmessagewillhaveadevice
statusof1althoughtheprecedingmessagesmayhaveadevice
statusof0.
Table Note 93:IfEnhancedConfigurationoption41issettoinclude
datareadfromacardwhenretracted,allthemagnetictrackdetails
areincludedinthestatusmessage.Ifthisdataistobeincluded,the
fieldsdescribedinTable 940,AdditionalTrackDataonCard
Retractareaddedtothemessage.
Table 9-40
Additional Track Data on Card Retract
Field
Number of Characters
Content
FS
Fieldseparator
e600
Var(78)
Track1data
GS
Groupseparator
9-89

CashHandler
Field
Content
e601
Var(39)
Track2data
GS
Groupseparator
e602
Var(106)
Track3data
Thismessagegivesdetailsofadispenseoperationinresponsetoa
TransactionReplycommandmessage.
9
TheformatdependsonthesettingofEnhancedConfiguration
option76,asdescribedinTable 941below.WhenEnhanced
Configurationoption76issetto001,thecountsandstatusfields
reportcassettetypesinnumericalorder.
Fordetailsofthestatusandsuppliesreportedwhencassettesare
replenishedduringdeposits,seeCassetteReenabledDuring
DepositTransactionsonpage 994.IfOptionDigit4Aisset,a
solicitedstatusmessageisreturnedwhennotesaresuccessfully
retracted.Fordetailsofoptiondigits,refertotheAPTRAAdvance
Table 9-41
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.
9-90

Field
Number of
Characters
Content
Nonotesdispensedorcardnotejected.Thisstatusisreturnedona
cardbeforecashtransactionifthestackoperationfailsandthenotes
arepurgedpriortocardeject.
S/U
Somenoteshavebeenretractedwhenthenoteswerenottaken
followingaPresenttimeout.Thenumberofnotesretractedis
unknown.
SeeTableNote100
WhenEnhancedconfigurationoption76issetto000,thecountsarereportedasfollows:
Characters29(Tdata)containnotesdispensedcounts.Eachpairofcharacters
representsatwodigitdecimalvalueintherange0099foraparticularcassettetype.
Characters
Cassette Types
23
45
67
89
1
2
3
4
9-91

Field
Number of
Characters
Content
Thefollowingoptionalcharacters1017areonlyvalidforaspraycashdispenser,and
containacountofnotesdispensedtothecardholderplusnotesinanunknownlocation.
Eachpairofcharactersrepresentsatwodigitdecimalvalueintherange0099fora
particularcassettetype.
Thedefaultmessageformatdoesnotincludethesecharacters.Theextrafieldsare
enabledinOptionDigit4C.Fordetailsofoptiondigits,refertotheAPTRAAdvance
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
Characters
Cassette Types
1617
1819
2023
2425
2627
2829
3031
1
2
3
4
5
6
7
9-92

Field
Number of
Characters
Content
g3/e3
5or8
ErrorSeverity.Usedtomakeashutdowndecision.
Character0
Severityinformationrelatedtocompletedevice
Character1
Severityrelatedtocassettetype1
Character2
Character3
Character4
Ifenhancedconfigurationoption76issetto001,theerrorseverityisreportedforthe
furthercassettesasfollows:
Character5
Character6
Character7
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.
SeeTableNote95
Character0
stateofrejectbin
Character1
stateofcassettetype1
Character2
Character3
Character4
IfEnhancedConfigurationoption76issetto001,thesuppliesstatusisreportedforthe
furthercassettesasfollows:
Character5
Character6
Character7
9-93

Field
Number of
Characters
Content
Codesforcharacters1to7are:
Code
Description
Nonewstate(cassettenotaccessedorstateunknownbecauseofafatal
hardwaremalfunction).
SeeTableNote96
Sufficientnotes.
Noteslow.
Outofnotes.
Codesforcharacter0are:
Code
Description
Nonewstate(cassettenotaccessedorstateunknownbecauseoffatal
hardwaremalfunction).
SeeTableNote96
Nooverfillcondition.
Overfillcondition.
Note: Ifanattemptismadetodispensenotesfromacassettetypethatisnotinstalled,a
suppliesstatuscodeof3isreturned.
Table Note 94:Foraspraydispenserthenotesdispensedcountsare

significant.Forexample,thecardholdermayhavereceivedsome,
butnotall,requestednotesduetoanerrorcondition.Inthiscase,
thesearecountsofthenotesdeliveredtothecardholder.However,
ifthenotesstickinthetransport,thesecountersdisplaythenumber
ofnotesrequestedandnotthenumberdelivered.
Table Note 95:Whennotesareretracted,thesuppliesstatusofall
cassettesisincludedintheunsolicitedmessageandjournaled.
Table Note 96:Bydefault,thesupplystatusreportedforrepeated
transactions,isthatofthecassettereferencedbythetransaction.If
thestatusremainsthesameastheprevioustransaction,itdoesnot
changeto0(nonewstate).Thepurgebinneverreports0.
Reportingoftheactualstatusofallcassettescanbeconfigured
throughtheregistry.Fordetailsoftheregistrysetting,refertothe
CassetteReenabledDuringDepositTransactions
Arecyclingcassettepreviouslyreportedasoutofnotescanbe
replenishedduringadeposittransaction.Whenthisoccurs,the
9-94

cassetteisreenabledfordispensingandthefollowinginformation
isreportedinanunsolicitedstatusmessage:
TheTransaction/DeviceStatus(fieldg2)reportsasuccessful
operation(0)andboththedispensedandpresentedcounts
reportzero
TheErrorSeverity(fieldg3)reportsthecurrentcashhandler
severityvalues
TheDiagnosticStatus(fieldg4)reportsnoerror(00)
TheSuppliesStatus(fieldg5)reportsthefollowing:
Updatedsupplyvaluesforanysupplystatusthathas
changed
Nochange(0)foranysupplystatusthathasnotchanged.
Thismessagegivesdetailsofadepositoperationinresponsetoa
TransactionReplyCommandmessage.
Depository
Table 9-42
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.
9-95

Field
Number of
Characters
g5/e5
Content
SuppliesStatus.Indicatesthestateofthedepositbin.Thisfieldisnotsentwiththe
messagewhenadeposittimeoutoccurs.Statesreportedare:
Code
Description
Noenvelopedeposited
Nooverfillcondition
Overfilldetected
ReceiptPrinter
Thismessageindicateswhetherornotaprintoperationhasbeen
successfullycompleted.Asolicitedstatusmessagemaybesentin
responsetothefollowingTransactionReplycommandsifsideways
printinghasbeenrequested:
PrintStatementandSetNextState.
Table 9-43
Receipt Printer Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphicG.
e2
Transaction/DeviceStatus.Indicateswhetherornottheprintwassuccessfullycompleted.
e3
e4
Var(2)
Var
Sol/
Unsol
Code
Description
Successfulprint
S/U
Printoperationnotsuccessfullycompleted
Devicenotconfigured
Cancelkeypressedduringsidewaysreceiptprint
Receiptretracted
ErrorSeverity.Standardcodeusedtomakeashutdowndecision.
Holdstheseverityinformationaboutthereceiptprinterandcapturebin.
Byte/char1
ReceiptPrinter
Byte/char2
CaptureBin
Bydefault,notreported;canbeincludedthroughtheregistry
Fordetails,refertoChapter5,ConfiguringAdvanceNDCand
AssociatedComponentsintheAPTRAAdvanceNDCDevelopersGuide
9-96

Field
Number of
Characters
e5
Content
SuppliesStatus.Indicatesthestatusoftheprinterpaper,ribbon,printhead,knifeand
capturebin.Thecapturebinseverityandsupplieswillbereportedas0,iftheprinter
doesnothaveacapturebin.
Char
Code
Description
Sufficientpaper
Paperlow
Paperexhausted
RibbonOK
Ribbonreplacementrecommended
Ribbonreplacementmandatory
PrintheadOK
Printheadreplacementrecommended
Printheadreplacementmandatory
KnifeOK
Knifereplacementrecommended
CapturebinOK
Capturebinoverfill
Whenapaperexhaustedconditionisdetected,andcapturebinstatusisreported,the
statusmessageis:
TransactionStatus=0
ErrorSeverity=40
SuppliesStatus=31111
(Ribbon,printhead,knifeandcapturebinareOK).
JournalPrinter
(Unsolicited)
completedsuccessfully.FromAdvanceNDC2.06onwards,
continuousmessagingoffataljournaldevicestatusissetandcannot
bechanged.
Note:Althoughnoknifeispresentonthe40columnjournal
printer,astatusof1(knifeOK)isalwaysreturnedinany
unsolicitedstatusmessage,asacommonformatisusedacrossall
the40columnprinters.
9-97

Table 9-44
Journal Printer Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphicH.
e2
1or25
Transaction/DeviceStatus.Indicateswhetherornottheprintwassuccessfully
completed.
SeeTableNote97,TableNote98,andTableNote99.
Sol/
Unsol
Code
Description
Successfulprint
Printoperationnotsuccessfullycompleted
Devicenotconfigured
Journalprinterbackupactivated
Journalprinterbackupandreprintterminated
Journalprinterbackupreprintstarted
Journalprinterbackuphalted
Journalprinterbackuplogsecurityerror
Journalprinterbackupreprinthalted
<
Journalprinterbackuptamperstateentered
e3
e4
Var
e5
SuppliesStatus.Indicatesthestatusoftheprinterpaper,ribbonandprinthead.
Char
Code
Description
Sufficientpaper
Paperlow
Paperexhausted
RibbonOK
9-98

Field
Number of
Characters
Content
PrintheadOK
KnifeOK
Whenapaperexhaustedconditionisdetected,thestatusmessageis:
TransactionStatus=0
ErrorSeverity=4
SuppliesStatus=3111
(RibbonandprintheadareOK;knifeisalwaysOK).
Table Note 97:Ifthetransactioncodeis:,JournalPrinterbackupis

operational,andthevalueofEnhancedConfigurationParameter
option22is2,thefollowingextradataissent:
AnASCIIdigitstringwithaformatof
*XXX*dd/mm/yy*hh:mm*YYYY,asfollows:
XXX
thelastprintedSecurityTraceNumber
dd/mm/yy hh:mm therecorddateandtime

YYYY
therecordnumberrelativetothelast
printedSecurityTraceNumber
Table Note 98:Ifrequired,supervisormessagemodeoption12can

beusedtoreportajournaloutstatusaslow.Formoreinformation,
Table Note 99:AsinNDC+,whennojournalprinterisconnectedto
theSSTandtheEJhasnotbeenactivated,nounsolicitedmessageis
senttothehosttoindicatethatthejournalisnotconfigured.
ElectronicJournalPrinter
(Unsolicited)
completedsuccessfully.
9
Note:Ifcutoverautomaticinitialisationisinuse,thismessage
shouldnotbereturnedwhentheEJfilereaches90%or100%full.As
cutoverperformsaninitialisationoperationwhentheEJfilereaches
90%full,the100%fullmessageisreturnedonlyifthecutover
operationfails.Forinformationonenablingcutover,refertothe
9-99

Table 9-45
Electronic Journal Printer Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphicH.
e2
Transaction/DeviceStatus.Indicateswhetherornottheprintwascompletedsuccessfully.
SeeTable
Note100.
Sol/
Unsol
Code
Description
Successfulprint
Printoperationnotcompletedsuccessfully
Devicenotconfigured.Bydefaultthiscodeissuppressed.Formore
information,refertotheAPTRAAdvanceNDC,DevelopersGuide.
EJindualmodeprintoperationsuccessful
>
EJindualmodeprintoperationnotsuccessful
e3
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
9-100

Field
Number of
Characters
Content
Whenanelectronicjournallogspacelowconditionisdetected,thestatusmessageis:
TransactionStatus=0
ErrorSeverity=2
SuppliesStatus=2111
Table Note 100:Ifoption35intheEnhancedConfiguration

Parametersload(seepage 1019)issetto001(reportEJindual
modeunsolicitederrors)or002(reportEJandhardcopybackupin
dualmodeunsolicitederrors)andboththejournalprinterandthe
EJareinerror,twounsolicitederrorswillbereported:oneforthe
physicaldeviceandonefortheEJ.Iftheoptionissettothedefault
of000,onlythephysicaldevicewillbereported.Thefollowingtable
liststhemessagesequencesreturnedfordualmodeforeachtype.
Table 9-46
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
Papersuppliesareloworout
H1
Printoperationfailed
Sentwhentheprintoperationis
unsuccessful
H=
EJprintoperation
succeeded
Sentinadditiontomessagesforphysical
journal.EJisnearlyfull
H>
EJprintoperationfailed
EJisfull
Note:Nomessagesaresentfromhard
copybackup
002
EJand
hardcopy
backup
H0
Papersuppliesarelow
H6
Journalprinterbackup
activated
Sentwhenthephysicaljournalprinter
entersafatalstate
9-101

Option 35
Value
Type
EJonly
Message Sequence
Comment
H8
reprintstarted
Sentwhenthejournalprinterrestarts
H7
andreprintterminated
SentafterH8whenthereprintis
successfullycompleted
H;
reprinthalted
Sentifthejournalprinterentersafatal
stateduringareprint
H=
SuccessfulEJprint
operation
Sentinadditiontomessagesforphysical
journal.EJisnearlyfull
H>
EJprintoperationfailed
EJisfull
NightSafeDepository
AsolicitedstatusmessageissentinresponsetoaTransactionReply
Commandmessageifthedeposithasnotbeendetected.Itindicates
thatoneofthefollowingconditionshasoccurred:
Cardholderhasnotattemptadeposit
Depositdoorisjammedclosed
Bagdetectionmechanismisfaulty.
Theunsolicitedstatusmessageissentonthetenthconsecutive
cardholderdidnotattemptdepositindication.
Table 9-47
Night Safe Depository Status
Field
Number of
Characters
Content
g1
DeviceIdentifierGraphicK.
g2
Transaction/DeviceStatus.
g3
Sol/
Unsol
Code
Description
Tenthconsecutivecustomerdidnotattemptadeposit.Reportedonly
once.
Undetecteddeposit,orbagdetectionswitchblockedbeforeenable.
SeeTableNote101.
ErrorSeverity.
Code
Description
Noerror.Bagdetectionmechanismwasclearwhenthedepositdoorwas
unlocked.
9-102

Field
Number of
Characters
Content
Warning.Bagdetectionmechanismwasblockedwhenthedepositdoorwas
unlocked(solicitedstatus).NCRrecommendsthatyoushutdowntheSSTifyou
requireconfirmationofalldeposits.
Tenthconsecutivecustomerdidnotmakedeposit(unsolicitedstatus).
g4
Var
g5
SuppliesStatus.Indicatesthestatusofthenightsafe.
Code
Description
Nonewstate(solicitedonly)
Nooverfillcondition
Overfillcondition
Table Note 101: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-48
Encryptor Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphicL.
e2
DeviceStatus.
1
Encryptorerror.
Encryptornotconfigured.
9-103

Field
Number of
Characters
Content
e3
e4
Var
DiagnosticStatus.
Note:TheencryptorstatusisreportedintheMdatafieldoftheDiagnosticStatusfor
compatibilitywithNDC+.
e5
Notused.
Camera(Unsolicited)
Thismessageindicatesthatacameraerrorhasbeendetected.For
detailsoftheEnhancedConfigurationoptiontoenableunsolicited
errorreportingforthesecuritycamera,seeOption32Unsolicited
ReportingControlonpage 710.
SupervisormessagemodeOptionDigit3Bcanalsobesettosend
unsolicitedmessages.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
Table 9-49
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
9-104

Sensors(Unsolicited)
ThismessageissentonSupervisormodeentryandexit,tamper
indicatingbinin/outconditionsandalarmconditions.
Table 9-50
Sensors Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphicP.
e2
19
DeviceStatus.Thisfieldcontainsupto19bytes.
Byte1indicatesthetypeofchangebeingreported:
Char
Code
Description
TIsensorchange
Modechange
Alarmstatechange
SeeTableNote
104
FullTIandfullalarmschangedetected
SeeTableNote
104
FlexibleTIandalarmschangedetected
Ifbyte1=2(modechange)thenextbytegivesdetailsofthecurrentstate:
2
Supervisormodeexit
Supervisormodeentry
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
Supervisormodeinactive
Supervisormodeactive
9-105

Field
Number of
Characters
Content
Vibrationand/orheatsensorinactive.
Vibrationand/orheatsensoractive
Doorcontactsensorinactive.SeeTableNote102andTableNote103.
Doorcontactsensoractive
Silentsignalsensorinactive.SeeTableNote102andTableNote103.
Silentsignalsensoractive
Electronicsenclosuresensorinactive.SeeTableNote102andTableNote
103.
Electronicsenclosuresensoractive
Depositbinout
Depositbinin
Zeroisalwaysreturned
Currencyrejectbinout
Currencyrejectbinin
Currencycassetteinposition1(top)out
Currencycassetteinposition1(top)in
Currencycassetteinposition2(second)out
Currencycassetteinposition2(second)in
Currencycassetteinposition3(third)out
Currencycassetteinposition3(third)in
Currencycassetteinposition4(bottom)out
Currencycassetteinposition4(bottom)in
10
11
12
13
Ifbyte1=5(fullTIandfullalarmschangedetected)bytes213areasabove.Bytes1419
givedetailsofthestateofthefollowingsensors.
Char
Code
Description
14
Coindispenserout
Coindispenserin
Coindispenserhopper1out
Coindispenserhopper1in
15
16
9-106

Field
Number of
Characters
Content
17
18
19
CPMpocketsopen
CPMpocketsclosed
Ifbyte1=6(flexibleTIandalarmschangedetected),thedataisthesameasthatforthe
ExtendedTamperIndicatorIdentifierCoftheTamperandSensorsDatacommand.For
details,seeTable 920,TamperandSensorDataResponseonpage 949.
e3
Notpresent
e4
Notpresent
e5
Notpresent
Table Note 102:IftheSSTisnotconfiguredwiththeTamper

Indicatingfeature,acodeof1isneverreturnedandbytes713are
omittedfromallmessages.
Table Note 103:Ifadeviceisnotconfigured,theassociatedtamper
bytewilltakethevaluezero.
Table Note 104:Thesetypesofchangearereportedonlywhen
option24issettosendtheEnhancedTI/Sensorstatus.
TouchScreenKeyboard
(Unsolicited)
Thismessageindicatesthatthekeyboardhasdetectedanerror.
9
Table 9-51
Touch Screen Keyboard Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphicQ.
e2
DeviceStatus.Always3,indicatingahardwareerror.
9-107

Field
Number of
Characters
Content
e3
ErrorSeverity.Always4,indicatingfatal.
e4
Var
e5
Notpresent.
ThismessageissenttoinformCentralofthefunctionsselectedby
theoperatorafterentrytoSupervisormode.
SupervisorKeys
(Unsolicited)
Note:WhenDiagnosticsisselectedfromtheSelectmenuin
Supervisor,anR07messageissenttothehost.Thisindicatesthat
theDiagnosticsoptionhasbeenselected,butnotwhetherentryto
Diagnosticshasbeensuccessful.
Table 9-52
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
23
Selectmenu
Replenishmentmenu
Configuremenu
Accessmenu
Reserved.
Exitmenu.SeeTableNote105.
Exitmenu.SeeTableNote105.
0098
Menuitemselected.Forthepermittedvaluesforeachmenu,referto
or
9-108

Field
Number of
Characters
Content
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
or
IfOptionDigit0issettoanyvaluegreaterthan3,theselectionsarereportedasifOptionDigit0hadbeenset
to2;thatis,thecomponentselectionsarenotreported.
Table Note 105:Menunumbers7and8arereservedforExits

designers.YoumayalsoredefinethesemessagesusingtheSUPCTR
file.Formoreinformation,refertotheAPTRAAdvanceNDC,
ExtendingtheProductpublication.
Table Note 106:Whenamenuislongerthanonescreen,function
99isusedtoswitchbetweenthescreens.Nomessageis
transmittedforthisselection.
ThemenuitemisnormallyasdefinedintheAPTRAAdvanceNDC,
SupervisorsGuide,butwiththefollowingexception:
Forcompatibilitywithpreviousreleases,function25KeyEntryon
theAccessmenuisnotreportedwhenOptionDigit0=1.Actions
intheKeyEntrysubmenuarereportedusingtheAccessmenu
functions6to11.Thecomponentsofeachkeyareenteredand
writtentotheencryptorasfollows:
Key
Enter Component
Write to Encryptor
06
07
08
09
10
11
Allotherfieldsareomitted.
9-109

CardholderDisplayAlarm
(Unsolicited)
9
Anunsolicitedmessageissenttoindicateastatechangeinthe
cardholderdisplaysensor.Thereportingofunsolicitedmessageis
controlledthroughEnhancedConfigurationParameteroption32.
Fordetails,seeOption32UnsolicitedReportingControlon
page 710.
Table 9-53
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.
StatementPrinter
AsolicitedstatusmessageissenttoCentralifafaultrequiring
attentionoccursduringtransactionprocessing.Anunsolicited
statusmessageissentwhenastatementisdetectedinthetransport,
thestatementprintersupplies(paper,ribbon,printhead,knife,
capturebin)requireattention,oranerroroccursona
cutanddeliverfunctionduringaClosestate.
Table 9-54
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
9-110

Field
Number of
Characters
Content
Devicenotconfigured
Statementpresentintransport
CardholderpressedCancelduringaprintstatementandwaitfunction.
g3/
e3
g4/
e4
Var
g5/
e5
Thisfivecharacterfieldindicatesthestatusoftheprinterpaper,paperribbon,printhead,
knifeandcapturebin.
Char
Code
Description
Sufficientpaper
Paperlow
Paperexhausted
RibbonOK
PrintheadOK
KnifeOK
Knifereplacementrecommended
Knifereplacementmandatory
CapturebinOK
Capturebinoverfill.SeeTableNote108.
Table Note 107:IfmessagemodeOptionDigit3Cisset,theCancel

keyonthecardholderkeyboardisenabledduringPrintStatement
AndWaitfunctions.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.IfthecardholderpressestheCancelkey,anew
unsolicitedstatusmessageissenttoCentral.Ifthisoptionisused,
theCentralapplicationmustbechangedsothatitrecognisesthe
newstatusmessage.
Thestatementprintthatisbeingperformedwhenthecardholder
pressesCancelisunaffectedandiscompletedasnormal.
9-111

Table Note 108:Ifthestatementcapturebinreturnsastatusof

overfill,thestatementprintermustbeinitialisedusingthe
SupervisoroptionINITSTMNTfromtheReplenishMenu,once
thecapturebinhasbeenemptied.Fordetails,refertotheAPTRA
VoiceGuidance
(Unsolicited)
IfthereisaproblemwiththevoiceguidancesystemandEnhanced
Configurationoption32isset,thisunsolicitedmessagegivesthe
statusofthefollowingfeaturesofvoiceguidance:
Theaudiocard
Theenhancedaudiocontrol
Theaudiojack
ThevoiceguidanceXMLconfigurationfile.
Fordetailsofoption32,seeOption32UnsolicitedReporting
Controlonpage 710.
Table 9-55
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.
9-112

Field
Number of
Characters
Content
e5
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.
00
Noaudiojackispresent
01
Aheadsetisconnected
02
Noheadsetisconnected
00
TheXMLdefinitionfileisinaccessible
01
TheXMLdefinitionfileisaccessible
Notused.
NoteAcceptor
Thismessagegivesthestatusofthecashacceptororrecyclingunit
inthefollowingsituations:
9
Soliciteddevicestatusmessagessentinresponsetothe
followingTransactionReplycommandmessages:
RefundCashDeposit
DepositCash
DepositCashandWait
Dispensenotesfirstduringvaluablemediaexchange
Depositnotesfirstduringvaluablemediaexchange
Asaresultofacashacceptororrecyclinguniterror
Wheneverthedevicecompletesanoperation,forexample,after
processinginsertednotes.Thisisalwaysreported,whetherthe
operationissuccessfulorproducesanerror.
Intheeventofanerror,forexamplewhenarefundoperation
jams,thenumberofnotesateachlocationintheBNAwill
becomeindeterminable.Inthiscase,thebestknown
9-113

representationofthecountswillbeshown.Acounterof0,
representedbyaspaceinthemessage,maybereportedfor
activenotetypeswhosecountsareunknown.
Countsarereturnedasfollows:
Allcountfields(fornotesintheescrow,vaultednotesand
returnednotes)instatusmessagesincludecategory3
(suspect)andcategory4(authenticated)notescombined.
Countsforcategory2(counterfeit)notesareneverincluded
exceptinECB6messagesforcategory2notes,indicatedby
themessagedesignator?.
ECB6messagesforcategory3noteshaveamessage
designatorof@andincludethecountsforcategory3notes.
Duringadispenseoperationwhererecyclingisenabledandthe
suppliesstatuschangesfromMediaFulltoMediaHighorfrom
MediaHightoGoodforacassette,anunsolicitedstatus
messageissent.Notransactionnotecountsarereported.
Iferrorrecoveryisenabledandapowerfailureoccurswith
notesintheescrow,thenonpowerupanunsolicitedstatus
messageissentreportingthevaultedcountsreturnedbyXFS.If
theplatformhaslimitationsinreportingupdatedcounts,then
themessageCOUNTS MAY BE INACCURATEisjournaled.
CountsinECB6UnsolicitedMessages
Whencategory2(counterfeit)notesaresentinaw?unsolicited
messageorcategory3(suspect)notesinaw@unsolicitedmessage,
countsarereportedasfollows:
Directdeposits
CountsarereportedintheVaultedCountsfield,whichisused
toreportnotecountsafternotesareinserted
Escrowdeposits
CountsarereportedintheEscrowCountsfield
9-114

Table 9-56
Bunch Note Acceptor Status
Field
(Subfield)
Number of
Characters
Content
g1/e1
DeviceIdentifierGraphicw.
g2/e2
Transaction/DeviceStatus;givesdetailsofacashacceptororrecycleunitoperationin
responsetoaTransactionReplycommandmessage,orasaresultofacashacceptoror
recyclinguniterror
Valuesare:
(g200/
e200)
ErrorCode
SeeTableNote109
Sol/
Unsol
Code
Description
Successfuloperation,butanexceptionhasoccurredornoteshavebeen
movedinthedeviceoutsideaTransactionReplyfunction.Uptodate
countsareincluded,whichwillbeintheescrownotesfield(refundable
deposits)orthevaultednotesfield(directdeposits).Inthiscase,both
countsarecumulativewithinthetransaction.SeeTableNote110
Itisalsopossibleforaw0codetobereturnedwhennotesarerefunded
forexample,intheClosestate.Inthiscase,countsarereportedinthe
Refundedcountsfields
Cancel selected,RefundselectedoratimeoutoccursduringtheCash
Acceptstate.Notecountswillbeintheescrownotesfield(refundable
deposit)orthevaultednotesfield(directdeposit).SeeTableNote110
N/A
Reservedforlegacyimplementations
S/U
Errorifcountsareincluded,theyareasaccurateastheavailable
informationallows,exceptfornotesleftintheescrowintheClosestate
whenthenotecountsareaccurate.
S/U
Deviceinoperativenotesareleftattheexitslot;countsareincluded.
Usuallythisisreturnedcountsinthew4messageasnotesareattheexit
slot.SeeTableNote110
NonotesintheescrowwhentheTransactionReplyfunctionattemptsto
vaultescrowednotesorreturncash,indicatinganerroratthehost
Notesdetectedatpowerup;ifautomaticerrorrecoveryisdisabled
countsareincludedintheescrowcountsfield;ifautomaticerror
recoveryisenabledandthenotesaresuccessfullymoved,thecounts
willbeinthevaultedcountsfield.
Notesnottaken,butretracted;countsareincludedintheVaulted
Countsfield.(notreportedoncashacceptorsthatdonotsupportretract
operationsorwithretractdisabled)
9-115

Field
(Subfield)
Number of
Characters
Content
N/A
Unabletobevaulted.Notsupported
N/A
Counterfeitnoteshavebeendetected
Suspectnoteshavebeendetected.
N/A
N/A
N/A
N/A
(g201/
e201)
50
Escrowcountsupto90foreachofthe50NDCnotetypes(1byteeach)
SeeTableNote117
(g202/
e202)
50
Vaultedcountsupto90foreachofthe50NDCnotetypes(1byteeach)
SeeTableNote117
(g203/
e203)
50
Returnedcountsupto90foreachofthe50NDCnotetypes(1byteeach)
SeeTableNote117
(g204/
e204)
Totalnumberofnotes,upto90,returnedtotheexitslot
SeeTableNote118
g205/
e205)
Totalnumberofnotes,upto90,intheescrow
SeeTableNote118
(g206/
e206)
Totalnumberofnotes,upto90,justvaulted
SeeTableNote118
Whenbit1ofoption45isset,thefollowingfieldsarealsopresentfornotetypeswithmorethan90notes.Each
pairconsistsofaNoteType,andaNoteCountthevalueofwhichisaddedtothepreviousnotecounttoreport
thetotalnumberofnotesentered.
Note:Thesefieldsarerepeatedforeachnotetypewherethenumberofnotesenteredismorethan90.Ifanyof
thesefieldsispresent,allthegroupseparatorsmustbepresentevenifthereisnodataforthedatagroups.Ifall
thetotalvaluesarenotmorethan90notes,nofieldsafterg206/e206willbepresent.
(g207/
e207)
EscrowcountsforeachNDCnotetypewithmorethan90notes
SeeTableNote119
2
Notetypeasahexadecimalvalue
Notecountasadecimalvalue,addedtothepreviousnotecountforthattype,toreport
thetotalnumberofnotesentered
(g208/
e208)
VaultedcountsforeachNDCnotetypewithmorethan90notes
SeeTableNote119
2
9-116

Field
(Subfield)
Number of
Characters
3
(g209/
e209)
Content
Notecountasadecimalvalue,addedtothepreviousnotecountforthattype,toreport
thetotalnumberofnotesentered
ReturnedcountsforeachNDCnotetypewithmorethan90notes
SeeTableNote119
Notecountasadecimalvalue,addedtothepreviousnotecountforthatNDCnotetype,
toreportthetotalnumberofnotesentered
(g210/
e210)
Totalnumber(decimalvalue)ofnotesreturned(movedtotheexitslot)inexcessof90
SeeTableNote120
(g211/
e211)
Totalnumber(decimalvalue)ofnotesintheescroworinthetoptransportinexcessof90
SeeTableNote120
(g212/
e212)
Totalnumber(decimalvalue)ofnotesjustvaultedinexcessof90
SeeTableNote120
g3/e3
Var
Errorseverity,asdescribedinCashAcceptorFitness(DIGw)onpage E24
g4/e4
Var
Diagnosticstatus(MstatusplusMdata);theMstatusdescribesthemainerrorfound
g5/e5
Var
Suppliesstatusofallcassettesinthedevice,asdescribedinCashAcceptorSupplies
(DIGw)onpageE16
Thestatusisreportedasfollows:
Code
Description
Nochange
Goodstate
Binout(missingorremoved)
Mediahigh(nearlyfull)
Mediafull(overfull)
Table Note 109:Forfieldg2,theerrorcodeinformationisobtained

bymappingfromXFStothecorrespondingerrorcode.
Table Note 110Countsarecumulativeuptothepointthatnotesare
refunded.Thenaretractoperationwillrestartthecount.
Table Note 111:IfadeposittransactionisinitiatedonanSST
withoutaBNA,nostatusmessageissenttothehost.
Table Note 112:Ifnotesnottakenbytheconsumerareretractedto
theescrow,thecashacceptorisreportedasinafatalcondition.The
notesmustberemovedfromtheSSTandeithertheInitialiseBNA
9-117

orClearBNASupervisoroptionsmustbeperformedtoresolvethis
condition.
Table Note 113:Ifnotesaretakenlate,thatis,justastheretract
operationstarts,now7 messageissentandAdvanceNDCremains
intheCashAcceptstate.
Table Note 114:Thereportingofcounterfeitandsuspectnotescan
beconfigured.Fordetailsofthisconfiguration,refertoChapter5,
ConfiguringAdvanceNDCandAssociatedComponentsinthe
APTRAAdvanceNDC,DevelopersGuide.Ifbothcounterfeitand
suspectnotesaredetected,separateunsolicitedmessagesaresent
foreachtype.Suspectnotecountsareincludedinthenotecounts
forallstatusmessagesotherthanw?statusmessages.Counterfeit
notesareincludedonlyinw?statusmessages.
Table Note 115:Thecounterfeitandsuspectnotecountsinboththe
escrowcountsfield(refundabledeposit)andthevaultedcounts
field(directdeposit)arecumulative.Thatis,eachmessagereports
thetotalcountsintheEscrowcountsfieldforallbunchesofnotes
inserteduntileitheraTransactionRequestmessageissentornotes
arerefunded.Inmultiplebunchdeposits,amessageissentforeach
bunchdepositedevenifnomoresuspectorcounterfeitnoteshave
beenadded.ForrefundabledepositinECB6mode,theinserted
suspectnotes(category3)willbereportedtogetherwiththe
authenticatednotes(category4)intheEscrowcountsfields
independentlyoftheactualpossiblephysicallocationofthesuspect
notes.
Thew?andw@messagesarenotsentinthefollowingsituations:
Whenautomaticerrorrecoveryisperformedattheendofthe
transaction.
Ifnonotesofthecategoryhavebeeninsertedduringthe
transaction.
Table Note 116:Ifcounterfeitandsuspectnotesareconfigured,this

messagecanalsobeconfiguredtoincludecardholderdataafterthe
suppliesdata.Ifthisdataistobeincluded,thefieldsdescribedin
Table 957areaddedtothemessage.Fordetailsofconfiguringthis
extensiontothemessage,refertoChapter5oftheAPTRAAdvance
9-118

Table 9-57
Additional Cardholder Data
Field
Content
FS
Fieldseparator
e600
Var(78)
Track1data
GS
Groupseparator
e601
Var(39)
Track2data
GS
Groupseparator
e602
Var(106)
Track3data
Table Note 117:EachbytecontainanASCIIvaluebetween20Hand

7AH,representingthenumberofnotesofthatdenomination;for
example,ASCIIchar!(21H)inposition2meansonenoteofNDC
notetype2.
Table Note 118:AsingleASCIIvaluebetween20Hand7AH,
representingatotalforthenumberofnoteswithinaprocessing
category;forexample,ASCIIchar!(21H)meansonenote.
Table Note 119:Agroupofzeroormoredatapairsproviding
informationfordenominationswithmorethan90notes.Only
denominationsthathavemorethan90notesareincluded;
denominationswithexactly90notesarenot.Eachdatapairconsists
ofaDenominationTypefieldandaNoteCountfield.The
DenominationTypefieldhasahexadecimalvalueintherange01to
32.TheNoteCountfieldhasadecimalvalueintherange001to999.
TheNoteCountvalueisaddedtotheequivalentprevious
singlebyteASCIInotecount.Thesumofthepreviousfieldandthe
currentfieldprovidesthetotalnumberofnotes.
Table Note 120:Thedecimalvalue(001to999)tobeaddedtothe
equivalentprevioussinglebyteASCIInotecount.Thesumofthe
previousfieldandthisvalueprovidesthetotalnumberofnotes.If
anyoffieldse210/g210toe212/g212arepresent,allmustbe
present.
Table Note 121:Whenaw6message(notesdetectedatstartofday)
oraw3message(deviceerror)issent,andtheplatformhasnot
providedanMStatusvalue,anappropriatefixednonzero
MStatusvaluewillbeincludedinthemessage.
Table Note 122Nativediagnosticsdataisreportedifavailable
(alwaysavailableonNCRSSTs)otherwiseXFSvaluesaremapped
toGBRUMStatusvalues.
9-119

EnvelopeDispenser
(Unsolicited)
Theenvelopedispenserreportsunsolicitedstatusmessages
dependingonthevalueofEnhancedConfigurationParameter
option23(seepage 1018).Statusmessagesaresentwhenthe
envelopedispenserisdetectedasbeinglow/outoranenvelope
failedtobepresentedorretracted.
Remotestatusindicatorsandtheremoterelayareoptionallysetand
enableddependingonthevalueofoption23.Solicitedstatus
messagesareneversentfortheenvelopedispenser,regardlessof
thevalueofoption23.
Messagesdetailingfitness,configurationandsuppliesinformation
aresenttothehostinresponsetothesendconfigurationdata
terminalcommand.
Table 9-58
Envelope Dispenser Status
Field
Number of
Characters
Content
e1
DeviceIdentifierGraphic\.
e2
DeviceStatus.Indicateswhetherthelastoperationwassuccessful.
Sol/
Unsol
Code
Description
Envelopepresentedsatisfactorily.
Failureenvelopenotpresentedorretracted.
e3
ErrorSeverity.Standardcode.
e4
Var
e5
SuppliesStatus.Indicatesthereplenishmentstatusofthebincontainingenvelopestobe
dispensed.
Code
Description
Sufficientenvelopes.
Envelopeslow.
Envelopesexhausted.
9-120

ChequeProcessor
Thismessagegivesdetailsofpossiblechequeprocessorresponsesto
aTransactionReplycommand,someofwhichcanbecontrolledby
EnhancedConfigurationoption83.Fordetails,seedescribedon
Option83ChequeProcessoronpage 721.
IfaTransactionReplycommandcontainsoneofthecheque
processorfunctionvaluesandtheSSTdoesnothaveacheque
processorconfigured,asolicitederrormessageisreturned.
Table 9-59
Cheque Processor Status
Field
Number of
Characters
Content
g1
DeviceIdentifierGraphicq.
g2
Var(2)
Transaction/DeviceStatus.Givesdetailsofachequeprocessoroperationinresponsetoa
ErrorCode(e200/g200).
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.
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).
9-121

Field
Number of
Characters
Content
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
SeeTableNote123
1
GS
ChequeID.Thethreedigitdecimalnumberassignedtoeachchequeintherange000999
ChequeLocation
GroupSeparator
Value
Description
01
Thechequeisinsidethedevice,butnotinabin
02
Thechequeisinabin.ThebinisidentifiedintheBinNumberfield
03
Thechequehasbeenreturnedtothecardholder
04
Thelocationofthechequeisunknown
BinNumber.Atwodigitdecimalvaluecontainingthenumberofthebininwhichthe
chequehasbeendeposited
Ifthechequeisnotinabin,thisis00
9-122

Field
g3/
e3
Number of
Characters
Content
Var
ErrorSeverity.
Whenoption83bit0andbit1aresettozero,asinglecharacterisreturned,which
representstheoverallerrorseverityofthedevice.
Char
Description
Overallchequeprocessor
Whenoption83bit0orbit1issettoone,thefollowingisreturned:
Char
Description
Overallchequeprocessor
Endorseprinter
Stamper
Reserved
Reserved
Bin1
Bin2
Bin3
Binn
Thenumberofbinsreporteddependsonhardwareconfiguration
Eachcharactercantakeoneofthefollowingvalues:
g4/
e4
Var
Value
Description
Noerror/Notconfigured
Routine
Warning
Suspend
Fatal
DiagnosticStatus.
Whenoption83bit0andbit1aresettozero,thisfieldcontainszeroesandis14bytes
long.
Whenoption83bit0orbit1issettoone,thisfieldisvariablelengthandcontainsthe
chequeprocessordiagnosticinformation.
9-123

Field
g5/
e5
Number of
Characters
Content
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 123:Ifanerroroccurs,itisnotalwayspossibleto

accuratelyreportthelocationofacheque.
Table Note 124:Wheninformationonchequelocationisreported,
eachchequeisreportedwithinagroupseparatedbyagroup
separator.Allfieldsmustbepresentforeachchequethathasa
chequeID,includinganychequesthatthecardholderrequestedfor
return.Eachchequedatagroupisprecededbyagroupseparator.
Nogroupseparatorfollowsthefinalchequetobereported,andif
nochequesarereported,nogroupseparatorispresent.
Table Note 125:Whentheunsolicitedmessageisgeneratedbeforea
transactionrequesthasbeensenttoCentral,noinformationonthe
cardholderorthechequesisavailabletoCentral.However,alllocal
dataisjournalled.
9-124

CoinDispenser
ThismessagegivesdetailsofaCoinDispenserresponsetoa
TransactionReplyCommandmessage.Unsolicitedmessages
alwayshaveadevicestatusof0.
Whenoption79issetto000,thismessagereportsthestatusoffour
hoppertypes.Whenoption79issetto001,thismessagereports
thestatusofthenumberofhoppertypesreportedintheHardware
Configurationmessage.Thestatusisalwaysreportedfora
minimumoffourhoppertypes.Fordetailsofoption79,seeOption
79CoinDispenseronpage 721.
Table 9-60
Coin Dispenser Status
Number of
Characters
Content
g1/
e1
DeviceIdentifierGraphicY.
g2/
e2
1
SeeTable
Note126
Transaction/DeviceStatus.Givesdetailsofacoindispenseoperationinresponsetoa
SeeTable
Note127
Sol/
Unsol
Code
Description
S/U
Successfuloperation,butanexceptionhasoccurred,describedinthe
DiagnosticStatusfield.
Thecoindispenserlowthresholdsforeachcoinhopperwerenotset
duringtheconfigurationoftheSST.Nocoinshavebeendispensed.
Thecoindispensehasnotstartedastherequestedhopperis:
inafatalstate
outofcoins
notinthecorrectpositiontoallowadispense
inalowconditionwithoutenoughcoinstoperformthedispense.
Nocoinshavebeendispensed.
Thecoindispensehasfailedforareasonotherthanajam.Somecoins
mayhavebeendispensed.
Thecoindispensehasfailedduetoajaminthehopper.Somecoins
Thecoindispensehasfailedduetoajaminthetransportchute.Some
coinsmayhavebeendispensed.
Thetransportchuteexitsensorwasblockedatthestartofthecoin
dispense.Nocoinshavebeendispensed.
<
Acoindispensehasbeenattemptedwhilethecoindispenserisina
fatalstate.Nocoinshavebeendispensed.
Field
9-125

Field
Number of
Characters
Content
g3/
e3
Tamperingdetectedduringdispense.Thecoindispensehasfailed
duetothemodulebeingaccessedduringthedispense.Somecoins
Var
CoinsDispensed
SeeTable
Note128
Char
Description
23
Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype1
45
67
89
1011
<n>(<n
>+1)
Decimalrepresentationofthenumberofcoinsdispensedfromhoppertype
<n>
Var
ErrorSeverity.Usedtomakeashutdowndecision.Holdstheseverityinformationforthe
coindispenserandthesubdeviceelements(coinhoppers1to<n>).
Char
Description
Coindispensercorecomponents
Coinhoppertype1
Coinhoppertype2
Coinhoppertype3
Coinhoppertype4
Coinhoppertype5
<n>
Coinhoppertype<n>
Eachcharactercantakeoneofthefollowingvalues:
g4/
e4
Var(14)
Value
Description
Noerror
Routine
Warning
Suspend.Thisisonlyusedforthecoindispensercorecomponentscharacter
Fatal
DiagnosticStatus.Maintenancedatareportedbythecoindispenser.
9-126

Field
g5/
e5
Number of
Characters
Var(4)
Content
SuppliesStatus.Holdsthereplenishableconditionforthecoindispenserandthe
subdeviceelements.Seefieldg3/e3(ErrorSeverity)fortheorderofreportingonthecoin
dispenserandthesubdeviceelements.
Value
Description
Statenotdeterminedduringthisoperation
Good
HopperLow.Thesensorassociatedwiththishopperhasindicatedalow
condition.
HopperEmpty.Thesensorassociatedwiththishopperhasindicatedlowand
thecoinlowthresholdlimithasbeenreached.
Table Note 126:Forfieldg2,theerrorcodeinformationisobtained

bymappingthereceivedActiveXFSeventtoitscorrespondingerror
code.
Table Note 127:Unsolicitedmessagesalwayshaveadevicestatusof
0.
Table Note 128:Thisinformationcanbeusedtofacilitatea
transactionreversalorcorrectionifrequired.Theinformationrefers
tocoinsthathaveleftthehopper,butnotnecessarilyreachedthe
cardholder.
BarcodeReader
(Unsolicited)
Thismessagegivesdetailsofthebarcodereaderresponsetoa
TransactionReplycommandmessage.Unsoliciteddevicestatus
messagesaresentonlyifoption48issetto1.Formoreinformation,
seeOption48BarcodeReaderonpage 717.
9-127

Table 9-61
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
9-128
Table of Contents
Central to Terminal Messages
Chapter 10
Overview
101
CommandLimitations
TerminalCommandLimitations
CustomisationDataCommandLimitations
EMVMessageClassSupport
102
102
102
102
TerminalCommands
103
107
StateTablesLoad
109
Screen/KeyboardDataLoad
ManagingKeyboardsandAssociations
1011
1013
1015
1017
FITDataLoad
1022
ConfigurationIDNumberLoad
1024
MessageAuthenticationFieldSelectionLoad
1026
DateandTimeLoad
1033
Table of Contents
EncryptionKeyChange
1034
ExtendedEncryptionKeyChange
1037
DispenserCurrencyCassetteMappingTable
1045
XMLConfigurationDownload
1048
TransactionReplyCommand
TerminalFunctionsforTransactionCompletion
1051
1065
SupportforTouchScreenEmulation
SupportforVoiceGuidedSessions
MessageCoordinationNumber(MCN)
1086
1086
1086
1087
EJCommands
EJOptionsandTimers
AcknowledgeEJUploadBlock
AcknowledgeandStopEJ
ContinuousandBatchUploadMethods
1091
1091
1092
1093
1094
MessageValidation
ValidMessageClasses
SSTtoCentral
CentraltoSST
CommandRejectCauses
OtherInvalidParameters
Exits
1096
1096
1096
1096
1096
10102
10103
MessagesReceivedinWrongOperationalMode
TerminalCommands
10104
10104
10105
10106

Overview
J
Overview
10
ThischapterdescribesCentraltoterminalmessages,underthe
followingtopics:
TerminalCommands
ElectronicJournalCommands
MessageExceptionHandling
MessagesReceivedinWrongOperationalMode
Note:ForanydifferencesonothervendorsSSTs,refertothe
APTRAAdvanceNDC,MultiVendorSupportReferenceManual.
10-1

Command Limitations
CommandLimitations
10
CommandsthatarenotsupportedinAPTRAAdvanceNDCare
markedasnotsupportedorreservedinthemessageformats,except
forsendtalliesandsenderrorlogs,asdefaultmessagesarereturned
ifthesecommandsaresent.
TerminalCommand
Limitations
Allterminalcommandsareprocessedandacknowledged,withthe
exceptionofthefollowing:
10
CustomisationData
CommandLimitations
Alldatacommandsareprocessedandacknowledged,withthe
exceptionofthefollowing:
10
EMVMessageClass
Support
Sendtallyinformation(commandcode5).Thisalwaysreportsa
lastcleareddateofmidnight1stJanuary2000(000101000000)
andnotallydata(000000)
Senderrorloginformation(commandcode6).Thisalways
reportsnonewentries(00)andalastcleareddateofmidnight
1stJanuary2000(000101000000)
RetrieveandsendhallmarkkeyfromEKC(commandcode=)
EnableFREEJDATA(commandcode>)
Enableimagedumpinginformation(commandcode?).
10
InitialiseEKC(identifierF)
Overridereservedscreens(identifierG)
Screen/KeyboardData:NestedKeyboardData(fieldj3)
Messageclass8issupportedbyEMV/CAM2ExitsforAPTRA
AdvanceNDC.Fordetails,refertotheEMVIntegratedCircuitCard
(ICC)ReferenceManual.
10-2

Terminal Commands
TerminalCommands
10
ThesecommandsaresentbyCentraltostartuporshutdownthe
SST,ortorequestconfigurationdetails,countervaluesordateand
timeinformation.
Table 10-1
Terminal Commands
Field
Number of
Characters
Mandatory/
Optional
Description
Var
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.
10-3

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;defaultmessage
returned.
Senderrorloginformation.Notsupported;defaultmessage
returned.
Sendconfigurationinformation.
TheSendConfigurationInformationcommandasksthe
terminaltosendthefollowingconfigurationinformationdata,
identifiedbytheCommandModifierfieldg,toCentral:
HardwareConfiguration*
SuppliesStatus*
HardwareFitness*
SensorStatus
SoftwareIDandreleasenumber
*Thesecategoriesreturninformationforasubsetofpossible
devices.
Senddateandtimeinformation.
TheSendDateandTimeInformationcommandasksthe
terminaltosendthelocallyhelddateandtimetoCentral.
Reserved.
Reserved.
Reserved.
Reserved.
10-4

Terminal Commands
Field
Number of
Characters
Mandatory/
Optional
Description
<
Reserved.
>
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
Code
Code
Tally (Command Code = 5)
Notsupported
Error Log (Command Code = 6)
Notsupported
Code
Configuration Information (Command Code = 7)
none
Sendconfigurationinformation(includedforcompatibility
withearlierreleases)
Sendhardwareconfigurationdataonly
Sendsuppliesdataonly
Sendfitnessdataonly
Sendtamperandsensorstatusdataonly
SendsoftwareIDandreleasenumberdataonly
10-5

Terminal Commands
Field
Number of
Characters
Mandatory/
Optional
Description
Sendenhancedconfigurationdata
Sendlocalconfigurationoptiondigits
Ifthecommandmodifierisnotwithintherange18,themessagewill
berejected.Ifthespecificcommandrejectoptionisset,aSpecific
CommandRejectwillbereturned.
h
Var
10-6

Customisation Data Commands
10
CentralcanusevariousCustomisationDatacommandsto
downloaddifferenttypesofdatatotheterminal.Thecommandsare
asfollows:
StateTablesLoad
FITDataLoad
MACFieldSelectionLoad
DateandTimeLoad
EncryptionKeyChange
DispenserCurrencyCassetteMappingTable
Thefollowingtableshowsthemessageclass,subclassand
identifierforeachcommand.
Table 10-2
Message
Class
Message
Sub-Class
Identifier
Command
StateTablesLoad
Reserved
FITDataLoad
Load
MACFieldSelectionLoad
DateandTimeLoad
Reserved
DispenserCurrencyCassette
MappingTable
Reserved
10-7

Message
Class
Message
Sub-Class
Identifier
Command
Reserved
02
InteractiveTransactionReply
19
EncryptionKeyChange
19,
AK
10-8

State Tables Load
StateTablesLoad
10
Usethismessagetodownloadstatetablestotheterminal.Itmay
takemorethanonemessagetotransmitthestatetables,inwhich
caseeachmessagewillcontainaportionofthestatetables.For
detailsofthestatetables,seeChapter 2,StateTables.
Table 10-3
State Tables Load
Field
Number of
Characters
Mandatory/ Optional
Description
Var
3DataCommand
FS
FieldSeparator.
LogicalUnitNumber(LUNO).Includedforfutureuseandignoredby
theterminal.
FS
FieldSeparator.
MessageSequenceNumber.Includedforfutureuseandignoredby
theterminal.
FS
FieldSeparator.
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.
10-9

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
TableNote1:Thefieldseparatorandfieldjareonlyusedwhen
theDataSecurityfeatureisselectedandtheflagsarecorrect.For
details,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
TableNote2:EnhancedConfigurationParametersLoadoption80
withtherequiredsettingfortheAlphanumericStateEntrystate
mustbesentbeforetheStateTablesLoadmessage.Ifitisnotsent,
thedefaultvalueofbase10isassumed.Formoreinformation,see
EnhancedConfigurationParametersLoadonpage 1017.
10-10

Screen/Keyboard Data Load
10
Thismessageisusedtodownloadscreenand/orkeyboarddatainto
theterminal.ThemaximumlengthofasingleScreen/Keyboard
DataLoadmessageis2000bytes.
Table 10-4
Screen/keyboard Data Load
Field
Number of
Characters
Mandatory/Optional
Description
Var
Header.ProtocolDependent.
3DataCommand
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
1CustomisationData
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).
10-11

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
touchareamanually.Fordetails,seeCalculatingFullTouchScreen
Positionsonpage 417.
GS
SeeTableNote5
GroupSeparator
j3
SeeTableNote5
NestedKeyboardData.NotsupportedbyAdvanceNDC.
GS
SeeTableNote5
GroupSeparator
j4
Var
SeeTableNote5
MiscellaneousKeyboardDataThisfieldisreservedforfuture
expansion.
Var
TableNote3:Screendataand/orkeyboarddatamaybe
downloadedinamessage.Ifanypartoffieldj1j4ispresent,the
screendatafieldmustbeterminatedbyagroupseparatorto
indicatethestartofkeyboarddata.
TableNote4:Fieldshj4mayberepeatedanynumberoftimes,
asdefinedbythecommunicationsprotocollimitbutnotexceeding
10-12

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>
Todeletescreensandanyassociationswiththem:
<screen no.>
<fs>
<screen no.>
Todeleteascreenanddeleteakeyboardlayout,destroyingany
otherassociationstothatlayout:
<screen no.>
<fs>
<keyboard no.>
10-13

Tosendanewscreenanditsassociatedkeyboarddetailsinone
message:
<screen no> <screen data>
<gs>
<keyboard no.> <keyboard data>
<gs>
<touch data>
Tosendanewscreenandspecifyanassociatedkeyboardthat
willbeprovidedelsewhere:
<gs>
<keyboard no.>
10-14

Configuration Parameters Load
10
ThismessagedownloadstheLogicalUnitNumber(LUNO),
parametersandtimersintotheterminal.Fordetailsofthe
parameters,seeConfigurationParametersLoadMessageon
page 72.Fordescriptionsofthetimers,seeTimersonpage 724.
Thismessagedoesnotenabletheconfigurationofadditional
optionsavailablewithAdvanceNDC,forwhichyouusethe
EnhancedConfigurationParametersLoadmessagedescribedon
page 1017.
Table 10-5
Field
Number of
Characters
Mandatory/Optional
Description
Var
3DataCommand
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
terminal.
FS
FieldSeparator.
1CustomisationData
3ConfigurationData
FS
FieldSeparator.
SeeTableNote6
CameraControl
SeeTableNote6
Reserved
SeeTableNote6
Reserved
SeeTableNote6
Reserved
10-15

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.
FS
SeeTableNote7
FieldSeparator.Mustbepresentifthefollowingfieldsarepresent.
O
SeeTableNote8
TimerNumber.
(Foralistoftimers,seeTable740onpage74;fordetaileddescriptions,
seepage 724)
Numberof800MillisecondTicksperTimerField.
:
Thetimernumberandticksarerepeated.Thedataforeachtimerisdownloadedinthissequence:timer
number(2bytes),numberof800millisecondticks(3bytes)unlessstatedotherwiseinthetableabove.If
aparticulartimerisnotincluded,adefaultvalueisassumed.
:
r
Var
TableNote6:Fieldshtonmaybeomittedunlessfieldmis
populatedwhenalltheearlierfieldsmustbepopulated.The
omittedfieldsassumeavalueofzero.
TableNote7:Thisfieldseparatormustbepresentifanyofthelater
fieldsinthemessagearepresent.
TableNote8:Unlessotherwisestatedinthetimerdescriptionsa
timeoutintervalof000istakenasinfinity,andanunconfigured
timertakesatimeoutintervalof30ticks(seeTimeUnitsfor
Timersonpage 724).
10-16

Enhanced Configuration Parameters Load
Load
10
Thismessagesupportsconfigurationofoptionsandtimers,
includingadditionaloptionsthatarenotsupportedinthe
ConfigurationParametersLoadmessage.Formoredetailsofthe
format,seeEnhancedConfigurationParametersLoadMessageon
page 76
ThismessagedoesnotincludeoptionsandtimersfortheElectronic
Journal(EJ)Uploadfeature;thesearesetintheEJOptionsand
Timerscommand.Fordetails,seeEJCommandsonpage 1091.
Table 10-6
Field
Number of
Characters
Mandatory/Optional
Description
Var
3DataCommand
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
terminal.
FS
FieldSeparator.
1CustomisationData
AEnhancedConfigurationData
FS
FieldSeparator.
LogicalUnitNumber.AsfieldoofConfigurationParametersLoad;
(fordetailsseepage 73)
FS
SeeTableNote9
FieldSeparator.Mustbepresentifanyofthefollowingfieldsare
present.
10-17

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 72)
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
10-18

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
82
Unsolicitedapplicationstatus
83
FS
SeeTableNote9
FieldSeparator.
O
SeeTableNote11
TimerNumber.Containsthetimernumber.Theuseofthetimersisas
follows.Timerswithanasterisk(*)canbeadjustedforavoiceguided
session.Formoreinformation,seeTimersonpage 724.
00*
Keyboardentrytimeout
01*
Cardholderresponsetotimeoutscreentimeout
10-19

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

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
TableNote9:Thisfieldseparatormustbepresentifanyofthe
subsequentfieldsinthemessagearepresent.
TableNote10:ASupervisoroptionallowsoption36tobeignored
ifsentfromthehost.Forfurtherinformation,refertotheAPTRA
TableNote11:Fieldsi,j,kandlmayberepeatedtodefine
multipleoptionsand/ortimers.
TableNote12:EnhancedConfigurationParametersLoadoption80
(AlphanumericStateEntry)affectsfollowingStateTablesLoad
messages.Formoreinformation,seeStateTablesLoadon
page 109.
10-21

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
3DataCommand
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
1CustomisationData
5FITData
FS
FieldSeparator.
FITNumber.DesignatesthenumberassignedtotheFITinthe
followingfield.Valuesintherange000to999arevalid.TheFIT
numberdefinesthesearchorder.Forexample,FIT000isthefirstentry
checkedduringaFITsearch.Ifthereisagapinthenumberingrange,
allomittedentriesintheFITdatadefaultto000.IflinkedFITsare
used,theymusthaveconsecutiveFITnumbers.
10-22

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
transmittedforauthenticationofthismessage.
Thecharactersare09,AF.
Var
TableNote13:Afieldseparatorandfieldsjandkcanbe
repeateduntilthemaximumlengthpermittedbytheprotocolis
reached.
TableNote14:ThefieldseparatorandMACDatafieldlareonly
presentiftheflagsettingsarecorrect.Fordetails,seetheAPTRA
10-23

Configuration ID Number Load
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
Field
Number of
Characters
Mandatory/ Optional
Description
Var
3DataCommand
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
theterminal.
FS
FieldSeparator.
1CustomisationData
6ConfigurationIDnumber
10-24

Field
Number of
Characters
Mandatory/ Optional
Description
FS
FieldSeparator.
ConfigurationIDNumber.Thevalidrangeis00019999.
Var
10-25

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
3DataCommand
ResponseFlag.Thisfieldisincludedforfutureuseandisignoredby
theterminal.
FS
FieldSeparator.
LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuseand
isignoredbytheterminal.
FS
FieldSeparator.
MessageSequenceNumber.Thisfieldisincludedforfutureuseandis
ignoredbytheterminal.
FS
FieldSeparator.
1CustomisationData
BMessageAuthenticationFieldselection
FS
FieldSeparator.
Var(47)
SeeTableNote15
TransactionRequestField.Thisfieldcontainsthefieldselectiondata
forthetransactionrequestmessage.
ThefieldsoftheTransactionRequestmessageareselectedforinclusion
intheMACiftherelevantoffsetbyteissetto1.Theoffsetsforthe
TransactionRequestmessagefieldsareshown:
10-26

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

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

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

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
cardtrack2.
FS
FieldSeparator.
11
SeeTableNote16
cardtrack3.
10-30

Field
Number of
Characters
Mandatory/Optional
Description
FS
FieldSeparator.
SeeTableNote16
EMVSmartCardConfiguration.ThisfieldcontainstheMACselection
datafortheEMVConfigurationmessage.
FS
SeeTableNote17
FieldSeparator.
SeeTableNote17
MessageAuthenticationCode(MAC)Data.Thisfieldcontainsthe
eightcharactervaluetransmittedforauthenticationofthismessage.
Thecharactersare09andAF.
Var
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
10-31

CircuitCard(ICCorSmartCard)configurationusingAPTRA
AdvanceNDC,seeOtherNCRDocumentationonpage G6..
10-32

Date and Time Load
DateandTimeLoad
10
Thismessageisusedtosetthelocaldateandtimeintheterminal.
Table 10-10
Data and Time Load
Field
Number of
Characters
Mandatory/Optional
Description
Var
3DataCommand
theterminal.
FS
FieldSeparator.
FS
FieldSeparator.
FS
FieldSeparator.
1CustomisationData
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.
10-33

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

Table 10-11
Field
Number of
Characters
Mandatory/ Optional
Description
Var
3DataCommand
theterminal.
FS
FieldSeparator.
FS
FieldSeparator.
FS
FieldSeparator.
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.
10-35

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

Extended Encryption Key Change
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.
10-37

Ifthekeyloadissuccessful,anEncryptorInitialisationData
messageisreturnedtoCentraltoreporttheKeyVerificationValue
(KVV)forthenewkey.Ifthekeyloadfails,arejectmessageissent.
WhenaDESkeyisusedtoencryptthenewencryptionkey,Central
mustencryptthenewencryptionkeywiththesamekeydesignated
todecryptitattheSST.
PINverificationmayrequiretheuseofaseparatePINkey.Thekey
usedinthiscaseisthePEKEY,containedintheFIT,whichcanbe
differentforeachfinancialinstitutioninthesystem.
OnpowerfailuretheMasterkeyisunchanged,butthe
CommunicationskeyandMACkeyarechangedtothelocally
enteredBkeyiftheRestartModeoptionspecifiesthis,orif
configurationdatareloadfromdiskfails.Thehostmustensurethat
anyrequiredExtendedEncryptionKeyChangemessagesaresent.
TheExtendedEncryptionKeyChangemessagecanbesentto
changetheMACkeytothecurrentMasterkey(modifier5)orthe
currentCommunicationskey(modifier6)atanypointafteritis
initiallyentered,exceptforthefollowing:
Whenacardholdertransactionisinprogress
WhentheSSTisinSuspendmode
WhenaSupervisorsettlementtransactionisinprogress.
Thismessageisnotconsideredpartofthecustomisationdataand
doesnotresettheconfigurationIDtozero.
Table 10-12
Field
Number of
Characters
Mandatory/ Optional
Description
Var
3DataCommand
theterminal.
FS
FieldSeparator.
FS
FieldSeparator.
10-38

Field
Number of
Characters
Mandatory/ Optional
Description
FS
FieldSeparator.
4ExtendedEncryptionKeyInformation
Modifier.Thisonecharacterfieldspecifiestheencryptionkeychange
totakeplace:
1Deciphernewmasterkeywithcurrentmasterkey.
SeeTableNote23.
2Deciphernewcommunicationskeywithcurrentmasterkey.
SeeTableNote23.
3Deciphernewcommunicationskeywithcurrentcommunications
key.SeeTableNote23andTableNote24.
4Uselocallyenteredcommunicationskey(Bkey)ascurrent
communicationskey.
5DeciphernewMACkeywithcurrentmasterkey.
SeeTableNote23.
6DeciphernewMACkeywithcurrentcommunicationskey.
7Uselocallyenteredcommunicationskey(Bkey)ascurrentMAC
key.SeeTableNote24andTableNote26.
8DeciphernewVISAmasterkeywithcurrentVISAmasterkey..
SeeTableNote26.
9KeydataisnewVISAkeytable.
ADeciphernewVISAmasterkeywithcurrentmasterkey.
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.
SeeTableNote35.
10-39

Field
Number of
Characters
Mandatory/ Optional
Description
DLoadnewinitialcommunicationskey(Bkey)withRSAkey.
SeeTableNote27.
ThekeydatafieldcontainstheinitialBkeyencryptedwiththeEPP
publickey[BKEY],PKEPPandsignatureblock([BKEY],PKEPP)
640bytes.
ELoadnewinitialVISAmasterkey(Vkey)withRSAkey
SeeTableNote27.
ThekeydatafieldcontainstheinitialVkeyencryptedwiththeEPP
publickey[VKEY],PKEPPandsignatureblock([VKEY],PKEPP)
640bytes.
SeeTableNote35.
FSendEPPserialnumber.
SeeTableNote27.
TheterminalwillrespondwithanEncryptorInitialisationData
messagecontainingthesignedserialnumber.
IftheEPPserialnumberreturnedbytheEPPisnot8bytesinlength.it
willberejectedwithaSpecificCommandRejectcodeofE06.
IftheencryptorhaspreviouslybeenusedinBAPEmode,this
commandoptionwillfailunlessthekeyentrymodeischanged
througheitherthemodifierJortheSupervisorAccessmenu.
SeeTableNote33.
GSendEPPpublickey.
SeeTableNote27.
TheterminalwillrespondwithanEncryptorInitialisationData
messagecontainingthesignedEPPpublickey
HSendallKVVs.SeeTableNote26
IReserved.
JSetkeyentrymode.SeeTableNote27andTableNote33
KSendcurrentkeyentrymode
LLoadhostcertificate(primaryorsecondary)
MSendSSTcertificate
NSendSSTrandomnumber
ThisissupportedonlyiftheSSTisusingcertificatesortheEnhanced
Signatureschemeforremotekeyloading.IfNisnotsupported,the
messagewillberejectedwithreasonE02:
OLoadAkeyPKCS7encoded.
10-40

Field
Number of
Characters
Mandatory/ Optional
Description
PReplacecertificationauthoritycertificate
Ifthecommandfailsorisnotsupported,themessagewillberejected
withreasonC02.
IftheEPPisnotpresent,themessagewillberejectedwithreasonE02.
QSendencryptorcapabilitiesandstate.
RLoadNCRSubpublickeyandsignature.SeeTableNote36
SDeleteHSMpublickey.SeeTableNote37
TDeleteNCRSubpublickey.SeeTableNote36andTableNote37
USendEPPattributesSeeTableNote38
VSendvariablelengthEPPserialnumber.SeeTableNote39
FS
FieldSeparator.
KeyDataSize.Specifiesthesizeofthefollowingkeydatafieldin
hexadecimal(hex).
ForasinglelengthDESkey,thesizeis018hex(24decimal)characters.
ForadoublelengthDESkey,thesizeis030hex(48decimal)
characters.
ForthesixVISAtablekeys,thesizeis120hex(288decimal)characters.
0640
NewKeyData.Maximumlengthis640bytes.
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.
10-41

TableNote24:Modifiers3,4,6,7andDcannotbeusedifthe
KeyEntrymodeissettoDoubleLengthRestricted,whentheywill
berejectedwithreasonC17.SeeChapter 11,SecurityFeatures.
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,MACkeyandVISAkey,encryptedbythe
Akey,canbeloaded.
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.
TableNote32TheformatoffieldiformodifiersL,M,N,O,
PandQisasfollows:
Modifier
Key Data Format
Number of characters
LorP
Binarydatalength
Certificate,base94encoded
3bytes
VAR
Certificatetype
0=encryptioncertificate
1=verificationcertificate
N&Q
Nokeydata
Binarydatalength
KeyLoadPacket
3bytes
VAR
10-42

TableNote33: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.
Themodecontrolsthemanualencryptionkeyentrymode,the
encryptionkeysizeandtherestrictionsplacedonkeyusage.When
usingaremotekeyprotocol,themodemustbesetbasedontheDES
keysizetobeusedandthelevelofrestrictiontobeplacedonthe
usageofencryptionkeys.
AllfourkeymodesaresupportedforanonsecureEPPonNCRand
othervendorsmachines.WithasecureEPPandfirmwaresuchas
DAPI7,onlykeymode4issupported.Ifthemodecannotbe
supportedbytheEPP,aSpecificCommandRejectisreturned.
TableNote34:SecuritymessagesfromCentralwillnotbe
processediftheapplicationisinSupervisormode.
TableNote35:FormodifiersC,DandE,thekeydataconsists
ofeitherasingleordoublelengthDESkey,whichispaddedand
encryptedwithPKEPPusingtheRSAESPKCS1v1_5encryption
scheme.The256byteresultisthensignedwithSKHSMusingthe
RSASSAPKCS1v1_5signaturealgorithmtogivea256byte
signature.EachblockisBase94encodedgiving320bytes.T
ThesameprocessisfollowedwhentheEnhancedSignaturescheme
isusedbutthesignatureisgeneratedfromtherandomnumber
returnedinresponsetoanEEKCrequestwithmodifierNand
concatenatedwiththeencryptedsingleordoublelengthDESkey.
Therandomnumberisnotincludedinthemessagefromthehostto
theEPP.Allofthedatareturnedintherandomnumberfromthe
SSTmustbeusedinthecryptogram.
TableNote36:ModifiersR,SandTaresupportedonlyunder
theenhancedsignatureremotekeyprotocol.Iftheenhanced
10-43

signatureisnotsupported,SpecificCommandRejectE02is
returned.
TableNote37:ModifiersSandTareusedtodeletetheHSM
publickeyandHSMRootpublickey.
TableNote38:ModifierUisusedtoreturntheEPPattributesfor
thehosttodeterminewhethertheEPPisPCIcompliant.
TableNote39:WherevariablelengthEPPserialnumbersare
supportedusemodifierVtoreportEPPserialnumbersforall
hardwarevariantstoavoiddifferenthostprocessingrequirements
ondifferenthardware.
Note:TheapplicationaddstheSNEPPtothemessagedatafor
verification.
10-44

Dispenser Currency Cassette Mapping Table
DispenserCurrencyCassette
MappingTable
10
Thetablecontainedinthismessageisusedtodefinecurrencytypes,
whichmaptotheconfigurationsettingsintableentry7ofthe
AmountCheckStatedefinedintheAmountCheckStateTable.
Table 10-13
Dispenser Currency Cassette Mapping
Field
Number of
Characters
Mandatory/ Optional
Description
Var
3DataCommand
theterminal.
FS
FieldSeparator.
LogicalUnitNumber(LUNO).Thisfieldisincludedforfutureuse
andisignoredbytheterminal.
FS
FieldSeparator.
MessageSequenceNumber.Thisfieldisincludedforfutureuseand
FS
FieldSeparator.
1CustomisationData
EDispenserCurrencyCassetteMappingTable
FS
FieldSeparator.
NumberofMappingEntries.TwodigitASCIIhexvalue(range01to
FF).SeeTableNote40.
i1
SeeTableNote40
CurrencyType.SingledigitASCIIhexvalue(range01toFF).Used
formappingtostatetypeGtableentry7.
10-45

Field
Number of
Characters
Mandatory/ Optional
Description
i2
SeeTableNote40
CassetteType.SingledigitASCIIhexvalue(range0toF,types1to4
supported).
i3
SeeTableNote40
DenominationforCassette.FivedigitASCIInumericvalue(for
example,00005for$5).
FS
SeeTableNote41
FieldSeparator.
SeeTableNote41
transmittedforauthenticationofthismessage.Thecharactersare09,
AF.
Var
TableNote40: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.
10-46

TableNote41:ThefieldseparatorandMACarepresentonlywhen
theDataSecurityfeatureisselectedandtheflagsaresetcorrectly.
10-47

XML Configuration Download
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.
10-48

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(seeTableNote42).
FieldSeparator.
Messagepart.
Partnumberfortheconfigurationdatacontainedwithinthismessage.It
containsafourdigitdecimalnumber,intherange0000to9999.Ifthis
valueis0000,allpreviouspartsofapartialconfigurationdatadownload
arediscarded(seeTableNote42).IfthisvalueequalsthevalueinTotal
MessageParts(fieldh),thedownloadedpartsarecombinedandvalidated
againstthespecificschema.Ifthedataisvalidtheconfigurationdatais
storedinanXMLfileataspecificlocation.
FieldSeparator.
Description
10-49

Field
Number of
Characters
Mandatory/
Optional
VAR
NDCConfigurationData.
Fordetailsoftheconfigurationdataformat,refertotheAPTRAAdvance
NDCDevelopersGuide
SeeTable
Note43.
FieldSeparator.
SeeTable
Note43.
MessageAuthenticationCodeData(MAC)Data.
Valuetransmittedforauthenticationofthismessage.Thecharactersarein
therange09andAF.
Description
TableNote42:Ifeitherfieldhoricontainthevalue0000,all
previouspartsofapartialconfigurationdownloadarediscarded.
TableNote43:ThefieldseparatorandMACDatafieldkareonly
presentiftheflagsettingsarecorrect.Fordetails,refertothe
10-50

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
4TransactionReplyCommand
ResponseFlag.Includedforfutureuseandignoredbythe
terminal.
FS
FieldSeparator.
3or9
LogicalUnitNumber(LUNO).Thecontentsofthisfieldareonly
usedwhenCentralasksforthesecurityterminalnumbertobe
checked.Inthiscasethefieldwillcontainninecharacters,thelast
sixofwhicharechecked.
FS
FieldSeparator.
3or8
SeeTableNote54
MessageSequence/TimeVariantNumber.TheMessageSequence
numberfieldisignoredbytheterminalandisincludedforfuture
use.TheTimeVariantfieldcontainsaneightcharactertime
variantnumberwhichshouldbethesameasthelasttimevariant
numbertransmittedtoCentral.
FS
FieldSeparator.
10-51

Field
Number of
Characters
Mandatory/ Optional
Description
NextStateIDData.Containsabase10(decimal)numberinthe
range000254or256999,orabase36(alphanumeric)numberin
therange000254or256ZZZ.Thisidentifiesthestatenumber
whichtheSSTshouldexecuteafterithascompletedthespecified
TransactionReplycommand.
ThisfieldmustbeincludedinallTransactionReplymessages
exceptaPrintImmediate.
FS
FieldSeparator.
g1
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
Numberoftype1notestodispense.Containsthenumberoftype1
notestobedispensed.Validrangeisdefinedbyhardware
capabilities.
g2
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
capabilities.
g3
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
capabilities.
g4
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
capabilities.
g5
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
capabilities.
g6
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
capabilities.
g7
SeeTableNote50,
TableNote51,Table
Note52,andTable
Note53
capabilities.
GS
SeeTableNote56
GroupSeparator
j1
SeeTableNote57
andTableNote56
Numberofhoppertype1CoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertype1.
Validrangeisdefinedbyhardwarecapabilities.See TableNote58.
10-52

Field
Number of
Characters
j2
Mandatory/ Optional
Description
SeeTableNote57
andTableNote56
j3
SeeTableNote57
andTableNote56
j4
SeeTableNote57
andTableNote56
j5
SeeTableNote57
andTableNote56
:
Repeatedforthenumberofhoppertypespresent.
:
jn
SeeTableNote57
andTableNote56
NumberofhoppertypenCoinstoDispense.
Containsthenumberofcoinstobedispensedfromhoppertypen.
FS
FieldSeparator.
TransactionSerialNumber.NumberthatCentralusestoidentify
thetransaction.ItisusedbytheSSTforthefollowingfunctions:
DefaultPPDprinting
TransactionnumberofthelasttransactionprocessedbytheSST.
(ThiscanberequestedbyCentralbytransmittingaSendSupply
CountersTerminalCommandtotheterminal.)
Partoftheinformationprintedonthejournalwhenanexception
statusissenttoCentral.
Validrangeis00009999
FunctionIdentifier.Instructstheterminalonwhatfunctionsareto
beperformed:
Function ID
Functions Performed
1or7
Depositandprint.SeeTableNote46.
2or8
Dispenseandprint.SeeTableNote44.
3or9
Displayandprint
Printimmediate
10-53

Field
Number of
Characters
Mandatory/ Optional
Description
Setnextstateandprint
Nightsafedepositandprint
Ejectcardanddispenseandprint(cardbeforecash)
BorC
Paralleldispenseandprintandcardeject
Reserved.Aspecificcommandrejectwillbesentifthis
isreceived.
Cardbeforeparalleldispense/print
Reserved
Printstatementandwait.SeeTableNote45.
Printstatementandsetnextstate.SeeTableNote45.
Reserved.ASpecificCommandRejectwillbesentif
thisisreceived.
thisisreceived.
thisisreceived.
Printpassbookandsetnextstate(notsupported)
Printpassbookandwait(notsupported)
Refundnotesandprint
Depositnotesandprint
Depositnotesandwait
Processcheque
Dispensenotesfirstduringvaluablemediaexchange
Processmultiplecheques
Printvaluablemediaandsetnextstate(notsupported)
Depositmediafirstduringvaluablemediaexchange
TableNote44:IftheDispenseandPrintfunctionisusedwitha
spraycashdispenserandamotorisedcardreader,thefulltimeout
oncashtakenbeforereturningcardandthenprintingwillbeused.
TableNote45:FunctionIDsPandQareusedtoprint
statementsonthestatementprinterwhentheprinterflaginthe
TransactionReplyis8orsidewaysonthereceiptprinterwhenthe
printerflagis=.
10-54

Field
Number of
Characters
Mandatory/ Optional
Description
TheactiontakenonaPrintImmediatecommanddependsonwhen
itisreceivedandthecontentsofthenextstateIDfield.
TableNote46: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.
10-55

Field
Number of
Characters
Mandatory/ Optional
Description
Var
ScreenDisplayUpdate.Containsscreennumbersandnewscreen
datawhichcanreplaceexistingscreendata.Thenewscreendatais
displayedwhenitsscreennumberisreferencedduringtransaction
processing.
Toimmediatelyupdateadisplayedscreen,thedisplayedscreen
mustbethefirstscreeninthescreenupdatedata.Ina
voiceguidedsession,thiscanbeusedtoinsertdynamicaudiodata
inamessage;fordetails,seeDigitalAudioControlforVoice
Guidanceonpage 323.
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.
Fordetails,seefieldgonpage 93
CardReturn/RetainFlag.Tellstheterminaltoeitherreturnor
retainthecardduringtheClosestate.
0returncardduringClosestate
1retaincardduringClosestate
10-56

Field
Number of
Characters
Mandatory/ Optional
Description
4returncardwhileprocessingthetransactionreply.Thisvalue
canonlybeusedwhenthefunctionidisborf.Ifthisvalueis
usedwithanyotherfunctionidthetransactionreplywillbe
rejected(SpecificCommandRejectE01).
ThisflagisignoredandthecardisalwaysreturnediftheFunction
IDisA,BorCandthecardisnotinthecardreaderattheclose
state.
q
M
SeeTableNote47
PrinterFlag.Tellstheterminalwhichprinterorprinterstouse.
0Donotprint
1Printonjournalprinteronly
2Printonreceiptprinteronly
3Printonreceiptandjournalprinter
4PrintonPPDiftheFunctionIDis1or7(Depositandprint).
5PrintonPPDandjournaliftheFunctionIDis1or7(Deposit
andprint).
8Printonstatementprinteronly
9Reserved
:Reserved
=PrintsidewaysonthereceiptprinteriftheFunctionIDisP
(PrintStatementandWait)orQ(PrintStatementandSetNext
State).
>orwIdentifiesaudiodataforavoiceguidedsession.
SeeTableNote62.
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.
10-57

Field
Number of
Characters
Mandatory/ Optional
Description
Ifprinterflagvalue8isusedinanyfunctionsotherthanPand
Q,thefollowingprinterdatafieldwillbeignored.Onlythefirst
printerdatafieldwithflagvalue8willbeacceptedinamessage.
Forsidewaysprintingonthereceipt,onlyoneprinterflagof=
willbeacceptedinthemessageforfunctionsPandQ.Ifprinter
flag=isusedinanyotherfunction,thefollowingprinterdata
fieldwillbeignored.
Ifprinterflags=and8arebothpresentinatransactionreply
alongwithFunctionIDPorQ,thefirstoftheseflags
encounteredinthemessagewillbeacceptedandprocessed.Itis
thereforerecommendedthatonlyoneoftheseprinterflagsis
presentinaPrintStatementandWaitorPrintStatementandSet
NextStatefunction.
Printerflags9and:areignored.
r
Var(500)
PrinterDataField.Themaximumlengthofthisfielddependson
theamountofdatacompressionusedinthetransmitteddata,but
itisatleast500bytesofuncompressedprintdata.Inserteddatais
printedbytheprinterindicatedinthePrinterFlagfield.
Eachprinterdevicehasitsownrestrictions:
Textsenttoprintonthedepositorymustbe80charactersorless.
Textsenttoprintonthereceiptprintermustbe:
24linesorlessifprintinginnormalmode
49linesorlessiflocalconfigurationoptiondigit6Bisset
20linesorlessforsidewaysprintingonthereceipt.
Sidewaysprintingisnotsupportedforthejournalprinter.
Textsenttobeprintedsidewaysonthereceiptprintercanbeupto
amaximumwidthof80characters.
Thestatementprinterisconstrainedeithertothecompresseddata
lengthandtheoverallmessagelength,ortothelengthofpaper.
10-58

Field
Number of
Characters
Mandatory/ Optional
Description
WhenusedwithprinterflagbforFunctionID:(Processcheque)
orFunctionIDc(ProcessMultipleCheques),thisfieldcontains
theendorsementprintdata(ASCIItext)forthecheque.
Whenusedwithprinterflagwor>(Identifyaudiodatafor
voiceguidance),thisfieldcontainstheaudioIDsubelement
referencetotheTextelementinthevoiceguidanceXML
configurationfile,andanydynamicaudiodatatobeincludedin
themessage.SeeTableNote62.
Ifthefirstcharacteris?,thetextisprintedinthealternative
format.Thealternativeformatcouldbenormal,bold,or
compressedtextdependingonthechequeprocessorvariant.
The?charactercanbeusedtoselecttheXFSPTRformtouse.
Theseformscanbeusedtomodifythetextformat.Fordetails,
refertotheAPTRAonlinehelpunderAPTRAXFS|
ProgrammersReference|XFSServiceProviders|XFSPTR
ServiceProvider.
Noescapesequencesorcontrolcodesaresupportedwithprinter
flagb.Ifnoendorsementdataissuppledwiththisflag,aSpecific
CommandRejectisreturned.
GS
SeeTableNote47
GroupSeparator.
PrinterFlag.Seefieldq.
Var(500)
PrinterData.Seefieldr.
GS
SeeTableNote47
GroupSeparator.
Var(500)
PrinterData.Seefieldr.
GS
SeeTableNote47
GroupSeparator
v1
v2
Var(500)
PrinterData.SeeFieldr.
:
GS,v1andv2mayberepeateduptoninefurthertimes.SeeTableNote47.
:
FS
SeeTableNote49
FieldSeparator.
O
SeeTableNote49
BufferIdentifier.A4inthisfieldidentifiesthefollowingdataas
Track3data.
10-59

Field
Number of
Characters
Mandatory/ Optional
Description
Var(106)
O
SeeTableNote49
Track3Data.ContainsthedatatobewrittenontoTrack3during
theCardWritestateorCardBeforeCashfunctioncommand.This
datareplacesanyexistingdataintheterminalsTrack3buffer.The
Track3dataconsistsofupto106charactersincludingthestartand
endsentinels.
FS
SeeTableNote49
FieldSeparator.
ak1
BufferIdentifierK.AvalueofKfortheBufferIdentifier
indicatesthatthefollowingfieldsdefinethenewTrack1datathat
istobewrittentothecard.
ak2
Var(78)
Track1Data.ThisfieldcontainsthedatatobewrittentoTrack1
duringtheCardWritestateorCardBeforeCashfunction
command.Thisdatareplacesanydataalreadyintheterminals
Track1buffer.TheTrack1dataconsistsofupto78characters.
FS
SeeTableNote49
FieldSeparator.
al1
BufferIdentifierL.AvalueofLfortheBufferIdentifier
indicatesthatthefollowingfieldsdefinethenewtrackdatathatis
tobewrittentothecard.
al2
Var(39)
Track2Data.ThisfieldcontainsthedatatobewrittentoTrack2
duringtheCardWritestateorCardBeforeCashfunction
command.Thisdatareplacesanydataalreadyintheterminals
Track2buffer.TheTrack2dataconsistsofupto39characters.
FS
SeeTableNote49
FieldSeparator.
am1
VCdataIDM.
Fieldsam1/am2toar1/ar2arereservedforExitsuse.Thefirstfield
inthepairisadataidentifier,thesecondisavariablelengthbuffer.
ThedataidentifiershouldbeintherangeM(4DH)toR(52H).
ThefieldscanbeselectivelyMACed.Fordetails,seeMessage
Authenticationonpage 1110.
am2
Var
VCdata
TheExitdata.ThedatafieldshouldnotcontaintheGroup
Separatorcharacter(1DH).
FS
SeeTableNote49
FieldSeparator.
an1
VCdataIDN
an2
Var
VCdata
FS
SeeTableNote49
FieldSeparator.
ao1
VCdataIDO
ao2
Var
VCdata
FS
SeeTableNote49
FieldSeparator.
10-60

Field
Number of
Characters
Mandatory/ Optional
Description
ap1
VCdataIDP
ap2
Var
VCdata
FS
SeeTableNote49
FieldSeparator.
aq1
VCdataIDQ
aq2
Var
VCdata
FS
SeeTableNote49
FieldSeparator.
ar1
VCdataIDR
ar2
Var
VCdata
FS
SeeTableNote49
FieldSeparator.
as1
SeeTableNote49
BufferIdentifierS(Reservedforinternaluse)
as2
SeeTableNote49
Cashhandlernumber(0or1)
as3
SeeTableNote49
1stcassettetypeinspecifiedcashhandler
as4
SeeTableNote49
Numberofbillstodispensefrom1sttype
as5
SeeTableNote49
2ndcassettetypeinspecifiedcashhandler
as6
SeeTableNote49
Numberofbillstodispensefrom2ndtype
as7
SeeTableNote49
3rdcassettetypeinspecifiedcashhandler
as8
SeeTableNote49
Numberofbillstodispensefrom3rdtype
as9
SeeTableNote49
4thcassettetypeinspecifiedcashhandler
as10
SeeTableNote49
Numberofbillstodispensefrom4thtype
asn
SeeTableNote49
Lastcassettetypeinspecifiedcashhandler
asn
+1
SeeTableNote49
Numberofbillstodispensefromlasttype
FS
SeeTableNote55
at1
SeeTableNote49
SmartcarddataID5
at2
Var
SeeTableNote49
Smartcarddata.FordatathatisspecifictoEMV/CAM2,thedata
willbeginwithCAM.Formoreinformation,refertotheEMV
IntegratedCircuitCard(ICC)ReferenceManual.Othersmartcard
customisationsmaybeginwithadifferentvalue.
FS
SeeTableNote55
ba1
SeeTableNote49
Cheque(s)DestinationBufferDataIDa
...
10-61

Field
Number of
Characters
ba2
Mandatory/ Optional
Description
SeeTableNote49
andTableNote59
Cheque(s)destinationdata
1Depositchequeintopocket1
EEjectthecheque
Thehostcandeterminethenumberofpocketspresentby
retrievingtheHardwareConfigurationDataonlymessage.Ifthe
TransactionReplyspecifiesapocketwhichdoesnotexist,the
chequewillbecapturedtotherejectpocketandthecountforthe
rejectpocketwillbeupdated.IfaTransactionReplyissentthat
doesnotcontainoneoftheabovedestinationvalues(aninvalid
chequedestinationfield),aSpecificCommandRejectwitherror
codeB13UnrecognisedDocumentDestinationwillbereturned.
IftheTransactionReplydoesnotincludeendorsementprintdata
(seepage 1059),noendorsementdataisprintedandchequesare
senttopocket2(pocket1ifonlyonepocketisavailable).
FS
SeeTableNote55
bb1
ProcessMultipleChequesBufferDataIDb
bb2
SeeTableNote60
ChequeIdentifier.
Range000999
ReferstospecificchequesreportedintheTransactionRequest
message.Ifthisreferstoachequethatwasnotreportedinthe
TransactionRequestmessage,specificcommandrejectB34is
returned
Ifthisis000,thefollowingfieldsapplytoallchequesthatdonot
haveaspecificactiondefined
Ifthisbufferdoesnotincludeactionsforallchequesincludedin
theTransactionRequestmessage,eitherexplicitlyorwithasetting
of000,specificcommandrejectB34isreturnedandnoneofthe
chequesareprocessed
FordetailsofthespecificcommandrejectB34,seeTable 1040
SpecificCommandRejectValue/QualifierCombinationson
page 1097
bb3
SeeTableNote60
ChequeDestination
SpecifiesthedestinationforthechequeidentifiedbytheCheque
Identifierfield
00Returnchequetocardholder
:
bb4
SeeTableNote60
ChequeStamp
Specifieswhetherthechequeistobestampedifsupportedbythe
hardware
0Donotstampthecheque
1Stampthecheque
10-62

Field
Number of
Characters
Mandatory/ Optional
Description
bb5
SeeTableNote60
Reserved
Mustbefilledwithzeros
bb6
Var
SeeTableNote60
ChequeEndorseText
Containsthetexttousewhenendorsingthecheque.Anyprint
dataprovidedforPrinterflagbisignored
Multiplelinesoftextcanbeprovidedwitheachlineseparatedbya
carriagereturn(0x0D)andlinefeed(0x0A)sequence
Ifthebunchchequeacceptordoesnotsupportmultiline
endorsement,thecarriagereturnandlinefeedcharactersare
removedandreplacedwithaspace(0x20)character
GS
SeeTableNote60
Groupseparator
FS
SeeTableNote61
Fieldseparator
bc
UsedforEMVdynamiccurrencyconversiontransactions.For
details,refertotheEMVIntegratedCircuitCard(ICC)Reference
Manual.
FS
SeeTableNote55
Fieldseparator
MessageAuthenticationCode(MAC)Data.Containsthe
transmittedvalueforauthenticationofthismessage.The
characterscanbe09,AF.
Var
TableNote47:Agroupseparatorandoptionalfieldss/t,u/v,
v1/v2andsoon,compriseagroup.Whenincludedinthemessage,
allfieldsofthegroupmustbepresent.Theremaybeuptothirteen
printfieldgroupswithinamessage.
TableNote48:WhendefiningtheTransactionReplymessagefora
chequeprocessor,themessagemustcontainoneorbothofprinter
flagsaorb.Ifneitherflagispresentallchequesaredepositedin
therejectbin.
TableNote49:Thefieldswandx,ae*,af*,ak*toat*
includingtheirfieldseparators,comprisegroups.Ifthefieldisnot
included,itsprecedingfieldseparatormustbeomitted.
TableNote50:Ahighernumberedtypecanbeomittedifno
dispenseofthattypeisrequested.
TableNote51:Itispossibletodispensefromasmanycassette
typesasarepresentinthecashhandler.
TableNote52:Thelengthofthisfieldisdependentonthesetting
ofEnhancedConfigurationoption76.Fordetails,seeOption76
10-63

CashHandlersonpage 719..ASpecificCommandRejectissentif
thefieldistoolong.
TableNote53:Themaximumnumberofnotesthatcanbe
dispensedisreportedintheHardwareConfigurationmessage.The
maximumnumberofnotesistakenfromtheserviceprovider
capabilityinformation.Anyrequestformorethan999notesis
rejectedasthisisabovethemessagereportingcapacity
TableNote54:TheTimeVariantNumber,lengtheightbytes,is
presentiftheMACflagsettingsarecorrect.Otherwise,theMessage
SequenceNumber,lengththreebytes,isoptionallypresent.For
details,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
TableNote55:ThefieldseparatorandMACdatafieldyare
presentiftheDataSecurityfeatureisselected,andtheMACflag
settingsarecorrect.Fordetails,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
TableNote56:Thisgroupseparatorshouldonlybeincludedifa
coindispenseisrequired.
TableNote57:Fieldj1mustbepresentiftheprecedinggroup
separatorisincluded.However,highernumberedhoppersmaybe
omittedifnodispensefromthesehoppersisrequired.Thetotal
numberofcoinsdispensedmustnotexceed25.
TableNote58:Themaximumnumberofcoinsthatcanbe
dispensedisreportedintheHardwareConfigurationmessage.The
maximumnumberofcoinsistakenfromtheserviceprovider
capabilityinformation.Anyrequestformorethan999coinsis
rejectedasthisexceedsthemessagereportingcapacity.
TableNote59:Themessageformatcanalsosupportdestinations
4through9todepositthechequeintochequeprocessorbins4
through9;andathroughftodepositthechequeintocheque
processorbins10through15.AdvanceNDCdoesnotsupportthese
destinations.
TableNote60:Fieldsbb2tobb6arerepeatedforeachcheque,and
thedetailsforeachchequeareseparatedbyaGroupSeparator.
Detailsforthechequeswithinasinglecurrencycanbeprovidedin
anyorder,thatisthechequedetailsareprovidedasanunordered
list.Thelastchequedoesnothaveagroupseparatorfollowingthe
data.Fieldbb2correspondstotheChequeIdentifierusedinthe
TransactionRequestmessage.
TableNote61:Thefieldseparatorisrequiredonlyifthefollowing
fieldispresent.
10-64

TableNote62:Thevoiceguidancedataisplayedaftersuccessful
processingofthetransactionreplyfunctionandbeforemovingto
thenextstatespecifiedinthetransactionreplymessage.Ifthe
transactionreplyprocessingfails,forexample,becauseofa
dispenserfault,resultinginasolicitedstatussenttothehost,voice
datafromtheoriginaltransactionreplymessageisdiscarded.If
alternativevoicedataisrequired,thehostmustsenditinthe
subsequenttransactionreplymessage.
TerminalFunctionsfor
TransactionCompletion
10
FieldloftheTransactionReplycontainsaFunctionIdentifier.This
tellstheSSTwhatfunctionsaretobeperformedtocompletethe
transaction.Thefunctionsareasfollows:
DepositandPrint(Table1016onpage1066)
DispenseandPrint(Table1017onpage1067)
DisplayandPrint(Table1018onpage1068)
PrintImmediate(Table1019onpage1069)
SetNextStateandPrint(Table1020onpage1069)
NightSafeDepositandPrint(Table1021onpage1069)
EjectCard,DispenseandPrint(CardBeforeCash)(Table1022
onpage1070)
ParallelEject/DispenseandPrint(Table1023onpage1071)
CardBeforeParallelDispenseandPrint(Table1024onpage
1072)
PrintStatementandWait(Table 1025onpage 1073)
PrintStatementandSetNextState(Table1026onpage1074)
RefundNotesandSetNextState(Table1027onpage1075)
DepositNotesandPrint(Table1028onpage1076)
DepositNotesandWait(Table1029onpage1077)
ProcessCheque(Table1030onpage1077)
DispenseCashFirstduringValuableMediaExchange
(Table 1031onpage 1078)
ProcessMultipleCheques(Table1033onpage1081).
DepositMediaFirstduringValuableMediaExchange
(Table 1034onpage 1082)
Dispensefunctionsmayhaveslightlydifferentbehaviourifaspray
dispenserispresent.Thisisbecausethespraydispensersendseach
notestraightintoareceivingpocketinsteadofstackingand
presentingthemasastandarddispenserdoes.Also,thereisno
possibilityofretractingnotesdispensedbyaspraydispenser.
Thefollowingtablesillustratethesequenceofevents,andrelated
screendisplays,foreachofthesefunctions.
10-65

Table 10-16
Deposit and Print (Function ID 1 or 7)
State
Screen
Operation
TransactionRequest
TransactionRequestScreen
(PLEASEWAIT)
Screen
(INSERTENVELOPE)
Presentenvelope.SeeTableNote63
Enabledepository.
Startslowbeep.SeeTableNote64.
Switchonmediaentryindicator.
Waitforcardholdertoinsertenvelope.
Stopbeeping.
(EnterTimeOutstateiftimer04expires.
SeeTableNote65andTableNote66).
Printonenvelope.
Printonreceiptandjournaltodefinedlevel.
Sendstatus.
NextStatein
TransactionReply
Command
NextStateScreen
(forexample,SELECT
TRANSACTION)
EventualClosestate
CloseScreen
(forexample,TAKECARD)
Switchoffmediaentryindicator.
Cutanddeliverreceiptifnecessaryandejectcard.
Waitforcardtobetakenorcaptured.
Capturecardiftimer09expires.
SeeTableNote66.
Timer02
SeeTable
Note67.
TableNote63:Anenvelopeispresentedonlyifanenvelopehas
notpreviouslybeendispensedduringtheEnvelopeDispenserState.
Fordetails,seeCEnvelopeDispenserStateonpage 215.
TableNote64:Ifthebeeperisnotrequired,localconfiguration
optiondigit2Ccanbesettostopitsoperation.Fordetails,referto
TableNote65:TheCancelkeyisactivewhentheInsertEnvelope
screenisdisplayed.PressingtheCancelkeycausesatimeoutstatus
tobesenttoCentral.
TableNote66:Fordetailsoftimers,seetheConfiguration
ParametersLoadsection.
TableNote67:Timer02(page 77)isusedtodeterminethelength
oftimethattheClosescreenisdisplayed.
10-66

Table 10-17
Dispense and Print (Function ID 2 or 8)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
Dispensetherequestedcashand
coins.
SeeTableNote68
TransactionReplyScreen
(TAKECASH)
Printonreceiptandjournalto
definedlevel.
Sendstatus.
NextStatein
TransactionReply
Command
Timers
(07+10)
or
(05+07)
SeeTable
Note69
NextStateScreen
(forexample,SELECT
TRANSACTION)
TableNote68:Adispensecanconsistofnotesonly,coinsonly,ora
combinationofnotesandcoins.Ifthedispenseincludesa
combinationofnotesandcoins,thenotesmustbesuccessfully
dispensedbeforethecoinsaredispensed.
TableNote69:IftheSSTisconfigurednottoretractnotes,timers
07(page 726)and10(page 727)areusedtocontroltheminimum
lengthoftimeforthetransaction,withtimer05(page 725)if
beepingisactive.Fordetailsofconfigurationoptions,refertothe
IftheSSTisconfiguredtoretractnotes,timer05(page 725)isused
ifbeepingisactive,thentimer07.Timer05isstartedwhennotesare
presented;ifitexpiresbeforethenotesaretaken,aretractis
attempted.
10-67

Ifsomenotesareretracted,thePresenterErrormessageislogged
tothejournal,andanunsolicitederrorisreportedtoCentral.For
details,seetheCashHandler(Solicited/Unsolicited)onpage 990.
Ifthenotesaretakenbeforetheexpiryoftimer05(page 725),itis
cancelled.
Ifthelocalconfigurationoptionisselected,thebeeperissounded
duringthetimethattimer05isinuse.Fordetailsofconfiguration
options,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
Timer07(page 726)isstartedafternoteshavebeentakenandthe
nextstateisenteredonexpiry.
Fortimerformatinamessage,seeConfigurationParameters
Loadonpage 1015.
Table 10-18
Display and Print (Function ID 3 or 9)
State
Screen
Operation
TransactionRequest
(forexample,DISPENSE
ERROR)
definedlevel.
Sendstatus.
NextStatein
TransactionReply
Command
Timer
(10+07)
or
(07)
SeeTable
Note70.
NextStateScreen
(forexample,SELECT
TRANSACTION)
TableNote70:OnanSSTconfigurednottoretractnotes,timers10
(page 727)and07(page 726)areused.OnanSSTconfiguredto
retractnotes,timer07isused.
Fordetailsofthetimerformatinamessage,seeConfiguration
ParametersLoadonpage 1015.Fordetailsofconfiguration
options,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
10-68

Table 10-19
Print Immediate (Function ID 4)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
WaitforanotherTransactionReplycommand.
PrintImmediatemayalsobereceivedatothertimes.Fordetails,see
theMessagesReceivedinWrongOperationalModesectionon
page 10104.
Table 10-20
Set Next State and Print (Function ID 5)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
definedlevel.
Sendstatus.
NextStatein
TransactionReply
Command
NextStateScreen
Table 10-21
Night Safe Deposit and Print
(Function ID 6)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
Unlocknightsafe.
Startslowbeep.
Screen
(INSERTBAG)
SeeTableNote71
Waitforcardholdertoinsertbag.
Stopbeeping.
(EnterTimeOutstateiftimer08expires
SeeTableNote72).
Sendstatus.
Nextstatein
TransactionReply
Command
NextStateScreen
(forexample,Transaction
State)
TableNote71:TheCancelkeyisactivewhentheInsertBag
screenisbeingdisplayed.PressingtheCancelkeycausesan
undetecteddepositstatustobesenttoCentral.
TableNote72:Timer08(page 726)isstartedwhenthenightsafe
doorisunlockedtoacceptanightsafedeposit.
10-69

Table 10-22
Card Before Cash (Function ID A)
State
Screen
Operation
TransactionRequest
SeeTableNote73.
(PLEASEWAIT)
Ejectcard.
SeeTableNote74.
TransactionReplyScreen1
(TAKECARD)
Waitforcardtobetaken.
(Capturecardiftimer09expires)
(PLEASEWAITFORCASH
ANDRECEIPT)
Dispensetherequestedcashandcoins.
Sendstatus.
Cutanddeliverreceiptifnecessary.
ClosescreenTableEntry2
(TAKERECEIPTAND
CASH)
or
TableEntry4
(TAKECASH)
Timer02
(Determinesthelengthoftimethat
theClosescreenisdisplayed).
Close
Countand
stackcash
TableNote73:InnormalusagethenextstateisalwaysClose.
TableNote74:Track3updatecantakeplacebeforecardejectif
newTrack3dataiscontainedinthetransactionreplymessage.
TableNote76:Foraterminalconfiguredfornoteretraction,timer
05(page 725)isstartedafterthecashhasbeendispensed.Timer05
isalsousedforbeepinginCardBeforeCashtransactionswherethe
SSTisconfigurednottoretractnotes.Fordetailsofconfiguration
options,seetheAPTRAAdvanceNDC,SupervisorsGuide.
OnSSTswithcashretractenabled,ifthenoteshavenotbeentaken
whenthistimerexpires,retractionisattempted.Ifsomenotesare
retracted,thePresenterErrormessageisloggedtothejournaland
anunsolicitederrorisreportedtoCentral.Fordetails,seetheCash
Handler(Solicited/Unsolicited)onpage 990.Ifthenotesaretaken
beforethetimerexpires,thetimeriscancelled.Inbothcases,timer
10-70

07page 726)isstarted,andthenextstateisenteredonexpiry.For
detailsoftimers,seeTimersonpage 724..
Iflocalconfigurationoptiondigit2BissetattheSST,thebeeperis
soundedduringthetimethattimer05isoperative.Fordetails,see
TableNote77:WhenthenoretractoptionissetinaCardBefore
Cashtransaction,therecommendedminimumvalueoftimer07is5
seconds.
Table 10-23
Parallel Eject/Dispense and Print Fast Cash (Function ID B or C)
State
Screen
Operation
TransactionRequest
SeeTableNote78
(PLEASEWAIT)
ParallelEject/DispenseandPrint.
TransactionScreen
(TAKECARDANDCASH)
Printreceiptandjournaltodefinedlevel.
Sendstatus.
SeeTableNote82.
CloseScreenTableEntry2
(ANDRECEIPT)
or
TableEntry4
(NULL)
SeeTableNote79
Waitforcardtobetakenorcaptured,
ifnotalreadytaken.
Close
Timer02
SeeTable
Note84.
TableNote78:InnormalusagethenextstateisClose.
TableNote79:NCRrecommendsthattheClosescreensaddtextto
theTransactionReplyscreenratherthanclearthescreen.
TableNote80:Followingtheparalleleject/dispenseandprint,
timers05and07arestarted.Fordetailsoftimers,seethe
ConfigurationParametersLoadsection.Ifthetotaltimeout
periodexpiresbeforethecashistakenaretractisattempted.Ifsome
notesareretractedthePresenterErrormessageisloggedtothe
journal,andanunsolicitederrorisreportedtoCentral.Fordetails,
seeCashHandler(Solicited/Unsolicited)onpage 990..Ifthe
notesaretakenbeforethetimerexpires,itiscancelledandthenext
stateisentered.Ifthelocalconfigurationoptionisselected,the
beeperissoundedwhilsttimer07isinuse.Fordetailsof
configurationoption,seetheAPTRAAdvanceNDC,Supervisors
Guide.
10-71

TableNote81:AtransactionthatusestheParallelEject/Dispense
andPrintreplyiscommonlyreferredtoasaFastCashtransaction.
ToachieveoptimumperformancewithaFastCashtransaction,this
replyshouldbeusedtogetherwiththeTCardReadPINEntry
InitiationStatedescribedinChapter2.
TableNote82:Printerandcardreadererrorsarereportedas
unsolicitedstatusmessages.Adispenseerrorisreportedbya
solicitedstatusmessagetogiveCentraltheoptionofprintingan
errorreportordisplayinganerrorscreen.
TableNote84:Timer02isusedtodeterminethelengthoftimethat
theClosescreenisdisplayed.
Table 1024
Card Before Parallel Dispense and Print

(Function ID F)
State
Screen
Operation
TransactionRequest
SeeTableNote85
(PLEASEWAIT)
Waitfortransactionreply
(TAKECARD)
Ejectcard.
Waitforcardtobetaken.
(Capturecardiftimer09expires)
Sendstatusiffailureandabort(seeTableNote88).
Otherwisecontinue.
SeeTableNote86
(PLEASEWAITFORCASH
ANDRECEIPT)
Stackanddispensecash,andprintfullreceiptdata,
butonlycutthereceiptifaformfeedissentora
completepage(24or49lines)hasbeenprinted.
Sendstatusiffailureandabort.
Sendstatus.
SeeTableNote89.
Close
CloseScreen
SeeTableNote87
TableNote85:Innormalusage,thenextstateisaClosestate.
10-72

TableNote87:NCRrecommendsthattheClosescreensdonot
clearthescreenbutsimplyaddtexttotheTransactionReplyscreen.
TableNote88:Printerandcardreadererrorsarereportedas
solicitedstatusmessages.Adispenseerrorisreportedbyasolicited
statusmessagetogiveCentraltheoptionofprintinganerrorreport
ordisplayinganerrorscreen.
TableNote89:Followingthecardeject,dispenseandprint,timers
05and07arestarted.Ifthetotaltimeoutperiodexpiresbeforethe
cashistaken,aretractisattempted,thePresenterErrormessageis
loggedtothejournalandanunsolicitederrorwillbereportedto
Centralifthelocalconfigurationoptiontodelaystatusreportingis
notset.
Ifthenotesaretakenbeforethetimersexpire,theyarecancelled
andthenextstateentered.Fordetails,seeTimersonpage 724..
Ifthelocalconfigurationoptiontosoundthebeeperissetandthe
noretractoptionisnotset,thebeeperwillbesoundedduringthe
timethattimers05plus07areoperative.
Fordetailsoflocalconfigurationoptions,refertotheAPTRA
Table 10-25
Print Statement and Wait
(Function ID P)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
(STATEMENTBEING
PRINTED)
Printonstatementorprintsidewaysonreceipt
printerandjournaltodefinedlevel.
Sendstatus(statementprinterorreceiptprinterif
printingsidewaysonthereceipt).
Note:Alocalconfigurationoption(optiondigit3C)canbesetto
enabletheCancelkeyonthecardholderkeyboard.Fordetails,refer
totheAPTRAAdvanceNDC,SupervisorsGuide.
10-73

Table 10-26
Print Statement and Set Next State
(Function ID Q)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
PrintonStatementorprintsidewaysonreceipt
printer.
(TAKESTATEMENT)
definedlevel.
Sendstatus(statementprinteror
receiptprinterifprintingsidewayson
thereceipt)
NextStatein
TransactionReply
Command
Timer96
See.
NextStateScreen
TableNote90:Timer96isusedonlyintheprintstatementand
continuefunctionandisstartedwhetherornotastatementisbeing
delivered.Whenthetimerexpires,thenextstatespecifiedbythe
TransactionReplycommandisentered.
10-74

Table 10-27
Refund Notes and Set Next State
(Function ID *)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
Attempttomovenotesfromthe
escrowtotherefundslot.
SeeTableNote91
(PLEASEREMOVENOTES
FROMREFUNDSLOT)
SeeTableNote92andTable
Note93
Waitfornotestoberemovedfrom
therefundslot.
Ifspecified,printonreceiptand
journaltodefinedlevel.
Sendstatusasfollows:
Ifanerroroccursbeforethenotesare
presented,sendasolicitedmessage.
IfanerroroccursorTimer78expires
afterthenotesarepresentedand
beforethenotesareremoved,either
retractthenotesiftheretractoptionis
setandsendanunsolicitedmessage,
orjustsendanunsolicitederror
messagetoCentral.
SendaReadymessagewhenthe
notesaresuccessfullypresented.
NextStatein
TransactionReply
Command
Timer78
NextStateScreen
TableNote91:Ifinsertedcashisdepositeddirectlytothecassettes,
thenotescannotberefunded.Inthissituation,asolicitedstatus
message(w5)reportsthattheescrowisempty.
TableNote92:IfthescreenreferencedintheTransactionReply
onlycontainsnestedscreens,thefirstnestedscreenisdisplayed
whenthenotesarepresented;andthesecondnestedscreenis
displayedwhenthenotesarebeingretracted(ifthecustomerhas
nottakenthenotesandAdvanceNDChasbeenconfiguredto
retractthenotes).IfthescreenreferencedintheTransactionReply
containsmorethannestedscreens,itisfullydisplayedwhenthe
notesarepresented.
TableNote93:Iftheconsumertakestherefundednoteslateasthe
retractoperationstarts,nounsolicitedmessage(w7)issentbutifa
retractnotesscreenisconfigured,itisdisplayed.
10-75

Table 10-28
Deposit Notes and Print
State
Screen
Operation
Transaction
Request
(PLEASEWAIT)
(YOURCASHISBEING
DEPOSITED)SeeTable
Note94andTableNote105
NextStatein
TransactionReply
Command
Attempttoencashthenotes.Ifcashhasbeendeposited
directlytothecassettes,thisisalogicaloperationonly:no
physicalmovementofnotestakesplaceastheoperation
isalreadycomplete.
Ifspecified,printonreceiptandjournaltodefinedlevel.
Thisisnormallydoneaftertheencashoperation.
Printonstatementorprintsidewaysonreceiptprinter.
Ifanerroroccurs,sendasolicitederrormessage.
Ifnotesaresuccessfullydeposited,setthenextstateand
sendaReadymessagetoCentral.
UnsolicitedmessagescanaccompanytheReadymessage
whenathresholdorcassetteerroroccursduringthe
successfulencash
NextStateScreen
TableNote94EnhancedConfigurationParameteroption44canbe
usedtojournaltheencashcountsintheusualstatusmessageformat
whenevertheReadymessageissent.
TableNote95Ifconfiguredintheregistry,thetransactionreply
printdatawillbeprintedwhilenotesarebeingmovedtothe
cassettes,otherwiseitwillbeprintedaftertheDepositoperationis
completed.Fordetailsoftheregistrysetting,
DoParallelEncashPrint,refertotheAPTRAAdvanceNDC
DevelopersGuide.
10-76

Table 10-29
Deposit Notes and Wait
State
Screen
Operation
Transaction
Request
(PLEASEWAIT)
(YOURCASHISBEING
DEPOSITED)SeeTable
Attempttomovethenotesfromtheescrowtothecash
depositbin(encash).Ifcashhasbeendepositeddirectly
tothecassettes,thisisalogicaloperationonly:no
physicalmovementofnotestakesplaceastheoperation
isalreadycomplete.
Ifspecified,printonreceiptandjournaltodefinedlevel.
Thisisnormallydoneaftertheencashoperation.
Ifanerroroccurssendasolicitedmessage.
IfthenotesaresuccessfullydepositedSendaReady
message.UnsolicitedmessagescanaccompanytheReady
messagewhenathresholdorcassetteerroroccursduring
thesuccessfulencash
Table 10-30
Process Cheque (Function ID :)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
(YOURCHEQUEISBEING
PROCESSED)
NextStatein
TransactionReply
Command
Endorsecheque,andattempttomove
chequetobin1,2or3.
SeeTableNote96
Chequestampingisnotsupportedby
AdvanceNDC.
Sendstatus:
Ifthechequeissuccessfully
processed,sendaReady9messageto
Central.
Ifchequeisejected,butnottaken,
retaininbin2andsendanunsolicited
errormessagetoCentral.
Timer94
NextStateScreen
TableNote96:Onasinglechequeprocessor,chequesareendorsed
whenpocketed,retractedorreturnedbythehost.Ifthesingle
chequeprocessorfailstoendorseareturnedcheque,thisisreported
inanunsolicitedstatusmessageforthechequeprocessor.
10-77

Table 10-31
Dispense Cash First During Valuable
Media Exchange (Function ID b)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
SeeTable
Note97
andTable
Note98
(TAKECARD)
Returncard(ifspecified)
Ifcardreturnduringtransaction
processingisspecifiedthenthecard
isreturnedandmustbetaken.
SeeTable
Note99
(TAKECASH)
Dispensenotes
Waitfortheconsumertotakethe
notes(whenretractisenabledand
option4asetto1)
SeeTable
Note100
andTable
Note101
Dispensethecoins
SeeTable
Note102
Depositthenotes,printthereceipt
andjournaldatainparallel.
SeeTable
Note103
andTable
Note104
Sendstatus
NextStatein
TransactionReply
Command
NextStateScreen
(forexampleSELECT
TRANSACTION)
TableNote97Thisfunctionmustonlybeusedwhennotesareto
bedepositedandcashistobedispensedinasingletransaction
replyIfonlyanotedepositistobeprocessed,theDepositNotesand
Print(functionID_)mustbeused.Ifthisfunctionisusedandno
notesorcoinsarespecified,therequestwillberejectedwitha
SpecificCommandRejectofB11).
TableNote98Thisfunctioncanalsobeusedforthefollowing:
Whentheextendedcashdispenserinterfaceisused(Enhanced
Configurationoption76issetto001)tosupportmorethan4
cassettetypes
Whenadualdispenserispresent.
10-78

TableNote99Ifcardreturnduringtransactionprocessingis
specified,thecardisreturnedtotheconsumerandmustbetaken
beforeanynotesaredispensed.Ifthereisanerrorwhileprocessing
thecardortheconsumerdoesnottakethecardanditiscaptured,a
solicitedcardreaderdevicestatusmessageissent.Nonotesand
coinsaredispensedandmediawillnotbedeposited.Ifthecardis
nottobereturnedduringthetransactionprocessing,notesare
dispensedasthefirststepintheprocess.
TableNote100ThenotesspecifiedintheTransactionReplyare
dispensedtothecardholder.Ifthenotesaresuccessfullydispensed,
anycoinsspecifiedaredispensedatthepointwhereaReady9or
ReadyBstatusmessagewouldnormallybegeneratedforthecash
dispenseoperation;thenthenotesaredeposited.
Inacashdispenseoperation,SupervisorMessageModeoptions2
and4controlwhensolicitedmessagesforthecashdispenserare
sent(errormessagesandReady9).AdvanceNDCcanbeconfigured
(MessageModeoption4aissetto0)tosendasolicitedmessage
afternoteshavebeensuccessfullypresented,oranerrorhas
occurred,uptoandincludingthepresentoperation,(without
waitingforacashretractoperationoranautopurgecycle).
Alternatively,AdvanceNDCcanalsobeconfigured(Message
Modeoption4aissetto1)tosendasolicitedmessageafteranerror
occursuptoandincludingthepresentoperationorafterthenotes
havebeenretracted/taken.
Fordetailsofhowtheflowofoperationsisaffectedbythesettings
forMessageModeoptions2and4,seeTable 1032,DispenseCash
FirstDuringValuableMediaExchange:OperationalFlowbelow.
TableNote101Ifthenotedispensefails,acashdispensersolicited
statusmessageissenttothehost,nocoinsaredispensedandthe
insertednotesarenotdeposited.AdvanceNDCwaitsforfurther
instructionfromthehost,forexample,thehostusestheRefund
NotesandPrintfunction(functionID*)toreturnthenotestothe
cardholder,orDepositNotesandPrint(functionID)todeposit
thenotes.
TableNote102Ifthereisafailureduringthecoindispense,a
solicitedstatusmessageforthecoindispenserissent;theinserted
notesarenotdepositedandAdvanceNDCwaitsforfurther
instructionfromthehost.
TableNote103Duringdeposit,notesaremovedtothecash
depositbinsdefinedbythedeviceconfiguration.
10-79

TableNote104Ifthenotedepositoperationfails,asolicited
messageforthecashacceptorissenttothehostandAdvanceNDC
waitsforfurtherinstructionfromthehost.
Table 10-32
Dispense Cash First During Valuable
Media Exchange: Operational Flow
Option 2A
Option 4A
Notes
Pres
Notes
Taken
Notes
Retracted
Cash
Dep
Print Ops
Message Sent
0
(retract
enabled)
(coin
dispense
startsafter
notes
presented)
Ready9
(coin
dispense
startsafter
notes
presented)
Unsolicited
NotesRetract;
Ready9
(coin
dispense
startsafter
notestaken)
Ready9
(nocoins
dispensedas
notesnot
taken)
Solicited
NotesRetract
(Ignored)
(coin
dispense
startsafter
notes
presented)
Ready9
(Ignored)
(coin
dispense
startsafter
notes
presented)
Ready9
Coins Dispensed
10-80

Table 10-33
Process Multiple Cheques (Function ID c)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
SeeTableNote105
Chequehandlingisspecifiedbythe
contentofbufferbinthe
TransactionReplymessage,as
follows:
Returnallchequestothe
cardholderwithoutendorsingor
stampinganycheque
Depositallcheques,stampedand
endorsed
Returnallchequestothe
cardholder,stampedand
endorsed
Selectivelyreturnordeposit
cheques,controlstampingand
endorsementindividuallyfor
eachcheque.Adefaultactioncan
bedefinedforallchequeswhere
aspecificactionisnotdefined.
Timer94
Ifchequesareejected,butnottaken,
retractandretainthemandsend
messagetoCentralasfollows:
Ifmultiplebunchesmustbeused
toreturnallchequesandcheques
areretractedbeforeallhavebeen
presented,sendasolicitederror
message
Ifchequesareretractedafterall
chequeshavebeenpresentedand
thestatusmessagehasalready
beensent,sendanunsolicited
messagetoindicatethatthe
chequeshavebeenretracted
Iftheretractedchequesjam
beforereachingtherejectbin,
sendanunsolicitederror
messagetoreportajam
NextStatein
TransactionReply
Command
NextStateScreen
10-81

TableNote105:ScreensreferencedbytheTransactionReplymust
containonlynestedscreens.Thescreensaredisplayedasfollows:
Nestedscreen1(TRANSACTION RESULTandPLEASE WAIT)

Nestedscreen2(PLEASE REMOVE CHEQUES)
Nestedscreen3(PLEASE WAIT FOR MORE CHEQUES)
Nestedscreen4(CHEQUES BEING RETRACTED).
Table 10-34
Deposit Media First During Valuable Media
Exchange (Function ID f)
State
Screen
Operation
TransactionRequest
(PLEASEWAIT)
SeeTableNote106
andTableNote
107
(PLEASEWAIT)
Depositnotes
SeeTableNote108
andTableNote
109
Returncard(ifspecified)
SeeTableNote110
Dispensenotes
Waitfortheconsumertotakethe
notes(whenretractisenabledand
option4asetto1)
SeeTableNote111
andTableNote
112
Dispensethecoins,printthe
receiptandjournaldatainparallel
SeeTableNote
112,TableNote
113,andTable
Note114
(TAKECASH)
Sendstatus
NextStatein
TransactionReply
Command
NextStateScreen
(forexampleSELECT
TRANSACTION)
TableNote106Thisfunctionmustonlybeusedwhennotesare
depositedandcashistobedispensedwithinasingletransaction
reply.Ifonlyanotedepositistobeprocessed,theDepositNotes
andPrint(functionID_)mustbeused.Ifthisfunctionisusedand
nonotesorcoinsarespecified,therequestwillberejectedwitha
SpecificCommandRejectofB11).
TableNote107Thisfunctioncanalsobeusedforthefollowing:
Whentheextendedcashdispenserinterface(option76setto
001)isusedtosupportmorethan4cassettetypes.
10-82

Whenadualdispenserispresent.
TableNote108Theinsertednotesaredepositedasthefirststepin
theprocessandmovedtothecashdepositbinsasdefinedbythe
deviceconfiguration.
TableNote109Ifasolicitednotedepositmessageissenttothe
host,nocash(notesand/orcoins)hasbeendispensed.Advance
NDCwaitsforfurtherinstructionfromthehost,forexample,to
displayanerrormessageandprintareceiptindicatingthatallthe
consumersinsertednoteshavebeencapturedbytheSSTandno
cashhasbeendispensed.
TableNote110Ifcardreturnduringtransactionprocessingis
specified,thecardisreturnedtotheconsumerandmustbetaken.If
thereisanerrorwhileprocessingthecard,ortheconsumerdoesnot
takethecardanditiscaptured,asoliciteddevicestatusmessagefor
thecardreaderissentandcashwillnotbedispensed.Ifthecardis
nottobereturnedduringthetransactionprocessing,cashwillbe
dispensedaftertheinsertednotesaredeposited.
Ifthedispensefailsthenasolicitedstatusmessageforthecash
handlerissent.Ifthedeviceisacombinedcashhandlerandnote
depositdevice,anunsolicitedstatusmessageforthenoteacceptor
willalsobesentifitsstatusisaffectedbythefailure.
TableNote111WhenthenotesspecifiedintheTransactionReply
havebeendispensed,anycoinsspecifiedaredispensedatthepoint
whereaReady9orReadyBstatusmessagewouldnormallybesent
forthecashdispenseoperation.AdvanceNDCMessageMode
options2and4controlwhencashdispensersolicitedmessagesare
sent(bothReady9anderrormessages).
AdvanceNDCcanbeconfigured(MessageModeoption4aissetto
0)tosendasolicitedmessage,afterthenoteshavebeensuccessfully
presentedoranerrorhasoccurred,uptoandincludingthecurrent
operation,thatis,withoutwaitingforacashretractoperationoran
autopurgecycle.
Alternatively,AdvanceNDCcanbeconfigured(MessageMode
option4aissetto1)tosendasolicitedmessageafteranerroroccurs
uptoandincludingthecurrentoperationorafterthenoteshave
beenretractedortaken.Withinthisfunction,anycoinsspecifiedare
dispensedatthepointwhereaReady9orReadyBstatusmessage
wouldnormallybesentforthecashdispenseoperation.
Fordetailsofhowtheflowofoperationsisaffectedbythesettings
forMessageModeoptions2and4,seeTable 1035,DepositMedia
FirstDuringValuableMediaExchange:OperationalFlowon
page 1084.
10-83

TableNote112Ifacashdispensersolicitedstatusmessageissent
tothehost,nocoinshavebeendispensed.
TableNote113Ifthereisafailureduringthecoindispense,a
solicitedstatusmessageforthecoindispenserissent.Printingwill
continueastheprintandcoindispenseoperationsareperformedin
parallel.
TableNote114Thereceiptdataspecifiedbythehostwillbe
printedevenifthereisaproblemdispensingcoins.Thehostcan
sendadditionalreceiptdataintheTransactionReplysentin
responsetoasolicitedcoindispensermessage.
Table 10-35
Deposit Media First During Valuable Media
Exchange: Operational Flow
Option 2A
Option 4A
Cash
Dep
Notes
Pres
Notes
Taken
Notes
Retracted
0
(retract
enabled)
Coins Dispensed
Print Ops
Message Sent
(coin
dispense
startsafter
notes
presented)
Ready9
(coin
dispense
startsafter
notes
presented)
Unsolicited
NotesRetract;
Ready9
(coin
dispense
startsafter
notestaken)
Ready9
(nocoins
dispensedas
notesnot
taken)
Solicited
NotesRetract
10-84

Cash
Dep
Notes
Pres
Notes
Taken
Notes
Retracted
(Ignored)
(Ignored)
Option 2A
Option 4A
Coins Dispensed
Print Ops
Message Sent
(coin
dispense
startsafter
notes
presented)
Ready9
(coin
dispense
startsafter
notes
presented)
Ready9
10-85

10
TheInteractiveTransactionResponse(ITR)messagemaybesentin
responsetoaTransactionRequestinordertoobtainmore
informationfromthecardholder.ThisfacilityallowsCentralto
communicatedirectlywiththekeyboardanddisplayinthose
situationswherestatetablesequencingisinappropriate.For
example,acardholderaccountselectioncanbehandledinthisway.
Centralcanestablishwhichaccountsareavailabletothecardholder
andbuildthescreenaccordingly.Themessagedefinesscreendata
andactivekeys.KeyboarddataisreturnedinaTransactionRequest
message.Fordetails,seeTransactionRequestMessageson
page 92..
SupportforTouchScreen
Emulation
10
physicalFDKs.Inthiscase,eight,fixed,touchareasaredefinedon
correspondingFDK.Thetouchareasareenabledanddisabledin
exactlythesamewayastheFDKs.Fordetails,seeFDKEmulation
onpage 42.
Alternatively,theterminalmaysupportfulltouchscreen
keyboards.Inthiscase,touchareasaredefinedonthescreenforall
therequiredkeys.Thecardholdertouchestheseinsteadofpressing
akeyonthekeypadoranFDK.Fordetails,seeChapter 4,
SupportforVoiceGuided
Sessions
Inavoiceguidedsession,Centralcansendamessagewithoneof
twoformatsusedinfieldj,asfollows:
10
DirectAudioTextformat.
Thetexttobespokenisincludedinthefield.Thetextmustnot
containspecialcharacters,suchasscreencontrolcharacters.The
specifiedtextisnotrepeated.Torepeatthetext,itmustbe
repeatedinthisfield.Fieldiisnotadjustedforavoiceguided
session.
IndirectAudioTextformat.
ThetexttobespokeniscontainedinthevoiceguidanceXML
configurationfileandreferencedfromthisfield.Thetext
specifiedintheXMLfileisnotrepeated.Torepeatthetext,
multipleTextelementsmustbeusedortherecordedvoicefile
mustcontainrepeatedaudiomessages.Fieldiisadjustedas
10-86

specifiedintheXMLconfigurationfile.FordetailsoftheXML
configurationfile,refertotheAPTRAAdvanceNDC,Developers
Guide.
MessageCoordination
Number(MCN)
10
IftheMCN(fielde2inTable 1036,InteractiveTransaction
Responsebelow)ispresent,theMessageSequenceNumber(field
e1)mustalsobepresent.IfMessageSequenceNumbersarenot
normallypopulated,fielde1mustbesetto000.
Iffielde2ispresent,itscontentwillbecomparedwiththeMCNin
thecurrentTransactionRequest.IftheMCNsdonotmatch,the
InteractiveTransactionResponsewillberejectedbydefault.This
canbechangedthroughEnhancedConfigurationParameteroption
34.
CentralcanoverridevalidationoftheMCNbyeitheromittingfield
e2orsettingitto0.
FordetailsoftheMCNinTransactionRequestsandhostresponses,
seefieldgoftheTransactionRequestmessage,onpage 93of
Chapter 9,TerminaltoCentralMessages.
FordetailsofEnhancedConfigurationParameteroption34,see
Option34MCNRangeonpage 711.
Table 10-36
Field
Number of
Characters
Mandatory/Optional
Description
Var
3DataCommand
theSST.
FS
FieldSeparator.
isignoredbytheSST.
FS
FieldSeparator.
e1
ignoredbytheSST
e2
MessageCoordinationNumber.SeeMessageCoordinationNumber
(MCN)above.
FS
FieldSeparator.
10-87

Field
Number of
Characters
Mandatory/Optional
Description
2InteractiveTransactionResponse
DisplayFlag.Thisonecharacterfieldinstructstheterminaldisplayas
follows:
0donotdisplaycardholderkeyboardentry
1displaycardholderkeyboardentry
2display*forcardholderkeyboardentry
ThekeyedresponseisstoredinGeneralPurposeBufferB(minimum
datalength1character),whichistheonlybufferincludedina
TransactionRequestmessagefollowingtheInteractiveTransaction
Response.
FormoreinformationongeneralpurposebuffersrefertotheAPTRA
Var(10)
ActiveKeys/TouchAreas.Thisisavariablelengthfieldwhich
activatestherequiredkeysortouchareasforcardholderresponsesas
follows:
0deactivatekeys/touchareas
1activatekeys/touchareas
Thefirstcharacterofthisfieldeitheractivatesordeactivatesall
numerickeys.
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
10-88

Field
Number of
Characters
Mandatory/Optional
Description
FDKH/FDKHtoucharea
10
FDKI/FDKItoucharea
Trailing0charactersmaybeomittedfromthisfield.
Note: IfnumerickeysareactiveandFDKAisalsoactive(orFDKIif
theoptionenablingthekeystotheleftofthecardholderscreenisset),
theEnterkeywillbeactiveandequivalenttoFDKAorFDKI.
Duringavoiceguidedsession,theFDK,numeric,Clear,Canceland
Enterkeyscanbeused.Ifthismessageindicatesthatoneormore
FDKsareactive,theactiveFDKsaremappedtothenumerickeyboard
asfollows:
FDK
Numeric Key
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.
10-89

Field
Number of
Characters
Mandatory/Optional
Description
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
GS
GroupSeparator.
j2
Var
ScreenUpdateDataField.Thismustbepresentiftheprecedinggroup
separatorispresent.Thisfieldrepresentsdatawhichisdisplayedon
theSSTscreenwhentheDirectAudioTextformatisused.
Var
10-90

EJ Commands
EJCommands
10
ThissectioncontainsdetailsofthefollowingEJcommands:
EJOptionsandTimers
Theformatandcontentofeachcommandisdescribedinthe
followingsections,alongwithanexplanationofcontinuousand
batchuploadmethods.
Note:IftheEJisnotconfigured,anyEJcommandssentwillbe
rejectedwithacommandreject.
FordetailsoftheSSTtoCentraluploadmessage,seeUploadEJ
DataMessageonpage 981.
EJOptionsandTimers
ThiscommandmaybesentbyCentralatanytimetoenable
electronicjournalupload,andtospecifytheoptionsandtimer
valuestobeused.Itmayalsobesentafterreceivingapowerfail
messagefromtheSSTtoreinstatetheEJuploadfeature.
10
Table 10-37
EJ Options and Timers
Field
Number of
Characters
Mandatory/ Optional
Description
Var
6ElectronicJournal
FS
FieldSeparator
FS
FieldSeparator
FS
FieldSeparator
CommandType.Thecommandtypeis:
3OptionsandTimers
10-91

EJ Commands
Field
Number of
Characters
Mandatory/ Optional
Description
OptionNumber.Possiblevaluesare:
Option60EJUploadBlockSize.Maximumsizeofthedataportionof
theEJUploadblock.Fordetails,seeUploadEJDataMessageon
page 981.
Option61RetryThreshold.Thenumberofattemptstosuccessfully
sendanEJUploadblockbeforetheEJisautomaticallydisabled.
SeeTableNote115.
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.
TableNote115: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.
10-92

EJ Commands
Table 10-38
Acknowledge EJ Upload Block
Field
Number of
Characters
Mandatory/ Optional
Description
Var
6ElectronicJournal
FS
FieldSeparator
FS
FieldSeparator
FS
FieldSeparator
1AcknowledgeUploadBlock
SeeTableNote117
LastCharacterReceived.Range000000999999.
SeeTableNote116.
ThevalueinthisfieldshouldbethesameasthevalueintheLast
CharacterThisBlockfieldinthelastUploadEJDatamessagesentby
theSST(seepage 981).
IftheLastCharacterReceivedisnotequaltothevalueoftheLast
CharacterThisBlockinthelastuploadblocksentbytheSST,andifEJ
uploadisinprogress,theSSTwillnotcountthisasan
acknowledgment,andwillcontinuetowaitforanacknowledgment
withoutresettingitstimer.IftheLastCharacterReceivedfield
contains000000thenAdvanceNDCwillresendthelastblockagain.
TableNote116:TheLastCharPreviousBlockandLastCharThis
TableNote117:IftheAcknowledgeEJBlockcommandisbeing
senttoenabletheEJuploadfunctionafterapowerfailora
communicationslossthentheLastCharacterReceivedfieldcanbe
anyvalue,buttherecommendedvalueis000000.Thiswillcause
theSSTtoenabletheEJuploadfunction,thentransmititscurrentEJ
data,startingfromthelastunacknowledgedblock.
10
ThiscommandacknowledgesthelastEJuploadblockreceivedby
Central,andinadditionindicatesthatEJuploadistocease.This
willdisabletheEJuploadfunctionuntilCentralsendsanew
10-93

EJ Commands
AcknowledgeEJUploadBlockcommandorEJOptionsandTimers
command.
TheAcknowledgeandStopEJcommandmayalsobesenttodisable
EJuploadatanytime(thatis,notinresponsetoanupload
message).
IfCentraldisablesEJupload,EJdatawillaccumulateattheSST
untilCentralreenablestheuploadfunction.Thisprocedurecanbe
usedtocontroltheuploadofEJdataatpeaklineloadtimes,ascan
lengtheningthetimeperiodbeforesendinganacknowledgement
message.ThistimedelayisconfiguredintheEJOptionsandTimers
command.
Table 10-39
Acknowledge and Stop EJ
Field
Number of
Characters
Mandatory/ Optional
Description
Var
6ElectronicJournal
FS
FieldSeparator.
FS
FieldSeparator.
FS
FieldSeparator.
2AcknowledgeandStopEJ
LastCharacterReceived.Range000000999999.SeeTableNote118.
ThevalueinthisfieldshouldbethesameasthevalueintheLast
CharacterThisBlockfieldinthelastUploadEJDatamessagesentby
theSST.Ifitisnot,EJuploadwillbedisabledandwhenitis
reenabledtheSSTwillsendthelastuploadblockagain.
TableNote118:TheLastCharPreviousBlockandLastCharThis
ContinuousandBatch
UploadMethods
10
ContinuousuploadisthenormalmethodofoperationwhentheEJ
uploadfunctionhasbeenenabled.Centralshouldacknowledge
eachuploadedblockassoonasitisknowntobeproperlystored,
andtheSSTshouldmarkEJdataintheejdata.logfileasbeingsentas
10-94

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

Message Validation
MessageValidation
10
Validationchecksareperformedonallmessagesreceivedfrom
Central.
ValidMessageClasses
10
ThefollowingarethevalidmessageclassesthatcomefromtheSST
toCentralandfromCentraltotheSST.
SSTtoCentral
10
ThevalidmessageclassesthataresentfromtheSSTtoCentralare1,
2,5and8.
CentraltoSST
10
ThevalidmessageclassesthataresentfromCentraltotheSSTare1.
3,4,6,7and8.
Note:Messageclass8enablesEMVsmartcardconfiguration.For
details,refertotheEMVIntegratedCircuitCard(ICC)Reference
Manual.
CommandRejectCauses
Thesituationswhichcauseacommandrejectareasfollows:
10
Illegalmessagesubclass
Illegalmessageidentifier
Illegalterminalcommandcode
Illegalterminalcommandmodifier
Fieldseparatorinthewrongposition
Insufficientfieldsinthemessage,forexample,anincomplete
InteractiveTransactionReplymessage
InsufficientmemorytoholdtheFITentry(FITnumbertoo
large)
Thedispenseamountrequestedislargerthanthenumberof
notesand/orcoinsreportedintheHardwareConfiguration
message
TheMessageCoordinationNumberinaTransactionReplyoran
InteractiveTransactionResponse(ITR)doesnotmatchthe
numberintheTransactionRequestandisnot0
InvalidfunctionIDinTransactionReplycommand.Aninvalid
functionIDisonenotsupportedbytheAPTRAAdvanceNDC
softwareoronerequiringtheuseofadevicethatisnotpartof
thehardwareconfiguration.
10-96

Message Validation
Note:Commandsrequestingareceiptorjournalprintwillnot
berejectedbecauseofanunconfiguredprinter.
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-40
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.
10-97

Message Validation
Value
Qualifier
Description
Notfoundwhenskippingthefirstthreefield
separatorsinaTransactionReplymessage.
Notfoundattheendofthecoinagefield.
NotfoundinMACFieldSelectionLoadData.
Mandatorylastfieldseparatornotfoundorfound
unexpectedlyinaTransactionReplymessage.
03
ToomanyprintgroupsintheTransactionReply
message.Morethan13printgroupsarepresentina
04
Agroupseparatorismissingorfoundunexpectedly.
Agroupseparatorisrequiredbetweenfieldsjand
j1aswellasbetweenaf2andaf3ofthe
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.
10-98

Message Validation
Value
Qualifier
Description
04
IllegalTerminalCommandCode:
Returnedifthecommandcodeisoutsidetherange
1?.
05
IllegalTerminalCommandModifier.Withinalegal
terminalcommand,ifamodifierisrequired:
ReporttalliesmodifieroutsidetherangeANor
VorYor\or[.
ReporterrorlogmodifieroutsidetherangeAC.
Theterminalcommandcodeis7andthecommand
modifierisoutsidetherange07.
06
InvalidFunctionIDinTransactionReplycommand:
FunctionIDisoutsidetherange19,A,B,C,
F,O,P,Q,S,T,b,c,e,f,*,,,:,#
or%.
07
DataFieldcontainsnonnumericdata.Thisisfound
inthefollowingcircumstances:
Encryptionkeychangemessagekeydata.
Coinagefieldhasatleastonenonnumericcharacter
present.
Option/Timernumberorvalueinconfiguration
message.
Fieldsae5ae10,af2oras2intheTransaction
Replymessagecontainanonnumericdigit.
08
Numericvalueoutofrange:
InaFITmessage,aFITdatavalueisgreaterthan
255.
Fieldsae3ae10oraf2intheTransactionReply
messagecontainavalueexceedingtheirmaximum
values.
09
InvalidMessageCoordinationNumber(MCN).Ina
TransactionReplyoranInteractiveTransaction
Response,theMCNisnotzeroanddoesnotmatch
thevalueintheTransactionRequest.
10
IllegalFITnumber.AFITinaFITloadmessageis
notintherangeofthereservedpoolsize.Legal
valuesare000999.
10-99

Message Validation
Value
Qualifier
Description
11
ToomanynotesinTransactionReplycommand.The
totalnumberofnotesrequestedexceedsthelimitof
40.
12
Reserved
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
10-100

Message Validation
Value
Qualifier
Description
IllegalMessageTypeforCurrentMode.
01
Messagetypeonlyacceptedwhileterminalisin
InServicemodeandisexpectingaTransaction
Reply.Therejectiscausedbyreceiptofa
TransactionReplyatothertimeswhiletheterminal
isInService.
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.
10-101

Message Validation
Value
Qualifier
Description
15
Cannotperformacommunicationsencryptionkey
changeduringacardholdertransaction,orwhenthe
terminalisinsuspendmode,orwhentheoperatoris
initiatingtheexecutionofsupervisoryorsettlement
transactions.
16
Reserved.
17
Keychangeoperationcannotbeacceptedin
restrictedmode.
18
Keyentrymodenotauthorised
HardwareFailure.
01
EncryptionFailureduringkeychangemessage.
02
TimeofDayclockfailureduringdata/timeset
commandorinvaliddatasent.
0305
Reserved.
06
Insufficientdiskspace.
07
FileI/OError
08
FileNotFound
OtherInvalidParameters
10
NotSupported.
01
Notsupportedbysoftware.Therequestedfunction
isnotsupportedbythesoftwareversioninuse.An
exampleisaDLLrequiredtocompletethe
transactionreplyprocessingismissing
02
Notsupportedbyhardware.Thehardwareisnot
presentorcannotsupporttherequest.
Examplesare:
TheBunchNoteAcceptor(BNA)functionhas
beenrequestedbutthereisnoBNApresent.
Sidewaysprintingonreceipthasbeenrequested
buttheoptionisnotavailable.
0304
Reserved.
05
Journalprinterbackupisinactive.
06
Theresponsemessageformatdefinitionisnot
compatiblewiththedataformat/lengththathasto
bereturnedinresponsetoacommandrequest.
Anyotherinvalidparameterinareceivedmessagewillbeaccepted
andtheappropriatedefaultoperationwilloccur,butsystem
10-102

Message Validation
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.
10-103

Messages Received in Wrong Operational Mode
MessagesReceivedinWrong
OperationalMode
10
Thefollowingtablesdescribewhatactionistakenifamessageis
receivedbytheterminalwhenitisinoneofthefollowingmodes:
PowerUp
OutofService
Supply
InService
Theactiontakenwilldependonwhichmodetheterminalisinat
thetimeofreceivingthemessage.Themessagesinclude:
CustomisationData
Commands
TransactionReplyCommands
TerminalCommands.
Formoredetailsofthesecommands,seeCustomisationData
Commandsonpage 107.
10
Table 10-41
Actions for Customisation Data Commands
Command Mode
Power-Up
Out-ofService
Supply
In-Service
StateTableLoad
Screen/KeyboardData
Load
Configuration
ParametersLoad
Interactive
TransactionResponse
A2
FITDataLoad
EncryptionKey
Change
A3
ExtendedEncryption
KeyChange
A3
ConfigurationID
NumberLoad
Enhanced
Configuration
ParametersLoad
10-104

Command Mode
Power-Up
Out-ofService
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-42
Actions for Transaction Reply Commands
Formoredetailsofthiscommand,seetheearlierTransaction
ReplyCommandsectioninthischapter.
10
Power-Up
Out-of-Service
Supply
In-Service
(Not TREQ
State)
In-Service
(TREQ State)
Print
Immediate
A1
Other
Command
Mode
RCommandReject.
AAcceptforprocessing.Ifcompletedsuccessfully,theresponseis
aReady9orReadyBstatus.Ifadeviceerror,theresponseisa
devicefaultstatusmessage.Ifaformaterror,theresponseisa
CommandReject.
A1IfthemodewasenteredfromOutofService,holduntil
OutofServiceisreenteredandthenprocessasA.Otherwise,the
responseisaCommandReject.IfanotherPrintImmediateis
received,thefirstoneisoverwritten.Thereisnoadditional
response.
10-105

TerminalCommands
Table 10-43
Actions for Terminal Commands
10
Formoredetailsofthesecommands,seetheTerminalCommands
sectiononpage 103.
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.
10-106
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
1112
1113
1116
KeyVerificationValues
DeterminingEncryptorKeyStatus
1117
1117
RSAInitialKeyLoading
IdentifyEPPandDetermineEPPCapabilities
1118
1118
Table of Contents
Security Features
RSAInitialKeyLoadingforSignatures
EPPAuthenticationProcess
StandardSignatureRemoteKeyLoading
Authentication
EnhancedSignatureRemoteKeyLoading
Authentication
LoadingInitialDESKeys
StandardMessageSequenceforDESKeyLoad
EnhancedMessageSequenceforDESKeyLoad
RSAEncryptedDESKeyFormat
SignatureFormat
Base94EncodingandDecoding
Encoding
Decoding
ChangingtheEncryptionKeyEntryMode
1125
1126
1127
1128
1129
1130
1130
1131
1132
1132
RSAInitialKeyLoadingforCertificates
ExchangeCertificates
LoadaDESKeyforCertificates
ReplaceaCertificate
PrimaryandSecondaryKeys
1133
1133
1135
1135
1136
DoubleLengthKeys
GeneralGuidelines
AdvanceNDCGuidelines
DoubleLengthRestrictedKeyEntryMode
1137
1137
1137
1138
JournalPrinterBackup
1139
1121
1121
1122
Security Features
Overview
Overview
11
ThischapterdescribesthesecurityfeaturesinAdvanceNDCand
providesguidelinesunderthefollowingtopics:
BAPEandEPPsecurity
RemotePINblock
Messageauthentication
Keyverificationvalues(KVVs)
RSAinitialkeyloading
Doublelengthkeys
Journalprinterbackup.
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.
11-2
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 1137.
ForinformationonkeymodesupportonothervendorsEPPs,refer
toChapter2,SupportforAdvanceNDCFeaturesintheAPTRA
AdvanceNDC,MultiVendorSupportReference.Forinformationon
anynecessaryconfigurationforothervendorsEPPs,referto
Chapter6,InstallingandConfiguringOtherVendorsHardware
intheAPTRAAdvanceNDC,MultiVendorSupportReference.
11-3
Security Features
Remote PIN Block
RemotePINBlock
11
TheremotePINblockisformattedandencryptedasdescribedin
thefollowingpassages:
FITFields
11
FITFields
PINBlockFormats
PINBlockEncryption.
ThefollowingFITfieldsareusedtodefinethePINblockformatand
PINblockencryption:
PMXPN(MaximumPINDigitsEnteredandPINblockformat)
PINPD(PINPad)
FordetailsoftheseFITfielddefinitions,seethefollowingsectionsin
Chapter 8,FinancialInstitutionTables:
PBFMT(PINBlockFormat)onpage 811
PMXPN(MaximumPINDigitsEntered)onpage 84
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.
11-4
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
Blockonpage 117.
ISOPINBlockFormat0isasfollows:
Figure 11-2
ISO PIN Block Format 0
Control
Field "0
PIN length,
4 to 12
PIN digits
PIN digits or
PAD digits,
depending on
PIN length
PAD digits,
always 15
11-5
Security Features
Remote PIN Block
ISOPINBlockFormat1
11
ISOPINBlockFormat1isasshownbelow:
Figure 11-3
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
ISOPINBlockFormat3
11
ISOPINBlockFormat3iscreatedbyXORingtogetherthePIN
Blockonpage 117.
ISOPINBlockFormat3isasshownbelow:
Figure 11-4
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
BANKSYSPINBlock
TheBANKSYSPINblockiscreatedbyXORingtogetherthePIN
Blockonpage 117.
11-6
11
Security Features
Remote PIN Block
TheBANKSYSPINblockisasfollows:
Figure 11-5
BANKSYS PIN Block
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
WhenthecardholderentersthePIN,thedigitsarepaddedtothe
rightwith0hexadecimal11tothemaximumdefinedbythefive
leastsignificantbitsofthePMXPNfield.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
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

First
Second
Single
COM
Double
SeeTableNote2.
MASTER
COM
Double
PEKEY
COM
(None)
SeeTableNote1.
Single
COM
11-8
Security Features
Remote PIN Block
Hexadecimal
Value
Type Of Encryption

First
Second
Double
MASTER
COM
Double
PEKEY
COM
(None)
SeeTableNote1.
TableNote1:Theencryptioncommands4andChexadecimal,
whichcallfortransmittinganunencryptedPINarenotsecure,and
arenotsupportedbyAdvanceNDC.
TableNote2:DoubleencryptioninvolvesencryptingthePINfield
usingthefirstencryptionkey,thenencryptingtheencryptedPIN
fieldusingthesecondencryptionkey.
11-9
Security Features
Message Authentication
11
WhenMessageAuthenticationisused,eitherCentralorthe
terminalsendingthemessageappendsaMessageAuthentication
Code(MAC)totheendofthemessage.TheMACiscalculatedfrom
themessagecontent,andisthereforespecifictothemessagethatit
iscreatedfrom.
ForsingleDESMACing,themessageauthenticationprocedure
conformstoANSIstandardX9.9.TripleDESMACingconformsto
ANSIstandardX9.19.
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.
11-10
Security Features
Steps2and3arerepeateduntilallthedatahasbeendealtwith.
ThefirstfourbytesofthefinalencryptionformtheMACfield.It
isregardedaseighthexadecimaldigits,eachofwhichis
convertedtoacharacterintherange09,AF.
DoublelengthKeys
11
IftheMACkeyisdoublelength,steps1to4areperformedusing
thefirsthalfofthekey.Thefinalresultisthendecryptedusingthe
secondhalfofthekey,andencryptedagainusingthefirsthalf.
Step5isthenperformedtoextracttheMAC.Thisisalsoknownas
LastBlockTripleDES.
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.
11-11
Security Features
FullMessage
Authentication
11
MessageAuthenticationiscontrolledbytheentryofinformationat
theSSTaspartoftheconfigurationprocess.RefertotheAPTRA
AdvanceNDC,SupervisorsGuidefordetails.Thisinformation
containsflagsthataredescribedinthefollowingtables.
Table 11-3
Message Authentication Configuration
Flag 1
Flag 1
Table 11-4
Flag 2
DonotcheckthetimevariantnumberinTransactionReply
messages,ortheMACinTransactionReply,StateTable,and
FITLoadorDispenserCurrencyCassetteMappingTable
messages.
CheckthetimevariantnumberinTransactionReply
messages,andtheMACinTransactionReply,StateTable,and
FITLoadandDispenserCurrencyCassetteMappingTable
messages.Flag2mustalsobesetforthisflagtohaveany
effect.
Flag 2
SeeTableNote3
DonotsendthetimevariantnumberandtheMACdatain
TransactionRequestmessages.
SendthetimevariantnumberandtheMACdatain
TransactionRequestmessages.
TableNote3:Flag2mustbesetto1toenablemessage
authentication.Ifthisflagissetto0,nomessageauthentication
occurswhateverthesettingsinflags1,8,9or10.
Validcombinationsofflags1and2are00,01and11.Whenflag
combination01isused,thefollowingapply:
MACandtimevariantfieldsarestillexpectedintheTransaction
ReplyandInteractiveTransactionReplyfromCentral,butthey
arenotchecked
MACandtimevariantfieldsmustnotbeincludedintheother
messagescontrolledbyflag1.
Table 11-5
Flag 8
Flag 8
DonotchecktheSecurityTerminalNumberinTransaction
Replymessages.
ChecktheSecurityTerminalNumberinTransactionReply
messages.
11-12
Security Features
Table 11-6
Flag 9
Flag 9
Table 11-7
Flag 10
TheMACcalculationisperformedonthewholemessage.
TheMACcalculationisperformedonthefieldsthatare
specifiedintheMACfieldselectiontable.Flag2mustalsobe
setforthisflagtohaveanyeffect.
Flag 10
DonotsendthetimevariantnumberandtheMACon
Solicitedstatusmessages.
SendthetimevariantnumberandMAConSoliciteddevice
statusmessages(excludingRDY).Flag2mustalsobesetfor
thisflagtohaveanyeffect.
Flags37arenotused,andmustbezerowhenFlags9and10are
used.
Flags1,2and10determinewhethertheMACistobe
performed.Flag2mustbesetfortheMACtobeperformed.
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 1026.
11-13
Security Features
Table 11-8
MAC Field Selection: Solicited Status
Message
Solicited Status Message

Offset
Meaning
0MACcompletemessage.Ignoretheremainingdigits.
1SelectivelyMACthefieldsbelow.SeeTableNote4.
Fieldsbandc
Fieldd
Reserved
Fielde
Fieldf
Fieldg1
Fieldg2.SeeTableNote5.
Fieldg3
Fieldg4
10
Fieldg5
TableNote4:FieldsareselectedforinclusionintheMACifthe
TableNote5:Whenfieldg2issettobeMACedselectively,any
groupseparatorswithinthatfieldwillnotbeMACed.
Table 11-9
MAC Field Selection - Other Messages
Other Messages
Offset
Meaning
0DonotMACFITLoadmessages.
1MACFITLoadmessages.
0DonotMACStateTableLoadmessages.
1MACStateTableLoadmessages.
0DonotMACTerminalStatemessages.
1MACTerminalStatemessages.
0DonotMACDispenserCurrencyCassetteMappingTable
messages.
1MACDispenserCurrencyCassetteMappingTable
messages.
11-14
Security Features
Table 11-10
MAC Field Selection - Track 1, Track 2,
Track 3
Track 1, Track 2, Track 3

Offset
Meaning
0MACfulltrack.Ignorebytes1n.
1SelectivelyMACthefieldsbelow.SeeTableNote6.
Subfield1(includingstartsentinel)
2n
Subfields2n
TableNote6:SubfieldsareselectedforinclusionintheMACifthe
AmaximumoffivefieldsispossibleonTracks1and2,andtenon
Track3.
Iftherearefewerthanthemaximumnumberofsubfieldspresent
onthecard,theexcessbytesaresettozero.Thelastsubfield
containstheendsentinel.Ifthesubfieldsthatcontainthestartand
endsentinelsarespecifiedforinclusionintheMAC,thenthe
sentinelsareincluded.
Thetrackfieldsareonlyexaminediftherelevantoffsetbyteissetin
theTransactionRequest/Replyfield.
ThefollowingtableisonlyrelevantifyouareusinganEMV
IntegratedCircuitCard(ICCorSmartCard):
Table 11-11
MAC Field Selection For EMV ICC
Configuration Messages
EMV ICC (Smart Card) Configuration Messages

Offset
Meaning
0DonotMACICCCurrencyDataObjectsTablemessages.
1MACICCCurrencyDataObjectsTablemessages.
0DonotMACICCTransactionDataObjectsTablemessages.
1MACICCTransactionDataObjectsTablemessages.
0DonotMACICCLanguageSupportTablemessages.
1MACICCLanguageSupportTablemessages.
0DonotMACICCTerminalDataObjectsTablemessages.
1MACICCTerminalDataObjectsTablemessages.
0DonotMACICCTerminalAcceptableAIDsTable
messages.
1MACICCTerminalAcceptableAIDsTablemessages.
11-15
Security Features
UsingSelectiveMessage
Authentication
Table 11-12
Selective MAC Default Field Values
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.
TableNote7:Thesedefaultscanbechangedbyadownload
TableNote8:Whenselectivefieldsareused,theyaretakenin
sequencefromthemessagetobuildasingledatastring.Fieldand
groupseparatorsarenotincluded.Emptyfieldsareomitted.Ifthe
completedatastringisempty,noauthenticationisattemptedand
theMACissettozero.
TableNote9:TheselectiveMACiscalculatedinthesamewayas
forfullMessageAuthentication.
11-16
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
SST
EEKC, 'H' - Send all KVVs
EID, '4' - KVV table
11-17
Security Features
RSA Initial Key Loading
RSAInitialKeyLoading
11
WhereanSSTisfittedwithanEncryptingPINPad(EPP),the
AdvanceNDCapplicationsupportstheloadingoftheinitial
encryptionkeys(Akey,BkeyandVkey)usingRSAencryption,
insteadoflocalentryinSupervisormode.
InitialkeyloadingusingRSAissupportedonNCRSSTsusinga
signaturebasedscheme.Forhardwarefromothervendorsthatuse
acertificatebasedscheme,AdvanceNDCsupportscertificates.
Inthefollowingsectionsanddiagrams,forbothsignaturesand
certificates,thefollowingabbreviationsareused:
IdentifyEPPand
DetermineEPP
Capabilities
EEKC
ExtendedEncryptionKeyChange;fordetails,seethe
ExtendedEncryptionKeyChangeonpage1037
EID
EncryptorInitialisationData;fordetails,seeEncryptor
InitialisationDataonpage976section
KVV
KeyVerificationValue;fordetailsseeKeyVerificationValues
onpage1117.
AsthehostmayhavetohandleamixednetworkofSSTs,asystem
ofreportingthecapabilitiesofthePINdeviceisrequiredtosupport
thefollowingschemes:
11
Standardsignaturescheme
Enhancedsignaturescheme
Certificatescheme
Thediagramonthenextpageshowsthemessagesequenceusedto
determinetheEPPcapabilities.
11-18
Security Features
Figure 11-8
Identify EPP and Determine EPP
Capabilities
Host
NDC
XFSPIN
EEKC,Q
Sendencryptor
capabilitiesandstate
WFS_INF_PIN_CAPABILITIES
WFS_INF_PIN_STATUS
EID,B
Encryptorcapabilitiesandstate
(RemotekeyschemeCertificatestate)
EEKC,ForV
SendEPPserialnumber
EID,5
EPPserialnumberorReject
SupportforcertificatesdependsontheCENXFSinterfaceandnot
onNCRhardware.TheAdvanceNDCmessageinterfaceisnot
tightlydefinedoroptimisedforNCRhardware,butreflectsthe
generaliseddefinitionsoftheCENinterface.Itisnotpossiblefrom
theAdvanceNDCinterfacespecificationalonetodetermineexactly
howtoimplementremotekeyloadingusingcertificatesfromthe
host.ReferencetotheCEN,ANSIandRSAstandardsisrequiredto
determinemessageformats.
TheANSIstandarddefinestheoveralloperationofthekeyloading
schemes.TheCENXFSstandarddefinestheinterfacetothePIN
deviceintheSST.
SupportforthefeaturesdefinedinCENXFSmayvaryfromvendor
tovendor.Supportforcertificatesandsignaturesonothervendors
hardwareisdesignedtocoverthefeaturesdefinedbytheCENXFS
specificationbutitdoesnotimplythatallfeaturesdescribedare
supportedbyallvendors.
ForfurtherinformationabouttheRSAencryptionandsignature
schemes,refertotheRSALaboratoriesCryptographicTokenInterface
StandardPKCS#1v2.0.
11-19
Security Features
ForfurtherinformationabouttheCENXFSinterfacespecification,
referto
http://www.cen.eu/CEN/sectors/sectors/isss/activity/Pages/wsxfs.aspx
ForfurtherinformationabouttheANSIstandard,referto
http://ansi.org/
11-20
Security Features
RSA Initial Key Loading for Signatures
RSAInitialKeyLoadingfor
Signatures
11
Twoversionsofthesignaturebasedkeyexchangeprotocolare
supportedfortheinitialkeyloadingusingRSA,asfollows:
EPPAuthentication
Process
11
EnhancedSignatureRemoteKeyLoading.
BeforeusingRSAencryption,theHostSecurityModule(HSM)at
thehostandtheEPPintheterminalmustperformanauthentication
processwhichsatisfiestheconditionsdescribedinthissection.
TheobjectiveoftheinitialkeydownloadistotransferaDES
encryptionkeyfromtheHSMatthehosttotheEPPintheterminal.
Therearethreeimportantconditionstothistransfer:
TheDESkeymustremainsecret.OnlythesourceHSMand
destinationEPPcanknowthekey.
TheEPPmustonlyacceptakeyfromanHSMidentifiedas
authentic.
TheHSMmustonlysendthekeytoanEPPidentifiedas
authentic.
RSAencryptionisusedtomeettheseconditions.RSAencryption
usesasymmetriccryptographyalgorithms(alsoknownasan
asymmetricencryptionscheme)whichuseapairofkeys:onekeyis
usedforencryption;theotherkeyisusedfordecryption.
Oneofthekeysiskeptsecretandtheotherkeyismadepublic.
Duringtheauthenticationprocess,RSAencryptionisusedfor
encryptingsecretdataandforsigningdata.WithRSAencryption,
anybodycanencryptdatausingthepublickey,butonlytheholder
ofthesecretkeycandecryptthedata.
Signaturesareusedtopreventmessagesfrombeingchanged
duringtransmissionandthesenderfrombeingimpersonated.A
SecureHashingAlgorithm(SHA)isappliedtothemessageand
thentheresultisencrypted.WithRSAencryption,thesecretkeyis
usedforgeneratingthesignature.Onlytheholderofthesecretkey
cangeneratethesignature,butanybodycanverifythesignature
usingthepublickey.
Inthesesectionsandthediagrams,[message]PKisusedto
representamessageencryptedwithapublickey(PK),and
(message)*SKrepresentsamessagesignatureusingasecretkey
(SK).
11-21
Security Features
Authentication
11
TwopairsofRSAkeysareusedtotransferaninitialDESkey
(theAkey)fromtheHSMtoanEPP.Onepairofkeysisassociated
withtheHSM(SKHSMandPKHSM);theHSMretainsSKHSM
andsendsPKHSMtotheEPP.Theotherpairisassociatedwiththe
EPP(SKEPPandPKEPP);theEPPretainsSKEPPandsends
PKEPPtotheHSM.
TheHSMusesPKEPPtoencrypttheAkey,representedby
[Akey]PKEPP,sothatonlytheEPPcandecryptitusingSKEPP.
TheHSMsignsthemessageusingSKHSM,representedby
([Akey]PKEPP)*SKHSM,sothattheEPPcanverifythatthe
messagecamefromtheHSMandhasnotbeenaltered.Thisis
summarisedinthefollowingdiagram:
Figure 11-9
HSM - EPP A-key Message Exchange in
Standard Mode
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
Therearestillacoupleofissuestoresolve:
HowtheHSMchecksthatthePKEPPcamefromanauthentic
EPP,ratherthananimpostortryingtostealtheAkey
HowtheEPPchecksthatthePKHSMcamefromanauthentic
HSM,ratherthananimpostorattemptingtoloadtheirown
keys.
AfurtherstepisthusrequiredtoauthenticatetheEPPandHSM
publickeys.ThisusesathirdpairofRSAkeysgeneratedbythe
vendorNCRintheseexamples(SKNCRandPKNCR).
SKNCRwillbekeptinasecuritymoduleinahighlysecure
locationwithinNCR.
11-22
Security Features
WhenPKEPPandSKEPParegeneratedandwrittentotheEPP
duringtheEPPmanufacturingprocess,SKNCRisusedtosign
PKEPP,thatis,(PKEPP)*SKNCR.ThissignatureandPKNCRis
alsowrittentotheEPP.UsingsomeothersecurechannelPKHSM
istransferredtothevendorssecurelocationandsignedusing
SKNCR,thatis,(PKHSM)*SKNCR.Usingasecurechannel,this
signatureandPKNCRarewrittentotheHSM.
Thisprocessissummarisedinthefollowingdiagram:
Figure 11-10
Authentication of EPP/HSM Public Keys in
Standard Mode
NCR Security
Module
Secure channel
PK-HSM
During manufacture
PK-NCR,
(PK-HSM) * SK-NCR
SK-EPP, PK-EPP,
(PK-EPP) * SK-NCR
PK-NCR
New EPP
HSM
WhentheHSMandEPPexchangepublickeys,thesignatures
createdusingSKNCRarealsoexchanged.TheHSMandEPPcan
authenticatetheotherspublickeybyverifyingthesignaturesusing
PKNCR,assummarisedbythefollowing:
Figure 11-11
HSM/EPP Signature Verification in
Standard Mode
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
11-23
Security Features
Asanadditionalauthenticationmeasure,everyEPPhasaunique
serialnumber(SNEPP)thatiswrittentotheEPPduring
manufacture.TheserialnumberisalsosignedwithSKNCRand
canbetransmittedtothehostandtheHSM.
AnewlyinstalledEPPrequiresanexchangeoftheabovemessages
withthehost,toauthenticatetheEPPtotheHSMandtheHSMto
theEPP.Oncetheauthenticationiscomplete,RSAencryptioncan
beusedtoloadtheinitialkeys(A,BandV)intotheEPP.
Note:Untiltheinitialkeyshavebeenloadedintotheencryptor,
AdvanceNDCisrestrictedintheoperationsitcanperform.In
particular,itcannotMACanymessageswithoutaMACkeyoraB
key;thereforetheauthenticationprocesscannotusemessage
formatswhichnormallyhaveaMAC.TheExtendedEncryption
KeychangemessageisusedforsendinginformationtotheSST,and
anewmessageformat(EncryptorInitialisationData)isusedfor
sendinginformationfromtheSSTtothehost.
ThemessagesequencetoauthenticateanEPPinAdvanceNDCin
StandardSignatureRemoteKeyLoadingmodeisshowninthe
followingdiagram:
Figure 11-12
EPP Authentication Message Sequence in
Standard Mode
Host
SST
EEKC, Q - Send encryptor capabilities and state
EID, B - Encryptor capabilities and state
EEKC, F or V - Send EPP serial number
EID, 1 or E - EPP serial number and signature or Reject
EEKC, B - Load HSM public key and signature

EID, 5 - Key loaded or Reject
EEKC, G - Send EPP public key

EID, 2 - EPP public key and signature or Reject
11-24
Security Features
Note:IftheSSTdoesnotcontainanEPP,themessagesarerejected
withE02Functionnotsupportedbyhardware.
EnhancedSignatureRemoteKeyLoading
Authentication
11
TheEnhancedSignatureRemoteKeyLoadingAuthentication
schemeissimilartotheStandardSignatureRemoteKeyLoading
authenticationschemebuthasthefollowingdifferences:
AnadditionalpairofRSAkeysisintroducedintothehostkey
hierarchy.Thisadditionalkeypairisusedtoensureonlypublic
keysbelongingtothecorrecthostcanbeloadedintotheEPP.
Thiskeypairisknownas(SKHOSTRootandPKHOSTRoot).
Aselfsignaturemustbeprovidedbeforeeitherthe
PKHOSTRootorPKHOSTcanbedeleted.Akeymustbe
deletedbeforeitcanbereplaced.
Inthisscheme,SKNCRisusedtosignthehostrootkey
PKHOSTRootusingasecurechannelasinthestandard
authenticationmode,andPKHOSTRootisusedtosignPKHOST
asshowninthefollowingdiagram:
Figure 11-13
Authentication of EPP/HSM Public Keys in
Enhanced Mode
NCR Security
Module
Secure channel
PK-HSMRoot
During manufacture
PK-NCR,
(PK-HSMRoot) * SK-NCR
HSM
SK-EPP, PK-EPP,
(PK-EPP) * SK-NCR
New EPP
SK-HSM, PK-HSM, (PK-HSM) * SK-HSMRoot
ThisauthenticationexchangeresultsintheHSMcontainingthe
following:
PKNCR
SKHSMRoot
PKHSMRoot
(PKHSMRoot)*SKNCR
SKHSM
11-25
Security Features
PKHSM
(PKHSM)*SKHSMRoot
ThemessagesequencetoauthenticateanEPPinNDCinthe
EnhancedSignatureRemoteKeyLoadingmodeisshowninthe
followingdiagram.
Figure 11-14
EPP Authentication Message Sequence in
Enhanced Mode
Host
SST
EEKC,ForVSendEPPserialnumber
>
EID,1orEEPPserialnumber&signatureorReject
<
EEKC.R,LoadHSMRootpublickey&signature
>
EID.5KeyloadedorReject
<
EEKC,BLoadHSMpublickeyandsignature
>
EID5KeyloadedorReject
<
EEKC,GSendEPPpublickey
>
EID,2EPPpublickey&signatureorReject
<
IftheSSTdoesnotcontainanEPP,themessagesarerejectedwitha
rejectreasonofE02Functionnotsupportedbyhardware.Ifthe
EnhancedSignatureschemeisnotsupported,theEEKCRmessage
isrejectedwithreasonE02Functionnotsupportedbyhardware.
LoadingInitialDESKeys
11
AfterperformingtheEPPauthenticationprocess,theDESkeyscan
beloaded.Thesectionsonthefollowingpagesdefinethesequence
ofmessagesforeachscheme.
11-26
Security Features
StandardMessageSequenceforDESKeyLoad
11
Thestandardmessagesequenceisshowninthefollowingdiagram:
Figure 11-15
DES Key Load Standard Message
Sequence
Host
EEKC, C - Load initial master key (A key) with RSA key
SST

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
11-27
Security Features
EnhancedMessageSequenceforDESKeyLoad
11
Theenhancedmessagesequenceisasfollows:
Figure 11-16
DES Key Load Enhanced Message
Sequence
Host
SST
EEKC, N - Send SST Random Number
EID, 9 - SST Random Number





Note:AllthedatareturnedintherandomnumberfromtheSSTis
includedinthecryptogram.
11-28
Security Features
KeyDeletion IntheEnhancedRemoteKeyLoadingscheme,the
hostkeysthathavebeenimportedmustbedeletedbeforetheycan
bereplaced.Inaddition,topreventunauthoriseddeletionofthese
keys,thepublickeysaredeletedonlyiftherequestisaccompanied
byasignatureoftheconcatenationoftheEPPserialnumberandthe
publickeytobedeletedwiththecorrespondingsecretkey.
11
IfthePKHOSTisdeleted,thenPKHOSTRootremainswithinthe
EPPandcanbeusedtoloadanotherPKHOST.IfPKHOSTRootis
deleted,bothPKHOSTRootandPKHOSTaredeleted.
ThemessagesequencetodeletethePKHOSTintheEPPisas
follows:
Host
Figure 11-17
Enhanced Signature Remote Key Load
Mode: Delete PK-HOST
SST
EEKC,SDeletePKHOST
>
EIDCKeydeletedorReject
<
ThemessagesequencetodeletePKHOSTRootintheEPPisas
follows:
Host
Figure 11-18
Enhanced Signature Remote Key Load
Mode: Delete PK-HOSTRoot
SST
EEKC,SDeletePKHOSTRoot
>
EIDCKeydeletedorReject
<
Note:DeletingPKHOSTbeforedeletingPKHOSTRootisnot
necessaryasdeletingPKHOSTRootautomaticallyresultsin
PKHOSTbeingdeleted.
RSAEncryptedDESKey
Format
11
WhenloadinganinitialDESkeyusingRSAencryption,the8or16
bytesofthekeyareencryptedusingtheRSAESPKCS1v1_5
schemedescribedintheRSALaboratoriesCryptographicToken
InterfaceStandard(PKCS#1v2.0).
TheSSTdecodestheblockasasingleordoublelengthkey,
dependingonthekeyentrymodeselectedinSupervisormode.
11-29
Security Features
Fortransmissiontotheterminal,thedataisencodedasdescribedin
Base94EncodingandDecodingbelow.
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
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
11-30
Security Features
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
11
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]
}
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.
11-31
Security Features
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
}
ChangingtheEncryption
KeyEntryMode
Aftertheauthenticationsequenceisperformed,theencryptionkey
entrymodecanbechangedremotelyusingthefollowingsequence:
11
Figure 11-19
Key Entry Mode Remote Change
Sequence
Host
SST
EEKC, 'J' - Set Key Entry Mode
EID, '6' - Key Entry Mode
Warning:
ChangingthekeyentrymodedeletesalltheDESkeysinthe
encryptor.
11-32
Security Features
RSA Initial Key Loading for Certificates
RSAInitialKeyLoadingfor
Certificates
11
OncethecapabilitiesoftheEPParedetermined,certificatesare
processedasfollows:
ExchangeCertificates
11
Exchangecertificates
LoadaDESKey
Replaceacertificate
Primaryandsecondarykeys.
ThisexchangeisusedtoexchangethepublickeysofthehostsHSM
andthePINdeviceintheSST.Itisverysimilartotheexchangingof
publickeysinthesignaturesystem.Wherethereisapossibilityof
multiplecertificationauthorities(CAs)beingused,thehostcan
determinewhichCAtheSSTexpectsbyreadingtheSSTs
certificates,whichcontaintheidentityoftheCA,beforesendingits
own.Themessagesequenceisshownonthenextpage.
11-33
Security Features
Figure 11-20
Exchange Certificates
Host
NDC
XFSPIN
EEKCM0
SendSSTencryptorcertificate
WFS_CMD_PIN_
GET_CERTIFICATE
EID8 SSTcertificate
(SSTencryptioncertificate)
SSTencryptionCertificate)
EEKCM1
SendSSTverificationcertificate
WFS_CMD_PIN_
GET_CERTIFICATE
EID8SSTcertificate
(SSTencryptioncertificate)
(SSTencryptionCertificate)
EEKCLLoadhostcertificate
(Hostcertificate)
EID7 RSAKVV
(RSAKVV)
(Hostcertificate)
WFS_CMD_
LOAD_CERTIFICATE
(RSAKVV)
11-34
Security Features
LoadaDESKeyfor
Certificates
Theexchangerequiredforloadingasymmetrickeyismore
complexthanthatusedwithsignatures.
11
Figure 11-21
Load a Certificate DES Key
Host
NDC
XFSPIN
EEKCN SendSSTrandomnumber
WFS_CMD_PIN_
START_KEY_EXCHANGE
EID9SSTRandomnumber
(RSST)
(RSST)
EEKCO LoadAkeyPKCS7encoded
(KeyLoadPacket)
KeyLoadPacket)
WFS_CMD_PIN_IMPORT_RSA_
ENCIPHERED_PCKS7_KEY
EIDAPKCS7keyloaded

(KeyLoad
(KeyLoadAcknowledgementPacket)
AcknowledgementPacket)
ReplaceaCertificate
Figure 11-22
Replace a Certificate
11
Thisexchangeisuniquetothecertificatesystemandisusedto
replacethecertificationauthority(CA)certificates.Thereisno
equivalenttothisinthesignaturesystem.
Host
NDC
XFSPIN
EEKCPReplaceCACertificate
(CACertificate)
WFS_CMD_
PIN_REPLACE_CERTIFICATE
EID7RSAKVV
(RSAKVV)
(RSAKVV)
11-35
Security Features
PrimaryandSecondary
Keys
11
Thecertificateschemesupportsprimaryandsecondarysetsofkeys.
Iftheprimarykeysarecompromised,theEPPcanbeswitchedto
usethesecondarykeys.Theswitchoverisaccomplishedthrough
thehostsendingtheEPPaninstructiontousethesecondarykeys.
DataembeddedinthePKCS#7packetfromthehostindicateswhen
theEPPistoswitchtousingitssecondarykeys.
Oncethesecondarykeyshavebeenactivated,itisnotpossibletogo
backtousingtheprimarykeys.Ifthesecondarykeysare
compromised,thishastoberesolvedaccordingtothe
recommendationsoftheEPPmanufacturer.
TheEncryptorCapabilitiesreturnedinEIDBindicatewhetherthe
primaryofsecondarykeysareinuse.
ThecertificatesreturnedinresponsetotheSendSSTCertificates
EEKCMwillbeeitherprimaryorsecondarydependingonthe
stateoftheEPP.
11-36
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
outsidetheSSTssecuritymodule.
Keysshouldnothavemultipleuses.Forexample,thekeyused
toprotectotherkeysduringtransfershouldnotbeusedfor
transferringPINblocksorforlocalPINverification.
Initialkeysshouldbeloadedorentereddirectlyintothe
encryptormoduleintwoormorefulllengthblocks,andthen
XORedtogethertocreatethekey.
MACingshouldbeusedtopreventmodificationofsensitive
dataduringtransmission.
AdvanceNDCsupportstheEncryptingPINPad(EPP)and
doublelengthkeys.
Theaboveguidelinescanbemetbyusingthefollowingmodesof
operationwithAdvanceNDC2.04orabovewithanEPP:
Allkeysusedshouldbedoublelength,includingthemasterkey
(Akey),communicationskey(andBkey),MACkeyandVISA
masterkey.
Useonlythemasterkeyforloadingotherencryptionkeys,and
donotusethemasterkeyforanyotherpurpose.
UsethecommunicationskeyforPINblockencryptionandISO
format3PINblock.
PerformMACingintripleDESmode.
Loadtheinitialmasterkey(AKey)intotheencryptor,andthen
usethemasterkeytoloadalltheotherrequiredkeys.Donotuse
themasterkeyaspartofthelocalPINverificationorforPIN
blockencryption.
Althoughallkeysusedshouldbedoublelength,itispossibletouse
asinglelengthEncryptedPINKey(PEKEY)providedthePINblock
isalsoencryptedusingthecommunicationskey.
11-37
Security Features
Double-Length Keys
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,theimportisrejectedwithanEncryptionkey
changefailedmessage.
Forfurtherdetailsofthemenuoptions,refertotheAPTRAAdvance
11-38
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
Loadonpage 1017.
Ifjournalprinterbackupissetandthejournalprinterentersafatal
state,journallingcontinues,usingthejournalbackupmodeandthe
bufferfileresidentonthesystemdisk.Thejournallingincludesthe
textofthelastjournalprintercommandsenttothejournalprinter
beforeitenteredthefatalstate.
Fordetailsofwhathappenstothedatawhenthejournalprinter
becomesoperationalagain,refertotheAPTRAAdvanceNDC,
SupervisorsGuide.
Forsecurityreasons,reprintingfromthejournalbackuplogtothe
journalprinterissuspendediftheSSTgoesoffline,butcontinuesas
soonascommunicationshavebeenreestablished.
11-39
Security Features
Journal Printer Backup
11-40
Table of Contents
EMV Smart Card Handling
Chapter 12
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
Table of Contents

Overview
L
Overview
12
Thesmartcardhandlingdescribedinthischapterillustrateshow
EMVsmartcardscanbeusedwithAdvanceNDC.
ForfurtherdetailsofusingEMVsmartcards,refertotheEMV
IntegratedCircuitCard(ICC)ReferenceManual.
12-1

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

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

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

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

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.
Statetowhichtheterminalproceedsifthe
cardholderpressestheCancelkey.
GuidelinesforHandling
SmartCardTransactions
12
Thissectionprovidesrecommendationsandguidelinesonhowto
handlesomeofthepossibletransactionsinvolvingsmartcards.
Notethatthedifferentscenarioswillrequiredifferentvaluestobe
setinEnhancedConfigurationParametersLoadoption39
(NonmagneticCardAccept).Thesettingchosenwillbedetermined
12-6

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

CloseState(J)cardisreturnedtothecardholderandthe
transactionends.
Recommendations
12
Donotusenonmagneticcardacceptcommandsunlessyouhaveto
handlenonmagneticsmartcards.
Duringnonmagneticsmartcardaccept,ifnomagneticorchipdata
isfound,displayascreenduringtheClosestateindicatingtothe
cardholderthecorrectorientationforenteringcards.
WherethesamereadconditionsaretobeusedonSSTswitha
mixtureofmagneticcardreadersandsmartcardreaders,makesure
thatthereisatleastonemagneticdataonlyreadconditioninthe
CardReadState.
12-8
Table of Contents
CCM VISA2 Dialup System
Chapter 13
Overview
131
DialupSystemSetup
BaudRate
DialupTimers
ModemTimers
ApplicationTimers
PreDialandNormal
EJUpload
132
132
132
132
133
133
133
DialupMessages:SSTtoCentral
ImAliveMessage
ActivityTimer
ErrorRedialTimer
MessageonCP
MessageSuppression
134
135
135
136
136
136
136
DialupMessages:CentraltoSST
DisconnectMessage
NoOpMessage
ExampleUsageoftheNoOpCommand
GoOutofService(SupervisorMode)
137
137
138
139
139
Table of Contents

Overview
M
Overview
13
Withadialupsystem,theapplicationbehaviourisnotalwaysthe
sameasinothersystems.Thischapterdiscusseshowmessagesare
handledonSSTsthatuseCCMVISA2dialupcommunicationswith
Central.
13-1

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

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

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

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
2Solicitedmessage.
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
13-5

ofthelinetoCentralandstoppedonconnection.Ifthetimer
expires,theSSTattemptstoestablishaconnection.Iftheattempt
succeeds,anImAlivemessageissent.Thetimerisconfigurable
throughtheDialupConfigmenuinSupervisor.
ErrorRedialTimer
13
Whenanerrorisencounteredontheline,theSSTgoesofflinefor
theperiodoftheErrorRedialtimer,afterwhichitdialsupand
attemptstosendanImAlivemessage.Iftheattemptsucceeds,the
SSTwillgoinservice.Iftheattemptfails,theSSTremainsoffline
andrestartsthetimer.ThetimerisconfigurablethroughtheDialup
ConfigmenuinSupervisor.
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.
13-6

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
Type
Contents
Description
Command
Pending
Flag
Alphan
umeric
AcommandispendingatCentral
Space
NocommandinpendingatCentral
Reserved
Spaces
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
1TerminalCommand.
FS
FieldSeparator.
13-7

Field
Number of Bytes
Mandatory
/Optional
3or9
Loadmessage.Thedefaultnumberis000.Ifthedatasecurity
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
1TerminalCommand.
FS
FieldSeparator.
3or9
LoadMessage.Thedefaultnumberis000.Ifthedatasecurity
containingthemachinenumber.
FS
FieldSeparator.
FS
FieldSeparator.
Commandcode.Onecharacterfieldusedtoidentifythetypeof
TerminalCommandcode.Thecodeusedinthisfieldis:
GMaintainconnectiontocompletetransaction(NoOp).
13-8

ExampleUsageoftheNoOpCommand
13
Oneexampleofthisuseiswhereacustomertransactionrequires
tworequest/replycompletiontransmissionsinordertocomplete
thetransaction.TheNoOpcommandsentafterthefirstcompletion
allowsthesecondrequesttobesentwithouttheSSThangingup
andredialling.MessageonCPmustbeenabledthroughSupervisor
toallowamessagetobesentaftertheCPmessage.
GoOutofService
(SupervisorMode)
13
IfthehostsendsaGoOutofServicecommandtotheSSTwhilethe
SSTisinSupervisormode,theSSTwillsendaReadymessage
immediately.Thisisdifferentfromaleasedlinesystem,wherethe
commandisqueuedattheSSTandnotprocesseduntiltheSSTexits
Supervisormode.
13-9

13-10
Table of Contents
Reserved Screens
Appendix A
ReservedScreens
Overview
ScreenContent
DynamicText
VariablePrintData
UnderstandingtheTables
ScreenswithanAsterisk
ScreenswithaLowercaseLetter
A1
A1
A1
A1
A1
A2
A2
ASupervisorAcknowledgements
A3
EErrorScreens
A5
A18
MandmSupervisorMenus
A25
PSupervisorPrompts
A43
SSupervisorInformationLines
A49
TandtJournalTraceInformation
A53
UCheque,EMVSmartCardandBNA
A63
A70
iSupervisorTCP/IP
A72
Table of Contents
Reserved Screens
iSupervisorDialup
A75
iSupervisorBNA
A88
iSupervisorSettlementScreens
A92
jSupervisorandJournalMiscellaneousScreens
A95
Reserved Screens
Overview
Overview
Thetablesinthisappendixillustratethedefaulttextforthe
Supervisormenuscreens,andtheotherreservedscreensnot
coveredinChapter 3,ScreenData.Forallthereservedscreens,
refertotheresrvd.deffileprovidedwithAdvanceNDC.
ScreenContent
Somescreenscontainlongcontrolsequencesaswellasscreentext,
forexample,screenM06.Themeaningofthecontrolisexplainedin
thetable,insteadofthecontrolitself,whichyoucanseeinresrvd.def.
Otherscreenshaveprintercontrolsequences,forexample,M15.For
these,theASCIItextequivalentisshowninthetable,withan
explanationofwhatthecontroldoes.
DynamicText
Inresrvd.def,thepercentsign(%)isoftenusedtoindicatethestartof
textthatisdynamicallyeditedbeforethescreenisdisplayedor
printed.Forscreensthathavesuchdata,the%characteractsasa
placeholderandmustbeleftinplaceifyoueditorlocalisethetext.
Thedataisdisplayedwithoutpadding.Inthisappendix,the
percentsignisusedinthetablestoshowthestartandextentofthe
spaceusedbythedynamicallyediteddata.
VariablePrintData
Someofthescreens,forexampleU0168(seepage A68),display
datafrom.NETdatarecords,whichconsistoffieldname/value
pairsandaremappedtoscreennumbers.
Foreachofthesescreensinresrvd.def,thefieldnamesare
representedastextwithatrailingpercentsign(%)insideangle
brackets.Thetexthasnospacesandwhenthescreenisdisplayedon
theSST,thetextandpercentsignarereplacedbythevariabledata,
whichisdisplayedwithoutpadding.Theextentofthevariabledata
isnotindicatedinthetablesasthedatalengthisunknown.
Forscreensthatusethisconvention,thefieldnameandpercentsign
actasaplaceholderandmustbeleftinplace.Ifyoueditorlocalise
thetext,NCRrecommendsthatyoucarryoutusabilityacceptance
testingtocheckthedataiscorrectlyformatted.
UnderstandingtheTables
Foreachreservedscreen,thetablesidentifythescreennumberand
thepositionofthetextwithinthescreendata(thisisnotnecessarily
thefinalpositiondisplayedonthecardholderscreen/enhanced
operatorinterface).Textpositionisdisplayedbytherowand
columnpositionsforeachscreen,startingfromrow1,column1in
A-1
Reserved Screens
Overview
thetopleftcorner.Operatorscreensare16rowsby32columnsand
printerscreensare16by40.
ScreenswithanAsterisk
Screenswithanasterisk(*)afterthescreennumberindicatethe
screensareusedonlyonothervendorsSSTs.Formoreinformation,
refertotheAPTRAAdvanceNDC,MultiVendorSupportReference
Manual.
ScreenswithaLowercaseLetter
Screensstartingwithalowercaseletterapplytofunctionality
developedforAdvanceNDCandareplacedafterscreensstarting
withanuppercaseletter.
AdditionalSupervisormenusandfunctionsforTCP/IPandDialup
communications,cashacceptorsandSupervisorsettlement
transactionsstartwithalowercasei.Furtherscreensusedin
Supervisorandforjournalingstartwithalowercasej,andare
groupedattheendoftheappendix.
Note:Sidewaysprintingonthereceiptisnotsupportedwhen
printingSupervisorreservedscreens.
ForinformationonthescreensusedinSupervisormodeandfor
journaling,refertotheAPTRAAdvanceNDC,SupervisorsGuide.
A-2
Reserved Screens
A Supervisor Acknowledgements
ASupervisorAcknowledgements
Ascreensincludeacknowledgementlinesforthecardholderand
enhancedoperator(EOP)interfaces.
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
A-3
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
A-4
Reserved Screens
E Error Screens
EErrorScreens
Eorescreensareerrormessagesthatappearonthecardholder
screenorenhancedoperatorinterface.
Fordetails,seetheAPTRAAdvanceNDC,SupervisorsGuide.
Note:TheExxxx screensforpassbookprintersareshownonthe
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
A-5
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
A-6
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
A-7
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
A-8
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
A-9
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
A-10
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
A-11
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
A-12
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
A-13
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
Reserved
E1909
HARDWARE ERROR
E1910
CARDLESS ALREADY %%%%%%%%
E1911
SET NEXT STATE NUMBER FIRST
E1912
E1999
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
A-14
Reserved Screens
E Error Screens
Column Position
Screen
Number
Row
Position
E2009
ROUTINE
E2010
WARNING
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
E2117
DEVICE OFFLINE
e00
NOT CONFIGURED
e01
BIN NOT PRESENT
1
2
3
12345678901234567890123456789012
A-15
Reserved Screens
E Error Screens
Column Position
Screen
Number
Row
Position
e02
FAILED TO CREATE CHECKSUM
e03
FAILED TO UPDATE CURRENCY
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
FILE NOT FOUND
A-16
Reserved Screens
E Error Screens
Column Position
Screen
Number
Row
Position
e28
NO DRIVES SUITABLE FOR COPY
e29
SILENTDEBUG ALREADY STARTED
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
A-17
Reserved Screens
I Supervisor Information
Iscreenscontainthefollowinginformation:
Encryptionkeys
Cashandcounterdisplays
Configurationdata
Multiplecardimageselectionforrearsettlement
EJlogfileinspection.
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 %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%:%%
A-18
Reserved Screens
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
%%%%%
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 ST LEN = %% RCT TOP MGN = %%
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.
A-19
Reserved Screens
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
A-20
Reserved Screens
Column Position
Screen Number
Row Position
I21
I22I26
I27
I30
I31
* M/C
%%/%%/%% %%:%%:%% *
Reserved
MODULE = 2
I28
I29
1
2
3
4
1234567890123456789012345678901234567890
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 =
A-21
Reserved Screens
Column Position
Screen Number
Row Position
I32
I33
1
2
3
4
1234567890123456789012345678901234567890
Reserved
*EJ CONFIGURATION DATA*
1
2
3
4
5
6
7
8
9
10
11
12
13
14
I34I35
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
I36
*CASH TEST* MODULE = 2
I37
*CASH TEST* MODULE = 1
I38
SWITCHED ON
I39
SWITCHED OFF
I40
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
I41
THE CARD IMAGES PRESENT ARE

MARKED WITH X:
0
SELECT FROM THE LIST ABOVEReserved
A-22
Reserved Screens
Column Position
Screen Number
Row Position
I42
1
2
3
4
5
6
7
8
9
10
11
12
13
I43
I44
I45
1
2
3
4
5
6
7
I67I69
REMAINING
+DISPENSED
=TOTAL COINS
HOPPER %
%%%%%
%%%%%
%%%%%
REMAINING
+DISPENSED
=TOTAL COINS
LAST CLEARED
HOPPER %
HOPPER %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%
%%:%%
HOPPER %
%%%%%
%%%%%
%%%%%
STANDARD COIN COUNTS
HOPPER 1= %%%%% HOPPER 2= %%%%%
HOPPER 3= %%%%% HOPPER 4= %%%%%
CARDLESS TRANSACTIONS = %%%%%%%%
CARDLESS NEXT STATE NUMBER = %%%
*CHECK COIN*
Reserved
1
I64I65
I66
COIN DISPENSER
Reserved
I46I65
I63
1
2
3
4
1234567890123456789012345678901234567890
DUAL
Reserved
1
2
3
4
5
6
7
8
9
STANDARD COIN COUNTS
HOPPER 1= %%%%% HOPPER
2=
4=
6=
8=
%%%%%
%%%%%
%%%%%
%%%%%
CARDLESS TRANSACTIONS = %%%%%%%%

Reserved
A-23
Reserved Screens
Column Position
Screen Number
Row Position
I70
1
2
3
4
5
6
7
8
9
I71I95
I96
I97
I98
I99
1
2
3
4
1234567890123456789012345678901234567890
CARDS CAPTURED
%%%%%
ACTIVITY COUNT =
%%%%%%%
Reserved
1
2
1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
8
9
10
11
12
1
2
3
KVV VALUE = %%%%

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
A-24
Reserved Screens
M and m Supervisor Menus
MandmSupervisorMenus
Mandmscreenscontaininformationonkeyboardsandthe
followingmenus:
Select
Replenish
Configure
Access
FordetailsoftheSupervisormenus,refertotheAPTRAAdvance
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
A-25
Reserved Screens
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
14
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
60
INIT EJRNL
SECURITY CAM
CLR BINS
DUMP IMAGES
PRN BNA RCNL
DIRCT EJ BKP
CLR BNA
CREATE SIGS
DSP BNA CNTS
PRN BNA TTLS
41
43
45
48
50
52
54
56
59
99
FILL ENV
INIT DEPOS
CHECK COIN
DSP BNA RCNL
RCOPY EJRNL
PRN BNA EXCP
INIT BNA
EXTRACT SIGS
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,seeControl
CodesforSpecialFeaturesonpage 320.
A-26
Reserved Screens
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,seeControlCharacterson
page 316andControlCodesforSpecial
Featuresonpage 320.
M60
1
2
3
4
5
6
7
8
9
10
11
12
13
14
%
+-----------------------+
|
1
|
2
|
3
|
| _#() | abc | def |
|-------+-------+-------|
|
4
|
5
|
6
|
| ghi | jkl | mno |
|-------+-------+-------|
|
7
|
8
|
9
|
| pqrs | tuv | wxyz |
+-------+-------+-------+
|
0
|
| -?!@ |
CAPS >>
+-------+
A-27
Reserved Screens
Column Position
Screen
Number
Row
Position
M61
1
2
3
4
5
6
7
8
9
10
11
12
13
14
%
+-----------------------+
|
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
20
RMT PORT NO
LCL PORT NO
ADVANCED
PRINT TCP/IP
GATEWAY
DNS ADDRESS
COMP NAME
MULTI HOST
SSL CONFIG
IPV4/IPV6
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
A-28
Reserved Screens
Column Position
Screen
Number
Row
Position
m02
1
2
3
4
5
6
7
8
9
10
11
12
13
34
37
39
45
46
47
80
81
82
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
BNA CASS CFG
POWERUP MSG
99 MORE
1
2
3
4
5
6
7
8
9
10
11
12
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
m03
m04
m05
1
2
3
12345678901234567890123456789012
CONFIGURE
Reserved
1
2
3
4
5
6
MISC FUNCS
0 PRNT CMPNT VERS
1 PRNT SCRW VERS
2 SOFTWARE UPDATE
A-29
Reserved Screens
Column Position
Screen
Number
Row
Position
m06
1
2
3
4
5
6
7
8
9
10
11
12
m07
m08
m09
m10
1
2
3
4
5
6
7
8
9
10
11
1
2
3
4
5
6
7
8
9
10
1
2
3
4
5
6
1
2
3
12345678901234567890123456789012
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
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
A-30
Reserved Screens
Column Position
Screen
Number
Row
Position
m11
1
2
3
4
5
6
7
m12
m13
m14
m15
1
2
3
4
5
6
1
2
3
12345678901234567890123456789012
UPDATE REJECT BIN
THRESHOLD
CURRENT SETTING
THRESHOLD = %
TROUBLESHOOTING
1
2
3
1
2
3
4
5
6
7
8
9
10
11
12
1
2
3
4
5
6
7
8
1
2
3
4
5
6
7
PD INVESTIGATION
SILENT DEBUG
RETRIEVE ARCHIVE
SELECT DRIVE
%
%
%
%
%
%
%
CALIBRATE CASH UNIT

%
TO BE CALIBRATED
WITH 8 - 12 NOTES
CALIBRATE CASH UNIT
1.
2.
3.
4.
TOP
SECOND
THIRD
FOURTH
A-31
Reserved Screens
Column Position
Screen
Number
Row
Position
m16
1
2
3
4
5
6
7
8
9
10
11
12
13
m17
1
2
3
4
5
6
7
m18
m19
m20
m21
m22
1
2
3
12345678901234567890123456789012
UPDATE SP CURRENCY ID
CURRENT SETTING
%
CURRENCY = %
1.
2.
3.
4.
%
%
%
%
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
A-32
Reserved Screens
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
A-33
Reserved Screens
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(#)|
+----+
%%%%%%%%%%%%%%%%%%%%
A-34
Reserved Screens
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
A-35
Reserved Screens
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
A-36
Reserved Screens
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
A-37
Reserved Screens
Column Position
Screen
Number
Row
Position
m47
1
2
3
4
5
m48
m49
m50
1
2
3
4
5
1
2
3
4
5
6
7
8
9
10
11
12
13
14
1
2
3
4
5
6
7
8
9
10
11
12
13
1
2
3
12345678901234567890123456789012
RELATE MENU
1 ENABLE/DISABLE RELATE
SOFTWARE UPDATE MENU

0 RUN EXECUTABLE FILE
1 COPY FILES AND RESTART
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
UPDATE SP CASH UNIT ID

CURRENT SETTING
%%%%%
CASH UNIT ID = %%%%%
1.
2.
3.
4.
5.
6.
7.
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
A-38
Reserved Screens
Column Position
Screen
Number
Row
Position
m51
1
2
3
4
5
6
7
8
9
10
11
12
13
m52
m54
1
2
3
12345678901234567890123456789012
UPDATE CASH UNIT ID VALUE
CURRENT SETTINGS
CASSETTE %
CASH UNIT ID = %%%%%
0.
1.
2.
3.
4.
5.
6.
7.
NOT REQUIRED
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
Reserved
m55
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
m56
1
2
3
4
5
6
7
8
* 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
= %
DNS CONFIG
1
2
3
4
ENTER PRIMARY DNS

ENTER SECONDARY DNS
COPY DNS SUFFIX FROM DISK
ENTER DNS SUFFIX
A-39
Reserved Screens
Column Position
Screen
Number
Row
Position
m57
1
2
3
4
5
6
7
8
9
m58
m59
m60
1
2
3
12345678901234567890123456789012
IPV4/IPV6 MENU
CURRENT MODE = %%%%
1
2
IPV4 ENTRY MODE

IPV6 ENTRY MODE
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
A-40
Reserved Screens
Column Position
Screen
Number
Row
Position
m63
1
2
3
4
5
6
7
8
9
10
11
12
1
2
3
12345678901234567890123456789012
COPY SNAPSHOTS
SNAPSHOTS ARE AVAILABLE
FROM %
TO %
m64
1
2
3
4
5
CLEAR CASH
SELECT CASH HANDLER TO CLEAR
0 CASH HANDLERS 1 AND 2
1 CASH HANDLER 1 ONLY
m65
1
2
3
4
5
STD CASH
SELECT CASH HANDLER
0 CASH HANDLER 1 AND 2
m66
m66
m67
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
MV DIAGNOSTICS
m90
m91
m92
0 CLEAR ALL
m93
0 CLEAR ALL
DEVICE
FITNESS
8 BACK
9 NEXT
A-41
Reserved Screens
Column Position
Screen
Number
Row
Position
m94
26 FAULT DISPLAY
m95
THERE ARE NO DEVICES CONFIGURED
m96
1
2
3
4
5
6
1
2
3
12345678901234567890123456789012
91 SHUTDOWN
DEVICE SELF TEST

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
A-42
Reserved Screens
P Supervisor Prompts
PSupervisorPrompts
Porpscreensarepromptlinesthatappearonthecardholder
screenandenhancedoperatorinterface.
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-
A-43
Reserved Screens
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
SET JOURNAL OPTION -
P43P52
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 -
A-44
Reserved Screens
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
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
A-45
Reserved Screens
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
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 -
A-46
Reserved Screens
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
STANDARD MODE ALREADY ACTIVE

ENTER MAX EJ BACKUPSReserved
p32
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
A-47
Reserved Screens
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
p65
p66p77
Reserved
1
2
3
1
TO EXIT SUPERVISOR
SET MODE SWITCH TO NORMAL
ENTER UNIT ID Reserved
A-48
Reserved Screens
S Supervisor Information Lines
SSupervisorInformationLines
Sorsscreenscontainthefollowingmessages:
Mediastatus
Testcash.
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
S07
S08
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
A-49
Reserved Screens
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
RECEIPT CAPTURE BIN OVERFILL

Reserved
S30
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
A-50
Reserved Screens
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
A-51
Reserved Screens
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
A-52
Reserved Screens
T and t Journal Trace Information
TandtJournalTraceInformation
Tandtscreenscontainthefollowingmessages:
Envelopeserialnumber
Securitytrace
Presentererror
Envelopelength
Journalreprint.
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
A-53
Reserved Screens
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 = %%%%%
A-54
Reserved Screens
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 = %%%%%
A-55
Reserved Screens
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 = %%
A-56
Reserved Screens
Column Position
Screen
Number
Row
Position
t05
CHEQUE PROCESSOR INITIALISED
t06
CHEQUE TRANSPORT CLEARED
t07*
1
2
3
4
5
CASSETTE %
CURRENCYID
MEDIA TYPE
VALUE
UNIT ID
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 = %%
A-57
Reserved Screens
Column Position
Screen
Number
Row
Position
t14
1
2
3
4
5
SP UPDATE - NEW VALUE FOR

%%%%%%
CURRENCYID = %%%
VALUE
= %%%%%
UNITID
= %%%%%
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 %
A-58
Reserved Screens
Column Position
Screen
Number
Row
Position
t40
ENABLED
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:%
A-59
Reserved Screens
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
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
FGRPRINT DATA SENT
t72
t73
CONSUMER RESOURCE RELINQUISHED

INIT AFTER SETTLEMENT %
t74
t75
1
2
3
4
1234567890123456789012345678901234567890
1
2
3
4
5
6
7
8
9
10
11
12

DISPENSE
COINS DISPENSED %%%%%
HOPPER 1 = %%%%% HOPPER 2
COINS REMAINING
A-60
=
=
=
=
%%%%%
%%%%%
%%%%%
%%%%%
=
=
=
=
%%%%%
%%%%%
%%%%%
%%%%%
Reserved Screens
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
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

<HARDCOPY BACKUP: NO CHEQUE IMAGE>
t88
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
A-61
Reserved Screens
Column Position
Screen
Number
Row
Position
t99
1
2
3
4
1234567890123456789012345678901234567890
INIT BY EJ SCHEDULED INIT
A-62
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
%%%%%% %%%%%%%%%%%%%%%%%%%%%%
CAPTURED %%/%%/%% %%/%%/%%
U0057
U0058
1
2
3
CHEQUE CAPTURED
TSN: %%%%
CARD: %%%%%%%%%%%%%%%%%%%%%%
U0059
1
2
3
CHEQUE CAPTURE FAILED

TSN: %%%%
CARD: %%%%%%%%%%%%%%%%%%%%%%
U0060
U0066
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
A-63
Reserved Screens
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

OR
PRESS CANCEL TO EXIT
1
2
3
4
5
NO ITEMS ENTERED
CASHINACTIVE PERFORM INIT BNA

OR
A-64
Reserved Screens
Column Position
Screen
Number
Row
Position
U0109
1
2
3
4
5
1
2
3
12345678901234567890123456789012345
TIMEOUT OCURRED
OR
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

FAILED SIGNATURES: CAT2: %%%%%
U0124
U0125
FAILED SIGNATURES: CAT3: %%%%%
U0126
1
2
MISRECOGNITION ERROR/NOTES IN REJECT

BIN
A-65
Reserved Screens
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
RETRACT NO: %%%%%, TOT: %%%%% ITEMS:

%%%%%
ESC: %%%%%%%%%%%
%%%%%%%%%%%
VAL: %%%%%%%%%%%
%%%%%%%%%%%
REF: %%%%%%%%%%%
%%%%%%%%%%%
REJECTS: %%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
%%%%%%%%%%%
U0134
U0135
NOTES DETECTED AT EXIT SLOT
U0136
INIT BNA STARTED - %%%%%%%%%%%
A-66
Reserved Screens
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
A-67
Reserved Screens
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
CASHIN ADD MORE NOT ENABLED
U0166
U0167
REJECTED BUNCH ENTRY LIMIT REACHED
U0168
1
2
3
4
5
6
7
8
910
DATE/TIME: <DateTime%>
TERMINAL ID: <TerminalID%>
CARD NO: <ConsumerID%>
DEPOSITED:
<TxCounts%>
CAT2:
<Cat2Counts%>
CAT3:
<Cat3Counts%>
U0169
1
2
3
4
5
6
7
8
9
REFUNDED:
<TxCounts%>
CAT2:
<Cat2Counts%>
CAT3:
<Cat3Counts%>
U0170
1
2
3
4
5
6
7
8
9
REFUND FAILED NOTE COUNTS:
<TxCounts%>
CAT2:
<Cat2Counts%>
CAT3:
<Cat3Counts%>
U0171
NOTES DETECTED IN THE STACKER
U0172
RETRACTED TO <RetractArea%>
U0173
U0299
U0300
Reserved
1
TIMEOUT FROM TIMEOUT STATE
A-68
Reserved Screens
Column Position
Screen
Number
Row
Position
U0301
U0302
U0303
1
2
3
12345678901234567890123456789012345
CANCEL FROM TIMEOUT STATE
Reserved
CUSTOMER CANCELLED
A-69
Reserved Screens
d Supervisor Diagnostic Screens
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
A-70
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
A-71
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:

REMOTE PORT NO:

LOCAL IP ADDRESS:

LOCAL PORT NO:

CONFIG AS SRVR:

MESSAGE FORMAT:

LENGTH SIZE:
A-72
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
LENGTH FORMAT:

LENGTH ADJUST:

LENGTH OFFSET:

LENGTH EMBED:

RCVD TIMEOUT:

HRTBT INTERVAL:

DWNBT INTERVAL:

MAX ROUNDTRP:
A-73
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
RECONN ON CLS:

MAXIMUM RETRYS:

KEEP ALIVE:

RETRY INTERVAL:

RETRY TIMER:
CONFIGURE SSL
OPTIONAL PARAMETERS
1 ADD
2 EDIT
3 DELETE
CONFIGURE SSL
OPTIONAL PARAMETERS
1 ADD/EDIT
2 DELETE
A-74
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

A-75
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
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 -
A-76
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
MSG ON CP:
1 - ENABLED
0 - DISABLED
ENTER MSG ON CP CURRENT APPLICATION CONFIG

CP MSG TIMER :

0 AND 255 SECONDS
ENTER CP MSG TIMER CURRENT APPLICATION CONFIG

ERROR REDIAL TIMER :

0 AND 2550 SECONDS'
ENTER ERROR REDIAL TMR -
A-77
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 -
A-78
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-
A-79
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 :

0 AND 255 SECONDS
ENTER CONNECT TIMER CURRENT MODEM LINK CONFIG

DIAL MODE :
1 - TONE
0 - PULSE
ENTER DIAL MODE -
A-80
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 :

1 AND 20 SECONDS
ENTER CMD RSP TIMER CURRENT VISA 2 CONFIG

ENQ TIMER :

0 AND 255 SECONDS
ENTER ENQ TIMER CURRENT VISA 2 CONFIG

MESSAGE RETRIES :

0 AND 9
ENTER MSG RETRIES -
A-81
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 :

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 -
A-82
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
DIAL ON SEND TIMER :

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 :

0 AND 1000 MILLISECONDS
ENTER N/A DELAY TMR -
A-83
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 :

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
A-84
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:
HOST MESSAGE HEADER :
1 - ENABLED
0 - DISABLED
ENTER HOST MSG HEADER FILE COPIED
A-85
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:

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
A-86
+-----|!"#$%&
+-----+-----|=>?@[\
+------
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
BACKOFF TIMER :

ENTER BACKOFF TIMER -
A-87
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
%%%%%
%%%%%
A-88
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
%%%%%
DEPOSITS MADE
%%%%%
ACTIVITY COUNT = %%%%%%%
PKT 1 %%%%% CLRD %%/%%/%% %%:%%
PKT 2 / REJECT BIN
%%%%% CLRD %%/%%/%% %%:%%
PKT 3 %%%%% CLRD %%/%%/%% %%:%%
A-89
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
%%%%%
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
i38
1
2
3
i40
TYPE
%
%
%
%
%
%
%
CURR
%%%
%%%
%%%
%%%
%%%
%%%
%%%
VALUE
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
CUID
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
DISP
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
REJECT BIN THRESHOLD = %%

ENTER START DATE (DDMMYY)
ENTER END DATE (DDMMYY)
.
A-90
= %%%%%
= %%%%%
= %%%%%
Reserved
i34i36
i37
1
2
3
12345678901234567890123456789012
/
/
/
/
Reserved Screens
i Supervisor BNA
Column Position
Screen
Number
Row
Position
i43
1
2
3
4
5
6
7
8
9
10
11
TYPE %%-%%
CASSETTE
+RETRACT
+RECYCLED
=DEPOSITED
%%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
TYPE %%-%%
CASSETTE
+RETRACT
+RECYCLED
=DEPOSITED
%%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
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
1
2
3
12345678901234567890123456789012
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
%%%%%
%%%%%
%%%%%
%%%%%
CUID
%%%%%
%%%%%
%%%%%
%%%%%
%%
%%
%%
%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
TYPE
%
%
%
%
A-91
Reserved Screens
i Supervisor Settlement Screens
iSupervisorSettlementScreens
ThefollowingiSupervisorSettlementscreensaredisplayed:
Table A-13
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-
A-92
Reserved 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-
A-93
Reserved 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 %
A-94
Reserved Screens
j Supervisor and Journal Miscellaneous Screens
jSupervisorandJournal
MiscellaneousScreens
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
4
1234567890123456789012345678901234567890
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 %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%/%%/%%
%%:%%
A-95
Reserved Screens
Column Position
Screen Number
Row Position
j0003
1
2
3
4
1
2
3
4
1234567890123456789012345678901234567890
STANDARD NOTE COUNTS
T1=%%%%%
T2=%%%%%
T3=%%%%%
T4=%%%%%
Note:Ifdualcashhandlersareusedwithseparatedcounters,thestandardnotecountsaredisplayedwiththe
primarycashhandlercountfirst(P),thenthesecondarycashhandlercount(S),asfollows:
T1=PPPPPP SSSSSS T2=PPPPPP SSSSSS
j0004
1
2
3
4
5
6
STANDARD NOTE COUNTS
T1=%%%%%
T2= %%%%%
T3=%%%%%
T4= %%%%%
T5=%%%%%
T6= %%%%%
T7=%%%%%
Note:Ifdualcashhandlersareusedwithseparatedcounters,thestandardnotecountsaredisplayedwiththe
primarycashhandlercountfirst(P),thenthesecondarycashhandlercount(S),asfollows:
IfEnhancedConfigurationoption76issetto001,thedisplaywillbeasfollows:
T1=PPPPPP
T3=PPPPPP
T5=PPPPPP
T7=PPPPPP
j0005
j0006
SSSSSS T2=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 %
%%%%%
%%%%%
%%%%%
%%%%%
%%%%%
%%:%%
A-96
Reserved 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
j0008
j0009
j0010
1
2
3
4
1234567890123456789012345678901234567890
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:

0 AND 9
ENTER SUPP CASH LOW -
A-97
Reserved Screens
Column Position
Screen Number
Row Position
j0011j0019
j0020
j0021
1
2
3
4
1234567890123456789012345678901234567890
Reserved
1
2
3
4
5
6
7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
CONFIGURE
89
91
92
93
99
NO HOST CHG VG
ALPHANUMERIC MACHINE NUMBER
RECEIPT TOP MARGIN
CARDLESS TRANSACTIONS
MORE
CURRENT CONFIG - %%%%%%

PRESS KEY REPEATEDLY TO
CYCLE THROUGH VALUES
+--------------+
|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

TYPE 1 = %%%%% TYPE 2 =
TYPE 3 = %%%%% TYPE 4 =
TYPE 5 = %%%%% TYPE 6 =
TYPE 7 = %%%%% UNKNOWN=
LAST CLEARED %%/%%/%%
j0024
1
2
3
4
%%%%%
%%%%%
%%%%%
%%%%%
%%:%%

TYPE 1 = %%%%% TYPE 2 = %%%%%
TYPE 3 = %%%%% TYPE 4 = %%%%%
UNKNOWN= %%%%%
A-98
Reserved Screens
Column Position
Screen Number
Row Position
j0025
1
2
3
4
5

TYPE 1 = %%%%% TYPE 2 =
TYPE 3 = %%%%% TYPE 4 =
TYPE 5 = %%%%% TYPE 6 =
TYPE 7 = %%%%% UNKNOWN=
j0026
1
2
LAST DISPENSED COUNTS ARE UNKNOWN

CAUTION-CASH COUNTS MAY BE INACCURATE
j0027
CASH TOTAL %%%%
TYPE1 TYPE2 TYPE3 TYPE4
j0028
CASH TOTAL %%%%
TYPE5 TYPE6 TYPE7
j0029
DENOMINATION
%%%%% %%%%% %%%%% %%%%%
j0030
DISPENSED
%%%%% %%%%% %%%%% %%%%%
j0031
REJECTED
%%%%% %%%%% %%%%% %%%%%
j0032
REMAINING
%%%%% %%%%% %%%%% %%%%%
j0033
OPCODE = %%%%%
j0034
ENTER RECEIPT TOP MARGIN -%%
j0035
1
2
3
4
5
6
7
8
CARDLESS TRANSACTIONS
j0036
j0037
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
1
1
2
3
4
1234567890123456789012345678901234567890
%%%%%
%%%%%
%%%%%
%%%%%
CURRENT STATUS = %%%%%%%%

NEXT STATE NUMBER = %%%
0 DISABLE
1 ENABLE
2 CHANGE NEXT STATE NUMBER
CURRENT NEXT STATE NUMBER: %%%
+--------------+
|1ABC|2DEF|3GHI|
|----+----+----|
|4JKL|5MNO|6PQR|
|----+----+----|
|7STU|8VWX|0YZ |
+----+----+----+
| 0 |
+----+
ENTER STRING:
ENTER NEXT STATE NUMBER-
A-99
Reserved Screens
Column Position
Screen Number
Row Position
j0038
CARDLESS TRANSACTIONS %%%%%%%%
j0039
j0040
LOCAL CASH DISPENSE STATE
j0041
DISPENSE AND PRINT
j0042
CARD BEFORE CASH
j0043
CARD BEFORE DISPENSE AND PRINT
j0044
FAST CASH
j0045
REQUESTED COINS CANNOT BE DISPENSED
j0046
NO NOTES AND NO COINS REQUESTED
j0047
CARD EJECTED
j0048
CARD READER TAMPERING
j0049
NOTES PURGED
j0050
NOTES PARTIALLY PRESENTED %% %% %% %%
j0051
CASH DISPENSER TAMPERING
j0052
COIN DISPENSER TAMPERING
j0053
GOOD DISPENSE EXIT
j0054
SHORT DISPENSE EXIT
j0055
NO DISPENSE EXIT
j0056
UNKNOWN DISPENSE EXIT
j0057
COINS PRESENTED %% %% %% %% %% %% %% %%
j0058
COINS PARTIALLY PRESENTED %% %% %% %% %% %% %% %%
j0059j3999
1
2
3
4
1234567890123456789012345678901234567890
Reserved
j4000
MACHINE NO =%
j4001
DATE-TIME
j4010
j4011j4012
=%
Reserved
A-100
Reserved Screens
Column Position
Screen Number
Row Position
j4013
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 %%%%%%%%%%%
j4022
CIM-ITEMS PRESENTED
j4023
CIM-ITEMS TAKEN
j4024
CIM-DEPOSIT COMPLETED
j4014
j4025
j4031
1
2
3
4
1234567890123456789012345678901234567890
Reserved
A-101
Reserved Screens
Column Position
Screen Number
Row Position
j4032
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
j4035
1
2
3
4
1234567890123456789012345678901234567890
CONFIGURE NHC VG
0 DISABLE'
1 ENABLE'
CURRENT = %
PRESS 1 TO ENABLE/0 TO DISABLE

CIM-DEPOSIT COMPLETED - ITEMS REFUNDED
j4036
j4054
Reserved
j4055
CASH DEPOSIT HANDLING - ENCASH STARTED
j4056
CASH DEPOSIT HANDLING - REFUND STARTED
j4057
CASH DEPOSIT HANDLING - ENCASH SUCCESS
j4058
CASH DEPOSIT HANDLING - ENCASH FAILED
j4059
CASH DEPOSIT HANDLING - REFUND SUCCESS
j4060
CASH DEPOSIT HANDLING - REFUND FAILED
j4061
CASH DEPOSIT HANDLING - REFUND TIMEOUT
A-102
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
B12
Table of Contents
Character Sets
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.
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
B-2
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
96
96
96
B-3
Character Sets
Character Sets
Character Set
Designator

CRT
PPD
R/J
96
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
B-4
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
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
96
B-5
Character Sets
Character Sets
Character Sets
Designator
96
96
12cpiSizeAlpha1
96
12cpiSizeAlpha2
96
12cpiSizeAlpha3
96
96
96
12cpiSizeAlpha4
96
12cpiSizeAlpha5
96
12cpiSizeAlpha6
B-6
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
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.
0ifmappingisnotrequired.Themappingfileisneverchecked
1ifmappingisrequired.Themappingfileisalwayschecked.
Ifthesectionislocated,theSelectCodepagecontrolsequenceis
usedtomaptheprintabledata.Ifthesectionisnotlocated,the
requestispasseddirectlytotheprinter.
B-8
Character Sets
Mapping Files
Forinformationontheprintercontrolcodes,seePrinterControl
Charactersonpage 56.
Thecharacterdesignatorsentbythehosttoselectuserdefinedfonts
mustmatchthatheldintheappropriateregistrykeyfortheprinter
type,asfollows:
RECEIPT\CHAR_MAP_DESIGNATOR
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]
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
B-10
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
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
B-12
Table of Contents
Cardholder Screen Graphics
Appendix C
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
Table of Contents

Overview
Overview
TwosetsofcardholderscreengraphicsareprovidedwithAdvance
NDC:fileswithnamesintheformatofg<nn>.pngandthesamefiles
withnamesintheformatofPIC0<nn>.png.Thevariablenn
representsanumberintherange01to10.
Thisappendixliststheexamplecardholderscreengraphicsforthe
g<nn>.pngsetofgraphics.
Note:Thesegraphicsareprovidedasexamplesonly;youwill
probablyneedtoreplaceoramendthemasrequired.
C-1

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

InsertCard(g00.png)
Figure C-1
Insert Card (g00.png)
C-3

PressKey(g01.png)
Figure C-2
Press Key (g01.png)
C-4

MakeaDeposit(g03.png)
Figure C-3
Make a Deposit (g03.png)
C-5

TakeReceipt(g04.png)
Figure C-4
Take Receipt (g04.png)
C-6

TakeCash(g05.png)
Figure C-5
Take Cash (g05.png)
C-7

TakeStatement(g06.png)
Figure C-6
Take Statement (g06.png)
C-8

ScanBarcode(g10.png)
Figure C-7
Scan Barcode (g10.png)
C-9

C-10
Table of Contents
Quick Reference to Message Types
Appendix D
Overview
TransactionRequest
UploadEJDataMessage
TerminalCommands
TransactionReply
AcknowledgeEJUploadBlockCommand
AcknowledgeandStopEJCommand
EJOptionsandTimersCommand
D1
D2
D3
D7
D8
D9
D10
D10
D13
D16
D21
D22
D22
Table of Contents

Overview
Overview
ThisappendixisforprogrammersdesigningtheCentralcontrol
application.Itprovidesaquickreferencetothetypesofmessage
sentbetweenCentralandtheterminal.Foreachmessagetype,the
messageclassandsubclassareshown,andeachfieldwithinthe
message.Thiswillhelpyoutoquicklyidentifythemessagesthat
passtoandfromCentral.
Thisappendixdoesnotincludeinformationonthe
protocoldependentheadersandtrailers.
D-1

Table D-1
Message
Class
Message
Sub-Class
FS
(See Table
Note 1)
LUNO
FS
(See Table
Note 1)
Fields
(See Table
Note 2)
Message
Destination
000
~~~
...
TransactionRequest
Central
000
~~
...
UnsolicitedStatus
Central
000
~~
...
SolicitedStatus
Central
000
~~
...
Central
~~
...
TMAlert
Central
~~
...
UploadEJData
Central
~~
...
TerminalCommands
Terminal
~~
...
Terminal
~~
...
SeeTableNote3
Terminal
~~
...
EncryptionKeyChange
SeeTableNote3
Terminal
~~
...
SeeTableNote3
Terminal
000
...
TransactionReply
Terminal
~~
...
TMAlert
Terminal
...
Terminal
...
Terminal
...
EJOptionsandTimers
Terminal
TableNote1:Eachtildacharacter(~)representsafieldseparator.
TableNote2:Thefieldsareidentifiedinthemessageformattables
intheremainderofthisappendix.
TableNote3:TheInteractiveTransactionResponse,Encryption
KeyChangeandExtendedEncryptionKeyChangemessagesare
D-2

describedinTable D11,CustomisationDataCommandFields
onpage D13.
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)
D-3

Transaction Request
11~000~~~...
Field
Description
Length
FS
Fieldseparator
av1
CSPDataIDU
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
D-4

Transaction Request
11~000~~~...
Field
Description
Length
ca1
DeviceIDwforBNA/GBRU
ca2*
NoteTypeinhex(0132);upto50types
ca3**
Numberofnotesinescrowforca2
2or3
*ca2andca3mayberepeatedforupto50
**thelengthdependsonoption45configuration.
FS
Fieldseparator
cb1
SingleChequeDepositDataIDa
cb2
Codelinedetected
cb3
Codelinevalue
Var(256)
FS
FieldSeparator
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
type2
cf4
type3
:
ThefieldisrepeatedforeachhoppertypespecifiedintheTransaction
Replymessage
:
cf<n
+1>
typen
FS
Fieldseparator
D-5

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
ch1
PassbookDataIDh
ch2
PageNumberatWhichPassbookisOpen
ch3
LineNumberofNextPrintableLine
FS
FieldSeparator
ci1
DataID<VoiceGuidance
ci2
VoiceGuidanceLanguageIdentifier
GS
Groupseparator
Fieldseparator
Dataidentifier
Data
Var
FS
Fieldseparator
MessageAuthenticationCodedata
D-6

UnsolicitedStatus
Messages
Table D-3
Unsolicited Status Message Format
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
XPassbook
YCoindispenser
\Envelopedispenser
qChequeprocessor
wBunchNoteAcceptor(BNA)
D-7

Table D-4
Solicited Status Message Fields
Table D-5
Solicited Status Message Field Values
22~000~~f~(g1)...
Field
Description
Length
Statusdescriptor
Statusinformation
g1
Description
Devicefault
Cardreader/writer
Cashhandler
Depository
Nightsafedepository
Statementprinter
Passbook
Coindispenser
Envelopedispenser
Chequeprocessor
BunchNoteAcceptor(BNA)
Ready
Commandreject
Ready(transactionreply)
Specificcommandreject
1
MACfailure
Timevariantnumberfailure
Securityterminalnumbermismatch
Messageformaterror
Fieldvalueerror
Illegalmessagetype
Hardwarefailure
Notsupported
D-8

EncryptorInitialisation
Data
Table D-6
Encryptor Initialisation Data
g1
Description
Terminalstate
1
Sendsupplycounters
Sendtallyinformation
Senderrorloginformation
Senddate/timeinformation
SendconfigurationID
EKCretrievehallmarkkey(unsupported)
Hardwareconfigurationdata
Suppliesdata
Fitnessdata
Tamperandsensorstatusdata
SoftwareIDandreleasenumberdata
Localconfigurationoptiondigits

Field
Description
Length
InformationIdentifier
1EPPserialnumberandsignature
2EPPpublickeyandsignature
3NewKeyVerificationValue(KVV)
4Keysstatus
5Keyloaded
6Keyentrymode
7RSAencryptionKVV
8SSTcertificate
9SSTrandomnumber
APKCS7keyloaded
D-9

Field
Description
Length
BEncryptorcapabilitiesandstate
CKeydeleted
DEPPattributes
EVariablelengthEPPserialnumberand
signature
f
UploadEJDataMessage
Table D-8
Terminal Command Fields
Table D-9
Field Values for Terminal Commands
Upload EJ Data Message
61~~~~d
Field
Description
Length
MachineNumber
Date
Time
LastCharacterPreviousBlock
LastCharacterThisBlock
BlockLength
ResponseData
Var(1to
350)
Terminal Commands
1~~~fg
Field
Description
Length
Commandcode
Commandmodifier
Goinservice
Gooutofservice
0
Description
Standardoutofservicescreendisplayed
D-10
Var
Table D-7
Upload EJ Data Message
TerminalCommands
EncryptorInformation

f
Description
Temporaryoutofservicescreendisplayed
SendconfigurationID
Sendsupplycounters
None
Sendtallyinformation
A
Processorandsystem
Communications
Systemdisk
Cardreader/writer
Cashhandler
Depository
Receiptprinter
Journalprinter
Reserved
Reserved
Nightsafe
Encryptor
Camera
Dooraccess(notsupported)
Offlinedisk
Statementprinter
Passbook
Coindispenser
Envelopedispenser
Bunchnoteacceptor
Chequeacceptor
Senderrorloginformation
A
Processorandsystem
D-11

f
CustomisationData
Commands
Table D-10
Customisation Data Command Fields
Description
Communications
SSTdevices
0
Sendhardwareinformationonly
Sendsuppliesdataonly
Sendfitnessdataonly
Sendtamperandsensorstatusdataonly
SendsoftwareIDandreleasenumberdataonly
Sendenhancedconfigurationdata
Sendlocalconfigurationoptiondigits
SendBNAnotedefinitions
Senddateandtimeinformation
Reserved
Reserved
Reserved
EKCretrievehallmarkkey(notsupported)
<
Reserved
>
EnableFREEJDATA
Enableimagedumping(notsupported)
0
DonotallowaccesstoDumpImages
AllowaccesstoDumpImages
3~~~fg
Field
Description
Length
Messagesubclass
Messageidentifier
D-12

Table D-11
Field Values for Data Commands
Customisationdata
Description
Screenand/orkeyboarddataload
Statetablesload
Configurationparametersload
Reserved
FITdataload
ConfigurationIDnumberload
Enhancedconfigurationparametersload
MACfieldselectionload
Dateandtimeload
Reserved
Dispensercurrencycassettemappingtable
InitialiseEKC(notsupported)
Overridereservedscreenscommand
Interactivetransactionresponse
0
Donotdisplaycardholderkeyboardentry
Displaycardholderkeyboardentry
Display*forcardholderkeyboardentry
Encryptionkeychange
1
Deciphernewmasterkeywithcurrentmasterkey
Deciphernewcommunicationskeywithcurrent
masterkey
communicationskey
Uselocallyenteredcommunicationskey(Bkey)as
currentMACkey
DeciphernewMACkeywithcurrentmasterkey
DeciphernewMACkeywithcurrent
communicationskey
D-13

f
Description
currentMACkey
DeciphernewVISAmasterkeywithcurrentVISA
masterkey
KeydataisnewVISAkeytable
Extendedencryptionkeychange
1
Deciphernewmasterkeywithcurrentmasterkey
masterkey
communicationskey
currentMACkey
DeciphernewMACkeywithcurrentmasterkey
DeciphernewMACkeywithcurrent
communicationskey
currentMACkey
DeciphernewVISAmasterkeywithcurrentVISA
masterkey
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
D-14

f
TransactionReply
Table D-12
Transaction Reply
Description
Sendcurrentkeyentrymode
SendrandomATMnumber
Sendencryptorcapabilitiesandstate
LoadNCRSubpublickeyandsignature
DeleteHSMpublickey
DeleteNCRSubpublickey
SendEPPattributes
SendvariablelengthEPPserialnumber
Transaction Reply
4~000~...
Field
Description
Length
Messagesequencenumber
3or8
FS
Fieldseparator
Nextstateidentifier
FS
Fieldseparator
g1
Numberoftype1notestodispense
g2
g3
g4
g5
g6
g7
GS
Groupseparator
j1
Numberofhopper1coinstodispense
j2
j3
j4
j5
...
D-15

Transaction Reply
4~000~...
Field
Description
Length
jn
Numberofhopperncoinstodispense
FS
Fieldseparator
Functionidentifier:
1Depositandprint
2Dispenseandprint
3Displayandprint
4Printimmediate
5Setnextstateandprint
6Nightsafedepositandprint
7Depositandprint
8Dispenseandprint
9Displayandprint
AEjectcard,dispenseandprint
BParalleldispense,printandcardeject
CParalleldispense,printandcardeject
EReserved
FCardbeforeparalleldispenseandprint
OReserved
PPrintstatementandwait
QPrintstatementandsetnextstate
RReserved
SProcessdocumentwithcash(not
supported)
TDPMdepositenvelope(notsupported)
*Refundnotesandprint
Depositnotesandprint
Depositnotesandwait
:Processcheque
D-16

Transaction Reply
4~000~...
Field
Length
Description
bDispensecashfirstduringvaluable
mediaexchange
cProcessmultiplecheques
fDepositmediafirstduringvaluable
mediaexchange
m
Screennumber
Screendisplayupdate
Var
FS
FieldSeparator
Messagecoordinationnumber
Cardreturn/retainflag:
0ReturncardduringClosestate
1RetaincardduringClosestate
q
Printerflag:
0Donotprint
1Printonjournalonly
2Printonreceiptonly
3Printonreceiptandjournal
4PrintonPPDifFunctionIDis1or7
5PrintonPPDandjournalifFunctionID
is1or7
8Printonstatementonly
9Reserved
:Reserved
=Sidewaysprintingonreceiptif
FunctionIDisPorQ
>orwIdentifiesaudiodatafora
voiceguidedsession
aStampcheque,withoutprinterdata,if
theFunctionIDis:(Processcheque).
bEndorsecheque,withprinterdata,if
theFunctionIDis:(Processcheque)
r
Printerdata
Var(500)
D-17

Transaction Reply
4~000~...
Field
Description
Length
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
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
D-18

Transaction Reply
4~000~...
Field
Description
Length
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(Reservedforinternaluse)
as2
Cashhandlernumber(0or1)
as3
1stcassettetypeinspecifiedcashhandler
as4
Numberofbillstodispensefrom1sttype
as5
2ndcassettetypeinspecifiedcashhandler
as6
Numberofbillstodispensefrom2ndtype
as7
3rdcassettetypeinspecifiedcashhandler
as8
Numberofbillstodispensefrom3rdtype
as9
4thcassettetypeinspecifiedcashhandler
as10
Numberofbillstodispensefrom4thtype
as(n)
Lastcassettetypeinspecifiedcashhandler
as(n
+1)
Numberofbillstodispensefromlasttype
FS
FieldSeparator
at1
SmartcarddataID5
at2
Smartcarddata
...
D-19

Transaction Reply
4~000~...
Field
Description
Length
FS
FieldSeparator
ba1
Cheque(s)destinationdataIDa
ba2
Cheque(s)destinationdata
1Depositcheque(s)intopocket1
4to9Depositcheque(s)intopocket4to9
(notsupported)
atofDepositcheque(s)intopocket10to
15(notsupported)
EEjectthecheque(s)
AcknowledgeEJUpload
BlockCommand
Table D-13
Acknowledge EJ Upload Block Command
FS
FieldSeparator
bb1
BufferidentifierB
bb2
Chequeidentifier
bb3
Chequedestination
bb4
Chequestamp
bb5
Reserved
bb6
Chequeendorsetext
Var
FS
FieldSeparator
MACdata
Acknowledge EJ Upload Block command
6~~~1d.
Field
Description
Length
LastCharacterReceived
D-20

Command
Table D-14
Acknowledge and Stop EJ Command
EJOptionsandTimers
Command
Table D-15
EJ Options and Timers Command
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
D-21

D-22
Table of Contents
Device Identifiers
Appendix E
DeviceIdentifiers
Overview
E1
E2
SuppliesData
CashAcceptorSupplies(DIGw)
DoNotUseExtendedMessageFormat(Bit3=0)
UseExtendedMessageFormat(Bit3=1)
NoChangeReporting
E11
E16
E16
E18
E18
FitnessData
CashAcceptorFitness(DIGw)
E19
E24
TamperData
E25
Table of Contents
Device Identifiers
Device Identifiers
Overview
Overview
DeviceidentifiersaregenerallyknownasDIGs(deviceidentifier
graphics).TheyarereturnedintheStatusInformationfieldof
solicitedorunsoliciteddevicestatusmessagesandindicatethe
devicetowhichthedatainthemessageapplies.
ThetablesinthisappendixshowwhichSSTdevicetheDIGsrelate
to,thevaluestheycantakeandthedataaccompanyingthem.
FormoreinformationabouttheStatusInformationfield,seethe
followingsectionsinChapter 9,TerminaltoCentralMessages:
Forsolicitedstatusinformation,DeviceFaultStatus
InformationFieldonpage 973
UnsolicitedStatusInformationFieldonpage 985.
E-1
Device Identifiers
Hardware Configuration Data
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
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
E-2
var(2)
Device Identifiers
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
E-3
Device Identifiers
DIG
ASCII Value
(Hex)
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
4A
Reserved
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
E-4
var(2)
var(2)
Device Identifiers
DIG
ASCII Value
(Hex)
Data Length
4E
DoorAccessSystem(notsupported)
var(2)
00
O
4F
Notconfigured
OffLineFlexDisk
00
01
02
50
Notconfigured
1.44MBflexdiskdrive
2.88MBflexdiskdrive
TIBins(Alarms)
01
51
52
CardholderKeyboard
53
OperatorKeyboard
54
var(2)
Notconfigured
Standardkeyboard(basic)
KeyboardplusFDKs(enhanced)
CardholderDisplay
BIT0
BIT1
BIT2
BIT2
BIT3
BIT3
BITs47
var(2)
Reserved
Standard(BAPE)keyboard
EPPkeyboard
00
01
02
S
var(2)
Securecash,insecurecards,andeitherinsecuredepositbinorno
depository
00
01
02
R
var(2)
var(2)
Alwayszero
Alwayszero
0novoice
1voicesupportedifdigitalaudiopresent
0standardFDKs
1touchscreen
0(reservedalwayszero)
Reserved
55
Reserved
56
StatementPrinter
00
01
02
03
04
05
09
var(2)
Notconfigured
Configured
Reserved
Reserved
Reserved
Reserved
Enhancedthermalstatementprinter(SDC+)
E-5
Device Identifiers
DIG
ASCII Value
(Hex)
57
Reserved
Data Length
X
58
Passbook
(notsupported)
BIT0
BIT1
BIT2
BIT3
BIT4
BIT5
BITs616
59
5A
5B
Byte
Description
12
00Notconfigured
01Reserved
02Coindispenserwithuptofourhoppertypes
03Coindispenserwithmorethanfourhoppertypes
Byte
Description
34
Numberofhoppertypes.Thisisatwodigitdecimal
number.
57
Totalnumberofcoinsthatcanbedispensedper
transaction.Thisisathreedigitdecimalnumber.
SystemDisplay
5C
Notconfigured
Configured
Reserved
Reserved
E-6
SeeTable
Note1
var(2)
var(2)
Notconfigured
Configured
EnvelopeDispenser
00
01
02
03
var(7)
Notconfigured
Reserved
Configured(16x32)
MediaEntryIndicators
00
01
1=Passbookprinterpresent
1=Passbookprintercanreadmagneticstripe
1=Passbookprintercanwritemagneticstripe
1=Passbookprintercanreadpagenumber
1=Passbookprintercanscanfornextblankline
1=Passbookprintercanturnpages
Reserved
CoinDispenser
00
01
02
var(4)
var(2)
Device Identifiers
DIG
ASCII Value
(Hex)
Data Length
61
VoiceGuidance
var(2)
00
01
02
d
64
Notpresent
AudiopresentorStandardaudiopresent
Enhancedaudio
CashHandler0
00
01
02
03
04
var(5)
Notconfigured
Stackingcashhandler
Spraydispenser
knownastheGBRU.
Note:Whetherrecyclingisenabledordisabled,the
040070
transaction.
ThisDIGisonlyreportedwhenextendedcassettetypesare
supported.
e
65
CashHandler1
00
01
02
03
04
var(5)
Notconfigured
Stackingcashhandler
Spraydispenser
knownastheGBRU.
Note:Whetherrecyclingisenabledordisabled,the
040070
transaction.
supported.
E-7
Device Identifiers
DIG
ASCII Value
(Hex)
Data Length
66
BarcodeReader
var(4)
0001
J
70
71
Barcodereaderconfigured
UPS
var(2)
00
Notconfigured
01
UPSconfigured
ChequeProcessor
Configurationdatalengthvar(4)isanASCIIrepresentationofa
hexadecimalnumber.
0000
00xx
Notconfigured
Configured
WhenEnhancedConfigurationoption83is000thefollowingis
returned:
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.
E-8
var(4)
Device Identifiers
DIG
ASCII Value
(Hex)
Data Length
WhenEnhancedConfigurationoption83is001thefollowingis
returned:
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.
cash.Cashandchequescanbeacceptedtogetheras
partofasingletransaction(notsupported).
OpticalCharacterRecognition(OCR)codelinereadis
supported
MICRreadersupportsE13B
MICRreadersupportsCMC7
Reserved
SeeTable
Note2
andTable
Note3
E-9
Device Identifiers
DIG
ASCII Value
(Hex)
Data Length
Forexample,20ABindicatesCPMconfiguredwithE13BMICR
readerwith5bins,frontscannerandrearprinter.
w
77
NoteAcceptor
00
03
04
Notconfigured
BunchNoteAcceptor
BunchNoteAcceptorwithrecyclecapabilities.For
NCRSSTs,thisisknownastheGBRU.TheMStatus
valuesreportedindevicestatusmessagesare
compatiblewiththeGBXXfamilyofdevices
05
BunchNoteAcceptorreportingMStatusvalues
compatiblewiththeGBXXfamilyofdevices.ForNCR
SSTsthisisknownastheGBNA;itcanalsobe
reportedwhenaGBRUispresentwithrecycling
disabled.
06
BunchNoteAcceptorthatcanalsoacceptcheques.
Eithercashorchequescanbeacceptedinasingle
transactionbutnotboth.TheNCRSDMcanbe
configuredasthistypeofdevice.
07
cash.Cashandchequescanbeacceptedtogetheras
partofasingletransaction.(Notsupported).
08
Singlenoteacceptor
var(2)
SeeTable
Note4
SeeTable
Note2
TableNote1:IfOption79issetto000,onlythefirsttwobytesare
reported.IfOption79issetto001,allsevenbytesarereported.
TableNote2:YoucanconfigureanNCRscalabledepositmodule
(SDM)asachequeprocessorthatcanacceptcashandchequesoras
acashacceptorthatcanaccepteithercashorchequesbutnotbothin
asingletransaction.
TableNote3:Bits10and11aremutuallyexclusive.
TableNote4:Forarecyclingunit,thecashhandlervariantis
reportedas03andthecashacceptorvariantisreportedas04onlyif
recyclingmodeisenabled.
E-10
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)
41
TimeofDayClock
Data Length
ThisDIGisneverreturnedinthesuppliesfield
B
42
Communications
43
SystemDisk
44
45
var(1)
Cardcapturebin
CashHandler
var(5)
Cashhandlerrejectbin
Cashhandlercassettetype1
1
1
1
1
1
Ifextendedcassettesaresupported,thisisextendedtoincludethe
following:
46
1
1
1
SeeTable
Note7
EnvelopeDepository
var(1)
Envelopedepositbin
E-11
Device Identifiers
Supplies Data
DIG
ASCII Value
(Hex)
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
4A
Reserved
4B
4C
NightSafeDepository
var(1)
Nightsafebin
Encryptor
4D
SecurityCamera
var(1)
Securitycamerafilm
4E
4F
OffLineDisk
50
TIBins(Alarms)
51
CardholderKeyboard
52
OperatorKeyboard
E-12
Device Identifiers
Supplies Data
DIG
ASCII Value
(Hex)
53
CardholderDisplay
Data Length
T
54
Reserved
55
Reserved
56
57
StatementPrinter
var(5)
Statementprinterpaper
Statementprinterribbon
Statementprinterprinthead
Statementprinterknife
Statementprintercapturebin
1
1
1
1
1
Reserved
58
59
5A
PassbookPrinter
(notsupported)
var(5)
Reserved
Passbookprinterribbon
Passbookprinterprinthead
Reserved
Passbookprintercapturebin
1
1
1
1
1
CoinDispenser*
var(4)
Coindispenserhoppertype1
:
Coindispenserhoppertypen
1
1
1
1
1
SeeTable
Note10
SystemDisplay
5B
5C
EnvelopeDispenser
var(1)
Envelopedispenserhopper
E-13
Device Identifiers
Supplies Data
DIG
ASCII Value
(Hex)
Data Length
64
CashHandler0
var(29)
Rejectbin
Cassettetype1
Cassettetype1suppliesstatus
Cassettetype2
Cassettetype3
Cassettetype4
Cassettetype5
Cassettetype6
Cassettetype7
supported.
1
3
1
3
1
3
1
3
1
3
1
3
1
3
1
SeeTable
Note7and
TableNote8
CashHandler1
var(29)
Rejectbin
Cassettetype1
Cassettetype2
Cassettetype3
Cassettetype4
Cassettetype5
Cassettetype6
Cassettetype7
supported.
1
3
1
3
1
3
1
3
1
3
1
3
1
3
1
SeeTable
Note7and
TableNote8
ChequeProcessor
var(1)
65
71
WhenOption83is000suppliesinformationisnotreportedto
thehostforthechequeprocessor.DIGqwillnotbepresent.
WhenOption83is001or002thefollowingisreturned:
E-14
Device Identifiers
Supplies Data
DIG
ASCII Value
(Hex)
Data Length
Endorseprinter
Stamper
Reserved
Reserved
Bin1
Bin2
:
Binn
1
1
1
1
1
1
:
1
SeeTableNote9
w
77
var(1)
BNACashBin
Fordetailsofthesuppliesstatusofallcassettes,seeCash
AcceptorSupplies(DIGw)onpage E16
TableNote5:Always1(GoodState)forThermalprinters.
TableNote6:Iftheprinterdoesnothaveacapturebinbutthe
registryisconfiguredtosendthereceiptcapturebinstatus,the
valueis0.
Ifthereceiptprinterhasacapturebinbuttheregistryisnot
configuredtosendthereceiptcapturebinstatus,thisvalueisnot
reportedinthestatusmessage.
Guide.
TableNote7:Whenextendedcassettetypesaresupported,using
EnhancedConfigurationoption76,DIGEreportsthecombined
suppliesstatus.Separatecashhandlersuppliesstatusisgivenin
DIGdandDIGe.
TableNote8:Therejectbinsuppliesstatusreportsthecombined
statusforboththerejectbinandtheretractbin,wherepresent.The
statustakesthevalueofthefullestbin,asanoverfilloneitherwill
preventfurtheruseoftheSST.
TableNote9:Asuppliesvalueisreportedforthenumberofbins
reportedwithinthechequeprocessordatainthehardware
E-15
Device Identifiers
Supplies Data
configurationmessage.Inadditiontothestandardsuppliesvalues
0to4,thefollowingsuppliesvalueisalsopossible:
Supplies Status Data Value
Description
Mediahigh(almostfull)
TableNote10:Hopperpositions1to4arealwayspresent,hopper
positions5tonareonlypresentwhenmorethanfourhoppertypes
areconfigured.
CashAcceptorSupplies
(DIGw)
ThereportingofthestatusofaBNAorGBXXdeviceisconfigured
usingenhancedconfigurationoption45.Fordetailsofthesettings,
seeOption45BNASettingsonpage 714.
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
E-16
Device Identifiers
Supplies Data
notereporting(bit4).Whentheextendedmessageformatisnot
used,theBNAdataisasinglebyte.
Bit4=0 Ifoption45specifiesthatasuppliesstatusistobe
reportedwhenthefirstcassetteisfullornearlyfull,themostsevere
statusofanycassetteisreported.Themostseveresuppliesstatusis
calculatedasdescribedinTable E5.
5
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:
Table E-6
Least Severe BNA Supplies Status
Reporting
Theleastseverestatusofanycashincassette,calculatedas
describedinTable E6.Suppliesseveritiesfromleasttomost
severeare:Good;NearlyFull;BinOut;Overfill
Theoverallretractstatus,calculatedasdescribedinTable E4.
Overall Status
Description
Good
AnycassettehasasuppliesstatusofGood
Overfill
AllcassetteshaveasuppliesstatusofOverfillorBinOut
BinOut
AllcassetteshaveasuppliesstatusofBinOut
Nearly
Full
AnycassettehasasuppliesstatusofNearlyFullandnone
haveasuppliesstatusofGood
E-17
Device Identifiers
Supplies Data
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
911
003
Thethirdlogicalcassettetype
12
1315
004
Thefourthlogicalcassettetype
16
NoChangeReporting
IntheBNAdevicestatusmessage,asuppliesstatusof0No
Changeisreportedinthefollowingsituations:
Whenathresholdorcashuniterrorhasoccurred,theextended
messageformatisenabled,andthecashincassetteorretractbin
wasnotusedinthelasttransaction
Whennothresholdorcashuniterrorhasoccurredandthe
cashincassetteorretractbinwasnotusedinthelast
transaction.
E-18
Device Identifiers
Fitness Data
FitnessData
Thefollowingtablesummarisesthefitnessdataassociatedwith
eachdevice.Whereadevicehasmultipleseverities,theyaregiven
intheorderinwhichtheyappearinthemessage.
Table E-8
Device Fitness Data
DIG
ASCII Value
(Hex)
Data Length
41
TimeofDayClock
var(1)
FitnessTimeofDayClock
Communications
var(1)
FitnessCommunications
SystemDisk
var(1)
Fitnesssystemdisk
var(1)
Fitnessmagneticcard
CashHandler
var(5)
Fitnesscashhandler
Fitnesscassettetype1
1
1
1
1
1
42
43
44
45
Ifextendedcassettesaresupported,thisisextendedtoincludethe
following:
46
1
1
1
SeeTable
Note11
EnvelopeDepository
var(1)
Fitnessdepository
E-19
Device Identifiers
Fitness Data
DIG
ASCII Value
(Hex)
Data Length
47
ReceiptPrinter
var(2)
Fitnessreceiptprinter
Fitnesscapturebin
1
SeeTable
Note12
JournalPrinter
var(1)
Fitnessjournalprinter
48
49
Reserved
ThisDIGisneverreturnedinthefitnessfield
4A
Reserved
4B
4C
4D
NightSafeDepository
var(1)
Fitnessnightsafedepository
Encryptor
var(1)
Fitnessencryptor
SecurityCamera
var(1)
Fitnesssecuritycamera
4E
4F
OffLineFlexDisk
var(1)
Fitnessofflineflexdisk
50
TIBins(Alarms)
51
52
CardholderKeyboard
var(1)
Fitnesscardholderkeyboard
OperatorKeyboard
53
CardholderDisplay
var(1)
Fitnesscardholderdisplay
1
SeeTable
Note13
E-20
Device Identifiers
Fitness Data
DIG
ASCII Value
(Hex)
54
Reserved
Data Length
U
55
Reserved
56
StatementPrinter
var(1)
Fitnessstatementprinter
Reserved
58
Passbook
(notsupported)
var(1)
Fitnesspassbookprinter
Y
59
CoinDispenser
var(5)
Fitnesscoindispenser
Fitnesshopper1
Fitnesshopper2
Fitnesshopper3
Fitnesshopper4
Fitnesshopper5
Fitnesshoppern
1
1
1
1
1
1
1
Hopperreferstoasinglehopperoralogicalcombinationof
physicalhoppers(ahoppertype)dependingonthehardware
configuration.
Hopperpositions1to4arealwayspresent,hopperpositions5ton
areonlypresentwhenmorethanfourhoppertypesareconfigured.
Z
5A
SystemDisplay
5B
5C
61
EnvelopeDispenser
var(1)
Fitnessenvelopedispenser
VoiceGuidance
var(1)
Theaudiodevicereturnsthefollowingfitnessstatuses:
0NoErrors
2Warning
4Fatal
E-21
Device Identifiers
Fitness Data
DIG
ASCII Value
(Hex)
Data Length
64
CashHandler0
var(29)
Fitnesscashacceptor
Cassettetype1(intherange001999)
Cassettetype1fitnessstatus
1
3
1
3
1
3
1
3
1
3
1
3
1
3
1
supported.
SeeTable
Note11
CashHandler1
var(29)
Fitnesscashacceptor
1
3
1
3
1
3
1
3
1
3
1
3
1
3
1
supported.
SeeTable
Note11
BarcodeReader
var(1)
Fitnessbarcodereader
ChequeProcessor
var(1)
65
66
71
WhenOption83is000thefollowingisreturned:
Fitnesschequeprocessor
E-22
Device Identifiers
Fitness Data
DIG
ASCII Value
(Hex)
Data Length
WhenOption83is001thefollowingisreturned:
Fitnesschequeprocessor
Endorseprinter
Stamper
Escrow/Rebuncher
Reserved
Bin1
Bin2
Binn
1
1
1
1
1
1
1
1
SeeTableNote14
w
77
var(1)
Fitnessbunchnoteacceptor
SeeCashAcceptorSupplies(DIGw)onpage E16
TableNote11:Whenextendedcassettetypesaresupported,using
EnhancedConfigurationoption76,DIGEreportsthecombined
fitnessstatus.SeparatecashhandlerfitnessstatusisgiveninDIGd
andDIGe.
TableNote12Bydefault,theregistryisconfiguredtoexcludethis
valuefromthefitnessstatusmessage.
Ifthereceiptprinterhasacapturebinbuttheregistryisnot
configuredtosendthereceiptcapturebinstatus,thisvalueisnot
reportedinthestatusmessage.
Iftheprinterdoesnothaveacapturebinbuttheregistryis
configuredtosendthereceiptcapturebinstatus,thevalueis0.
AssociatedComponentsintheAPTRAAdvanceNDCDevelopers
Guide.
TableNote13:Bydefault,theregistryisconfiguredtoexcludethis
valuefromthefitnessstatusmessage.Ifrequired,itcanbeincluded
byeditingtheregistry.
Guide.
TableNote14:Afitnessvalueisreportedforthenumberofbins
reportedwithinthechequeprocessordatainthehardware
E-23
Device Identifiers
Fitness Data
CashAcceptorFitness
(DIGw)
ThereportingofthestatusofaBNAorGBXXdeviceisconfigured
usingenhancedconfigurationoption45.Fordetailsofthesettings,
seeOption45BNASettingsonpage 714.
Ifthedevicecontainsintelligentcassettes,thecommunications
connectionisdroppedwhentheinnercoverisopened.Thisisdone
toprotecttheonboardprocessors.Itmeans,however,thatthe
fitnessofthecassettescannotbedetermined.
Whateverthesettingsofoption45,theoverallfitnessstatusis
calculatedasfollows:
Ifthecashacceptserviceisnotavailable,theoverallfitnessisa
fatalcondition
IfanycashincassettehasafitnessofFatalbutthisisnotdueto
acassettebeingeitherfullormissing,theoverallfitnessisa
warningcondition
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
911
003
Thethirdlogicalcassettetype,ifpresent
12
1315
004
Thefourthlogicalcassettetype,ifpresent
16
nm
Logicalcassettetypeidentifier
Fitnessoftheidentifiedcassettetype
E-24
Device Identifiers
Tamper Data
TamperData
Thefollowingtablesummarisesthetamperdataassociatedwith
eachdevicewhenenhancedconfigurationoption24issettosend
extendedtamperdata.
Fordetailsofoption24,seeOption24Enhanced/TISensorStatus
UnsolicitedMessageonpage 79.
Table E-10
Device Tamper Data
DIG
ASCII Value
(Hex)
Data Length
44
var(1)
Cardcapturebin
CashHandler
var(0)
45
Thisisnotreported.
Cashhandler0isreportedusingDIGd,describedinCash
Handler0onpage E26
Cashhandler1isreportedusingDIGe,describedinCash
Handler1onpage E27
F
46
47
4B
50
SeeTableNote15,Table
Note16,TableNote17
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
E-25
Device Identifiers
Tamper Data
DIG
ASCII Value
(Hex)
Data Length
56
StatementPrinter
var(102)
Retractposition1
:
Retractpositionn
2
1
Passbook(notsupported)
var
NumberofRetractposition.Thisisintherange00to99
Retractposition1
:
Retractpositionn
2
1
CoinDispenser
var
NumberofRejectpositions.Thisisintherange00to99
Rejectposition1
:
Rejectpositionn
2
1
Retractposition1
:
Retractpositionn
2
1
NumberofHopperpositions.Thisisintherange00to99
Hopperposition1
:
Hopperpositionn
2
1
CashHandler0
var
Rejectposition1
:
Rejectpositionn
2
1
Retractposition1
:
Retractpositionn
2
1
NumberofCassettepositions.Thisisintherange00to99
Cassetteposition1
:
Cassettepositionn
2
1
58
59
SeeTableNote18and
TableNote19
64
E-26
Device Identifiers
Tamper Data
DIG
ASCII Value
(Hex)
Data Length
65
CashHandler1
var
Rejectposition1
:
Rejectpositionn
2
1
Retractposition1
:
Retractpositionn
2
1
Cassetteposition1
:
Cassettepositionn
2
1
Note21,TableNote22
andTableNote23.
77
CashAcceptor
Retractposition1
:
Retractpositionn
2
1
Cassetteposition1
:
Cassettepositionn
2
1
71
ChequeProcessor
var(102)
SeeTable
Note29
Numberofbins.Thisisintherange00to99
Binposition1
:
Binpositionn
2
1
Note25,TableNote26,
TableNote27andTable
Note28
TableNote15:Onlythealarmsandsensorsarereportedusingthis
field.
TableNote16:Sensortypes001,002,003,and004mustbereported
withinthisfield,asdefinedinTable E11.
TableNote17:Sensorstatescanbeeither000noalert(normal),
or001alert.
TableNote18:Thecoindispenserfieldcontainsanorderedlistof
coincontainers,includinghoppers,retractandrejectbins.Thelistis
orderedbyphysicaltypethenphysicalposition.Thereporting
orderis:rejectbins,retractbins,thenhoppers.Thelimitonthe
E-27
Device Identifiers
Tamper Data
numberofphysicalcontainerswithineachcategoryisthemaximum
possiblemessagelength.
TableNote19:Ifthecoindispenseispartofacompounddispense
ordepositdevice,thisfieldreportsthestateofallphysicalcassettes,
includingdeposit.
TableNote20:Thecashhandlerfieldcontainsanorderedlistof
cassettesandbins.Thelistisorderedbyphysicaltypethenphysical
position.Thereportingorderis:rejectbins,retractbins,then
cassettes.Thelimitonthenumberofphysicalcontainerswithin
eachcategoryisthemaximumpossiblemessagelength.
TableNote21:Ifthecashhandlerisarecycler,thisfieldreportsthe
stateofallphysicalcassettes,includingdeposit.
TableNote22Theretractposition(1)andtherejectposition(2)are
notreported.
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
issentwhenthebindoorisclosedtoreportthebinsasinserted.
Theseeventsarealsojournaledusingreservedscreenst58andt59.
E-28
Device Identifiers
Tamper Data
Table E-11
TI Bins (Alarms) Sensor Types
SensorType
Description
001
Vibrationand/orheatsensor
002
Doorcontactsensor
003
Silentsignalsensor
004
Electronicsenclosuresensor
005to009
Reserved
E-29
Device Identifiers
Tamper Data
E-30
Table of Contents
ASCII/EBCDIC Conversion Table
Appendix F
Overview
F1
CodeConversionTable
F2
Table of Contents

Overview
Overview
Thisappendixprovidesaconversiontableshowingthemappingof
ASCIIcharactercodestoEBCDICandASCIIhexadecimalcodes.
F-1

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

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

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

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

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
F-6
Table of Contents
Related Documentation
Appendix G
Overview
G1
AdvanceNDCDocumentation
G2
APTRAAuthorDocumentation
G3
NDC+Documentation
G5
OtherNCRDocumentation
G6
MiscellaneousDocumentation
G7
Table of Contents
Overview
G
Overview
Thisappendixliststhefollowingdocumentation:
DocumentationprovidedontheAdvanceNDCCDROM
DocumentationthatishistoricallylinkedtoAdvanceNDC,but
notprovidedontheAdvanceNDCCDROM
Documentationfromothersources,suchasoptional
componentsandstandardsbodies.Thisdocumentationisnot
providedontheAdvanceNDCCDROM.
Onadevelopmentsystem,thedocumentationcanbeinstalledalone
orinstalledwiththeAdvanceNDCsoftware.Thedocumentationis
notinstalledonaruntimesystem.
G-1
Advance NDC Documentation
AdvanceNDCDocumentation
ThefollowingpublicationsareprovidedontheAdvanceNDC
CDROM.TheyareavailablefromNCRonrequest.
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
G-2
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
runtimeerrorsprovidedwithATM.
SpecialSelfServiceHelp
Windows
Help
runtimeerrorsprovidedwithSpecialSelfService.
StatementPrinterHelp
Windows
Help
runtimeerrorsprovidedwithStatementPrinter.
AdvanceNDCHelp
Windows
Help
ContextsensitivehelpfortheAdvanceNDCAuthoring
components(excludingApplicationCorecomponents).
AdvanceNDCApplicationCore
Help
Windows
Help
ContextsensitivehelpfortheApplicationCore/Supervisor
Authoringcomponents.
G-3
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.
G-4
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.
G-5
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.
G-6
Miscellaneous Documentation
MiscellaneousDocumentation
Thissectionlistsanythirdpartypublicationsanddocumentsthat
arereferencedinthetext.MoreinformationaboutCENXFS
specificationsisavailableathttp://www.cen.eu/cen/pages/default.aspx.
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.
G-7
Miscellaneous Documentation
G-8
Glossary
Symbols
.NET Asetofcapabilitiesinproductsthatenablespeople,
information,systems,anddevicestoconnectandexchange
informationseamlesslythroughtheuseofWebservices.
ABA AmericanBankersAssociation.
ActiveX Control AtypeofCOMcomponentwhichimplements
standardinterfaces,andcanbeincludedinawebpageandusedin
languagessuchasVBScript.
Advance NDC NCRsimplementationofNDCforaWindows
environment.
AID ApplicationIdentifier:UsedtouniquelyidentifyeachEMV
applicationthataterminalsupports.
API ApplicationProgrammingInterface.
APTRA Thebrandnameforafamilyofselfservicesoftware
solutionsfromNCR,currentlybasedontheWindowsoperating
system.
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.
Glossary-1
Basic Remote Key Protocol Aminimumcommandsetforremotekey

managementthatcomplieswiththemandatoryrequirementsof
ANSX9.24.2004part2.
Bills Alternativetermforcurrencynotes.
BNA BunchNoteAcceptor.AnNCRdevicevariantreportedusing
theBNAsetofmStatusvalues.Allowsaconsumertodeposita
numberofbanknotesinabunch.Thisisalsousedasagenericterm
forcashacceptors,forexampleonmanySupervisormenuoptions.
SeeCashacceptor.
BOP BasicOperatorPanel.NotsupportedbyAdvanceNDC.
SeeEOP.
CAM CardAuthenticationMethod.
Cardholder SeeConsumer.
Cash acceptor AgenerictermforanySSTdevicethataccepts
banknotedeposits.
SeealsoBNA,Cashrecycler,GBNA,GBRU,Recyclingunitand
SNA
Cash recycler AgenerictermforanySSTdevicethatrecycles
banknotes.
SeeCashrecycling, Recyclingunit.
Cash recycling Theprocessofreusingdepositedcashfordispense
operationsonasingleSST.
Catalog IntheAPTRAAuthor,ameansoforganisingworkersor
applicationsintomanageablegroups.
CDM CashDispenserModule.CENXFSclassnamefortheCash
Dispenserservice.
CEN ComitEuropendeNormalisation(EuropeanCommitteefor
Standardization).ResponsiblefortheXFSinterfacespecification.
Central Thecontrolapplicationonthehostorswitchthatsends
commandstotheSSTandrespondstorequestsfromtheSST.
Cheque Processor CPMandbunchchequeacceptor.
CIM CashInModule.CENXFSclassnamefortheCashAccept
service.
CMC-7 AnMICRfontthatisusedoncheques.
SeealsoMICRandE13B.
Glossary-2
Codec ShortformofCOder/DECoder.Softwarethatcompresses
anddecompressesadigitalvideosignalsuchasMPEG.
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.
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.
Glossary-3
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
indexintoanarrayofscreenfragmentsusedtoinformthe
cardholderoftheexactconditionsthathaveoccurred.
E13B AnMICRfontthatisusedoncheques.
SeealsoMICRandCMC7.
EBCDIC ExtendedBinaryCodedDecimalInterchangeCode.An
eightbitcharactercode.
EEKC ExtendedEncryptionKeyChange.
EID EncryptionInitialisationData.
EJ ElectronicJournal.TheEJlogemulatestheprintedjournal.All
thedatanormallyrecordedonthejournalprinteriswrittentotheEJ
logontheterminalssystemdisk.
EKC EncryptorKeyboardController.Amorecomplexandsecure
versionoftheBAPE,fittedtosometerminals.Notsupportedin
AdvanceNDC2.06orlater.
EMV Europay,Mastercard,VISA.Aconsortiumresponsibleforthe
theEMVstandardforsmartcards.
Glossary-4
Encryption Certificate Acertificateusedtoencryptdata.IntheNDC

context,acertificateisusedtoauthenticateandsecure
communicationbetweenthehostsecuritymoduleandtheEPP.
SeealsoVerification Certificate.
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.
Flex drive Diskettedrive.
Forms-based printing FormsbasedprintingutilisestheWindows
printingenvironment,removingtheneedtoknowdetailsofthe
printer,andisimplementedusingXFSforms,whicharegenerated
dynamicallybytheapplication.
GBNA GlobalBunchNoteAcceptor.AnNCRdevicevariantthat
allowsaconsumertodepositanumberofbanknotesinabunch.
SeeCashacceptor.
Glossary-5
GBRU GlobalBillRecyclingUnit.AnNCRdevicethatisreported
usingtheGBNAsetofmStatusvalues.Allowsaconsumerto
depositanumberofbanknotesinabunch.Thedevicecanalso
dispensenotesandrecycledepositednotes.
SeeCashrecycler,Recyclingunit.
GBXX AnNCRtermforacashacceptororarecyclingunitwhere
thespecificdeviceisnotsignificant.Usedwhentheinformation
appliestoboththeGBNAandGBRUand/orequivalentdevices.
SeeGBNA,GBRU
GIF GraphicsInterchangeformat.
Hex Shortformofhexadecimal.
HRI HumanReadableInterpretationofabarcode.
Hooks Generaltermformiscellaneoususerdefinedroutines
detailedintheMISCONTfile.
SeealsoExit
HSM HostSecurityModule
ICC IntegratedCircuitCard.Acardcontaininganintegrated
circuit.Alsoknownasasmartcard.
ID Identifier.
IMCRW IntegratedMagneticCardReader/Writer.
Intercept routine Anothernameforvirtualcontroller.
Invalid notes SeeRejecteditems
IQA ImageQualityAssessment
ISO InternationalStandardsOrganisation.
ITR InteractiveTransactionResponse.
JIF JPEGInterchangeFormat.
JPEG JointPhotographicExpertsGroup.
lpi linesperinch.
LUNO LogicalUnitNumber.
MAC MessageAuthenticationCode.Amethodofprotecting
messagespassingbetweentheterminalandCentralfrom
tampering.
Glossary-6
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.
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.
OCR OpticalCharacterRecognition.
OpCode ShortformofOperationCode.
PAN PrimaryAccountNumber.
PCI DSS PaymentCardIndustryDataSecurityStandard.
PCX PictureExchange.AdvanceNDCdoesnotsupportthisfile
formatforgraphics.
PDF PortableDocumentFormat.TheAdobefileformatfor
documentsviewableinAdobeReader.
Persistent memory Thistypeofmemoryretainsinformationwhen
thepowerisswitchedofforlost.Alsoknownaspersistentstorage.
Glossary-7
PIN PersonalIdentificationNumber.Asecretidentificationnumber
thatisissuedtoeachcardholder.
PNG PortableNetworkGraphics.
PPD ProgrammablePrintingDepository.Oneofthetypesofprinter
supportedbyAdvanceNDC.
PVKI PINVerificationKeyIndicator.PartofthePINoffsetdata
usedinVISAPINverification.
PVV PINVerificationValue.AnotherpartofthePINoffsetdata
usedinVISAPINverification.
Raw data printing Amethodofprintingwhereprinterspecific

controlcodesaresentdirectlytotheprinter.
Recycler AnothertermforRecyclingunit
Recycling unit Agenerictermforadevicethatallowsaconsumerto
depositanumberofbanknotesinabunch.Thedevicecanalso
dispensenotesandrecycledepositednotes.
SeealsoGBRUandGBXX
Refundable Deposit Depositmodewherecashisheldintheescrow,
fromwhereitcanberefundedtothecardholderbeforethedeposit
iscompleted.
Refused notes Anothertermforrejecteditems.
Rejected items Itemsthatareunrecognizedasnotes;eithertheyare
notnotesorcannotberecognizedasnotes.Suchitemscannotbe
acceptedfordepositandarereturnedimmediatelytotheconsumer.
RKM RemoteKeyManagement.
RSA encryption Anasymmetricencryptionschemeusingprivate
andpublickeys,devisedbyRivest,ShamirandAdleman.
Rule File SeeControl File
Scheme Atermusedincryptographyforthealgorithmsusedto
secureinformation.
Screen Base Thescreennumberofthefirstscreeninthescreen
groupforeachlanguage.
Screen Group Therangeofscreensthatarespecifictoasingle
language.
SCRW SmartCardReaderWriter.Adevicewhichcaninteractwith
anICC.
Glossary-8
SDC SerialDistributedControl.
SDM ScalableDepositModule.AnNCRdevicethatisreported
usingthesamesetofmStatusvalesasaBNA.Allowsaconsumerto
depositcashorcheques.
Self-Service Application ThisistheapplicationwhichrunsonanSST
andprocessesallthenecessarytransactions.
Self-Service Support A32bitopensoftwareplatformsuppliedby
NCRforuseonSSTs.
Smart Card Commonnameforacardwhichusesanintegrated
circuit(microchip)ratherthanamagneticstripe.SeeICC.
SMS Shortmessageservice.
SNA SingleNoteAcceptor.AnNCRdevicevariantthatisreported
usingthesamesetofmStatusvaluesasaBNA.Allowsaconsumer
todepositasinglebanknote.
SeeBNA,Cashacceptor
SNMP SimpleNetworkManagementProtocol.Awidelyused
networkmonitoringandcontrolprotocol.
SO ShiftOut.
SST SelfServiceTerminal.Alsoknownasaterminal.
Stacking Dispenser Acashdispenserthatfeeds media out of a safe
and stacks it in a temporary-stacking section before presenting the
media to the cardholder.
Standard Cash Handler Afourcassettestackingdispenser.See
StackingDispenser.
Standard EJ Backup ThedefaultsettingforEJbackup.Createsa
singleelectronicjournalbackupfile.
Standard Output Thedestinationtowhichoutputissent.Unless
redirected,forexampletoafile,standardoutputisthecommand
windowfromwhichtheprogramwasinitiated.
STCONT AcontrolfiledefinedbyExitswhenuserdefinedstatesare
added.
SeealsoControl File
SUPCTR AcontrolfileusedbyExitswhenuserdefinedSupervisor
featuresareadded.
SeealsoControl File
Supervisor TheSupervisorapplicationperformstheoutofservice
operationsneededtomaintainandrunSSTs.
Glossary-9
Suspect note Anotewithrecognisedauthenticationfeaturesbut

qualityand/ortolerancedeviations.Inmostcases,thismeansa
damagedorsoiledbanknote.Thisisthesameasacategory3note,
asdefinedintheECB6regulation.
SWF ShockWaveFlash.AfileformatfromAdobefordisplaying
multimediafilesandanimatedvectorgraphics.
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,suchasdiskdrivesandprinters.
UPS UninterruptiblePowerSupply.Adevicethatprovidesbattery
backupwhenmainspowerfailsordropstoanunacceptablevoltage
level.
Valuable Media Printeditemswithamonetaryvalue,suchasa

coupon.
Vault Todepositnotesinacassetteorbinasthefinalstageina
transaction,afterwhichthenotescannolongerbereturnedtothe
cardholder.
VC VirtualController(orinterceptroutine).Auserwrittenroutine
tointerceptandrespondtomessages.
SeealsoExit
VCCONT AcontrolfileusedbyExitswhenvirtualcontrollersare
added.
SeealsoControl File
VDM VendorDependentMode.
Verification Certificate Acertificateusedtoauthenticatean
encryptioncertificate
Glossary-10
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.
Glossary-11
Glossary-12
Index
Index
A
Abbreviationsusedinthemanual lix
AcknowledgeandStopEJ 1093
AcknowledgeEJUploadBlock 1092
Activitytimerindialup 135
AdvanceNDC
documentation G2
Alphanumericstatenumbers 24
Amountcheckstate 224
Amountentrystate 221
Animation 344
Applicationtimersfordialup 133
Audienceforthismanual lv
Autovoice(option2) 1018
Backgroundcolourcontrolcommands 328
BANKSYSPINblock 117
BAPEsecurity 112
Barcodereader
Option48 717,1019
state 2168
Base94encodinganddecoding 1130
Baudratefordialupconnection 132
Blinkingcommands 327
BNASeeBunchNoteAcceptor
Buffervalidationstate 2144
Buffers
Amount 221
FDK 276
FDKswitchstate 275
Generalpurpose 230
Operationcode 216,279
Track3data 249,251
Bunchchequeamountdisplaycontrolsequence 337
Bunchchequecodelinedisplaysequence 337
Bunchchequeimagedisplaycontrol 335
Bunchchequeimagedisplaysequence 335
Bunchchequevaluedisplaycontrolsequence 338
BunchNoteAcceptor
Cashacceptstate 296
Closestate 241
Encash 1077
Encash,printandsetnextstate 1076
fitnessreporting E24
Journalnotescount(option44) 714
Journalvaultednotescount(option44) 1019
Messagesettings(option45,bit1) 9116
Messagesettings(option45) 714,96
Index-1
Index
Notedefinitionssolicitedstatusmessage 953
Option45inEnhancedConfigurationParametersLoadmessage 1019
Refundandsetnextstate 1075
suppliesreporting E16
Bunchedcheques
formatofamountdisplay 338
Cameracontrolstate 254
Cardbeforecashfunction 1070
Cardbeforeparalleldispenseandprintfunction 1072
Cardreadstate 27
Cardreader/writer(solicited/unsolicitedmessage) 988
Cardwritestate 249
Cardholderdisplayreservedscreens 36
Internationalcurrencydisplayformat 345
Cardholderverificationstate 255
Cardlesstransactions(option77) 1019
Cashacceptstate 296
CashDepositHandlingstate 2158
CashDepositRetractDestination(option74) 1019
Cashhandler(solicited/unsolicitedmessage) 990
Cashhandlers
(option76) 1019
CCMVISA2dialupsystem 131
CellBody
BITs47 E5,E6
CentraltoSST
Dialupmessages 137
Centraltoterminalmessages
EJcommands 1091
EJOptionsandTimers 1091
Messageexceptionhandling 1096
NDCconfigurationcommand 107
Terminalcommands 103
Changingdisplayinidle 330
Charactersets B2
downloadable B4
ISO8859 B12
Chequeimagecontrol 335
ChequeProcessor
Chequeacceptstate 2109
Option83 1019
Closestate 239
Coindispenser
option79 96
solicited/unsolicitedmessage 9125
Commandrejectcauses 1096
Communications
CCMVISA2dialup 131
CompareoperationsintheDataCopyandComparestate 2157
Index-2
Index
ConfigurationIDnumberloadmessage 1024
Configurationparameters
Configurationparametersloadmessage 1015
Introduction 71
Configurationparametersloadmessage
LogicalunitnumberLUNO 73
millisecondtickspertimerfield 74
Timernumber 73
Controlcharacters
CRTscreenactivity 316
Digitalaudiocontrol 323
CopyoperationsintheDataCopyandComparestate 2156
CRTdisplaycharacters 314
Customerscreengroups 33
CustomerselectablePINstate 284
Customisationdatacommands
ConfigurationIDnumberload 1024
Configurationparametersload 1015
Dateandtimeload 1033
Dispensercurrencycassettemappingtable 1045
Encryptionkeychange 1034
Enhancedconfigurationparametersload 1017
FITdataload 1022
Messageauthenticationfieldselectionload 1026
Screen/keyboarddataload 1011
Statetablesload 109
Typesofcommand 107
Customisedscreensdefinition 33
DAPI7andrearsettlement 354
DASHcardreader 263
DataCopyandComparestate 2154
Dateandtimeloadmessage 1033
Dateformat(option3) 1018
Decoding,Base94 1130
Definingakeyboard
Example 416
Depositandprintfunction 1066
Depository(solicited/unsolicitedmessage) 995,9121
DESkeyformat,RSAencrypted 1129
Devicefaults 972
Devicefitnessstate 267
Deviceidentifiers
Fitnessdata E19
Hardwareconfigurationdata E2
Suppliesdata E11
Devicestatusinformation
BarcodeReader(solicited/unsolicited) 9127
Camera(unsolicited) 9104
Cardreader/writer(solicited/unsolicited) 988
Cashacceptor(solicited/unsolicited) 9113
Cashhandler(solicited/unsolicited) 990
Index-3
Index
ChequeProcessor(solicited/unsolicited) 9121
Chequeprocessor(solicited/unsolicited) 9121
Coindispener(solicited/unsolicited) 9125
Depository(solicited/unsolicited) 995
Electronicjournalprinter(unsolicited) 999
Encryptor(unsolicited) 9103
Envelopedispenser(unsolicited) 9120
Journalprinter(unsolicited) 997
Nightsafedepository(solicited/unsolicited) 9102
NoteAcceptor(solicited/unsolicited) 9113
Powerfailure(unsolicited) 987
Receiptprinter(solicited/unsolicited) 996
Sensors(unsolicited) 9105
Statementprinter(solicited/unsolicited) 9110
Supervisorkeys(unsolicited) 9108
Timeofdayclock(unsolicited) 987
Touchscreenkeyboard(unsolicited) 9107
Voiceguidance(solicited/unsolicited) 9112
Dialup
MessageonCP 136
Messagesuppression 136
Systemsetup 132
Transactioncompletion 136
Dialupmessageheaderformat 134,137
Dialupmessages
CentraltoSST 137
SSTtoCentral 134
Dialuptimers 132
Screenupdateinatransactionreply 325
Usinganestedscreen 325
usingdynamicplaceholderdata 326
Dispenseandprintfunction 1067
Dispensercurrencycassettemappingtablemessage 1045
Displayandprintfunction 1068
Displaycontrols
Liftchequeimage 335
Displaydynamictextdictionarysequence 339
Displayimagefilescontrol 334
Dynamicbuttonscontrol 342
Dynamictextdefinition 343
Dynamictextdictionarysequence
BunchChequeAcceptrefusereason 2122
BunchChequeAcceptrejectreason 2122
CashAcceptrefusereason 2107
e5 997
EightFDKselectionfunctionstate 279
EJcommands
Index-4
Index
EJUpload D2
EJUploadMessage 981
EJupload,dialup 133
Electronicjournalprinter(unsolicitedmessage) 999
EMVmessageclass 102,1096
EMVsmartcard(option70) 1019
EMVsmartcardextendedstatus(option69) 1019
Encoding,Base94 1130
Encryptionkeychangemessage 1034
Encryptionkeyentry 413
Encryptorinitialisationdata 976
Enhancedamountentrystate 256
Enhancedconfigurationparametersload
optionnumbers,enhancedconfigurationparameterload 1017
Enhancedconfigurationparametersloadmessage
AlphanumericStateEntry 721
Autovoice 77
BarcodeReader 717
BNAJournalNotesCount 714
BNAMessageSettings 714
CashHandlers 719
chequeprocessor 721
coindispenser 721
Dateformat 77
EMVSmartCardExtendedStatusoption 718
EMVSmartCardoption 718
Enhancedcarddevicesecurityoption 717
EnhancedEJbackup 713
Envelopedispenserstatusoption 79
GBRUmstatusandvariantreporting 720
Journalprinterbackupprintoperationsoption 78
Journalprinterbackuptimeoption 78
Leftcolumn 77
MCNRange 711
Mediaentryindicatorsflashrateoption 710
Numberofsecondspertimerfield 722
PrintTrack2toJournal 713,714
Remoterelayoption 710
ReportdualmodeEJandhardcopybackupunsolicitedmessages 713
Rollwidth 77
Sendenhanced/TIsensorstatusunsolicitedmessageoption 79
Simulatesupervisormodeentry/exitoption 711
Specificcommandrejectoption 78
Track1format 78
Transactionstatusinformationoption 78
EnhancedEJbackup(option36) 1019
EnhancedPINentrystate 251
EnhancedPrinterControlCodes
DefineDownloadableBitImage 516
DefineDownloadableCharacterSet 515
PrintBarcode 512
PrintDownloadableBitImage 510
Index-5
Index
PrintEpsonGraphics 513
SelectArabicCharacterSets 510
SelectHorizontalHeightofBarcode 518
SelectInternationalCharacterSet 59
SelectOS/2CodePage 59
SelectPrintingPositionofHRICharacters 517
SelectWidthofBarcode 517
SetLeftMargin 57
SetRightMargin 58
EnhancedRemoteKeyLoadingscheme
DESkeymessagesequence 1128
keydeletion 1129
EnhancedTI/sensorstatus(option24) 1018
Envelopedispenser(unsolicitedmessage) 9120
Envelopedispenserstate 215
Envelopedispenserstatus(option23) 9120,1018
EPPauthenticationprocess 1121
EPPsecurity 113
ErrorRedialtimer 136
Examplemessages
digitalaudiocontrolinatransactionreply 325,326
Exitstates 21,287
Extendedencryptionkeychangemessage 1037
ExtendedscreencontrolsreservedscreensK 38
Extensionstates 25
ExtensiontoStateY 283
FDKinformationentrystate 276
FDKswitchstate 275
Data 82
Fields 84
Introduction 81
FITdataloadmessage 1022
FITfields 114
Algorithm/bankIDindex(PAGDX) 84
Decimalisationtable(PDCTB) 89
EncryptedPINkey(PEKEY) 89
Indexreferencepoint(PINDX) 89
Indirectnextstateindex(PSTDX) 84
InstitutionID(PFIID) 84
InstitutionIDindex(PIDDX) 84
Languagecodeindex(PLNDX) 811
MaximumPINdigitschecked(PCKLN) 85
MaximumPINdigitsentered(PMXPN) 84
MMsensorflag(PMMSR) 811
PANdataindex(PANDX) 87
PANdatalength(PANLN) 87
PANpad(PANPD) 88
PINblockformat(PBFMT) 811
PINoffsetdata(POFDX) 89
PINpad(PINPD) 86
Index-6
Index
Track3PIN(PRCNT) 88
FITswitchstate 246
FontIDmappingtable B12
Foregroundcolourcontrolcommands 328
Foreigncurrenclyexchangetrasnactions
LocalCashDispensestate 2147
FourFDKselectionfunctionstate 219
FunctionIDs
FunctionID 1054,1099,D17
FunctionID* 1054,1099,D17
FunctionID1 1053,1057,1099,D17,D18,D21
FunctionID2 1053,D17
FunctionID7 1053,1057,D17,D18,D21
FunctionID9 1053,1099,D17
FunctionIDA 1054,1057,1099,D17
FunctionIDB 1054,1057,1099,D17
FunctionIDC 1054,1057,1099,D17
FunctionIDE 1054,D17
FunctionIDF 1054,1099,D17
FunctionIDO 1054,1099,D17
FunctionIDP 1054,1057,1058,1099,D17
FunctionIDQ 1054,1057,1058,1099,D17
FunctionIDR 1054,D17
FunctionIDS 1054,1099,D17
FunctionIDT 1054,1099,D17
FunctionID 1054,1099,D17
FunctionIDc 1054
FunctionIDcolon 1054,1057,1099,D17,D18
GBRU
Option78 720
GraphicpicturesreservedscreensG 38
Graphicspictures C2
ImAlivemessage 135
Imagedisplaycontrols
Bunchcheque 335
Informationentrystate 229
InsertCardState 2140
Internationalcurrencydisplayformat 345
ISO8859charactersets B12
Journalprinter(unsolicitedmessage) 997
Journalprinterbackup 1139
Journalprinterbackuplogtamper(option22) 999
Journalprinterbackupprintoperations(option17) 1018,1139
Index-7
Index
Journalprinterbackuptime(option16) 1018,1139
KeyentrymodeD 937
Keyloading,RSAinitialforsignatures 1121
Keyverificationvalues 1117
Keyboarddata
Encryptionkeyentry 413
Introduction 42
Securekeyentry 413
Statesandkeyboards 48
Supervisormode 412
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 259
Languageselectfromcardstate 273
Leftmargincontrol 332
Leftprintcolumn(option5) 1018
Liftchequeimagecontrol 335
LinkedFITs 812
LocalCashDispensestate
foreigncurrencyexchangetransactions 2147
messagehandling 2151
Logocontrol 333
Logosreservedscreens 312
MCNrange(option34) 1019
MCRWECDsecurityjitter(option46) 1019
Mediaentry/exitindicatorsflashrate(option25) 1018
Messageauthentication 1110
Fullmessageauthentication 1112
Selectivemessageauthentication 1113
SendingtheMACfieldfromCentraltotheterminal 1111
SendingtheMACfieldfromtheterminaltoCentral 1111
Timevariantnumber 1111
Messageauthenticationcode
Generation 1110
Messageauthenticationfieldselectionloadmessage 1026
Messagecoordinationnumber 1087
Messageexceptionhandling
Index-8
Index
Reasonsforacommandreject 1096
Messagehandling
LocalCashDispensestate 2151
MessageonCPoptionindialup 136
Messagesuppressionindialup 136
Messagetypes
Quickreference D2
Acknowledgeandstopcommand D22
AcknowledgeEJuploadblockcommand D21
Customisationdatacommands D13
EJoptionsandtimerscommand D22
Solicitedstatus D8
Terminalcommands D10
TMAlert D2
Transactionreply D16
Transactionrequest D3
Unsolicitedstatus D7
UploadEJdata D10
Messages
ImAlive 135
Messagesreceivedinwrongoperationalmode
Actiontaken 10104
Customisationdatacommands 10104
Terminalcommands 10106
Transactionreplycommand 10105
Modemtimers 132
Multilanguagescreens 348
Navigatingthepublication lix
NCRdocumentation,other G6
NCRXFSsimulator G6
Nestedkeyboards,notsupported 42
Nightsafe
Depositandprintfunction 1069
Nightsafedepository(solicited/unsolicitedmessage) 9102
Notemixselectionstate 2161
Operatorinterfacedisplaycharacters 315
OperatorKeyboard 414
Optionnumbers
EJoption60 1092
EJoption61 1092,1095
Enhancedconfigurationparametersloadoptions
Option0(cameracontrol) 72
Option1(ready/supply/amountbuffer) 1018
Option12(specificcommandreject) 78,1018
Option15(transactionstatusinformation) 78,1018
Option16(journalprinterbackuptime) 78,1018,1139
Option 17 (journal printer backup print operations) 78, 1018,
1139
Option2(autovoice) 77,1018
Option22(journalprinterbackuplogtamper) 999
Index-9
Index
Option23(envelopedispenserstatus) 79,9120,1018
Option24(enhancedTI/sensorstatus) 79,1018
Option25(mediaentry/exitindicatorsflashrate) 710,1018
Option27(remoterelay) 710,1018
Option3(dateformat) 77,1018
Option33(simulatesupervisormodeentry/exit) 711,1019
Option34(MCNrange) 711,1019
Option35(reportdualmodeEJ) 713,9101,1019
Option36(enhancedEJbackup) 713,1019
Option37(printtrack2tojournal) 713,1019
Option4(rollwidth) 77,1018
Option44(BNAjournalnotescount) 714
Option44(BNAjournalvaultednotescount) 1019
Option45(BNAmessagesettings) 96,9116,1019
Option45(BNAsettings) 714
Option46(MCRWECDsecurityjitter) 717,1019
Option48(barcodereader) 717,1019
Option5(leftprintcolumn) 77,1018
Option69(EMVsmartcardextendedstatus) 718,1019
Option7(track1format) 78,1018
Option70(EMVsmartcard) 1019
Option76(cashhandlers) 719,1019
Option77(Cardlesstransactionsnextstate) 1019
Option77(nextstatenumber) 1019
Option78(GBRUvariantreporting) 720
Option79(coindispenser) 721,96
Option80(alphanumericstateentry) 721
Option83(chequeprocessor) 721,1019
PAGDX 84
PANblock 117
PANDX 87
PANLN 87
PANPD 88
Paralleleject/dispenseandprint(fastcash)function 1071
PBFMT 811
PCKLN 85
PDCTB 89
PEKEY 89
PFIID 84
Physicalkeyboards 42
Picturecontrol 333
PIDDX 84
PINblocks
BANKSYS 116
ISOformat0(ANSI) 115
ISOformat3 116
PINEntry
enabledintheTstate 263
PINentry
disabledintheTstate 263
PINentrystate 212
Index-10
Index
PINDX 89
PINPD 86
PLNDX 811
PMXPN 84
POFDX 89
Powerfailure(unsolicitedmessage) 988
PPDdefaultprint
Eightcharacteramountbuffer 54
Twelvecharacteramountbuffer 55
PRCNT 88
PreDialandNormaloptionsfordialup 133
Presetoperationcodebufferstate 216
Printimmediatefunction 1069
Printstatementandsetnextstatefunction 1074
Printtrack2tojournal(option37) 1019
Printerdata
Charactersets 520
PPDdefaultprint 54
Printercontrolcharacters 56
PrintertypessupportedbyAdvanceNDC 52
Simulatedpreprintedreceiptmessages 525
PSTDX 84
Readconditionvalues 29
Ready(B) 922
Ready/supply/amountbuffer(option1) 1018
Rearsettlementrestrictions 354
Receiptprinter
firstlineposition 537
screenK01 39
topmargin 310
Receiptprinter(solicited/unsolicitedmessage) 996
Relateddocumentation
overview G1
RemotePINblock 114
Remoterelay(option27) 1018
ReportdualmodeEJ(option35) 9101,1019
Reserved 729
Reservedparameters
ConfigurationParametersLoadmessage 75
Reservedscreens
Cardholderdisplay 36
Definition 34
Extendedscreencontrols 38
Graphicpictures 38
Logos 312
Supervisormenus 312
Typesof 35
Reservedscreensdefaulttext
AAcknowledgements A3
dDiagnostic A70
EErrors A5
Index-11
Index
iBNA A88
IInformation A18
iSettlement A92
iTCP/IP A72,A75
jMisc A95
MMenus A25
PPrompts A43
SInformationlines A49
TTrace A53
UEMVSmartCard A63
Reservedtimers
EnhancedConfigurationParametersLoadmessage 729
Rollwidth(option4) 1018
RSAencryptedDESkeyformat 1129
RSAinitialkeyloading
Signatures 1121
Screens
Calculatingtouchscreenpositions 417
Customised 32
Definition 32
invalidcontrolsequenceinnamedisplay 320
Multilanguagescreens 348
Reserved 34
screenblinkingandcolourcontrol 327
Screendisplayconsiderations 352
Screen/keyboarddataloadmessage 1011
specialfeatures 320
Securekeyentry 413
SecurePINEntry
Keyboards 49
Securityfeatures
BANKSYSPINblock 117
BAPEsecurity 112
EPPsecurity 113
Journalprinterbackup 1139
Keyverificationvalues 1117
Messageauthentication 1110
Full 1112
Selective 1113
Messageauthenticationcode(MAC) 1110
RemotePINblock 114
RSAinitialkeyloadingforsignatures 1121
Selectprimarycharacterset 331
Selectsecondarycharacterset 331
Sensors(unsolicitedmessage) 9105
Setnextstateandprintfunction 1069
Signatureformat 1130
Simulatesupervisormodeentry/exit(option33) 1019
Simulatedpreprintedreceiptmessages 525
SimulatorforAPTRA G6
Smartcardhandling 121
Index-12
Index
SmartFITCheckstate 288
SMSstyledataentry 230
Solicitedstatusmessages
Encryptorinitialisationdata 976
Exits 920
Fitnessdata 948
Hardwareconfigurationdata 943
Introduction 920
Localconfigurationoptiondigits 953
Ready(B) 922
SendconfigurationID 971
Sendconfigurationinformation 930
Senddate/timeinformation 970
Sendenhancedconfigurationinformation 952
Sendsupplycounters 955
Sendtallyinformation 969
SoftwareIDandreleasenumberdata 952
Specificcommandreject 925
Statusdescriptorfield 920
Statusinformationfield 920
Suppliesdata 945
Tamperandsensorstatusdata 949
Specialfeatures
Animation 343,344
Bunchchequeamountdisplay 337
Bunchchequecodelinedisplay 337
Bunchchequeimagedisplay 335
Bunchchequevaluedisplay 338
Changingdisplayinidle 330
Displaydynamictextdictionary 339
Displayimagefilescontrol 334
Dynamictextdictionary
BunchChequeAcceptrefusereason 2122
BunchChequeAcceptrejectreason 2122
CashAcceptrefusereason 2107
Chequeacceptancestates 2133
Liftchequeimagecontrol 335
Logocontrol 333
Picturecontrol 333
Screenblinkingandcolourcontrol 327
Selectprimarycharacterset 331
Selectsecondarycharacterset 331
Setdisplaymodecontrol 332
Specificcommandreject 925
Specificcommandreject(option12) 1018
SSTtoCentraldialupmessages 134
Statenumbers 24
Statetables 22
Amountcheckstate 225
Barcodereaderstate 2168
Index-13
Index
BufferValidationstate 2144
BunchChequeAcceptstate 2117
BunchChequeHandlingstate 2124
Cameracontrolstate 254
CardreadPINentryinitiationstate 262
Cardreadstate 27
Cardwritestate 249
Cashacceptstate 296
Chequeacceptstate 2109
ChequeDetailDisplaystate 2128
Closestate 239
CustomerselectablePINstate 284
Devicefitness 267
DisplayChequeSummarystate 2134
Enhancedamountentrystate 255,257,2161
EnhancedPINentrystate 251
Envelopedispenserstate 215
ExitStates 287
ExpandedFITswitchstate 247
FDKswitchstate 275
FITswitchstate 246
FourFDKselectionstate 219
Languagecodeswitchstate 259
Languageselectfromcardstate 273
LocalCashDispense 2147
MasterExpansionstate 2116
PINentrystate 212
Presetoperationcodebufferstate 216
SmartFITCheckstate 288
Timeoutstate 2173
Transactionrequeststate 233
Typesof 23
Statetablesloadmessage 109
Statementprinter(solicited/unsolicitedmessage) 9110
Statementprintercontrols
Lines/inchcontrol 524
Margincontroluse 524
Rightmargincontrol 523
Statesandkeyboards 48
States,userwritten 21
Statusdescriptorfield 921,109610103
SupervisorandJournalMiscellaneousScreensj A95
Supervisorkeys(unsolicitedmessage) 9108
Supervisormenusreservedscreens 312
Supervisormessages
Automaticscreenediting 64
Charactersets 62
Controlcodes 62
CRTlayout 63
Index-14
Index
Introduction 14
Mediastatusmessages 64
Printerlayout 64
Screensizelimitations 63
Testcashreport 64
Supportinformation lxii
Systemsetupfordialupconnections 132
Tamperandsensorstatusdatamessage 949
Terminal
Commandformat 103,1049
Howtheterminaloperates 12
Terminalcommands
Disconnectmessage 137
NoOpmessage 138
TerminaltoCentralmessages
EJUploadmessage 981
Transactionrequestmessage 92
Unsolicitedstatusmessages 984
Timeofdayclock(unsolicitedmessage) 987
Timeoutstate 2173
TimeOutStateentry(option71) 1019
Timers
adjustingforvoiceguidance 724
reservedinEnhancedConfigurationParametersLoadmessage 729
Timer00 2173,74,724,730,1019
Timer01 74,724,1019
Timer02 28,239,37,74,725,1020,1066,1070,1071,1072
Timer03 233,74,725,1020
Timer04 2113,2173,74,1020,1066
Timer05 74,725,1020,1067,1070,1071
Timer06 74,726,1020
Timer07 74,726,1020,1067,1068,1071,1073
Timer08 2173,74,726,9103,1020,1069
Timer09 28,239,241,74,727,1020,1066,1070,1072
Timer10 74,727,1067
Timer60 982,1092
Timer61 2173,74,727
Timer63 727
Timer68 74,728,1020
Timer69 74,728
Timer72 264,265,74,728,1020
Timer77 2102,2107,74,728
Timer78 74
Timer87 2112,74,728,1020
Timer91 74,730
Timer92 74,729,1020
Timer94 243,2113,74,1021,1077,1081
Timer95 239,74,1021
Timer96 74,1021,1074
Timer97(unsupported) 74
Timersfordialup
Index-15
Index
Application 133
Modem 132
Timers,unsupported 730
TouchscreenFDKemulation
FourFDKselectionstate 219
PINentrystate 212
Timeoutstate 2175
Touchscreenkeyboards 42
FourFDKselectionfunctionstate 219
Resetconsiderations 353
Timeoutstate 2175
Unsolicitedmessage 9107
TouchscreenemulationinITRs 1086
Track1format(option7) 1018
Track1namedisplay
ABAformatcards 320
Autoselectbackwardssearch 319
Autoselectforwardssearch 320
Formats 318
ISOformatcards 319
Namedisplay 320
VISAformatcards 319
TransactionCompletionoptionindialup 136
Transactionprocessingkeyboard 410
Transactionreplycommands
Interactivetransactionresponse 1086
Transactionreplyformat 1051
Transactionreplyfunctions
BNAencash 1077
BNArefundandsetnextstate 1075
Cardbeforecash 1070
Cardbeforeparalleldispenseandprint 1072
Depositandprint 1066
Dispenseandprint 1067
Displayandprint 1068
Nightsafedepositandprint 1069
Paralleleject/dispenseandprint(fastcash) 1071
Printimmediate 1069
Printstatementandsetnextstate 1074
Printstatementandwait 1073
Setnextstateandprint 1069
Transactionrequestmessage
Format 92
Introduction 92
Transactionrequeststate 233
Index-16
Index
Transactionstatusinformation(option15) 1018
V
X
Z
Unsolicitedstatusmessages
Conditionsforsending 984
Format 985
Unsupportedparameters
ConfigurationParametersLoadmessage 75
EnhancedConfigurationParametersLoadmessage 722
Unsupportedtimers 730
UploadEJData 981
Usingthepublication lviii
Voiceguidance,adjustingtimers 724
VoiceguidedsessionsinITRs 1086
XFSSimulatorforAPTRA G6
z008InsertCardstate 2140
z010LocalCashDispensestateLocalCashDispensestate 2147
z013DataCopyandComparestate 2154
compareoperations 2157
copyoperations 2156
z014CashDepositHandlingstate 2158
Index-17
Index
Index-18
Cut
UserFeedbackForm
Title:
APTRAAdvanceNDC,ReferenceManual
Number:
B0066180P000
Release: Issue1
Date:January2013
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:
Emailsf230067@ncr.com
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

B 66180

Загружено:

Сведения о документе

Исходное описание:

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

B 66180

Загружено:

Авторское право:

Доступные форматы

APTRAAdvanceNDC

Federal Communications Commission (FCC) Radio Frequency Interference Statement

APTRA Advance NDC, Reference Manual

Federal Communications Commission (FCC) Radio Frequency Interference Statement

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC Reference Manual

Figure 412 CalculateCoordinate ..................................................420

APTRA Advance NDC Reference Manual

Figure 1122 ReplaceaCertificate ..................................................1135

APTRA Advance NDC Reference Manual

APTRA Advance NDC Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

Table 2101 ActionTakenonSelectionoftheCancelKeyforEach

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

Table 1043 ActionsforTerminalCommands ..........................10106

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

APTRA Advance NDC, Reference Manual

Advance NDCAPTRA Advance NDC, Reference Manual

Advance NDCAPTRA Advance NDC, Reference Manual

Advance NDCAPTRA Advance NDC, Reference Manual

Advance NDCAPTRA Advance NDC, Reference Manual

Advance NDCAPTRA Advance NDC, Reference Manual