WaveWorks Portable Shopping System Integration Guide February 1, 2000 Version 1.
Revision History Revision Date 1.00 December 31, 1999 1.10 February, 1, 2000 Author Mary Wroniak Garry Simmons Brian Reed Tom Pike Mike Tierney Luke Petrozza Luke Petrozza Comments Initial version Added PST 008 and PST 038 transactions Copyright 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, without permission in writing from Symbol.
Table of Contents 1. Introduction ............................................................................................................1 1.1 1.2 1.3 2. PURPOSE OF DOCUMENT ................................................................................................................................. 1 ASSUMPTIONS ................................................................................................................................................. 1 REFERENCE DOCUMENTS ..................
.19 4.20 4.21 4.22 4.23 4.24 4.25 4.26 5. Configuration of the PSS System .......................................................................53 5.1 5.2 6. LOAD INITIAL DATA ................................................................................................................................. 43 MS IIS CONFIGURATION ..........................................................................................................................
9.4.3 Using the CPssMsgLog Class ........................................................................................................... 106 9.5 AVAILABLE USER EXIT FUNCTIONS ............................................................................................................ 108 9.5.1 UE_PreProcessItemFile.................................................................................................................... 108 9.5.2 UE_PreProcessItemRecord ..........................................
B.21 B.22 B.23 B.24 B.25 B.26 B.27 B.28 B.29 B.30 B.31 B.32 B.33 B.34 B.35 B.36 B.37 B.38 B.39 B.40 B.41 B.42 B.43 B.44 B.45 B.46 B.47 B.48 B.49 B.50 B.51 B.52 B.53 TABLE NAME: PSS_ORDER_LIST ........................................................................................................... 136 TABLE NAME: PSS_ORDER_LIST_ITEM ................................................................................................. 136 TABLE NAME: PSS_ORDER_STATUS ............................................
Introduction ______________________________________________________________________________ 1. Introduction 1.1 Purpose of Document This document is an aid to be used in the configuration, customization and installation of the WaveWorks Portable Shopping System (PSS). 1.2 Assumptions This document assumes that the reader is familiar with the functionality of Symbol’s WaveWorks architecture, the WaveWorks Client, and the Server Enabler.
Architecture Overview ______________________________________________________________________________ 2. Architecture Overview The Portable Shopping System utilizes Symbol Technologies’ proprietary WaveWorks threetiered architecture, which provides clear separation of the user interface, business logic and database portions of the system. For the PSS, WaveWorks provides application messaging functions and manages distributed objects on the Microsoft Windows NT platform. 2.
Architecture Overview ______________________________________________________________________________ 2.1.1 WaveWorks Design Objectives Three-tiered ArchitectureWaveWorks provides a platform for implementing applications that maintain a clear separation between the user interface, business logic, and database layers. Light WeightWaveWorks is designed to run on P200 systems or better. AdaptableCOM object-based design allows easy addition of new business service objects to support new applications.
Architecture Overview ______________________________________________________________________________ 2.1.2 WaveWorks Components The WaveWorks components are shown in the following diagram and described below.
Architecture Overview ______________________________________________________________________________ WaveWorks MessagesThe WaveWorks messaging service uses a common message format for all WaveWorks messages. This format contains a fixed header, followed by zero or more application dependent data fields. TCP is used as the transport protocol for all WaveWorks messages. This permits the business logic tier to reside on a remote system, if desired.
Architecture Overview ______________________________________________________________________________ 2.2 PSS Software Overview Built upon the WaveWorks core software, the PSS software consists of • COM Objects • NT Services • Display Server Scripts • Database The COM Objects and NT Services perform the business logic. That is, they are responsible for the data manipulation and system sequencing that makes the system a portable shopping system.
Architecture Overview ______________________________________________________________________________ 2.3.3 Quick Order Subsystem While shopping, a user may choose to place a quick order through the optional Quick Order subsystem provided. The shopper identifies, through the quick order mechanism, the products and the quantities/weights of those products they wish to order.
Architecture Overview ______________________________________________________________________________ 2.3.7 User Messaging Also, through the User Messaging application, the store has the option to send messages to shopper’s hand held terminals. The messages can be any text, and can be made to be repeated, to be displayed at fixed times during the day, and/or to be directed to any set of shoppers currently in the store.
Architecture Overview ______________________________________________________________________________ Entrance Station Ticket Printer Asterix Terminals Native POS System Controller Service Desk Checkouts PSS Web Server Spectrum 24 Network Ethernet Web API Customer Management System Configuration System Management Sockets Hand held terminal management PSS Web Server Applets Data Management (Reports and Queries) ObjectWave/OpenView Wireless Network Management Comm Manager System Status Comm
Architecture Overview ______________________________________________________________________________ 2.5 PSS Component Diagram The following diagram gives a more complete listing of the software components included in the WaveWorks PSS system. Further details of these components are provided in subsequent chapters.
Hardware Requirements ______________________________________________________________________________ 3. Hardware Requirements 3.1 Windows NT Computer A 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; if some other host in store is a DHCP server where PSS files can be written, NT Workstation is sufficient.
Hardware Requirements ______________________________________________________________________________ 3.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 printer Note: See Symbol product literature for available dispenser types and options. 3.
PSS Software Installation ______________________________________________________________________________ 4. PSS Software Installation This installation guide is intended to provide a roadmap for installing and configuring the PSS system and all supporting software. The reader should be familiar with the Windows interface and installing software. This guide assumes the software is being installed on a new machine.
PSS Software Installation ______________________________________________________________________________ 4.1 Install NT 4.0 Server The first step in the installation process is to install the NT 4.0 Server operating system. It is strongly recommended that you do a clean installation of the entire system. Many of the more expensive server PCs come with customized installation programs that walk the user thru the NT installation process.
PSS Software Installation ______________________________________________________________________________ - The Components list is displayed. hardware/software components. - The Partition options screen is displayed. It is very important to pay attention to what you are doing here. This section is also hardware specific. - Start off by deleting all existing disk partitions. Select each existing partition (use the arrow key to move the highlighted partition) and following the on-screen instructions.
PSS Software Installation ______________________________________________________________________________ - Press Enter to restart the computer. - Wait while the system reboots and prepares to continue the installation. You will be prompted to insert the NT server CD when it is ready to continue. Note that the PC is now using the mouse and is displaying graphical screens. - Wait while more files are copied. - The Windows NT Setup Wizard is displayed.
PSS Software Installation ______________________________________________________________________________ - 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.
PSS Software Installation ______________________________________________________________________________ address 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.
PSS Software Installation ______________________________________________________________________________ 4.2 Install the NT 4 Service Pack NT has bugs, just like any other software. Microsoft releases “service packs” to add new features and fix bugs on your NT installation. This section of the installation guide documents how to install Service Pack 5. - Log in as Administrator (using the password you defined in section 1). - Close the “Welcome to Windows NT” window.
PSS Software Installation ______________________________________________________________________________ 4.3 Install Internet Explorer 4.01 Service Pack 2 The PSS system uses the Internet Explorer web browser by default. Installing IE4 also provides some 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 the desktop update and other Windows enhancements.
PSS Software Installation ______________________________________________________________________________ - The IE4.01 setup program automatically starts when you log in and finishes configuring the system. - 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 Web Page” option. WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
PSS Software Installation ______________________________________________________________________________ 4.4 NT Option Pack Install The NT Option Pack installs software that is not part of the standard NT installation. Our purpose 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.
PSS Software Installation ______________________________________________________________________________ 4.5 Install the Video Driver The normal NT installation uses a generic video driver. This section leads you through the steps to installing a video driver for the specific video card in your computer. Installing the correct video driver for your hardware allows the system to run at higher resolutions, refresh rates and numbers of colors.
PSS Software Installation ______________________________________________________________________________ - 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.
PSS Software Installation ______________________________________________________________________________ 4.6 Create and Format the Database partition You may remember the discussion about the creation of a D: partition on the hard drive from the early steps of this procedure. If you created a D: partition then, you may skip to the Format steps. If you did not create a D: partition earlier, we will create (and then format) one here. The D: partition is where we store all the database data files.
PSS Software Installation ______________________________________________________________________________ 4.7 Desktop Cleanup (optional) This section includes OPTIONAL changes to the desktop environment. We’ve found that these changes make life a little easier. The intent is clean up the desktop and to set up the Explorer window to show the data we want to see.
PSS Software Installation ______________________________________________________________________________ 4.8 Install Microsoft SQL Server 7 This 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 will autostart. - Click on the Install SQL Server 7.
PSS Software Installation ______________________________________________________________________________ - Reboot the PC manually. (Start | Shutdown | Restart) 4.9 Create and Configure the PSS Database The 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). After creating the PSS database, we will configure SQL Server and set up the automated database maintenance tasks. 4.9.
PSS Software Installation ______________________________________________________________________________ 4.9.2 Configure SQL Server This step will configure SQL Server to function properly, and allow sufficient security access to the database. - Expand the “MS SQL Server” branch. - Expand the “SQL Server Group” branch. - Expand the branch. - Right-click on the local machine name.
PSS Software Installation ______________________________________________________________________________ 4.9.3 Configure the Clear Transaction Log job This step will schedule a clearing of the SQL Server Transaction Log, which provides temporary space for all data modification activities in the database. The Transaction Log must be cleared occasionally to remove old inactive database transaction entries. - Under SQL Server Agent, click on ‘Jobs’. - In the right pane, right-click, and select ‘New Job...
PSS Software Installation ______________________________________________________________________________ - - In Starting At, change the time to 1:55am (or 5 minutes before backups will be scheduled to start below). - Press OK. Press OK. Press OK. 4.9.4 Configure the Extensive Database Check and Backup job This step will configure a database backup, and an extensive check of the integrity of all of the structures in the database, including tables and table indexes, which will run once a week.
PSS Software Installation ______________________________________________________________________________ - 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’.
PSS Software Installation ______________________________________________________________________________ 4.9.5 Configure the Nightly Database Check and Backup job This step will configure a database backup and a brief check of the integrity of all of the tables in the database, which will run every day of the week, except for the night on which the extensive check and backup is run. This activity should be scheduled for the time of the day with the least shopping activity.
PSS Software Installation ______________________________________________________________________________ - 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 drive than 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.
PSS Software Installation ______________________________________________________________________________ 4.10 Install Microsoft Access There are times that you may want direct access to the WaveWorks database. You do not need to install the whole MS Office Suite or even any of the Access extras, just Access. This procedure 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.
PSS Software Installation ______________________________________________________________________________ - Log on as Administrator. - The final setup of IE5 will continue. The normal desktop will be displayed when setup is complete. 4.12 Install WaveWorks ObjectWave has been renamed “WaveWorks.” The name change is only partially complete, so you may still see references to “Objectwave” on the system. WaveWorks is the foundation that the PSS system is built on.
PSS Software Installation ______________________________________________________________________________ - Click Finish - Reboot the PC to make new environment variables and registry changes take effect 4.13 Install PSS Runtime System This section installs the PSS software. It is strongly recommended that you use the default folder for the files. This section installs the generic/base system. - Run the PssWaveworksSetup.exe file to install the PSS system.
PSS Software Installation ______________________________________________________________________________ - Reboot the PC to make PSS environment variables and registry changes take effect. 4.14 Install Waveworks Development Studio This section installs the Waveworks Development Studio system used for modifying the scripts that drive the handheld terminal applications and that link terminal actions to WaveWorks transactions. It is strongly recommended that you use the default folder for the files.
PSS Software Installation ______________________________________________________________________________ - The PSS Development System requires several Microsoft and WaveWorks components. If you have skipped any steps in this integration guide, then you will be notified by a dialog box of any missing components which may be required. The installation process may stop if a missing component is required.
PSS Software Installation ______________________________________________________________________________ - Type Exit to close command window. 4.16.1 Create STEP hex images for the terminals to download This 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 the steps for the type of terminals you have.
PSS Software Installation ______________________________________________________________________________ 4.17 DHCP Configuration DHCP is the service that gives out IP addresses to Asterix terminals when they boot up. The DHCP service is allocated a range of IP addresses that it can give out. This section describes how to set up that range of addresses and make them active. - Run the "DHCP Manager" program by selecting Start button, then Programs, then Administrative Tools.
PSS Software Installation ______________________________________________________________________________ 4.18 Create an ODBC Data Source This section creates the ODBC data source that is used by the PSS software to access the database. 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 software uses the data source name in the PSS.
PSS Software Installation ______________________________________________________________________________ 4.19 Load Initial Data This step will populate the PSS database with the initial data needed for the system to run. The PSS system is very much a data-driven system. It is CRITICAL that these scripts be run correctly if you want the system to run properly. You can run a batch file that will run all the scripts for you (the “Automatic” method), but it requires that the database is named “PSS”.
PSS Software Installation ______________________________________________________________________________ - Ums_System_Settings.sql (loads Unit Management settings) Ums_Text.sql (loads Unit Management settings in US English) Exit WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc. Query Analyzer.
PSS Software Installation ________________________________________________________________________ ______ 4.20 MS IIS Configuration This step will configure the web server to recognize the PSS Service Terminal as a valid Active 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 Microsoft Internet Information Server, then Internet Service Manager. - Expand Internet Information Server.
PSS Software Installation ________________________________________________________________________ ______ 4.21 Obtaining Access to PSS System Administration Screens This step will configure Internet Explorer for easy access to the Portable Shopping System Service Terminal. - Open Internet Explorer (double-click on the icon on the desktop) - If the Internet Explorer connection Wizard displays, select the “connect through Local Area Network” option.
PSS Software Installation ________________________________________________________________________ ______ 4.22 Configure Task Scheduler This step creates processes that must run automatically at various intervals for the proper function 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 system will eventually cease functioning. - Double-click "My Computer" on the Windows Desktop.
PSS Software Installation ________________________________________________________________________ ______ 4.23 Configure Unit Management This step establishes the configuration of the hardware needed for PSS. The exact number of entries is specific for each installation, so you’ll need to know what your hardware set up is. Use the Service Terminal screens to add entries or just directly type them into the database using the SQL Server Enterprise Manager.
PSS Software Installation ________________________________________________________________________ ______ want at least one dispenser per entry station, but you may have multiple dispensers per entry station. Customers are directed to a dispenser, so keep this in mind when deciding how to group cradles into dispensers. Each dispenser is controlled by a single entrance. - Create Cradles - Finally, create a row in the UMS_Cradle table for each cradle in the system.
PSS Software Installation ________________________________________________________________________ ______ 4.24 Configure Licensing This step makes the number of licenses bought for specific Microsoft products known to the 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 License Manager window should appear.
PSS Software Installation ________________________________________________________________________ ______ 4.25 Configure the NBQMAIN Service (IBM 4690 POS Only) If you chose the IBM4690 POS as your Point of Sale system, NBQMAIN service, which is part of IBM’s Retail Connectivity Option(RCO), is a critical link between the PSS system and the POS. The NBQMAIN service should be configured to startup automatically when WindowsNT starts up. It is NOT controlled by the WaveWorks System Controller.
PSS Software Installation ______________________________________________________________________________ 4.26 Setup NT System Log Select Start, Program, Administrative Tools, Event Viewer. Click on "Log" tab. Select "Log Settings" from pulldown Chnage settings for "System" In the "Event Log Settings" Window, in the event Log Wrapping Area, select "Overwrite events as needed" Click OK Click on Log Tab Select Exit WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Configuration of the PSS System ______________________________________________________________________________ 5. Configuration of the PSS System 5.1 Set Up System Setting Constants All system configuration data is stored in the database. A System Administration screen is included to provide you with the ability to adjust the configuration data for the system. You can navigate to this screen by selecting System Settings under the System Management heading on the main System Administration screen.
Configuration of the PSS System ______________________________________________________________________________ Name – Subname POSItemFile – ProcessTX POSItemFile – PSSExpansionLength POSItemFile – RemoveItemChkDigit POSItemFile – TransferEnabled POSItemFile – TransferTime POSItemFile – TransferTX POSItemFile – TransferType POSItemFile – UserExpansionLength POSItemUpdate – MonitorInterval POSTaxFile – FileFormatVersion POSTaxFile – FileName POSTaxFile – MonitorInterval POSTaxFile – ProcessTX POSTaxFile – Tra
Configuration of the PSS System ______________________________________________________________________________ Name – Subname PSSTransFile – FileFormatVersion PSSTransFile - File Name PSSTransFile – Monitor Interval PSSTransFile – ProcessEvent PSSTransFile – PSSExpansionLength PSSTransFile – Transfer Enabled PSSTransFile – TransferTime PSSTransFile – TransferTX PSSTransFile – TransferType PSSTransfile – UserExpansionLength RESCAN – ConsecNExcptBelowLvl RESCAN – DefaultDiffUnit RESCAN – DefaultInitLvl RESCAN
Configuration of the PSS System ______________________________________________________________________________ Name – Subname SHOPPING TRIP – TRANSACTION TYPE SPECIAL BARCODE – CUSTOMERENDOFTRIP SVCTERMINAl – Card Prefix SVCTERMINAL – CustomStatusString SVCTERMINAL – UsePrinters SVCTERMINAL – UseQuickOrder TRANSTICKET – DefaultDir TRANSTICKET –DefaultPrinter TRANSTICKET – PrinterColumnWidth TRANSTICKET - Ticket Cut Type UMS – BadScanFactor UMS – BaseFactor UMS – ChargingFactor UMS – GoodScanFactor UMS – Las
Validation of System Operation ______________________________________________________________________________ 6. Validation of System Operation 6.1 Testing an Installation Tests On 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.
Validation of System Operation ______________________________________________________________________________ 6.2 Obtaining System Status Information 6.2.1 Viewing The System Log The System Log screen allows you to view detailed information on events that have occurred in the 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.
Validation of System Operation ______________________________________________________________________________ 6.2.2 Viewing POS Status The POS Interface screen displays POS status messages and activities. These can be sorted by item name or start date. To access the POS Status screen, from the Main Menu, select Hardware / POS Interface. The following information is displayed: • Item name (i. e., customer file, item file, etc.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ 7. Directory Listing of PSS Folders/Files This section provides a detailed listing and description of the Folders and Files that are created as a result of the PSS installation process. C:\ Folders SubFolder Files Asterix2Step Bios236.hex Makebios.bat Makectrl.bat Makehex1.bat Makehex2.bat Makestep.bat Romdisk1.hex Romdisk2.hex Sendbios.bat Sendhex1.bat Sendhex2.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ Folders SubFolder Control Files Host.x ObjectWave Description Defines which host the terminal connects to. Location of all ObjectWave-related architecture files (Refer to WaveWorks product documentation.) PSS Install.log Prs_tags.000 Prs_tags.001 Pss.ini Backup The Master directory for the PSS software. Created by installation program to document the placement of files.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ PssTransactionTicket Com.exe PSSUserExits.dll PssUtilsCom.exe PssWebUtilityCom.dll Qexec.exe UnitMgmtCom.exe COM object – provides PSS transaction ticket printing services, in conjunction with the PrinterService. Stub user exit routines. COM object – contains PSS utility functions. COM object – provides WaveWorks / PSS utility services for the Service Terminal.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ Folders SubFolder Files UmsCleanup.sql UpdateOwave.bat Description Sets all UMS devices to “logged out” at startup / shut down. Generic update batch file that runs an SQL script on WaveWorks database. Logs Ess01.tr1 Prs01.tr2 Trace file for entrance units which use serial communications. Trace file for printers which use serial communications.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ install.bat MainMenu.swv PosInterface.sws Pss.swp PssActivityCom.sws PssCustomerMaintCom.sws PssCustomerRank.sws PSSDbCleanup.sws PssFileMaintCom.sws PssQOBarcodeCom.sws PssShoppingTripCom.sws PssSpecialBarcodeCom.sws PssSystemMessage.sws PssTimerCom.sws PssTransactionTicket.sws PssUtilsCom.sws QuickOrder.swv release.ini ShoppingTrip.swv sminstall.exe UMS.sws UMS.swv update.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ Folders SubFolder Files fielddate.inc fieldtime.inc global.asa index.asp index.html issueterminal.asp keyboard.asp login.asp lookupuser.asp pss.css pssdatatableend.inc pssdatatablestart.inc pssfunctions.inc psstatus.inc. quickorder.asp quickorderframes.asp quickorderheader.asp registeruser.asp sendmessage.asp systemproblems.asp systemsummary.asp unabletoissue.asp viewdepartments.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ viewmessagelist.asp viewmessagelog.asp viewnlstext.asp viewopeningmessages.asp vieworderitems.asp vieworders.asp viewreportrescan.asp viewreportsales.asp viewreportshoppersummary.asp viewreportterminals.asp viewreportunknownitems.asp viewrescanresults.asp viewrescansettings.asp viewshoppers.asp viewshoppingactivities.asp viewshoppingitems.asp viewshoppinglists.asp viewsystemsettings.
Directory Listing of PSS Folders/Files ______________________________________________________________________________ Folders Mssql7 7.1 SubFolder Files varies Description Location of all database tables, in Microsoft SQL Server format. Scheduled Tasks Folders SubFolder C:\Winnt\Tasks WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc. Files Description Repository for time-based tasks to be defined and scheduled.
Software Description ______________________________________________________________________________ 8. Software Description The subsystems included in the WaveWorks PSS system may consist of any combination of the following: COM Objects NT Services StepServer Scripts 8.1 Contain methods invoked via WaveWorks transactions. Managed by the Message Server. Contain methods invoked via WaveWorks transactions. Usually started at system startup.
Software Description ______________________________________________________________________________ PSSActivity Transaction ID PSA010 Method Name PssActivityAdd Input Parameters CustomerId ShoppingListId ActivityId DetailText Return Parameters RetValue PSSSpecialBarcode Transaction ID PSP001 PSP010 Method Name Refresh PssGetBarCodeType Input Parameters InputBarcode TerminalId Return Parameters RetValue ItemId Action BarcodeType RetValue PSSQOBarcode Transaction ID Method Name PSQ010 GetMaxQONumbe
Software Description ______________________________________________________________________________ PSSShoppingTrip Transaction ID Method Name PST001 CreateShoppingList PST003 SwapTerminal PST004 ValidateCustomer PST005 PssSessionSwitch PST007 GetSessionData PST008 GetShoppingTripType PST010 StartShoppingTrip PST020 AdjustShoppingItemData PST025 SetShoppingListStatus PST030 GetShoppingList WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Software Description ______________________________________________________________________________ PST035 GetDisplayTotalByCurrency PST038 AdjustShoppingList PST040 PST041 GetStoreInformational Message GetCustomerMessage PST042 GetElectronicMarketingMes PST043 GetCustomerCardNumber PST100 EndShoppingTrip PST102 PST104 DeleteShoppingList DetermineEndShoppingTrip PST200 GetExpressCustomer PST999 Refresh CustomerId ShoppingListId CustomerCurrencyId CurrencyIndex ItemId CsutomerId ShoppingLis
Software Description ______________________________________________________________________________ Transaction ID PST103 Method Name ProcessMessages WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Software Description ______________________________________________________________________________ PSSUtils Transaction ID Method Name PSU001 GetText PSU002 GetTextWithParms PSU003 GetInActivityTimeoutString Input Parameters TextId CustomerLanguageId TextId CustomerLanguageId TextParameters InactivityIndex Return Parameters TextMsg RetValue Text Result InactivityString Result UnitMgmt Transaction ID Method Name Input Parameters UMS001 ReserveBestTerminal EntranceId UMS002 UMS003 TerminalIs
Software Description ______________________________________________________________________________ UMS014 SetBatteryStatus TerminalId BatteryStatus TerminalId TerminalId BootType TerminalId TerminalId UMS020 UMS021 ReleaseTerminal RebootTerminal UMS022 UMS023 UnlockTerminal QueryTerminal UMS024 UMS025 ResetTerminalSession SetTerminalUnlockMode UMS026 TestCardReader UMS027 ReportBatteryCondition UMS028 UpdateTerminalLocation UMS100 EntranceLogin UMS101 UMS103 EntranceLogout SetEntranceStat
Software Description ______________________________________________________________________________ Transaction ID P2P006 Method Name Input Parameters Return Parameters Input Parameters Return Parameters Input Parameters Return Parameters Input Parameters Return Parameters LoadFromFile PSSFileMaintenance Transaction ID P2P201 P2P298 P2P299 Method Name CleanupPssTransFile CleanupArchiveArea ConvertSltoSO PSSDbCleanup Transaction ID PST105 Method Name PerformDBCleanup PSSCustomerRank Transactio
Software Description ______________________________________________________________________________ 8.2 Unit Management Subsystem The Unit Management Subsystem (UMS) manages the Symbol hardware devices that comprise the PSS system. Those devices include hand held terminals, cradles, entrance unit devices, ticket printers, and power supplies. Since UMS manages hardware, it is important to understand each of the devices being managed in both the Asterix2 and Asterix3 versions of PSS. 8.2.
Software Description ______________________________________________________________________________ Entrances There are two types of entrance stations: serial and RF. Either type can be used with either terminal type, but the older serial entrance units are typically used on Asterix2 systems and the newer RF entrances are used with the Asterix3 terminals. The primary difference between them is how they are controlled from the host.
Software Description ______________________________________________________________________________ Printer ServiceUses PSA’s Hardware Isolation Library (HIL) to communicate with serially connected printers. UMS DisplayServer Interfacecontrols the display on the hand held terminal and also provides procedures for handling input from the terminal and commands the UMS COM object.
Software Description ______________________________________________________________________________ 8.3 Shopping Trip Subsystem Once the shopper retrieves the proper hand held terminal from the dispenser, the Shopping Trip Subsystem allows the shopper to add and delete items from their basket and view the total amount and number of items scanned during their current shopping trip.
Software Description ______________________________________________________________________________ 3. If, in the output from the above method, an item barcode is scanned, then the AdjustShoppingList method is called to add or delete the scanned barcode from the customer's shopping 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.
Software Description ______________________________________________________________________________ Describe 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 call to one of the ShoppingTripList functions is made. This will return character strings with item Ids, descriptions, and prices (see COM object definitions for full parameter list).
Software Description ______________________________________________________________________________ The following user exits are called during shopping trips: UE_PreRescanDetermination UE_PostRescanDetermination UE_PreProcessMarketingMessage UE_PrintReceipt UE_PostProcessIsVariableWeight Allows modification of the rescan calculation data prior to the calculation, or allows wholesale replacement of standard rescan calculation with a customized algorithm Allows modification of the result of a standard resca
Software Description ______________________________________________________________________________ Database tables associated with the shopping trip are: Pss_Currency Pss_Customer Pss_Language Pss_Text Pss_Shopping_List Pss_Session Pss_Shopping_Item Pss_Shopping_Activity Pss_Shopping_Tax Pss_Tax_Table Pss_Tax_Table_Entry Pss_Unknown_Item Pss_Item Pss_System_Setting Pss_Message_Log Other objects such as classes need to be defined: PssStoreInformation PssSpecialBarcode Session Language Text Activity Customer
Software Description ______________________________________________________________________________ 8.3.5 Fatal Messages: “No Session for this Terminal (%s)” ST_TEXT_NOSESSION “No Customer Data” ST_TEXT_NOCUSTOMER “Initialization FAILED(%s)” ST_TEXT_INITFAILED “No Express Customers Available” ST_TEXT_NO_XCUSTOMERS “Unable To Access Express Customers Data” ST_TEXT_NO_ACCESS_XCUSTOMERS - Attempted to start the Shopping trip without associating a customer with a terminal.
Software Description ______________________________________________________________________________ “Invalid Writing SCAN-IN %d” ST_TEXT_WRITESCANIN “Cannot unload list items for Customer (%s)” ST_TEXT_UNLOAD “Invalid Getting Printer CMSID ReturnCode, Customer %s” ST_TEXT_INVALIDPRINT “Could Not delete Shopping Tax Table %d” ST_TEXT_BADDELETETRIP “Could not format item list (%s)” ST_TEXT_INVALIDFORMAT “Customer (%s) Could not get Qty” ST_TEXT_GETQTY “Customer (%s) has less than zero items !!” ST_TEXT_LESSZE
Software Description ______________________________________________________________________________ “SwapTerminal Error for customer (%s)” ST_TEXT_SWAPTERMINALERROR “Customer, Card Number (%s) is suspended” ST_TEXT_CUSTOMERSUSPENDED “Customer for card is not found (%s)” ST_TEXT_NOCUSTOMERFORCARD “Error Validating Card; Customer (%s) has a Session” ST_TEXT_HASSESSION “Error Validating Customer (%s)” ST_TEXT_VALIDATECUSTOMERERROR - Error updating the Pss_Session and/or Pss_Shopping_List tables while attempti
Software Description ______________________________________________________________________________ 8.3.8 Debug Messages: The following are messages logged in the End Of Trip method to track progress through that method. "EOT Done totals" "EOT Done Rescan" "EOT Written to files" "EOT Done" - Completed calculation of trip totals - Completed Rescan calculation - Completed writing Pss Transfer File - End of trip completed successfully 8.3.
Software Description ______________________________________________________________________________ “Customer (%s) rescan is FALSE - Never Second” ST_TEXT_RESCAN_NOSECONDTRIP “Customer (%s) rescan is FALSE - Below Item Count” ST_TEXT_RESCAN_BELOWCOUNT “Customer (%s) rescan is FALSE - Below Value” ST_TEXT_RESCAN_BELOWVALUE “Customer (%s) rescan is FALSE - Above Amount” ST_TEXT_RESCAN_ABOVEVALUE “Customer (%s) rescan is FALSE - Above Item Count” ST_TEXT_RESCAN_ABOVECOUNT “Customer (%s) rescan is TRUE - Too lo
Software Description ______________________________________________________________________________ 8.4 Quick Order Subsystem While 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 the quantities/weights of those products they wish to order. The quick order can then be sent to the appropriate department, where a web screen displays to store personnel the orders placed by shoppers.
Software Description ______________________________________________________________________________ 8.6 Electronic Marketing Subsystem The PSS system also allows for a basic electronic marketing facility through the Electronic Marketing application. This application allows a retailer to send messages to a shopper’s hand held terminal anytime that a given item is scanned. This is an optional feature.
Software Description ______________________________________________________________________________ 8.8 POS Interface Subsystem The WaveWorks PSS POS Interface is a file-based mechanism that provides communication between the PSS system and the store POS system by the exchange of files. Transfer Area inbound Working Area inbound Processed Files Area outbound PSS software monitors and deposits files into a directory referenced as the Transfer Area.
Software Description ______________________________________________________________________________ 8.8.1 POS Interface Files The files defined are: • PSS Transaction filesent from PSS to POS to identify a shopper and the items they have scanned. • POS Transaction filesent from POS to PSS to identify that a shopper has paid for their trip and allows for sending the items scanned by the POS system.
Software Description ______________________________________________________________________________ 8.8.2.3 IBM RCO for 4680/90 POS PssPosService makes use of the IBM RCO (Retail Connectivity Option) product for the 4680/90 POS. Release 1 of PSS WaveWorks used IBM RCO release 2.4.1. This product supplies a client access service that communicates with a Server application on the 4680/90 POS. For this mechanism to work, the IBM POS must be running the adxsrvnl.286 application as a background application.
Software Description ______________________________________________________________________________ 8.8.2.6 PssFileMaintCOM This COM object handles general file housekeeping functions.
Software Description ______________________________________________________________________________ The names of the items on the System Settings Page that are used to configure the POS interface portion of PSS are listed here for cross-reference to that page. Where the following pages mention a Configuration Group, that corresponds to the Name column on the System Setting page. Where they mention a Configuration Item, that corresponds to the Subname column on the System Setting page.
Software Description ______________________________________________________________________________ Settings that Apply to the POS Interface Subsystem as a Whole Configuration Group (Name column on System Settings Page) POSInterface Configuration Item (Subname column on System Settings Page) LocalTransferArea Directory to monitor for the arrival of files from the POS and where PSS should place files for the POS to retrieve RemoteTransferArea (Future)Location on POS where files are to be deposited or retriev
Software Description ______________________________________________________________________________ Settings for Configuring Processing Attributes of Each POS File Type Configuration File Groups POSItemFile Full Item file and Item/Price updates POSTaxFile Tax tables POSTransFile 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.
Software Description ______________________________________________________________________________ RemoveCustCheckDigit (not all files) AddItemCheckDigit (not all files) AddCustCheckDigit (not all files) FullItemFileName (POSItemFile only) Trace_Level Identifies if the CUSTOMER CARD number in the record as written by the POS includes a checkdigit.
Software Description ______________________________________________________________________________ 8.8.4 PSSTransactionFile Processing 8.8.4.1 File-Based Interface At the conclusion of a shopping trip (when a hand held terminal is returned to the dispenser or the End of Trip barcode is scanned), a PSS transaction file is created and placed in the transfer directory. Once the file is properly placed in the transfer directory, the processing for a PSS transaction file is complete in the file-based interface.
Software Description ______________________________________________________________________________ In order to enable this feature, the following system settings must be configured as shown.
Software Description ______________________________________________________________________________ 8.8.6 Item Record File Processing PSS maintains a database of items on the store shelves and their prices. This database is maintained by downloading the item information from the store’s POS system. These downloads can be achieved as either full item database downloads or as item information updates. The POSItemFile system settings are used to control the functioning of these operations.
Software Description ______________________________________________________________________________ 8.8.7 Customer Update File Processing The information maintained for customers that are registered to use the PSS system may be updated by sending a Customer Update File to the PSS system. This file can be used to create and update customer records in the PSS Customer database. PSS maintains many data items not included in the CUSTMTxx.
Software Description ______________________________________________________________________________ PSS File Monitoring Service—manages file transfers between PSS and POS (primarily for transfer of item, customer, scan in, and scan out files PSS RF Entrance Service—controls operation of all entrance units PSS Printer Service—controls operation of all printers WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Customizing the PSS System Software ______________________________________________________________________________ 9. Customizing the PSS System Software The WaveWorks PSS system offers a number of options for integrators that need to customize the base system to meet customer requirements. PSS allows integrators to customize the system by changing the DisplayServer scripts, writing custom services, or writing custom business objects.
Customizing the PSS System Software ______________________________________________________________________________ Writing custom COM Objects requires a solid programming background, preferably using Visual C++ and the ATL wizard. 9.4 User Exit DLL A DLL, PssUserExits.dll, is provided which allows integration teams to customize the software for a given installation. This mechanism is equivalent to the User Exits used in the PSA software.
Customizing the PSS System Software ______________________________________________________________________________ PSS base code is linked with Microsoft's Multithreaded DLL runtime library, so integrators must link a custom user exit DLL using that same library. Otherwise runtime errors will occur with the CpssMsgLog and CSymStatementPool classes that are used in the stub User Exits. 9.4.
Customizing the PSS System Software ______________________________________________________________________________ • Severityrepresents the severity of the condition being logged. A System setting value, subname "Trace_Level", is maintained for the Facilities that log messages. If the message severity value is less than the severity value specified in the LogMessage call, the message is not written to the log.
Customizing the PSS System Software ______________________________________________________________________________ 9.5 Available User Exit Functions Following 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 description of how the base PSS software reacts to the return code received from the User Exit.
Customizing the PSS System Software ______________________________________________________________________________ 9.5.3 UE_PostProcessItemRecord This function is called after the item record has been processed by PSS and loaded into the PSS database. It is anticipated that this User Exit function will be used to alter the PSS database item values set by default PSS processing or to process additional information in the User Expansion area of the item record.
Customizing the PSS System Software ______________________________________________________________________________ 9.5.6 UE_PostProcessTaxFile This function is called after PSS has processed the entire Tax Table File, all updates to thePSS database have been completed, and the file has been closed. It receives the file path of the tax table file as an argument.
Customizing the PSS System Software ______________________________________________________________________________ 9.5.9 UE_PostProcessPOSTransRecord This function is called after processing the current header or detail record read from a POS Transaction File and after updates to the PSS database for the current record have been completed. 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 record 9.5.
Customizing the PSS System Software ______________________________________________________________________________ 9.5.13 UE_PreProcessPSSTransRecord This function is called before writing the current header or detail record to a PSS Transaction File.
Customizing the PSS System Software ______________________________________________________________________________ 9.5.18 UE_PostRescanDetermination This function is called after the standard rescan determination algorithm and could be used to modify 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.
System Administration Interface ______________________________________________________________________________ 10. System Administration Interface The System Administration Interface provides browser-based access into the data contained in the system database, as well as various system control functions. The purpose is to allow store personnel to manage the system, obtain information, and provide updates to the information.
System Administration Interface ______________________________________________________________________________ • Valid starting and expiration dates and times for user’s access to the PSS. • Privilege levelsecurity level to which the user is assigned. This controls the functions that are displayed (as described below). These levels, from highest to lowest, are: - Administratorhas the same functions as all others, plus additional functions.
System Administration Interface ______________________________________________________________________________ All 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 providing appropriate system access to each level of user. However, differing customer requirements may make modifications to these default settings necessary.
System Administration Interface ______________________________________________________________________________ 20701 - 20799 20801 - 20899 20901 - 20999 21000 - 21099 21101 - 29999 Page State Short NamesText appearing as the page title at the top of the page, in the navigation bar, and in the page buttons in the Service Terminal menu system for pages with multiple “states.
System Administration Interface ______________________________________________________________________________ Tx ID: Class: PST105 PssDbCleanupCOM Method: PerformDBCleanup PerformDBCleanup performs a number of operations to reduce the number of rows in various database tables, thus improving system performance and eliminating obsolete or unnecessary data. Its operation is configurable based on entries in the system settings with name “PSSDBCleanup.
System Administration Interface ______________________________________________________________________________ ReturnCode Values: PSS_SUCCESS DB_CONNECT_ERROR DB_OPEN_ERROR DB_EXECUTE_ERROR DB_FETCH_ERROR DB_NO_DATA WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Specific Features ______________________________________________________________________________ 11. Specific Features 11.1 Multiple Language Support Support 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 text is held in the PSS_Text table in the database. The keys for each text string are a Text ID and a Language ID.
Appendix A Appendix A Database Layout Diagram The following diagram represents the database layout for the WaveWorks PSS system. V1.06 version WIZARD:PSS3 PSS_Admin_Action Symbol Technologies, Inc.
Appendix A PSS_Shopping_List Customer_ID: int Shopping_List_ID: int Time_Started: datetime Time_Ended: datetime Shopping_List_Status_ID: int Total: int Total_Currency_2: int Transaction_ID: varchar(25) Rescanned: char(1) Terminal_ID: varchar(16) Scanned_Item_Count: int Trip_Length_Seconds: int PSS_Shopping_List_Status Shopping_List_Status_ID: int PSS_Shopping_Item Customer_ID: int Shopping_List_ID: int Shopping_Item_ID: int Barcode: varchar(20) Item_ID: varchar(20) Sale_Price: int Sale_Price_Currency2: in
Appendix A PSS_Shopping_History_List Customer_ID: int Shopping_List_ID: int Time_Started: datetime Time_Ended: datetime Shopping_List_Status_ID: int Total: int Transaction_ID: varchar(25) Rescanned: char(1) Terminal_ID: varchar(16) Scanned_Item_Count: int Trip_Length_Seconds: int PSS_Shopping_Incomplete_List Customer_ID: int Shopping_List_ID: int Time_Started: datetime Time_Ended: datetime Shopping_List_Status_ID: int Total: int Transaction_ID: varchar(25) Rescanned: char(1) Terminal_ID: varchar(16) Scanne
Appendix A UMS_Card_Reader_Type UMS_Entrance Reader_Type: int Entrance_ID: int Description: varchar(50) Reader_Type: int Reader_Port: varchar(8) Status_Code: int Status_Datetime: datetime Display_Type: int Display_Port: varchar(8) Default_Mode: int Current_Mode: int Backup_ID: int Hardware_ID: varchar(16) Reader_Status: int Display_Status: int Entrance_Notes: varchar(40) Description: varchar(50) Card_Sentinel: varchar(5) Card_Offset: int End_Sentinel: varchar(5) UMS_Dispenser Dispenser_ID: varchar(4) D
Appendix B B.1 Database Tables / Physical Properties Table Name: PSS_Admin_Action Table Column Name Action_ID Description Privilege_Level Disabled Table Column Datatype int varchar(60) int char(1) Table Column Null Option NOT NULL NULL NULL NULL Table Column Is PK Table Column Is FK Yes No No No No No No No PSS Admin Action Table holds privilege information for various actions available through the service terminal Action_ID Description Privilege_Level Disabled B.
Appendix B Authenticated or not Disabled Parent_Menu_ID Target_Page_Name Button_Columns Special_Type Refresh_Seconds automatically refresh B.
Appendix B Privilege_Mask Login_Failures Last_IP Language_ID varchar(255) int varchar(16) int NULL NULL NULL NULL No No No No No No No Yes PSS Admin User Table holds information about Service Terminal Users Username the username this Administrative User will log in as Full_Name the full name of this Administrative User Password the password this Administrative User will use to log in Valid_Datetime the date/time this Administrative User account is active Expires_Datetime the date/time this Administrati
Appendix B B.
Appendix B Currency_ID Language_ID Rescan_Level Rank Suspend_Reason Card_Expiration_Datetime Num_Trips Num_Trips_Since_Rescan Last_Trip_Datetime First_Trip_Accurate Greeting_Text Registered_Datetime Display_Foodstamp Special_Customer Suspend_ID Num_Rescans Group_ID Num_Rescan_Diffs Num_Trips_Incomplete Total_Trip_Seconds First_Trip_Datetime Last_Incomplete_Datetime Total_Spent Last_Rescan_Datetime int int int int varchar(80) datetime int int datetime char(1) varchar(255) datetime char(1) char(1) int int in
Appendix B Greeting_Text greeting text to be displayed upon dispensing a terminal to this customer Registered_Datetime date/time that this customer was added to PSS Display_Foodstamp indicates whether this customer is shown foodstamp totals on their and-held terminal Special_Customer indicates whether this is a special type of customer (e.g.
Appendix B Table Column Name Suspend_ID Suspend_Reason Table Column Datatype Int Varchar(80) Table Column Null Option NOT NULL NULL Table Column Is PK Table Column Is FK Yes No No No PSS Customer Suspend Reason Table holds the Suspend ID reason codes for which a customer may be suspended from using PSS. Suspend_ID Suspend_Reason unique identifier for this suspend reason code text description of this suspend reason code B.
Appendix B B.
Appendix B POS_Item_Flag Currency_ID indicates whether this item has been processed through the POS during the current download process currency identifier for the currency in which this items price is described (from PSS_Currency) B.
Appendix B Language_ID Message Text Target Coupon Amt Target Rank Start_Datetime End_Datetime language that this message is in (from PSS_Language) marketing message text if the message contains a coupon offer, this is the amount of the coupon the customer rank level targeted by this message date/time after which this message is to be displayed date/time after which this message will no longer be displayed B.
Appendix B Target Coupon Amt Target Rank Start_Datetime End_Datetime if the message contains a coupon offer, this is the amount of the coupon the customer rank level targeted by this message date/time after which this message is to be displayed date/time after which this message will no longer be displayed B.
Appendix B B.
Appendix B Table Column Name Customer_ID Shopping_List_ID Department_ID Order_List_ID Item_ID Qty Notes Table Column Datatype int int int int varchar(20) int varchar(80) Table Column Null Option NOT NULL NOT NULL NOT NULL NOT NULL NOT NULL NULL NULL Table Column Is PK Table Column Is FK Yes Yes Yes Yes Yes No No Yes Yes Yes Yes Yes No No PSS Order List Item Table contains the item information in a customer order Customer ID Shopping List ID Department ID Order List ID identifies customer associated
Appendix B Instance_Name the particular instance of this type of entry (typically the controller or file name) Detection_Time date/time when the activity was initiated Start_Time date/time when the processing started End_Time date/time when the processing ended Instance_Value text value associated with this entry Instance_Description text description associated with this entry Instance_Data integer data associated with this entry B.
Appendix B B.
Appendix B B.
Appendix B B.
Appendix B B.
Appendix B B.32 Table Name: PSS_Shopping_History_Rescan Table Column Name Customer_ID Shopping_List_ID POS_Price PSS_Price POS_Qty PSS_Qty Table Datatype int int int int int int Column Table Column Null Option NOT NULL NOT NULL NULL NULL NULL NULL Table Column Is PK Table Column Is FK Yes Yes No No No No Yes Yes No No No No PSS Shopper History Rescan Table contains the re-scan data for a customer’s previous shopping trip.
Appendix B Total Transaction_ID Rescanned Terminal_ID total amount for this trip transaction identifier sent to/from the POS to help match shopping lists indicates whether this shopping trip was rescanned the terminal ID (from UMS_Terminal) of the terminal last used on this shopping trip Scanned_Item_Count number of items in this shopping list Trip_Length_Seconds number of seconds the terminal was in use for this shopping trip WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Appendix B B.
Appendix B B.
Appendix B B.
Appendix B B.
Appendix B B.
Appendix B B.
Appendix B PSS_Unknown_Item Table contains items scanned during shopping trips for which no matching item could be found in PSS_Item Item_ID Terminal_ID Scanned_Datetime Customer_ID Shopping_List_ID the barcode as returned by the scanner the Terminal ID (from UMS_Terminal) that scanned this item date/time that this item was scanned the customer ID (from PSS_Customer) that scanned this item the shopping list ID (from PSS_Shopping_List) of the list that this item was to be added to B.
Appendix B B.
Appendix B Default_Entrance Status_Code Status_Datetime Default_Printer Current_Mode the default entrance unit ID (from UMS_Entrance) for this dispenser, in case the entrance unit in use must be changed the status code (from UMS_Status_Codes) for the current state of this dispenser the date/time of the last status update for this dispenser the default printer ID (from UMS_Printer) for this dispenser, in case the printer in use must be changed indicates whether this dispenser is in Key-Controlled Unlock mod
Appendix B Hardware_ID Reader_Status Display_Status Entrance_Notes the hardware ID for this entrance unit (either the name of the PssEntranceXX service which controls this non-RF entrance unit, or the MAC address for RF entrance units) the status code (from UMS_Status_Codes) for the card reader associated with this entrance unit the status code (from UMS_Status_Codes) for the display associated with this entrance unit text associated with this entrance unit (typically for reason out of service) B.
Appendix B B.
Appendix B B.51 Table Name: UMS_Status_Codes Table Column Name Status_Code Status_Text Table Column Datatype int varchar(30) Table Column Null Option NOT NULL NULL Table Column Is PK Table Column Is FK Yes No No No UMS_Status_Codes Table contains definitions of the hardware status codes used throughout the system Status_Code Status_Text unique identifier for this status code text description of this status code B.
Appendix B Bad_Scans Seconds_Used Tot_Issue_Count the number of bad scans for this terminal from the last issue the number of seconds this terminal was used from the last issue the total number of times this terminal was issued (since last statistics reset) 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
Appendix D POS Interface File Descriptions Appendix C Overview Price Calculation Algorithms This appendix describes how price calculations are performed. A price is calculated for every item scanned during a shopping trip. Each item has an associated pricing method. The following item characteristics are used to determine how to calculate its price. • Pricing methodThe pricing method helps to determine the equation used to calculate the price of an item.
Appendix D C.2 POS Interface File Descriptions Overview Split Package Pricing The Split Package Pricing Method is a group pricing method based on a deal price and a deal quantity or a deal weight.
Appendix D POS Interface File Descriptions Item Price = Purchase Weight WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Appendix D POS Interface File Descriptions Overview Unit Pricing Example An 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.47 A weighted item costs $1.29 for a weight of 1 lb. The customer purchases 3 lbs. of the item. Item Price = C.4 3 * $1.29 = $3.87 Base Plus One Pricing The Base Plus One Pricing Method is a group pricing method based on a deal price and a deal quantity.
Appendix D POS Interface File Descriptions Overview New Total Price = ( 3 * $0.47 )/5 = $0.29 Item Price = $0.29 – $0.19 = $0.10 Item Number 4 added to shopping list. New Total Price = ( 4 * $0.47 )/5 = $0.38 Item Price = $0.38 – $0.29 = $0.09 Item Number 5 added to shopping list. New Total Price = ( 5 * $0.47 )/5 = $0.47 Item Price = $0.47 – $0.38 = $0.09 Item Number 6 added to shopping list. New Total Price = ( 6 * $0.47 )/5 = $0.57 Item Price = $0.57 – $0.47 = $0.10 C.
Appendix D POS Interface File Descriptions Overview Deal Quantity Item Price = Total Price – Previous Total Price WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Appendix D POS Interface File Descriptions Overview Group Threshold Pricing Example Items of the same type or group are sold at five for $0.47. The unit price of the items in the group is $0.10. The items are added at different times during the shopping trip. Item Number 1 added to shopping list. Item Price = $0.10 Total Price = ((1/5) * 0.47) + ((1 % 5) * $0.10) = $0.10 Item Number 2 added to shopping list. Item Price = $0.10 Total Price = ((2/5) * 0.47) + ((2 % 5) * $0.10) = $0.
Appendix D POS Interface File Descriptions Overview Item Price = $0.10 ( Unit Price ) Total Price = ((8/5) * 0.47) + ((8 % 5) * $0.10) = $0.77 WaveWorks PSS, Integration Guide, 1.10 © 2000, Symbol Technologies, Inc.
Appendix D POS Interface File Descriptions Overview Item Number 9 added to shopping list. Item Price = $0.10 ( Unit Price ) Total Price = ((9/5) * 0.47) + ((9 % 5) * $0.10) = $0.87 Item Number 10 added to shopping list. Total Price = ( 10 * $0.47 )/5 = $0.94 Item Price = $0.94 – $0.87 = $0.07 C.6 Group Adjusted Pricing The Group Adjusted Pricing Method is a group pricing method based on a unit price, a deal price and a deal quantity.
Appendix D POS Interface File Descriptions Overview Group Adjusted Threshold Pricing Example Items of the same type or group are sold at a unit price of $0.10. A special price of $0.08 is activated when 3 items are purchased. Item Number 1 added to shopping list. Item Price = $0.10 Total Price = 1 * $0.10 = $0.10 Item Number 2 added to shopping list. Item Price = $0.10 Total Price = 2 * $0.10 = $0.20 Item Number 3 added to shopping list. Total Price = 3 * $0.08 = $0.24 Item Price = $0.24 - $0.20 = $0.
Appendix D POS Interface File Descriptions Overview Total Price = Purchase Quantity * Deal Price The prices of all items added after the threshold item are calculated using the following equations: Item Price = Unit Price Total Price = ( Deal Quantity * Deal Price ) + ( ( Purchase Quantity – Deal Quantity ) * Unit Price ) Unit Adjusted Threshold Pricing Example 1 Items 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.
Appendix D POS Interface File Descriptions Overview Unit Adjusted Threshold Pricing Example 2 Items of the same type or group are sold at a unit price of $0.20. One item of the group per shopping trip is free. Item Number 1 added to shopping list. Item Price = $0.00 Total Price = 1 * $0.00 = $0.00 Item Number 2 added to shopping list. Item Price = $0.20 Total Price = ( 1 * $0.00 ) + ( ( 2 – 1 ) * $0.20 ) = $0.20 Item Number 3 added to shopping list. Item Price = $0.20 Total Price = ( 1 * $0.
Appendix D POS Interface File Descriptions Overview C.10 Rounding Methods The following rounding methods are used on the PSS system: Rounding Method 1 Prices are rounded up. Any decimal past the units position increases the units position by 1. ( 1 * $1.00 ) -------------- = $0.33333 3 Rounds up to $0.34 Rounding Method 2 Prices are rounded down. Any decimal past the units position is discarded. ( 1 * $1.00 ) -------------- = $0.33333 3 Rounds down to $0.
Appendix D POS Interface File Descriptions Overview Appendix D POS Interface File Descriptions Information is exchanged between the PSS system and the POS system using ASCII flat files copied between the systems. The files are exchanged in a directory configured in the PSS System Settings. It defaults to the C:\PSS\TRANSFER subdirectory. This section contains detailed information regarding the contents of these files. Each of these files contains multiple record types.
Appendix D POS Interface File Descriptions PSS Transaction File D.1 PSS Transaction File Filename File directory path specified in PSS System Settings. The file name defaults to SCxxyyyy.
Appendix D POS Interface File Descriptions PSS Transaction File Item Information Field Name Length Comments Record Type Item Number Start Offset 0 2 2 24 Item Price Flags 26 36 10 5 41 2 ‘Standard’ SCAN IN item record type = 02 Item barcode number right justified, zero filled on left (only last 13 digits are currently used). Item price in units (max 9,999,999,999) (right justified, zero filled on left) Implementation specific flags.
Appendix D POS Interface File Descriptions POS Transaction File D.2 POS Transaction File Filename File directory path specified in PSS System Settings. The file name defaults to SCxxyyyy.OUT, where ‘xx’ is the day of the month of this transaction as specified in the transaction barcode on the dispenser ticket and ‘yyyy’ is the four character POS transaction number. POS system Contains the list of items processed at the POS terminal by the cashier during the checkout process.
Appendix D POS Interface File Descriptions POS Transaction File Standard Item Information Field Name Length Record Type Item Number Start Offset 0 2 Item Price 26 10 Flags 36 5 PSS Expansion Area User Expansion Area Record Terminator 2 24 Comments ‘Standard’ item information = 04 Item barcode number right justified, zero filled on left (only the last 13 bytes are currently used). Item price in units (max 9,999,999,999) (right justified, zero filled on left) Implementation specific flags.
Appendix D POS Interface File Descriptions Item Record File D.3 Item Record File Filename Specified in PSS System Settings, defaults to PLUMT??.DAT for updates and to PLUNW.DAT for a full Item file replacement. POS Controller Contains item attributes needed by PSS for retrieval of item descriptions & computation of item prices.
Appendix D POS Interface File Descriptions Tax Table File D.4 Tax Table File Filename File directory path specified in PSS System Settings. The file name defaults to NXGTAXTxx.DAT, where ‘xx’ is a two digit number identifying which taxt table on the POS it represents POS system Source: Description Type Record Length Number of Records ASCII Sequential Variable Variable. This file is not in standard fixed length record format. It is a variable record length file with commadelimited fields.
D.5 Customer Information File Filename Source: Description Type Record Length Number of Records File directory path specified in PSS System Settings. The file name defaults to CUSTMTxx.DAT, where ‘xx’ is a two digit ID number. POS system Contains the list of customers which may use the PSS system. ASCII Sequential Fixed, 291* (Actual length depends on configured expansion area sizes) Variable, one record for each customer.
Field Name Record Type Action Start Offset 0 2 Length 3 20 Customer update record type = 09 ‘A’ = Add/Update ‘D’ = Delete Customer loyalty card number, (right justified, zero filled on left) 23 63 40 40 Customer’s name (left justified, space filled on right) First line of customer address (left justified, space filled on right) 103 40 Second line of customer address (left justified, space filled on right) 143 40 183 40 Third line of customer address (left justified, space filled on right – p
