Symbol Technologies CST3040K088R1 Handheld Portable Shopping System Transmitter User Manual Revision History

Symbol Technologies Inc Handheld Portable Shopping System Transmitter Revision History

Contents

WaveWorks PSS Integration Guide V110

WaveWorksPortable Shopping SystemIntegration GuideFebruary 1, 2000Version 1.10Integration Services GroupPittsburgh, PennsylvaniaUSA
DecembeRevision HistoryRevision Date Author Comments1.00 December 31, 1999 Mary WroniakGarry SimmonsBrian ReedTom PikeMike TierneyLuke PetrozzaInitial version1.10 February, 1, 2000 Luke Petrozza Added PST 008 and PST 038transactionsCopyright  1999, 2000 by Symbol Technologies, Inc. All rights reserved.No part of this document may be reproduced or used in any form, or by any electrical or mechanical means, withoutpermission in writing from Symbol. This includes electronic or mechanical means, such as photocopying,recording, or information storage and retrieval systems The material in this document is subject to change withnotice.Symbol does not assume any product liability arising out of, or in connection with, the application or use of anyproduct, circuit, or application described herein.No license is granted, either expressly or by implication, estoppel, or otherwise under any Symbol Technologies,Inc., intellectual property rights. An implied license only exists for equipment, circuits, and subsystems contained inSymbol products.Symbol, Spectrum24, WaveWorks, and WaveWorks NT are registered trademarks of Symbol Technologies, Inc.Other product names mentioned in this document may be trademarks or registered trademarks of their respectivecompanies and are hereby acknowledged.
WaveWorks PSS, Integration Guide, 1.10 Page ii© 2000, Symbol Technologies, Inc. February 1, 2000Table of Contents1. Introduction ............................................................................................................11.1 PURPOSE OF DOCUMENT ................................................................................................................................. 11.2 ASSUMPTIONS ................................................................................................................................................. 11.3 REFERENCE DOCUMENTS ................................................................................................................................12. Architecture Overview ...........................................................................................22.1 INTRODUCTION TO WAVEWORKS.................................................................................................................... 22.1.1 WaveWorks Design Objectives.............................................................................................................. 32.1.2 WaveWorks Components....................................................................................................................... 42.2 PSS SOFTWARE OVERVIEW............................................................................................................................. 62.3 MAJOR SUBSYSTEMS....................................................................................................................................... 62.3.1 Unit Management Subsystem ................................................................................................................ 62.3.2 Shopping Trip Subsystem ..................................................................................................................... 62.3.3 Quick Order Subsystem......................................................................................................................... 72.3.4 Queue Busting Subsystem...................................................................................................................... 72.3.5 Express Shopper Subsystem .................................................................................................................. 72.3.6 Electronic Marketing Subsystem........................................................................................................... 72.3.7 User Messaging..................................................................................................................................... 82.3.8 Transaction Ticket Printing .................................................................................................................. 82.3.9 POS Interface........................................................................................................................................ 82.3.10 System Administration........................................................................................................................... 82.4 PSS OVERVIEW DIAGRAM .............................................................................................................................. 82.5 PSS COMPONENT DIAGRAM.......................................................................................................................... 103. Hardware Requirements ......................................................................................113.1 WINDOWS NT COMPUTER............................................................................................................................. 113.2 HAND HELD TERMINALS ............................................................................................................................... 113.3 TERMINAL DISPENSER/ENTRANCE UNIT ....................................................................................................... 123.4 SPECTRUM 24 RADIO NETWORK................................................................................................................ 124. PSS Software Installation....................................................................................134.1 INSTALL NT 4.0 SERVER............................................................................................................................... 144.2 INSTALL THE NT 4 SERVICE PACK ................................................................................................................ 194.3 INSTALL INTERNET EXPLORER 4.01 SERVICE PACK 2 ................................................................................... 204.4 NT OPTION PACK INSTALL............................................................................................................................ 224.5 INSTALL THE VIDEO DRIVER ......................................................................................................................... 234.6 CREATE AND FORMAT THE DATABASE PARTITION ........................................................................................ 254.7 DESKTOP CLEANUP (OPTIONAL) .................................................................................................................... 264.8 INSTALL MICROSOFT SQL SERVER 7 ............................................................................................................ 274.9 CREATE AND CONFIGURE THE PSS DATABASE ............................................................................................. 284.9.1 Create the (blank) PSS Database........................................................................................................ 284.9.2 Configure SQL Server......................................................................................................................... 294.9.3 Configure the Clear Transaction Log job........................................................................................... 304.9.4 Configure the Extensive Database Check and Backup job ................................................................. 314.9.5 Configure the Nightly Database Check and Backup job..................................................................... 334.10 INSTALL MICROSOFT ACCESS................................................................................................................... 354.11 INTERNET EXPLORER 5.0 WITH TASK SCHEDULER INSTALL ..................................................................... 354.12 INSTALL WAVEWORKS............................................................................................................................. 364.13 INSTALL PSS RUNTIME SYSTEM............................................................................................................... 374.14 INSTALL WAVEWORKS DEVELOPMENT STUDIO........................................................................................ 384.15 INSTALL PSS DEVELOPMENT SYSTEM...................................................................................................... 384.16 TFTP CONFIGURATION ............................................................................................................................ 394.16.1 Create STEP hex images for the terminals to download..................................................................... 404.17 DHCP CONFIGURATION ........................................................................................................................... 414.18 CREATE AN ODBC DATA SOURCE ........................................................................................................... 42
WaveWorks PSS, Integration Guide, 1.10 Page iii© 2000, Symbol Technologies, Inc. February 1, 20004.19 LOAD INITIAL DATA ................................................................................................................................. 434.20 MS IIS CONFIGURATION .......................................................................................................................... 454.21 OBTAINING ACCESS TO PSS SYSTEM ADMINISTRATION SCREENS ........................................................... 464.22 CONFIGURE TASK SCHEDULER ................................................................................................................. 474.23 CONFIGURE UNIT MANAGEMENT ............................................................................................................. 484.24 CONFIGURE LICENSING............................................................................................................................. 504.25 CONFIGURE THE NBQMAIN SERVICE (IBM 4690 POS ONLY)............................................................... 514.26 SETUP NT SYSTEM LOG ........................................................................................................................... 525. Configuration of the PSS System .......................................................................535.1 SET UP SYSTEM SETTING CONSTANTS .......................................................................................................... 535.2 PERFORM INITIAL LOADING OF CUSTOMER AND ITEM DATA ........................................................................ 566. Validation of System Operation ..........................................................................576.1 TESTING AN INSTALLATION........................................................................................................................... 576.2 OBTAINING SYSTEM STATUS INFORMATION.................................................................................................. 586.2.1 Viewing The System Log ..................................................................................................................... 586.2.2 Viewing POS Status............................................................................................................................. 597. Directory Listing of PSS Folders/Files ...............................................................60D:\ (database repository) ............................................................................................................................... 667.1 SCHEDULED TASKS ....................................................................................................................................... 678. Software Description ...........................................................................................688.1 PSS TRANSACTION IDS / COM OBJECT METHOD LISTING........................................................................... 688.2 UNIT MANAGEMENT SUBSYSTEM.................................................................................................................. 768.2.1 Hardware Overview............................................................................................................................ 768.2.2 Software Components.......................................................................................................................... 778.2.3 Database Access.................................................................................................................................. 788.3 SHOPPING TRIP SUBSYSTEM .......................................................................................................................... 798.3.1 Start of Shopping Trip Processing ...................................................................................................... 798.3.2 Shopping Trip Processing................................................................................................................... 798.3.3 End of Shopping Trip Processing........................................................................................................ 828.3.4 Shopping Trip Message Log Entries................................................................................................... 838.3.5 Fatal Messages: .................................................................................................................................. 848.3.6 Error Messages:.................................................................................................................................. 848.3.7 Informational Messages...................................................................................................................... 868.3.8 Debug Messages: ................................................................................................................................ 878.3.9 Rescan Messages................................................................................................................................. 878.4 QUICK ORDER SUBSYSTEM ........................................................................................................................... 898.5 QUEUE BUSTING SUBSYSTEM........................................................................................................................ 898.6 ELECTRONIC MARKETING SUBSYSTEM ......................................................................................................... 908.7 USER MESSAGING SUBSYSTEM ..................................................................................................................... 908.8 POS INTERFACE SUBSYSTEM ........................................................................................................................ 918.8.1 POS Interface Files............................................................................................................................. 928.8.2 POS Interface Software Entities.......................................................................................................... 928.8.3 POS Interface Configuration .............................................................................................................. 948.8.4 PSSTransactionFile Processing.......................................................................................................... 998.8.5 POS Transaction File Processing..................................................................................................... 1008.8.6 Item Record File Processing............................................................................................................. 1018.8.7 Customer Update File Processing ................................................................................................... 1028.9 PSS SERVICES............................................................................................................................................. 1029. Customizing the PSS System Software............................................................1049.1 CUSTOM DISPLAYSERVER SCRIPTS ............................................................................................................. 1049.2 CUSTOM SERVICES ...................................................................................................................................... 1049.3 CUSTOM BUSINESS OBJECTS ....................................................................................................................... 1049.4 USER EXIT DLL .......................................................................................................................................... 1059.4.1 Common Information ........................................................................................................................ 1059.4.2 Return and Message Codes............................................................................................................... 106
WaveWorks PSS, Integration Guide, 1.10 Page iv© 2000, Symbol Technologies, Inc. February 1, 20009.4.3 Using the CPssMsgLog Class ........................................................................................................... 1069.5 AVAILABLE USER EXIT FUNCTIONS ............................................................................................................ 1089.5.1 UE_PreProcessItemFile.................................................................................................................... 1089.5.2 UE_PreProcessItemRecord .............................................................................................................. 1089.5.3 UE_PostProcessItemRecord ............................................................................................................. 1099.5.4 UE_PostProcessItemFile .................................................................................................................. 1099.5.5 UE_PreProcessTaxFile..................................................................................................................... 1099.5.6 UE_PostProcessTaxFile ................................................................................................................... 1109.5.7 UE_PreProcessPOSTransFile.......................................................................................................... 1109.5.8 UE_PreProcessPOSTransRecord..................................................................................................... 1109.5.9 UE_PostProcessPOSTransRecord.................................................................................................... 1119.5.10 UE_ProcessEODRecord................................................................................................................... 1119.5.11 UE_PostProcessPOSTransFile......................................................................................................... 1119.5.12 UE_PreProcessPSSTransFile........................................................................................................... 1119.5.13 UE_PreProcessPSSTransRecord...................................................................................................... 1129.5.14 UE_PostProcessPSSTransFile.......................................................................................................... 1129.5.15 UE_CalculateItemPrice_Method10to20........................................................................................... 1129.5.16 UE_RescanLevelCalculation ............................................................................................................ 1129.5.17 UE_Pre-RescanDetermination.......................................................................................................... 1129.5.18 UE_PostRescanDetermination.......................................................................................................... 1139.5.19 UE_PreProcessMarketingMessage................................................................................................... 1139.5.20 UE_LoginAuthorization .................................................................................................................... 11310. System Administration Interface ......................................................................11410.1 CONFIGURING THE BROWSER SOFTWARE............................................................................................... 11410.2 ESTABLISH USER ACCOUNTS ON THE SERVICE TERMINAL ..................................................................... 11410.3 UNDERSTANDING USER ACCESS TO ADMINISTRATIVE PAGES AND ACTIONS ......................................... 11510.4 CHANGING SCREEN TEXT ON THE SERVICE TERMINAL........................................................................... 11610.4.1 Service Terminal System Settings...................................................................................................... 11711. Specific Features................................................................................................12011.1 MULTIPLE LANGUAGE SUPPORT............................................................................................................. 12011.2 PRICING METHODS ................................................................................................................................. 12011.3 CURRENCY CONVERSIONS...................................................................................................................... 12011.4 CONTROL TICKET PRINTING ................................................................................................................... 120Appendix A Database Layout Diagram...................................................................121Appendix B Database Tables / Physical Properties ..............................................125B.1 TABLE NAME: PSS_ADMIN_ACTION .......................................................................................................... 125B.2 TABLE NAME: PSS_ADMIN_MENU............................................................................................................. 125B.3 TABLE NAME: PSS_ADMIN_PAGE.............................................................................................................. 126B.4 TABLE NAME: PSS_ADMIN_USER.............................................................................................................. 126B.5 TABLE NAME: PSS_BARCODE_VARIABLE_WEIGHT .................................................................................. 127B.6 TABLE NAME: PSS_CURRENCY .................................................................................................................. 128B.7 TABLE NAME: PSS_CUSTOMER .................................................................................................................. 128B.8 TABLE NAME: PSS_CUSTOMER_MESSAGE................................................................................................. 130B.9 TABLE NAME: PSS_CUSTOMER_SUSPEND_REASON .................................................................................. 130B.10 TABLE NAME: PSS_DEPARTMENT ......................................................................................................... 131B.11 TABLE NAME: PSS_EOD....................................................................................................................... 131B.12 TABLE NAME: PSS_ITEM ....................................................................................................................... 132B.13 TABLE NAME: PSS_LANGUAGE ............................................................................................................. 133B.14 TABLE NAME: PSS_MANUFACTURER .................................................................................................... 133B.15 TABLE NAME: PSS_MARKETING_DEPARTMENT.................................................................................... 133B.16 TABLE NAME: PSS_MARKETING_ITEM ................................................................................................. 134B.17 TABLE NAME: PSS_MARKETING_MFG.................................................................................................. 134B.18 TABLE NAME: PSS_MARKETING_SENT ................................................................................................. 135B.19 TABLE NAME: PSS_MESSAGE_LOG....................................................................................................... 135B.20 TABLE NAME: PSS_OPENING_MESSAGE ............................................................................................... 136
WaveWorks PSS, Integration Guide, 1.10 Page v© 2000, Symbol Technologies, Inc. February 1, 2000B.21 TABLE NAME: PSS_ORDER_LIST........................................................................................................... 136B.22 TABLE NAME: PSS_ORDER_LIST_ITEM................................................................................................. 136B.23 TABLE NAME: PSS_ORDER_STATUS ..................................................................................................... 137B.24 TABLE NAME: PSS_POS_STATUS.......................................................................................................... 137B.25 TABLE NAME: PSS_RESCAN_DIFFERENCE ............................................................................................ 138B.26 TABLE NAME: PSS_RESCAN_LEVEL...................................................................................................... 138B.27 TABLE NAME: PSS_SESSION.................................................................................................................. 139B.28 TABLE NAME: PSS_SHOPPING_ACTIVITY.............................................................................................. 139B.29 TABLE NAME: PSS_SHOPPING_HISTORY_ACTIVITY ............................................................................. 140B.30 TABLE NAME: PSS_SHOPPING_HISTORY_ITEM ..................................................................................... 141B.31 TABLE NAME: PSS_SHOPPING_HISTORY_LIST...................................................................................... 142B.32 TABLE NAME: PSS_SHOPPING_HISTORY_RESCAN................................................................................ 143B.33 TABLE NAME: PSS_SHOPPING_INCOMPLETE_LIST................................................................................ 143B.34 TABLE NAME: PSS_SHOPPING_ITEM ..................................................................................................... 145B.35 TABLE NAME: PSS_SHOPPING_LIST ...................................................................................................... 146B.36 TABLE NAME: PSS_SHOPPING_LIST_STATUS........................................................................................ 146B.37 TABLE NAME: PSS_SHOPPING_TAX ...................................................................................................... 147B.38 TABLE NAME: PSS_SPECIAL_BARCODE ................................................................................................ 147B.39 TABLE NAME: PSS_SYSTEM_MESSAGE................................................................................................. 148B.40 TABLE NAME: PSS_SYSTEM_SETTING................................................................................................... 149B.41 TABLE NAME: PSS_TAX_TABLE ........................................................................................................... 149B.42 TABLE NAME: PSS_TAX_TABLE_ENTRY .............................................................................................. 150B.43 TABLE NAME: PSS_TEXT....................................................................................................................... 150B.44 TABLE NAME: PSS_UNKNOWN_ITEM.................................................................................................... 150B.45 TABLE NAME: UMS_CARD_READER_TYPE .......................................................................................... 151B.46 TABLE NAME: UMS_CRADLE................................................................................................................ 152B.47 TABLE NAME: UMS_DISPENSER............................................................................................................ 152B.48 TABLE NAME: UMS_ENTRANCE............................................................................................................ 153B.49 TABLE NAME: UMS_POWER.................................................................................................................. 154B.50 TABLE NAME: UMS_PRINTER................................................................................................................ 155B.51 TABLE NAME: UMS_STATUS_CODES.................................................................................................... 156B.52 TABLE NAME: UMS_TERMINAL ............................................................................................................ 156B.53 TABLE NAME: UMS_TERMINAL_TYPES ................................................................................................ 157Appendix C Price Calculation Algorithms..............................................................158C.1 PRICING METHODS ...................................................................................................................................... 158C.2 SPLIT PACKAGE PRICING............................................................................................................................. 159C.3 UNIT PRICING.............................................................................................................................................. 159Unit Pricing Example........................................................................................................................... 161C.4 BASE PLUS ONE PRICING............................................................................................................................. 161C.5 GROUP THRESHOLD PRICING....................................................................................................................... 162Group Threshold Pricing Example................................................................................................ 164C.6 GROUP ADJUSTED PRICING ......................................................................................................................... 166C.7 UNIT ADJUSTED PRICING............................................................................................................................. 167Unit Adjusted Threshold Pricing Example 2............................................................................ 169C.8 MIX AND MATCH GROUPINGS ..................................................................................................................... 169C.9 PRICING METHOD APPLICATION RULES ...................................................................................................... 169C.10 ROUNDING METHODS ............................................................................................................................. 170Appendix D POS Interface File Descriptions .........................................................171D.1 PSS TRANSACTION FILE.............................................................................................................................. 172D.2 POS TRANSACTION FILE ............................................................................................................................. 174D.3 ITEM RECORD FILE ...................................................................................................................................... 176D.4 TAX TABLE FILE.......................................................................................................................................... 177D.5 CUSTOMER INFORMATION FILE ................................................................................................................... 178
Introduction______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 1© 2000, Symbol Technologies, Inc. February 1, 20001. Introduction1.1 Purpose of DocumentThis document is an aid to be used in the configuration, customization and installation of theWaveWorks Portable Shopping System (PSS).1.2 AssumptionsThis document assumes that the reader is familiar with the functionality of Symbol’sWaveWorks architecture, the WaveWorks Client, and the Server Enabler. In addition, the readershould be familiar with the Windows NT Operating System, and third-party “browser” software.1.3 Reference Documents• Portable Shopping System Functional Specification• Portable Shopping System Design Document• Portable Shopping System Users Reference Guide• ScreenMaker Users Reference Guide
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 2© 2000, Symbol Technologies, Inc. February 1, 20002. Architecture OverviewThe Portable Shopping System utilizes Symbol Technologies’ proprietary WaveWorks three-tiered architecture, which provides clear separation of the user interface, business logic anddatabase portions of the system. For the PSS, WaveWorks provides application messagingfunctions and manages distributed objects on the Microsoft Windows NT platform.2.1 Introduction to WaveWorksWaveWorks is a light weight, high performance, three-tiered, application messaging anddistributed object management architecture which is designed to run on the Windows NT systemplatform. As a horizontal system component, WaveWorks can serve as the backbonearchitecture for a wide variety of multitiered client/server applications.The WaveWorks system provides the following application services:• Thin client radio terminal environment (reduces system administration costs)• Radio Terminal display and client state management• Client-to-Server and Client-to-Client messaging service• Business Service object broker• Configurable Business Servers• Distributed business service objects• Load-based object instancing• Load balancing• Service based instancing• DBMS connection sharing• Client specific object instancing• Web-based system administration.• Application user password validation and security service
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 3© 2000, Symbol Technologies, Inc. February 1, 20002.1.1 WaveWorks Design ObjectivesThree-tiered ArchitectureWaveWorks provides a platform for implementing applications thatmaintain a clear separation between the user interface, business logic, and database layers.Light WeightWaveWorks is designed to run on P200 systems or better.AdaptableCOM object-based design allows easy addition of new business service objects tosupport new applications. The encapsulation of data access inside business objects makes it easyto change data sources in the future, without rewriting the entire application.Business Object ReuseCOM object-based design allows easy reuse of existing business serviceobjects to support new applications.ScaleableA distributed-object architecture makes it easy to add additional business servicecapacity, based on changing business demands.DistributedWaveWorks system components are designed so they can be deployed across LANor WAN networks. Network utilization can be optimized by placing the WaveWorks BusinessServer components near or on the DBMS server, while running the Display Server / MessageServer components near or on the client connection point server.High PerformanceMultithreaded business service execution, avoidance of persistent messagequeues, event driven implementation (no polling), and automatic load balancing permit messagerates of up to 500 per second (on a single system configuration).ReliableWaveWorks supports the ability to configure multiply redundant parallel BusinessServer components. In addition to load sharing, the redundant servers will automatically hot-swap / load-shift to the remaining servers if one or more server systems suffer a complete orpartial failure.Platform IndependenceDependency on NT specific features are minimal and are internallywell isolated.Minimum Dependency on Third-party ComponentsTo improve platform portability and reducelicensing costs, WaveWorks depends on only generally available add-on components, such as: anODBC compliant DBMS, Winsock 1.1, an http server, and a third-generation (or better) Webbrowser. A suitable version of all of these components is included with NT 4.0 server.
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 4© 2000, Symbol Technologies, Inc. February 1, 20002.1.2 WaveWorks ComponentsThe WaveWorks components are shown in the following diagram and described below.Display ServerManages the user interface and screen flow for radio-based, thin clientapplications. Maintains client data variables to record the state of the client application. Invokesbusiness services via WaveWorks messages.Message ServerProvides light weight message routing and load balancing services betweenthe various WaveWorks system components. Supports Command / Response stylecommunication for the execution of business services, and unsolicited client-to-client messaging.Business Server (Object Broker)Manages the creation, destruction, and invocation of COM-based business service objects. Automatically creates and destroys object instances based onsystem demand. Permits sharing of database connections by multiple clients. The WaveWorksarchitecture supports multiple Business Servers, running on either local or remote systems.Business Logic TierUser Interface TierData Access TierBusiness Logic TierBusiness Logic TierThinRadioClientsWaveWorks Message ServerWaveWorksRadio DisplayServersODBC (or other)Application DataSourcesWaveWorksBusiness ObjectServers?Desktop GUIClients ThinRadioClientsThinRadioClientsThinRadioClientsWeb Clients(CGI)Symbol EnablerWaveWorksConfigSpectrum 24 NetworkEthernetDBMS Device Drivers POS APIWaveWorksBusiness ObjectServersWANBusinessServiceObjectsWaveWorksBusiness ObjectServersDesktop GUIClientsWeb Clients(CGI)BusinessServiceObjectsBusinessServiceObjectsWaveWorks Message (TCP)COMAPI / Other
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 5© 2000, Symbol Technologies, Inc. February 1, 2000WaveWorks MessagesThe WaveWorks messaging service uses a common message formatfor all WaveWorks messages. This format contains a fixed header, followed by zero or moreapplication dependent data fields. TCP is used as the transport protocol for all WaveWorksmessages. This permits the business logic tier to reside on a remote system, if desired. Themessages form the "glue" that cements the client interface tier of the application to the businesslogic tier. The messaging service can also be used to implement direct "client-to-client"messaging.Business Service ObjectsContain the vertical business application logic, implemented asMicrosoft COM automation server objects. The term "Service Object" is used to describe theCOM interface subset to which all WaveWorks-managed objects must adhere.Transaction ModelWaveWorks uses a transaction Id scheme to provide namespace servicesfor purposes of automatically routing request messages to a capable Business Server forexecution.Development Tools (Optional Component)An application interface development tool (ScreenMaker) supports rapid development of thin client radio applications. A radio terminal simulationtool (Screen Runner) permits testing of Screen Maker applications without the need for an actualradio network. A WaveWorks C++ foundation class library is also available, which includesclasses that support ODBC data access, WaveWorks messaging, INI file access, Date / Timemanipulation,and more.
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 6© 2000, Symbol Technologies, Inc. February 1, 20002.2 PSS Software OverviewBuilt upon the WaveWorks core software, the PSS software consists of• COM Objects• NT Services• Display Server Scripts• DatabaseThe COM Objects and NT Services perform the business logic. That is, they are responsible forthe data manipulation and system sequencing that makes the system a portable shopping system.The methods contained in the COM Objects and the NT Services are invoked via WaveWorkstransactions. The COM Objects are dynamically created and deleted by the Business Server. TheNT Services are started at system startup and remain resident in the system.The Display Server scripts provide the user interface mechanism for the hand held terminals andentrance units. The scripts define the screen layout and provide the handling of user actions forthose devices. When necessary, the scripts invoke business methods via WaveWorkstransactions.The database contains all of the persistent data of the system. The database is used to store allinformation about the devices, shoppers, items, and system configuration as required.2.3 Major Subsystems2.3.1 Unit Management SubsystemThe Unit Management Subsystem (UMS) manages the Symbol hardware devices that comprisethe PSS system. Those devices include hand held terminals, cradles, entrance unit devices, ticketprinters, and power supplies. UMS ensures that the devices work in concert with one another toprovide a seamless integrated system.2.3.2 Shopping Trip SubsystemOnce the shopper retrieves the proper hand held terminal from the dispenser, the Shopping Tripapplication allows the shopper to add and delete items from their basket and view the “totals”information for their current shopping trip. Shopping trips can be ended by returning the handheld terminal to an empty dispenser slot or by scanning an “End of Trip” barcode. Each activityduring the shopping trip is logged and available for review from the Service Terminal.
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 7© 2000, Symbol Technologies, Inc. February 1, 20002.3.3 Quick Order SubsystemWhile shopping, a user may choose to place a quick order through the optional Quick Ordersubsystem provided. The shopper identifies, through the quick order mechanism, the productsand the quantities/weights of those products they wish to order. The quick order can then be sentto the appropriate department, where a web screen displays to store personnel the orders placedby shoppers. After they have finished processing the order, store personnel can send a messageto the shopper that their order is ready to be picked up.2.3.4 Queue Busting SubsystemThe Queue Busting subsystem allows the PSS System to be used in a slightly different mannerthan normal, but also helps retailers and shoppers reduce the amount of checkout time. Anyhand held terminal which has been released can be used for queue busting. This is normallydone by store personnel to alleviate long checkout lines which may have formed.Transactions in this mode are initiated by scanning a special (configurable) barcode. More thanone barcode can be configured for use in this manner. This barcode is expected to be on a plastictoken. Once the special barcode has been scanned, the items in the customer basket are scanned.A PSS transaction is created in the same manner as a normal PSS transaction. After all items inthe basket have been scanned, the special barcode, which began this mode, is scanned again.This transaction is sent to the POS System. The plastic token containing the barcode is thenhanded to the customer with instructions to give it to the cashier at the checkout register. Whenthe customer reaches the register, they present the token and their loyalty card (if used) to thecashier who then performs a standard non-audit self scan checkout. After the customer checksout, the token can be re-used for other customers.2.3.5 Express Shopper SubsystemThe Express Shopper subsystem also allows the PSS System to be used in a slightly differentmanner than normal, and also helps retailers and shoppers reduce the amount of checkout time.A self-scanning kiosk is installed near the express checkout lanes in the store. A customer picksup a terminal, scans their items, and replaces the terminal into the dispenser slot. The customerthen proceeds to the PSS checkout lanes and presents their ticket or loyalty card to the cashierwho then performs a standard non-audit self scan checkout.2.3.6 Electronic Marketing SubsystemThe PSS system also allows for a basic electronic marketing facility through the ElectronicMarketing subsystem. This application allows a retailer to send messages to a shopper’s handheld terminal anytime that a given item is scanned.
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 8© 2000, Symbol Technologies, Inc. February 1, 20002.3.7 User MessagingAlso, through the User Messaging application, the store has the option to send messages toshopper’s hand held terminals. The messages can be any text, and can be made to be repeated, tobe displayed at fixed times during the day, and/or to be directed to any set of shoppers currentlyin the store. In addition, messages can be "pre-loaded" such that they are displayed to the userthe next time they enter the store and use the PSS system.2.3.8 Transaction Ticket PrintingThe Transaction Ticket Printing application prints a transaction ticket for the shopper at theconclusion of their self-scan shopping trip. The ticket is used to direct the shopper to the self-scan or quick pay lanes. The ticket also provides a mechanism, when scanned, for notifying thePOS System that this is a PSS transaction. Using a transaction ticket is optional.2.3.9 POS InterfaceThe POS Interface application provides the mechanism by which the PSS System can be fullyintegrated into a store’s environment. It handles price file updates and Scan-In/ Scan-Out filemechanisms.2.3.10 System AdministrationFurther, a system administration application is provided which allows store personnel to adjustand monitor the PSS system and data.2.4 PSS Overview DiagramThe following diagram depicts the PSS Software in the context of a WaveWorks system. Thesystem hardware interfaces occur via the Spectrum 24 network. The hand-held terminal userinterfaces are managed as shown in the Application User Interfaces. The Web screens used at theService Desk Terminal interface via the Web Server. The Message Server routes messagesthrough the Business Server to COM objects that perform the PSS business logic and provideany necessary database manipulations.
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 9© 2000, Symbol Technologies, Inc. February 1, 2000ObjectWave/OpenViewWireless NetworkManagementBusiness Server Business ServerMessage ServerSocketsODBC - Database Interface & SystemInterface DriversUMS COMObject Other COMObjectsShoppingTrip COMObjectFuture COMObjectsThreadsSockets SocketsSocketsPSS WebServerAppletsCustomerManagementSystemConfigurationDataManagement(Reports andQueries)SystemManagementTransactionMaintenanceSystemStatusHand heldterminalmanagementWebAPIComm ManagerComm InterfaceDisplay ServerEthernetApplication User InterfacesConfigurationFilesData BaseConfigurationFilesNativePOS SystemControllerCheckoutsPSSWebServerService DeskSpectrum 24NetworkEntranceStation TicketPrinter AsterixTerminalsApplication UserInterfacesShoppingTripModuleUnitManagementModule
Architecture Overview______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 10© 2000, Symbol Technologies, Inc. February 1, 20002.5 PSS Component DiagramThe following diagram gives a more complete listing of the software components included in theWaveWorks PSS system. Further details of these components are provided in subsequentchapters.BrowserPOSInterfaceServiceService TerminalHARDWAREHARDWAREINTERFACESOFTWARECLIENTSOFTWAREIISComClientTxFileMonitorServiceLocal POS FilesMESSAGINGMessage ServerBusiness ServerBUSINESSOBJECTSBUSINESSSERVICESODBC DatabaseDATASTORAGEEntranceDisplayTicketPrinterStorePOSCardReaderHand-HeldTerminalsSTEP/EnablerHardwareInterfaceLayerHardwareInterfaceLayerHardwareInterfaceLayerDisplayServer EntranceService PrinterServiceEntranceServiceUnitManage-mentCOMPOSInterfaceCOMPSSActivityCOMPSSCustomerRankCOMPSSQuickOrderBarcodeCOMPSSShoppingTripCOMPSSUtilitiesCOMPSSTrans-actionTicketCOMPSSSystemMessagesCOMPSSSpecialBarcodeCOMUnitManagementLibPSSActivityLibPSSMessageLogPOSAsciiFileLibPSS UtilityLibPSSSessionPSSImportLibPOS Status PSSCustomerLibPSS HistoryShoppingTripLibPSSQuick OrderLibPSSConfigura-tion LibPSSBarcodeLibPSSNLS Lib(LanguageSupport)PSSTransactionTicketLibPSSSystemMessagingLibPSSPricingLibPSS ActivityLog LibPSS ItemLibPSSShoppingTrip LibPSSCustomerRank LibPOS Events PSSRescanLibPSSMarketingMessageLibPSSSpecialBarcodeLibPOSConfiguration LibPSSVariableWeightBarcodePSS DbCleanup Lib PSS FileUtils LibPSS FileMaintenance COMPSS DBCleanupCOMPOS FileTransferCOMPSS ItemMaintCOMPSSTransaction FilesCOMPSSCustomerMaintCOMPSS WebUtility COM
Hardware Requirements______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 11© 2000, Symbol Technologies, Inc. February 1, 20003. Hardware Requirements3.1 Windows NT ComputerA Windows NT Machine is required with approximately the following configuration:• Intel-based PC (minimum 233 MHz Pentium)• Windows NT Server version 4.0 (NT Server needed to perform DHCP functionality; ifsome other host in store is a DHCP server where PSS files can be written, NT Workstationis sufficient.)• VGA monitor• Mouse• xx Mb of free space on the hard diskdisk sizing is dependent on length of time historicaldata is to be stored in database• minimum 128 Mb RAM• CD drive• Ethernet adapter card• Token ring adapter card (optional)The build environment expected is:• IBM RCO Version 2.3 NT Client Support• ODBC-compliant database (SQL Server is recommended)3.2 Hand Held Terminals• Symbol Technologies’ CST 2040• Asterix 2 RF; 5-key model• Asterix 3, RFNote: See Symbol product literature for available terminal types and options.
Hardware Requirements______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 12© 2000, Symbol Technologies, Inc. February 1, 20003.3 Terminal Dispenser/Entrance Unit• Symbol Technologies’ CPD 20XX Dispenser - 96, 64, or 32 slot (for Asterix 2 terminals)• Symbol Technologies' Asterix 3 Standard Charging Cradle• Entry Station barcode reader or magnetic stripe reader• Standard furniture• Optional ticket printerNote: See Symbol product literature for available dispenser types and options.3.4 Spectrum 24 Radio NetworkThe hand held terminals communicate to the Windows NT computer via Symbol’s wireless radiosystem. The terminals send and receive radio messages via multiple “access points” locatedthroughout the store.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 13© 2000, Symbol Technologies, Inc. February 1, 20004. PSS Software InstallationThis installation guide is intended to provide a roadmap for installing and configuring the PSSsystem and all supporting software. The reader should be familiar with the Windows interfaceand installing software.This guide assumes the software is being installed on a new machine. It is stronglyrecommended that the target computer be dedicated to running PSS and that you install thesoftware onto a freshly formatted disk.Before StartingThe following media will be needed during the installation process:- Bootable Microsoft NT Server Version 4.0 Installation CD- NT “Getting Started” book (with the Certificate of Authenticity on the front)- NT 4.0 Service Pack 5 CD- NT 4.0 Option Pack CD- Video and Network Card drivers- Microsoft SQL Server 7.0 (Standard) CD- Microsoft Access CD or Microsoft Office 97 Professional Edition CD- Symbol PSS Setup CD (includes WaveWorks, PSS, and customer changes)The following information will be needed during the install:- Administrative account and password for the computer- The IP address and hostname of the target computer. (It is suggested that the target computer use a private IP subnet. The 172.16.N.N addresses are typically used with asubnet mask of 255.255.255.0; this allows for 256 hosts on the subnet).- The range of IP addresses to allocate for DHCP use. If you need to have the target computeron the office/store network, make sure that there are no other DHCP servers on the samesubnet. If that is not possible, then install a second network adapter and use it to connect tothe outside world, leaving the private IP subnet for PSS use.- Access Point ESS ID (aka Net ID)
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 14© 2000, Symbol Technologies, Inc. February 1, 20004.1 Install NT 4.0 ServerThe first step in the installation process is to install the NT 4.0 Server operating system. It isstrongly recommended that you do a clean installation of the entire system. Many of the moreexpensive server PCs come with customized installation programs that walk the user thru the NTinstallation process. If your PC comes with a special installation CD, you should use it, but readthis section first to identify the places where you will have to change settings from the defaultvalues. This section describes the NT installation process using the standard Microsoft NTServer installation CD.Below are the specific steps to follow:Turn the computer on. During the boot-up process, enter the CMOS setuphowever thatprocess occurs on your machine. Look for a message that says which key to press to enter Setup(Delete and F2 are popular choices).- Set the CMOS to boot from the CD-ROM drive.- Insert the NT Server CD Installation in the CD-ROM drive, then exit from the CMOSsettings. The system should now boot from the CD.- The blue “Windows NT Setup” screen is displayed. Wait while various system files anddrivers are loaded.- The blue NT boot screen is displayed, then it goes back to the “Windows NT Server Setup”screen.- Press Enter to install Windows NT now.- The Mass Storage screen is now displayed. This section of the setup process is hardwarespecific. Most corporate PCs do not have SCSI interfaces installed in them. Many serverPCs do come with SCSI interfaces, so you’ll need to know what kind of hard disks yoursystem has before continuing. Press Enter to skip searching for SCSI devices. Press “S” tocheck for them.- The Licensing Agreement is displayed. Read the Agreement (press the Page Down key toadvance to the next page) until end of End User License Agreement (EULA) verbiage isreached.- Press F8 to accept the Licensing Agreement.- The Server Setup screen is displayed which lists any previous installations of NT. Select“N” to install a fresh copy of NT Server.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 15© 2000, Symbol Technologies, Inc. February 1, 2000- The Components list is displayed. Press Enter to accept the list of standardhardware/software components.- The Partition options screen is displayed. It is very important to pay attention to what youare doing here. This section is also hardware specific.- Start off by deleting all existing disk partitions. Select each existing partition (use the arrowkey to move the highlighted partition) and following the on-screen instructions.- The screen should now only show “Unpartitioned space” since you just deleted all existingpartitions. The next step is to create a partition that NT will be installed onto. Depending onthe size of your hard drive, you’ll want to select a value between 2GB (2047 MB) and 4GB(4095 MB). You will now create a system (C:) partition. Move the highlight to“Unpartitioned Space” with the arrow keys. Press “C” to create a new partition and thenenter the partition size (a number between 2047 and 4095, consult your system administratorif you need help).- If your disk is 8GB or smaller, you can create a D: partition here. If your disk is greater than8GB in size, the NT setup program can’t access all of it, so it’s best to wait until later tocreate the D: partition. To create a D: partition, follow the same steps as for the C: partition,with the exception that the size will be all the remaining space on the drive (the number isalready filled in for you by default). Typical installations might evenly divide a 6 or 8 GBdisk between the C and D partitions. If you expect the database to be quite large, then givethe D: parition more space than the C partition (but give C at least 2GB!).- Put the highlight on the C: partition and press Enter to install NT on the C: drive- The File System selection screen is displayed. The FAT file system is the default, but FATpartitions are limited to a maximum size of 2GB and are not as efficient as the NT FileSystem (NTFS). Select the NTFS file system and press Enter.- Wait while the system formats the C: drive. Note that the D: partition (if you created one)does NOT get formatted at this step. Formatting a 4GB partition can take a while (10minutes perhaps).- The File location screen displays. Press Enter to accept installing NT in the \WINNT folder.- The Hard disk examination screen displays. Press ESC to skip the exhaustive hard diskcheck. The exhaustive check physically checks the entire hard disk surface and can take avery long time, so we skip it.- Wait while setup does a quick disk check.- Wait while setup copies files to the disk.- The Setup Successful screen is displayed. Remove the CD from CD-ROM drive.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 16© 2000, Symbol Technologies, Inc. February 1, 2000- Press Enter to restart the computer.- Wait while the system reboots and prepares to continue the installation. You will beprompted to insert the NT server CD when it is ready to continue. Note that the PC is nowusing the mouse and is displaying graphical screens.- Wait while more files are copied.- The Windows NT Setup Wizard is displayed. Click the Next button to gather informationabout your computer.- The Name screen displays. Enter a name and organization in the fields provided, then clickon the Next button.- Enter the Product ID (use the tab key to jump between fields) then click on the Next button.The Product ID code is found on the cover of the NT Server “Getting Started” book with the“Certificate of Authenticity” on it.- The Licensing Modes screen is displayed. Select “Per Seat”, then click on Next.- The Computer Name screen is displayed. Enter the name of the computer. Note the namemust be unique to avoid confusion within your network domain. Then click on Next.Contact your network administrator if you need help selecting a Name.- The Server Type screen is displayed. Select the “Stand Alone Server” option, then click onNext.- The Administrator Account screen is displayed. Enter the Administrator Account password(and the confirmation to ensure you typed it correctly), then click on Next.- The Emergency Repair Disk screen is displayed. Select “No”, since one will be created later(once the the system is completely configured). Click on Next to continue.- The Select Components screen is displayed. In general, we try not load any “fluff” on theserver, so we will limit the amount of extra software we install.- De-select all the options (no check mark) except for the “Accessories” and“Communications” options.- Highlight the Accessories option and click the Details button. Select all the componentslisted. Select the OK button.- Highlight the Communications option. Click on the Details button. Deselect the Chatand PhoneDialer options. Hyperterminal should be the only component selected. Clickon the OK button.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 17© 2000, Symbol Technologies, Inc. February 1, 2000- Click on the Next button on the Select Components screen to continue.- The Windows NT Setup screen displays again, click Next to Install Networking.- The Networking screen is displayed. The “will participate” and “wired to the network”options should be checked by default, click Next to continue.- The Microsoft Internet Info Server (IIS) screen is displayed. The “Install” MS IIS box ischecked by default. Uncheck the box since we will be installing a newer version of IIS laterin the procedure. Click Next to continue.- The Network Adapter screen is displayed. Click on the “Start Search” to look for networkcards. Depending on the type of PC you have, the search may or may not find the networkinterface in your computer. The procedure assumes the search does NOT find the networkcard in the PC or built into the motherboard.- Click on the “Select from list“ button, then Click on the “Have disk…” button.- Insert the floppy disk containing the NT drivers for your network card then click on OK tosearch the disk.- Select the proper driver from the list, then click OK to copy the driver files to the hard disk.- The network card you just installed the drivers for should now be listed. Click Next tocontinue.- The Network Protocols screen is now displayed. Deselect the “NWLINK IPX/SPX”protocol. Select the NETBui protocol. TCP/IP is required by the PSS system. NETBUI isused by NT to access disk drives on other computers. Click Next to continue.- The Network Services screen displays. Click on the “Select from list..“ button.- Select the “Microsoft DHCP Server” service from the list, then click OK. The DHCP serviceis a central resource that gives out IP addresses to other computers on the same network. Theterminals do not store IP addresses, so they ask DHCP for an IP address when they firstconnect to the system.- Note that DHCP Server is now added to the list of Network Services to install. Click Next.- Click Next again to install the networking components.- Wait while files are copied. Click OK on any status boxes that display.- The TCP/IP Setup dialog box displays and asks “Do you wish to use DHCP?” Click the“No” button. Just to clarify, this dialog box is asking if we want to assign a hard-coded IP
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 18© 2000, Symbol Technologies, Inc. February 1, 2000address to the computer or to let the computer use DHCP (running on some other computer)to supply us with an IP address. We do NOT want to use DHCP to get an IP address.- The TCP/IP Properties dialog is now displayed. Enter the following information in the fieldsprovided, then click OK:- IP address- Subnet mask- Gateway- The following entry may or may not display: “At least one of the adapter cards has an emptyprimary WINS address. Do you want to continue?” Answer “Yes.”- The Bindings screen is displayed. Click Next to skip past Bindings screen.- The Network Start screen is displayed. Click Next to start the network.- The Computer Name screen is displayed. Click Next to accept the computer name andworkgroup selection.- Click Finish to complete the network setup.- The Time screen displays. Select the appropriate time zone and system date and time, andthen click on Close.- A Message box is displayed concerning the video adapter. Click OK. Then click OK on theDisplay Properties dialog box. These selections just confirm that you are using the default640x480 VGA video driver. We will update the video driver later in this procedure.- Wait while Setup copies files.- The Windows NT Successfully Installed message is displayed. Remove CD and floppy,then click “Restart Computer” button.Congratulations! Windows NT Server is now installed.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 19© 2000, Symbol Technologies, Inc. February 1, 20004.2 Install the NT 4 Service PackNT has bugs, just like any other software. Microsoft releases “service packs” to add newfeatures and fix bugs on your NT installation. This section of the installation guide documentshow to install Service Pack 5.- Log in as Administrator (using the password you defined in section 1).- Close the “Welcome to Windows NT” window.- Insert the NT Service Pack 5 CD. Service Pack 5 will autostart in a few seconds.- Click on the “Install Service Pack 5” link (on the left).- The screen jumps to the Service Pack 5 options. Click on the “Install Service Pack 5 forIntel-based processors” link.- A message box asks how to open the file. Click on “Open” to run the setup program.- The License window displays. Select the “Accept License “ option, deselect the “Backupfiles” option, then click on “Install” to continue.- Wait while files are copied.- Click on the “Restart” button to reboot the PC.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 20© 2000, Symbol Technologies, Inc. February 1, 20004.3 Install Internet Explorer 4.01 Service Pack 2The PSS system uses the Internet Explorer web browser by default. Installing IE4 also providessome useful desktop updates. We will upgrade our IE4 installation to IE5 later in the procedure(primarily to install the Task Scheduler that comes with IE5), but we install IE4 here to get thedesktop update and other Windows enhancements.- Log in as Administrator.- The “Welcome to Window NT” Screen is displayed. Uncheck the “Show Welcome ScreenNext Time“ option, then click “Close.”- Open, then close, the CD drive to restart the Service Pack 5 installation program.- Click on the “Internet Explorer 4.01 Service Pack 2” link on the left (scroll down ifnecessary).- Click on the “Install IE4.01 SP2 for Intel-based Systems” link.- Click Open on the security message.- The Internet Explorer 4.01 Service Pack 2 screen is displayed. Click Next.- The License screen is displayed. Select the “I accept” option, then click Next.- The Installation Option screen is displayed. Click Next to accept a “Standard Installation”.- The Windows Desktop Update screen is displayed. Click Next to install the desktop update.- The Active Channel Selection screen displays. Click “Next”.- The Destination folder screen displays. Click “Next” to accept the default destination folder.- Wait while files are copied.- Click OK to complete the install.- Wait while the system is configured.- Click OK to restart the PC.- Wait while the PC reboots.- Log in as Administrator again.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 21© 2000, Symbol Technologies, Inc. February 1, 2000- The IE4.01 setup program automatically starts when you log in and finishes configuring thesystem.- Wait for the desktop to appear.- Close the Active Desktop Window (click the “x”)- Click on Start button, then Settings, then Active Desktop and uncheck the “View as WebPage” option.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 22© 2000, Symbol Technologies, Inc. February 1, 20004.4 NT Option Pack InstallThe NT Option Pack installs software that is not part of the standard NT installation. Ourpurpose for installing the Option Pack is to install the Microsoft Internet Information Server(IIS). IIS is the web server used by PSS for the Service Terminal screens.- Insert the Option Pack CD, click Install- Click on Step 5, Install the Windows NT Option Pack.- Select the “Run this program from current location” option, then click the OK button.- Click “Yes” on the security warning screen.- The message “Not tested with Service Pack 4 or greater. Do you wish to proceed?” messagedisplays. Click Yes.- The NT Option Pack Setup screen is displayed. Click Next to continue.- The License Agreement displays. Click on the “Accept” button.- The Options screen is displayed. Click on the “Typical” button.- Click on the Next button to confirm the default file locations.- Click on the Next button to confirm the default “mailroot” location.- Wait while files are installed.- Click “Finish” to complete the setup.- Click “Yes” to restart the computer.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 23© 2000, Symbol Technologies, Inc. February 1, 20004.5 Install the Video DriverThe normal NT installation uses a generic video driver. This section leads you through the stepsto installing a video driver for the specific video card in your computer. Installing the correctvideo driver for your hardware allows the system to run at higher resolutions, refresh rates andnumbers of colors. You will need the floppy disk containing the video drivers in this section.- Right Click on the desktop and select the Properties option from the menu.- The Display Properties window is displayed. Select the Settings tab. Click on the “DisplayType” button.- Click the “Change…” button.- Click on the “Have Disk…” button.- Insert the floppy disk containing the NT video drivers. Click OK.- Select the appropriate driver from the list, then click OK.- A third party driver message is displayed. Select the “Yes” button.- Wait while files are copied from the floppy disk to the hard drive.- The “Successful Installation” message is displayed. Click OK.- Select the Close button on Display Type window.- Select the Close button on Display Properties window.- Remove the floppy disk from the drive.- Click “Yes” to reboot the computer.- Wait while the computer reboots.- Log in as Administrator.- A message about a new graphics driver is displayed. Click OK.- Set the Desktop Area to 1024 x 768 (suggested value)- Set Color Palette to 65536 colors (suggested value)
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 24© 2000, Symbol Technologies, Inc. February 1, 2000- Set Refresh Frequency to 85Hz (or the highest refresh rate offered)- Click the “Test” button, then the OK button to view the test pattern.- The test ends after 15 seconds. Click “Yes” if you saw the test patten properly.- Click OK to exit the Display Properties window.- Click on the Start button, then Control Panel, then System, then Performance tab. Set theVirtual Memory min and max sizes to twice the RAM installed in the computer, then clickthe “Set” button. Click OK. Select Start Up/Shutdown tab. Change time in “Show listfor…” option to 3 seconds. Click OK.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 25© 2000, Symbol Technologies, Inc. February 1, 20004.6 Create and Format the Database partitionYou may remember the discussion about the creation of a D: partition on the hard drive from theearly steps of this procedure. If you created a D: partition then, you may skip to the Formatsteps. If you did not create a D: partition earlier, we will create (and then format) one here. TheD: partition is where we store all the database data files. Run the Disk Administrator utility tocreate and format the D: partition:• Click on the Start button, then Programs, then Admin Tools, then Disk Administrator• Click OK to update the configurationCreating the D: partition<< TO DO: add steps on creating a Logical drive in an Extended partition. Include info aboutpossibly needing to move the CD-ROM drive letter to E first, so that you can make the newpartition the D: drive>>Formatting the D: partition- Click on the D: drive to select it (make it the active partition)- Right click on then D: drive, then select “Format”- Change the file system to NTFS (NTFS is more efficient than FAT)- Change the Volume label to “Database”- Select the “Quick Format” option- Click on the “Start” button- A warning message about losing data displays. Click OK.- A “Format complete” message displays. Click OK.- Click on “Close” to exit the Format window.- Close “Disk Admin” window (click on the “X” in the upper right corner of the screen).
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 26© 2000, Symbol Technologies, Inc. February 1, 20004.7 Desktop Cleanup (optional)This section includes OPTIONAL changes to the desktop environment. We’ve found that thesechanges make life a little easier. The intent is clean up the desktop and to set up the Explorerwindow to show the data we want to see.- Delete the Outlook Express, My Briefcase, Internet Explorer, and Inbox Shortcuts by right-clicking on the desktop icon and then selecting the Delete option.- Right click on the “Recycle Bin” icon. Select Properties. Select the “Do not move files… “option. Click OK. This step basically turns off the Recycle Bin and causes all files to bedeleted immediately. We find ourselves creating (and later deleting) large log files. If theRecycle Bin is active, you won’t actually delete the file (and free up the disk space) until youempty the Recycle Bin. So we turn it Off.- Right click on the Recycle Bin icon. Select the “Empty Recycle Bin” option, then click“Yes”. This step cleans out any files that were previously deleted and moved to the RecycleBin.- Right click on the desktop and select the Arrange Icons submenu. Select the Auto Arrangeoption. This step makes the icons arrange themselves automatically (top to bottom, left toright). You may want to skip this step if you prefer to group desktop shortcuts all over theplace.- Click the Start button. Select Settings, then Taskbar, then Small Icons, then OK. This stepkeeps the Start menu smaller.- Click the Start button, then Programs, then Windows NT Explorer. Select View Menu,Folder Options, View Tab. These changes maximize the amount of information displayed inthe Explorer window.- Select Display full path in the title bar.- Select “Show Attributes” in Detail View.- Select “Show Map Network Drive” button in toolbar.- Uncheck Hide file extensions for known file types.- Click on “Show All Files”
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 27© 2000, Symbol Technologies, Inc. February 1, 20004.8 Install Microsoft SQL Server 7This section installs Microsoft SQL Server 7, the database application used to store PSS data.This section only installs the software, it does not configure SS7, or create the PSS database.Those steps are in the next section.- Insert the MS SQL Server 7 (Standard Edition, not Enterprise) CD. The setup program willautostart.- Click on the Install SQL Server 7.0 Components link.- Click on the “Database Server- Standard Edition” link.- Click on Next to accept “Local Install”- The Welcome screen is displayed. Click on Next to continue.- The License screen displays. Click on Yes to accept.- Click on Next to accept the default Name and Company.- Enter CD key at window- The Setup Type screen is displayed. Select “Typical” install (default). Click “Browse”button for Data files. We want to put the SS7 data files on a different disk than theapplication itself. Change C:\ to D:\, then click OK. Click on Next to continue.- The Services Accounts window displays. Select “Use the Local System Account,” then clickon Next.- Select Next (again) to continue.- The Choose Licensing Mode screen displays. Select “Per Seat” then “Continue”- The Licensing screen displays. Check the “I agree that..” box, then OK.- Click on “Continue” again (screen change might be sluggish)- Wait while files are installed (several minutes)- The Setup complete screen is displayed. Click Finish.- Click “Exit” to exit SQL Server 7 install program.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 28© 2000, Symbol Technologies, Inc. February 1, 2000- Reboot the PC manually. (Start | Shutdown | Restart)4.9 Create and Configure the PSS DatabaseThe PSS database is stored in a few large files. This section creates the (empty) PSS data files.We will still have to create database tables and populate them (later in the procedure). Aftercreating the PSS database, we will configure SQL Server and set up the automated databasemaintenance tasks.4.9.1 Create the (blank) PSS DatabaseThis step will create the initial storage for the PSS database.- Select Start button, then Programs, then Microsoft SQL Server 7.0 Enterprise Manager.- Expand the “MS SQL Server” branch.- Expand the “SQL Server Group” branch.- Expand the <local machine name> branch.- Under the <local machine name> branch, right click on “Databases.” Select “NewDatabase.”- Enter “Name” as “PSS”. WARNING: If you enter a different name, various PSS databasescripts will no longer work. It is strongly recommended that you use the default databasename of “PSS”. Use something else at your own risk!- Set the initial database size to 512MB.- Click on the Transaction Log tab.- Set the initial size transaction log to 512MB.- Click OK to create and prepare the database- Wait while the database is created (about 5 minutes)
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 29© 2000, Symbol Technologies, Inc. February 1, 20004.9.2 Configure SQL ServerThis step will configure SQL Server to function properly, and allow sufficient security access tothe database.- Expand the “MS SQL Server” branch.- Expand the “SQL Server Group” branch.- Expand the <local machine name> branch.- Right-click on the local machine name. Select “Properties”- In the General tab, at the bottom, make sure that in the AutoStart policies, both‘Autostart SQL Server’ and ‘Autostart SQL Server Agent’ are checked.- Press OK.- Expand the security branch- Right click on “Logins” and select “New Login”- Select SQL Server authentication- In the “Name” field, type: IUSR_<machine name>- Click on Database Access tab- Click on Pss database “Permit” column- Select db_datareader and db_datawriter- Click on OK- Under the local machine name icon, drop down and expand ‘Management’ and then expand‘SQL Server Agent’.- On the SQL Server Agent icon, if a green arrow does not appear, right-click on the SQLServer Agent icon, and select Start.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 30© 2000, Symbol Technologies, Inc. February 1, 20004.9.3 Configure the Clear Transaction Log jobThis step will schedule a clearing of the SQL Server Transaction Log, which provides temporaryspace for all data modification activities in the database. The Transaction Log must be clearedoccasionally to remove old inactive database transaction entries.- Under SQL Server Agent, click on ‘Jobs’.- In the right pane, right-click, and select ‘New Job...’- General tab:- In Name, enter 'Clear Transaction Log'.- Under Category, select 'Database Maintenance'.- Steps tab:- Click New...- In Step name, enter 'Clear Transaction Log'.- Under Database, select the name of the PSS database.- In Command, enter 'BACKUP TRANSACTION <dbname> WITHTRUNCATE_ONLY, where <dbname> is the name selected under the Databasefield.- Press OK.- Schedules tab:- Press New Schedule...- In Name, enter 'Every 2 hours' (or if you decide to use a different recurrence, asimilarly descriptive name)- Make sure Recurring is selected, and press Change...- In Occurs, press Daily.- In Daily Frequency, select Occurs Every, and change the value to the right to2.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 31© 2000, Symbol Technologies, Inc. February 1, 2000- In Starting At, change the time to 1:55am (or 5 minutes before backups willbe scheduled to start below).- Press OK.- Press OK.- Press OK.4.9.4 Configure the Extensive Database Check and Backup jobThis step will configure a database backup, and an extensive check of the integrity of all of thestructures in the database, including tables and table indexes, which will run once a week. Theintegrity check takes a relatively long time because the structure of all of the table indexes mustbe verified, and because of this, this activity must be scheduled for the time of the week with theleast shopping activity.- Under ‘Management’, click on ‘Database Maintenance Plans’.- In the right pane, right-click, and select ‘New Maintenance Plan...’, and the DatabaseMaintenance Plan Wizard should appear. Click “Next.”- This maintenance plan will include an exhaustive optimization and validation of thedatabase, as well as a backup. It should run once a week when the system is unused, orlightly used. The default schedule for these activities is Sunday in the early morninghours. You should change this schedule only if necessary.- On the Select Databases page, make sure ‘These databases’ is selected, and check the boxnext to the PSS database name. Click ‘Next’.- On the ‘Update Data Optimization Information’ page, click on ‘Reorganize data andindex pages’, and click on ‘Remove unused space from database files’.- This operation may take some time, and slow down the system, so if you have areason to use a different schedule, then next to ‘Schedule’ press the ‘Change’ button,and make the appropriate changes.- Click ‘Next’.- On the ‘Database Integrity Check’ page, click on ‘Check database integrity’. Click on‘Perform these tests before doing backups’.- If you have a reason to use a different schedule, you can change it by pressing the‘Change’ button next to ‘Schedule’. Make any changes, and press ‘OK”.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 32© 2000, Symbol Technologies, Inc. February 1, 2000- Click ‘Next’.- On the ‘Specify the Database Backup Plan’ page, make sure the ‘Back up the database’and ‘Verify the integrity’ options are selected, and under the ‘Location to store’, that‘Disk’ is selected.- If you have a reason to use a different schedule, you can change it by pressing the‘Change’ button next to ‘Schedule’. Make any changes, and press ‘OK”.- Click ‘Next’.- On the ‘Specify Backup Disk Directory’ page, make sure ‘Use this directory’ is selected,and enter the location where your backups should go (usually a different physical drivethan the drive on which the database resides). The default directory is the ‘Backup’directory under your SQL Server 7 installation directory, such as C:\MSSQL7\BACKUP.In any case, you should make sure that the specified directory exists in WindowsExplorer, and create it if it does not (using File, New, Folder). Through normaloperation, the database, and therefore the backups, can eventually grow to be very large,so make sure the space available will be sufficient.- Click on ‘Remove files older than’, and change the data to the right to ‘2’ ‘Days’.This value can be varied based on the amount of space available, and the number ofdays of backups you wish to keep.- Click ‘Next’.- When the ‘Specify the Transaction Log Backup Plan’ page appears, click ‘Next’.- When the ‘Reports to Generate’ page appears, click ‘Next’.- When the ‘Maintenance History’ page appears, click ‘Next’.- When the ‘Completing the Database Maintenance Plan Wizard’ page appears, select theentire contents of the ‘Plan Name’ field, and type over it: ‘DB Extensive Check andBackup’. This may not paint correctly, but your changes should appear in the list onceyou are finished with this step. Click ‘Finish’.- Click OK.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 33© 2000, Symbol Technologies, Inc. February 1, 20004.9.5 Configure the Nightly Database Check and Backup jobThis step will configure a database backup and a brief check of the integrity of all of the tables inthe database, which will run every day of the week, except for the night on which the extensivecheck and backup is run. This activity should be scheduled for the time of the day with the leastshopping activity.- Once again, in the right pane, right-click, and select ‘New Maintenance Plan...’, and theDatabase Maintenance Plan Wizard should appear. Click ‘Next’.- This maintenance plan will include a quick validation of the database, and a backup. Itshould run once a night (except for the night on which the exhaustive checks arescheduled) when the system is unused, or lightly used. The default schedule for theseactivities is each day in the early morning hours. You should change this schedule only ifnecessary.- On the Select Databases page, make sure ‘These databases’ is selected, and check the boxnext to the PSS database name. Click ‘Next’.- When the ‘Update Data Optimization Information’ page appears, click ‘Next’.- On the ‘Database Integrity Check’ page, click on ‘Check database integrity’, and thenclick on ‘Exclude indexes’. Click on ‘Perform these tests before doing backups’. Next to‘Schedule’ press the ‘Change’ button.- Unless you have a reason to use a different schedule, make sure ‘Weekly’ is selected,and to the right, check every day except for the day on which the exhaustive backupis scheduled. If the default, Sunday, is used for exhaustive backups, only every otherday from Monday to Saturday should be checked. Press “OK”.- Click ‘Next’.- On the ‘Specify the Database Backup Plan’ page, make sure the ‘Back up the database’and ‘Verify the integrity’ options are selected, and under the ‘Location to store’, that‘Disk’ is selected. Next to ‘Schedule’ press the ‘Change’ button.- Unless you have a reason to use a different schedule, make sure ‘Weekly’ is selected,and to the right, check every day except for the day on which the exhaustive backupis scheduled. If the default, Sunday, is used for exhaustive backups, only every otherday from Monday to Saturday should be checked. Press ‘OK”.- Click ‘Next’.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 34© 2000, Symbol Technologies, Inc. February 1, 2000- On the ‘Specify Backup Disk Directory’ page, make sure ‘Use this directory’ is selected,and enter the location where your backups should go (usually a different physical drivethan the drive on which the database resides). The default directory is the ‘Backup’directory under your SQL Server 7 installation directory, such as C:\MSSQL7\BACKUP.In any case, you should make sure that the specified directory exists in WindowsExplorer, and create it if it does not (using File, New, Folder). Through normaloperation, the database, and therefore the backups, can eventually grow to be very large,so make sure the space available will be sufficient.- Click on ‘Remove files older than’, and change the data to the right to ‘2’ ‘Days’.This value can be varied based on the amount of space available, and the number ofdays of backups you wish to keep.- Click ‘Next’.- When the ‘Specify the Transaction Log Backup Plan’ page appears, click ‘Next’.- When the ‘Reports to Generate’ page appears, click ‘Next’.- When the ‘Maintenance History’ page appears, click ‘Next’.- When the ‘Completing the Database Maintenance Plan Wizard’ page appears, select theentire contents of the ‘Plan Name’ field, and type over it: ‘DB Backup’. This may notpaint correctly, but your changes should appear in the list once you are finished with thisstep. Click ‘Finish’.- - Click OK.- Exit Enterprise Manager.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 35© 2000, Symbol Technologies, Inc. February 1, 20004.10 Install Microsoft AccessThere are times that you may want direct access to the WaveWorks database. You do not needto install the whole MS Office Suite or even any of the Access extras, just Access. Thisprocedure assumes you are using the Office 97 Professional CD.- Insert the Microsoft Office Professional CD.- Click on Install MS Office.- The Welcome screen is displayed. Click on the Continue button.- Enter Name and Organization. Click OK.- The default install folder is displayed. Click OK to accept the default location.- The installation type window is displayed. Select “Custom”.- Deselect everything except Microsoft Access, the click Continue to install- A success message is displayed. Click OK to complete the setup.- Click on the “X” to exit setup.4.11 Internet Explorer 5.0 with Task Scheduler installThis section installs the latest version of the Internet Explorer browser. The main reason weinstall IE5 is to also install the new Task Schedule program. PSS uses the Task Scheduler toperiodically trigger transactions. We will configure the periodic tasks later in this procedure.- Insert the PSS CD.- Open an NT Explorer window.- Double click on the “symie5.exe” icon in the root folder of the CD.- Wait while lots of files are copied to the disk (takes a while). The PC will automaticallyreboot when done.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 36© 2000, Symbol Technologies, Inc. February 1, 2000- Log on as Administrator.- The final setup of IE5 will continue. The normal desktop will be displayed when setup iscomplete.4.12 Install WaveWorksObjectWave has been renamed “WaveWorks.” The name change is only partially complete, soyou may still see references to “Objectwave” on the system. WaveWorks is the foundation thatthe PSS system is built on.- Insert the PSS CD (if it’s not still in the CD-ROM drive from the previous step)- Run the WaveWorksSetup.exe file via Explorer to install WaveWorks.- The Welcome Screen is displayed. Click on the “Install” button.- The Components Screen is displayed. Click on the “Next” button.- The Destination Directory is displayed. Click Next to accept the default location. NOTE:You will break several PSS scripts and will have to perform extra configuration steps tocorrect these problems, if you install to a non-default location.- Click Next to accept the default network parameters.- Uncheck the “Autostart Services” option. You will need to make the WaveWorks servicesautostart before placing the system into production, but it MUST be unchecked until youhave completed the entire PSS installation and verified that things are working properly.Click Next to continue.- You may accept the default value of 35 days to retain logs, but if you are installing on atest/lab system, then perhaps you’ll want to change this value to 7 days to avoid using largeamounts of disk space. Click Next to continue.- Enter Domain (If part of a larger network). Select Next.- The Install screen is displayed. Click Install, then OK.- Wait while files are copied.- The install is completed.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 37© 2000, Symbol Technologies, Inc. February 1, 2000- Click Finish- Reboot the PC to make new environment variables and registry changes take effect4.13 Install PSS Runtime SystemThis section installs the PSS software. It is strongly recommended that you use the default folderfor the files. This section installs the generic/base system.- Run the PssWaveworksSetup.exe file to install the PSS system.- PSS requires several Microsoft and WaveWorks components. If you have skipped any stepsin this installation guide, then you will be notified by a dialog box of any missingcomponents which may be required. The installation process may stop if a missingcomponent is required. Please note the missing component name and follow the instructionsin this document for installing that component.- The Welcome screen displays. Click Next- The PSS Components dialog displays. Choose the appropriate type of handheld terminal,entrance unit, printer and POS (Point of Sale) system interface which you will be using.Click Next.- Select Destination Directory dialog displays. Click Install. Do NOT change the defaultinstallation directory for PSS. The current installation script will not be able to successfullycomplete the installation if this directory is changed.- Wait while files install.- Several DOS windows will be displayed as various batch file scripts are run. Most of thesescripts are updating various WaveWorks and PSS database tables. Be sure to read themessages in the windows. If you see any error messages, write them down. After each scriptcompletes, the message “Press any key to continue” displays. Press a key to allow the installprocedure to continue.- The supplied PSS COM objects are registered at the end of the installation process. For afirst time installation, you may get errors indicating that some Microsoft dll files are missing.These files have been delivered, but are not yet active, so the system reports errors. Insubsequent installations, these messages should not appear.- The Limited License Notice screen displays. Read its instructions and then press OK.- The Installation Completed screen displays. Press the Finish button. The installation processis now completed
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 38© 2000, Symbol Technologies, Inc. February 1, 2000- Reboot the PC to make PSS environment variables and registry changes take effect.4.14 Install Waveworks Development StudioThis section installs the Waveworks Development Studio system used for modifying the scriptsthat drive the handheld terminal applications and that link terminal actions to WaveWorkstransactions. It is strongly recommended that you use the default folder for the files.- Run the ScreenMakerSetup.exe file on the root directory of the CD..- The Welcome screen displays. Click Next if you have installed the base WaveWorks system,or click Cancel and install that component first.- The Select Components dialog displays. It defaults selection to the most likely componentsto be used. If you will be modifying handheld terminal displays, the ScreenMaker andHardlock components must be checked. If you will be modifying Pss User Exit routines, theC++ Development Toolkit must be selected.- The Select Destination directory dialog displays. Click Next.- The Ready to Install dialog displays. If you are sure of your selections, click Next.- The installation progress bar now displays showing the progress of the installation.- If all goes well, the Installation Completed dialog box displays. Click Finish.This installation delivers the ScreenMaker application which is used for development ofapplications that run on Step compliant terminal devices. It also delivers WaveWorks librariesand header files and sets up environment variables needed to compile and link C or C++WaveWorks transaction components.4.15 Install PSS Development SystemThis section installs the PSS Development system software required for modifying handheldterminal displays and providing other client-specific customizations. It is strongly recommendedthat you use the default folder for the files.- Run the PssDeveloperSetup.exe file.- The “PSS Development System Installation” screen displays identifying the prerequisiteWaveWorks and PSS components. Click Next if you have installed these components, orclick Cancel and install those components first.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 39© 2000, Symbol Technologies, Inc. February 1, 2000- The PSS Development System requires several Microsoft and WaveWorks components. Ifyou have skipped any steps in this integration guide, then you will be notified by a dialog boxof any missing components which may be required. The installation process may stop if amissing component is required. Please note the missing component name and follow theinstructions in this document for installing that component.- The “Install New User Exit Sources” dialog displays. It defaults to installing the sources. Ifthis is a first time installation you should just click the Next button. If this is not the firsttime installation and you have modified the User Exit sources, you may choose to skip thisstep. Before choosing, please read the release notes to see if any existing User Exit callformats have changed or if any new User Exits are supplied in this release before you decideon whether or not to install the User Exit sources. If you choose to install the User Exits, thefiles in the User Exit directory will be moved to a backup directory before the new files areinstalled. After making your selection, click Next.- “Select Destination Directory” dialog displays. Click Install.- Wait while files install.- The “Installation Completed” dialog displays. The installation process has finished. ClickFinish.This installation delivers PSS libraries and header files and sets up environment variables neededto compile and link the User Exit sources into a dll. It also contains a project file for version 6 ofMicrosoft Developer Studio. If you are using that development platform, you may use that fileto build the dll. If you are using another development platform, you will need to develop yourown make file or equivalent project file. Once you have built a new dll file, copy it to thePss\Bin directory to make it part of the PSS runtime system.4.16 TFTP ConfigurationTFTP (Trivial File Transfer Protocol) is the mechanism that is used to transfer files between thehost and the terminal when the terminal boots up and connects to the host. This section explainshow to install the Symbol TFTP service.- Click on Start button, then Programs, then Command Prompt to open a command window.- Type cd c:\tftpserver to change to the "TftpServer" folder.- Type tftpsvr install c:\tftpserver\tftp.ini to install the TFTP server as a service.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 40© 2000, Symbol Technologies, Inc. February 1, 2000- Type Exit to close command window.4.16.1 Create STEP hex images for the terminals to downloadThis section explains how to create the hex image files that are transferred to the terminal.Asterix2 terminals have a somewhat different procedure than Asterix3 terminals, so follow thesteps for the type of terminals you have. The net result of these steps is that new hex image andconfiguration files will be created and copied under the C:\TftpBoot folder for use by theterminals.Asterix2 Terminals- Go to Start | Programs | Command Prompt to open a command prompt window.- Change to the C:\Asterix2Step\Control folder- Edit the “hosts.x” file. The file should have a single line with the IP address and hostnameand port id of the DHCP server (typically the target computer). Save the file and exit.- Change to the Asterix2Step\Hex1 folder- Edit the “Net.cfg” file. Change the "net_id" to match the net ID of the access point(s) thePSS system is using. Close and save the file.- Change to the Asterix2 folder.- Run MakeStep.bat to create/copy terminal files to the TftpBoot folder- Exit the command window.Asterix3 Terminals- Go to Start | Programs | Command Prompt to open a command prompt window.- Change to the C:\Asterix3Step\Control folder- Edit the “hosts.x” file. The file should have a single line with the IP address and hostnameand port id of the DHCP server (typically the target computer). Save the file and exit.- Change to the Asterix3 folder.- Run SetupStp.bat to create/copy terminal files to the TftpBoot folder- Exit the command window.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 41© 2000, Symbol Technologies, Inc. February 1, 20004.17 DHCP ConfigurationDHCP is the service that gives out IP addresses to Asterix terminals when they boot up. TheDHCP service is allocated a range of IP addresses that it can give out. This section describeshow to set up that range of addresses and make them active.- Run the "DHCP Manager" program by selecting Start button, then Programs, thenAdministrative Tools.- Select "Local Machine" (double click)- Run Scope | Create... to create the range of IP addresses to manage.- Enter the start and end addresses, and subnet mask.- Change Lease Duration to Unlimited. In Name field at bottom of screen, enter description ofterminals. Select "Yes" when asked to activate the addresses.- Acknowledge status message.- Close DHCP window (x at top).
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 42© 2000, Symbol Technologies, Inc. February 1, 20004.18 Create an ODBC Data SourceThis section creates the ODBC data source that is used by the PSS software to access thedatabase. It is strongly recommended that you use the default name “PSS” for the data source.Using a different name will require you to manually edit the PSS.INI file. The PSS softwareuses the data source name in the PSS.INI file and if a matching data source is not found, thennothing will work.- Run the ODBC32 control panel applet (Select Start button, then Settings, then Control Panel,then ODBC)- Click on the "System DSN" tab- Click on the "Add..." button- Select the SQL Server driver, then click the Finish button.- Enter the following DSN information, then click on the Next button:- Name: PSS- Description: PSS Data- Server: (local)- Enter the following information on user IDs, then click the Next button:- Select the "With SQL Server authentication..." radio button- Change the Login ID: to "sa". Leave the Password blank. Click on Next.- The Create New Data Source window is displayed.- Change the default database to “PSS”, then click the Next button.- Select the "Use regional settings" checkbox.- Click the Finish button- Click on the "Test Data Source..." button to verify everything is OK.- Click on the OK button to return to the System DSN tab.- Click OK to close ODBC Data Source Administration.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 43© 2000, Symbol Technologies, Inc. February 1, 20004.19 Load Initial DataThis step will populate the PSS database with the initial data needed for the system to run. ThePSS system is very much a data-driven system. It is CRITICAL that these scripts be runcorrectly if you want the system to run properly. You can run a batch file that will run all thescripts for you (the “Automatic” method), but it requires that the database is named “PSS”. Ifyou chose to use a different name for the database, you will have to run each script manuallyusing the Query Analyzer program or edit the BAT file to use the database name you used. TheAutomatic method is the preferred method.Automatic Method- Open a command window (Start | Programs | Command Prompt)- Change to the Pss\Database folder- Run the Pss_Create_And_Init.bat file to create the PSS tables and fill them with data.- Exit the command windowManual Method- Run the Query Analyzer program (Start | Programs | Microsoft SQL Server 7.0|QueryAnalyzer)- Connect to SQLServer (click on the “…” button).- Select the “Start SQLServer if stopped” button, then click OK.- Select the PSS database from the dropdown list.- Run the following SQL files, IN ORDER, by opening them (File | Open), then executingthem by clicking on the green triangle. Pay attention to the status messages at the bottom ofthe window. The message should read “Query completed without errors” if the script wassuccessfully executed. The following SQL files are found in the C:\Pss\Database folder (bydefault):- Pss_Drop_Db.sql (deletes all existing PSS tables, so backup any existing data first)- Pss_Create_Db.sql (creates empty database tables)- Pss_Init_Data.sql (loads default data)- PosInterface_Dbinit.sql (loads POS interface settings)- PosInterface_Text_Engus.sql (loads POS text strings in US English, the default language)
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 44© 2000, Symbol Technologies, Inc. February 1, 2000- Ums_System_Settings.sql (loads Unit Management settings)- Ums_Text.sql (loads Unit Management settings in US English)- Exit Query Analyzer.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 45© 2000, Symbol Technologies, Inc. February 1, 20004.20 MS IIS ConfigurationThis step will configure the web server to recognize the PSS Service Terminal as a validActive Server Page application, and will allow access to the system from a web browser.- Select Start button, then Programs, then Win NT Option Pack, then MicrosoftInternet Information Server, then Internet Service Manager.- Expand Internet Information Server.- Expand <your machine name>- Expand default Web Site- Right click on PSS Interface - Properties. In the Virtual Directory tab, click onCreate button.- Click OK.- Exit- Save console setting message displays. Click No.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 46© 2000, Symbol Technologies, Inc. February 1, 20004.21 Obtaining Access to PSS System Administration ScreensThis step will configure Internet Explorer for easy access to the Portable ShoppingSystem Service Terminal.- Open Internet Explorer (double-click on the icon on the desktop)- If the Internet Explorer connection Wizard displays, select the “connect throughLocal Area Network” option.- When the browser window displays, select Tools, Internet Options. In the ‘General’tab, in the ‘Home page’ box, next to ‘Address:’ type in the address:http://localhost/pssinterface/index.asp, and press OK. Press the ‘Home’ button,which has an icon that looks like a house.- The System Administration Main Menu screen displays. Login with the defaultusername ADMIN, password ADMIN.- You can then access the System User account screen and setup user accounts specificto your store, as described in the PSS User Reference Guide.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 47© 2000, Symbol Technologies, Inc. February 1, 20004.22 Configure Task SchedulerThis step creates processes that must run automatically at various intervals for the properfunction of the Portable Shopping System. If these tasks are not configured correctly,certain features of the system, such as timed messaging, will not work, and the systemwill eventually cease functioning.- Double-click "My Computer" on the Windows Desktop. Once the "My Computer"window appears, locate and double-click "Scheduled Tasks".- There should be several tasks listed in the window ("Add Scheduled Task" is not atask, but will allow you to add tasks to the scheduler, if desired).- For each task:- Double-click the task, and the task dialog should appear. Make sure the Task tabis selected.- In the "Run:" and "Start in:" fields, scroll across and make sure that all of the pathnames that appear point to the correct PSS installation directory (C:\Pss).- In the "Run as:" field, enter the local Administrator account (e.g.MyMachineName\Administrator). Click the Set Password button, enter theAdministrator password in each of the two fields, and press OK.- Press OK on the task dialog.- To verify that the scheduled task can run correctly, right-click on the task, andselect Run. Scroll to the right in the Scheduled Tasks window, and make sure thatunder the Last Run Time column, the current time appears, and that under theStatus column, no error messages appear. The task can then run successfully asscheduled.- Once the procedure above has been run on all scheduled tasks, close the window.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 48© 2000, Symbol Technologies, Inc. February 1, 20004.23 Configure Unit ManagementThis step establishes the configuration of the hardware needed for PSS. The exactnumber of entries is specific for each installation, so you’ll need to know what yourhardware set up is. Use the Service Terminal screens to add entries or just directly typethem into the database using the SQL Server Enterprise Manager. If the hardwareconfiguration is a “standard” setup, then perhaps it would be wise to have an SQL filethat can be run from the Query Profiler instead of manually entering the data at eachstore. Follow the order of data entry as shown. There are relationships between thetables that require this order of creation:- Create Power Supplies- Each power supply can handle about a dozen devices. The Unit Managementlogic uses the relationship between cradles and power supplies to preventunlocking more than one cradle per power supply. Enter one row for each powersupply in the PSS system.- Create Entrances- Create a row in the UMS_Entrance table for each entry station. The Entrance IDis just a sequential number that is used to identify the Entry Station once it haslogged in. The Entry Station logs in using its MAC address (RF Entry stations) orits service name (Ex. PssEntrance01) for serial entry stations. The MAC address(or service name) needs to be entered in the Hardware ID field. If you havemultiple entrances you can set the backup entrance. The system willautomatically failover to the backup entrance when the entrance is set to Out ofService.- Create Printers- Create a row in the UMS_Printer table for each printer in the system. The PrinterID is just a sequential number that is used to identify the Printer once it haslogged in. The Printer logs in using its MAC address (RF printers) or its servicename (ex. PssPrinter01) for serial printers. The MAC address (or service name)needs to be entered in the Hardware ID field. The system will automaticallyfailover to the backup printer when the printer is set to Out of Service.- Create Dispensers- Create a row in the UMS_Dispenser table for each dispenser in the system.Dispensers are simply a logical group of cradles that are (usually) physically closeto each other. A dispenser is NOT a piece of hardware, although all the cradlesmounted on a particular piece of furniture may be called a dispenser. It is up tothe discretion of the integrator on how to best group cradles into dispensers. You
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 49© 2000, Symbol Technologies, Inc. February 1, 2000want at least one dispenser per entry station, but you may have multipledispensers per entry station. Customers are directed to a dispenser, so keep this inmind when deciding how to group cradles into dispensers. Each dispenser iscontrolled by a single entrance.- Create Cradles- Finally, create a row in the UMS_Cradle table for each cradle in the system. Thiscan be a time consuming process if you have 100 or more terminals and is a finereason to have a standard SQL script for configuring the UMS tables. Each cradlehas a location barcode sticker. Make sure that the cradle ID's you enter match thebarcodes exactly (i.e. if the barcode is a "0100", the cradle ID entered must be0100). The stickers MUST be unique, but they do not need to be sequential. Becareful to assign the correct power supply to each cradle.Note: you do not need to create rows in the UMS_Terminal table for the hand-heldterminals. As terminals login to the system, rows are automatically created.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 50© 2000, Symbol Technologies, Inc. February 1, 20004.24 Configure LicensingThis step makes the number of licenses bought for specific Microsoft products known tothe system, to avoid warnings in the NT Event Log about violations of software licenses.To do this, perform the following:- Select Start, Programs, Administrative Tools, License Manager. The LicenseManager window should appear.- From the License Manager menu, select License, New License.- Next to Product, select “Microsoft SQL Server 7.0”.- Next to Quantity, enter the number of licenses you have purchased.- Press OK.- Read the license agreement, and click on 'I agree that'.- Press OK.- From the menu, select License, New License.- Next to Product, select “Windows NT Server”.- Next to Quantity, enter the number of licenses you have purchased.- Press OK.- Read the license agreement, and click on 'I agree that'.- Press OK.- Close the License Manager.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 51© 2000, Symbol Technologies, Inc. February 1, 20004.25 Configure the NBQMAIN Service (IBM 4690 POS Only)If you chose the IBM4690 POS as your Point of Sale system, NBQMAIN service, whichis part of IBM’s Retail Connectivity Option(RCO), is a critical link between the PSSsystem and the POS. The NBQMAIN service should be configured to startupautomatically when WindowsNT starts up. It is NOT controlled by the WaveWorksSystem Controller. This section explains how to set up the service to automatically startand how to configure the service.You will need to make the NBQMAIN service auto-start at bootup. Go toStartSettingsControl PanelServices and click on the “nbqmain” entry in the list.Now click on the “Startup…” button (NOT the “Start” button). Select the Automaticstartup option and click on the OK button. Close the Services window.The startup parameters, such as the POS controller name, LANA number and heartbeatinterval are contained in the NBQMAIN.CFG file in the PSS\Bin folder. You will needto edit the NBQMAIN.CFG file to set these parameters to match your specificinstallation. Default values are provided in the file.The most likely parameter to be modified is the LANA number, which is specified withthe –a switch in the NBQMAIN parameters list. This number identifies which netbiosport to use for communication to the IBM4690 POS. The correct value for this parameteris determined as follows:From the Windows NT Start button follow the pathStartSettingsControlPanelNetwork.Select the Services tab, then double-click the NetBIOS InterfaceNote the lana number for the “Nbf” entry for the network card connected to the POSnetwork.For more information on configuring parameters for the NBQMAIN service, start a DOScommand prompt session, set your path to C:\Pss\Bin and type the command:nbqmain -?Additional information is also available in the document Retail Connectivity OptionVersion 2.2 , IBM product reference 5764-054.
PSS Software Installation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 52© 2000, Symbol Technologies, Inc. February 1, 20004.26 Setup NT System LogSelect Start, Program, Administrative Tools, Event Viewer.Click on "Log" tab.Select "Log Settings" from pulldownChnage settings for "System"In the "Event Log Settings" Window, in the event Log Wrapping Area, select "Overwrite eventsas needed"Click OKClick on Log TabSelect Exit
Configuration of the PSS System______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 53© 2000, Symbol Technologies, Inc. February 1, 20005. Configuration of the PSS System5.1 Set Up System Setting ConstantsAll system configuration data is stored in the database. A System Administration screen isincluded to provide you with the ability to adjust the configuration data for the system. You cannavigate to this screen by selecting System Settings under the System Management headingon the main System Administration screen.The Name of each configuration item relates this particular configuration item to a subsystem ofthe PSS System. The Subname provides a descriptive name for this particular item. The Valuefield displays the current setting for this field. The Description provides all the pertinentinformation explaining the use and/or settings for this item. The Unit gives the allowable rangeof values. The Default Value is the value used if no changes have been made to this item. Andthe Actions field limits the allowable actions for this particular item.Name – Subname4POSSinterface – CopyTaxTables4POSSInterface – NumberPriceBytes4POSSInterface – POSTransFileVersionActivity – InactiveTimeDisplaySize – ItemPriceDisplay Size – Total PriceImportItemData – CheckDigitExistsImport Item Data – ValidateCheckDigitPOSInterface – ExcludedDepartmentsPOSInterface – LanAdapterNumberPOSInterface – Local_TransferArea.POSInterface – POSControllerNamePOSInterface – POSControllerTypePOSInterface – ProcessedFileAreaPOSInterface – PSSItemBarcodeLengthPOSInterface – PSSTransactionTypePOSInterface –Remote_TransferAreaPOSInterface – Trace_LevelPOSInterface – UsePSSPricePOSItemFile – AddItemChkDigitPOSItemFile – FileFormatVersionPOSItemFile – FileNamePOSItemFile – FullItemFileNamePOSItemFile – MonitorInterval
Configuration of the PSS System______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 54© 2000, Symbol Technologies, Inc. February 1, 2000Name – SubnamePOSItemFile – ProcessTXPOSItemFile – PSSExpansionLengthPOSItemFile – RemoveItemChkDigitPOSItemFile – TransferEnabledPOSItemFile – TransferTimePOSItemFile – TransferTXPOSItemFile – TransferTypePOSItemFile – UserExpansionLengthPOSItemUpdate – MonitorIntervalPOSTaxFile – FileFormatVersionPOSTaxFile – FileNamePOSTaxFile – MonitorIntervalPOSTaxFile – ProcessTXPOSTaxFile – TransferEnabledPOSTaxFile – TransferTimePOSTaxFile – TransferTXPOSTaxFile – TransferTypePOSTransFile – AddCustChkdigPOSTransFile – AddItemChkdigitPOSTransFile – FileFormatVersionPOSTransFile – FileNamePOSTransFile – MonitorIntervaPOSTransFile – ProcessTXPOSTransFile – PSSExpansionLengthPOSTransFile – RemoveCustChkdigitPOSTransFile – RemoveItemChkdigitPOSTransFile – TransferEnabledPOSTransFile – TransferTimePOSTransFile – TransferTXPOSTransFile – TransferTypePOSTransFile – UserExpansionLengthPSS_Global – Barcode_TypePSS Globar – Default CurrencyPSS_Global – Default_LanguagePSS_Global – LoyaltyCardLengthPSS Global – PssVersionPSS_Global – PSS_NamePSS Global – Store NamePSS Global – Store NumberPSS Global – Trace LevelPSS Global – Transaction IDPSS File Monitor – Report Startup ConfigurationPSS File Monitor – Trace LevelPSS TransFile – AddCustCheckDigitPSSTransFile – AddItemCheckDigit
Configuration of the PSS System______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 55© 2000, Symbol Technologies, Inc. February 1, 2000Name – SubnamePSSTransFile – FileFormatVersionPSSTransFile - File NamePSSTransFile – Monitor IntervalPSSTransFile – ProcessEventPSSTransFile – PSSExpansionLengthPSSTransFile – Transfer EnabledPSSTransFile – TransferTimePSSTransFile – TransferTXPSSTransFile – TransferTypePSSTransfile – UserExpansionLengthRESCAN – ConsecNExcptBelowLvlRESCAN – DefaultDiffUnitRESCAN – DefaultInitLvlRESCAN – GlobalAllTimeoutlRESCAN – GlobalNoneTimeoutRESCAN – GlobalRescanRESCAN – IgnoreScanTooMuchRESCAN – MaxTripAmtRESCAN – MaxWeeksWithoutRESCAN – MinItemCntRESCAN – MinTripAmtRESCAN – MinItemCntNoRescanRESCAN – NewUserNeverNumTripsRESCAN – NewUserNeverSecondRESCAN – NewUserRescanRESCAN – OptionsChangeDataRESCAN – UseConsecNeverRESCAN – UseConsecNeverExceptRESCAN – UseGlobalAllTimeoutRESCAN – UseGlobalNoneTimeoutRESCAN – Use GlobalRescanOptsRESCAN – UseMaxTripAmtRESCAN – UseMaxWeeksWithoutRESCAN – UseMinItemCntRESCAN – UseMinItemCntNoRescanRESCAN – UseMinTripAmtRESCAN – UseNewUserOptsSHOPPING TRIP – CreateScanInSHOPPING TRIP – FS SUPPORTSHOPPING TRIP – FX TAXEDSHOPPING TRIP – LOYALTYSHOPPING TRIP – MAXIMUM ITEMSSHOPPING TRIP – MAXIMUM VALUESHOPPING TRIP – PRINT TICKETSHOPPING TRIP – ROUNDING METHODSHOPPING TRIP – SYSTEM CURRENCYSHOPPING TRIP – SYSTEM LANGUAGESHOPPING TRIP - Trace Level.SHOPPING TRIP – TRANSACTION BARCODE
Configuration of the PSS System______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 56© 2000, Symbol Technologies, Inc. February 1, 2000Name – SubnameSHOPPING TRIP – TRANSACTION TYPESPECIAL BARCODE – CUSTOMERENDOFTRIPSVCTERMINAl – Card PrefixSVCTERMINAL – CustomStatusStringSVCTERMINAL – UsePrintersSVCTERMINAL – UseQuickOrderTRANSTICKET – DefaultDirTRANSTICKET –DefaultPrinterTRANSTICKET – PrinterColumnWidthTRANSTICKET - Ticket Cut TypeUMS – BadScanFactorUMS – BaseFactorUMS – ChargingFactorUMS – GoodScanFactorUMS – LaserOnFactorUMS – MaxBatteryLevelUMS – MinBatteryLevelUMS – PopupTimeoutUMS – QueryTimeoutUMS – RadioXmtFactor5.2 Perform Initial Loading of Customer and Item DataBoth the IBM 4690 POS and the FileBased POS interfaces require the creation of flat ASCIIfiles of information for PSS to process. The formats and default filenames for the Item andCustomer files are documented in Appendix D of this document. Ultimately the POS shouldcreate both of these file types for PSS to process. An Example Customer file and Item file areprovided in the PSS\PosTools directory for reference. See the readme.txt file in the directory formore information on the files provided in that directory.After other configuration steps have been completed and the PSS System has been started, a setof test Customers and test items can be loaded into the system by placing the example Customerand Item files into the configured Transfer directory(C:\Pss\Transfer). The PssFileMonitorservice will detect them and trigger the WaveWorks transaction to process them and load theinformation into the PSS database.
Validation of System Operation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 57© 2000, Symbol Technologies, Inc. February 1, 20006. Validation of System Operation6.1 Testing an InstallationTests NotesOn Windows NT Controller:Start ObjectWave System Controller Services or check that they are running.Selecting /opening browser software displays PSS Main menu.Valid username / password allows login and PSS Main Menu is displayed.System Summary screen shows system available and correct hardware status.Physically check that terminals are in “ready to shop” state.Physically check that Entrance Station displays “Welcome to PSS / insert card.”Valid shopper card can check out terminal (note location terminal taken from).System Admin / Terminals screen shows that location as “empty.”System Admin / View Current Shoppers screen displays that shopper name / cardnumber.Begin Shopping Trip:Scanner Welcome screen displayed for n seconds.Opening messages display if defined.Press “+” button and scan a normal item that exists in Item File. Item should besuccessfully added and the Item Entry Screen displayed.Displays correct item description / quantity / price.Increments total quantity and dollar amount of all items.UPC #1View Shopping List Screen.Add normal item that exists in Item File (Scan barcode while pressing “+” key). UPC #2Add price-embedded item that exists in Item File. UPC #3Add normal item that exists in Item File. UPC #4View Shopping List Screen.On Shopping List Screen, scroll up and down through list.Delete normal item just added. UPC #4Add Item not in Item File (Exception Item). (Scan barcode while pressing “+” key)Displays “Exception Item” screen for n seconds, then Item Entry screen is redisplayed. UPC #5Add “restricted” item that exists in Item File. UPC #7View Shopping List Screen.Add multiple quantities of the same normal item that exists in Item File. UPC #8End Shopping Trip; verify on scanner.total value of all itemstotal number of itemsReturn scanner to cradle.Verify that scanner reads barcode location and that System Admin / Terminal screenupdates that terminal status / location.If using tickets, verify ticket total matches display on scanner.Check System Administration Screens for shopper’s Item List and Activity List; verifythat lists are correct.Check customer trip through POS register.Check System Administration Screens that shopper’s trip moves from Current toHistorical Status.
Validation of System Operation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 58© 2000, Symbol Technologies, Inc. February 1, 20006.2 Obtaining System Status Information6.2.1 Viewing The System LogThe System Log screen allows you to view detailed information on events that have occurred inthe system; for example, to determine the cause when the system is down.From the Main Menu, select System / Settings / Status / System Log.This screen displays the following information:• The dates and times that events occurred. The pages are ordered from the most currentevent to the least current.• The facility (part of the software) that performs a function. Examples are UnitManagement, Transaction Ticket, PSS File Processor, etc.• Actions performed that are specifically related to the facility, such as Terminal Returned,Print Receipt / Stub, POS transFile, etc.• Severity code from 1-4 and 10, in ascending order of severity.• Messages.This System Log screen has several filter options for limiting the data display as follows:• Display all events in a particular date / time range.• Display all events associated with a particular facility within a date / time range.• Display all events associated with a particular action and date / time range.• Display all events with a particular severity code and date / time range.• Display all events with messages containing typed-in words or phrases.• You can also display data with all of the above filter options or select a date / range andany other one or more of these options.Note: The data in the log can be limited or expanded by setting the “trace level” of a particularsystem facility (function) to a particular level. Trace levels are set in the PSS Settings screen. Ifthe trace level for the Quick Order function is set to 2, for example, the system will saveinformation at level 2 and above, but will not save errors to the log that are beneath that level.The lower the trace level, the more details on the function are saved in the log.Trace levels are displayed on the log under the title Severity Level. If problems occur with afacility of the system, you can view the severity level for that facility and decide to lower thetrace level so that future events relating to that facility will be saved in the log.
Validation of System Operation______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 59© 2000, Symbol Technologies, Inc. February 1, 20006.2.2 Viewing POS StatusThe POS Interface screen displays POS status messages and activities. These can be sorted byitem name or start date.To access the POS Status screen, from the Main Menu, select Hardware / POS Interface. Thefollowing information is displayed:• Item name (i. e., customer file, item file, etc.)• Instance name• Detection time• Start and end time• Instance value(online, restarting, open, etc.)• Instance description(errors while processing, successfully processed, etc.)
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 60© 2000, Symbol Technologies, Inc. February 1, 20007. Directory Listing of PSS Folders/FilesThis section provides a detailed listing and description of the Folders and Files that are created asa result of the PSS installation process.C:\Folders SubFolder Files DescriptionAsterix2Step This folder contains the software that isloaded on the Asterix 2 hand held scannersand the batch files which place those files intothe tftpBoot directory for retrieval by thescanners during initial introduction to thesystem or during reboot of the terminal.Bios236.hex Bios hex file used for manual download.Makebios.bat Used by makestep.bat to create .bin version ofbios.Makectrl.bat Used by makestep.bat to copy files to tftpbootdirectory.Makehex1.bat Used by makestep.bat to create hex1 hex and.bin files.Makehex2.bat Creates hex2 .hex and .bin files.Makestep.bat Transfers A2 files to the tftpBoot directory.Romdisk1.hex Hex1 .hex file used for manual download.Romdisk2.hex Hex2 .hex file used for manual download.Sendbios.bat Manual download batch file for bios.Sendhex1.bat Manual download batch file for hex1.Sendhex2.bat Manual download batch file for hex2.Astdiag Contains diagnostic files for A2.Bldtools Contains .exes used by batch files.Control Host.x file Defines which host the terminal connects to.Hex1 Contains all files associated .hex1 files.Hex2 Net.cfg Contains access point id number and otherfiles part of .hex2 files.Asterix3Step This folder contains the software that isloaded on the Asterix 3 hand held scannersand the batch files which place those files intothe tftpBoot directory for retrieval by thescanners during initial introduction to thesystem or during reboot of the terminal.MakeRFLD.bat Batch file to create .LD file from .hex.RFburn.hex hex file for RF loader (Ver 1.4) (obsolete)SendRF.bat Manual download of RF loader.Setupstp.bat Transfers A3 files to the tftpBoot folder.Bldtools Executables used by batch files.
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 61© 2000, Symbol Technologies, Inc. February 1, 2000Folders SubFolder Files DescriptionControl Host.x Defines which host the terminal connects to.ObjectWave Location of all ObjectWave-relatedarchitecture files (Refer to WaveWorksproduct documentation.)PSS The Master directory for the PSS software.Install.log Created by installation program to documentthe placement of files.Prs_tags.000Prs_tags.001 When tickets are printed to serial printers,these files convert the software commandsinto printer commands.Pss.ini Initialization file which defines the path thedatabase, as well as the login authorization.Backup varies Directory used by the installation process tokeep previous versions of files (in the eventthat regression is needed).Bin EhtService.exe STEP translator for RF entrance units.EntryStationService.exe Controls serial entrance units.nbq.bat 4690 POS install script.nbqmain.cfg 4690 POS configuration file.nbqmain.exe 4690 POS NT service.nxg.cfg Library used by IBM 4690 POSService.Nxgco.dll Library used by IBM 4690 POSService.Nxghil.dll Library used by IBM 4690 POSService.Nxgue.dll Library used by IBM 4690 POSService.posapi.dll Library used by IBM 4690 POSService.POSInterFaceCOM.exe COM object – processes POS item,transaction files.PosService.exe 4690 POS – NT service that transfersinformation between POS and PSS.PrinterService.exe Controls serial ticket printers.PssActivityCom.exe Adds shopping trip activities to activity table.PssCustomerMaintCom.exe COM object – processes POS customer file.PSSCustomerRankCom.exe COM object – performs customer rankingbased on amount spent over a specifiednumber of shopping trips.PssDBCleanupCom.exe COM object – performs database datamaintenance functions, such as removing oldshopping trips, or message log data.PssFileMaintCom.exe COM object – performs file housekeepingfunctions.PSSFileMonitorSvc.exe File monitor service.PssQOBarCodeCom.exe Processes quick order barcodes.PssShoppingTripCom.exe Performs shopping trip functions.PssSpecialBarCodeCom.exe Performs special barcode lookups.PSSSystemMessage Com.exe COM object – provides PSS SystemMessaging functionality for sending messagesat specified times.
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 62© 2000, Symbol Technologies, Inc. February 1, 2000PssTransactionTicket Com.exe COM object – provides PSS transaction ticketprinting services, in conjunction with thePrinterService.PSSUserExits.dll Stub user exit routines.PssUtilsCom.exe COM object – contains PSS utility functions.PssWebUtilityCom.dll COM object – provides WaveWorks / PSSutility services for the Service Terminal.Qexec.exe “Quietly” executes a command (no commandwindow).UnitMgmtCom.exe Provides unit management business services.Database InsertA2EntranceServices.sql Adds serial entrance services to the WWdaemon table.InsertA2PrinterServices.sql Adds serial printer services to the WWdaemon table.InsertA3EntranceServices.sql Adds RF entrance service to the WW daemontable.InsertAdmProcesses.sql Adds startup / shutdown entries to the WWprocess table.InsertPssServices.sql Adds standard PSS services to the WWdaemon table.InsertServiceTerminalPrinterService.sql Adds the service terminal printer service tothe WW daemon table.POSINTERFACE_DBINIT.SQL Initializes POS interface system settings.POSINTERFACE_TEXT_ENGUK.SQL UK English version of messages written bythe POS interface to the system log (loadstables PSS Text).POSINTERFACE_TEXT_ENGUSA.SQL USA English version of messages written tosystem log by POS interface.pss_count.sql SQL script that lists a count of records foreach table in the PSS database.PSS_Create_And_Init.bat Batch file that runs all of the scripts necessaryto create and initialize the database for ageneric PSS system.pss_create_db.sql SQL script to create the PSS database tables.pss_delete.sql SQL script to delete all of the data from thePSS database tables.PSS_Delete_And_Init.bat Batch file that runs all of the scripts necessaryto delete the existing data and reinitialize thedatabase for a generic PSS system.pss_drop_db.sql SQL script to delete all of the PSS databasetables.pss_init_data.sql SQL script to initialize most of the necessarysettings and text for the generic PSS system.pss_init_text_2.sql SQL script containing text for the English –UK language.pss_init_text_3.sql SQL script containing text for the Frenchlanguage.pss_init_text_4.sql SQL script containing text for the Dutchlanguage.PSS_SYMBOL.ER1 ERwin database model of the PSS database.UMS_System_Settings.sql Adds UMS constants to system settings.UMS_Text.sql Adds UMS text strings to text table in USEnglish.
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 63© 2000, Symbol Technologies, Inc. February 1, 2000Folders SubFolder Files DescriptionUmsCleanup.sql Sets all UMS devices to “logged out” atstartup / shut down.UpdateOwave.bat Generic update batch file that runs an SQLscript on WaveWorks database.Logs Ess01.tr1 Trace file for entrance units which use serialcommunications.Prs01.tr2 Trace file for printers which use serialcommunications.Print Temporary holding location for transactionticket print files.Processed Holding directory for files received from POSafter processing by PSS. (Note: this directoryname and the filenames identified below areconfigurable to accommodate POS systems;the names listed are the default entries.)Shopping transaction files:cardnumber_yyyymmddtttt_PSS completedwhere yyyy = year, mm = month, dd = day andtttt = time; this is the PSS shoppingtransaction as scanned by the customer.cardnumber_yyyymmddtttt_POS.completedwhere yyyy = year, mm = month, dd = day andtttt = time; this is the POS shoppingtransaction as completed at the register.Item files:PLUNW.PSS - a full item (price look up) filetransfer.PLUMTnn.PSS – a partial (maintenance) itemfile update, where nn is a sequential numberreset each day.Customer files:CUSTMTnn.DAT – a maintenance update tothe customer data file.StepDev Files with an .sws extension are links betweenCOM Objects and transaction Ids. Files withan .swv extension are ScreenMaker interfacefiles.DiManager.swv Display interface manager interface.EHT.swv RF entrance interface.ExpressShopper.swv Interface for express shopper.
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 64© 2000, Symbol Technologies, Inc. February 1, 2000install.bat Batch file run to install scripts to (base)WaveWorks database.MainMenu.swv Initial interface that launches either UMS orshopping trip.PosInterface.sws Associates WaveWork transactions with COMmethods that perform POS interface functions.Pss.swp Used by ScreenMaker.PssActivityCom.sws Trans IDshopping activity log functions.PssCustomerMaintCom.sws Trans IDcustomer download function.PssCustomerRank.sws Trans IDcustomer ranking function.PSSDbCleanup.sws Trans IDdatabase cleanup function.PssFileMaintCom.sws Trans IDCOM methods that perform filehousekeeping.PssQOBarcodeCom.sws Trans IDquick order barcode functions.PssShoppingTripCom.sws Trans IDshopping trip functions.PssSpecialBarcodeCom.sws Trans IDspecial barcode functions.PssSystemMessage.sws Trans IDprocess system messages function.PssTimerCom.sws Debug tool for shopping trip.PssTransactionTicket.sws Trans IDtransaction ticket printing function.PssUtilsCom.sws Trans IDutility function.QuickOrder.swv Quick order interface.release.ini List of multiple .sws and .swv files to install.ShoppingTrip.swv Shopping trip interface.sminstall.exe Installs .sws and .swv files.UMS.sws Trans IDUMS COM methods.UMS.swv UMS interface.update.bat (customer specificdata) Batch file used to change base script or addnew ones.update.ini (customer specificdata) List of files to update for a customer.Transfer The holding location used by the PSS andPOS for exchanging files (i.e. both systemsread from and write to this directory). Undernormal conditions, files reside here onlytemporarily.Web All *.asp files are Active Server Pages.admincradles.asp Administer cradle hardware.admindispensers.asp Administer dispenser hardware.admineditterminal.asp Edit terminal settings / status.adminentrances.asp Administer entrance unit hardware.administer.asp Presents the service terminal menuing system.adminpageactions.asp Administers authenticated service terminalpage actions.adminpages.asp Administers authenticated service terminalpages.adminpos.asp View and administer point-of-sale systemstatus.adminpowersupplies.asp Administer power supply hardware.adminprinters.asp Administer printer hardware.adminservices.asp Administer PSS NT service components.adminterminals.asp Administer terminal hardware.adminusers.asp Administer service terminal users.
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 65© 2000, Symbol Technologies, Inc. February 1, 2000Folders SubFolder Files Descriptionfielddate.inc Script file to present a standard date inputfield.fieldtime.inc Script file to present a standard time inputfield.global.asa Active Server Page application file that setsup database connections for the PSS serviceterminal.index.asp Redirects the service terminal to theappropriate first page.index.html Redirects the service terminal to theappropriate first page.issueterminal.asp Issues a hand-held terminal to a customer anddisplays the location of the terminal.keyboard.asp Displays an on-screen keyboard for use withterminals without keyboards (currentlyunused).login.asp Presents a user login prompt and performsuser authentication.lookupuser.asp Looks up a customer by account details.pss.css Cascading Style Sheet file to create consistentpositioning and font formatting throughout thePSS service terminal.pssdatatableend.inc Active Server Pages script file to manage theportion of a data table after the data isdisplayed.pssdatatablestart.inc Active Server Pages script file to manage theheader and retrieval of data for a data table.pssfunctions.inc Active Server Pages script file containingnumerous functions for use throughout theservice terminal.psstatus.inc. Active Server Pages script file to calculate thecurrent status of the Portable ShoppingSystem.quickorder.asp Displays an individual quick order in thequick order frames page.quickorderframes.asp Displays multiple quick orders.quickorderheader.asp Manages display of multiple orders on thequick order frames page.registeruser.asp Creates or administers PSS customers.sendmessage.asp Sends ad hoc messages to PSS customers, ordefines and schedules system messages.systemproblems.asp Views any current problems with PSS.systemsummary.asp View an operational summary of PSS.unabletoissue.asp Displays errors in issuing a terminal to acustomer.viewdepartments.asp View the configured item departments.viewitemdetails.asp View the details of a particular item.viewitems.asp View the currently configured items.viewmarketing.asp View and administer the currently configuredmarketing messages.
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 66© 2000, Symbol Technologies, Inc. February 1, 2000viewmessagelist.asp View the currently configured systemmessages.viewmessagelog.asp View the PSS system log.viewnlstext.asp View the currently configured language-dependent text.viewopeningmessages.asp View the currently configured openingmessages.vieworderitems.asp View the items selected for a particular quickorder.vieworders.asp View the currently entered quick orders.viewreportrescan.asp View the Shopper Rescan Report.viewreportsales.asp View the Sales Report.viewreportshoppersummary.asp View the Shopper Summary Report.viewreportterminals.asp View the Hand-Held Terminal Report.viewreportunknownitems.asp View the Unknown Item Report.viewrescanresults.asp View the results of rescans in a particularcustomer’s historical shopping trips.viewrescansettings.asp Administer the PSS Rescan systemconfiguration.viewshoppers.asp View and administer the customers currentlyusing PSS.viewshoppingactivities.asp View the activities that occurred during aparticular customer’s current or historicalshopping trip.viewshoppingitems.asp View the items selected for purchase during aparticular customer’s current or historicalshopping trip.viewshoppinglists.asp View the list of a particular customer’scurrent, historical, and incomplete shoppingtrips.viewsystemsettings.asp View and administer PSS system settings.viewtaxtableentries.asp View the entries for a particular PSS tax table.viewtaxtables.asp View the list of PSS tax tables.viewterminallist.asp View a terminal issue list of terminalsavailable by dispenser.viewusersummary.asp View a particular customer account summary.Web – Images various Contains graphics files that are usedthroughout the Service Terminal application(e.g., the red, yellow and green traffic light onthe Main Menu.)Working Where files reside while the PSS software isprocessing them.TftpBoot Location of software files which aredownloaded to hand held terminals when theyboot.TftpServer Service that provides for file transfers.D:\ (database repository)
Directory Listing of PSS Folders/Files______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 67© 2000, Symbol Technologies, Inc. February 1, 2000Folders SubFolder Files DescriptionMssql7 varies Location of all database tables, in Microsoft SQLServer format.7.1 Scheduled TasksFolders SubFolder Files DescriptionC:\Winnt\Tasks Repository for time-based tasks to be defined andscheduled.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 68© 2000, Symbol Technologies, Inc. February 1, 20008. Software DescriptionThe subsystems included in the WaveWorks PSS system may consist of any combination of thefollowing:COM Objects Contain methods invoked via WaveWorks transactions. Managedby the Message Server.NT Services Contain methods invoked via WaveWorks transactions. Usuallystarted at system startup.StepServer Scripts Manage the user interface and screen flow for the hand heldterminals. Maintain client data variables. Invoke business services(COM object methods) via WaveWorks transactions.8.1 PSS Transaction IDs / COM Object Method ListingThe following tables list the transactions used to perform business logic, the methods which areinvoked, and the input and output parameters.POSInterfaceTransaction ID Method Name Input Parameters Return ParametersP2P002 LoadPOSTransaction FilePath ResultP2P003 LoadPOSItemFile FilePath ResultP2P005 LoadTaxTable FilePath ResultPOS100 POSstartup ResultP2P103 POSSItemFileTransfer ResultP2P199 FileTransferNoOP ResultP2P304 EnableItemUpdatesP2P404 DisableItemUpdatesPOS300 POSLogin PosVersionTransactionCheckIntervalItemUpdatesCheckIntervalCopyTaxTablesWithItemsPSSTransactionTypeNumberPriceBytesLoyaltyCardnumLengthLANAdapterNumberTransferAreaPathPOSControllerNameResultPOS301 SetCommLinkStatus LinkStatus Result
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 69© 2000, Symbol Technologies, Inc. February 1, 2000PSSActivityTransaction ID Method Name Input Parameters Return ParametersPSA010 PssActivityAdd CustomerIdShoppingListIdActivityIdDetailTextRetValuePSSSpecialBarcodeTransaction ID Method Name Input Parameters Return ParametersPSP001 Refresh RetValuePSP010 PssGetBarCodeType InputBarcodeTerminalId ItemIdActionBarcodeTypeRetValuePSSQOBarcodeTransaction ID Method Name Input Parameters Return ParametersPSQ010 GetMaxQONumber CustomerIdShoppingListId QONumberRetValuePSQ020 PssQOBarCode CustomerIdShoppingListIdPreviousQONumberPreviousItemIdCurrentBarcodeActionPreviousDepartmentIdThisItemIdThis ItemNameThisItemUnitThisItemDepartmentIdThisItemQtyThisQONumberRetValuePSQ030 PssQOSend CustomerIdShoppingListIdQONumber RetValuePSQ031 PssQOQuit CustomerIdShoppingListIdQONumberRetValuePSQ040 PssQOGetTotalQty CustomerIdShoppingListIdQONumberTotalQuantityRetValuePSQ050 PssQOListItems CustomerIdShoppingListIdQONumberItemNamesItemUnitsItemQtyRetValue
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 70© 2000, Symbol Technologies, Inc. February 1, 2000PSSShoppingTripTransaction ID Method Name Input Parameters Return ParametersPST001 CreateShoppingList TerminalIdCustomerId RetValuePST003 SwapTerminal TerminalIdCustomerId RetValuePST004 ValidateCustomer CardNumber OutputCustomerNameLanguageIdGreetingCustomerIdResultPST005 PssSessionSwitch TerminalIdInputBarcodeCustomer IdShoppingListIdNewCustomerIdNewShoppingListIdSessionStatusRetValuePST007 GetSessionData TerminalIdCustomerIdShoppingListIdResultPST008 GetShoppingTripType TerminalIdTripType RetValuePST010 StartShoppingTrip TerminalId CustomerIdShoppingListIdCustomerNameCustomerLanguageIdCustomerCurrencyIdRescanLevelStoreNumberRetValuePST020 AdjustShoppingItemData InputBarcodeCustomerIdShoppingListIdItemQuantityListValueActionCustomerCurrencyIdTerminalIdCMSNameCMSApplicationTerminalGroupItemDescriptionItemPriceItemCountTotalValueTotalCountMsgEmbeddedPriceItemRetValuePST025 SetShoppingListStatus CustomerIdShoppingListIdShoppingListStatusRetValuePST030 GetShoppingList CustomerIdShoppingListIdCustomerCurrencyIdItemPriceItemQuantityItemDescriptionItemIdEmbeddedPriceTotalValueStringTotalValueIntItemCountRetValue
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 71© 2000, Symbol Technologies, Inc. February 1, 2000PST035 GetDisplayTotalByCurrency CustomerIdShoppingListIdCustomerCurrencyIdCurrencyIndexCurrencyIndexDisplayTotalResultPST038 AdjustShoppingList ItemIdCsutomerIdShoppingListIdItemQtyActionTerminalIdCmsApplicationStartIndexNumberOfItemsItemDescriptionItemPriceItemCountTotalValueTotalCountMsgEmbeddedPriceItemItemIdMsgFlagsRetValuePST040 GetStoreInformationalMessage CustomerIdShoppingListId Text MessageRetValuePST041 GetCustomerMessage CustomerIdShoppingListId Text MessageRetValPST042 GetElectronicMarketingMes CustomerIdShoppingListIdItemIdTerminalIdCMSNameCMSApplicationTerminalGroupTextMessageResultPST043 GetCustomerCardNumber CustomerID CardNumberResultPST100 EndShoppingTrip CustomerIdShoppingListIdTerminalIdTerminalLocationRescanLevelRescanRetValuePST102 DeleteShoppingList TerminalId RetValuePST104 DetermineEndShoppingTrip CustomerIdShoppingListIdTerminalIdTerminalLocationRescanLevelRescanResultPST200 GetExpressCustomer CustomerIdResultPST999 RefreshTransactionTicketTransaction ID Method Name Input Parameters Return ParametersPST101 PrintTicket CustomerIDShoppingTripIDTransactionTypePrinterServiceRetValuePSSSystemMessage
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 72© 2000, Symbol Technologies, Inc. February 1, 2000Transaction ID Method Name Input Parameters Return ParametersPST103 ProcessMessages RetValue
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 73© 2000, Symbol Technologies, Inc. February 1, 2000PSSUtilsTransaction ID Method Name Input Parameters Return ParametersPSU001 GetText TextIdCustomerLanguageId TextMsgRetValuePSU002 GetTextWithParms TextIdCustomerLanguageIdTextParametersTextResultPSU003 GetInActivityTimeoutString InactivityIndex InactivityStringResultUnitMgmtTransaction ID Method Name Input Parameters Return ParametersUMS001 ReserveBestTerminal EntranceId TerminalIdDispenserIdCradleIdDispenserNameResultUMS002 TerminalIssued TerminalId ResultUMS003 TerminalReturned TerminalIdLocationIssueTimeReturnTimePlusScansMinusScansFailedScansResultUMS004 TerminalTimeout TerminalId ResultUMS005 TerminalLogin TerminalIdLocationTerminalTypeResultUMS006 TerminalLogout TerminalId ResultUMS007 GetTerminalStatus TerminalId StatusCodeStatusTextStatusTimestampResultUMS008 SetTerminalStatus TerminalIdStatusCodeReasonResultUMS009 ResetTerminalStatistics TerminalId ResultUMS010 GetTerminalTypeInfo TerminalType TerminalClassDefaultInterfaceDisplayRowsDisplayColumnsKeypadTypeResultUMS011 GetCurrentInterface TerminalId InterfaceNameResultUMS012 SetCurrentInterface TerminalIdInterfaceName ResultUMS013 UpdateBatteryLevels Result
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 74© 2000, Symbol Technologies, Inc. February 1, 2000UMS014 SetBatteryStatus TerminalIdBatteryStatus ResultUMS020 ReleaseTerminal TerminalId ResultUMS021 RebootTerminal TerminalIdBootType ResultUMS022 UnlockTerminal TerminalId ResultUMS023 QueryTerminal TerminalId LocationResultUMS024 ResetTerminalSession TerminalId ResultUMS025 SetTerminalUnlockMode TerminalIdUnlockMode ResultUMS026 TestCardReader EntranceId CardDataResultUMS027 ReportBatteryCondition TerminalIdBatteryCondition ResultUMS028 UpdateTerminalLocation TerminalIdLocation ResultUMS100 EntranceLogin HardwareIdStatusCode EntranceIdModeResultUMS101 EntranceLogout EntranceId ResultUMS103 SetEntranceStatus EntranceIdStatusCode ResultUMS104 GetEntranceMode EntranceId ModeReturnUMS105 UpdateEntranceModes ReturnUMS106 GetEntranceConfig EntranceId ReaderTypeReaderPortDisplayTypeDisplayPortPopupTimeoutCardLengthReturnUMS107 ProcessCardData EntranceIdRawData CardNumberCardStatusReturnUMS108 GetDispenserCounts DispenserId TotalCountIssueCountChargingCountUnavailCountOtherCountReturnUMS200 PrinterLogin HardwareIdPrinterStatus PrinterIdResultUMS201 SetPrinterStatus PrinterIdPrinterStatusReasonResultUMS202 GetPrinterConfig HardwareId PrinterTypePrinterPortReturnUMS999 Refresh N / A ReturnPSSCustomerMaint
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 75© 2000, Symbol Technologies, Inc. February 1, 2000Transaction ID Method Name Input Parameters Return ParametersP2P006 LoadFromFilePSSFileMaintenanceTransaction ID Method Name Input Parameters Return ParametersP2P201 CleanupPssTransFileP2P298 CleanupArchiveAreaP2P299 ConvertSltoSOPSSDbCleanupTransaction ID Method Name Input Parameters Return ParametersPST105 PerformDBCleanupPSSCustomerRankTransaction ID Method Name Input Parameters Return ParametersPST106 RankCustomers
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 76© 2000, Symbol Technologies, Inc. February 1, 20008.2 Unit Management SubsystemThe Unit Management Subsystem (UMS) manages the Symbol hardware devices that comprisethe PSS system. Those devices include hand held terminals, cradles, entrance unit devices, ticketprinters, and power supplies. Since UMS manages hardware, it is important to understand eachof the devices being managed in both the Asterix2 and Asterix3 versions of PSS.8.2.1 Hardware OverviewTerminalsThe PSS system only uses RF terminals. PSS can use either Asterix2 or Asterix3 terminals. TheAsterix2 terminal has five buttons and a 4 x 20 display. The Asterix3 terminal has four buttonsand a trigger (in lieu of the “+” key on the Asterix2), and an 8 x 20 display. Both terminal typescharge their batteries while in the cradle, but since the Asterix3 uses a newer lithium battery, thebattery-related constants are different for the two terminals.CradlesThe cradles are completely different between the Asterix2 and Asterix3 systems. The Asterix2terminals are placed into an integrated eight-slot rack, and as a result, the entire system iscomprised of terminals in multiples of eight. When the Asterix2 is unlocked, a small light on theface of the terminal is lit. The Asterix3 cradles are individual units, and the entire system caninclude any desired number of terminals. When the Asterix3 is unlocked, the cradle housinglights up. The Asterix2 cradle locks the terminal tightly against the contacts. The Asterix3cradle does not--which causes a number of issues, since the terminal can be lifted off the contactsbefore the latch stops it.DispensersIn a typical Asterix2 system a module was a large plastic device that had eight integrated cradles.Four modules were a unit. A dispenser in the Asterix2 world consisted of one or more modules.The Asterix3 system uses individual cradles that can be physically arranged however thecustomer wishes. An Asterix3 dispenser is simply a logical group of cradles (that are usuallyphysically adjacent to each other).The concept of a dispenser being a logical group of cradles also works for Asterix2 systems aslong as the cradles in the same module are part of the same dispenser (to avoid confusing thecustomer). So, in this document, a dispenser is really a collection of cradles, not a physicaldevice.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 77© 2000, Symbol Technologies, Inc. February 1, 2000EntrancesThere are two types of entrance stations: serial and RF. Either type can be used with eitherterminal type, but the older serial entrance units are typically used on Asterix2 systems and thenewer RF entrances are used with the Asterix3 terminals. The primary difference between themis how they are controlled from the host.The serial entrance units are controlled by NT Services (one service per entrance unit). Theseservices are named “PssEntrance01,” “PssEntrance02,”, etc. These services are WaveWorksclients and directly control the entrance display and process input. The RF entrance unitscommunicate with a single instance of an NT service (EhtService) that translates STEPcommands into low-level commands the hardware can understand. DisplayServer scripts handlethe screen display and input processing.PrintersTransaction tickets are (optionally) printed at the conclusion of a self-scan shopping trip. Theticket is used to direct the shopper to a quick pay or rescan lane and also as a means ofidentifying the shopper to the POS system. Transaction tickets are an optional feature of the PSSsystem. PSS supports three types of ticket printers: RF rack, serial rack, and serial serviceterminal. For installations that do print tickets, a printer is needed at the return rack and at theservice terminal.Power SuppliesThe PSS system also manages power supplies. There isn’t much to manage aside from ensuringthat only one terminal per power supply is unlocked at a time. Unlocking more than oneterminal at a time could cause the power supply to fail. Power supplies normally have a status ofReady (status code = 0). If a terminal that is powered by the power supply is being unlocked, thestatus is set to Reserved (status code = 1). If all the terminals attached to a power supply reportthat they are on battery power, then the power supply status is set to “Check Hardware” (statuscode = 6) to indicate that perhaps the power supply has failed or is unplugged.8.2.2 Software ComponentsThe Unit Management subsystem consists of the following software:Unit Management COM objectprovides all the UMS business services. The servicesmaintain data on hardware status, battery level, and terminal location. The services also sendcommands to the hand held terminals while they are in the dispenser. The UMS transactionmodel (description of all UMS transactions) is found in the Appendix.Entry Station Serviceuses PSA’s Hardware Isolation Library (HIL) to communicate with theEntrance Station hardware devices (serial entrance stations only).
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 78© 2000, Symbol Technologies, Inc. February 1, 2000Printer ServiceUses PSA’s Hardware Isolation Library (HIL) to communicate with seriallyconnected printers.UMS DisplayServer Interfacecontrols the display on the hand held terminal and alsoprovides procedures for handling input from the terminal and commands the UMS COM object.EHT DisplayServer Interfacecontrols the display on RF entrance units and providesprocedures for handling input from the entrance.8.2.3 Database AccessThe Unit Management COM object maintains the following database tables. Refer to the DataDictionary in the Appendix for a description of the tables:UMS_Entrancemaintains state information on entrance unit devicesUMS_Printermaintains information on printer devicesUMS_Terminalmaintains information on hand held terminalsUMS_Dispensermaintains information on dispensers (groups of cradles)UMS_Status_Codelist of valid status codes for UMS devicesUMS_Terminal_Typeslist of valid terminal typesUMS_Cradlemaintains information on terminal cradlesUMS_Powermaintains information on power suppliesUMS_Card_Reader_Typemaintains a list of supported card reader types and properties
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 79© 2000, Symbol Technologies, Inc. February 1, 20008.3 Shopping Trip SubsystemOnce the shopper retrieves the proper hand held terminal from the dispenser, the Shopping TripSubsystem allows the shopper to add and delete items from their basket and view the totalamount and number of items scanned during their current shopping trip. Shopping trips can beended by returning the hand held terminal to an empty dispenser slot or by scanning an “End ofTrip” barcode. Each activity during the shopping trip is logged and available for review from theService Terminal.8.3.1 Start of Shopping Trip ProcessingWhen a customer “swipes” their card to reserve a scanner to go shopping, the system willperform the following:1. ValidateCustomerverifies the following:• that the customer is in the Pss_Customer database table and is not suspended;• that the customer has no outstanding transactions (in the Pss_Shopping_List table), and• that the card has no current shopping trips (in the Pss_Session table).2. CreatShoppingListinitializes the tables Pss_Shopping_List, Pss_Session, andPss_Shopping_Activity.3. StartShoppingTripoccurs at removal of the scanner from the dispenser.4. GetTextretrieves all text necessary for display to the shopper (in the shopper's language).8.3.2 Shopping Trip ProcessingFor Asterix 2 terminals, the "+" key is a physical key on the scanner; for the Asterix 3 terminals,the "+" key is the trigger. The "-" key is a physical key on either terminal.After the shopper scans a barcode, the following steps are taken in the StepServer Scriptprocedure ProcessInputData to process the barcode:1. Parse the barcode• A call to PssSpecialBarcode to break up the scanned input field into its disparate parts• Modifications to the barcode from what was reported as scanned to what is needed tocompare into the item table• Determination of whether a barcode is a “special” barcode that requires special handling(e.g. the End of Trip barcode)2. If, in the output from the above method, a “special” barcode is encountered, it is specificallyhandled
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 80© 2000, Symbol Technologies, Inc. February 1, 20003. If, in the output from the above method, an item barcode is scanned, then theAdjustShoppingList method is called to add or delete the scanned barcode from the customer'sshopping list. Any anomalous output from this method is handled via error screen displays (i.e.,exception items, invalid barcodes).The following is the database activity for a "+" or "-" key event:1. Retrieve customer data from Pss_Customer table.2. Verify input barcode.3. Determine if it is a variable weight barcode using the Pss_Barcode_Variable_Weight- if variable weight, get the price and item Id- else use the scanned barcode and data from the Pss_Item table to execute the pricingalgorithm4. Add the item to the shopping list ("+") or remove the last scanned match for this item id ("-") inthe Pss_Shopping_Item.5. Calculate the total tax from the Pss_Tax_Table and Pss_Tax_Table_Entry and write the value toPss_Shopping_Tax.6. Read for marketing messages from the Pss_Marketing_Item, Pss_Marketing_Department, andthe Pss_Marketing_Mfg tables and write to the Pss_Marketing_Sent table any messages sent tothe shopper.7. Convert pricing values using the Pss_Currency table.8. Write the total to the Pss_Shopping_List table.9. Record the event into the Pss_Shopping_Activity table.Anomalous conditions encountered in this process will be logged to the Pss_Message_Log table.If the scanned item Id is not in the Pss_Item table, then record this in the Pss_Uknown_Itemtable.All text used throughout the shopping trip is stored in the Pss_Text table and is accessed througha language Id associated with the customer or store.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 81© 2000, Symbol Technologies, Inc. February 1, 2000Describe what happens when a customer presses the “=” key to view the summary.The shopper presses the "=" key, and in the StepServer script procedure ProcessInputData, a callto one of the ShoppingTripList functions is made. This will return character strings with itemIds, descriptions, and prices (see COM object definitions for full parameter list). These stringswill contain all items currently in the customer's basket in a pipe-separated format. The lists arecontrolled through the pss_system_setting database table. Based on these settings, display fieldsize, list order (ascending or descending), and contents of the list are established for consistentdisplay to the shoppers. All database access is “read only,” with the exception of an insert intothe Pss_Shopping_Activity table to record the event.The following libraries and COM Objects are available for the shopping trip subsystem to use:PssActivityCom COM object interface that allows activities to be added to thePss_Shopping_Activity database table to record shopper key presses and any otherevent.PSS ActivityLib This library handles the database insert, deletion, and retrieval ofPss_Shopping_Activity database table rows.PssBarcodeLib Library that interprets the barcodes scanned by the shopper. Has methods tocalculate and strip off check digits, determine barcode type (i.e., UPC, EAN13),etc.PssConfigurationLib Library used to access the database table Pss_System_Settings that contains theclient-selected configuration options.PssPricingLib This library provides the core of the pricing method algorithms as defined in theappendices.PssShoppingTripLib Library that handles the database insert, deletion, and retrieval ofPss_Shopping_List and Pss_Shopping_Item database table rows.PssShoppingTripCom This is the COM object interface allowing• shopping trips to be started,• items to be added and removed from shopper’s lists,• lists to be formatted for shopper review,• shopping trips to be ended,• as well as a series of general support functions (such as validating thecustomer, retrieving shopper messages of various sorts, andmaintaining the status of the current shopping trips).PssSpecialBarcodeCom This is the COM object interface to allow access to the special barcode functions,determining if the scanned barcode requires modification or requires specialhandling methods.PssSpecialBarcodeLib Library to access the Pss_special_Barcode table that contains definitions of allspecial barcodes, descriptions, and return types for StepServer script statementhandling.In general, the COM Objects handle the interface to the StepServer Scripts and perform thebusiness logic and the libraries provide access to the persistent data.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 82© 2000, Symbol Technologies, Inc. February 1, 2000The following user exits are called during shopping trips:UE_PreRescanDetermination Allows modification of the rescan calculation data prior to thecalculation, or allows wholesale replacement of standard rescancalculation with a customized algorithmUE_PostRescanDetermination Allows modification of the result of a standard rescan calculationUE_PreProcessMarketingMessage Allows additional item marketing messages to be allowed /disallowed prior to the standard method’s retrievalUE_PrintReceipt On End of Trip, allows modification to the receipt file to be printedon the ticketUE_PostProcessIsVariableWeight After an item has been determined to be an embedded price / weightitem (or not), custom code can be added here to modify the decision.If using the End of Trip barcode feature, configure any type of barcode with a check digit to bethe End of Trip barcode. The Pss_Special_Barcode table should contain the End of Trip value.8.3.3 End of Shopping Trip ProcessingThis can happen in one of two ways depending upon the Pss_system_Settings database tablevalues. Either the shopper scans a predetermined End of Trip barcode (as specified in thePss_Special_Barcode table) or places the scanner back into the dispenser.If an End of Trip input is recognized (either an “E” from the dispenser, or and End of Tripbarcode), the StepServer script procedure EndOfTrip is executed. This simply calls thePssShoppingTripCOM object method EndShoppingTrip and then handles the resetting of theshopping list status (if the scanner was in Queue Buster mode), then proceeds to the final ThankYou screen.Within the EndShoppingtrip method, the following is done:1. The customer data and shopping trip data are examined to determine if the trip is to be rescannedor not.2. The transaction barcode is calculated.3. If enabled, the PssTransferFile is written with the list of items scanned by the shopper.4. If enabled, the printer is requested to print the transaction ticket.5. Customer and Shopping Trip data and status are updated.6. Session data is deleted or modified if in queue buster mode.7. Data in the database tables related to the shopping trip are deleted, such as Pss_Order_List_Item,Pss_Order_List, Pss_Marketing_Sent and Pss_Shopping_Tax.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 83© 2000, Symbol Technologies, Inc. February 1, 2000Database tables associated with the shopping trip are:Pss_CurrencyPss_CustomerPss_LanguagePss_TextPss_Shopping_ListPss_SessionPss_Shopping_ItemPss_Shopping_ActivityPss_Shopping_TaxPss_Tax_TablePss_Tax_Table_EntryPss_Unknown_ItemPss_ItemPss_System_SettingPss_Message_LogOther objects such as classes need to be defined:PssStoreInformationPssSpecialBarcodeSessionLanguage TextActivityCustomerCustomer RescanEvent Scheduler8.3.4 Shopping Trip Message Log EntriesThis describes the log messages found in the Pss_Message_Log table that originated within theShopping Trip. The text shown here is in English, since the inclusion of all language text for allmessages would be excessive. This text is configurable in the database table Pss_Text, so if amessage is not here or not exactly as stated here, then the database table probably has changed.All text is accessed through the GetText method, which accepts the Text_Id as an inputparameter.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 84© 2000, Symbol Technologies, Inc. February 1, 20008.3.5 Fatal Messages:“No Session for this Terminal (%s)”ST_TEXT_NOSESSION - Attempted to start the Shopping trip without associating acustomer with a terminal. Verify that CreateShoppingListcompleted successfully prior to calling StartShoppingTrip.“No Customer Data”ST_TEXT_NOCUSTOMER - Customer's card does not exist in the database.“Initialization FAILED(%s)”ST_TEXT_INITFAILED - Could not initialize Pss_System_Setting configuration data fromdatabase – Methods may not be executing along desired paths.“No Express Customers Available”ST_TEXT_NO_XCUSTOMERS - No more Express Shopper customers available for expressshopper to use. Add more to the database.“Unable To Access Express Customers Data”ST_TEXT_NO_ACCESS_XCUSTOMERS - Database error accessing Express Shopper customers.8.3.6 Error Messages:“Activity Add”ST_TEXT_ACTIVITY_ADD - Failure to add an activity to the Pss_Shopping_Activitytable. Generally when the shopping trip does not startproperly, there is an invalid key constraint problem.“Invalid Customer Data associated with terminal (%s)”ST_TEXT_INVALIDCUSTOMER - Invalid Customer Id, not found in database. Verifycustomer exists in database.“Invalid Get Rescan data for customer (%s)”ST_TEXT_INVALIDRESCANDATA - Failure getting customer rescan data. Verify customerexists in the database and has valid rescan level andaccurate trip counters and rescan counters in thePss_Customer table.“Invalid Sub Total for Customer (%s)”ST_TEXT_INVALIDSUBTOTAL - Had an error calculating total for customer”s shoppingtrip. Verify values for this customer in the database.“Invalid Customer (%s) Save Recalced Prices”ST_TEXT_BADSAVEPRICES - Database error saving pricing data to the customer”sshopping list."UE_PreRescanDeterminationGENERATED TRAP!!!do NOT rescan”ST_TEXT_USEREXITERROR- Error in the user exit for determination of rescan.Rewrite the user exit without the problem causing theabnormal execution.“Invalid Rescan Determination for Customer (%s)”ST_TEXT_RESCANDETERMINATION - Error in determining whether to rescan a customer.Verify customer rescan data in Pss_Customer andPss_rescan tables are consistent."UE_PostProcessRescanDeterminationGENERATED TRAP!!! – do NOT rescan"ST_TEXT_USEREXITERROR-Error in the user exit for determination of rescan.Rewrite the user exit without the problem causing theabnormal execution.“UE Post CalculateRescan”ST_TEXT_USEREXITERROR - Error in the user exit for determination of rescan.Rewrite the user exit without the problem causing theabnormal execution.“UE Pre CalculateRescan”ST_TEXT_USEREXITERROR - Error in the user exit for determination of rescan.Rewrite the user exit without the problem causing theabnormal execution.“Invalid Customer (%s) Rescan Update”ST_TEXT_UPDATERESCAN - On end of trip, could not update customer”s rescandata in the Pss_Customer table with latest data.“Invalid Calculate Transaction Id for Customer (%s)”ST_TEXT_TRANSACTIONID - Could not calculate correct transaction Id. VerifyPss_System_Settings (for Shopping_Trip Loyalty Cardand Transaction barcode) are proper for this customer.“Invalid Saving End of Trip Data for Customer (%s)”ST_TEXT_SAVE_EOT - Error saving shopping trip and/or customer data forend of trip.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 85© 2000, Symbol Technologies, Inc. February 1, 2000“Invalid Writing SCAN-IN %d”ST_TEXT_WRITESCANIN - Error writing scanIn (PssTransferFile). Check for diskspace availability, existance of proper directories andpermissions to create files there.“Cannot unload list items for Customer (%s)”ST_TEXT_UNLOAD - Error-freeing memory used to store local copyofshopping list.“Invalid Getting Printer CMSID ReturnCode, Customer%s”ST_TEXT_INVALIDPRINT- Error printing transaction ticket. Verify printer andconnections.“Could Not delete Shopping Tax Table %d”ST_TEXT_BADDELETETRIP - Error as specified in text deleting shopping data on endof trip“Could not format item list (%s)”ST_TEXT_INVALIDFORMAT - Error formatting shopping trip data for list display.“Customer (%s) Could not get Qty”ST_TEXT_GETQTY - Error retrieving shopping trip data for item barcode.“Customer (%s) has less than zero items !!”ST_TEXT_LESSZEROITEMS - Deleting of an item from a customer”s list yielded aless-than-zero number of items in the list. Ooops.“Customer (%s) BAD Saving Item To Shopping List”ST_TEXT_BADSAVEITEM - Could not save a item to the Pss_Shopping_Item tablefor a customer”s shopping list. Verify that thePss_Session and Pss_Shopping_list tables have rows forthis customer.“UE_PreProcessMarketingMessage”ST_TEXT_USEREXITERROR - Error value returned from user exit code. Fix the code.“Customer (%s) Could not set Total Value”ST_TEXT_TOTALVALUE - Error saving total value to Pss_Shopping_List table.Verify that the customer is valid“No Session for this Terminal (%s)”ST_TEXT_NOSESSIONCUSTOMER - Attempted to queue bust shopper without an associatedexployee with a terminal. Verify thatCreateShoppingList completed successfully prior tocalling StartShoppingTrip.“No Customer Data”ST_TEXT_NOCUSTOMER - The customer barcode scanned by the employee forqueue busting does not exist in the Pss_Customer table.“No New Shopping List for this card (%s)”ST_TEXT_NOSHOPPINGLIST - Could not get Pss_session table data for the terminaltrying to do the queue busting“Could Not initialize For card number (%s)”ST_TEXT_SESSIONBAD - Could not exchange from employee to shopper for theterminal trying to do the queue busting.“Could not Get Queue Buster session Data (%s)”ST_TEXT_QUEUEBUSTER - Could not find queue buster Pss_session table entry forthe shopper.“Could not Swapping queue buster session for card(%s)”ST_TEXT_SWAPQUEUEBUSTER- Could not exchange from shopper to initiatingemployee for the terminal trying to do the queue busting“Could not delete shopping list just created for (%s)”ST_TEXT_BADDELETE - Error deleting shopping data Pss_Session table after anerror. Attempting cleanup“Error Retrieving Customer Message for (%s)”ST_TEXT_NOCUSTOMERMESSAGE. - Database error retrieving message for this customer.Verify existance of customer and message inPSS_Customer_Message table.“Customer (%s) Could not create session”ST_TEXT_NOSESSIONSTART - On starting a shopping trip, added a row toPss_Shopping_List but could not add to the Pss_SessionTABLE. Check for already existing row for thisterminal in the Pss_Session table.“Customer (%s) Could not delete shopping list”ST_TEXT_DELETESHOPPINGLIST - Database error trying to cleanup after some other errorthe Pss_Session, Pss_Shopping_List andPss_Shopping_Activity tables.“Customer (%s) could not Set Shopping Status”ST_TEXT_SETSHOPPINGSTATUS - Error setting the Pss_Shopping_List table status.Verify the customer has a valid row in this table.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 86© 2000, Symbol Technologies, Inc. February 1, 2000“SwapTerminal Error for customer (%s)”ST_TEXT_SWAPTERMINALERROR - Error updating the Pss_Session and/orPss_Shopping_List tables while attempting a swapterminal command.“Customer, Card Number (%s) is suspended”ST_TEXT_CUSTOMERSUSPENDED - Logging the fact that a suspended customer has triedto release a scanner. From ValidateCustomer on cardswipe.“Customer for card is not found (%s)”ST_TEXT_NOCUSTOMERFORCARD - Logging the fact that a nonexistant customer (as perPss_Customer database table) has tried to release ascanner. From ValidateCustomer on card swipe.“Error Validating Card; Customer (%s) has a Session”ST_TEXT_HASSESSION - Logging the fact that this customer already has ascanner currently issued to them. FromValidateCustomer on card swipe.“Error Validating Customer (%s)”ST_TEXT_VALIDATECUSTOMERERROR - There was a Bad database problem on a card swipetrying to validate a customer.8.3.7 Informational Messages “No Session, or Swapped terminal (%s) - No trip toend”ST_TEXT_NOTRIP- EndOfTrip method was executed, but there is nocustomer or terminal data to end. Check thePss_Session table or the Pss_Shopping_List table for anentry.“Scanner Abandoned by Customer (%s)”ST_TEXT_SCANNERABANDONDED - A scanner that was detected as abandoned is being runthrough EndOfTrip. This will delete all informationabout the trip, saving nothing to history, and not sendingany data to the POS.“Done with special Customer (%s)”ST_TEXT_SPECIALCUSTOMER - Logs that a store employee has completed a shoppingtrip and EndOfTrip has run, deleting all informationabout the trip and saving nothing to history and notsending any data to the POS.“User Exit Returned Done %s”ST_TEXT_USEREXITDONE - After user exit calls, to specify NOT using the standardalgorithms that follow the user exit calls.“For Customer, Error on Terminal Finding Item (%s)”ST_TEXT_NOITEM - An error trying to find the item scanned in thePss_Item table.“For Customer, Error on Terminal Invalid Barcode %s”ST_TEXT_INVALIDBARCODE - Logs that an invalid barcode was scanned or that theshopping trip was incorrectly started. Verify that datafor the customer exists in the Pss_Session andPss_Shopping_List tables“No New Shopping List for this customer (%s)”ST_TEXT_NOCUSTOMERLIST - No data in Pss_Shopping_Item table to list for thiscustomer.“Could not Get trip data to delete for terminal (%s)”ST_TEXT_DELETECUSTOMERSESSION Error trying to clean up Pss_session andPss_shopping_List tables after unsuccessful release ofscanner.“Customer (%s) Could not delete session”ST_TEXT_DELETETERMINALSESSION - Error trying to clean up Pss_session andPss_shopping_List tables after unsuccessful release ofscanner.“Customer (%s) has scanned an exception item”ST_TEXT_EXCEPTIONITEM - Logs the scanning of an exception item by a customer.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 87© 2000, Symbol Technologies, Inc. February 1, 20008.3.8 Debug Messages:The following are messages logged in the End Of Trip method to track progress through thatmethod."EOT Done totals" - Completed calculation of trip totals"EOT Done Rescan" - Completed Rescan calculation"EOT Written to files" - Completed writing Pss Transfer File"EOT Done" - End of trip completed successfully8.3.9 Rescan MessagesThese Information messages are specific to determine if a shopper gets rescanned or not."Into RescanLevel lOldLevel=%d, lPOSItemCount=%d,lPSAItemCount=%d, lBothItemCount=%d,lPOSItemValue=%d, IPSAItemValue=%d,1BothItemValue=%d”- Displays inputs into rescan calculation.“Rescan by Currency” - Employs the rescan calculation by absolute valuedifference in prices.“IgnoreScanTooMuch” Ignore overscans by customer in rescan determination.“NOT IgnoreScanTooMuch” - Do not ignore overscans by customer in rescandetermination.“Level diff RescanLevel Diff=%d, levelMod=%d” - Displays the calculated difference and specified levelchange.“Rescan by Percentage” Employs the rescan calculation by percentage difference.“new Level (%d) old(%d) modifier(%d)” - Displays the shoppers new and previous rescan levels,and specified level change.“Check new Level (%d) vs min(%d max(%d)” - Displays new level and minimum and maximumallowed levels.“Leave alone ret=%d” - No change in shopper”s level.“Customer (%s) rescan is FALSE - Gold Customer”ST_TEXT_RESCAN_GOLD This customer will never be rescanned.“Customer (%s) rescan is FALSE - Rescan Nobody, bydate”ST_TEXT_RESCAN_NOBODYDATE- During the current time period, nobody should berescanned. This is selected from the rescan screen onthe administrative service terminal.“Customer (%s) rescan is FALSE - Rescan Nobody”ST_TEXT_RESCAN_NOBODY - Nobody is to be rescanned. This is selected from therescan screen on the administrative service terminal.“Customer (%s) rescan is TRUE - Rescan Everybody,by date”ST_TEXT_RESCAN_EVERYBODYDATE- During the current time period, everybody should berescanned. This is selected from the rescan screen onthe administrative service terminal.“Customer (%s) rescan is TRUE - Rescan Everybody”ST_TEXT_RESCAN_EVERYBODY - Everybody should be rescanned. This is e- Nobody isto be scanned. This is elected from the rescan screen onthe administrative service terminal.“Customer (%s) rescan is TRUE - Always First Trip”ST_TEXT_RESCAN_YESFIRSTTRIP - This is the shopper”s first trip, rescan them.“Customer (%s) rescan is FALSE - Never First Trip”ST_TEXT_RESCAN_NOFIRSTTRIP - This is the shopper”s first trip, do NOT rescan them.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 88© 2000, Symbol Technologies, Inc. February 1, 2000“Customer (%s) rescan is FALSE - Never Second”ST_TEXT_RESCAN_NOSECONDTRIP - This is the shopper”s second trip, do NOT rescan them.“Customer (%s) rescan is FALSE - Below Item Count”ST_TEXT_RESCAN_BELOWCOUNT - This shopper”s trip is below the specified item count,do NOT rescan them.“Customer (%s) rescan is FALSE - Below Value”ST_TEXT_RESCAN_BELOWVALUE - This shopper”s trip is below the specified basket value,do NOT rescan them.“Customer (%s) rescan is FALSE - Above Amount”ST_TEXT_RESCAN_ABOVEVALUE - This shopper”s trip is above the specified basket value,do NOT rescan them.“Customer (%s) rescan is FALSE - Above Item Count”ST_TEXT_RESCAN_ABOVECOUNT - This shopper”s trip is above the specified item count,do NOT rescan them.“Customer (%s) rescan is TRUE - Too long betweentrips”ST_TEXT_RESCAN_TOOLONG- This shopper”s last PSS trip was too long ago, rescanthem.“Customer (%s) rescan is TRUE - Too long since lastrescan”ST_TEXT_RESCAN_TOOLONGLASTRESCAN- This shopper”s last rescanned trip was too long ago,rescan them.“Customer (%s) rescan is FALSE - Too soon since lastrescan”ST_TEXT_RESCAN_TOOSOONLASTRESCAN- This shopper”s last rescanned trip was too short ago, doNOT rescan them.“Customer (%s) rescan is FALSE - Never Consecutive”ST_TEXT_RESCAN_NO2INAROW - Never rescan a shopper twice in a row, do NOT rescan.“Time Window populations: QPCust = %d,%d,%d,%d;RSCust = %d,%d,%d,%d; QPItem = %d,%d,%d,%d;RSItem = %d,%d,%d,%d”- Display data for load balance algorithm.“Item Count Load Balance Average process time / PSSLane = %.2f” - Display data for load balance algorithm.“HeadCount Load Balance #Rescan = %.1f, #QuickPay= %.1f” - Display data for load balance algorithm.“Customer (%s) rescan is FALSE - Load Balanceheadcount too big”ST_TEXT_RESCAN_QUEUEHEADCOUNTTOOBIG- Do not rescan this customer, head count too large.“Customer (%) rescan checking REDUCED – Loadbalance reduced checking”ST_TEXT_RESCAN_REDUCEDCHECKING- Entering reduced rescan level due to load balancing.“Customer (%s) rescan is TRUE - Load balance cashierIS available”ST_TEXT_RESCAN_CASHIERAVAILABLE- Rescan this customer since load balancing cashier isavailable.“Customer (%s) rescan is FALSE - Load balance cashierNOT available”ST_TEXT_RESCAN_CASHIERNOTAVAILABLE- Do NOT Rescan this customer since load balancingcashier is not available“TRUE - On max trip number since last rescan (%d)” - Shopper is at maximum trip since last rescan for theirrescan level, rescan them.“Customer <%s> rescan is TRUE - Level=%d Pct=%dvalue=%d” - Randomly calculated result yields a rescan for thisshopper.“Customer <%s> rescan is FALSE - Level=%d Pct=%dvalue=%d” - Randomly calculated result yields a NO rescan for thisshopper.“Customer (%s) rescan had Error retrieving RescanData”ST_TEXT_RESCAN_DATA- Error in reading this customer”s rescan data. Checkthe Pss_Customer table for valid data..
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 89© 2000, Symbol Technologies, Inc. February 1, 20008.4 Quick Order SubsystemWhile shopping, a user may choose to place a quick order through the Quick Order subsystem.The shopper identifies, through the quick order mechanism, the products and thequantities/weights of those products they wish to order. The quick order can then be sent to theappropriate department, where a web screen displays to store personnel the orders placed byshoppers. After they have finished processing the order, store personnel can send a message tothe shopper that their order is ready. This is an optional feature.PssQuickOrderBarcodeCom – Com object associated with quick orderPssQuickOrder – Class associated with quick orderDatabase tables associated with quick order are:Pss_Order_ListPss_Order_StatusPss_Order_List_ItemPss_Department8.5 Queue Busting SubsystemThe Queue Busting application allows the PSS System to be used in a slightly different mannerthan normal, but also helps retailers and shoppers reduce the amount of check–out time. Anyhand held terminal which has been released can be used for queue busting. This is normallydone by store personnel to alleviate long check out lines which may have formed.Transactions in this mode are initiated by scanning a special (configurable) barcode. More thanone barcode can be configured for use in this manner. This barcode is expected to be on a plastictoken. Once the special barcode has been scanned, the items in the customer basket are scanned.A PSS transaction is created in the same manner as a normal PSS transaction. After all items inthe basket have been scanned, the special barcode, which began this mode, is scanned again.This transaction is sent to the POS System. The plastic token containing the barcode is thenhanded to the customer with instructions to give it to the cashier at the check-out register. Whenthe customer reaches the register, they present the token and their loyalty card (if used) to thecashier who then performs a standard non-audit self scan check out. After the customer checksout, the token can be reused for other customers.There are no methods written specifically for queue busting. The hand held applicationdifferentiates between a normal shopping trip and a queue busting session.PssSpecialBarcodeCom – Com object associated with queue bustingPssSpecialBarcodeLib – Library associated with queue bustingAssociated database tables are:Pss_SessionPss_Special_Barcode
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 90© 2000, Symbol Technologies, Inc. February 1, 20008.6 Electronic Marketing SubsystemThe PSS system also allows for a basic electronic marketing facility through the ElectronicMarketing application. This application allows a retailer to send messages to a shopper’s handheld terminal anytime that a given item is scanned. This is an optional feature.PssEMarketingMessage - Class associated with electronic messagesElectronicMarketing – Library associated with marketingDatabase tables associated with marketing messages:PSS_Marketing_ItemPSS_Marketing_SentPSS_Marketing_MfgPSS_Marketing_Department8.7 User Messaging SubsystemAlso, through the User Messaging application, the store has the option to send messages toshopper’s hand held terminals. The messages can be any text, and can be made to be repeated,be displayed at fixed times during the day, and/or can be directed to any set of shoppers currentlyin the store. In addition, messages for a particular customer can be preloaded and are deliveredto them the next time they shop with the WaveWorks PSS system.PssSystemMessageCom - Com object associated with system messagesPss_System_Message – Database table associated with system messages
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 91© 2000, Symbol Technologies, Inc. February 1, 20008.8 POS Interface SubsystemThe WaveWorks PSS POS Interface is a file-based mechanism that provides communicationbetween the PSS system and the store POS system by the exchange of files.PSS software monitors and deposits files into a directory referenced as the Transfer Area.Inbound files (created by the POS) are detected in the Transfer Area and moved into the workingarea where a processing transaction processes the information in the file. When processingcompletes, the file is then moved into the Processed Files Area. Outbound files (created by PSS)are initially created in the working area and, when completed, are moved into the Transfer Areato be processed by the POS system.Under normal operating conditions, files should only exist in the Transfer and Working areastemporarily. If files begin to accumulate in either of those areas, it is a sign of a systemmalfunction. Files moved into the Processed Files Area remain there until a File Housekeepingjob deletes them. Files which are processed correctly are renamed with filetype "COMPLETED"and files which could not be processed are renamed with filetype "ERR".The directory location of the Transfer Area and the Processed Files Area may be configured inthe PSS System Settings, but they default to the "Transfer" and "Processed" subfolders of thefolder where PSS was installed: (C:\Pss\Transfer and C:\Pss\Processed). This Transfer Areafolder location is identified by System Setting value POSINTERFACE/Local_TransferArea.If the POS system supports network file paths and WindowsNT can be configured to map adirectory on the POS, then PSS can be configured to retrieve and send files to a directory area onthe POS system. The Processed Files Area is identified by a System Setting valuePOSINTERFACE/ ProcessedFileArea. Since this folder can accumulate large numbers of filesdepending on how frequently File Housekeeping is configured to run, this directory may beconfigured to be on a different disk device than the disk on which PSS is installed. This wouldbe done to avoid filling up that disk and causing a Disk Full problem.TransferArea WorkingArea Processed FilesAreainbound inboundoutbound
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 92© 2000, Symbol Technologies, Inc. February 1, 20008.8.1 POS Interface FilesThe files defined are:• PSS Transaction filesent from PSS to POS to identify a shopper and the items they havescanned.• POS Transaction filesent from POS to PSS to identify that a shopper has paid for theirtrip and allows for sending the items scanned by the POS system.• Item Record filesent from POS to PSS and contains all of the items in the POS databasesuch that the PSS database can be updated to reflect the items contained in the POSdatabase.• Price Changes filesubset of the Item Record file, processing is the same.• Tax Table filessent from the POS to PSS and contain tax information used by PSS toperform transaction tax calculations.• Customer Update Filesent from POS to PSS to update the PSS database withinformation about valid PSS shoppers.The following sections describe the file layout for each of the file types.(File layouts unchangedskipping to next section)8.8.2 POS Interface Software EntitiesThe following software components are included to process the files listed above. A serviceexists which monitors a specific folder for the arrival of these files. Files created by PSS are,when detected, transferred to the POS system using the configured “transfer” transaction. Filescreated by the POS system are, when detected, “processed” on the PSS system using theconfigured “processing” transaction.8.8.2.1 PSSFileMonitorSvcPSSFileMonitorSvc is the service which monitors Transfer Area for the arrival of files from thePOS system and for files generated by the PSS system. It moves inbound files into the WorkingArea and, when appropriate, initiates WaveWorks transactions for performing file-processingfunctions. It can also be configured to initiate transfer transactions when it detects outboundfiles. Release 1 of PSS provides no transfer transactions for sending files to a POS system.8.8.2.2 PssPosService(IBM 4690 POS only)This is an NT Service specifically developed for information exchange with IBM 4680/90 POSsystems running the Supermarket Application(SA). This service handles the transfer function forall of the file types listed above.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 93© 2000, Symbol Technologies, Inc. February 1, 20008.8.2.3 IBM RCO for 4680/90 POSPssPosService makes use of the IBM RCO (Retail Connectivity Option) product for the 4680/90POS. Release 1 of PSS WaveWorks used IBM RCO release 2.4.1. This product supplies aclient access service that communicates with a Server application on the 4680/90 POS. For thismechanism to work, the IBM POS must be running the adxsrvnl.286 application as a backgroundapplication. The client application nbqmain.exe that runs as a WindowsNT service isautomatically installed by the PSS installation procedure, but it must be configured by placingconfiguration information into file nbqmain.cfg in the Pss\bin directory. This file is deliveredwith a set of preconfigured values that are typical of a PSS/4690 POS installation, but may needto be changed to allow PSS to communicate with the POS. See the IBM RCO User's Guide forparameter values which can be placed in this file.8.8.2.4 POSInterfaceCOMThis COM object contains the software methods used to perform the processing of transactionfiles, item files, and tax table files described earlier. In release 1 of PSS, it also contains thetransactions which initialize the PssPosService. It contains the following functions to handle theassociated transaction:Function Transaction ActivatorLoadPOSItemFile P2P003 PssFileMonitorSvcLoadTaxTable P2P005 PssFileMonitorSvcLoadPOSTransaction P2P002 PssFileMonitorSvcEnableItemUpdates P2P304 PosInterfaceCOM/LoadPOSItemFileDisableItemUpdates P2P404 PosInterfaceCOM/POSSItemFileTransferPOSSItemFileTransfer P2P103 PssFileMonitorSvcPOSstartup POS100 PssFileMonitorSvcSetCommLinkStatus POS301 PssPosServicePOSLogin POS300 PssPosService8.8.2.5 PssCustomerMaintCOMThis COM object handles processing of the Customer Information File (CUSTMTxx.DAT) andupdates the PSS database tables with information from that file.It contains the following functions:Function Transaction ActivatorLoadFromFile P2P006 PssFileMonitorSvc
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 94© 2000, Symbol Technologies, Inc. February 1, 20008.8.2.6 PssFileMaintCOMThis COM object handles general file housekeeping functions. It contains the transaction usedby the POSInterface to purge files from the Processed File Area, the transaction to move thePssTransactionFile from the Transfer area after the POS has processed it, and the transaction thatemulates the POS (Converts PSSTransactionFile to POSTransactionFile)It contains the following functions:Function Transaction ActivatorCleanupPssTransFile P2P201 PssFileMonitorSvcCleanupArchiveArea P2P298 WindowsNT Scheduler/WaveWorksSENDTXConvertSItoSO P2P299 PssFileMonitorSvc8.8.2.7 Windows NT SchedulerPSS uses the native scheduler inWindowNT to schedule a purge of files from theProcessedFileArea area. During PSS installation, a scheduled task named PurgeFiles is placedin the Windows NT \Tasks folder which is scheduled to activate transaction P2P298 daily topurge the files. The FileHouseKeeping system settings are used to control the purge activity.8.8.3 POS Interface ConfigurationConfiguration of the POS Interface for a specific store environment is achieved by modificationof PSS System Settings and by implementation of User Exit routines supported by the POSInterface Applications. Changes to configuration items are made using the System Settings pageon the System Administration Terminal. That page contains a detailed description of eachsystem setting item with information that identifies valid values for the item. The page alsocontains a default value for each item.The settings for the POS interface are divided into the following four areas• settings that apply subsystem-wide to the POS interface• settings that apply to the processing of specific file types• settings that affect the operation of the NT Services used by the POS Interface• settings that apply to a specific POS system (IBM 4680/90).After modifying a system setting value, the link at the bottom of the system-setting page,Re-Initialize PSS System, must be activated to cause the modified setting to be recognized by thePSS software. The PssPosService must be stopped and restarted after changing any4POSSINTERFACE settings.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 95© 2000, Symbol Technologies, Inc. February 1, 2000The names of the items on the System Settings Page that are used to configure the POS interfaceportion of PSS are listed here for cross-reference to that page. Where the following pagesmention a Configuration Group, that corresponds to the Name column on the System Settingpage. Where they mention a Configuration Item, that corresponds to the Subname column on theSystem Setting page.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 96© 2000, Symbol Technologies, Inc. February 1, 2000Settings that Apply to the POS Interface Subsystem as a WholeConfiguration Group (Name column on System Settings Page)POSInterfaceConfiguration Item (Subname column on System Settings Page)LocalTransferArea Directory to monitor for the arrival of files from the POS and where PSS should placefiles for the POS to retrieveRemoteTransferArea (Future)Location on POS where files are to be deposited or retrievedProcessedFileArea Directory where PSS should place files when done processing themPOSControllerType Type of POS which PSS is interfacing to (4POSS is the 4690 interface)POSControllerName Network Name of the POS controllerLanAdapterNumber LANA number of the network interface that the POS computer is connected toPSSItemBarcodeLength Number of valid digits in the item barcode field of a file exchanged with the POS.This field is pre-sized to 24 digits in the files, but most barcodes have fewer digits.PSSTransactionType TICKETONLY/LOYALTYUsePSSPrice Set to Yes if the POS does not place price information in the POSTransactionFile.PSS rescan logic will not do price comparisonsExcludedDepartments Identifies items not to be loaded into the PSS database if they are associated withthese department numbersTrace_Level Identifies the amount of status information that should be written to the PSS SystemLog by the software that is part of the POSInterface system. This value may beoverridden by definition of a Trace_Level for a specific POSInterface componentPSS_GlobalLoyaltyCardLength Number of valid digits in a customer loyalty cardFileHouseKeepingHousekeepingEnabled Whether or not File's should be deleted from the ProcessedFileArea when theFileHousekeeping job runsFileKeepDays Number of days a file should remain in the ProcessedFileArea before being deleted.This is actually the number of 24 hour periods to be kept. If the File Houskeeping jobis set to run more frequently than once per day, some files dated on a specific daymay be deleted and others remain.ImportItemDataCheckDigitExists Indicates whether or not a check digit is part of item file barcodesValidateCheckDigit Indicates whether check digit item file barcodes are valid
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 97© 2000, Symbol Technologies, Inc. February 1, 2000Settings for Configuring Processing Attributes of Each POS File TypeConfiguration File GroupsPOSItemFile Full Item file and Item/Price updatesPOSTaxFile Tax tablesPOSTransFile Created at completion of a POS transaction (Scan-Out)PSSTransFile Created at completion of a PSS transaction (Scan-In)PSSTransFileX Defined when the IBM 4690 POS(4POSS) is being used. 4POSSrenames Scan-In files that have been successfully written to the POS andleaves them in the transfer area. This file type identifies those files andspecifies a transaction that moves them into the ProcessedFileArea.POSCustomerFile Provides updates to customer information and identifies customers whomay use PSSConfiguration Item Applies to each of the above file types (not all apply to every file type).FileName Name used by POS system to identify the type of file to be processedMonitorInterval Delay(in ms) between scans by the PssFileMonitor service to look for theexistence of the file typeTransferEnabled Identifies to the PssFileMonitor service whether or not the filetype should beprocessedTransferType Identifies the direction of transfer(Inbound or Outbound) and distinguishesIMMEDIATE vs TOD (TimeOfDay) processing. The PssFileMonitor serviceactivates a WaveWorks TransferTX when it detects an OUTBOUND file and itinitiates a WaveWorks ProcessTX when it detects an INBOUND file. If the fileis an INBOUND-TOD type file, then the PssFileMonitor initiates a TransferTXat a specified time to request a POS to send a filetype.TransferTime Only applies to TOD file types. This identifies the time of day at which theTransferTX will be activated to retrieve the file on the POSTransferTX A WaveWorks transaction ID. This transaction must be defined in theWaveWorks database with a string parameter for the file path of the file toretrieveProcessTX A WaveWorks transaction ID. This transaction must be defined in theWaveWorks database with a string parameter for the file path of the file toprocess.PSSExpansionLength Identifies the number of additional bytes appended to each record in a file fortransferring PSS specific information. See the specific filetype layout for moreinformationUserExpansionLength Identifies the number of additional bytes appended to each record in a file fortransferring client specific information. PSS standard processing ignores thisdata, but it may be accessed by PSS User ExitsFileFormatVersion (future) Future. Will be used to distinguish file versions if the standard file formatchanges in the futureRemoveItemCheckDigit (not allfiles) Identifies if the ITEM barcode in the record as written by the POS includes acheckdigit. PSS does not store the checkdigits in its database
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 98© 2000, Symbol Technologies, Inc. February 1, 2000RemoveCustCheckDigit (not allfiles) Identifies if the CUSTOMER CARD number in the record as written by the POSincludes a checkdigit. PSS does not store checkdigits in its databaseAddItemCheckDigit (not all files) Identifies if PSS should write a checkdigit value in the ITEM field in the recordsof files sent to the POSAddCustCheckDigit (not all files) Identifies if PSS should write a checkdigit value in the CUSTOMER CARDnumber field in the records of files sent to the POSFullItemFileName (POSItemFileonly) The specific file name of a Full Item Update file. This is used to distinguishreplacement database from a database update to the PSS item dataTrace_Level Identifies the amount of status information that should be written to the PSSSystem Log by the software that processes the file typeSettings for Configuration of NT Services that Perform POS Interface FunctionsPssFileMonitorTrace_Level Trace level to be used by the PssFileMonitor servicePOS Specific Settings for the IBM4680/90 POS4POSSInterface (Specific settings for the interface to the IBM 4680/90 SA POS system)POSTransFileVersion Whether the 4690 ScanOut file user exit writes prices to the file and whether Quickpaytransactions have items written to the transaction fileCopyTaxTables Whether or not to retrieve tax tables from the POSNumberPriceBytes Number of price bytes expected in the ScanIn file by the POS User ExitsDeletePOSIRC Whether/When to delete the POS Item record changes fileTrace_Level Specific trace level for the PssPosService.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 99© 2000, Symbol Technologies, Inc. February 1, 20008.8.4 PSSTransactionFile Processing8.8.4.1 File-Based InterfaceAt the conclusion of a shopping trip (when a hand held terminal is returned to the dispenser orthe End of Trip barcode is scanned), a PSS transaction file is created and placed in the transferdirectory. Once the file is properly placed in the transfer directory, the processing for a PSStransaction file is complete in the file-based interface. Custom code must be developed toprovide the transfer mechanism to the POS system.8.8.4.2 4680/4690 InterfaceThe IBM SA Personality implementation of the POS API uses the IBM product RCO. The RCOAPI provides access to the POS files on the POS controller over a LAN. It is described in theIBM manuals:• “Retail Connectivity OptionVersion 2.4.1 including OS/2 appendix - Product Reference”dated September 15 1994.• “Retail Connectivity OptionVersion 2.3 - User’s Guide” dated November 1996, whichcovers both OS/2 and NTThe POS Interface consists of a service (PssPosService) that includes a modified version of thePOSAPI from Version 5.0 of the PSA. The POSAPI provides the interface between the PSSController and the native 4680/90 POS. It provides the PSS Controller with file access to data onthe native POS controller.When a hand held scanner is returned from a shopping trip, a PSSTransactionFile, according tothe format listed above, is created in the transfer directory. The PssPosService scans the transferdirectory at a regular interval. On detection of a file, the PssPosService handles transfer of theinformation in the transaction file to the 4690 controller by writing the transaction informationinto the Scan-In file on the POS. The frequency at which the PssPosService scans the directoryis specified by the system setting PSStransactionFile/MonitorInterval.8.8.4.3 POS Emulation (Demo System)Under normal conditions, the PSS shopping trip creates PssTransaction files and places them inthe transfer area for a POS to process. The PssFileMonitor process is configured to ignore thesefiles and not attempt to move them or process them, since the store POS (PssPosService) will beprocessing them. For testing and demonstration purposes, when access to a POS system isunavailable, the System Setting values for the PSSTransactionFile can be modified to cause thePssFileMonitor to detect them and activate a POS emulation transaction. This transaction readsPSSTransaction files (Scan-In) and creates corresponding POSTransaction files (ScanOut) whichare in turn detected and processed to complete the full shopping transaction cycle and unsuspendthe customer record (customers are suspended until trips are completed).
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 100© 2000, Symbol Technologies, Inc. February 1, 2000In order to enable this feature, the following system settings must be configured as shown.Name/Subname ValuePSSTransFile/TransferEnabled Y (Tells PssFileMonitor to process this filetype - default is N)PSSTransFile/TransferTX P2P299 (the PosEmulation transaction -default is P2P199)PSSTransFile/AddCustCheckDigit N (should match value for POSTransFile/RemoveCustChkdigit)PSSTransFile/AddCustItemDigit Y (should match value for POSTransFile/RemoveItemChkdigit)After changing these settings, stop both the PosService and PssFileMonitor services. Set theWaveWorks database ADM_DAEMON table so that PosService is NOT restarted automatically(just prefix the name so the service isn't found). This will prevent the PosService process fromtrying to process PssTransaction(ScanIn) files.Start up the PssFileMonitor service. By setting the values above, PssFileMonitor will be enabledto monitor PSSTransaction(ScanIn) files and trigger event P2P299, which creates acorresponding POSTransaction(ScanOut) file. Normal POSTransaction file processing will thenbe triggered by the appearance of a file and cause the shopping trip to be completed.The POSTransaction file that is created has the same RESCAN flag value and the same items asare in the PSSTransaction file. Future support for record level and file level user exits to becalled by transaction P2P299 is planned. Thus the created POSTransaction file could be alteredby integrators to add to, remove, or alter records. This support is not available in the initialrelease.8.8.5 POS Transaction File Processing8.8.5.1 File-Based InterfaceThe transfer directory is polled by the PssFileMonitor service. Once a POSTransactionFilearrives in the transfer directory, file processing is activated. The shopping trip information ismoved into the Shopping History database tables. In addition, the shopper's rescan probability isrecalculated. If the file contains an End of Day record, the End of Day Event is stored in thedatabase (PSS_EOD table) and the End of Day user exit routine is activated.8.8.5.2 4690 InterfaceUpon completion of a transaction at the store check-out lane, a 4690 user exit running in thecheck out support application updates a ScanOut file on the POS with information about thecompleted transaction. The PssPosService polls the file on the POS, retrieves new informationin the scan-out file, and creates a PosTransactionFile in the Transfer Area for each POStransaction completed since the last scan. Upon detection of a POS transaction file by thePssFileMonitor service, processing continues as described in the file-based interface. Thefrequency of the poll interval is specified by system setting POSTransactionFile/MonitorInterval.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 101© 2000, Symbol Technologies, Inc. February 1, 20008.8.6 Item Record File ProcessingPSS maintains a database of items on the store shelves and their prices. This database ismaintained by downloading the item information from the store’s POS system. Thesedownloads can be achieved as either full item database downloads or as item informationupdates.The POSItemFile system settings are used to control the functioning of these operations. Eitheror both download types can be used to update the PSS item database. Since a download of a fullitem file requires a high level of computer system resources it is recommended that full itemdatabase downloads be performed when shopping activity is low. However, shopping tripactivities may continue during Item File processing and full downloads or updates can occur atany time. Early benchmarks indicate approximately 1500-4000 records per minute can be loadeddepending on other PSS system activities, load on the POS system, overall traffic load on thePSS-POS network segment, machine configuration (CPU speed and amount of memory) and onthe database size.There is one primary distinction between item update and full item file processing, item deletion.During full item file processing PSS tags all items in the database that were also in the item fileand after finishing its update pass it deletes all untagged items. Since item update processingdoes not include an item delete function, this is the only way to purge PSS of items that havebeen deleted from the POS database.8.8.6.1 File-Based InterfaceThe transfer directory is polled by the PSSFileMonitor service. When a Full Item File orItem/Price Update file arrives in the transfer directory, the Item File processing is initiated. Fileprocessing takes the data contained in each Item File record and loads that data into thePSS_Shopping_Item table in the PSS Database.8.8.6.2 4690 InterfaceThe PssPosService creates an Item update or full Item file from the information maintained onthe 4690 controller. On startup, the PSSFileMonitor service sends a WaveWorks transaction tothe PssPosService requesting that it initiate Item/Price update processing. The PosService thenbegins polling the POS controller at the rate specified by the configuration itemPOSItemFile/MonitorInterval for changes. The PSSFileMonitor uses the configuration itemPOSItemFile/TransferTime to control when to request download of a full item file to the PSSsystem. When that time arrives, the PSSFileMonitor sends a pair of WaveWorks transactions tothe PosService, one to disable item/price update polling and one to request creation of the fullitem file. On arrival of the item file in the transfer directory the PSSFileMonitor triggers theWaveWorks ItemFile load transaction. Upon completion of loading the file, the ItemFile loadmodule sends a WaveWorks transaction to the PosService to tell it to resume polling the POSsystem for updates.
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 102© 2000, Symbol Technologies, Inc. February 1, 20008.8.7 Customer Update File ProcessingThe information maintained for customers that are registered to use the PSS system may beupdated by sending a Customer Update File to the PSS system. This file can be used to createand update customer records in the PSS Customer database. PSS maintains many data items notincluded in the CUSTMTxx.DAT file described earlier in this document, but the format has beenmaintained for compatibility with existing PSA systems. Sites, which choose to populateadditional PSS customer fields, can append data to the customer record in the User ExpansionArea of the record and can process that data by customizing the User Exits provided.8.8.7.1 File-Based InterfaceThe transfer directory is polled by the PSSFileMonitor service. When a Customer Update filearrives in the transfer directory, the file processing transaction is activated. File processing takesthe data contained in each Customer Update record and loads that data into the PSS_Customertable in the PSS Database.8.8.7.2 4690 InterfaceThere is no special support provided with the base PSS system for creation and transfer ofcustomer files.8.9 PSS ServicesServices are software programs that control individual components of the Portable ShoppingSystem (there are also services concerned with the operating system and other components ofyour computer). The common services associated with the Portable Shopping System aredefined below; your store may have additional custom services not listed here.WaveWorks RF Server—handles all communications to RF devices (primarily the hand heldscanners, and certain types of entrance units)WaveWorks Message Server—routes messages between components of the systemWaveWorks Business Server—manages software applications (COM Objects)WaveWorks STEP/Display Server—displays the screens on the hand held scannersWaveWorks System Controller—the highest level service which encompasses all other servicesdefined for your installation of the PSSPSS POS Service—handles communications between the PSS and the IBM 4600 series of POScontrollers
Software Description______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 103© 2000, Symbol Technologies, Inc. February 1, 2000PSS File Monitoring Service—manages file transfers between PSS and POS (primarily fortransfer of item, customer, scan in, and scan out filesPSS RF Entrance Service—controls operation of all entrance unitsPSS Printer Service—controls operation of all printers
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 104© 2000, Symbol Technologies, Inc. February 1, 20009. Customizing the PSS System SoftwareThe WaveWorks PSS system offers a number of options for integrators that need to customizethe base system to meet customer requirements. PSS allows integrators to customize the systemby changing the DisplayServer scripts, writing custom services, or writing custom businessobjects. PSS also supports “user exits,” which are function hooks in the base code that let theintegrator provide custom processing at key points in the code.9.1 Custom DisplayServer ScriptsThe DisplayServer process runs scripts called “interfaces” that control the display on RF devices(terminals and RF entrance units). The code for the interfaces is stored in the WaveWorksdatabase. The source files that were used to load the database at install time are found (bydefault) in the C:\PSS\StepDev folder. The integrator can make a customer-specific copy ofthese source files and modify them as needed. The modifications can range from small changesto the logic, such as running a custom transaction or changing the screen layout, to completelyrewriting the interface. Note that most interfaces get their text from the PSS database, sochanging the wording of prompt or message may be as simple as changing the text in thePSS_Text table.9.2 Custom ServicesThe PSS system uses NT Services (standalone processes that are started at bootup) tocommunicate to hardware devices. Examples include the EhtService for communicating withthe RF entrance unit, PssPrinterXX for talking to serial ticket printers, and the PssPosService fortalking to the store’s POS system. Writing an NT service requires a solid programmingbackground and WaveWorks developer training, but is an option for providing an interface tospecial devices or computer systems. The services connect to the WaveWorks MessageServerand use WaveWorks transactions to access standard business services.9.3 Custom Business ObjectsPSS business services are contained in more than a dozen COM Objects. Each business serviceis a COM object method. The WaveWorks system uses transaction Ids to map business servicesto a particular method on a particular business object. Integrators don’t have access to the basesystem source code (aside from user exits that are implemented in the COM Objects), but theycan create their own COM Objects. These COM Objects can provide new business services(using new transaction Ids) or replace existing business services (by changing the mappingbetween transaction ID and COM object/method in the WaveWorks database). These newbusiness services can be accessed from custom services and custom DisplayServer interfaces.
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 105© 2000, Symbol Technologies, Inc. February 1, 2000Writing custom COM Objects requires a solid programming background, preferably using VisualC++ and the ATL wizard.9.4 User Exit DLLA DLL, PssUserExits.dll, is provided which allows integration teams to customize the softwarefor a given installation. This mechanism is equivalent to the User Exits used in the PSAsoftware. The DLL contains functions that have been built into the code, but that, in most cases,contain stubs that only log a debug level message to identify that the function was called. Theintegrator is then allowed to add appropriate code to the functions and rebuild the dll.The C++ language header file PssUserExits.h documents the intended purpose of each function,the detail of the function interfaces, and the return status codes expected by the base PSSsoftware. It also documents how the various return code values will affect the operation of thebase PSS software when the function returns.Each User Exit function is implemented in a separate C++ source file named<UserExitName>.cpp. This C++ source file contains the stub code for the function.9.4.1 Common InformationAll methods should return one of three return status codes as described below. The return codeis the last argument in the call list to the User Exit function.The following description of standard arguments which are passed to all user exits applies toC++ modules only. User Exits called from "C" only code will not include the arguments whichare C++ objects.A C++ source module with the same name as the function name is supplied with a stubimplementation routine for the User Exit. The stub routine "includes" the PssUserExits.h file toretrieve the function definition. All stubs return status UE_CONTINUE to the calling routine.Many of the stub routines log a debug level message to the PSS System Log with the values ofall the input arguments. This stub code can be reviewed to see how to use the CPssMsgLogobject to write messages to the PSS System Log. See also the following section "Using theCPssMsgLog Class."If a "Preprocess" User Exit needs to pass information to a "Postprocess" User Exit for the samePSS function (PreProcessRecord -> PostProcessRecord), it can be maintained in static storage inthe dll. All other information exchange between user exits cannot safely rely on executingwithin the same instance of the dll. In those cases the User Exits must use other mechanisms forsharing information between user exit functions.
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 106© 2000, Symbol Technologies, Inc. February 1, 2000PSS base code is linked with Microsoft's Multithreaded DLL runtime library, so integrators mustlink a custom user exit DLL using that same library. Otherwise runtime errors will occur withthe CpssMsgLog and CSymStatementPool classes that are used in the stub User Exits.9.4.2 Return and Message CodesThe following return codes are used by the standard PSS software to determine how to proceedafter the User Exit routine has returned to the calling routine. The name and numeric value mustalso be defined in database table PSS_TEXT if this name is to be used as the msgcode field forwriting a message to the PSS System Log.UE_CONTINUE Indicates PSS should continue with normal processingUE_DONE Indicates the User Exit has performed all necessary processing and PSS should skip itsnormal processing.Note: A UE_DONE returned by a "PreProcess" function will cause PSS to skip the callfor the "PostProcess")UE_ERROR Indicates the User Exit was unable to process sucessfully PSS processing will write amessage to the log and continue processing in the same manner as if a UE_CONTINUEwas returned unless documented otherwise for the individual User Exit.9.4.3 Using the CPssMsgLog ClassAll of the PSS software uses a C++ class named CPssMsgLog for writing operational status anderror messages to the PSS System Log. Customized User Exits should make use of this class tokeep system logging consistent for troubleshooting purposes. Each line in the PSS System Logdisplays the following:• Date/time the message was written.• Facility Namea 64-character name which should identify the COM object, NTService, or other high-level entity such as "ShoppingTripEndOfTrip" to identify atransaction type.• Action Namea 64-character name which represents the specific function which islogging the message. This should either be the UserExit name or the name of aspecific subfunction used by the UserExit routine.• Message texta 256-character string that contains the information being reported.The text of these messages is maintained in the PSS_Text database table. The textin that table can contain tags that represent values which the software supplies toreplace the tag. For instance, the POS file processing replaces a string tag with thefilename of the file being processed and the Unit Management system replaces astring tag with the MAC address of a terminal that doesn't respond.
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 107© 2000, Symbol Technologies, Inc. February 1, 2000• Severityrepresents the severity of the condition being logged. A System settingvalue, subname "Trace_Level", is maintained for the Facilities that log messages.If the message severity value is less than the severity value specified in theLogMessage call, the message is not written to the log. For instance, if theTrace_Level is set to 2 (Warning), then messages with a severity value 1(Informational) are not written to the log, but messages logged with the severity 3(Error) are written to the log. The value 2 is the default Trace_Level value set formost facilities by the PSS installation scripts. The Trace_Level values can bemodified using the System Settings Page on the PSS Administration terminal.The allowable values for severity which can be specified in a LogMessage call are:• PML_DEBUGlevel 0, used to log messages helpful in debugging code duringdevelopment. Examples are logging the values of parameters used or calculated bysoftware. The default Trace_Level settings suppress these messages.• PML_INFOlevel 1, informational messages that typically log the operational status ofsoftware. Examples are positive status about the completion of an operation (FunctionXYX completed successfully). These are messages that would not normally be enabled inthe System Log because there would be many such messages cluttering the log and theywould obscure more severe messages. If there were a perceived system problem, thentroubleshooting procedures might suggest setting the Trace_Level to 1 so these messageswould be written to the log and could be reviewed to see if software functions were beingperformed as expected.• PML_WARNINGlevel 2, Error conditions which the PSS software is readily able torecover from. The default Trace_Level settings write these messages to the log. Thesemessages may or may not indicate a system malfunction.• PML_ERRORlevel 3, Error conditions that indicate a system malfunction that is causingoperational errors. The default Trace_Level settings write these messages to the log.Some corrective action will normally need to be taken to reinstate proper system operation.• PML_FATALlevel 4, Critical Error conditions that stop the operation of PSS systemcomponents. These messages typically accompany other indications such as turning thePSS Administration terminal's Main Menu traffic light red and the disabling of the abilityof PSS to perform shopping activities.• PML_ALWAYSlevel 10, Status messages that do not indicate error conditions, butwhich should always be written to the System Log. Examples are startup and shutdownmessages logged by PSS services or activation messages logged by scheduled tasks.See the PssMsgLog.h header file for more programming details.
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 108© 2000, Symbol Technologies, Inc. February 1, 20009.5 Available User Exit FunctionsFollowing is a complete list of the User Exit routines as called by the standard PSS Software,along with a brief description of the intended purpose of the User Exit routine and a descriptionof how the base PSS software reacts to the return code received from the User Exit. For the mostrecent information on functionality and more details about specific arguments passed to the UserExit routines, review the header file PssUserExits.h.9.5.1 UE_PreProcessItemFileThis function is called before processing of Item Record File is performed. It receives the filepath of the item file as an argument.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the item record file as if no Pre-Processing was performedUE_DONE: PSS performs no Item record file processingUE_ERROR: PSS logs an error then proceeds as with UE_DONE9.5.2 UE_PreProcessItemRecordThis function is called after an item record is read from the file, but before PSS performs anyprocessing of the record. It is anticipated that this UE function will be used to either replace allPSS Item record processing or to alter the input buffer that PSS processes.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the item record as if no Pre-Processing was performed, validating theitem record and loading it into the PSS database.UE_DONE: PSS performs no record processing and proceeds to read the next recordUE_ERROR: PSS logs an error then proceeds as with UE_DONENote: If a UE_DONE is returned, the POS_Item_Flag field of the record in table PSS_Itemmust have been updated to "Y" or the record for that item will be deleted from the database byPSS end of file processing.
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 109© 2000, Symbol Technologies, Inc. February 1, 20009.5.3 UE_PostProcessItemRecordThis function is called after the item record has been processed by PSS and loaded into the PSSdatabase. It is anticipated that this User Exit function will be used to alter the PSS database itemvalues set by default PSS processing or to process additional information in the User Expansionarea of the item record.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS proceeds to read the next recordUE_DONE: PSS proceeds to read the next recordUE_ERROR: PSS logs an error then proceeds as with UE_DONE9.5.4 UE_PostProcessItemFileThis function is called after PSS has processed the entire Item Record File. All database updateshave been completed and the file is closed. It receives the file path of the item file as anargument. The file path for the processed Item record file will be different than the name the filehad for UE_PreProcessItemFile and depends on the success of PSS processing.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS performs no additional file processingUE_DONE: PSS performs no additional file processingUE_ERROR: PSS logs an error then proceeds as with UE_DONE9.5.5 UE_PreProcessTaxFileThis function is called before any processing of a POS Tax Table File is performed. It receivesthe path of the tax table file as an argument.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the file as if no Pre-Processing was performedUE_DONE: PSS performs NO file processingUE_ERROR: PSS logs an error then proceeds as with UE_DONE
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 110© 2000, Symbol Technologies, Inc. February 1, 20009.5.6 UE_PostProcessTaxFileThis function is called after PSS has processed the entire Tax Table File, all updates to thePSSdatabase have been completed, and the file has been closed. It receives the file path of the taxtable file as an argument. The file path for the processed file will be different than the name thefile had for UE_PreProcessTaxFile and depends on the success of PSS processing.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the file as if no Pre-Processing was performedUE_DONE: PSS performs no file processingUE_ERROR: PSS logs an error then proceeds as with UE_DONE9.5.7 UE_PreProcessPOSTransFileThis function is called before any processing of a POS Transaction File is performed.The POS Transaction file defines a completed transaction at the POS terminal. Arrival of the fileindicates completion of the shopping trip. Base logic clears the trip from the list of currentshopping trips and moves the trip into shopping trip history. The information in the file is usedto calculate a shopper's rescan levelThe base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the file as if no preprocessing was performedUE_DONE: PSS performs NO file processingUE_ERROR: PSS logs an error then proceeds as with UE_DONE9.5.8 UE_PreProcessPOSTransRecordThis function is called before processing the current header or detail record read from a POSTransaction File.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the RECORD as if no Pre-Processing was performedUE_DONE: PSS performs NO RECORD processing and proceeds to the next recordUE_ERROR: PSS logs the error an proceeds as with UE_CONTINUE.
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 111© 2000, Symbol Technologies, Inc. February 1, 20009.5.9 UE_PostProcessPOSTransRecordThis function is called after processing the current header or detail record read from a POSTransaction File and after updates to the PSS database for the current record have beencompleted.The base PSS software handles the following return codes from the User Exit as follows:All return codes: PSS logs the status and continues on to the next record9.5.10 UE_ProcessEODRecordThis function is called after PSS processes an EOD or EOW record in a POS Transaction FileThe base PSS software handles the following return codes from the User Exit as follows:All return codes: PSS logs the status and continues on to the next record9.5.11 UE_PostProcessPOSTransFileThis function is called after all processing of a POS Transaction File and all updates to the PSSdatabase for a POS transaction have been completed.The base PSS software handles the following return codes from the User Exit as follows:All return codes: PSS logs the status9.5.12 UE_PreProcessPSSTransFileThis function is called before processing of a PSS Transaction File is performed. The PSSTransaction file defines a completed by a shopper using a hand held terminal. This is the fileused by the POS to retrieve the PSS shopping trip.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the FILE as if no Pre-Processing was performedUE_DONE: PSS logs the return status and performs NO FILE processingUE_ERROR: PSS logs the return status and performs NO FILE processing
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 112© 2000, Symbol Technologies, Inc. February 1, 20009.5.13 UE_PreProcessPSSTransRecordThis function is called before writing the current header or detail record to a PSS TransactionFile.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE: PSS processes the RECORD as if no preprocessing was performedUE_DONE: PSS performs NO RECORD processing and proceeds to the next record2UE_ERROR: PSS logs the error an proceeds as with UE_ DONE9.5.14 UE_PostProcessPSSTransFileThis function is called after all processing of a PSS Transaction File has been completed and thefile has been closed. The file path to the processed file is passed as an argument.The base PSS software handles the following return codes from the User Exit as follows:All return codes: PSS logs the status9.5.15 UE_CalculateItemPrice_Method10to209.5.16 UE_RescanLevelCalculationThis function is called prior to the standard rescan level recalculation and is intended to replace itwith the user-defined algorithm.The base PSS software handles the following return codes from the User Exit as follows:9.5.17 UE_Pre-RescanDeterminationThis function is called prior to the standard rescan determination algorithm and could beused to either replace or modify the inputs into the algorithm.The base PSS software handles the following return codes from the User Exit as follows:All return codes:
Customizing the PSS System Software______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 113© 2000, Symbol Technologies, Inc. February 1, 20009.5.18 UE_PostRescanDeterminationThis function is called after the standard rescan determination algorithm and could be used tomodify the result of the calculation.The base PSS software handles the following return codes from the User Exit as follows:All return codes:9.5.19 UE_PreProcessMarketingMessageThis function is called prior to the standard marketing message method to allow differentmessages to be sent based upon different criteria.The base PSS software handles the following return codes from the User Exit as follows:All return codes:9.5.20 UE_LoginAuthorizationThis function is called after a user fills out the username and password fields on theAdministration Terminal login screen. It receives the username and password as arguments andmust return as status indicating if the user is authorized.The base PSS software handles the following return codes from the User Exit as follows:UE_CONTINUE PSS performs its default authenticationUE_DONE PSS proceeds considering the user is authorizedUE_ERROR PSS proceeds considering the user is not authorized
System Administration Interface______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 114© 2000, Symbol Technologies, Inc. February 1, 200010. System Administration InterfaceThe System Administration Interface provides browser-based access into the data contained inthe system database, as well as various system control functions. The purpose is to allow storepersonnel to manage the system, obtain information, and provide updates to the information.The available data concerns almost every facet of the system, including:• Customer current and historical data• Messaging• Hardware configuration• Item data and marketing• Reports• System Status• System Configuration10.1 Configuring the Browser SoftwareInstall the desired browser software on the Service Terminal. The recommended browsersoftware packages are:• Netscape Navigator (Netscape Communications Corporation), v4.08 or greater• Microsoft Internet Explorer (Microsoft Corporation), v5.0 or greaterCreate a shortcut icon on the desktop for the browser, for ease of access by store personnel.Set the PSS Administration Main Menu screen as the “HOME” page of your browser software.The home page will then be automatically displayed when the browser software is started. Thepath to the main menu is: http://localhost/pssinterface/administer.asp, where localhost is eitherthe literal text string ‘localhost’ or the name or IP address of the Service Terminal computeritself.10.2 Establish User Accounts on the Service TerminalA browser screen is provided to create employees accounts and control employee access to theService Terminal. To access the screen, from the PSS Main Menu, select System / Settings /Configuration / Administration Users. The Administration Users screen, which is orderedalphabetically by user names, appears. Related user data includes:• Full name of the user.
System Administration Interface______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 115© 2000, Symbol Technologies, Inc. February 1, 2000• Valid starting and expiration dates and times for user’s access to the PSS.• Privilege levelsecurity level to which the user is assigned. This controls the functionsthat are displayed (as described below). These levels, from highest to lowest, are:- Administratorhas the same functions as all others, plus additional functions.- Technicianhas the same functions as Manager and Customer Service, plus someadditional functions.- Managerhas the same functions as Customer Service, plus some additional functions.- Customer Servicehas the fewest functions.• The language spoken or preferred by this administrative user. If a particular text stringdoes not exist for the language preferred by the user, the store language, or, as a last resort,US English will be used.• All data concerning user accounts is stored in the PSS_Admin_User database table.10.3 Understanding User Access to Administrative Pages andActionsFor each security level (Administrator, Technician, Manager, Customer Service) of useraccounts, there is default access established to Administrative Pages (which are browser pages)and to Administrative Page Actions (which are distinct tasks contained on browser pages). Thisallows for a high degree of flexibility in controlling user access.Two browser screens are provided to maintain these Administrative Pages and Page Actions.To access the Administrative Pages screen, from the PSS Main Menu, select System / Settings /Configuration / Admin Pages. The Administration Pages screen, which is ordered alphabeticallyby page name, is displayed. Related data includes:• Page description• Minimum user privilege level• Whether or not authenticated login is required• Whether or not the page is disabledAll data concerning administrative pages is stored in the PSS_Admin_Page database table.To access the Administrative Actions screen, from the PSS Main Menu, select System / Settings/ Configuration / Admin Actions. The Administration Actions screen is displayed. Related dataincludes:• Description of the action• Minimum user privilege level• Whether or not the action is disabled
System Administration Interface______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 116© 2000, Symbol Technologies, Inc. February 1, 2000All data concerning administrative actions is stored in the PSS_Admin_Action database table.The default permission settings for pages and page actions should be sufficient for providingappropriate system access to each level of user. However, differing customer requirements maymake modifications to these default settings necessary.In general, raising the authentication levels to make features available to fewer users is not aproblem, but care should be taken to make sure that each level of user has access to all of thefeatures necessary for their use of the system. For example, a customer service user shouldalways have access to customer-related functions—not only to the obvious lookupuser.asp (FindCustomer) and registeruser.asp (Add Customer) pages--but also to the support pages forcustomer functions, such as issueterminal.asp (Issue Terminal) and unabletoissue.asp (Unable toIssue a Terminal). The same rule applies for privileges on actions.Care be taken that the combinations make sense; for example, requiring higher privilege levelsfor viewing than for modifying a customer name would be largely ineffective.Lowering the authentication levels to make features available to more users should be done withextreme caution. In some cases, lowering authentication levels can, in effect, remove all securityfrom the system (i.e., lowering the privileges on the Administrative Pages or Page Actionspages). Lowering the authentication levels on particular actions could also cause problems. Forexample, lowering the Modify Customer Rescan Level or Modify Gold Customer action couldallow any customer service user to set customers levels so that they would never be rescanned,regardless of previous rescan results. The Suspend / Unsuspend Customer actions could also beabused similarly.10.4 Changing Screen Text on the Service TerminalThe text that appears on the Service Terminal is stored in the PSS_Text database table. TheService Terminal uses Text_IDs from 20000 to 30000 and is organized as follows:Text_ID Contents20001 - 20099 Menu TitlesText appearing in the menu buttons in the Service Terminal menusystem20101 - 20199 Menu Long NamesText appearing in the pop-up “alternate text” descriptions forthe menu buttons in the Service Terminal menu system20201 - 20299 Page TitlesText appearing as the page title in the browser title bar20301 - 20399 Page Short NamesText appearing as the page title at the top of the page, in thenavigation bar, and in the page buttons in the Service Terminal menu system20401 - 20499 Page DescriptionsText appearing as pop-up “alternate text” descriptions for thepage buttons in the Service Terminal menu system.20501 - 20599 Action DescriptionsText appearing as action Descriptions on the Admin Actionspage20601-20699 Page State TitlesText appearing as the page title in the browser title bar for pageswith multiple “states,” for example, the Add Customer page also performs ModifyCustomer activities.
System Administration Interface______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 117© 2000, Symbol Technologies, Inc. February 1, 200020701 - 20799 Page State Short NamesText appearing as the page title at the top of the page, inthe navigation bar, and in the page buttons in the Service Terminal menu systemfor pages with multiple “states.”20801 - 20899 Page State DescriptionsText appearing as pop-up “alternate text”descriptions forthe page buttons in the Service Terminal menu system for pages with multiple“states.”20901 - 20999 Miscellaneous Menu TextText used for particular purposes in the ServiceTerminal menu system, for example, the text for logging in and out of the system isstored here.21000 - 21099 Miscellaneous TextText used for particular purposes throughout the ServiceTerminal, for example, the strings for months of the year, or days of the week arestored here.21101 - 29999 Page TextText for each page in the Service Terminal is stored in this region.The formula for determining the range for a particular page is (21000 + (CurrentPage ID x 100)). Page Ids are all stored in the PSS_Admin_Page table. Forexample, page 51 is the Admin Actions page, and its text region is 21000 + (51 x100) = 26100 (to 26199).10.4.1 Service Terminal System SettingsThe behavior of the Service Terminal can also be modified by a collection of system settings,with Name “SVCTERMINAL.” These settings control:• The use of various features or fields that may not be used at every installation for displayor in calculating the system status• The dimensions of hand-held terminal messaging displays• Service Terminal hardware settings• The length of time before user login sessions time out• Transactions for resetting system software componentsThe PSSSysInit settings provide the transactions for resetting system COM Objects throughWaveWorks. On the System Settings administrative page, there is a link at the bottom of thepage, Re-Initialize PSS System. When this link is selected, a CMS message “PSS998” is sent toall standalone executables, such as services, subscribed as “PSSSYS.” In addition, all systemsettings with Name “SVCTERMINAL” and Subname “PSSSysInitX” (where X is a customstring appended to the Subname) are traversed. The value is sent as a multicasted transaction,that is, sent to all instances of a COM object that handles that particular transaction.Additional transactions may be added to the system by adding system settings with Name“SVCTERMINAL,” Subname “PSSSysInitXXX,” where XXX is a custom string appended tothe Subname. For custom transactions, it is recommended that letters be used for the customstring (e.g., A - Z) to avoid conflicting with future additions to the PSS system, which will usenumbers.
System Administration Interface______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 118© 2000, Symbol Technologies, Inc. February 1, 2000Tx ID: PST105Class: PssDbCleanupCOMMethod: PerformDBCleanupDescription: PerformDBCleanup performs a number of operations to reduce the number ofrows in various database tables, thus improving system performance and eliminating obsolete orunnecessary data. Its operation is configurable based on entries in the system settings with name“PSSDBCleanup.” The configuration is read when the COM object is initialized, and since thisroutine typically runs only once per night, it should happen each time that PerformDBCleanup isrun.The first step is the cleaning of the PSS_Message_Log table. All records in the table that areolder than the configured number of hours and are not required for system reporting are deletedfrom the table. Currently, the only message log entries used for system reporting are those withfacility ‘Unit Management’ and action 'TerminalCount', 'OperationalCount', 'TerminalIssued', or'TerminalReturned'. Actions required for reporting are kept for 13 months, which is the currentlimit for the system reports.Next, the PSS_POS_Status table is processed. All records with a Start_Time or Detection_Timeolder than the configured number of hours for each type is deleted from the table, except for therecords with Item_Name ‘POSControllerName’, for which there is always only one record foreach POS controller in use.Finally, the shopping trip data is processed. This includes both the current shopping list datafrom PSS_Shopping_List, and the historical data from both PSS_Shopping_History_List andPSS_Shopping_Incomplete_List.For current shopping lists, any shopping list data with a Time_Started older than the configurednumber of hours is deleted. Shopping list data includes all associated items(PSS_Shopping_Item), activities (PSS_Shopping_Activity), tax data (PSS_Shopping_Tax),marketing data (PSS_Marketing_Sent), exception items (PSS_Unknown_Item), and quick orderlist (PSS_Order_List) and item (PSS_Order_List_Item) data. Exception item data for whichbarcode was scanned, terminal used, and time of scan is kept in the PSS_Unknown_Item table,but the link to the customer shopping list is removed.Parameters:Input:noneOutput:rc long integer indicates whether the call succeeded
System Administration Interface______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 119© 2000, Symbol Technologies, Inc. February 1, 2000ReturnCode Values:PSS_SUCCESSDB_CONNECT_ERRORDB_OPEN_ERRORDB_EXECUTE_ERRORDB_FETCH_ERRORDB_NO_DATA
Specific Features______________________________________________________________________________WaveWorks PSS, Integration Guide, 1.10 Page 120© 2000, Symbol Technologies, Inc. February 1, 200011. Specific Features11.1 Multiple Language SupportSupport for multiple languages is provided for all screens displayed on the hand held terminals,all screens displayed on the entrance units, and all PSS log messages. All language sensitive textis held in the PSS_Text table in the database. The keys for each text string are a Text ID and aLanguage ID. Based on the key, the string in the proper language is returned.The Active Server Pages used for the System Administration screens will need to be rewritten inthe store’s preferred language, if the store’s preferred language is other than English.11.2 Pricing MethodsSee Appendix C.11.3 Currency ConversionsThe forumla for converting currencies is as follows:Currency Y amount = (Exchange_Rate Y / Exchange_Rate X) * Currency X amountWhere each Exchange_Rate value is read from the PSS_Currency table for the particularcurrencies in use. Exchange_Rates for all currencies should be in the same base amount, that is,a single currency should be chosen as having an exchange rate of 1, and all other currenciesshould be entered as values relative to that currency. For example, if US Dollars is chosen ashaving an Exchange_Rate of 1, Canadian Dollars may have an Exchange_Rate of 1.47. Toconvert 2 Canadian Dollars to US Dollars, the formula is therefore:US Dollar amount = (1 / 1.47) * 2 = 1.36 US Dollars11.4 Control Ticket PrintingThe text that appears on the PSS shopping trip transaction ticket is stored in the PSS_Text tablein the PSS database. The Service Terminal uses Text_IDs starting at 7000.The contents of the transaction ticket are configurable based on system settings inPSS_System_Setting with a name of “TRANSTICKET.”There is also a printing user exit, UE_PrintReceipt, which is called after the Transaction TicketCOM object creates a template print file. The template print file is sent to the Printer Service tobe interpreted to literal print commands for a particular printer.
Appendix AWaveWorks PSS, Integration Guide, 1.10 Page 121© 2000, Symbol Technologies, Inc. February 1, 2000Appendix A Database Layout DiagramThe following diagram represents the database layout for the WaveWorks PSS system.PSS_Admin_MenuMenu_ID: intMenu_Title:h(30)Show_System_Status: char(1)Show_Title: char(1)Show_Image: char(1)Show_Status_Line: char(1)Authenticated: char(1)Disabled: char(1)Parent_Menu_ID: intTarget_Page_Name:h (40)Button_Columns: intSpecial_Type: intRefresh_Seconds: intPSS_Admin_ActionAction_ID: intDescription:h (60)Privilege_Level: intDisabled: char(1)PSS_Marketing_SentCustomer_ID: intShopping_List_ID: intMarketing_Datetime: datetimeItem_ID:h (20)Dept_ID: intMfg_ID: intV1.06 versionPSS_Customer_Suspend_ReasoSuspend_ID: intSuspend_Reason:h (80)PSS_Admin_UserUsername:h (20)Full_Name:h (80)Password:h (20)Valid_Datetime: datetimeExpires_Datetime: datetimePrivilege_Level: intPrivilege_Mask:h (255)Login_Failures: intLast_IP: varchar(16)Language_ID: intWIZARD:PSS3PSS_TextText_ID: intLanguage_ID: intConstant_Name:h (40)Text: varchar(255)PSS_Opening_MessageMsg_ID: intSequence: intLanguage_ID: intMessage: varchar(20)Start_Datetime: datetimeEnd_Datetime: datetimeTarget_Rank: intSymbol Technologies, Inc.,Confidential andPitPSS_CustomerCustomer_ID: intCard_Number:h (30)First_Name:h (40)Middle_Name:h (40)Last_Name:h (40)Address: varchar(40)Address2: varchar(40)City: varchar(40)State: varchar(40)Postal_Code:h (20)Country:h (40)Allow_Promotions: char(1)Allow_Checks: char(1)Currency_ID: intLanguage_ID: intRescan_Level: intRank: intSuspend_Reason:h (80)Card_Expiration_Datetime: datetimeNum_Trips: intNum_Trips_Since_Rescan: intLast_Trip_Datetime: datetimeFirst_Trip_Accurate: char(1)Greeting_Text:h (255)Registered_Datetime: datetimeDisplay_Foodstamp: char(1)Special_Customer: char(1)Suspend_ID: intNum_Rescans: intGroup_ID: intNum_Rescan_Diffs: intNum_Trips_Incomplete: intTotal_Trip_Seconds: intFirst_Trip_Datetime: datetimeLast_Incomplete_Datetime: datetimeTotal_Spent: intLast_Rescan_Datetime: datetimePSS_CurrencyCurrency_ID: intCurrency_Name:h (20)Exchange_Rate: realNum_Decimal_Digits: intDecimal_Char: char(1)Thousands_Char:h(1)Currency_Symbol: char(1)Use_Curr_Symbol: char(1)Price_Times_Factor: intCurrency_Symbol2: char(1)Currency_Symbol_Web: char(1)PSS_LanguageLanguage_ID: intLanguage_Name:h (20)PSS_Marketing_DepartmentDepartment_ID: intLanguage_ID: intMessage_Text:h (255)Target_Coupon_Amt: intTarget_Rank: intStart_Datetime: datetimeEnd_Datetime: datetimePSS_Marketing_MfgManufacturer_ID: intLanguage_ID: intMessage_Text:h (255)Target_Coupon_Amt: intTarget_Rank: intStart_Datetime: datetimeEnd_Datetime: datetimePSS_Marketing_ItemItem_ID:h (20)Language_ID: intMessage_Text:h (255)Target_Coupon_Amt: intTarget_Rank: intStart_Datetime: datetimeEnd_Datetime: datetimePSS_Customer_MessageCustomer_ID: intMessage_Nbr: intMessage_Text:h (255)Start_Datetime: datetimeEnd_Datetime: datetimePSS_Admin_PagePage_ID: intPage_Name:h (40)Privilege_Level: intAuthenticated: char(1)Disabled: char(1)Default_Parms:h (50)Parent_Menu_ID: intParent_Page_ID: int
Appendix AWaveWorks PSS, Integration Guide, 1.10 Page 122© 2000, Symbol Technologies, Inc. February 1, 2000PSS_Shopping_TaxCustomer_ID: intShopping_List_ID: intTax_Plan_ID: intAmount: intTax_Amount: char(18)PSS_Unknown_ItemItem_ID: varchar(20)Terminal_ID: varchar(16)Scanned_Datetime: datetimeCustomer_ID: intShopping_List_ID: intPSS_Tax_TableTax_Plan_ID: intDescription: varchar(40)Price_Range_Low: intTax_Amount_Low: intPrice_Range_High: intTax_Amount_High: intFirst_Tax_Flag: char(1)PSS_Tax_Table_EntryTax_Plan_ID: intRange_Indicator: char(1)Price_Group_Start: intTax_Amount: intPSS_Shopping_ActivityCustomer_ID: intShopping_List_ID: intActivity_Nbr: intActivity_Datetime: datetimeActivity_Type: varchar(10)Activity_Detail: varchar(80)PSS_Shopping_ItemCustomer_ID: intShopping_List_ID: intShopping_Item_ID: intBarcode: varchar(20)Item_ID: varchar(20)Sale_Price: intSale_Price_Currency2: intPricing_Method: char(1)Mix_Match: intDepartment_ID: intUnit_Price: intDeal_Price: intDeal_Qty: intEmbedded_Price: char(1)Tax_Plan: intCurrency_ID: intPSS_Shopping_ListCustomer_ID: intShopping_List_ID: intTime_Started: datetimeTime_Ended: datetimeShopping_List_Status_ID: intTotal: intTotal_Currency_2: intTransaction_ID: varchar(25)Rescanned: char(1)Terminal_ID: varchar(16)Scanned_Item_Count: intTrip_Length_Seconds: intPSS_SessionTerminal_ID: varchar(16)Customer_ID: intShopping_List_ID: intCustomer_Name: varchar(45)Status: intInitiating_Customer_ID: intInitiating_Shopping_List_ID: intPSS_ItemItem_ID: varchar(20)Description: varchar(40)Price: intDepartment_ID: intClass: varchar(20)Subclass: varchar(20)Manufacturer_ID: intAisle: varchar(10)Shelf: varchar(10)Unit: varchar(10)Weight: varchar(20)Linkcode: varchar(20)Pricing_Method: char(1)Mix_Match: intFoodstamp: char(1)Flags: intDeal_Price: intDeal_Qty: intTax_Plan: intPOS_Item_Flag: char(1)Currency_ID: intPSS_DepartmentDepartment_ID: intDepartment_Name: varchar(40)Department_Type: varchar(10)Allow_Quick_Order: char(1)PSS_Order_ListCustomer_ID: intShopping_List_ID: intDepartment_ID: intOrder_List_ID: intOrder_Status_ID: intPSS_Order_List_ItemCustomer_ID: intShopping_List_ID: intDepartment_ID: intOrder_List_ID: intItem_ID: varchar(20)Qty: intNotes: varchar(80)PSS_Order_StatusOrder_Status_ID: intDescription: varchar(20)PSS_Shopping_List_StatusShopping_List_Status_ID: intDescription: varchar(20)PSS_ManufacturerManufacturer_ID: intManufacturer_Name: varchar(20)
Appendix AWaveWorks PSS, Integration Guide, 1.10 Page 123© 2000, Symbol Technologies, Inc. February 1, 2000PSS_Barcode_Variable_WeightBarcode_Type: intBarcode_Prefix: varchar(20)Barcode_Prefix_Length: intItem_Start: intItem_Length: intPrice_Check_Start: intPrice_Check_Length: intPrice_Start: intPrice_Length: intPrice_Or_Weight: char(1)PSS_POS_StatusItem_Name: varchar(30)Instance_Name: varchar(100)Detection_Time: datetimeStart_Time: datetimeEnd_Time: datetimeInstance_Value: varchar(20)Instance_Description: varchar(50)Instance_Data: intPSS_Message_LogMsg_Datetime: datetimeMsg_Facility: varchar(64)Msg_Action: varchar(64)Msg_Severity: intMsg_Message: varchar(255)Msg_Data: intPSS_EODRecvd_Datetime: datetimeDescription: varchar(50)PSS_Shopping_History_RescanCustomer_ID: intShopping_List_ID: intPOS_Price: intPSS_Price: intPOS_Qty: intPSS_Qty: intPSS_Rescan_LevelRescan_Level: intPct: intLevel_Name: varchar(20)PSS_Rescan_DifferenceDifference_Level: intDifference_Amt: intLevel_Change_Amt: intPSS_Shopping_History_ActivityCustomer_ID: intShopping_List_ID: intActivity_Nbr: intActivity_Datetime: datetimeActivity_Type: varchar(10)Activity_Detail: varchar(80)PSS_Shopping_History_ItemCustomer_ID: intShopping_List_ID: intShopping_Item_ID: intBarcode: varchar(20)Item_ID: varchar(20)Sale_Price: intPricing_Method: char(1)Mix_Match: intDepartment_ID: intUnit_Price: intDeal_Price: intDeal_Qty: intEmbedded_Price: char(1)POS_Price: intPOS_PSA_Flag: char(1)Exception: char(1)Tax_Plan: intPSS_Shopping_History_ListCustomer_ID: intShopping_List_ID: intTime_Started: datetimeTime_Ended: datetimeShopping_List_Status_ID: intTotal: intTransaction_ID: varchar(25)Rescanned: char(1)Terminal_ID: varchar(16)Scanned_Item_Count: intTrip_Length_Seconds: intPSS_System_SettingName: varchar(20)Subname: varchar(20)Value: varchar(255)Description: varchar(255)Unit: varchar(10)Default_Value: varchar(255)Editable: char(1)PSS_System_MessageSystem_Message_ID: intMessage_Text: varchar(255)Frequency_Type: intMonth_Of_Year: intDay_Of_Month: intDay_Of_Week: intHour_Of_Day: intMinutes_After_Hour: intTime_Interval: intRepeat_Count: intSend_Next_At_Datetime: datetimePSS_Special_BarcodeBarcode: varchar(20)Type: intDescription: varchar(50)PSS_Shopping_Incomplete_ListCustomer_ID: intShopping_List_ID: intTime_Started: datetimeTime_Ended: datetimeShopping_List_Status_ID: intTotal: intTransaction_ID: varchar(25)Rescanned: char(1)Terminal_ID: varchar(16)Scanned_Item_Count: intTrip_Length_Seconds: int
Appendix AWaveWorks PSS, Integration Guide, 1.10 Page 124© 2000, Symbol Technologies, Inc. February 1, 2000UMS_PowerPower_ID: intDescription: varchar(50)Status_Code: intStatus_Datetime: datetimePower_Notes: varchar(40)UMS_CradleCradle_ID: varchar(4)Power_ID: intDispenser_ID: varchar(4)Status_Code: intStatus_Datetime: datetimeCradle_Notes: varchar(40)Default_Interface: varchar(40)UMS_Terminal_TypesTerminal_Type: varchar(8)Terminal_Class: varchar(50)Default_Interface: varchar(40)Display_Rows: intDisplay_Cols: intKeypad_Type: intUMS_Status_CodesStatus_Code: intStatus_Text: varchar(30)UMS_TerminalTerminal_ID: varchar(16)Cradle_ID: varchar(4)Status_Code: intStatus_Datetime: datetimeBattery_Level: intBattery_Datetime: intTerminal_Type: varchar(8)Good_Scans: intBad_Scans: intSeconds_Used: intTot_Issue_Count: intTot_Good_Scans: intTot_Bad_Scans: intTot_Seconds_Used: intTimeout_Count: intCurrent_Interface: varchar(50)Dispenser_ID: varchar(4)Terminal_Notes: varchar(40)Battery_Status: intUMS_PrinterPrinter_ID: intDescription: varchar(50)Printer_Type: intPrinter_Port: varchar(8)Status_Code: intStatus_Datetime: datetimeBackup_ID: intCurrent_Mode: intHardware_ID: varchar(16)Printer_Notes: varchar(40)Paper_Remaining: intUMS_EntranceEntrance_ID: intDescription: varchar(50)Reader_Type: intReader_Port: varchar(8)Status_Code: intStatus_Datetime: datetimeDisplay_Type: intDisplay_Port: varchar(8)Default_Mode: intCurrent_Mode: intBackup_ID: intHardware_ID: varchar(16)Reader_Status: intDisplay_Status: intEntrance_Notes: varchar(40)UMS_DispenserDispenser_ID: varchar(4)Dispenser_Name: varchar(50)Entrance_ID: intPrinter_ID: intDefault_Entrance: intStatus_Code: intStatus_Datetime: datetimeDefault_Printer: intCurrent_Mode: intUMS_Card_Reader_TypeReader_Type: intDescription: varchar(50)Card_Sentinel: varchar(5)Card_Offset: intEnd_Sentinel: varchar(5)
DecembeAppendix B Database Tables / Physical PropertiesB.1 Table Name: PSS_Admin_ActionTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKAction_ID int NOT NULL Yes NoDescription varchar(60) NULL No NoPrivilege_Level int NULL No NoDisabled char(1) NULL No NoPSS Admin Action Table holds privilege information for various actions available through theservice terminalAction_ID unique ID associated with this Administrative ActionDescription description of this Administrative ActionPrivilege_Level privilege level associated with this Administrative ActionDisabled indicates whether this Administrative Action is disabled or notB.2 Table Name: PSS_Admin_MenuTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKMenu_ID int NOT NULL Yes NoMenu_Title varchar(30) NULL No NoShow_System_Status char(1) NULL No NoShow_Title char(1) NULL No NoShow_Image char(1) NULL No NoShow_Status_Line char(1) NULL No NoAuthenticated char(1) NULL No NoDisabled char(1) NULL No NoParent_Menu_ID int NULL No NoTarget_Page_Name varchar(40) NULL No NoButton_Columns int NULL No NoSpecial_Type int NULL No NoRefresh_Seconds int NULL No NoPSS Admin Menu Table holds configuration information for the service terminal menu systemMenu_ID unique ID associated with this Administrative Menu entryMenu_Title title of this Administrative Menu entryShow_System_Status indicates whether the system status displays on this Administrative Menupage or notShow_Title indicates whether the menu title displays on this Administrative Menu page or notShow_Image indicates whether the PSS menu image displays on this Administrative Menupage or notShow_Status_Line indicates whether the status line (showing copyright and current time)displays on this Administrative Menu page or not
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 126© 2000, Symbol Technologies, Inc. February 1, 2000Authenticated indicates whether this Administrative Menu entry requires authenticationor notDisabled indicates whether this Administrative Menu entry is disabled or notParent_Menu_ID the Menu ID of the parent page to this Administrative Menu entryTarget_Page_Name name of the ASP script that this Administrative Menu entry points toButton_Columns number of buttons across this Administrative Menu pageSpecial_Type indicates whether this page is of a special type (e.g. a login/out button)Refresh_Seconds number of seconds before this Administrative Menu page shouldautomatically refreshB.3 Table Name: PSS_Admin_PageTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKPage_ID int NOT NULL Yes NoPage_Name varchar(40) NULL No NoPrivilege_Level int NULL No NoAuthenticated char(1) NULL No NoDisabled char(1) NULL No NoDefault_Parms varchar(50) NULL No NoParent_Menu_ID int NULL No NoParent_Page_ID int NULL No NoPSS Admin Page Table holds privilege and configuration information for the service terminalAdministrative PagesPage_ID unique ID associated with this Administrative PagePage_Name name of this Administrative PagePrivilege_Level privilege level required to access this Administrative PageAuthenticated indicates whether this Administrative Page is authenticated or notDisabled indicates whether this Administrative Page is disabled or notDefault_Parms the default parameters sent in the URL when running this AdministrativePageParent_Menu_ID the Administrative Menu Page ID on which a link to this AdministrativePage appearsParent_Page_ID the Administrative Page ID that acts as a parent to this AdministrativePageB.4 Table Name: PSS_Admin_UserTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKUsername varchar(20) NOT NULL Yes NoFull_Name varchar(80) NULL No NoPassword varchar(20) NULL No NoValid_Datetime datetime NULL No NoExpires_Datetime datetime NULL No NoPrivilege_Level int NULL No No
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 127© 2000, Symbol Technologies, Inc. February 1, 2000Privilege_Mask varchar(255) NULL No NoLogin_Failures int NULL No NoLast_IP varchar(16) NULL No NoLanguage_ID int NULL No YesPSS Admin User Table holds information about Service Terminal UsersUsername the username this Administrative User will log in asFull_Name the full name of this Administrative UserPassword the password this Administrative User will use to log inValid_Datetime the date/time this Administrative User account is activeExpires_Datetime the date/time this Administrative User account is no longer activePrivilege_Level the privilege level of this Administrative UserPrivilege_Mask the privilege mask for this Administrative User (currently unused)Login_Failures number of failures since the last successful login for this AdministrativeUserLast_IP the last IP address from which this Administrative User last accessed theiraccountLanguage_ID the language (from PSS_Language) in which this Administrative Userprefers to view the service terminalB.5 Table Name: PSS_Barcode_Variable_WeightTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKBarcode_Type int NOT NULL No NoBarcode_Prefix varchar(20) NULL No NoBarcode_Prefix_Length int NULL No NoItem_Start int NULL No NoItem_Length int NULL No NoPrice_Check_Start int NULL No NoPrice_Check_Length int NULL No NoPrice_Start int NULL No NoPrice_Length int NULL No NoPrice_Or_Weight char(1) NULL No NoPSS Barcode Variable Weight Table holds configuration information for price or weight-embedded barcodesBarcode_Type Type of Barcode (unknown, UPC, EAN, etc.)Barcode_Prefix Sequence of digits starting the embedded barcodeBarcode_Prefix_Length Length of prefixItem_Start Position of start of item codeItem_Length Length of item codePrice_Check_Start Position of price check digitPrice_Check_Length Length of price check digit(s)Price_Start Position of pricePrice_Length Length of pricePrice_Or_Weight Indicates whether barcode is Price or Weight embedded
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 128© 2000, Symbol Technologies, Inc. February 1, 2000B.6 Table Name: PSS_CurrencyTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCurrency_ID int NOT NULL Yes NoCurrency_Name varchar(20) NULL No NoExchange_Rate real NULL No NoNum_Decimal_Digits int NULL No NoDecimal_Char char(1) NULL No NoThousands_Char char(1) NULL No NoCurrency_Symbol char(1) NULL No NoUse_Curr_Symbol char(1) NULL No NoPrice_Times_Factor int NULL No NoCurrency_Symbol2 char(1) NULL No NoCurrency_Symbol_Web char(1) NULL No NoPSS Currency Table holds the supported currency types and conversion ratesCurrency ID Unique ID associated with this currencyCurrency Name text name of currencyExchange Rate exchange rate with base currencyNum_Decimal_Digits number of digits in the stored integer value that are decimal digitsDecimal_Char character used to delineate the decimal portionThousands_Char character used to delineate groups of three decimal digitsCurrency_Symbol currency symbol used for display on hand-held terminalsUse_Curr_Symbol indicates whether the currency symbol should be used in displayPrice_Times_Factor amount that a stored value should be multiplied by to arrive at adisplayable valueCurrency_Symbol2 currency symbol used for display on printed transaction ticketsCurrency_Symbol_Web currency symbol used for display on service terminal pagesB.7 Table Name: PSS_CustomerTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes NoCard_Number varchar(30) NOT NULL No NoFirst_Name varchar(40) NULL No NoMiddle_Name varchar(40) NULL No NoLast_Name varchar(40) NULL No NoAddress varchar(40) NULL No NoAddress2 varchar(40) NULL No NoCity varchar(40) NULL No NoState varchar(40) NULL No NoPostal_Code varchar(20) NULL No NoCountry varchar(40) NULL No NoAllow_Promotions char(1) NULL No NoAllow_Checks char(1) NULL No No
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 129© 2000, Symbol Technologies, Inc. February 1, 2000Currency_ID int NULL No YesLanguage_ID int NULL No YesRescan_Level int NULL No NoRank int NULL No NoSuspend_Reason varchar(80) NULL No NoCard_Expiration_Datetime datetime NULL No NoNum_Trips int NULL No NoNum_Trips_Since_Rescan int NULL No NoLast_Trip_Datetime datetime NULL No NoFirst_Trip_Accurate char(1) NULL No NoGreeting_Text varchar(255) NULL No NoRegistered_Datetime datetime NULL No NoDisplay_Foodstamp char(1) NULL No NoSpecial_Customer char(1) NULL No NoSuspend_ID int NULL No YesNum_Rescans int NULL No NoGroup_ID int NULL No NoNum_Rescan_Diffs int NULL No NoNum_Trips_Incomplete int NULL No NoTotal_Trip_Seconds int NULL No NoFirst_Trip_Datetime datetime NULL No NoLast_Incomplete_Datetime datetime NULL No NoTotal_Spent int NULL No NoLast_Rescan_Datetime datetime NULL No NoPSS Customer Table holds all persistent data needed for a given PSS user.Customer_ID a unique identifier for a given customerCard_Number number on PSS shopper loyalty card which matches this customerFirst_Name customer first nameMiddle_Name customer middle nameLast_Name customer last nameAddress customer addressAddress2 customer address, line 2City customer cityState customer state/provincePostal_Code customer postal codeCountry customer countryAllow_Promotions indicates whether this customer allows marketing message displayon hand-held terminalAllow_Checks indicates whether this customer may be rescannedCurrency_ID customer preferred currency (from PSS_Currency)Language_ID customer preferred language (from PSS_Language)Rescan_Level customer rescan level (from PSS_Rescan_Level)Rank customer rank (0 to 100), typically based on amount spent throughPSS in last 30 daysSuspend_Reason reason text for customer suspension from PSSCard_Expiration_Datetime expiration date/time of the customer’s loyalty cardNum_Trips number of PSS shopping trips this customer has been onNum_Trips_Since_Rescan number of PSS shopping trips since this customer was lastrescannedLast_Trip_Datetime date/time of this customer’s last PSS shopping tripFirst_Trip_Accurate indicates whether the customer’s first shopping trip resulted in anaccurate rescan
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 130© 2000, Symbol Technologies, Inc. February 1, 2000Greeting_Text greeting text to be displayed upon dispensing a terminal to thiscustomerRegistered_Datetime date/time that this customer was added to PSSDisplay_Foodstamp indicates whether this customer is shown foodstamp totals on theirand-held terminalSpecial_Customer indicates whether this is a special type of customer (e.g. Queue-Buster, Price Checker, or Express Shopping-type customer)Suspend_ID indicates whether this customer is suspended from PSS, and withwhich reason code (from PSS_Customer_Suspend_Reason)Num_Rescans number of rescanned PSS shopping trips for this customerGroup_ID number used for grouping customers (e.g. family cards, etc.)Num_Rescan_Diffs number of rescanned PSS shopping trips with item count/amountdifferences for this customerNum_Trips_Incomplete number of incomplete PSS shopping trips (started, but neverchecked out) for this customerTotal_Trip_Seconds total number of seconds this customer has spent shopping using aPSS hand-held terminalFirst_Trip_Datetime date/time of the first PSS shopping trip for this customerLast_Incomplete_Datetime date/time of the last incomplete PSS shopping trip for thiscustomerTotal_Spent total amount this customer has spent using PSSLast_Rescan_Datetime date/time of the last rescanned shopping trip for this customerB.8 Table Name: PSS_Customer_MessageTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesMessage_Nbr int NOT NULL Yes NoMessage_Text varchar(255) NULL No NoStart_Datetime datetime NULL No NoEnd_Datetime datetime NULL No NoPSS Customer Message Table holds messages to be displayed at the start of a shopping trip fora particular PSS customer.Customer_ID unique identifier for this customerMessage_Nbr unique identifier for this message for this customerMessage_Text message text to be displayedStart_Datetime date/time after which this message is to be displayedEnd_Datetime date/time after which this message will no longer be displayedB.9 Table Name: PSS_Customer_Suspend_Reason
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 131© 2000, Symbol Technologies, Inc. February 1, 2000Table Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKSuspend_ID Int NOT NULL Yes NoSuspend_Reason Varchar(80) NULL No NoPSS Customer Suspend Reason Table holds the Suspend ID reason codes for which acustomer may be suspended from using PSS.Suspend_ID unique identifier for this suspend reason codeSuspend_Reason text description of this suspend reason codeB.10 Table Name: PSS_DepartmentTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKDepartment_ID Int NOT NULL Yes NoDepartment_Name Varchar(40) NULL No NoDepartment_Type Varchar(10) NULL No NoAllow_Quick_Order char(1) NULL No NoPSS Department Table contains the data describing a store’s departmentsDepartment ID Unique identifier for a departmentDepartment Name text name of department Department Type text type of department (meant to provide particular functionality fordepartments that require universal functionality, i.e. functionalityparticular to all deli’s)Allow Quick Order when set, this department shows up in the quick order department listB.11 Table Name: PSS_EODTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKRecvd_Datetime Datetime NOT NULL Yes NoDescription varchar(50) NULL No NoPSS EOD Table contains the End-Of-Day indicators received from the POS.Recvd_Datetime date/time when this End-Of-Day indicator was receivedDescription description of this End-Of-Day indicator
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 132© 2000, Symbol Technologies, Inc. February 1, 2000B.12 Table Name: PSS_ItemTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKItem_ID varchar(20) NOT NULL Yes NoDescription varchar(40) NULL No NoPrice Int NULL No NoDepartment_ID Int NULL No YesClass varchar(20) NULL No NoSubclass varchar(20) NULL No NoManufacturer_ID Int NULL No YesAisle varchar(10) NULL No NoShelf varchar(10) NULL No NoUnit varchar(10) NULL No NoWeight varchar(20) NULL No NoLinkcode varchar(20) NULL No NoPricing_Method char(1) NULL No NoMix_Match Int NULL No NoFoodstamp char(1) NULL No NoFlags Int NULL No NoDeal_Price Int NULL No NoDeal_Qty Int NULL No NoTax_Plan int NULL No NoPOS_Item_Flag char(1) NULL No NoCurrency_ID int NULL No NoPSS Item Table holds item information; source of information can be the POS item fileItem ID unique item identifierDescription text description of the itemPrice unit price of the item represented in the base store currency Department ID unique identifier for the department assigned to this item (fromPSS_Department)Class the classification group of this itemSubclass a more specific classification of an item within a classManufacturer ID unique identifier for this item manufacturer (from PSS_Manufacturer)Aisle usual aisle in store for this itemShelf shelf location in store Unit the unit used to measure quantities of an item (i.e. fluid ounces, pounds,etc.)Weight the amount of the unitLinkcode a barcode for an item linked to this itemPricing Method identifies pricing method to be used for this itemMix Match when set, this item is part of an identically priced group (i.e. yogurts,canned soups)Foodstamp when set, indicates that this item is food stamp eligible Flags holds information specific to the item (i.e. discontinued, applicable taxlevels, etc.)Deal Price The price of the deal, if any, assigned to this itemDeal Quantity quantity of this item which must be purchased to enable the deal Tax_Plan unique identifier for the text plan under which this item falls (fromPSS_Tax_Table)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 133© 2000, Symbol Technologies, Inc. February 1, 2000 POS_Item_Flag indicates whether this item has been processed through the POS during thecurrent download process Currency_ID currency identifier for the currency in which this items price is described(from PSS_Currency)B.13 Table Name: PSS_LanguageTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKLanguage_ID Int NOT NULL Yes NoLanguage_Name Varchar(20) NULL No NoPSS Language Table holds the languages supported by the systemLanguage ID unique identifier for a languageLanguage Name text name of languageB.14 Table Name: PSS_ManufacturerTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKManufacturer_ID int NOT NULL Yes NoManufacturer_Name varchar(20) NULL No NoPSS Manufacturer Table holds the manufacturers for PSS itemsManufacturer ID unique identifier for a manufacturerManufacturer Name text name of manufacturerB.15 Table Name: PSS_Marketing_DepartmentTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKDepartment_ID int NOT NULL Yes YesLanguage_ID int NOT NULL Yes YesMessage_Text varchar(255) NULL No NoTarget_Coupon_Amt int NULL No NoTarget_Rank int NULL No NoStart_Datetime datetime NULL No NoEnd_Datetime datetime NULL No NoPSS Marketing Department Table contains the marketing messages for particular departmentsDepartment ID unique department identifier (from PSS_Department)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 134© 2000, Symbol Technologies, Inc. February 1, 2000Language_ID language that this message is in (from PSS_Language)Message Text marketing message textTarget Coupon Amt if the message contains a coupon offer, this is the amount of the couponTarget Rank the customer rank level targeted by this messageStart_Datetime date/time after which this message is to be displayedEnd_Datetime date/time after which this message will no longer be displayedB.16 Table Name: PSS_Marketing_ItemTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKItem_ID varchar(20) NOT NULL Yes YesLanguage_ID int NOT NULL Yes YesMessage_Text varchar(255) NULL No NoTarget_Coupon_Amt int NULL No NoTarget_Rank int NULL No NoStart_Datetime datetime NULL No NoEnd_Datetime datetime NULL No NoPSS Marketing Item Table contains the marketing messages for particular itemsItem ID unique item identifier (from PSS_Item)Language_ID language that this message is in (from PSS_Language)Message Text marketing message textTarget Coupon Amt if the message contains a coupon offer, this is the amount of the couponTarget Rank the customer rank level targeted by this messageStart_Datetime date/time after which this message is to be displayedEnd_Datetime date/time after which this message will no longer be displayedB.17 Table Name: PSS_Marketing_MfgTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKManufacturer_ID Int NOT NULL Yes YesLanguage_ID Int NOT NULL Yes YesMessage_Text Varchar(255) NULL No NoTarget_Coupon_Amt int NULL No NoTarget_Rank int NULL No NoStart_Datetime datetime NULL No NoEnd_Datetime datetime NULL No NoPSS Marketing Mfg Table contains the marketing messages for particular manufacturersManufacturer ID unique identifier for this manufacturer (from PSS_Manufacturer)Language_ID language that this message is in (from PSS_Language)Message Text marketing message text
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 135© 2000, Symbol Technologies, Inc. February 1, 2000Target Coupon Amt if the message contains a coupon offer, this is the amount of the couponTarget Rank the customer rank level targeted by this messageStart_Datetime date/time after which this message is to be displayedEnd_Datetime date/time after which this message will no longer be displayedB.18 Table Name: PSS_Marketing_SentTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID Int NOT NULL Yes NoShopping_List_ID Int NOT NULL Yes NoMarketing_Datetime Datetime NOT NULL Yes NoItem_ID Varchar(20) NULL No NoDept_ID Int NULL No NoMfg_ID Int NULL No NoPSS Marketing Sent Table contains information on which marketing messages have been sentto which customers on current shopping tripsCustomer ID unique identifier for this customer (from PSS_Customer)Shopping List ID identifies shopping list (from PSS_Shopping_List)Marketing_Datetimedate/time when this message was displayed to the customerItem ID unique item identifier for item messages (from PSS_Item)Department ID unique department identifier for department messages (fromPSS_Department)Manufacturer ID unique identifier for this manufacturer for manufacturer messages (fromPSS_Manufacturer)B.19 Table Name: PSS_Message_LogTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKMsg_Datetime datetime NOT NULL No NoMsg_Facility varchar(64) NOT NULL No NoMsg_Action varchar(64) NOT NULL No NoMsg_Severity int NOT NULL No NoMsg_Message varchar(255) NULL No NoMsg_Data int NULL No NoPSS Message Log Table contains logging information from PSS processesMsg_Datetime date/time this message was loggedMsg_Facility the facility logging this action (e.g. POSInterfaceCOM)Msg_Action the action this facility was performingMsg_Severity the severity level of this message (e.g. Informational, Fatal, etc.)Msg_Message the message text of this messageMsg_Data optional integer data associated with this message
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 136© 2000, Symbol Technologies, Inc. February 1, 2000B.20 Table Name: PSS_Opening_MessageTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKMsg_ID Int NOT NULL Yes NoSequence Int NOT NULL Yes NoLanguage_ID Int NOT NULL Yes YesMessage Varchar(20) NULL No NoStart_Datetime Datetime NULL No NoEnd_Datetime Datetime NULL No NoTarget_Rank Int NULL No NoPSS Opening Message Table holds messages that the customer may scroll through at the startof a shopping tripMsg_ID unique identifier for this messageSequence sequence number for this line of this messageLanguage_ID the language this message is in (from PSS_Language)Message the message text for this lineStart_Datetime date/time after which this message is to be displayedEnd_Datetime date/time after which this message will no longer be displayedTarget_Rank the customer rank level targeted by this messageB.21 Table Name: PSS_Order_ListTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID Int NOT NULL Yes YesShopping_List_ID Int NOT NULL Yes YesDepartment_ID Int NOT NULL Yes YesOrder_List_ID Int NOT NULL Yes NoOrder_Status_ID Int NULL No YesPSS Order List Table contains the quick-order list informationCustomer ID identifies customer associated with this order (from PSS_Customer)Shopping List ID identifies the customer shopping list associated with this order (fromPSS_Shopping_List)Department ID the department which this order is for (from PSS_Department)Order List ID unique identifier for this quick order listOrder Status ID status of this order (from PSS_Order_Status, e.g. ready, picked up, etc.)B.22 Table Name: PSS_Order_List_Item
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 137© 2000, Symbol Technologies, Inc. February 1, 2000Table Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes YesDepartment_ID int NOT NULL Yes YesOrder_List_ID int NOT NULL Yes YesItem_ID varchar(20) NOT NULL Yes YesQty int NULL No NoNotes varchar(80) NULL No NoPSS Order List Item Table contains the item information in a customer orderCustomer ID identifies customer associated to this order itemShopping List ID identifies shopping list associated to this order itemDepartment ID the department which this order is forOrder List ID unique identifier for this quick order list (from PSS_Order_List)Item ID identifies item in the listQty quantity ordered of this itemNotes text field entered via browser screenB.23 Table Name: PSS_Order_StatusTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKOrder_Status_ID int NOT NULL Yes NoDescription varchar(20) NULL No NoPSS Order Status Table contains the allowable order statesOrder Status ID status identifierDescription text message corresponding to this statusB.24 Table Name: PSS_POS_StatusTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKItem_Name varchar(30) NOT NULL Yes NoInstance_Name varchar(100) NOT NULL Yes NoDetection_Time datetime NULL No NoStart_Time datetime NULL No NoEnd_Time datetime NULL No NoInstance_Value varchar(20) NULL No NoInstance_Description varchar(50) NULL No NoInstance_Data int NULL No NoPSS POS Status Table contains the quick-order list informationItem_Name the type of entry this is (e.g. POSControllerName, PSSItemFile)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 138© 2000, Symbol Technologies, Inc. February 1, 2000Instance_Name the particular instance of this type of entry (typically the controller or filename)Detection_Time date/time when the activity was initiatedStart_Time date/time when the processing startedEnd_Time date/time when the processing endedInstance_Value text value associated with this entryInstance_Description text description associated with this entryInstance_Data integer data associated with this entryB.25 Table Name: PSS_Rescan_DifferenceTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKDifference_Level int NOT NULL Yes NoDifference_Amt int NULL No NoLevel_Change_Amt int NULL No NoPSS Rescan Difference Table contains the difference amounts (in currency or percent) betweena PSS shopping list, and the re-scanned shopping list, necessary to reduce a customer’s rescanpossibility by the given number of levels.Difference Level difference level identifierDifference Amount the minimum currency amount or percentage necessary for a rescan toqualify he customer for this difference levelLevel Change Amt the number of rescan levels that a customer qualifying for this differencelevel will be reduced by, a greater number of rescan levels indicating agreater possibility of being checked on the next trip.B.26 Table Name: PSS_Rescan_LevelTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKRescan_Level int NOT NULL Yes NoPct int NULL No NoLevel_Name varchar(20) NULL No NoPSS Rescan Level Table contains the rescan levels and the associated probability of beingchecked when qualifying for each level. Level 1 will hold the highest probability level (i.e. 1:1,or a 100% chance of rescanning on the next PSS shopping trip), with subsequent levels holdingincreasingly lower probabilities.Rescan_Level rescan level identifierPct the probability 1 in N that this customer will be rescanned on the nextshopping trip.Level_Name name for this rescan level
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 139© 2000, Symbol Technologies, Inc. February 1, 2000B.27 Table Name: PSS_SessionTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKTerminal_ID varchar(16) NOT NULL Yes NoCustomer_ID int NOT NULL No YesShopping_List_ID int NOT NULL No YesCustomer_Name varchar(45) NULL No NoStatus int NULL No NoInitiating_Customer_ID int NULL No NoInitiating_Shopping_List_ID int NULL No NoPSS Session Table contains the high level PSS terminal issue informationTerminal ID unique hand held terminal identifier (from UMS_Terminal)Customer ID identifies customer (from PSS_Customer)Shopping List ID identifies shopping list (from PSS_Shopping_List)Customer Name abbreviated version of the customer name for hand-held terminal displayStatus status of this session (used to mark queue-busting session in progress, etc.)Initiating_Customer_ID identifies the customer who started this session (used to maintain themain queue-busting customer)Initiating_Shopping_List_ID identifies the shopping list created by the customer who startedthis session (used to maintain the main queue-busting customer’s shoppinglist)B.28 Table Name: PSS_Shopping_ActivityTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID Int NOT NULL Yes YesShopping_List_ID Int NOT NULL Yes YesActivity_Nbr Int NOT NULL Yes NoActivity_Datetime Datetime NULL No NoActivity_Type Varchar(10) NULL No NoActivity_Detail Varchar(80) NULL No NoPSS Shopping Activity Table contains activities that occurred on the hand-held terminal duringa shopping trip, including addition/removal of items, marketing messages displayed on theterminal, etc.Customer ID identifies the customer (from PSS_Customer)Shopping List ID identifies shopping list (from PSS_Shopping_List)Activity Nbr a sequential number showing the order in which the events occurredActivity Datetime the date and time of the activityActivity Type the type of activity which occurred (i.e. ADDITEM, DELITEM, etc.)Activity Detail a description of the activity which occurred
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 140© 2000, Symbol Technologies, Inc. February 1, 2000B.29 Table Name: PSS_Shopping_History_ActivityTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID Int NOT NULL Yes YesShopping_List_ID Int NOT NULL Yes YesActivity_Nbr Int NOT NULL Yes NoActivity_Datetime Datetime NULL No NoActivity_Type Varchar(10) NULL No NoActivity_Detail Varchar(80) NULL No NoPSS Shopping History Activity Table contains activities that occurred on the hand-heldterminal during a historical shopping trip, including addition/removal of items, marketingmessages displayed on the terminal, etc.Customer ID identifies the customer (from PSS_Customer)Shopping List ID identifies shopping list (from PSS_Shopping_List)Activity Nbr a sequential number showing the order in which the events occurredActivity Datetime the date and time of the activityActivity Type the type of activity which occurred (i.e. ADDITEM, DELITEM, etc.)Activity Detail a description of the activity which occurred
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 141© 2000, Symbol Technologies, Inc. February 1, 2000B.30 Table Name: PSS_Shopping_History_ItemTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes YesShopping_Item_ID int NOT NULL Yes NoBarcode varchar(20) NULL No NoItem_ID varchar(20) NULL No NoSale_Price int NULL No NoPricing_Method char(1) NULL No NoMix_Match int NULL No NoDepartment_ID int NULL No NoUnit_Price int NULL No NoDeal_Price int NULL No NoDeal_Qty int NULL No NoEmbedded_Price char(1) NULL No NoPOS_Price int NULL No NoPOS_PSA_Flag char(1) NULL No NoException char(1) NULL No NoTax_Plan int NULL No NoPSS Shopping History Item Table contains the items for a given historical shopping tripCustomer ID customer whom which this shopping trip is associated (fromPSS_Customer)Shopping List ID shopping list with which this item is associated (fromPSS_Shopping_List)Shopping Item ID sequential unique item identifierBarcode the actual barcode scanned before any translation occurs (i.e. forembedded price barcodes)Item ID item ID as matched against item information in PSS_ItemSale Price the actual price paid for this itemPricing_Method the pricing method used to price this itemMix_Match the POS mix/match category this item was included inDepartment_ID the department ID (from PSS_Department) that this item belongs toUnit_Price the unit price for this item (from PSS_Item)Deal_Price the deal price for this item (from PSS_Item)Deal_Qty the deal quantity for this item (from PSS_Item)Embedded_Price indicates whether this item had an embedded price barcodePOS_Price the price for this item sent from the POSPOS_PSA_Flag indicates whether this item was in the PSS shopping list (S) only, the POSshopping list (P) only, or both (B).Exception indicates whether this was flagged as an exception item at checkoutTax_Plan indicates the tax plan that applied to this item (from PSS_Tax_Table)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 142© 2000, Symbol Technologies, Inc. February 1, 2000B.31 Table Name: PSS_Shopping_History_ListTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes NoTime_Started datetime NULL No NoTime_Ended datetime NULL No NoShopping_List_Status_ID int NULL No NoTotal int NULL No NoTransaction_ID varchar(25) NULL No NoRescanned char(1) NULL No NoTerminal_ID varchar(16) NULL No NoScanned_Item_Count int NULL No NoTrip_Length_Seconds int NULL No NoPSS Shopping History List Table contains the high-level historical shopping trip information.Once shopping trips are completed, the data is moved into the historical tables.Customer ID customer with whom this shopping trip is associated (fromPSS_Customer)Shopping List ID unique shopping list identifierTime Started the date and time that a shopping list was startedTime Ended the date and time that a shopping list was completedShopping List Status ID status of this shopping trip (from PSS_Shopping_List_Status)Total total amount for this tripTransaction_ID transaction identifier sent to/from the POS to help match shopping listsRescanned indicates whether this shopping trip was rescanned Terminal_ID the terminal ID (from UMS_Terminal) of the terminal last used on thisshopping tripScanned_Item_Count number of items in this shopping listTrip_Length_Seconds number of seconds the terminal was in use for this shopping trip
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 143© 2000, Symbol Technologies, Inc. February 1, 2000B.32 Table Name: PSS_Shopping_History_RescanTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes YesPOS_Price int NULL No NoPSS_Price int NULL No NoPOS_Qty int NULL No NoPSS_Qty int NULL No NoPSS Shopper History Rescan Table contains the re-scan data for a customer’s previousshopping trip.Customer ID customer with whom this shopping trip is associated (fromPSS_Customer)Shopping List ID unique shopping list identifierPOS Price the re-scanned shopping list amount from the POSPSS Price the original shopping list amount from PSSPOS Qty the number of items in the re-scanned shopping list from the POSPSS Price the number of items in the original shopping list amount from PSSB.33 Table Name: PSS_Shopping_Incomplete_ListTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes NoTime_Started datetime NULL No NoTime_Ended datetime NULL No NoShopping_List_Status_ID int NULL No NoTotal int NULL No NoTransaction_ID varchar(25) NULL No NoRescanned char(1) NULL No NoTerminal_ID varchar(16) NULL No NoScanned_Item_Count int NULL No NoTrip_Length_Seconds int NULL No NoPSS Shopping Incomplete List Table contains the high-level shopping trip information forincomplete shopping trips. The DB Cleanup task moves all current shopping trips that haven’tbeen checked out after a configurable length of time (8 hours is the default) to this table.Customer ID customer with whom this shopping trip is associated (fromPSS_Customer)Shopping List ID unique shopping list identifierTime Started the date and time that a shopping list was startedTime Ended the date and time that a shopping list was completedShopping List Status ID status of this shopping trip (from PSS_Shopping_List_Status)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 144© 2000, Symbol Technologies, Inc. February 1, 2000Total total amount for this tripTransaction_ID transaction identifier sent to/from the POS to help match shopping listsRescanned indicates whether this shopping trip was rescannedTerminal_ID the terminal ID (from UMS_Terminal) of the terminal last used on thisshopping tripScanned_Item_Count number of items in this shopping listTrip_Length_Seconds number of seconds the terminal was in use for this shopping trip
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 145© 2000, Symbol Technologies, Inc. February 1, 2000B.34 Table Name: PSS_Shopping_ItemTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes YesShopping_Item_ID int NOT NULL Yes NoBarcode varchar(20) NULL No NoItem_ID varchar(20) NULL No YesSale_Price int NULL No NoSale_Price_Currency2 int NULL No NoPricing_Method char(1) NULL No NoMix_Match int NULL No NoDepartment_ID int NULL No NoUnit_Price int NULL No NoDeal_Price int NULL No NoDeal_Qty int NULL No NoEmbedded_Price char(1) NULL No NoTax_Plan int NULL No NoCurrency_ID int NULL No NoPSS Shopping Item Table contains the items for a given current shopping tripCustomer ID customer with whom this shopping trip is associated (fromPSS_Customer)Shopping List ID shopping list with which this item is associated (fromPSS_Shopping_List)Shopping Item ID sequential unique item identifierBarcode the actual barcode scanned before any translation occurs (i.e. forembedded price barcodes)Item ID item ID as matched against item information in PSS_ItemSale Price the actual price paid for this itemSale_Price_Currency2 the actual price paid for this item in the secondary currencyPricing_Method the pricing method used to price this itemMix_Match the POS mix/match category this item was included inDepartment_ID the department ID (from PSS_Department) that this item belongs toUnit_Price the unit price for this item (from PSS_Item)Deal_Price the deal price for this item (from PSS_Item)Deal_Qty the deal quantity for this item (from PSS_Item)Embedded_Price indicates whether this item had an embedded price barcodeTax_Plan indicates the tax plan that applied to this item (from PSS_Tax_Table)Currency_ID currency identifier (from PSS_Currency) for the currency in whichSale_Price is described
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 146© 2000, Symbol Technologies, Inc. February 1, 2000B.35 Table Name: PSS_Shopping_ListTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes NoTime_Started datetime NULL No NoTime_Ended datetime NULL No NoShopping_List_Status_ID int NULL No YesTotal int NULL No NoTotal_Currency_2 int NULL No NoTransaction_ID varchar(25) NULL No NoRescanned char(1) NULL No NoTerminal_ID varchar(16) NULL No NoScanned_Item_Count int NULL No NoTrip_Length_Seconds int NULL No NoPSS Shopping List Table contains the high level shopping trip informationCustomer ID customer with whom this shopping trip is associated (fromPSS_Customer)Shopping List ID unique shopping list identifierTime Started the date and time that this shopping list was startedTime Ended the date and time that this shopping list was completedShopping List Status ID status of this shopping trip (from PSS_Shopping_List_Status)Total total amount for this tripTransaction_ID transaction identifier sent to/from the POS to help match shoppinglistsRescanned indicates whether this shopping trip was rescannedTerminal_ID terminal ID (from UMS_Terminal) of the terminal last used on thisshopping tripScanned_Item_Count number of items in this shopping listTrip_Length_Seconds number of seconds the terminal was in use for this shopping tripB.36 Table Name: PSS_Shopping_List_StatusTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKShopping_List_Status_ID int NOT NULL Yes NoDescription varchar(20) NULL No NoPSS Shopping List Status Table identifies the allowable shopping list statesShopping List Status ID unique status identifierDescription text describing this state
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 147© 2000, Symbol Technologies, Inc. February 1, 2000B.37 Table Name: PSS_Shopping_TaxTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCustomer_ID int NOT NULL Yes YesShopping_List_ID int NOT NULL Yes YesTax_Plan_ID int NOT NULL Yes YesAmount int NULL No NoTax_Amount char(18) NULL No NoPSS Shopping Tax Table contains the tax amounts by plan for items from a particular shoppinglistCustomer ID customer with whom this shopping list is associated (from PSS_Customer)Shopping List ID shopping list with which this item is associated (fromPSS_Shopping_List)Tax_Plan_ID tax table ID as referenced in item records (from PSS_Tax_Table)Amount taxable amount in base currencyTax_Amount amount of tax in base currency (currently unused)B.38 Table Name: PSS_Special_BarcodeTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKBarcode Varchar(20) NOT NULL Yes NoType Int NULL No NoDescription Varchar(50) NULL No NoPSS_Special_Barcode Table contains configuration information for barcodes with specialmeanings, such as an End-Of-Trip barcode, or Queue Buster barcodes.Barcode the special barcode as returned from the scanner Type the type of barcode (quick order weight = 10, end-of-trip = 11, swap scanner = 12,queue buster = 13)Description a text description of this barcode
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 148© 2000, Symbol Technologies, Inc. February 1, 2000B.39 Table Name: PSS_System_MessageTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKSystem_Message_ID int NOT NULL Yes NoMessage_Text varchar(255) NULL No NoFrequency_Type int NULL No NoMonth_Of_Year int NULL No NoDay_Of_Month int NULL No NoDay_Of_Week int NULL No NoHour_Of_Day int NULL No NoMinutes_After_Hour int NULL No NoTime_Interval int NULL No NoRepeat_Count int NULL No NoSend_Next_At_Datetime datetime NULL No NoPSS_System_Message Table contains configuration information for barcodes with specialmeanings, such as an End-Of-Trip barcode, or Queue Buster barcodes.System_Message_ID unique identifier for this system messageMessage_Text the text of this messageFrequency_Type type of send frequency (annual = 1, monthly = 2, weekly = 3, daily= 4, hourly = 5, interval = 6)Month_Of_Year month of the year when message should be sent (1-12)Day_Of_Month day of the month when message should be sent (1-31)Day_Of_Week day of the week when message should be sent (1-7)Hour_Of_Day hour of the day when message should be sent (0-23)Minutes_After_Hour month of the year when message should be sent (1-12)Time_Interval time interval (in minutes) between which the message should besentRepeat_Count number of times to repeat the message send over a time intervalSend_Next_At_Datetime date/time when this message will be sent next (set byPssSystemMessageCOM)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 149© 2000, Symbol Technologies, Inc. February 1, 2000B.40 Table Name: PSS_System_SettingTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKName Varchar(20) NOT NULL Yes NoSubname Varchar(20) NOT NULL Yes NoValue Varchar(255) NULL No NoDescription varchar(255) NULL No NoUnit varchar(10) NULL No NoDefault_Value varchar(255) NULL No NoEditable char(1) NULL No NoPSS System Setting Table contains system-wide configuration settingsName the configuration option nameSubname the component name within the given configuration option nameValue the data associated with this configuration settingDescription the description of this system settingUnit the unit of measure for this system settingDefault_Value the default Value for this system settingEditable indicates whether this system setting is editable from the System Settingweb pageB.41 Table Name: PSS_Tax_TableTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKTax_Plan_ID int NOT NULL Yes NoDescription varchar(40) NULL No NoPrice_Range_Low int NULL No NoTax_Amount_Low int NULL No NoPrice_Range_High int NULL No NoTax_Amount_High int NULL No NoFirst_Tax_Flag char(1) NULL No NoPSS Tax Table Table contains the definitions of the possible tax plans for this locationTaxPlan Taxtable ID as referenced in item recordsDescription Identifies type of tax (State, Federal , Excise, …)PriceRangeLow Transaction price below which the Low Tax table is usedTaxAmountLow Tax cost for a transaction with price equal to PriceRangeLowPriceRangeHigh Price range that corresponds to TaxAmountHigh. Transaction price isdivided by this amount to determine the number of TaxAmountHighincrements to charge. Any remainder is computed by lookup in the HighTax Table for the Tax Plan.TaxAmountHigh Tax cost for each PriceRangeHigh increment.First_Tax_Flag indicates whether tax is collected on the first tax range.
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 150© 2000, Symbol Technologies, Inc. February 1, 2000B.42 Table Name: PSS_Tax_Table_EntryTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKTax_Plan_ID Int NOT NULL Yes YesRange_Indicator char(1) NOT NULL Yes NoPrice_Group_Start int NOT NULL Yes NoTax_Amount int NULL No NoPSS Tax Table Entries Table contains the definitions of the tax ranges for each tax planTax Plan Tax table ID as referenced in item recordsRange Indicator “H” or “L” indicates whether this is an entry in the Low tax table or is anentry in the High tax tablePrice Group Start Threshold price for identifying a transaction with this tax groupTax Amount Tax cost for a transaction in this tax groupB.43 Table Name: PSS_TextTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKText_ID int NOT NULL Yes NoLanguage_ID int NOT NULL Yes YesConstant_Name varchar(40) NULL No NoText varchar(255) NULL No NoPSS_Text Table contains text strings displayed throughout the system in various languagesText_ID unique identifier for this text entryLanguage_ID language ID (from PSS_Language) that this version of this text entry is inConstant_Name a C++-style identifier for this text entryText the text for this text entry in this languageB.44 Table Name: PSS_Unknown_ItemTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKItem_ID varchar(20) NOT NULL Yes NoTerminal_ID varchar(16) NOT NULL Yes NoScanned_Datetime datetime NOT NULL Yes NoCustomer_ID int NULL No NoShopping_List_ID int NULL No No
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 151© 2000, Symbol Technologies, Inc. February 1, 2000PSS_Unknown_Item Table contains items scanned during shopping trips for which nomatching item could be found in PSS_ItemItem_ID the barcode as returned by the scannerTerminal_ID the Terminal ID (from UMS_Terminal) that scanned this itemScanned_Datetime date/time that this item was scannedCustomer_ID the customer ID (from PSS_Customer) that scanned this itemShopping_List_ID the shopping list ID (from PSS_Shopping_List) of the list that this itemwas to be added toB.45 Table Name: UMS_Card_Reader_TypeTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKReader_Type Int NOT NULL Yes NoDescription Varchar(50) NULL No NoCard_Sentinel varchar(5) NULL No NoCard_Offset int NULL No NoEnd_Sentinel varchar(5) NULL No NoUMS_Card_Reader_Type Table contains definitions of the various types of card readinghardware used by the systemReader_Type a unique identifier for the type of card reader hardware for this entryDescription the description of this card readerCard_Sentinel the sentinel character(s) that mark the start of the card numberCard_Offset the number of characters after the first character of the start sentinel beforethe card number beginsEnd_Sentinel the sentinel character(s) that mark the end of the card number
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 152© 2000, Symbol Technologies, Inc. February 1, 2000B.46 Table Name: UMS_CradleTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKCradle_ID varchar(4) NOT NULL Yes NoPower_ID int NULL No YesDispenser_ID varchar(4) NULL No YesStatus_Code int NULL No YesStatus_Datetime datetime NULL No NoCradle_Notes varchar(40) NULL No NoDefault_Interface varchar(40) NULL No NoUMS_Cradle Table contains definitions of the configured cradles, or charging slots, for theterminals used by the systemCradle_ID the unique identifier scanned by a terminal placed into this cradlePower_ID the power supply ID (from UMS_Power) from which this cradle gets itspowerDispenser_ID the dispenser ID (from UMS_Dispenser) that this cradle is associated withStatus_Code the status code (from UMS_Status_Codes) for the current state of thiscradleStatus_Datetime the date/time of the last status update for this cradleCradle_Notes text associated with this cradle (typically for reason marked out of service)Default_Interface the default interface for the terminals dispensed from this cradleB.47 Table Name: UMS_DispenserTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKDispenser_ID varchar(4) NOT NULL Yes NoDispenser_Name varchar(50) NULL No NoEntrance_ID int NULL No YesPrinter_ID int NULL No YesDefault_Entrance int NULL No NoStatus_Code int NULL No YesStatus_Datetime datetime NULL No NoDefault_Printer int NULL No NoCurrent_Mode int NULL No NoUMS_Dispenser Table contains definitions of the dispensers, or logical grouping of cradles,used by the systemDispenser_ID a unique identifier for this dispenserDispenser_Name a text description of this dispenserEntrance_ID the entrance unit ID (from UMS_Entrance) associated with this dispenserPrinter_ID the printer ID (from UMS_Printer) associated with this dispenser
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 153© 2000, Symbol Technologies, Inc. February 1, 2000Default_Entrance the default entrance unit ID (from UMS_Entrance) for this dispenser, incase the entrance unit in use must be changedStatus_Code the status code (from UMS_Status_Codes) for the current state of thisdispenserStatus_Datetime the date/time of the last status update for this dispenserDefault_Printer the default printer ID (from UMS_Printer) for this dispenser, in case theprinter in use must be changedCurrent_Mode indicates whether this dispenser is in Key-Controlled Unlock mode or notB.48 Table Name: UMS_EntranceTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKEntrance_ID int NOT NULL Yes NoDescription varchar(50) NULL No NoReader_Type int NULL No YesReader_Port varchar(8) NULL No NoStatus_Code int NULL No YesStatus_Datetime datetime NULL No NoDisplay_Type int NULL No NoDisplay_Port varchar(8) NULL No NoDefault_Mode int NULL No NoCurrent_Mode int NULL No NoBackup_ID int NULL No NoHardware_ID varchar(16) NULL No NoReader_Status int NULL No NoDisplay_Status int NULL No NoEntrance_Notes varchar(40) NULL No NoUMS_Entrance Table contains definitions of the configured entrance units used by the systemEntrance_ID unique identifier for this entrance unitDescription description of this entrance unitReader_Type the type of card reader (from UMS_Card_Reader_Type) used by thisentrance unitReader_Port the communications port (typically COMx port) used to communicatewith the non-RF card readerStatus_Code the status code (from UMS_Status_Codes) for the current state of thisentrance unitStatus_Datetime the date/time of the last status update for this entrance unitDisplay_Type the type of display used by this entrance unitDisplay_Port the communications port (typically COMx port) used to communicatewith the non-RF displayDefault_Mode the default status message displayed by this entrance unit (swipe card, noterminals available, etc.)Current_Mode the current status message displayed by this entrance unit (swipe card, noterminals available, etc.)Backup_ID the entrance unit ID (from UMS_Entrance) to act as a backup if thisentrance unit is out of order
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 154© 2000, Symbol Technologies, Inc. February 1, 2000Hardware_ID the hardware ID for this entrance unit (either the name of thePssEntranceXX service which controls this non-RF entrance unit, or theMAC address for RF entrance units)Reader_Status the status code (from UMS_Status_Codes) for the card reader associatedwith this entrance unitDisplay_Status the status code (from UMS_Status_Codes) for the display associated withthis entrance unitEntrance_Notes text associated with this entrance unit (typically for reason out of service)B.49 Table Name: UMS_PowerTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKPower_ID int NOT NULL Yes NoDescription varchar(50) NULL No NoStatus_Code int NULL No YesStatus_Datetime datetime NULL No NoPower_Notes varchar(40) NULL No NoUMS_Power Table contains definitions of the configured power supplies used by the systemPower_ID unique identifier for this power supplyDescription description of this power supplyStatus_Code the status code (from UMS_Status_Codes) for the current state of thispower supplyStatus_Datetime the date/time of the last status update for this power supplyPower_Notes text associated with this power supply (typically for reason out of service)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 155© 2000, Symbol Technologies, Inc. February 1, 2000B.50 Table Name: UMS_PrinterTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKPrinter_ID int NOT NULL Yes NoDescription varchar(50) NULL No NoPrinter_Type int NULL No NoPrinter_Port varchar(8) NULL No NoStatus_Code int NULL No YesStatus_Datetime datetime NULL No NoBackup_ID int NULL No NoCurrent_Mode int NULL No NoHardware_ID varchar(16) NULL No NoPrinter_Notes varchar(40) NULL No NoPaper_Remaining int NULL No NoUMS_Printer Table contains definitions of the configured printers used by the systemPrinter_ID unique identifier for this printerDescription description of this printerPrinter_Type the type of printerPrinter_Port the communications port (typically COMx port) used to communicatewith the printerStatus_Code the status code (from UMS_Status_Codes) for the current state of thisprinterStatus_Datetime the date/time of the last status update for this printerBackup_ID the printer ID (from UMS_Printer) for the printer to be used as a backupfor this printerCurrent_Mode the current mode of this printer (currently unused)Hardware_ID the name of the printer service (PssPrinterXX) which controls this printerPrinter_Notes text associated with this printer (typically for reason out of service)Paper_Remaining a number associated with the remaining paper in this printer (currentlyunused)
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 156© 2000, Symbol Technologies, Inc. February 1, 2000B.51 Table Name: UMS_Status_CodesTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKStatus_Code int NOT NULL Yes NoStatus_Text varchar(30) NULL No NoUMS_Status_Codes Table contains definitions of the hardware status codes used throughoutthe systemStatus_Code unique identifier for this status codeStatus_Text text description of this status codeB.52 Table Name: UMS_TerminalTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKTerminal_ID varchar(16) NOT NULL Yes NoCradle_ID varchar(4) NULL No NoStatus_Code int NULL No YesStatus_Datetime datetime NULL No NoBattery_Level int NULL No NoBattery_Datetime int NULL No NoTerminal_Type varchar(8) NULL No YesGood_Scans int NULL No NoBad_Scans int NULL No NoSeconds_Used int NULL No NoTot_Issue_Count int NULL No NoTot_Good_Scans int NULL No NoTot_Bad_Scans int NULL No NoTot_Seconds_Used int NULL No NoTimeout_Count int NULL No NoCurrent_Interface varchar(50) NULL No NoDispenser_ID varchar(4) NULL No NoTerminal_Notes varchar(40) NULL No NoBattery_Status int NULL No NoUMS_Terminal Table contains definitions of the configured hand-held terminals used by thesystemTerminal_ID unique identifier for this terminal (the MAC address of its network card)Cradle_ID the cradle ID (from UMS_Cradle) for the current location of this terminalStatus_Code the status code (from UMS_Status_Codes) for the current state of thisterminalStatus_Datetime the date/time of the last status update for this terminalBattery_Level a number corresponding to the amount of battery life remaining for thisterminalBattery_Datetime the date/time of the last battery level update for this terminalTerminal_Type the type of terminal (from UMS_Terminal_Types)Good_Scans the number of good scans for this terminal from the last issue
Appendix BWaveWorks PSS, Integration Guide, 1.10 Page 157© 2000, Symbol Technologies, Inc. February 1, 2000Bad_Scans the number of bad scans for this terminal from the last issueSeconds_Used the number of seconds this terminal was used from the last issueTot_Issue_Count the total number of times this terminal was issued (since last statisticsreset)Tot_Good_Scans the total number of good scans for this terminal (since last statistics reset)Tot_Bad_Scans the total number of bad scans for this terminal (since last statistics reset)Tot_Seconds_Used the total number of seconds this terminal was used (since last statisticsreset)Timeout_Count the total number of issue timeouts for this terminal (since last issue or laststatistics reset)Dispenser_ID the dispenser ID (from UMS_Dispenser) for the dispenser this terminal iscurrently inTerminal_Notes text associated with this terminal (typically for reason out of service)Battery_Status indicates whether the terminal is currently on battery or AC powerCurrent_Interface the current interface this terminal is runningB.53 Table Name: UMS_Terminal_TypesTable Column Name Table ColumnDatatype Table Column NullOption Table Column Is PK Table Column Is FKTerminal_Type varchar(8) NOT NULL Yes NoTerminal_Class varchar(50) NULL No NoDefault_Interface varchar(40) NULL No NoDisplay_Rows int NULL No NoDisplay_Cols int NULL No NoKeypad_Type int NULL No NoUMS_Terminal_Types Table contains definitions of the types of hand-held terminals used bythe systemTerminal_Type unique identifier for this type of terminalTerminal_Class a text description for this type of terminalDefault_Interface the default interface run by this type of terminalDisplay_Rows the number of rows available on the display of this type of terminalDisplay_Cols the number of columns available on the display of this type of terminalKeypad_Type the keypad type, or number of keys, available on this type of terminal
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 158© 2000, Symbol Technologies, Inc. February 1, 2000Appendix C Price Calculation AlgorithmsThis appendix describes how price calculations are performed.A price is calculated for every item scanned during a shopping trip. Each item has an associatedpricing method. The following item characteristics are used to determine how to calculate itsprice.• Pricing methodThe pricing method helps to determine the equation used to calculate theprice of an item.• Mix and match numberThe mix and match number is used to indicate whether or not anitem can be part of a pricing deal that includes other items.• DepartmentThe department helps to determine which mix and match pricing deal to applyto an item.The following item characteristics are used as inputs to price calculation equations.• Deal quantity / Deal weightA deal quantity must never be negative. A deal quantity ofzero is treated as a one.• Deal priceThe meaning of the deal price associated with an item depends on the pricingmethod associated with that item. A deal price is always equal to or greater than zero.• Unit priceThe unit price helps to determine which mix and match pricing deal to apply toan item. The unit price is always equal to or greater than zero.C.1 Pricing MethodsThe following pricing methods are used by the PSS system:• Split Package Pricing• Unit Pricing• Base Plus One Pricing• Group Threshold Pricing• Group Adjusted Pricing• Unit Adjusted PricingBelow is a description of each of the pricing methods used on the PSS system. Included in eachdescription is an example calculation. All pricing methods described as a group pricing methodrequire a price rounding method. All calculated prices in the examples are always rounded up.
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 159© 2000, Symbol Technologies, Inc. February 1, 2000C.2 Split Package PricingThe Split Package Pricing Method is a group pricing method based on a deal price and a dealquantity or a deal weight.The price of an item is calculated using one of the following equations:( Purchase Quantity * Deal Price )Item Price = -------------------------------------Deal QuantityOR( Purchase Weight * Deal Price )Item Price = ----------------------------------Deal WeightSplit Package Pricing ExampleAn item costs $1.00 for a quantity of 5. The customer purchases a quantity of 3 of the item.Item Price=(3*1.00 )/5 = $0.60A weight-based item costs $5.00 for a weight of 2 lbs. The customer purchases 3 lbs. of the item.Item Price = ( 3 * 5.00 )/2 = $7.50C.3 Unit PricingThe Unit Pricing Method is a simplified version of the Split Package Pricing Method. The priceused in the equation is the unit price instead of the deal price and the deal quantity / deal weight isequal to 1 or 0.The price of an item is calculated using one of the following equations:Item Price = Purchase Quantity * Unit PriceOR
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 160© 2000, Symbol Technologies, Inc. February 1, 2000Item Price = Purchase Weight * Unit Price
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 161© 2000, Symbol Technologies, Inc. February 1, 2000Unit Pricing ExampleAn item costs $0.49 for a quantity of 1. The customer purchases a quantity of 3 of the item.Item Price = 3 * $0.49 = $1.47A weighted item costs $1.29 for a weight of 1 lb. The customer purchases 3 lbs. of the item.Item Price = 3 * $1.29 = $3.87C.4 Base Plus One PricingThe Base Plus One Pricing Method is a group pricing method based on a deal price and a dealquantity. This pricing method accumulates previously sold items of the same type or group.Every time an item needs to be included in the group the total price is recalculated for the newpurchase quantity. The price of the added item is adjusted to reflect the new total for the group.The price of the added item is calculated using the following equations.(Purchase Quantity * Deal Price)New Total Price = --------------------------------Deal QuantityItem Price = New Total Price – Previous Total PriceBase Plus One Pricing ExampleItems of the same type or group are sold at five for $0.47. The items are added at different timesduring the shopping trip.Item Number 1 added to shopping list.New Total Price=(1*$0.47 )/5 = $0.10Item Price = $0.10 – $0.00 = $0.10Item Number 2 added to shopping list.New Total Price=(2*$0.47 )/5 = $0.19Item Price = $0.19 – $0.10 = $0.09Item Number 3 added to shopping list.
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 162© 2000, Symbol Technologies, Inc. February 1, 2000New Total Price=(3*$0.47 )/5 = $0.29Item Price = $0.29 – $0.19 = $0.10Item Number 4 added to shopping list.New Total Price=(4*$0.47 )/5 = $0.38Item Price = $0.38 – $0.29 = $0.09Item Number 5 added to shopping list.New Total Price=(5*$0.47 )/5 = $0.47Item Price = $0.47 – $0.38 = $0.09Item Number 6 added to shopping list.New Total Price=(6*$0.47 )/5 = $0.57Item Price = $0.57 – $0.47 = $0.10C.5 Group Threshold PricingThe Group Threshold Pricing Method is a group pricing method based on a unit price, a deal price,and a deal quantity. This pricing method accumulates previously sold items of the same type orgroup. The unit price is applied to items added to a group until its deal quantity is reached. Whenthe deal quantity is reached the total price is calculated using the deal price and the deal quantity.The price of the threshold item is adjusted to reflect the total price for the group. Addingadditional items to the group begins a new deal.The prices of the items sold before reaching the deal quantity are calculated using the followingequations:Item Price = Unit PricePurchase QuantityTotal Price = ------------------ * Deal Price +Deal Quantity((Purchase Quantity % Deal Quantity) * Unit Price)The price of the threshold item is calculated using the following equations:(Purchase Quantity * Deal Price)Total Price = --------------------------------
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 163© 2000, Symbol Technologies, Inc. February 1, 2000Deal QuantityItem Price = Total Price – Previous Total Price
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 164© 2000, Symbol Technologies, Inc. February 1, 2000Group Threshold Pricing ExampleItems of the same type or group are sold at five for $0.47. The unit price of the items in the groupis $0.10. The items are added at different times during the shopping trip.Item Number 1 added to shopping list.Item Price = $0.10Total Price = ((1/5) * 0.47) + ((1 % 5) * $0.10) = $0.10Item Number 2 added to shopping list.Item Price = $0.10Total Price = ((2/5) * 0.47) + ((2 % 5) * $0.10) = $0.20Item Number 3 added to shopping list.Item Price = $0.10Total Price = ((3/5) * 0.47) + ((3 % 5) * $0.10) = $0.30Item Number 4 added to shopping list.Item Price = $0.10Total Price = ((4/5) * 0.47) + ((4 % 5) * $0.10) = $0.40Item Number 5 added to shopping list.Total Price=(5*$0.47 )/5 = $0.47Item Price = $0.47 – $0.40 = $0.07Item Number 6 added to shopping list.Item Price = $0.10Total Price = ((6/5) * 0.47) + ((6 % 5) * $0.10) = $0.57Item Number 7 added to shopping list.Item Price = $0.10Total Price = ((7/5) * 0.47) + ((7 % 5) * $0.10) = $0.67Item Number 8 added to shopping list.
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 165© 2000, Symbol Technologies, Inc. February 1, 2000Item Price = $0.10 ( Unit Price )Total Price = ((8/5) * 0.47) + ((8 % 5) * $0.10) = $0.77
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 166© 2000, Symbol Technologies, Inc. February 1, 2000Item Number 9 added to shopping list.Item Price = $0.10 ( Unit Price )Total Price = ((9/5) * 0.47) + ((9 % 5) * $0.10) = $0.87Item Number 10 added to shopping list.Total Price=(10*$0.47 )/5 = $0.94Item Price = $0.94 – $0.87 = $0.07C.6 Group Adjusted PricingThe Group Adjusted Pricing Method is a group pricing method based on a unit price, a deal priceand a deal quantity. This pricing method accumulates previously sold items of the same type orgroup. The deal price for this pricing method is often referred to as the reduced price. The dealprice is treated as an item price rather than a package price.The unit price is applied to items in a group until the deal quantity is reached. The price of thethreshold item is calculated to bring the total group cost equal to the number of items sold at thedeal price. All items added to the group after the threshold item are sold at the deal price.The prices of the items sold before the threshold item are calculated using the following equations:Item Price = Unit PriceTotal Price = Purchase Quantity * Unit PriceThe price of the threshold item is calculated using the following equations:Total Price = Purchase Quantity * Deal PriceItem Price = Total Price – Previous Deal PriceThe prices of all items added after the threshold item are calculated using the following equations:Item Price = Deal PriceTotal Price = Purchase Quantity * Deal Price
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 167© 2000, Symbol Technologies, Inc. February 1, 2000Group Adjusted Threshold Pricing ExampleItems of the same type or group are sold at a unit price of $0.10. A special price of $0.08 isactivated when 3 items are purchased.Item Number 1 added to shopping list.Item Price = $0.10Total Price=1*$0.10 = $0.10Item Number 2 added to shopping list.Item Price = $0.10Total Price=2*$0.10 = $0.20Item Number 3 added to shopping list.Total Price=3*$0.08 = $0.24Item Price = $0.24 - $0.20 = $0.04Item Number 4 added to shopping list.Item Price = $0.08Total Price=4*$0.08 = $0.32Item Number 5 added to shopping list.Item Price = $0.08Total Price=5*$0.08 = $0.40C.7 Unit Adjusted PricingThe Unit Adjusted Pricing Method is a group pricing method based on a unit price, a deal price anda deal quantity. This pricing method accumulates previously sold items of the same type or group.The deal price for this pricing method is often referred to as the reduced price. The deal price istreated as an item price rather than a package price. This pricing method can be used to control thedistribution of free merchandise.The deal price is applied to items in a group until the deal quantity is exceeded. All items added tothe group after the threshold item are sold at the unit price.The prices of the items sold before the deal quantity is exceeded are calculated using the followingequations:Item Price = Deal Price
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 168© 2000, Symbol Technologies, Inc. February 1, 2000Total Price = Purchase Quantity * Deal PriceThe prices of all items added after the threshold item are calculated using the following equations:Item Price = Unit PriceTotal Price = ( Deal Quantity * Deal Price ) +( ( Purchase Quantity – Deal Quantity ) * UnitPrice )Unit Adjusted Threshold Pricing Example 1Items of the same type or group are sold at a unit price of $0.25. The items are on special for$0.20 with a limit of 3 per customer.Item Number 1 added to shopping list.Item Price = $0.20Total Price=1*$0.20 = $0.20Item Number 2 added to shopping list.Item Price = $0.20Total Price=2*$0.20 = $0.40Item Number 3 added to shopping list.Item Price = $0.20Total Price=3*$0.20 = $0.60Item Number 4 added to shopping list.Item Price = $0.25Total Price=(3*$0.20)+((4–3)*$0.25 ) = $0.85Item Number 5 added to shopping list.Item Price = $0.25
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 169© 2000, Symbol Technologies, Inc. February 1, 2000Unit Adjusted Threshold Pricing Example 2Items of the same type or group are sold at a unit price of $0.20. One item of the group pershopping trip is free.Item Number 1 added to shopping list.Item Price = $0.00Total Price=1*$0.00 = $0.00Item Number 2 added to shopping list.Item Price = $0.20Total Price=(1*$0.00)+((2–1)*$0.20 ) = $0.20Item Number 3 added to shopping list.Item Price = $0.20Total Price=(1*$0.00)+((3–1)*$0.20 ) = $0.40C.8 Mix and Match GroupingsMix and match is the name for the technique that lets a customer purchase items within the samegroup or pricing deal while mixing items but matching the unit price. Each item eligible for a mixand match pricing deal will have the same group number in the item record of each item in thegroup. Mixed items in a pricing deal must have the same unit price and the same department.C.9 Pricing Method Application RulesThe following application rules apply to the pricing methods.• All weight items use either the Unit Pricing Method or the Split Package Pricing Method.• All items with price embedded barcodes use the Unit Pricing Method. The embedded pricebecomes the unit price and the purchase quantity is treated as a one.• If an item is assigned to use the Base Plus One Pricing Method but its deal price is evenlydivisible by its deal quantity, its price is calculated using the Split Package Pricing Method.• If an item is assigned to use the Group Threshold Pricing Method and its deal quantity is 1,its price is calculated using the Unit Pricing Method.• Only the Group Adjusted Pricing Method and the Unit Adjusted Pricing Method allow anitem to be given away using a deal price of zero and a deal quantity of one.• Mix and match groupings can be used in the Unit Pricing Method, the Base Plus One PricingMethod, the Group Threshold Pricing Method, the Group Adjusted Pricing Method, and theUnit Adjusted Pricing Method.
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 170© 2000, Symbol Technologies, Inc. February 1, 2000C.10 Rounding MethodsThe following rounding methods are used on the PSS system:Rounding Method 1Prices are rounded up. Any decimal past the units position increases the units position by 1.( 1 * $1.00 )-------------- = $0.33333 Rounds up to $0.343Rounding Method 2Rounding Method 2Rounding Method 2Rounding Method 2Prices are rounded down. Any decimal past the units position is discarded.( 1 * $1.00 )-------------- = $0.33333 Rounds down to $0.333Rounding Method 3Rounding Method 3Rounding Method 3Rounding Method 3Prices are rounded up and down. Any decimal past the units position is rounded down fordecimals one through four and rounded up for decimals five through nine.( 1 * $1.00 )-------------- = $0.33333 Rounds down to $0.333( 2 * $1.00 )-------------- = $0.66666 Rounds up to $0.673
Appendix D POS Interface File Descriptions OverviewWaveWorks PSS, Integration Guide, 1.10 Page 171© 2000, Symbol Technologies, Inc. February 1, 2000Appendix D POS Interface File DescriptionsInformation is exchanged between the PSS system and the POS system using ASCII flat files copiedbetween the systems. The files are exchanged in a directory configured in the PSS System Settings. Itdefaults to the C:\PSS\TRANSFER subdirectory.This section contains detailed information regarding the contents of these files. Each of these files containsmultiple record types. The record type identifier is a two byte ASCII numeric value which is the first twobytes of the record.The file formats match those of the PSA version 5 release with some minor modifications.Record Type range Associated POS Interface file“01”, “02” PssTransaction File“03” - “06” POSTransaction File“08” Item Record File“09” Customer Information FileNA TaxTable File
Appendix D POS Interface File Descriptions PSS Transaction FileWaveWorks PSS, Integration Guide, 1.10 Page 172© 2000, Symbol Technologies, Inc. February 1, 2000D.1 PSS Transaction FileFilename File directory path specified in PSS System Settings. The file name defaultsto SCxxyyyy.IN, where ‘xx’ is the day of the month of this transaction asspecified in the transaction barcode on the dispenser ticket and ‘yyyy’ is thefour character transaction number stored in the transaction barcode on thedispenser ticket (see transaction ticket barcode description in this integrationguide for details of format).Source: PSS systemDescription Contains the list of items scanned by the PSS shopper during a selfscanshopping tripType ASCII SequentialRecord Length Fixed for each record type (length depends on expansion area configuration)Number of Records VariableThis file consists of a transaction information and item information. The Standard Transaction Informationhas details of the customer number, the selfscan transaction ‘barcode’, the number of items in the selfscantransaction and whether the POS operator is to check (re-scan) the items. After the Transaction record arethe item records. Each item record represents one article from the customer selfscan transaction andincludes the item code, price and a number of implementation specific ‘flags’. The file is in ASCII formatwith each record being terminated by a carriage return/line feed delimiting character pair.Transaction Information (Header record)Field Name StartOffset Length CommentsRecord Type 0 2 Standard SCAN IN transaction information = 01CustomerNumber 2 20 Customer Loyalty Card Number (right justified, zero filled on left)Transaction‘Barcode’ 22 24 This field is used to link the self scan transaction receipt barcode to theself scan transaction. (right justified, zero filled on left)Date & Time 46 14 Date and time of self scan transaction in formatDDMMYYYYHHMMSS.Number OfItems 60 4 The number of articles in the self scan transaction (right justified, zerofilled on left).Check Indicator 64 1 Flag to indicate if the POS operator is to check (re-scan) the selfscantransaction items.“N” = Don’t check (Quick Pay)“Y” = Check (RESCAN)“S” = Pre-scan (Queue Buster)PSS ExpansionArea This area is reserved for future expansion by the PSS system. Its size isconfigurable and defaults to zero length.User ExpansionArea This area is used for customized implementations of PSS. Its size isconfigurable and defaults to zero length.RecordTerminator 66 2 Carriage Return/Linefeed(0x0D, 0x0A)
Appendix D POS Interface File Descriptions PSS Transaction FileWaveWorks PSS, Integration Guide, 1.10 Page 173© 2000, Symbol Technologies, Inc. February 1, 2000Item InformationField Name StartOffset Length CommentsRecord Type 0 2 ‘Standard’ SCAN IN item record type = 02Item Number 2 24 Item barcode number right justified, zero filled on left (only last 13 digitsare currently used).Item Price 26 10 Item price in units (max 9,999,999,999) (right justified, zero filled on left)Flags 36 5 Implementation specific flags.Defaults as follows:‘X1 X2 X3 X4 X5‘X1unusedX20=Price in Store Currency, 1=Price in EurosX30=Normal item, 1=reduced to clear (RTC) itemX4unusedX5unusedPSS ExpansionArea This area is reserved for future expansion by the PSS system. It’s size isconfigurable and defaults to zero length.User ExpansionArea This area is used for customized implementations of PSS. It’s size isconfigurable and defaults to zero length.RecordTerminator 41 2 Carriage Return/Linefeed(0x0D, 0x0A)
Appendix D POS Interface File Descriptions POS Transaction FileWaveWorks PSS, Integration Guide, 1.10 Page 174© 2000, Symbol Technologies, Inc. February 1, 2000D.2 POS Transaction FileFilename File directory path specified in PSS System Settings. The file name defaultsto SCxxyyyy.OUT, where ‘xx’ is the day of the month of this transaction asspecified in the transaction barcode on the dispenser ticket and ‘yyyy’ is thefour character POS transaction number.Source: POS systemDescription Contains the list of items processed at the POS terminal by the cashier duringthe checkout process.Type ASCII SequentialRecord Length Fixed for each record type (length depends on expansion area configurationNumber of Records Variable, one header record, plus one record for each item purchased.This file consists of a transaction information and item information. The Header Record has details of thecustomer number, the selfscan transaction ‘barcode’, the number of items in the selfscan transaction andwhether the POS operator re-scanned the items. Following the header record are the item records. Each itemrecord represents one article processed at the POS and includes the item code, price and a number ofimplementation specific ‘flags’. The file is in ASCII format with each record being terminated by a carriagereturn/line feed delimiting character pair.Transaction Information (Header record)Field Name StartOffset Length CommentsRecord Type 0 2 ‘Standard’ SCAN OUT transaction information = 03CustomerNumber 2 20 Customer Loyalty Card Number (right justified, zero filled on left)Transaction‘Barcode’ 22 24 This field is used to link the self scan transaction receipt barcode to theself scan transaction. Note that this field may used for other purposes inspecific system implementation (right justified, zero filled on left)Date & Time 46 14 Date and time of POS rescan transaction in formatDDMMYYYYHHMMSSNumber OfItems 60 4 The number of articles in the checked transaction (right justified, zerofilled on left)Check Indicator 64 1 Flag to indicate if the POS operator did check (re-scan) the selfscantransaction items.“N” = Didn’t check (Quick Pay) “Y” = Did Check (RESCAN)PSS ExpansionArea This area is reserved for future expansion by the PSS system. It’s sizeis configurable and defaults to zero length.User ExpansionArea This area is used for customized implementations of PSS. It’s size isconfigurable and defaults to zero length.RecordTerminator 65 2 Carriage Return/Linefeed(0x0D, 0x0A)
Appendix D POS Interface File Descriptions POS Transaction FileWaveWorks PSS, Integration Guide, 1.10 Page 175© 2000, Symbol Technologies, Inc. February 1, 2000Standard Item InformationField Name StartOffset Length CommentsRecord Type 0 2 ‘Standard’ item information = 04Item Number 2 24 Item barcode number right justified, zero filled on left (only the last13 bytes are currently used).Item Price 26 10 Item price in units (max 9,999,999,999) (right justified, zero filled onleft)Flags 36 5 Implementation specific flags.Defaults as follows:‘X1 X2 X3 X4 X5‘X1unusedX2unusedX30=Normal item, 1=exception itemX4unusedX5unusedPSSExpansionAreaThis area is reserved for future expansion by the PSS system. It’s sizeis configurable and defaults to zero length.UserExpansionAreaThis area is used for customized implementations of PSS. It’s size isconfigurable and defaults to zero length.RecordTerminator 41 2 Carriage Return/Linefeed(0x0D, 0x0A)End Of Day InformationField Name StartOffset Length CommentsRecord Type 0 2 End of Day information = 05Identifier 2 3 “EOD”Reserved 5 2 Zero filledPSSExpansionAreaThis area is reserved for future expansion by the PSS system. It’s sizeis configurable and defaults to zero length.UserExpansionAreaThis area is used for customized implementations of PSS. It’s size isconfigurable and defaults to zero length.RecordTerminator 7 2 Carriage Return/Linefeed(0x0D, 0x0A)End Of Week InformationField Name StartOffset Length CommentsRecord Type 0 2 End of Week information = 06Identifier 2 3 “EOW”WeekNumber 5 2 “00” – “52”PSSExpansionAreaThis area is reserved for future expansion by the PSS system. It’s sizeis configurable and defaults to zero length.UserExpansionAreaThis area is used for customized implementations of PSS. It’s size isconfigurable and defaults to zero length.RecordTerminator 7 2 Carriage Return/Linefeed(0x0D, 0x0A)
Appendix D POS Interface File Descriptions Item Record FileWaveWorks PSS, Integration Guide, 1.10 Page 176© 2000, Symbol Technologies, Inc. February 1, 2000D.3 Item Record FileFilename Specified in PSS System Settings, defaults to PLUMT??.DAT for updatesand to PLUNW.DAT for a full Item file replacement.Source: POS ControllerDescription Contains item attributes needed by PSS for retrieval of item descriptions &computation of item prices.Type ASCII SequentialRecord Length Fixed, 117* (Actual length depends on configured expansion area sizes)Number of Records VariableThis file is created by the POS. PSS transfers the file from the POS host to the PSS system and thenprocesses it to load the data contained in it into the PSS. It exists primarily to update item description andpricing information.Field Name StartOffset Length CommentsRecord Type 0 2 Item file information, value = “02”Action 2 1 ‘A’ = Add\Update‘D’ = DeleteBarcode 3 24 Item Barcode, (right justified, zero filled on left -currently only the last 13 bytes used)Description 27 30 Description (left justified, space filled on right)Price 57 10 Unit Price 9,999,999,999 (right justified, zero filled on left)Item Flags 67 6 ‘X1 X2 X3 X4 X5 X6‘X1= ‘Y’, Tax plan A applicable= ‘N’ Tax plan A NOT applicableX2= ‘Y’, Tax plan B applicableX3= ‘Y’, Tax plan C applicableX4= ‘Y’, Tax plan D applicableX5= ‘Y’, Foodstamps applicableX6 = ‘Y’, ReservedLinkCode 73 24 Linked Item CodeRight justified, zero filled on left(currently only the last 13 bytes are used)Depart 97 3 Department Code (right justified, zero filled on left)MixMatch 100 2 Mix & Match Number (right justified, zero filled on left)Method 102 1 Pricing method:4 = Unit Adjusted Pricing3 = Group Adjusted Pricing2 = Group Threshold Pricing1 = Base + 1 Pricing0 = Unit PricingDeal Price 103 10 Deal Price 9,999,999,999 (right justified, zero filled on left)Deal Quantity 113 3 Deal Quantity (right justified, zero filled on left)PSS ExpansionArea This area is reserved for future expansion by the PSS system. It’s size isconfigurable and defaults to zero length.User ExpansionArea This area is used for customized implementations of PSS. It’s size isconfigurable and defaults to zero length.RecordTerminator 116 2 Carriage Return/Linefeed(0x0D, 0x0A)
Appendix D POS Interface File Descriptions Tax Table FileWaveWorks PSS, Integration Guide, 1.10 Page 177© 2000, Symbol Technologies, Inc. February 1, 2000D.4 Tax Table FileFilename File directory path specified in PSS System Settings. The file name defaultsto NXGTAXTxx.DAT, where ‘xx’ is a two digit number identifying whichtaxt table on the POS it representsSource: POS systemDescriptionType ASCII SequentialRecord Length VariableNumber of Records Variable.This file is not in standard fixed length record format. It is a variable record length file with comma-delimited fields. Up to ten separate tax tables can be defined using the file names NXGTAXT01-10.Each Tax Table File contains the deltas for the tax brackets and amounts that are required to compute tax.The file is sequential with three different record formats.Tax Table Record 1Field Name Type Length DescriptionASC 1 “ (0x22)DESCRIPTOR ASC 18 Tax Table descriptor.ASC 1 “ (0x22)ASC 1 , (0x2C)TAXRATE ASC 1-4 Start of repeat range for table (0-99.99).ASC 1 , (0x2C)FIRSTTAX ASC 1 True implies tax is collected on first range. False implies taxis not collected on first range.True = any non zero value, False = 0.ASC 2 CRLF (0x0D0A)Tax Table Record 2Field Name Type Length DescriptionNUMRANGES ASC 1-2 Number of ranges in the tax table.ASC 2 CRLF (0x0D0A)Tax Table Record 3Field Name Type Length DescriptionRANGEDELTA ASC 1-2 Delta amount for high end of bracket for this range.ASC 1 , (0x2C)AMTDELTA ASC 1-2 Delta amount for tax amount for this range.ASC 2 CRLF (0x0D0A)
WaveWorks PSS, Integration Guide, 1.10 Page 178© 2000, Symbol Technologies, Inc. February 1, 2000D.5 Customer Information FileFilename File directory path specified in PSS System Settings. The file name defaultsto CUSTMTxx.DAT, where ‘xx’ is a two digit ID number.Source: POS systemDescription Contains the list of customers which may use the PSS system.Type ASCII SequentialRecord Length Fixed, 291* (Actual length depends on configured expansion area sizes)Number of Records Variable, one record for each customer.Each record represents one customer and information needed by PSS to identify the customer as a validuser of the system. The file is in ASCII format with each record being terminated by a carriagereturn/line feed delimiting character pair.
WaveWorks PSS, Integration Guide, 1.10 Page 179© 2000, Symbol Technologies, Inc. February 1, 2000Field Name StartOffset Length CommentsRecord Type 0 2 Customer update record type = 09Action 2 1 ‘A’ = Add/Update‘D’ = DeleteCustomer cardnumber 3 20 Customer loyalty card number, (right justified, zero filled on left)Customer Name 23 40 Customer’s name (left justified, space filled on right)Customer addressline 1 63 40 First line of customer address (left justified, space filled on right)Customer addressline 2 103 40 Second line of customer address (left justified, space filled on right)Customer addressline 3 143 40 Third line of customer address (left justified, space filled on right –populates PSS “City” field by default)Customer addressline 4 183 40 Fourth line of customer address (left justified, space filled on right–populates PSS “State” field)Customer addressline 5 223 40 Fifth line of customer address (left justified, space filled on right–populates PSS Postal_Code and Country fields)Language Code 263 1 Language Code0 = Use store language, 1 = First language, 2 = Second language, 3 =Third languageIf multiple languages are not used, set to zero (0)Customer category264 2 This field exists for compatibility with versions of PSA. It isavailiable for use by User Exit routinesEnable/ Disableflag 266 1 Contains an optional flag to specify whether this customer is createdenabled or disabled for shopping. ‘D’ indicates the customer iscreated disabled and must be manually enabled using the ServiceTerminal. ‘E’ indicates the customer is created enabled and may usePSS to shop. It the field is left blank, the customer is created disabledCustomerGreeting 267 20 This field updates the PSS Greeting_Text field in the customerrecord. It is displayed on the terminal at the start of the shopping tripin place of the customer name if supplied.CheckchanceLevel 287 3 A numeric value that is used in determining whether a customer issent to the re-scan or quick-pay checkout lane. (right justified, zerofilled on left)PSS Expansion This area is reserved for future expansion by PSS. Default size iszeroUser Expansion This area is set aside for use by systems customized with user exitroutines. Default size is zeroRecordTerminator 290 2 Carriage Return/Linefeed(0x0D, 0x0A)

Navigation menu