CHEC68ProgrammingGuide.pdf

CHEC68ProgrammingGuide.pdf - Toshiba Global Commerce...

This preview shows page 1 out of 452 pages.

Unformatted text preview: Toshiba Global Commerce Solutions Checkout Environment for Consumer-Service Programming Guide Version 6.8.3 TC62-0011-03 1 Note: Before using this information and the product it supports, be sure to read Safety Information- Read This First, Warranty Information, Uninterruptible Power Supply Information and the information under Notices. December 2017 This edition applies to the Toshiba Checkout Environment for Consumer-Service Version 6 Release 8 Modification 3, and to all subsequent releases and modifications until otherwise indicated in new editions. This edition replaces the Toshiba Checkout Environment for Consumer-Service Programming Guide, Version 6 Release 8, TC62-0011-02. If you send information to Toshiba Global Commerce Solutions (Toshiba), you grant Toshiba a nonexclusive right to use or distribute whatever information you supply in any way it believes appropriate without incurring any obligation to you. © Copyright Toshiba Global Commerce Solutions, Inc. 2011, 2017 Contents Figures.......................................................9 Tables.......................................................13 Safety........................................................................................ 15 About this guide.....................................................................17 Who should read this guide.................................................. 17 Where to find more information...........................................17 Related publications............................................................... 17 Notice statements....................................................................18 Summary of Changes............................................................ 19 TC62-0010-03............................................................................19 TC62-0010-02............................................................................19 TC62-0011-01............................................................................19 TC62-0011-00............................................................................19 June 2014 (G362-0623-01)....................................................... 19 March 2014 (G362-0623-00)....................................................20 June 2012 (G362-0582-01)....................................................... 20 Part I. Overview section........................ 21 Chapter 1. System overview..................23 Lane components.................................................................... 24 BOSS components................................................................... 25 Additional components..........................................................25 Toshiba Store Integrator (SI)........................................... 25 Toshiba Remote Management Agent ........................... 25 IBM Systems Director...................................................... 26 IBM DB2 Universal Database......................................... 27 IBM WebSphere Application Server..............................27 JavaPOS..............................................................................27 ActiveSync......................................................................... 28 CHEC on Microsoft Windows........................................28 CHEC on 4690...................................................................28 Chapter 2. Solution architecture overview.................................................. 29 Lane solution stack................................................................. 29 Lane architecture.....................................................................30 External Interfaces............................................................31 Roles of Lane components.............................................. 32 Lane data flow.................................................................. 35 BOSS solution stack................................................................ 41 BOSS architecture....................................................................43 BOSS external interfaces..................................................43 Boss internal interfaces.................................................... 44 Roles of the BOSS components.......................................44 BOSS data flow................................................................. 45 Mobile Terminal architecture................................................ 47 © Copyright Toshiba Global Commerce Solutions, Inc. 2011, 2017 Chapter 3. Framework architecture...... 49 Basic framework components............................................... 50 Base classes...............................................................................50 FrameworkBase................................................................ 50 ThreadBase........................................................................ 51 FrameworkDataContainer.............................................. 52 FrameworkDeviceBase.................................................... 52 StateWorkerBase............................................................... 52 CommHandlerBase.......................................................... 52 CommTransformerBase...................................................53 EventPacket....................................................................... 53 XMLDataWrapper............................................................ 53 ParameterList.................................................................... 53 Key framework objects...........................................................53 CaptureThread..................................................................53 SystemsManagementThread.......................................... 54 TimerThread..................................................................... 54 DBInterfaceThread........................................................... 54 FrameworkLoader............................................................54 ObjectManagerThread..................................................... 55 CommThread.................................................................... 55 DeviceThread.................................................................... 55 StateProcessingClient.......................................................55 Framework application load order.......................................55 Load Options.....................................................................55 Load Self Checkout Config............................................. 56 Load Factory Config........................................................ 56 Load Threads.................................................................... 56 Start threads...................................................................... 57 Application data......................................................................57 CHEC state table overview....................................................58 State machine basics.........................................................59 CHEC framework state engine.......................................60 State programming overview................................................64 State programming reference................................................67 State engine processing example................................... 67 Extensibility............................................................................. 68 Organize by features........................................................70 Configuration....................................................................74 Structural configuration settings....................................74 Structural merge rules..................................................... 77 Important note.................................................................. 78 Structural merge rules (example)...................................78 Typical structural configs................................................ 80 Adding a new structural config..................................... 80 Extending the schema or usage of an existing structural config................................................................81 Summary........................................................................... 81 Referring to behavioral configs through structural configs.............................................................. 81 State table extensibility.................................................... 81 Extending BOSS and lane configurations............................89 3 Constraints ....................................................................... 89 Option Data Validation Responses................................ 93 Configuration utilities resource path ........................... 93 Structural configurations....................................................... 94 Capture configuration..................................................... 94 Barcode data identifier.....................................................96 Comm configuration........................................................98 Cash devices....................................................................101 LoadConfig......................................................................103 DBConfig......................................................................... 104 DBManagerThreadConfig.............................................105 DeviceConfig...................................................................106 DBStorageListConfig..................................................... 107 FactoryConfig..................................................................107 AudioLookupConfig......................................................108 TranslationConfig...........................................................110 StructureConfig.............................................................. 111 Chapter 4. SI GUI architecture and Self Checkout specific design............. 115 SI GUI extension overview.................................................. 118 Java classpath.................................................................. 118 File chaining.................................................................... 119 Property file chaining example.................................... 119 XML file chaining example........................................... 120 Business Partner extension model............................... 121 Business Partner JAR files............................................. 121 Handling new XML for the lane......................................... 121 Defining new lane XML................................................ 121 Parsing the XML............................................................. 122 Define the XML mapping..............................................122 Define tractions and conditional actions........................... 123 Conditional action.......................................................... 123 Traction............................................................................ 123 Chapter 5. POSBC details and implementations................................... 125 Toshiba POSBC architecture................................................125 Non-Toshiba Java POSBC architecture.............................. 126 Non-Java POSBC architecture.............................................126 POSBC requests.....................................................................127 Requests - control........................................................... 128 Requests - sales-related..................................................128 Requests - logical receipt............................................... 129 Requests - logical printer...............................................130 Requests - miscellaneous...............................................131 POSBC callbacks....................................................................131 POSBC events........................................................................ 132 Providing a Java-based POS integration........................... 132 Providing an XML-Based POS integration........................133 Sample request/response sequence with events........ 134 Extending POSBC Messages.........................................136 Chapter 6. RMA and BOSS details...... 137 General RMA/RES CHEC JMX UI architecture................137 4 Programming Guide RMA extension model..........................................................137 JMX notifications and IBM Systems Director events....... 139 Event qualifiers............................................................... 141 Modifying BOSS extract contents................................ 143 Modifying Lane extract contents..................................144 General BOSS architecture...................................................144 High level system model..................................................... 144 BOSS applications................................................................. 146 Completing a new language translation for the BOSS................................................................................. 147 BOSS database tables............................................................147 BOSS store procedures.................................................. 147 Chapter 7. Lane application details.... 149 Five main state machine implementations........................151 UI Manager......................................................................151 Control............................................................................. 151 Closed...............................................................................151 Item purchase..................................................................151 POS interface...................................................................152 Table interaction............................................................. 152 Application data flow.................................................... 152 Control state machine...........................................................154 Initiate and monitor item purchase............................. 154 Item purchase item process.......................................... 155 Request final total...........................................................156 Add tender to transaction............................................. 156 POS receipts.................................................................... 156 Transaction recovery...................................................... 157 Data containers for control............................................157 POS callBacks.................................................................. 158 Extensibility of control state table................................158 Item purchase........................................................................ 158 Item Purchase Configuration Details.......................... 160 POS data required.......................................................... 162 Data containers for item purchase............................... 163 Extensibility for item purchase state table..................163 POS interface..........................................................................163 POS requests and responses......................................... 164 POS event data................................................................164 Callback request............................................................. 164 Extensibility.....................................................................164 UI Manager............................................................................ 164 UI Manager devices....................................................... 164 UIManager tasks.............................................................166 Pending Action Properties............................................ 171 Pending Action Support functions.............................. 171 Data Containers.............................................................. 172 UI Manager extensibility............................................... 173 Chapter 8. Device implementation...... 175 Device control messages...................................................... 180 Incoming messages (received by the device class).... 180 Outgoing messages (sent by the device class)........... 181 Message packet data.............................................................182 Device implementations...................................................... 183 Scanner/scale device............................................................. 183 Device architecture.........................................................183 Logical devices................................................................183 Unique message implementations...............................183 Incoming messages........................................................ 183 Outgoing messages........................................................ 184 Message packet data...................................................... 185 Special feature.................................................................186 Item security (item handler) device....................................186 Device architecture.........................................................186 Logical devices................................................................187 Unique message implementations...............................187 Incoming messages........................................................ 188 Outgoing messages........................................................ 190 Message packet data...................................................... 191 Item security control commands..................................192 Data Packet Contents..................................................... 196 Audio device..........................................................................197 Device Architecture........................................................198 Device Messages.............................................................199 Commands Overview....................................................200 PlayAudio Command....................................................201 StopByPriority Command.............................................201 StopByGroup Command...............................................201 ProcessAudioEvent Command.................................... 202 Standard phrases............................................................ 204 Signature capture device......................................................204 Logical devices................................................................204 Incoming message packet IDs...................................... 205 Outgoing message packet IDs...................................... 205 Data packet contents...................................................... 206 Cash hardware devices........................................................ 206 Device architecture.........................................................206 Logical devices................................................................208 Incoming Messages........................................................ 209 Outgoing message packet ID's..................................... 210 Cash device status detail............................................... 211 Cash device control commands................................... 211 Cash device response messages................................... 213 Message flow/interaction.............................................. 215 AnyPlace Checkout...............................................................218 Design criteria for devices.............................................219 Supported devices ......................................................... 219 Configurations................................................................ 220 Starting the Java Devices Server...................................221 Java devices communi...
View Full Document

  • Summer '17
  • Michael Hart
  • boss, Bankruptcy in the United States, NCR Corporation, Vermiform appendix

{[ snackBarMessage ]}

What students are saying

  • Left Quote Icon

    As a current student on this bumpy collegiate pathway, I stumbled upon Course Hero, where I can find study resources for nearly all my courses, get online help from tutors 24/7, and even share my old projects, papers, and lecture notes with other students.

    Student Picture

    Kiran Temple University Fox School of Business ‘17, Course Hero Intern

  • Left Quote Icon

    I cannot even describe how much Course Hero helped me this summer. It’s truly become something I can always rely on and help me. In the end, I was not only able to survive summer classes, but I was able to thrive thanks to Course Hero.

    Student Picture

    Dana University of Pennsylvania ‘17, Course Hero Intern

  • Left Quote Icon

    The ability to access any university’s resources through Course Hero proved invaluable in my case. I was behind on Tulane coursework and actually used UCLA’s materials to help me move forward and get everything together on time.

    Student Picture

    Jill Tulane University ‘16, Course Hero Intern