Oracle® Retail Point-of-ServiceOperations Guide

Release 12.0

September 2007

Oracle Retail Point-of-Service Operations Guide, Release 12.0

Copyright © 2007, Oracle. All rights reserved.

Primary Author: Graham Fredrickson

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.

Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.

Value-Added Reseller (VAR) Language

(i) the software component known as ACUMATE developed and licensed by Lucent Technologies Inc. of Murray Hill, New Jersey, to Oracle and imbedded in the Oracle Retail Predictive Application Server - Enterprise Engine, Oracle Retail Category Management, Oracle Retail Item Planning, Oracle Retail Merchandise Financial Planning, Oracle Retail Advanced Inventory Planning and Oracle Retail Demand Forecasting applications.

(ii) the MicroStrategy Components developed and licensed by MicroStrategy Services Corporation (MicroStrategy) of McLean, Virginia to Oracle and imbedded in the MicroStrategy for Oracle Retail Data Warehouse and MicroStrategy for Oracle Retail Planning & Optimization applications.

(iii) the SeeBeyond component developed and licensed by Sun MicroSystems, Inc. (Sun) of Santa Clara, California, to Oracle and imbedded in the Oracle Retail Integration Bus application.

(iv) the Wavelink component developed and licensed by Wavelink Corporation (Wavelink) of Kirkland, Washington, to Oracle and imbedded in Oracle Retail Store Inventory Management.

(v) the software component known as Crystal Enterprise Professional and/or Crystal Reports Professional licensed by Business Objects Software Limited ("Business Objects") and imbedded in Oracle Retail Store Inventory Management.

(vi) the software component known as Access Via™ licensed by Access Via of Seattle, Washington, and imbedded in Oracle Retail Signs and Oracle Retail Labels and Tags.

(vii) the software component known as Adobe Flex™ licensed by Adobe Systems Incorporated of San Jose, California, and imbedded in Oracle Retail Promotion Planning & Optimization application.

(viii) the software component known as Style Report™ developed and licensed by InetSoft Technology Corp. of Piscataway, New Jersey, to Oracle and imbedded in the Oracle Retail Value Chain Collaboration application.

(ix) the software component known as i-net Crystal-Clear™ developed and licensed by I-NET Software Inc. of Berlin, Germany, to Oracle and imbedded in the Oracle Retail Central Office and Oracle Retail Back Office applications.

(x) the software component known as WebLogic™ developed and licensed by BEA Systems, Inc. of San Jose, California, to Oracle and imbedded in the Oracle Retail Value Chain Collaboration application.

(xi) the software component known as DataBeacon™ developed and licensed by Cognos Incorporated of Ottawa, Ontario, Canada, to Oracle and imbedded in the Oracle Retail Value Chain Collaboration application.

v

Contents

List of FiguresList of TablesList of Examples

Preface ............................................................................................................................................................. xxiii

Audience................................................................................................................................................... xxiiiRelated Documents ................................................................................................................................. xxiiiCustomer Support ................................................................................................................................... xxiiiReview Patch Documentation ............................................................................................................... xxivOracle Retail Documentation on the Oracle Technology Network ................................................. xxivConventions ............................................................................................................................................. xxiv

1 Backend System Administration and Configuration

Defining Security with Roles ................................................................................................................ 1-1Modifying a Role................................................................................................................................ 1-1Adding a Role ..................................................................................................................................... 1-2Secured Features ................................................................................................................................ 1-4Security Implementation -- Warnings and Advice ....................................................................... 1-5

Password Policy ........................................................................................................................................ 1-6Password Reset................................................................................................................................... 1-6Viewing or Modifying the Password in the Database.................................................................. 1-7Password Policy and Password Change......................................................................................... 1-8

Reason Codes ............................................................................................................................................ 1-8Configuring Transaction ID Lengths................................................................................................. 1-11

Understanding Transaction IDs.................................................................................................... 1-12Changing Transaction ID Lengths................................................................................................ 1-12

Configuring the Purchase Date Field for Returns and Voids............................................ 1-13Configuring RMI Timeout Intervals ................................................................................................. 1-13

Setting the RMI Timeout Interval for the JVM Under Linux.................................................... 1-13Modifying the TCP Connection Timeout on Linux ............................................................ 1-13

Setting the RMI Timeout Interval for All Manager and Technician Calls.............................. 1-14Setting the RMI Timeout Interval for a Specific Technician ..................................................... 1-14

Configuring Third-party Tender Authorization ............................................................................. 1-14Enabling the Financial Network Technician ............................................................................... 1-15Setting the Merchant Number....................................................................................................... 1-15

System Settings...................................................................................................................................... 1-15Adding or Changing Language Bundles .......................................................................................... 1-15

Naming Convention for Language Bundles ............................................................................... 1-16

vi

Creating a New Language Bundle ............................................................................................... 1-16Configuring the System to Use a New Language Bundle......................................................... 1-16

Configuring Logging ............................................................................................................................ 1-16

2 Technical Architecture

Point-of-Service Architecture................................................................................................................. 2-2Frameworks ............................................................................................................................................... 2-4

Manager/Technician ......................................................................................................................... 2-4User Interface...................................................................................................................................... 2-5Business Object ................................................................................................................................... 2-7Data Persistence.................................................................................................................................. 2-8Tour ................................................................................................................................................... 2-10

Design Patterns ...................................................................................................................................... 2-10MVC Pattern .................................................................................................................................... 2-10Factory Pattern................................................................................................................................. 2-11Command Pattern ........................................................................................................................... 2-12Singleton Pattern ............................................................................................................................. 2-13

3 Extracting Source Code

4 Customization

Parameters.................................................................................................................................................. 4-1Parameter Hierarchy.......................................................................................................................... 4-1Parameter Group................................................................................................................................ 4-2Parameter Properties ......................................................................................................................... 4-2

Devices ....................................................................................................................................................... 4-3Set Up the Device ............................................................................................................................... 4-3Test the Device.................................................................................................................................... 4-4Create a Session and ActionGroup.................................................................................................. 4-4Simulate the Device ........................................................................................................................... 4-6

Help Files ................................................................................................................................................... 4-6Modifying Help Files......................................................................................................................... 4-7

5 Development Environment

Preparation................................................................................................................................................. 5-1Setup ........................................................................................................................................................... 5-1

Install Point-of-Service ..................................................................................................................... 5-1Build the Database ............................................................................................................................. 5-2Create a Sandbox................................................................................................................................ 5-2Configure the IDE .............................................................................................................................. 5-3Update Java Security and Policy Files............................................................................................. 5-4Configure the Version Control System ........................................................................................... 5-4

Run Point-of-Service................................................................................................................................ 5-4

6 General Development Standards

Basics........................................................................................................................................................... 6-1

vii

Java Dos and Don’ts........................................................................................................................... 6-1Avoiding Common Java Bugs.......................................................................................................... 6-2Formatting........................................................................................................................................... 6-2Javadoc................................................................................................................................................. 6-3Naming Conventions......................................................................................................................... 6-3SQL Guidelines................................................................................................................................... 6-4

DB2................................................................................................................................................ 6-5Oracle............................................................................................................................................ 6-6PostgreSQL .................................................................................................................................. 6-6Sybase ........................................................................................................................................... 6-6

Unit Testing......................................................................................................................................... 6-7Architecture and Design Guidelines .................................................................................................... 6-7

AntiPatterns ........................................................................................................................................ 6-7Designing for Extension .................................................................................................................... 6-9

Common Frameworks .......................................................................................................................... 6-10Logging............................................................................................................................................. 6-10

Guarding Code......................................................................................................................... 6-10When to Log.............................................................................................................................. 6-11Writing Log Messages............................................................................................................. 6-11Exception Messages ................................................................................................................. 6-11Heartbeat or Life Cycle Messages ......................................................................................... 6-12Debug Messages....................................................................................................................... 6-12

Exception Handling ........................................................................................................................ 6-13Types of Exceptions ................................................................................................................. 6-13Avoid java.lang.Exception...................................................................................................... 6-14Avoid Custom Exceptions ...................................................................................................... 6-14Catching Exceptions ................................................................................................................ 6-14

Keep the Try Block Short ................................................................................................. 6-14Avoid Throwing New Exceptions.................................................................................. 6-15Catching Specific Exceptions .......................................................................................... 6-16Favor a Switch over Code Duplication.......................................................................... 6-16

7 Point-of-Service Development Standards

Screen Design and User Interface Guidelines.................................................................................... 7-1Tour Framework........................................................................................................................................ 7-1

Tour Architectural Guidelines ......................................................................................................... 7-1General Tour Guidelines................................................................................................................... 7-1Foundation .......................................................................................................................................... 7-3Tours and Services ............................................................................................................................. 7-3Sites ...................................................................................................................................................... 7-4Managers and Technicians ............................................................................................................... 7-4Roads.................................................................................................................................................... 7-4Aisles .................................................................................................................................................... 7-5Signals .................................................................................................................................................. 7-5Choosing Among Sites, Aisles, and Signals ................................................................................... 7-6Renaming Letters ............................................................................................................................... 7-6Shuttles ................................................................................................................................................ 7-6

viii

Cargo.................................................................................................................................................... 7-7Log Entry Format ...................................................................................................................................... 7-7

Log Entry Description ....................................................................................................................... 7-7Fixed Length Header ......................................................................................................................... 7-7Additional Logging Info ................................................................................................................... 7-8Example Log Entry ............................................................................................................................ 7-9

8 Extension Guidelines

Conventions............................................................................................................................................... 8-1Terms.................................................................................................................................................... 8-1Filename Conventions....................................................................................................................... 8-1Modules ............................................................................................................................................... 8-2Directory Paths ................................................................................................................................... 8-2

POS Package.............................................................................................................................................. 8-3Tour ...................................................................................................................................................... 8-3

Tour Map...................................................................................................................................... 8-3Tour Scripts.................................................................................................................................. 8-4Site ................................................................................................................................................. 8-4Lane—Road or Aisle................................................................................................................... 8-5Shuttle ........................................................................................................................................... 8-5Signal ............................................................................................................................................ 8-6Cargo............................................................................................................................................. 8-6

UI Framework..................................................................................................................................... 8-7Default UI Config........................................................................................................................ 8-7UI Script........................................................................................................................................ 8-8Bean Model and Bean................................................................................................................. 8-8

Other .................................................................................................................................................... 8-9Internationalization .................................................................................................................... 8-9Conduit Scripts......................................................................................................................... 8-10PLAF .......................................................................................................................................... 8-10Receipts...................................................................................................................................... 8-10Reports....................................................................................................................................... 8-11

Domain Package .................................................................................................................................... 8-11Retail Domain .................................................................................................................................. 8-12

DomainObjectFactory.............................................................................................................. 8-12Retail Domain Object (RDO) .................................................................................................. 8-12

Database ........................................................................................................................................... 8-13Data Manager and Technician Scripts .................................................................................. 8-13Data Actions and Operations ................................................................................................. 8-13Data Transactions..................................................................................................................... 8-14

9 Tour Framework

Tour Components ..................................................................................................................................... 9-1Tour Metaphor.................................................................................................................................... 9-1Service and Service Region ............................................................................................................... 9-3Bus ........................................................................................................................................................ 9-3Tourmap .............................................................................................................................................. 9-4

ix

Cargo.................................................................................................................................................... 9-5Sites ...................................................................................................................................................... 9-6System Sites......................................................................................................................................... 9-6Letters................................................................................................................................................... 9-7Roads.................................................................................................................................................... 9-7Common Roads .................................................................................................................................. 9-8Aisles .................................................................................................................................................... 9-8Stations and Shuttles.......................................................................................................................... 9-9Signals ............................................................................................................................................... 9-10Exception Region............................................................................................................................. 9-11

Role of Java Classes .............................................................................................................................. 9-12Tour Cam ................................................................................................................................................. 9-12

Attributes.......................................................................................................................................... 9-13Letter Processing ............................................................................................................................. 9-16Cargo Restoration............................................................................................................................ 9-16

Tender Tour Reference.......................................................................................................................... 9-17

10 UI Framework

Screens ..................................................................................................................................................... 10-2Beans ........................................................................................................................................................ 10-4

PromptAndResponseBean............................................................................................................. 10-4Bean Properties and Text Bundle .......................................................................................... 10-4Tour Code ................................................................................................................................. 10-6

DataInputBean................................................................................................................................. 10-7Bean Properties and Text Bundle .......................................................................................... 10-7Tour Code ................................................................................................................................. 10-8

NavigationButtonBean ................................................................................................................... 10-9Bean Properties and Text Bundle .......................................................................................... 10-9

LocalNavigationPanel ...................................................................................................... 10-9GlobalNavigationPanel.................................................................................................. 10-10

Tour Code ............................................................................................................................... 10-11DialogBean ..................................................................................................................................... 10-12

Bean Properties and Text Bundle ........................................................................................ 10-12Tour Code ............................................................................................................................... 10-12

Field Types ..................................................................................................................................... 10-14Connections .......................................................................................................................................... 10-15

ClearActionListener ...................................................................................................................... 10-15DocumentListener......................................................................................................................... 10-15ValidateActionListener................................................................................................................. 10-15

Text Bundles ......................................................................................................................................... 10-16receiptText...................................................................................................................................... 10-16parameterText................................................................................................................................ 10-17

11 Manager/Technician Framework

New Manager/Technician .................................................................................................................... 11-3Manager Class ................................................................................................................................. 11-4

x

Manager Configuration.................................................................................................................. 11-4Technician Class .............................................................................................................................. 11-5Technician Configuration .............................................................................................................. 11-5Valet Class ........................................................................................................................................ 11-6Sample Code .................................................................................................................................... 11-6

Configuration ........................................................................................................................... 11-7Tour Code ................................................................................................................................. 11-7Manager..................................................................................................................................... 11-7Valet ........................................................................................................................................... 11-8Technician ................................................................................................................................. 11-9

Manager/Technician Reference ........................................................................................................ 11-10Parameter Manager/Technician ................................................................................................. 11-10UI Manager/Technician............................................................................................................... 11-12Journal Manager/Technician ...................................................................................................... 11-13

12 Retail Domain

New Domain Object ............................................................................................................................. 12-2Domain Object in Tour Code .............................................................................................................. 12-3Domain Object Reference.................................................................................................................... 12-4

CodeListMap.................................................................................................................................... 12-4Currency ........................................................................................................................................... 12-6Transaction....................................................................................................................................... 12-8

13 Store Database

ARTS Compliance ................................................................................................................................. 13-1Understanding Data Managers and Technicians ............................................................................ 13-1How Data Transactions Work.............................................................................................................. 13-3Creating or Updating Database Tables ............................................................................................. 13-5Example of Saving Data: Storing Tender Information................................................................... 13-7

Research Table Requirements and Standards............................................................................. 13-7Saving Data from Site Code........................................................................................................... 13-8Locate Data Operation.................................................................................................................... 13-9Modify Data Operation ................................................................................................................ 13-13Test Code........................................................................................................................................ 13-15Verify Data ..................................................................................................................................... 13-15

Updating Flat File Configurations ................................................................................................... 13-15Data Technician Script.................................................................................................................. 13-16Flat File Engine Configuration Script......................................................................................... 13-17Implementing FlatFileDataOperations ...................................................................................... 13-18Other Query Types ....................................................................................................................... 13-21Complex Query Expressions ....................................................................................................... 13-21

A Appendix: Intra Store Data Distribution Infrastructure

Spring Configuration ............................................................................................................................. A-1Application Configuration .................................................................................................................... A-6Integration Considerations.................................................................................................................... A-7

xi

DataSet Compressed File Structure .................................................................................................... A-8DataSet Compressed File Example................................................................................................. A-8

Manifest File Structure........................................................................................................................... A-9Manifest File Example ...................................................................................................................... A-9

DataSet Flat File Structure..................................................................................................................... A-9DataSet Flat File Example ................................................................................................................ A-9

Extensibility.............................................................................................................................................. A-9Adding New Table To Existing Dataset ...................................................................................... A-10

Adding More Tables To Existing Dataset Types................................................................. A-10Adding a New DataSet .................................................................................................................. A-11Configuring Schedule for DataSet Producer and Consumer ................................................... A-11

Configure DataSet Producer .................................................................................................. A-11Configure DataSet Consumer ................................................................................................ A-12

Adding New DataSet Type............................................................................................................ A-13Changing Oracle Retail Point-of-Service Client Database vendor........................................... A-18Plugability ........................................................................................................................................ A-18

B Appendix: Value-Added Tax

VAT calculation ........................................................................................................................................ B-1Inclusive Tax Flag At Tax Group Rule Level ................................................................................ B-1Inclusive Tax Rate Calculator.......................................................................................................... B-1Enhancing PLU Item Look Up ........................................................................................................ B-2Enhancing Internal Tax Engine....................................................................................................... B-2VAT Tax Rule Seed Data.................................................................................................................. B-2Calculate VAT For Unknown Items, Invalid Or Blank Tax Groups.......................................... B-3Calculate VAT for Returns Transactions ....................................................................................... B-3Calculate VAT for Reverse Transactions Other Than Returns................................................... B-3Calculate VAT for Shipping Charges............................................................................................. B-4

Enhance Shipping Method Table and Domain Interface/Class ......................................... B-4Add/Update Send Packages to/in a Sale Return Transaction ........................................... B-4Enhance Internal Tax Engine ................................................................................................... B-4Negate VAT for Shipping Charges for a Post Void Transaction ........................................ B-4Enhance Overlay Lane Action Class SendMethodSelectedRoad........................................ B-4

Calculate VAT for Send Transactions ............................................................................................ B-5Transaction Persistence for VAT ........................................................................................................... B-5

Persist Inclusive tax .......................................................................................................................... B-5Persist Shipping Charge Tax ........................................................................................................... B-6

Tracking VAT Financial Totals .............................................................................................................. B-6Accumulate Inclusive Tax................................................................................................................ B-7Accumulate Shipping Charge Tax.................................................................................................. B-8

Transaction Retrieval in CO .................................................................................................................. B-9Enhancing Transaction Entity Beans.............................................................................................. B-9Enhancing Transaction Service Bean.............................................................................................. B-9Enhancing Transaction Manager Bean ........................................................................................ B-10

Enhancing POSLog ............................................................................................................................... B-10Seed Data Population ........................................................................................................................... B-12

VAT Tax Rule Seed Data................................................................................................................ B-12

xii

Point-of-Service Department Seed Data ...................................................................................... B-13Item Seed Data................................................................................................................................. B-13Shipping Method Seed Data.......................................................................................................... B-13Sales Return Transaction Seed Data ............................................................................................. B-14

New or Changed Classes/Services ..................................................................................................... B-14Adding Tax Inclusive Flag To Tax Group Rule.......................................................................... B-14

Business Objects ....................................................................................................................... B-14Persistence Services ................................................................................................................. B-14Import Services......................................................................................................................... B-15

Internal Tax Engine Classes........................................................................................................... B-15Tax Rate Calculators ....................................................................................................................... B-15

Business Objects ....................................................................................................................... B-15Domain Object Factory Service.............................................................................................. B-15

Enhancing Domain Tax Interfaces/Classes ................................................................................ B-16Tax Information Interface/Class ........................................................................................... B-16Tax Information Container Interface/Class......................................................................... B-16

Enhancing Transaction & Line Item Tax Interfaces/Classes.................................................... B-17Transaction Totals Interface/Class........................................................................................ B-17Item Tax Interface/Class......................................................................................................... B-17Item Price Interface/Class ...................................................................................................... B-18Tax Line Item Information Interface ..................................................................................... B-18Sale Return Line Item Class.................................................................................................... B-18

Enhancing Financial Totals Interfaces/Classes .......................................................................... B-18Financial Tax Totals Interface/Class..................................................................................... B-18Financial Totals Interface/Class ............................................................................................ B-19

Add Support for Inclusive Tax ....................................................................................... B-19Add Support for Shipping Charges Tax........................................................................ B-19

Shipping Method Interface/Class ................................................................................................ B-20Send Package Line Item Interface/Class ..................................................................................... B-20Enhancing Sale Return Transaction Interface/Class ................................................................. B-23Enhancing POSLog Interface/Class ............................................................................................. B-24

Log Retail Transaction Class .................................................................................................. B-24Log Sale Return Line Item Class............................................................................................ B-24IXRetail Constants V21 Ifc Class............................................................................................ B-24Retail Transaction Delivery 360 Ifc Interface/Class ........................................................... B-25Schema Types Factory Ifc Interface/Class ........................................................................... B-25Retail Transaction Line Item Ifc Interface/Class................................................................. B-25

XmlToSqlTaxHistoryInsert Class ................................................................................... B-25XmlToSqlFinancialTotalsCommon Class...................................................................... B-25XmlToSqlDeliveryTax Class............................................................................................ B-25JdbcSaveIXRetailRetailTransaction Class...................................................................... B-25360POSLogLibrary.xsd .................................................................................................... B-25

Commerce Service Transaction DTO Classes ............................................................................. B-26Retail Transaction DTO........................................................................................................... B-26Transaction Group Rule Tax DTO......................................................................................... B-26Sale Return Line Item Tax DTO............................................................................................. B-27Sale Return Line Item DTO .................................................................................................... B-27

xiii

Shipping Record Tax DTO...................................................................................................... B-27Shipping Record DTO ............................................................................................................. B-27

Web Modules Transaction View Bean Classes ........................................................................... B-28Database Design / Changes -- Tables /Views ................................................................................... B-28

Tax Group Rule Table RU_TX_GP ............................................................................................... B-28Retail Transaction Table TR_RTL ................................................................................................. B-28Tax Line Item Table TR_LTM_TX................................................................................................. B-28Sales Return Line Item Table TR_LTM_SLS_RTN ..................................................................... B-29Sales Return Tax Line Item Table TR_LTM_SLS_RTN_TX ...................................................... B-29Order Item Table OR_LTM............................................................................................................ B-29Point-of-Service Department History Table LE_HST_PS_DPT................................................ B-29Till History Table LE_HST_TL...................................................................................................... B-29Register History Table LE_HST_WS ............................................................................................ B-30Store History Table LE_HST_STR ................................................................................................ B-30Tax History Table HST_TX............................................................................................................ B-30Shipping Methods Table CO_SHP_MTH.................................................................................... B-30Shipping Record Table SHP_RDS_SLS_RTN ............................................................................. B-30Shipping Record Tax Table SHP_RDS_SLS_RTN_TX............................................................... B-31

C Appendix: Changing Currency

xiv

xv

List of Figures

1–1 Set Access Screen......................................................................................................................... 1-21–2 Add Role Screen.......................................................................................................................... 1-31–3 Set Access Screen......................................................................................................................... 1-41–4 Reason Code Group Screen ....................................................................................................... 1-91–5 Reason Code List Screen ......................................................................................................... 1-101–6 Edit Reason Code Screen ........................................................................................................ 1-112–1 Oracle Retail Architecture ......................................................................................................... 2-12–2 Point-of-Service Architecture Layers ....................................................................................... 2-32–3 Manager/Technician Framework ............................................................................................ 2-52–4 UI Framework ............................................................................................................................. 2-62–5 Business Object Framework ...................................................................................................... 2-82–6 Data Persistence Framework..................................................................................................... 2-92–7 MVC Pattern ............................................................................................................................. 2-102–8 Factory Pattern ......................................................................................................................... 2-112–9 Command Pattern.................................................................................................................... 2-122–10 Singleton Pattern...................................................................................................................... 2-139–1 Workflow Example: Tender with Credit Card Option....................................................... 9-1811–1 Manager, Technician and Valet ............................................................................................. 11-112–1 CodeListMap Class Diagrams................................................................................................ 12-612–2 Currency Class Diagram......................................................................................................... 12-713–1 Data Managers and Data Technicians .................................................................................. 13-213–2 Updating the Database: Simplified Runtime View............................................................. 13-413–3 Tender Tour to Point-of-Service Tour Workflow................................................................ 13-913–4 Diagram: Saving a Transaction ............................................................................................ 13-1013–5 FlatFileQuery Classes ............................................................................................................ 13-19

xvi

List of Tables

1–1 Security Access Points ................................................................................................................ 1-41–2 Sample Bundle Names ............................................................................................................ 1-162–1 Oracle Retail Architecture Components.................................................................................. 2-22–2 Point-of-Service Architecture Layers ....................................................................................... 2-42–3 Manager/Technician Framework Components..................................................................... 2-52–4 UI Framework Components...................................................................................................... 2-62–5 Business Object Framework Components............................................................................... 2-82–6 Data Persistence Framework Components ............................................................................. 2-94–1 Parameter Directories, Files, and Descriptions....................................................................... 4-14–2 Validator Types ........................................................................................................................... 4-35–1 Point-of-Service Installation Options ....................................................................................... 5-25–2 Build Path..................................................................................................................................... 5-35–3 Launch Properties ....................................................................................................................... 5-46–1 Common Java Bugs..................................................................................................................... 6-26–2 Naming Conventions ................................................................................................................. 6-46–3 DB2 SQL Code Problems ........................................................................................................... 6-56–4 Oracle SQL Code Problems ....................................................................................................... 6-66–5 Common AntiPatterns ............................................................................................................... 6-87–1 Tour Naming Conventions........................................................................................................ 7-27–2 Log Message Level...................................................................................................................... 7-77–3 Time Stamp Fields ...................................................................................................................... 7-88–1 Required Modules in Dependency Order ............................................................................... 8-29–1 Metaphor Components .............................................................................................................. 9-29–2 Component Identification Strategies ....................................................................................... 9-29–3 System-called Methods ........................................................................................................... 9-129–4 Road Tag Element Attributes................................................................................................. 9-149–5 Forward TourCam Settings .................................................................................................... 9-159–6 Backup Tour Cam Settings ..................................................................................................... 9-159–7 Tender Package Components................................................................................................. 9-1710–1 UI Framework Features .......................................................................................................... 10-110–2 UI Framework Components................................................................................................... 10-210–3 Display Types ........................................................................................................................... 10-210–4 Template Types ........................................................................................................................ 10-310–5 Default Screen Types ............................................................................................................... 10-310–6 PromptAndResponseBean Property Names and Values................................................... 10-510–7 PromptAndResponseModel Important Methods ............................................................... 10-610–8 DataInputBean Property Names and Values....................................................................... 10-710–9 DataInputBeanModel Important Methods .......................................................................... 10-810–10 GlobalNavigationButtonBean Property Names and Values ........................................... 10-1010–11 NavigationButtonBeanModel Important Methods........................................................... 10-1110–12 DialogBeanModel Important Methods............................................................................... 10-1210–13 Dialog Types ........................................................................................................................... 10-1310–14 Button Types........................................................................................................................... 10-1310–15 Field Types and Descriptions............................................................................................... 10-1411–1 Manager/Technician Type Examples................................................................................... 11-211–2 Manager Names and Descriptions ........................................................................................ 11-311–3 ManagerIfc Methods................................................................................................................ 11-411–4 TechnicianIfc Methods ............................................................................................................ 11-511–5 ValetIfc Method........................................................................................................................ 11-611–6 Important ParameterManagerIfc Methods ........................................................................ 11-1111–7 Important POSUIManagerIfc Methods .............................................................................. 11-1311–8 Important JournalManagerIfc Methods.............................................................................. 11-1412–1 CodeListMap Object Classes and Interfaces ........................................................................ 12-5

xvii

12–2 Currency Object Classes and Interfaces................................................................................ 12-712–3 Transaction Object Classes and Interfaces ........................................................................... 12-813–1 Database Tables Used in Credit Card Tender Option........................................................ 13-813–2 FlatFileEngine Query Types ................................................................................................. 13-21A–1 Spring Framework Configuration Options............................................................................ A-2A–2 Point-of-Service Dataset Table ................................................................................................. A-7B–1 Rule 1: Tax Authority Id8888600 ........................................................................................... B-12B–2 Rule 2: Tax Authority Id8888601 ........................................................................................... B-13

xviii

xix

List of Examples

1–1 Changing Transaction ID Length .......................................................................................... 1-124–1 Default Parameter Settings ........................................................................................................ 4-24–2 Definition of Tender Group....................................................................................................... 4-24–3 Parameter Definitions From application.xml ......................................................................... 4-24–4 ActionGroup Configuration...................................................................................................... 4-44–5 Session Configuration ................................................................................................................ 4-44–6 Example of Device Connection ................................................................................................. 4-54–7 ActionGroup in Tour code......................................................................................................... 4-54–8 Simulated Device Configuration .............................................................................................. 4-64–9 JavaHelp—helpscreens.properties .......................................................................................... 4-74–10 JavaHelp—toc.xml ...................................................................................................................... 4-76–1 Header Sample ............................................................................................................................ 6-26–2 SQL Code Before PostgresqlDataFilter Conversion .............................................................. 6-66–3 SQL Code After PostgresqlDataFilter Conversion................................................................. 6-66–4 Wrapping Code in a Code Guard.......................................................................................... 6-106–5 Switching Graphics Contexts via a Logging Level Test..................................................... 6-116–6 JUnit ........................................................................................................................................... 6-126–7 Network Test ........................................................................................................................... 6-146–8 Network Test with Shortened Try Block.............................................................................. 6-156–9 Wrapped Exception ................................................................................................................. 6-156–10 Declaring an Exception ........................................................................................................... 6-156–11 Clean Up First, then Rethrow Exception .............................................................................. 6-166–12 Using a Switch to Execute Code Specific to an Exception ................................................. 6-166–13 Using Multiple Catch Blocks Causes Duplicate Code........................................................ 6-168–1 MBStourmap_CA.xml: Sample initial tourmap file for Canadian locale ........................... 8-38–2 posfoundation.properties: Adding new Tour Maps ............................................................. 8-48–3 tourmap_CA.xml: Replacing one tour script.......................................................................... 8-48–4 tourmap_CA.xml: Replacing a siteaction................................................................................ 8-48–5 tourmap_CA.xml: Replacing a laneaction............................................................................... 8-58–6 tourmap_CA.xml: Replacing or Extending a shuttle............................................................. 8-58–7 MBStender.xml: Tender tour script with customized signal................................................ 8-68–8 tourmap_CA.xml: Replacing a Cargo...................................................................................... 8-78–9 ClientConduit.xml: Conduit script modified to use custom UI configuration file ........... 8-88–10 MBSdefaultuicfg.xml: Customized Default UI Configuration File ..................................... 8-88–11 MBStenderuicfg.xml: Tender UI Configuration with Customized Bean Reference ......... 8-98–12 MBSDefaultDataTechnician.xml: Customizing a Data Operation ................................... 8-138–13 CollapsedConduitFF.xml: Customizing the Data Technician .......................................... 8-138–14 MBSDataTransactionKeys.java: Adding Strings ................................................................ 8-148–15 domain.properties: Sample Modified and New Data Transactions................................. 8-149–1 tender.xml: Definition of Service and Service Region ........................................................... 9-39–2 GetCheckInfoSite.java: Retrieving Cargo from Bus............................................................... 9-39–3 Sample Tourmap......................................................................................................................... 9-59–4 tender.xml: Definition of Cargo................................................................................................ 9-59–5 tourmap.xml: Example of Overriding Cargo Class ............................................................... 9-69–6 tender.xml: Definition of Site Class.......................................................................................... 9-69–7 tender.xml: Mapping of Site to SiteAction .............................................................................. 9-69–8 tourmap.xml: Overriding Siteaction With Tourmap............................................................. 9-69–9 tender.xml: Definition of System Sites..................................................................................... 9-69–10 tender.xml: Definition of Letter ................................................................................................ 9-79–11 tender.xml: Definition of Road Class ....................................................................................... 9-79–12 tourmap.xml: Example of Overriding Site Laneaction.......................................................... 9-89–13 Example of Common Road........................................................................................................ 9-89–14 tender.xml: Definition of Aisle Class ....................................................................................... 9-89–15 tender.xml: Mapping of Aisle to Site ....................................................................................... 9-9

xx

9–16 tourmap.xml: Example of Overriding Aisle Laneaction ....................................................... 9-99–17 tender.xml: Definition of Shuttle Class.................................................................................... 9-99–18 tender.xml: Mapping of Station to Service and Shuttle Classes........................................... 9-99–19 tourmap.xml: Example of Mapping Servicename .............................................................. 9-109–20 tourmap.xml: Example of Overriding Shuttle Name ......................................................... 9-109–21 tender.xml: Definition of Traffic Signal ................................................................................ 9-109–22 tender.xml: Signal Processing With Negate Tag ................................................................. 9-119–23 tender.xml: Definition of tourcam ........................................................................................ 9-139–24 tender.xml: Definition of Road With TourCam Attributes................................................ 9-139–25 GiftReceiptCargo.java: TourCamIfc Implementation......................................................... 9-169–26 Sample Backupshuttle Definition .......................................................................................... 9-1710–1 alterationsuicfg.xml: Overlay Screen Definition ................................................................. 10-410–2 defaultuicfg.xml: Bean Specification Using PromptAndResponseBean ......................... 10-510–3 tenderuicfg.xml: PromptAndResponseBean Property Definition.................................... 10-610–4 tenderText_en_US.properties: PromptAndResponseBean Text Bundle Example......... 10-610–5 GetPurchaseOrderAmountSite.java: Creating and Displaying PromptAndResponseModel.

10-610–6 PurchaseOrderNumberEnteredRoad.java: Retrieving Data From

PromptAndResponseModel 10-710–7 manageruicfg.xml: Bean Specification Using DataInputBean........................................... 10-810–8 managerText_en_US.properties: DataInputBean Text Bundle Example......................... 10-810–9 SelectParamStoreSite.java: Creating and Displaying DataInputBeanModel .................. 10-910–10 StoreParamGroupAisle.java: Retrieving Data from DataInputBeanModel .................... 10-910–11 customeruicfg.xml: Bean Specification Using NavigationButtonBean ......................... 10-1010–12 customerText_en_US.properties: NavigationButtonBean Text Bundle Example ........ 10-1010–13 defaultuicfg.xml: Bean Specification Using GlobalNavigationButtonBean ................. 10-1010–14 tenderuicfg.xml: GlobalNavigationButtonBean Property Definitions........................... 10-1110–15 PricingOptionsSite.java: Creating and Displaying NavigationButtonBeanModel ...... 10-1110–16 commonuicfg.xml: Bean Specification Using DialogBean .............................................. 10-1210–17 InquirySlipPrintAisle.java: DialogBean Label Definition ................................................ 10-1210–18 dialogText_en_US.properties: DialogBean Text Bundle Example ................................. 10-1210–19 LookupStoreCreditSite.java: Creating and Displaying DialogBeanModel ................... 10-1310–20 tender.xml: ClearActionListener XML tag ......................................................................... 10-1510–21 tender.xml: DocumentListener XML tag............................................................................ 10-1510–22 tender.xml: ValidateActionListener XML tag.................................................................... 10-1610–23 tenderuicfg.xml: ValidateActionListener Required Fields .............................................. 10-1610–24 BundleConstantsIfc.java: String Constant for receiptText............................................... 10-1610–25 GiftCardInquirySlip.java: Tour Code to Print Receipt ..................................................... 10-1710–26 receiptText_en_US.properties: Text Bundle....................................................................... 10-1710–27 parameteruicfg.xml: Overlay Specification Using parameterText ................................. 10-1710–28 GiftCardUtility.java: Tour Code to Retrieve Parameter................................................... 10-1710–29 parameterText_en_US.properties: Text Bundle ................................................................ 10-1810–30 application.xml: Definition of Parameter ........................................................................... 10-1811–1 CollapsedConduitFF.xml: Data Manager Configuration................................................... 11-511–2 CollapsedConduitFF.xml: Tax Technician Configuration ................................................. 11-611–3 ParameterManager.java: Valet Passed By Manager ........................................................... 11-611–4 Sample Manager and Technician Configuration ................................................................ 11-711–5 Sample Manager in Tour Code .............................................................................................. 11-711–6 Sample Manager Class ............................................................................................................ 11-811–7 Sample Valet Class................................................................................................................... 11-911–8 Sample Technician Class....................................................................................................... 11-1011–9 ClientConduit.xml: Code to Configure Parameter Manager .......................................... 11-1111–10 ClientConduit.xml: Code to Configure Parameter Technician ....................................... 11-1111–11 BrowserControlSite.java: Tour Code Using ParameterManagerIfc ............................... 11-1211–12 ClientConduit.xml: Code to Configure UI Manager ........................................................ 11-12

xxi

11–13 ClientConduit.xml: Code to Configure UI Technician..................................................... 11-1211–14 GetCheckInfoSite.java: Tour Code Using POSUIManagerIfc ......................................... 11-1311–15 CollapsedConduitFF.xml: Code to Configure Journal Manager .................................... 11-1411–16 CollapsedConduitFF.xml: Code to Configure Journal Technician................................. 11-1411–17 GetCheckInfoSite.java: Tour Code Using JournalManagerIfc ........................................ 11-1412–1 TenderPurchaseOrderIfc.java: Class Header....................................................................... 12-212–2 TenderPurchaseOrder.java: Class Header ........................................................................... 12-212–3 DomainObjectFactoryIfc.java: Method For Instantiating TenderPurchaseOrder .......... 12-312–4 DomainObjectFactory.java: Method For Instantiating TenderPurchaseOrder............... 12-312–5 GetCheckInfoSite.java: Instantiating Check from DomainObjectFactory ....................... 12-412–6 GetCheckInfoSite.java: Setting Attributes of Check ........................................................... 12-412–7 ItemInfoEnteredAisle.java: CodeListIfc in Tour Code ....................................................... 12-612–8 PurchaseOrderAmountEnteredAisle.java: CurrencyIfc in Tour Code ............................ 12-812–9 JdbcSaveTenderLineItems.java: SaleReturnTransactionIfc in Tour Code....................... 12-913–1 CreateTableCreditDebitCardTenderLineItem.sql............................................................... 13-513–2 InsertTableTenderLineItem.sql.............................................................................................. 13-613–3 String Constant in ARTSDatabaseIfc.java ............................................................................ 13-613–4 mysql_builddb.bat: Changes to Implement Foreign Key Checking ................................ 13-713–5 ValidCreditInfoEnteredRoad.java: Transaction Object...................................................... 13-813–6 SaveRetailTransactionAisle.java: Save Transaction............................................................ 13-813–7 UtilityManager.java: Save Data Transaction...................................................................... 13-1113–8 TransactionWriteDataTransaction.java: Save Transaction .............................................. 13-1113–9 DefaultDataTechnician.xml: Define Data Transaction Class .......................................... 13-1113–10 TransactionWriteDataTransaction: DataAction ................................................................ 13-1213–11 SaveTenderLineItemsAction: Set Data Operation Name................................................. 13-1213–12 DefaultDataTechnician.xml: Define Data Operation Class ............................................. 13-1313–13 JdbcSaveTenderLineItems: Saving Tender Line Item ...................................................... 13-1313–14 JdbcSaveTenderLineItems.java: SQL Factory Methods ................................................... 13-1413–15 PosLFFDataTechnician.xml: Sample Data Technician Script for Flat Files................... 13-1613–16 FFTableDefs.xml: Sample FlatFileEngine Configuration File ......................................... 13-1713–17 Item Retrieve Sample Code .................................................................................................. 13-20A–1 Adding Table Assiociation To Employee Dataset .............................................................. A-10A–2 Adding New DataSet .............................................................................................................. A-13A–3 Adding Table association to New DataSet........................................................................... A-14A–4 DataSetProducer Code ............................................................................................................ A-14A–5 DataSetConsumer Code.......................................................................................................... A-15

xxii

xxiii

Preface

Oracle Retail Operations Guides contain the requirements and procedures that are necessary for the retailer to configure Point-of-Service, and extend code for a Point-of-Service implementation.

AudienceThe audience for this document is developers who develop code for Oracle Retail Point-of-Service. Knowledge of the following techniques is required:

■ Java Programming Language

■ Object-Oriented Design Methodology (OOD)

■ Extensible Markup Language (XML)

Related DocumentsFor more information, see the following documents in the Oracle Retail Point-of-Service Release 12.0 documentation set:

■ Oracle Retail Point-of-Service Release Notes

■ Oracle Retail Point-of-Service Installation Guide

■ Oracle Retail Point-of-Service User Guide

Customer Support■ https://metalink.oracle.com

When contacting Customer Support, please provide:

■ Product version and program/module name

■ Functional and technical description of the problem (include business impact)

■ Detailed step-by-step instructions to recreate

■ Exact error message received

■ Screen shots of each step you take

https://metalink.oracle.com/

xxiv

Review Patch DocumentationFor a base release (".0" release, such as 12.0), Oracle Retail strongly recommends that you read all patch documentation before you begin installation procedures. Patch documentation can contain critical information related to the base release, based on new information and code changes that have been made since the base release.

Oracle Retail Documentation on the Oracle Technology NetworkIn addition to being packaged with each product release (on the base or patch level), all Oracle Retail documentation is available on the following Web site:

http://www.oracle.com/technology/documentation/oracle_retail.html

Documentation should be available on this Web site within a month after a product release. Note that documentation is always available with the packaged code on the release date.

ConventionsThe following text conventions are used in this document:

Convention Meaning

boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

http://www.oracle.com/technology/documentation/oracle_retail.htmlhttp://www.oracle.com/technology/documentation/oracle_retail.htmlhttp://www.oracle.com/technology/documentation/oracle_retail.html

Backend System Administration and Configuration 1-