Top Banner
Upgrade Guide SAP ® Point of Sale 2.0 SAP Transactionware GM 10.0 Target Audience System administrators Technology consultants Document version: 1.01 October 2008 PUBLIC
47

SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Jan 19, 2023

Download

Documents

Khang Minh
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

SAP® Point of Sale 2.0

SAP TransactionwareGM 10.0Target Audience

System administrators

Technology consultants

Document version: 1.01 October 2008

PUBLIC

Page 2: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

© Copyright 2008 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in anyform or for any purpose without the express permission of SAP AG.The information contained herein may be changed without priornotice.

Some software products marketed by SAP AG and its distributorscontain proprietary software components of other software vendors.

Microsoft, Windows, Outlook, and PowerPoint are registeredtrademarks of Microsoft Corporation.IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex,MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400, iSeries, pSeries,xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity,Tivoli, Informix, i5/OS, POWER, POWER5, OpenPower andPowerPC are trademarks or registered trademarks of IBM Corporation.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are eithertrademarks or registered trademarks of Adobe Systems Incorporated inthe United States and/or other countries.Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of theOpen Group.Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame,VideoFrame, and MultiWin are trademarks or registered trademarks ofCitrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registeredtrademarks of W3C®, World Wide Web Consortium, MassachusettsInstitute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., usedunder license for technology invented and implemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, andother SAP products and services mentioned herein as well as theirrespective logos are trademarks or registered trademarks of SAP AGin Germany and in several other countries all over the world. All otherproduct and service names mentioned are the trademarks of theirrespective companies. Data contained in this document servesinformational purposes only. National product specifications mayvary.

These materials are subject to change without notice. These materialsare provided by SAP AG and its affiliated companies ("SAP Group")for informational purposes only, without representation or warranty ofany kind, and SAP Group shall not be liable for errors or omissionswith respect to the materials. The only warranties for SAP Groupproducts and services are those that are set forth in the expresswarranty statements accompanying such products and services, if any.Nothing herein should be construed as constituting an additionalwarranty.

DisclaimerSome components of this product are based on Java™. Any codechange in these components may cause unpredictable and severemalfunctions and is therefore expressively prohibited, as is anydecompilation of these components.

Any Java™ Source Code delivered with this product is only to be usedby SAP’s Support Services and may not be modified or altered in anyway.

Documentation in the SAP Service MarketplaceYou can find this documentation at the following address:http://service.sap.com/<xxxxxxxx>

SAP AGDietmar-Hopp-Allee 1669190 WalldorfGermanyT +49/18 05/34 34 24F +49/18 05/34 34 20www.sap.com

Page 3: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Typographic Conventions

Type Style Description

Example Text Words or characters quotedfrom the screen. These includefield names, screen titles,pushbuttons labels, menunames, menu paths, and menuoptions.

Cross-references to otherdocumentation

Example text Emphasized words or phrasesin body text, graphic titles, andtable titles

EXAMPLE TEXT Technical names of systemobjects. These include reportnames, program names,transaction codes, tablenames, and key concepts of aprogramming language whenthey are surrounded by bodytext, for example, SELECT andINCLUDE.

Example text Output on the screen. Thisincludes file and directorynames and their paths,messages, names of variablesand parameters, source text,and names of installation,upgrade and database tools.

Example text Exact user entry. These arewords or characters that youenter in the system exactly asthey appear in thedocumentation.

<Exampletext>

Variable user entry. Anglebrackets indicate that youreplace these words andcharacters with appropriateentries to make entries in thesystem.

EXAMPLE TEXT Keys on the keyboard, forexample, F2 or ENTER.

Icons

Icon Meaning

Caution

Example

Note

Recommendation

Syntax

Additional icons are used in SAPLibrary documentation to help youidentify different types of information ata glance. For more information, seeHelp on Help General InformationClasses and Information Classes forBusiness Information Warehouse onthe first page of any version of SAPLibrary.

Page 4: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

4 October 2008

Contents1 Introduction .........................................................................................5

1.1 About this Document............................................................................. 51.2 New Features.......................................................................................... 61.3 Document History .................................................................................. 7

3 Upgrade Process.................................................................................74 Upgrading from Sybase 5.0 to 9.0 ...................................................105 Connecting to a Sybase ASA 9.0 Database....................................156 Unattended Upgrade.........................................................................17

6.1 General Information about the unattended upgrade......................... 176.2 Unattended Upgrade Framework overview........................................ 186.3 The Unattended Upgrade Process...................................................... 226.4 The upgrade application batch file ..................................................... 256.5 Appendix A ........................................................................................... 44

Page 5: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 5

1 IntroductionThis section provides introductory information you need know before you begin upgradingSAP POS.

1.1 About this DocumentPurposeThis guide provides step-by-step instruction for installing SAP POS. It also includesprerequisite and post-installation steps required to successfully install the application. It isintend for SAP or SAP-approved system administrators and technology consultants.

SAP POS is the leading transaction-management and point-of-sale solution for generalmerchandise retailers including specialty, mass merchandise, discount and departmentstores.

The SAP POS product suite consists of the following components:

Point of Sale Xpress

Store Manager

The Configurator

Point of Sale XpressAn advanced point-of-sale transaction processing application, Point of Sale Xpress provideslow- to high-volume capabilities. Point of Sale Xpress is a front-end processing applicationthat scales to your growing business and evolves to encompass changing technology.

Store ManagerStore Manager is the in-store administrative or ‘back office’ information managementcomponent of the SAP POS. It provides in-store and back-office functions such as reporting,payroll entry, file maintenance, cash management, and inventory control.

Store Manager is available at three licensing levels, to fit your company's businessrequirements.

Level 1: POS Manager

Allows POS administrative tasks, such as cash management, to be expedited at the storelevel

Single or multiple terminals can be monitored to facilitate training

Flexible report generation allows retailers to determine which reports they wish to generate

Journal viewer allows read-only access to all register journals in the store, for securitypurposes

Security levels can be set to limit access based on position or level of authority

Level 2: Store Manager with Inventory Management

This option offers all the functions of Level 1, plus:

Vendor information and SKU maintenance for receiving, transfers, purchase orders andphysical counts

Level 3: Store Manager Deluxe with Perpetual Inventory Control

This option offers all the functions of Level 2, plus:

Page 6: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

6 October 2008

An inventory component that can handle on-hand quantities and suggested re-order forperpetual inventory control on all or selected items

The ConfiguratorThe Configurator is a key component in the SAP POS. A powerful parameter definition tool,the Configurator allows your regional and head office personnel to tailor your Point of SaleXpress terminals to your retail business needs through a simple user interface. With thisinterface, you can control all of your POS terminal functions and processes by manipulatingtheir settings in a series of detailed data tables. These data tables contain parameterdefinitions for such core functions as your tender and transaction types, tax settings,promotions, keyboard layouts, terminal menus, cashier prompts, customer records, and muchmore.

From the Configurator, the parameters you define are transferred or converted over to yourPoint of Sale Xpress terminals during regular system polling—and only those parameter fileswhich have been changed are converted, reducing unnecessary drain on system resources.This conversion and update process can be performed as often as required to ensure that allterminals in all stores contain the same information. Many of the parameters in theConfigurator need to be set only once, or very infrequently, to reflect core aspects of yourbusiness model (for example, the tender types your company uses, or your terminal displaysettings). Other parameters, such as price lookup (PLU) definitions and promotion settingscan be modified more frequently for maximum system flexibility.

IntegrationIntegration with Allegiance™ CRM systems allows for powerful customer loyalty programs

1.2 New FeaturesThe following are the new features added to SAP POS, version 10.0.

Area Description

Removal ofretireddatabasesupport

SAP POS has used Sybase SQL Anywhere DBMS since the inceptionof the Windows based Point of Sale. The current Sybase version usedby SAP POS has been retired and has been replaced and by a newerversion. In this release, we have removed the retired databases fromthe available DBMS solutions

Addition ofnew supporteddatabases

Add support for Microsoft SQL Server 2005 + Standard, Workgroup andExpress Editions: To stay in-line with current technology and SAP’s ownProduct Standards Roadmap, we would like to update the availabledatabase selections to include Microsoft SQL Server 2005 StandardEdition, Workgroup Edition and Express Edition.

UpdateInstallationInfrastructure& Process

Updated to newer version of InstallShield. This reflects the new SAPbranding and also makes the installation simpler and more robust byusing of MSI (Microsoft Installer).

Page 7: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 7

Application Old Path New Path

Express Server(XPS)

c:\xps\xps.exe C:\program files\sap\retailsystems\XpressServer\xps.exe

Electronic Journal c:\program files\elv C:\program files\sap\retailsystems\Sales JournalViewer

Point of Sale Xpress c:\program files\poswin\ C:\program files\sap\retailsystems\point of sale\

Store Configurator c:\programfiles\configurator\configurator.exe

C:\program files\sap\retailsystems\StoreConfigurator\configurator.exe

Databases c:\Program Files\triversitydatabases

C:\Program Files\sap\retailsystems\databases

SAP POSapplicationinstallationpaths havechanged forprior versions.

dbtools c:\program files\trimax utils\dbtools C:\Program Files\sap\retailsystems\dbtools

1.3 Document HistoryThe following table provides an overview about the most important document changes.

Version Date Description

1.00 May 2007 First version – no changes

1.01 October 2008 Added revised Unattended Upgrade chapter for SP03

3 Upgrade Process3.1 Before beginning the upgrade installationAn upgrade should be performed after all the registers are closed and the End-Of-Dayprocess is complete. Before you begin the upgrade procedure, you must do the following:

Backup all existing SAP POS application data and database information.

Exit the Configurator application.

Exit the Database Tools application.

Exit all registers. To do this run manager code 499.

Re-boot all registers but ensure that the SAP POS application is not running.

Exit all Point of Sale Manager or Store Manager applications.

Exit any Electronic Journal applications.

Ensure that the Point of Sale Server application is stopped. To stop the Point of SaleServer, use the operating system Services application. Select the Point of Sale Serverapplication in the list of services and select the Stop option.

Page 8: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

8 October 2008

Ensure that the database engine for the back office and/or the journal database isrunning. This allows for the automatic upgrade of the back office and journaldatabases when the Point of Sale Server and Electronic Journal upgrade is installed.

Ensure that any SAP product entries that previously used the Sybase 9 engine areremoved from the system registry.

After the Xpress Server, Xpress Server database and the Configurator are installed,you must re-boot the PC’s and place all the parameter files exported by theConfigurator application in the following directory: \Program Files\SAP\RetailSystems\Xpress Server\Parm. This is required for a new installation, a re-installationor an upgrade on the Xpress Server.

3.2 Performing the upgrade installationFor each PC, you must upgrade all of the components that were previously installed on themachine.

To perform the upgrade installation:

1. Insert the SAP POS suite Installation CD.The installation software scans your system for previous versions of the software and anyexisting databases.

2. Based on the scan, the following happens:

o If you are upgrading from POS 8.0 or 9.5 to POS 10.0, the UpgradeWelcome screen appears. To begin the upgrade process, choose Upgrade.

o If you are installing patch for POS 10.0, the Program Maintenance screenappears. Choose the Upgrade/Repair option and then choose Next.

o If you are upgrading from any version prior to POS 9.5, you will be prompt tocontact SAP support. This process does not support upgrading POS versionsprior to POS 8.0.

3. Follow the prompts as they appear. For detailed installation information, see the SAPPOS 10.0 Installation Guide.

Page 9: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 9

3.3 Performing the upgrade installation for theMobile POSFor each PC, you must upgrade all of the components that were previously installed on themachine. This process does not support upgrading POS versions prior to POS 8.0.

To perform the upgrade installation:

1. Insert the SAP POS suite Installation CD.The installation software scans your system for previous versions of the software and anyexisting databases.

2. Based on the scan, the following happens:

If you are upgrading from version POS 8.0 or 9.5 to POS 10.0, the InstallShieldWelcome screen appears. To begin the upgrade process, choose Next. TheInstallShield Program Maintenance screen appears.

Choose one of the maintenance activities:

o Upgrade/Repair- This option upgrades or repairs your existing version of theMobile Point of Sale application. Choose this option if you are installing apatch for POS 10.0 and then choose Next.

o Remove- This option removes the Mobile Point of Sale application from yoursystem, if required.

Choose Install.

Follow the prompts as they appear. For detailed installation information, see the SAP POS10.0 Installation Guide.

3.4 Upgrading the databasesThe Database Tools application provides the SQL scripts required to upgrade the databases.This application must be installed before the Configurator, Express Server or ElectronicJournal applications are upgraded because they will automatically upgrade the defaultconfigurator database (poscfgw.db), the back office database and the journal database usingthe SQL scripts which the Database Tools application provides.

3.5 Upgrading custom Configurator databasesCustom Configurator databases are not automatically upgraded through the upgradeinstallation of the Configurator component. These databases must be upgraded manuallyusing the Upgrade function in the Database Tools application. Additionally, any database(Point Of Sale Server, Journal and Configurator databases) can be manually upgradedthrough this function if required.

Page 10: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

10 October 2008

4 Upgrading from Sybase 5.0 to 9.0Sybase SQL Anywhere 5 database management system will no longer be supported for usewith SAP applications and databases. Hence all Sybase SQL Anywhere 5 ODBC entriesinstalled by SAP must replaced with corresponding Sybase 9 ODBC entries. (The onlyexception to this is the Sybase SQL Anywhere 5 database server. Instead of being removed,it will be disabled.) As well, any third party applications which rely on the Sybase SQLAnywhere 5 ODBC settings or registry entries installed by SAP will also need to be upgradedto use Sybase 9.

This section discusses the process which upgrades the Sybase SQL Anywhere databaseversion 5 to Sybase SQL Anywhere version 9.

OverviewThe upgrade process is launched through a command line utility that upgrades the databasemanagement system used by SAP applications from Sybase SQL Anywhere 5 to Sybase 9.The upgrade utility is called syb5to9.exe. This utility is a command line executable whichuses parameters to implement the required functionality. The following table showsparameters for syb5to9.exe along with the options available for the parameter.

Parameter Options

/0 Type of operation to perform

UPG Upgrade either a database or an application to Sybase 9

RST Restore either a database or an application to Sybase 9

/A Identifier of application to upgrade to Sybase 9

CFG Configurator

XPS Xpress Server

SMG Store Manager

EJV Electronic Journal Viewer

DBT Database Tools

/D Name of database to upgrade to Sybase 9

BACKOFF Xpress Server database

JOURNAL Electronic Journal Viewer database

POSCFGW Configurator databaseNote: To upgrade a user-defined Configurator database, provide thename of the database excluding the ‘.db’ file extension.

USERDB Configurator database

/S Optional parameter that will silence error messages.Syntax for an application:syb5to9.exe /O <operation> /A <application> /S.Syntax for a database:syb5to9.exe /O <operation> /D <database> /S

The upgrade utility is designed to return an error code to the calling program via errorlevelenvironment variables. A return code of ‘0’ (zero) denotes success. A return code of ‘1’ (one)denotes failure.

Page 11: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 11

The upgrade utility generates a status file in the directory where the upgrade utility is beingexecuted upon completion of an operation to a SAP component. The file extension denotesthe success or failure. Hence a file extension of ‘.0’ (zero) is a success. A file extension of ‘.1’(one) is a failure.

Each of the SAP components (5 applications, 3 databases) have their own unique filenaming convention for the status file:

XPD.? Xpress Server database

EJD.? Electronic Journal database

CFG.? Configurator

CFD.? Configurator database

SMG.? Store Manager

EJV.? Electronic Journal Viewer

XPS.? Xpress Server

DBT.? Database Tools

In the case of a restore operation, if a failure status file for a given componentalready exists (assuming it was generated by an upgrade failure) it will not bereset after a restore operation is successfully completed. The reason for thisis so the status of each individual component can be used to compile theoverall status of the upgrade session. (Refer to the section on Batch FileSession.)

Error MessagesAn ASCII text error file will be generated in the same directory where the utility is executed. Itis called syb5to9.err. This file contains a time-stamped list of any error message(s) producedby the utility This aids in determining the nature of any problems that may arise during normalprogram execution. Each error message is comprised of an internal numeric classificationand message text.

The optional command line parameter ‘/S’ can be used to silence the default message boxwhich displays the error message text.

Batch File SessionAn upgrade session represents the upgrading of multiple SAP components at one time.Batch file syb5to9.bat was designed to do so. This batch file contains all the necessary callsto upgrade each of the required database components and applications. It is designed toanalyze the status file produced by each component as it is upgraded. If a failure occurs, thedefault action to restore those components that have been upgraded during the currentsession is undertaken.

The batch file generates a status file syb5to9.? for the current upgrade session. The fileextension of ‘.ok’ denotes success. A ‘.bad’ file extension denotes failure. This allows otherapplications to take action based on the results of an upgrade session. A log file syb5to9.logis also generated by the batch file. It contains the time stamp status of each component as itis upgraded and/or restored.

Page 12: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

12 October 2008

At the start of an upgrade session, any previously generated status files (such as *.0, *.1 and*.bad) are removed to prevent interference with the current upgrade session. The syb5to9.okstatus file prevents any subsequent executions of the upgrade batch file. This assumes that ifthis file exists in the same directory where the upgrade is being executed, the SAPapplications have been successfully upgraded to use Sybase 9 database managementsystem.

The user can control which SAP components need to be upgraded through a ‘rem’ of the callto upgrade a component. Refer to the section: SYBASE5_TO_SYBASE9_UPGRADE in thebatch file syb5to9.bat for further explanation.

The batch file will need to be modified to upgrade or restore any user-definedConfigurator databases. Only the default components are addressed in thesyb5to9.bat batch file.

Backup FilesThe upgrade utility is designed to backup the Sybase SQL Anywhere 5 databases and logfiles prior to performing an upgrade. In the case of a failure during the process, these backupfiles will be used to restore the database and log files. The BACKOFF.DB (Xpress Serverdatabase) and JOURNAL.DB (Electronic Journal Viewer) will be backed up to the backupsub-directory located under the directory where the databases are installed. For instance:‘\Program Files\sap\retail systems\databases\Backup’. The Configurator databases arebacked up to the backup sub-directory located under the directory where the Configurator isinstalled.

The backup files will use the following naming conventions:

<DATABASE>.S5L Official backup copy of Sybase SQL Anywhere 5 log file

<DATABASE>.S5D Official backup copy of Sybase SQL Anywhere 5 database

<DATABASE>.S5C Temporary copy of compressed database file. Once the database issuccessfully compressed, this file is renamed to <DATABASE>.S5D).

A special backup file will be placed in the same backup directory where the Xpress Serverand Electronic Journal Viewer database backup files reside. This is an ASCII text file calledSTARTUP.S5P which contains the database server parameters extracted from the SybaseSQL Anywhere 5 database server. The Sybase 9 database server will be configured with theminimum amount of parameters necessary to start the database server. Any customizedserver parameters will need to be extracted from the parameter backup file and used tomanually configure the Sybase 9 database server after the upgrade is successfullycompleted.

Page 13: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 13

RequirementsThe following are requirements to successfully run the upgrade process:

A working version of Sybase 9 must be installed on the same machine where the SAPapplications have been installed. The upgrade utility is designed to unload a SybaseSQL Anywhere 5 database and use the output to reload a Sybase 9 database. (Areload sub-directory will be created under the directory where the utility is beingexecuted. The contents of the sub-directory will contain the output from the databaseunload. The reload sub-directory will be recreated each time the upgrade utility isconfigured to upgrade a database).

The SAP databases must be upgraded to the SAP software release that supportsSybase 9. (To accomplish this, upgrade Database Tools and then upgrade thedatabases prior to performing the upgrade to Sybase 9.)

There must be sufficient disk space available to maintain backup copies of the SybaseSQL Anywhere 5 databases and log files, in addition to the output from the unloadeddatabase. As a rule of thumb, there should be at least the equivalent to five times thesize of the largest database to be upgraded of disk space.

After the upgrade process is completed, the machine must be rebooted in order forthe Sybase 9 database server service registry entries to take effect.

RestrictionsThe upgrade process is limited by the following restrictions:

The upgrade utility is designed only to upgrade or restore a database or anapplication. The database management utilities used by the upgrade utility are notprovided.

There can only be one session of the upgrade utility running at a time. This is becausethe name of the engine used to the connect to the Sybase SQL Anywhere 5 databaseand the Sybase 9 database will be the name assigned to the database server.

One DOS session of the upgrade batch file can upgrade all databases and allapplications provided that there are no existing registry entries for any SAP productcomponents using Sybase version 9. Should the upgrade machine contain anyinstalled components using the Sybase 9 engine, these components must be cleanedfrom the machine before it is used for the upgrade from Sybase SQL Anywhere 5 to 9.

All SAP applications must be shut down prior to running the upgrade utility. There areno provisions within the upgrade process to stop the Xpress Server or end the StoreManager, Electronic Journal Viewer/Processor, Database Tools or Configuratorapplications. These applications all connect to the database which will be upgraded.The database should be free of connects prior to upgrading to Sybase 9. The upgradeutility will shut down the database server prior to upgrading a specified database.

User-defined Configurator databases that are being upgraded to Sybase 9 must havebeen generated by the Configurator application that is currently installed. There arerequired registry entries generated by the Configurator application referring to theuser-defined database that need to be configured for Sybase 9. The utility will notupgrade a database that was produced through a Configurator application installed onanother machine. (A possible solution for upgrading customized databases andgetting registry entries created for them is to rename the customized databases toPOSCFGW before beginning the upgrade process.)

Page 14: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

14 October 2008

After a database is upgraded to Sybase 9, all applications that attach to the databasemust also be upgraded. The upgrade of an application to Sybase 9 results in alteredregistry entries and ODBC settings required to connect it to the Sybase 9 database. Ifthis process is not followed, the applications related to the upgraded database will failto attach to the database. Note that the same is true when an application is upgradedto Sybase 9, but not the database. The application will again not connect to thedatabase.

To upgrade SAP applications and databases to Sybase 9:

1. Copy the batch file syb5to9.bat and associated executables syb5to9.exe, sybase5.dll andsybase9.dll to a user-defined directory. Ensure that any file or directory names youassign adhere to DOS naming conventions. For instance, the directory name should notcontain any spaces.

2. Configure the batch file to update applications and databases currently installed on themachine where the batch file is being run. Refer to the sectionSYBASE5_TO_SYBASE9_UPGRADE in the batch file syb5to9.bat for further explanationon how to customize the upgrade. To avoid naming convention conflicts between theexecutable and the batch file, launch the batch file from the command line as follows:

syb5to9.bat

You can customize the default batch file provided or write your own batch file process toperform the upgrade as long as you adhere to the conditions and restrictions outlinedabove.

Progress DisplayThe utility is designed to display the progress at each phase of an upgrade or restore. Thetime is incremented in seconds, minutes and hours up to a maximum of 99 hours, 59 minutesand 59 seconds. This provides confirmation that an upgrade or restore is currently inprogress.

DisclaimerThis utility is developed to upgrade SAP applications and databases to support a Sybase 9database management system. It is intended that this utility will not be retained once theupgrade to Sybase 9 is successfully completed and assumed that there should be no reasonto revert back to the previous version Sybase SQL Anywhere 5. The restoration process wasimplemented to allow a store to return an operational state should a failure occur during theupgrade process. During a restoration, databases and log files that were backed up will beused to overwrite the active databases and log files. Should a rollback to the previous SybaseSQL Anywhere version be undertaken once the upgrade process is carried out, all dataentered into the system after the upgrade to Sybase 9 will be lost. The upgrade utilitysyb5to9.exe is not designed to support toggling back and forth between databasemanagement system versions.

Page 15: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 15

5 Connecting to a Sybase ASA 9.0DatabaseTo use Sybase ASA 9.0, you need to set up the SAP POS application to connect to thedatabase and upgrade your database(s) to Sybase ASA 9.0. For assistance and informationon the upgrade process, please contact your SAP representative.

If you are using an OEM version of Sybase 9.0 you may see authenticationerrors when attempting to install. This situation has not been detected in anon-OEM version of Sybase9.0.

To set up SAP POS application to connect to a Sybase ASA 9.0 database:

1. Install Sybase ASA 9.0 on machine(s) where a SAP POS application will connect to aSybase 9 database.

2. Install the SAP POS application to use a Sybase ASA 9.0 database.

3. Installing a Sybase ASA 9.0 database management system

To install the database management system:

Make sure you install the Windows 32 bit English Version of SQL Anywhere Studio 9.0.2

If you are using an OEM version of Sybase 9.0 you may see authentication errors whenattempting to install. This situation has not been detected in a non-OEM version ofSybase9.0.

1. Run the install shield from the Sybase SQL Anywhere Studio 9.0.2 CD.

2. Click Next on the Welcome window.

3. Accept the licence agreement, and then click Next.

4. Type the registration key, and then click Next.

5. Select the database driver the Configurator will use.

This should be the driver for the database you are installing.

6. Do one of the following:

Click Next to accept the default location to install Sybase ASA 9.0

Click Browse, navigate to the a preferred location to install Sybase ASA 9.0, and thenclick Next.

7. Do one of the following:

Click Next to accept the default location to install Sybase ASA 9.0 shared components

Click Browse, navigate to the a preferred location to install Sybase ASA 9.0 sharedcomponents, and then click Next.

8. Select the shared components you want to install.

Databases

o Adaptive Server Anywhere

o UltraLite

Page 16: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

16 October 2008

Synchronization And Messaging

o MobiLink

o QAnywhere

o SQL Remote for Adaptive Server Anywhere

Tools

o Sybase Central

o jConnect

o Documentation

o Samples

o PowerDesigner 9

o InfoMaker 9

9. Type the server licence information, and then click Next.

Use the following table to specify the information:

Name Your name

Company Your company’s name

Licensed units 1

License type Networked Seat (per-seat) model

10. Select a folder for the program’s icon, and then click Next.

11. Click Next to start copying the installation files.

12. Select the documentation components you want to install, and then click Next.

English Online Documentation (HTML)

English Printable Books (PDF)

13. Click Next to start copying the documentation files.

14. Click Install to confirm launching of external installations.

The preceding step confirms you are installing Sybase 9 Power Designer andSybase 9 Info Maker as separate, external installations launched from theSybase 9 installation.

15. Click Next on the Welcome to Sybase 9 Power Designer installation window.

16. Select Stand-alone as the type of Sybase 9 Power Designer installation.

17. Do one of the following:

Click Next to accept the default location to install Power Designer

Click Browse, navigate to the a preferred location to install Power Designer, and thenclick Next.

18. Select the Power Designer components you want to install, and then click Next.

Products

o Physical Data

o PDF Documentation

Page 17: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 17

Components

o Program

o Examples

o DB Definition Files

o Report Templates

o Online Help

19. Select a folder for Power Designer’s icon, and then click Next.

20. Click Next to start copying the Power Designer installation files.

21. Click Finish to complete installing Power Designer.

22. Do one of the following:

Click Next to accept the default location to install Info Maker

Click Browse, navigate to the a preferred location to install Info Maker, and then clickNext.

23. Do one of the following:

Click Next to accept the default location to install Info Maker shared files

Click Browse, navigate to the a preferred location to install Info Maker shared files,and then click Next.

24. Select Typical as the type of Info Maker setup.

25. Select a folder for Info Maker’s icon, and then click Next.

26. Click Next to start copying the Info Maker files.

27. Click Finish to complete installing Info Maker.

28. Optionally select to view the “ReadMe” file and “iAnywhere Online Resources”.

29. Click Finish again to complete installing Sybase ASA 9.

30. Reboot your computer.

6 Unattended Upgrade6.1 General Information about the unattendedupgradeThe unattended upgrade framework (UUF) runs in the background as GMClient andGMServer Windows services. These services make it possible to use an automated processto upgrade the POS applications. This automated process performs the following functions:

Unattended upgrades from an installation CD or hard drive. Replace specific application files

The GMClient service is present on each client system, such as the POS terminals, and isalso present on the Xpress Server system.

The GMServer is installed on the Xpress Server system, and services requests from thevarious GMClients. The GMClient application is designed to allow a single client executableto support multiple application upgrades on the same system.

Page 18: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

18 October 2008

The GMServer service listens for running GMClients and waits for a trigger file as a signal tostart servicing the clients. When the trigger file appears, the GMServer copies the necessaryupgrade (MSI installer) files to the GMClient. The GMClient then executes the installer toupgrade the POS application.

The MSI installers for the SAP POS Suite use a user-defined configuration file, upgrade.ini,to hold responses to the MSI installer dialog prompts. This allows an upgrade to executewithout user intervention.

A distinct section within upgrade.ini is present for each installation type, such as Point OfSale, Xpress Server, Store Manager, or Electronic Journal Viewer. These sections specifythe parameters for that installation type. Although the MSI installers provide the capability torecord and play back an installation silently, this enhancement allows this process to besimplified by pre-defining responses to the MSI installer dialogs. Other configuration filesdiscussed later in this document control the Unattended Upgrade framework, and therebydictate how the upgrade will proceed.

The target POS applications for unattended upgrades are:

Point of Sale

DBTools

Xpress Server

Electronic Journal Viewer

Store manager

Mobile Point of Sale

Store Configurator is installed at the head office, and is not included in the unattendedupgrade process.

The unattended upgrade does not use the MSI packages used to install the applicationdatabases. These databases are installed initially at the stores, and DBTools is used duringsubsequent upgrades to keep the database structures up to date.

6.2 Unattended Upgrade Framework overviewPackagesThe UUF files are distributed in packages in a separate download. These packages arerequired to deploy the Unattended Upgrade Framework to the server and secondary POSterminals.

Server PackageThe server package is installed on the Xpress Server system and contains the GMClient andGMServer Windows services.

Files included in the server package:

Serverdeploy.bat

Deploys the UUF server component.

Server.cab

Contains the necessary applications, batch and configuration files the UUFserver application uses.

Page 19: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 19

Clientserver.cab

Contains the necessary applications, batch and configuration files the UUFclient application uses.

Tools.cab

Contains utility programs the UUF applications use.

Client PackageThe client package is installed on the POS terminals

Files included in the client package:

Go.bat

Deploys the UUF client component on POS Terminals.

Updsec.cab

Contains the necessary applications and configuration files the UUF clientapplication uses.

Unattended Upgrade Framework Deployment

The following is a recommended deployment that involves running thedeployment batch files SAP supplies. Of course, you may use a differentmethod to deploy the framework. However, you must ensure the batch filesexecute properly.

We recommend that you test all deployments and file customizations beforerolling out the UUF to stores.

Before deploying the UUF to stores, you must change the configuration of theserver and the POS terminals.

Server configurationThe following example shows how to configure the server to enable hooks required to installthe framework on the server. To do this, you must modify the end of day procedure. The endof day procedure is typically a batch file called EODPROC.BAT. This batch file is found in theXpress Server directory, which by default it is installed in C:\Program Files\SAP\RetailSystems\Xpress Server.

Sample section of EODPROC.BAT:

:UPDATES

rem **** perform any updates

if exist C:\Program Files\SAP\Retail Systems\xpress server\dnload\update.trg start C:\ProgramFiles\SAP\Retail Systems\xpress server\dnload\serverdeploy.bat

:UPGCHK

console /server /status

move \gmserver\status.log c:\Program Files\SAP\Retail Systems\xpress server\upload\keep1

Page 20: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

20 October 2008

The preceding example employs a “trigger” file, and serverdeploy.bat is runbased on it being present. If you do not use the default directories, you mayneed to modify the serverdeploy.bat SAP provides.Of course, you may use a different method to deploy serverdeploy.bat.

POS configurationThe following example shows one way to run the batch file from a cash register withouthaving to exit to Windows.

You must create a Launch Application entry in the Store Configurator and its correspondingManager Code.

The following is a recommended deployment that involves running thedeployment batch files SAP supplies. Of course, you may use a differentmethod to deploy the framework. However, you must ensure the batch filesexecute properly.

We recommend that you test all deployments and file customizations beforerolling out the UUF to stores.

To create a Launch Application entry in the Store Configurator and its correspondingManager Code:

1. In Configurator, select Launch Applications from the Transaction Functions Tab.2. Select New in the Launch Application Search screen.3. In the Launch Application Maintenance screen enter the following for systems

running Windows XP or Windows 2003:4. Launch Application ID: 85. Launch Application Description: Windows XP/2K36. Executable Filename: C:\PROGRAM FILES\SAP\RETAIL\SYSTEMS\POINT OF

SALE\GO.BAT7. Run: Normal Windows8. Window Name: GO.BAT9. Launch Options: If application is active, attach to running program10. Error Condition Options: If executable name does not exist, display error message11. Data Retrieval Method: None12. Data Retrieval Type: Any data type13. Select Save.14. In Configurator, select Manager/POS Functions from the Transaction Functions Tab.15. In the Manager/POS Functions Maintenance screen, enter the Code that is

associated with Launch Application ID. (In this example, Launch Application ID is 8,so you must create Code 658.)

Manager codes are numbered in individual “sections”. The 650 sectionapplies to launch codes. In the above example, if your Laumch Application IDis 8, the correct manager code to execute would be 658. If you chooseLaunch Application 5, the correct Manager Code would be 655.

16. Select Save, and then Close.17. In Configurator, select Convert.18. In the File Conversion screen, select Launch Application, and Mgr POS Func.

Page 21: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 21

The output from the conversion process is:

99990000.aps - launch applications function

99990000.mgr - manager pos function

newparm.trg - default parameter file apply trigger

Download to each store server store server in the parm directory the above files

Preparation

The following steps assume you downloaded changes to the Xpress Servereodproc.bat server file and POS configuration to the stores.

Before deploying the UUF to the stores, you must send the necessary files to the stores.

Send the following files to the directory

C:\Program Files\SAP\Retail Systems\Xpress Server\dnload directory: Serverdeploy.bat Server.cab Clientserver.cab Tools.cab

Copy the following files to the directory

C:\Program Files\SAP\Retail Systems\Xpress Server\Parm directory: Go.bat Updsec.cab Newparm.trg (forces the files to copy to each register)

Files copied to C:\Program Files\SAP\Retail Systems\Xpress Server\Parm are automaticallycopied to each register through the ordinary parameter file mechanism.

After the preceding files are sent, you must open all registers in the stores. This ensures thatall registers will receive the necessary files to deploy the framework.

Initiate the appropriate Manager Code function to install the UUF on the Secondary POSRegisters.

To allow cab files to be extracted, you must install sapcab.exe andsapcab.dll. These files are part of the Utilities distribution installed on eachPOS client and Xpress Server system.

VerificationTo verify the UUF was successfully deployed, follow the steps below to manually execute thestatus function and review the “status.log” file.

1. Open a command prompt.2. Change directories to the c:\gmserver directory.3. Execute the command “console /server /status”.4. View the status.log file to review the deployment details.

Page 22: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

22 October 2008

6.3 The Unattended Upgrade ProcessThe unattended upgrade process runs in the background as GMClient and GMServerWindows services. The directories that contain the service executables and configurationfiles are C:\GMClient and C:\GMServer. The GMServer service listens for running GMClientsand waits for a trigger file to appear in the C:\GMServer directory. When the trigger fileappears, the GMServer copies the necessary upgrade files to the GMClient. The GMClientthen executes the upgrade.

The GMClient service is present on each client system, such as the POS terminals, and isalso present on the Xpress Server system. A single GMServer installed on the Xpress Serversystem services requests from various GMClients. The client upgrade application is designedto allow a single client executable to support multiple application upgrades on the samesystem.

The MSI installers for the SAP POS Suite use a user-defined configuration file calledupgrade.ini to hold responses to InstallShield’s installer dialog prompts. This allows anupgrade to execute without user intervention.

A distinct section within the configuration file for each installation type such as Point Of Sale,Xpress Server, Store Manager, or Electronic Journal Viewer specifies the parameters for thatinstallation type. Other configuration files that control the Unattended Upgrade frameworkdictate how the upgrade will proceed.

Initial configurationWhen the unattended upgrade is first deployed reasonable defaults are set. However, werecommend you perform a one time configuration setup. For example, if you do not use thedefault installation paths and languages, the initial configuration would require you toconfigure settings in the upgrade.ini file specifically for a particular store’s environment.

In addition, you also need to set up the client.ini file, <application.ini>, and server.ini filesfor the particular store.

Additional ConfigurationAfter the initial setup is complete, additional configuration changes depend on what is beingupgraded. The only file you need to modify for these changes is the server.ini file. This file isused to dictate the rules of the upgrade (patch or full upgrade), which applications toupgrade, name the batch files to launch, and indicate the success or failure thresholds.

Functionality overviewThe unattended upgrade process executes based on the presence of a trigger file namedupgrade.trg in the GMServer directory. The trigger file can be manually placed in thedirectory to start the process, or it can be placed there as part of eodproc.bat processing atend of day (EOD) from the Xpress Server.

Once the trigger file is present, the upgrade server will delete it and check the server.ini fileto see if a preprocess batch file has been defined. If so, the preprocess batch file is executed.This preprocessing typically copies all of the InstallShield installers from a distribution mediaor from the hard drive to special staging directories located underneath the C:\GMServerdirectory. After the preprocess file is executed, the upgrade server will determine if anyupgrade clients are requesting upgrades.

Page 23: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 23

When the upgrade server gets the request from the upgrade client, it checks in the ClientUpgrade Applications’ section of server.ini to see if the value for that particular client requestis YES or NO. If the configuration is set to NO, it ignores the upgrade client request. If theconfiguration is set to YES, it begins transferring files down to the upgrade client(s) based onthe settings in the ‘Client Upgrade Files’ section of the server.ini for that particularapplication. When the files have been transferred, the upgrade server transfers files down forthe cleanup (post-process) as defined in the ‘Client Cleanup Processes’ section of theserver.ini. It also transfers files down as defined in the ‘Client Upgrade Processes’ section ofthe server.ini file. The upgrade client launches these batch files.

When all files have been successfully transferred to the upgrade client, the upgrade clientexecutes the batch file that was defined in the ‘Client Upgrade Processes’ section ofserver.ini file for that particular application. The batch file executes and returns ‘Success’ or‘Failure’ based on the execution status.

If a failure occurs, the ‘Upgrade Threshold Failure’ section of the server.ini is referenced tosee whether or not the failure is within the defined threshold. If the failure is within thresholdor the batch file returns ‘Success’ then the unattended upgrade continues. If the failurethresholds are exceeded, then the unattended upgrade begins to revert all applications totheir original states prior to the beginning of the unattended upgrade.

If batch files are defined in the ‘Client Cleanup Processes’ section of the server.ini file thenthese batch files are executed after the initial batch file has completed.

When the cleanup batch file process is complete, and all other clients residing on the variousmachines have completed their respective tasks for the application, the cycle will repeat itselffor subsequent applications. Throughout the process, status messages are sent back to theGMServer service and written to the server.log file.

The applications are upgraded in the following order:

DBTools

Xpress Server

Backup Server

Store Manager

Electronic Journal Viewer

Point of Sale

When all applications have been upgraded, the upgrade server checks server.ini to see if apost-processing batch file was defined. If one was, it executes that batch file. When executionof the batch file is completed, the unattended upgrade is complete.

The upgrade process begins at the server where a trigger file upgrade.trg is run to launchthe application upgrade process. Using the network TCP/IP protocol, an upgrade client,gmclient.exe, sends a request for upgrade to the upgrade server, gmserver.exe. If theupgrade server finds an upgrade package it sends it to the client and the client automaticallyruns the upgrade. Once the upgrade is complete, the client notifies the server, which allowsthe server to track the success or failure of the upgrade process.

Server.ini controls the actions performed in the upgrade. This file resides on the server. Itspecifies which applications are to be upgraded, failure thresholds, preprocessing and post-processing routines as well as other user-defined configurations. The upgrade is carried outby customizable batch files which are sent to, and launched by the client. This allows apredefined set of batch files to exist for an unattended patch upgrade, an unattended fullupgrade or any other user-defined unattended upgrade process.

Page 24: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

24 October 2008

The client/server applications only serve as a mechanism for sending and launching theexternal process (batch files) on the client machines. No upgrade-specific logic is built intothe client/server application.

Upgrade files sent from the server to the client are recreated using the path defined in the[Client Upgrade Files] section of the server.ini file. It is assumed that if a full path has notbeen defined, then the same sub-directory structure that appears under the upgrade serverdirectory will be recreated under the directory where the upgrade client has been installed.Batch files specified in the ‘Client Upgrade Process’ section of the server.ini file will also besent from the server to the client using the same convention.

Console command parameters for the upgradeapplicationThe client/server applications are Windows services and do not directly interact with thedesktop. A console command program is available as a separate upgrade application thathelps control the service or allows the user to see the progress of the upgrade.

The following is a list of these console command parameters.

Parameter Description

To invoke a specific console command, the following parameters are available:

/SERVER Denotes that command should be invoked byupgrade server.

/CLIENT Denotes that command should be invoked byupgrade client.

The following commands are available to both the upgrade server and the upgradeclient:

/SUSPEND Suspend sending/receivingrequests/responses.

/RESUME Resume sending/receivingrequests/responses.

/SHUTDOWN Abort execution of upgrade application.

/OPEN Client or server will become visible on thescreen.

/CLOSE Client or server will no longer be visible onthe screen (but will still be running.)

The following commands are only availableto the upgrade server:

/STATUS Gets a summarized status of upgrade activityand outputs to an ASCII text file.

/REFRESH Refreshes server status by removingreferences to client connections that are nolonger valid (such as a machine where clientupgrade was installed but has been removedfrom the network causing the clientconnection to time out on the server.)

/RESTART Allows upgrade server to restart the lastupgrade session that was in progress.

Page 25: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 25

6.4 The upgrade application batch fileThe following table shows the default parameters required to launch a client upgrade processbatch file.

The file supplied with the Unattended Upgrade Framework is appupg.bat

Parameter Description

%1 Type of operation upgrade (UPGRADE/RESTORE)

%2 Type of application that is being upgraded

%3 Location of application that is being upgraded

%4 Location of upgrade client (GMClient)

When customizing the upgrade batch file, a list of additional user-defined parameters may beincluded, however any additional parameters must start from the fifth batch file parameter(%5) and higher. Each batch file that is launched must also return a value to determinesuccess or failure (or other actions) based on the execution of the batch file.

The following is a list of the possible return values and their description.

Return value Description

0 Return success

1 Return failure

2 Return success, and shut down GMClient

Using the upgrade server configuration file server.iniThe upgrade server configuration file is called server.ini. The following is a description of thesections and parameters for the upgrade server configuration file. This file, if necessary,should be modified at the head office and sent to the stores prior to an upgrade.

Server Specific ParametersUpgrade Application sectionThis section specifies the names of the log and error files, the purge parameters, and thelevel of debug logging that is to be used.

ErrorFile — defines the name of the error file used to capture server any upgradeerrors during an upgrade session. The error file is located in the same directory wherethe upgrade server resides. (Messages are time stamped and appended to end of theerror file.)

LogFile — defines the name of the server log file used to capture server statusmessages. (Contents of UPGRADE.LOG file generated by a client upgrade is alsocaptured in the server log.) The log file is located in the same directory where theupgrade server resides. (Messages are time stamped and appended to end of logfile.)

LogPurge — number of days to retain server log messages before purging them fromLogFile. (The log file is truncated after messages are removed.)

Page 26: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

26 October 2008

DebugLevel — level of application debugging. The resulting debug messages arecaptured in DEBUG.LOG located in same directory where the upgrade server islocated. Currently only 0 (no debugging) and 1 (debugging) are the supported levels.

Upgrade Server sectionThis section specifies the server port number and configuration to denote whether themachine that the gmserver application resides on should be rebooted.

ServerPort — port number that the upgrade server will listen on for upgrade clientrequests. This port number is also used to listen on for server commands from theupgrade console.

Reboot — denotes whether or not to reboot the machine where the upgrade serverresides after the current upgrade session is completed.

Upgrade session parametersServer Upgrade Processes SectionThis section specifies preprocessing and post-processing batch files as well as a delay timerfor starting the upgrade.

Pre-Process — defines the name of the batch file that the upgrade server will launchprior to starting an upgrade session. The launch is assumed normal unless thefollowing parameters are used:

/MAX — launch maximized

/MIN — launch minimized

Post-Process — defines the name of the batch file that the upgrade server willlaunch after finishing an upgrade session. The launch is assumed normal unless thefollowing parameters are used:

/MAX — launch maximized

/MIN — launch minimized

UpgradeDelayProcess — number of seconds to wait before starting the upgradeprocess. The default is to start immediately.

Client Upgrade Applications sectionThis section specifies which applications will be upgraded during the current upgradesession. You can enter the applications in this section and specify which should be upgradedby setting it to either:

Yes — Upgrade this application

or

No — Do not upgrade this application

If you do not specify an application in this section, it is not upgraded. The upgrade server willonly send upgrade files to an upgrade client if the application upgrade has been configured.

The following list shows the names and abbreviations of applications that can be upgraded:

POS — Pont of Sale

XPS — Xpress Server

DBT — DB Tools

Page 27: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 27

EJV — Electronic Journal Viewer

SMG — Store Manager

BUX — Backup Server

UGS — Upgrade Server

UGC — Upgrade Client

Client Upgrade Files sectionThis section defines the location of files to transfer to an upgrade client during the currentupgrade session. The semi-colon character ‘;’ is used to denote a subdirectory under the firstdirectory name specified.

Point of sale;PARM\2 denotes all files located in Point of Sale and\SAP\RETAIL SYSTEMS\POINT OF SALE\PARM\2.

The directory structure is recreated under the directory where the client being servicedresides. You can specify a complete path to transfer files from a different directory than theupgrade subdirectory. You can also use the parent directory identifier to denote a directoryabove the upgrade sub-directory.

For example, .\Batch Files means transfer all files located in sub-directory thatis on the same level as upgrade sub-directory.

Also, you can transfer a specified file by specifying the location and name of file, for example,.\Batch Files\myfile.txt. Preceding the label with a ‘;’ will comment out the line (similar to aREM statement in a batch file.)

The following list shows the names and abbreviations of batch files that can transferred sothat the application can be upgraded:

POS — Point of Sale

XPS — Xpress Server

DBT — DB Tools

EJV — Electronic Journal Viewer

SMG — Store Manager

BUX — Backup Server

UGS — Upgrade Server

UGC — Upgrade Client

Client Upgrade ProcessesThis section defines the name of the batch file that the upgrade client launches during currentupgrade session in order to upgrade an application. As the file is copied to the upgrade client,the same directory structure is recreated under the directory where the upgrade clientresides. The launch is assumed normal unless the following parameters are used:

/MAX — launch maximized

/MIN — launch minimized

Preceding the label with a “;” will comment out the line (similar to a REM statement.)

Page 28: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

28 October 2008

The following list shows the names and abbreviations of batch files the upgrade clientlaunches so that the application can be upgraded:

POS — Point of Sale

XPS — Xpress Server

DBT — DB Tools

EJV — Electronic Journal Viewer

SMG — Store Manager

BUX — Backup Server

UGS — Upgrade Server

UGC — Upgrade Client

Client Cleanup Processes sectionThis section defines the name of the batch file that the upgrade client launches uponcompletion of current upgrade session. As the file is copied to the upgrade client, the samedirectory structure is recreated under directory where the upgrade client resides. The launchis assumed normal unless the following parameters are used:

/MAX — launch maximized

/MIN — launch minimized

Preceding the label with a “;” will comment out the line (similar to a REM statement.)

The following list shows the names and abbreviations of batch files the upgrade clientlaunches after the application is successfully upgraded:

POS — Point of Sale

XPS — Xpress Server

DBT — DB Tools

EJV — Electronic Journal Viewer

SMG — Store Manager

BUX — Backup Server

UGS — Upgrade Server

UGC — Upgrade Client

Upgrade Threshold Failure sectionThis section defines the number of failures allowed per type of client that is upgraded. Whenany client threshold value is exceeded, the upgrade server will automatically switch currentupgrade session status from ‘upgrade’ to ‘restore’ in order to restore the applications to astate prior to the upgrade. Preceding the label with a “;” will comment out the line (similar to aREM statement.)

The following list shows the abbreviations of the applications to be upgraded, and the numberof times the upgrade can fail before the upgrade process stops.

In the example below, “0” means the upgrade will stop after the first failure.

EJV = 0

DBT = 0

POS = 0

Page 29: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 29

SMG = 0

Sample server.ini fileThe following is an example of the server.ini file.

#=================================================================

# SERVER UPGRADE INITIALIZATION FILE

#=================================================================

#=================================================================

# SERVER SPECIFIC PARAMETERS

#=================================================================

[Upgrade Application]

ErrorFile = SERVER.ERR

LogFile = SERVER.LOG

LogPurge = 1

DebugLevel = 0

[Upgrade Server]

ServerPort = 4404

Reboot = NO

#=================================================================

# UPGRADE SESSION PARAMETERS

#=================================================================

[Server Upgrade Processes]

Pre-Process = /MIN “Upgrade\Batch Files\image.bat”“C:\V9_1_1_0Build25(May13-05)” c:\gmserver\upgradec:\gmserver\upgrade\parms c:\gmserver\upgrade\misc c:\gmserver;Post-Process = /MIN “Upgrade\Batch Files\postupg.bat” c:\gmserverc:\gmserver\upgrade

UpgradeDelayProcess = 20

[Client Upgrade Applications]

POS = NO

XPS = NO

DBT = YES

EJV = NO

SMG = NO

BUX = NO

UGS = NO

UGC = NO

Page 30: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

30 October 2008

[Client Upgrade Files]

POS = POS;disk1

XPS = XPS;disk1

BUX = BUX;disk1

EJV = EJV;disk1

DBT = DBT;disk1;SQLScript

SMG = SMG;disk1

UGS = UGS;Client;Server;..\batch files\cpy_server.bat

UGC = UGC;..\batch files\cpy_client.bat

[Client Upgrade Processes]

XPS = /MIN upgrade\Batch Files\appupg.bat

EJV = /MIN upgrade\Batch Files\appupg.bat

DBT = /MIN upgrade\Batch Files\appupg.bat

POS = /MIN upgrade\Batch Files\appupg.bat

SMG = /MIN upgrade\Batch Files\appupg.bat

BUX = /MIN upgrade\Batch Files\appupg.bat

UGS = /MIN upgrade\Batch Files\appupg_UGS.bat

UGC = /MAX upgrade\Batch Files\appupg_UGC.bat

[Client Cleanup Processes]

XPS = upgrade\Batch Files\post_XPS.bat

UGS = upgrade\Batch Files\post_UGS.bat

UGC = upgrade\Batch Files\post_UGC.bat

[Upgrade Threshold Failure]

EJV = 0

DBT = 0

POS = 0

SMG = 0

Page 31: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 31

Using the upgrade client configuration file client.iniThe following is a description of the sections and parameters for the upgrade clientconfiguration file called client.ini.

Upgrade Client Specific ParametersUpgrade Application sectionThis section specifies the names of the log and error files, the purge parameters, and thelevel of debug logging that is to be used.

ErrorFile — defines name of error file used to capture any client upgrade errorsduring an upgrade session. The error file is located in the same directory where theupgrade client resides. Messages are time stamped and appended to end of error file.

LogFile— defines name of client log file used to capture client status messages. Thelog file is located in the same directory where the upgrade client resides. Messagesare time stamped and appended to end of log file.

LogPurge — number of days to retain client log messages before purging them fromLogFile. Log file is truncated after messages are removed.

DebugLevel — level of application debugging. The resulting debug messages arecaptured in DEBUG.LOG located in the same directory where the upgrade client islocated. Currently only 0 (no debugging) and 1 (debugging) are the supported levels.

ActivePrompt— name of program to launch in order to visually denote client upgradeactivity. The process is automatically terminated once the upgrade session iscompleted or the upgrade client is shutdown.

Upgrade Server sectionThis section specifies the IP and port information about the server.

IPAddress — IP address of the upgrade server. If you are using a ‘loop back’address, make sure that loop back has been properly installed. Otherwise supply theIP Address of the server.

ServerPort — port number that the upgrade server will listen on for requests from theupgrade client.

Upgrade Client sectionThis section specifies the port of the client.

ConsolePort — port number that the upgrade client will listen on for client commands fromthe upgrade console.

Page 32: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

32 October 2008

Sample client.ini fileThe following is an example of the client.ini file.

#=====================================================

# TRANSACTIONWARE CLIENT INITIALIZATION FILE

#=====================================================

#=====================================================

# UPGRADE CLIENT SPECIFIC PARAMETERS

#=====================================================

[Upgrade Application]

ErrorFile = CLIENT.ERR

LogFile = CLIENT.LOG

LogPurge = 1

DebugLevel = 1

ActivePrompt = \gmclient\upgalert.bat

[Upgrade Server]

IPAddress = 127.0.0.1

ServerPort = 4404

[Upgrade Client]

ConsolePort = 4405

Using the application upgrade ini filesThe application ini files are located in the same directory gmclient.exe, C:\GMClient. Eachconfiguration file present on a particular machine represents a SAP POS application that alsoresides on that machine. Possible ini files deployed with the upgrade client, or GMClient,include the following:

POS.INI — Use this file if there is a Point of Sale application on the machine.

XPS.INI — Use this file if there is an Xpress Server application on the machine.

EJV.INI — Use this file if there is an Electronic Journal Viewer application on the machine.

DBT.INI — Use this file if there is a DBTools application on the machine.

SMG.INI — Use this file if there is a Store Manager application on the machine.

BUX.INI — Use this file if there is a Backup Server application on the machine.

Page 33: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 33

Optional:

We recommend you deploy the Upgrade Client/Server applications rather than upgrade themusing the Unattended Upgrade framework. However, SAP provides configuration and batchfiles with the upgrade package.

Optional ini files deployed with the upgrade client, or GMClient, include the following:

UGS.INI — Use this file if there is an Upgrade Server application on the machine.

UGC.INI — Use this file if there is an Upgrade Client application on the machine.

Do not include the UGC.INI file on the machine that also has the upgradeserver present. The server upgrade process will take care of upgrading theupgrade client on that particular machine. Include only the UGS.INI file.

Upgrade Session ParametersClient Identification sectionThis section defines the identification and location of the particular application that the .INI filerepresents.

Location — defines the location of the application being upgraded.

Identification — defines the identification label used in denoting command requests inSERVER.LOG located in the upgrade server directory.

Upgrade Client sectionThis section defines rebooting behavior and trigger file behavior.

Reboot — denotes whether or not to reboot the machine where the upgrade client residesafter the current upgrade client session is completed. The default is ‘No’.

TriggerFile — denotes whether or not the client should wait for the trigger file to be verifiedupon restart of the upgraded application. Assumes the trigger file is created in the applicationdirectory. The default is ‘No’.

Upgrade Timeout Period sectionThis section defines failure timeout behavior and additional trigger file behavior.

ProgramLaunch — denotes how many seconds to wait after the batch file process islaunched before determining that the batch file process has failed. If the batch file processterminates prior to the timeout period, the resulting success or failure is based on the returncode from the batch file.

If you set the timeout period to INFINITE in the ini file, thesystem will wait indefinitely to determine the batch file processfailed.

Page 34: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

34 October 2008

VerifyTrigger — denotes how many seconds to wait for the upgraded application to generatethe verification file before determining that the client application failed to successfully restartafter upgrade. The timeout period works in conjunction with the TriggerFile configuration setto ‘Yes’.

If you set the timeout period to INFINITE in the ini file, thesystem will not look for the TriggerFile. (In this case we recommend you setthe TriggerFile configuration to “No”.)

Sample pos.ini configuration fileThe following is an example of an application configuration file pos.ini.#===============================================

# TRANSACTIONWARE APPLICATION UPGRADE INITIALIZATION FILE

#===============================================

#===============================================

# UPGRADE SESSION PARAMETERS

#===============================================

[Client Identification]

Location = C:\Program files\SAP\Retail Systems\Point of Sale

Identification = POS01

[Upgrade Client]

Reboot = NO

TriggerFile = NO

[Upgrade Timeout Period]

ProgramLaunch = 900

;VerifyTrigger = 120

Using the upgrade.ini configuration fileThe upgrade configuration file, upgrade.ini, contains all of the application-specificparameters the individual application installers use. During the unattended installation, theinstallers read these parameters to get the values that would normally be input by the userduring an interactive installation. The upgrade.ini file must reside in the same location as theMSI installer file of each application.

Page 35: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 35

Point Of Sale UpgradeThis section defines the parameters for the unattended Point of Sale upgrade.

Parameter Description

INSTALL_BROWSER Determines if the Point of Sale Browser will be upgraded aspart of the install. Options are:

Y

N

INSTALL_DEMO_PARMS Determines if the demo parameters are to be installed.Options are:

Y

N

CREDIT Determines if credit is to be installed (EF=EFT Services(Transnet)

The following are no longer supported:

TN=Concord

NC=No Credit

FD=First Data

NB=Nabanco

NC=NCR2127

ND=NDC2

SA=SAGA

VI=Visanet

AL=Alliance Data Systems

AJ=AJB

INSTALL_DIRECTORY Installation directory of application

UTIL_DIRECTORY Installation directory of utilities

SERVER_IP IP Address of the server

BACKUP_SERVER_IP IP Address of the backup server

CISP_MODULE Determines whether to add security keys. Options are:

Y

N

CISP_KEYFILE Location of the security key file for import, if desired.

CISP_SINGLEKEY_PASSWORD Password for the single key security container

CISP_MULTIKEY_PASSWORD Password for the multikey security container

CISP_KEYFILE_PASSWORD Password for the import key file

Page 36: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

36 October 2008

Parameter Description

Language Installs the appropriate language files. Options are:

ENG

FRE

SPA

GER

To successfully operate after an upgrade, an upgraded Point of Sale requiresa copy of the literal.bit and literal.lit parameter files in the XPS\Parmdirectory.

Xpress Server UpgradeThis section defines the parameters for the unattended XPS and Backup Server upgrade.

Parameter Description

INSTALL_API Determines if API is to be installed. Options are:

Y

N

INSTALL_DEMO_PARMS Determines if the demo parameters are to be installed.Options are:

Y

N

DB_TYPE Determines which database is used in the installation.Options are:

S9=Sybase SQL Anywhere 9

MS=MS SQL Server

The following are no longer supported:

SY=Sybase SQL Anywhere

SA=Sybase Adaptive Server

Page 37: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 37

Parameter Description

CREDIT Determines credit to be installed (EF=EFT Services(Transnet)

The following no longer supported:

TN=Concord

NC=No Credit

FD=First Data

NB=Nabanco

NC=NCR2127

ND=NDC2

SA=SAGA

VI=Visanet

AL=Alliance Data Systems

AJ=AJB

DATABASE_APP_PATH Location of database service application

DATABASE_SERVER Name of database server

DB_USER Database connection user name; applicable onlywhen DB_TYPE = MS

DB_PASS Database connection password; applicable only whenDB_TYPE = MS

INSTALL_DIRECTORY Installation Directory of application

UTIL_DIRECTORY Installation Directory of Utilities

CISP_MODULE Determines whether to add security keys. Options are:

Y

N

CISP_KEYFILE Location of the security key file for import, if desired

CISP_SINGLEKEY_PASSWORD Password for the single key security container

CISP_MULTIKEY_PASSWORD Password for the multikey security container

CISP_KEYFILE_PASSWORD Password for the import key file

Language Installs the appropriate language files. Options are:

ENG

FRE

SPA

GER

Page 38: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

38 October 2008

EJV UpgradeThis section defines the parameters for the unattended Electronic Journal Viewer pgrade.

Parameter Description

DATABASE_SERVER Name of database Service

DB_USER Database connection user name;applicable only when DB_TYPE = MS

DB_PASS Database connection password;applicable only when DB_TYPE = MS

DB_TYPE Determines which database is used in theinstallation. Options are:

S9=Sybase SQL Anywhere 9

MS=MS SQL Server

The following are no longer supported:

SY=Sybase SQL Anywhere

SA=Sybase Adaptive Server

INSTALL_DIRECTORY Installation Directory of application

DATABASE_APP_PATH Location of database service application

XPRESS_SERVER_PATH Path to the Xpress Server installation

CISP_MODULE Determines whether to add security keys.Options are:

Y

N

CISP_KEYFILE Location of the security key file for import,if desired

CISP_SINGLEKEY_PASSWORD Password for the single key securitycontainer

CISP_MULTIKEY_PASSWORD Password for the multikey securitycontainer

CISP_KEYFILE_PASSWORD Password for the import key file

Language Installs the appropriate language files.Options are:

ENG

FRE

SPA

GER

Page 39: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 39

Store Manager UpgradeThis section defines the parameters for the Unattended Store Manager Upgrade.

Parameter Description

DATABASE_SERVER Name of database Service

DB_USER Database connection user name; applicable only whenDB_TYPE = MS

DB_PASS Database connection password; applicable only whenDB_TYPE = MS

DB_TYPE Determines which database is used in the installation.Options are:

S9=Sybase SQL Anywhere 9

MS=MS SQL Server

The following are no longer supported:

SY=Sybase SQL Anywhere

SA=Sybase Adaptive Server

SERVER_IP IP Address of Server

INSTALL_DIRECTORY Installation Directory of application

DATABASE_APP_PATH Location of database service application

XPRESS_SERVER_PATH Path to the Xpress Server installation

Language Installs the appropriate language files. Options are:

ENG

FRE

SPA

GER

DBTools UpgradeThis section defines the parameters for the unattended DBTools upgrade.

Parameter Description

DB_TYPE Determines which database is used in the installation. Optionsare:

S9 = Sybase SQL Anywhere 9

MS = MS SQL Server

The following are no longer supported:

SY = Sybase SQL Anywhere

SA = Sybase Adaptive Server

BACKUP_DIR Backup location of DB files

DATABASE_APP_PATH Location of database service application

INSTALL_DIRECTORY Installation Directory of application

UPGRADE_BACKOFF Upgrade BACKOFF Database (that is, Xpress Server, and

Page 40: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

40 October 2008

Parameter DescriptionStore Manager)

Options are:

Y

N

UPGRADE_JOURNAL Upgrade Electronic Journal Database

Options are:

Y

N

UPGRADE_CONFIG Upgrade Configurator Database

Options are:

Y

N

DATABASE_SERVER Name of database Service

BKDATABASE_SERVER Name of database Service for Store manager

JRDATABASE_SERVER Name of database Service for Journal Viewer

CFG_DB_PATH Location of the Configurator database

The followingparameters are usedonly if DB_TYPE = MS:

BKDB_USER DB Administrator user name for Store manager

BKDB_PASS DB Administrator password name for Store manager

JRDDB_USER DB Administrator user name for Journal Viewer

JRDDB_PASS DB Administrator password for Journal Viewer

Sample configuration of the upgrade.ini fileThe following is an example of the upgrade.ini file:[POS UPGRADE]

INSTALL_BROWSER = N #Determines if POS Browser will be upgraded as part of theinstall

INSTALL_DEMO_PARMS = N #Determines if Triversity demo parameters are to be installed

CREDIT = EF #Determines credit to be installed (TN=Concord, NC=No Credit, FD=FirstData, NB=Nabanco,NC=NCR2127, ND=NDC2, SA=SAGA, VI=Visanet, AL=Alliance Data Systems,AJ=AJB)

INSTALL_DIRECTORY = c:\program files\SAP\Retail Systems\point of sale #InstallationDirectory of application

UTIL_DIRECTORY = c:\program files\SAP\Retail Systems\utilities #InstallationDirectory of Utilities

REM Provide appropriate Server IP address in the line below TEST GM10 Server IPprovided

SERVER_IP =127.0.0.1

BACKUP_SERVER_IP =

CISP_MODULE = N #CISP Security Container N=Do not install, Y=Install

Page 41: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 41

CISP_KEYFILE = #CISP Location of CISP Key File

CISP_MULTIKEY_PASSWORD = #CISP Multi Key Container Password

CISP_KEYFILE_PASSWORD = #CISP KeyFile Password

Language=ENG # ENG, FRE, SPA, GER

[XPS UPGRADE]

INSTALL_API = N #Determines if Triversity API is to be installed

DB_TYPE = MS #Determines which database is used in the installation (S9=Sybase SQLAnywhere 9, MS=MS SQL Server)

CREDIT = EF #Determines credit to be installed (TN=Concord, NC=No Credit, FD=FirstData, NB=Nabanco,NC=NCR2127, ND=NDC2, SA=SAGA, VI=Visanet, AL=Alliance Data Systems,AJ=AJB)

DATABASE_APP_PATH = C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Binn#Location of database service application

DATABASE_SERVER =localhost

INSTALL_DIRECTORY = c:\program files\SAP\Retail Systems\xpress server

INSTALL_DEMO_PARMS = N #Determines if Triversity demo parameters are to be installed

UTIL_DIRECTORY = c:\program files\SAP\Retail Systems\utilities #InstallationDirectory of Utilities

CISP_MODULE = N

CISP_KEYFILE =

CISP_MULTIKEY_PASSWORD =

CISP_SINGLEKEY_PASSWORD =

CISP_KEYFILE_PASSWORD =

Language=ENG # ENG, FRE, SPA, GER

[EJV UPGRADE]

DATABASE_SERVER =localhost

DB_TYPE = MS #Determines which database is used in the installation (S9=Sybase SQLAnywhere 9, MS=MS SQL Server)

INSTALL_DIRECTORY = c:\program files\SAP\Retail Systems\Sales Journal Viewer

DATABASE_APP_PATH = C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Binn#Location of database service application

CISP_MODULE = N #CISP Security Container N=Do not install, Y=Install

CISP_KEYFILE = #CISP Location of CISP Key File

CISP_MULTIKEY_PASSWORD = #CISP Multi Key Container Password

CISP_SINGLEKEY_PASSWORD = #CISP Single Key Container Password

CISP_KEYFILE_PASSWORD = #CISP KeyFile Password

Language=ENG # ENG, FRE, SPA, GER

[STORE MANAGER UPGRADE]

DATABASE_SERVER =localhost

DB_TYPE = MS #Determines which database is used in the installation (S9=Sybase SQLAnywhere 9, MS=MS SQL Server)

LABEL_COMPONENT = NO #Label component used (EP=Episys, NO = None)

SERVER_IP=127.0.0.1

INSTALL_DIRECTORY = c:\program files\SAP\Retail Systems\store manager

DATABASE_APP_PATH = C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Binn#Location of database service application

XPRESS_SERVER_PATH = c:\Program files\SAP\Retail Systems\xpress server

Language=ENG # ENG, FRE, SPA, GER

Page 42: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

42 October 2008

[SDK UPGRADE]

SERVER_IP=127.0.0.1

INSTALL_DIRECTORY = c:\program files\SAP\Retail Systems\sdk

[BACKOFF DB UPGRADE]

DB_TYPE = MS #Determines which database is used in the installation (S9=Sybase SQLAnywhere 9, MS=MS SQL Server)

SERVER_IP=127.0.0.1

DB_PATH = C:\Program Files\SAP\Retail Systems\Databases #location of DB files

LOG_PATH = C:\Program Files\SAP\Retail Systems\Databases #location of DB transactionlog

BACKUP_DIR = C:\Program Files\SAP\Retail Systems\Databases\Backup #backup locationof DB files

DATABASE_APP_PATH = C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Binn#Location of database service application

DATABASE_SERVER =localhost

INSTALL_DATABASE = Y #really install the database

[DB TOOLS UPGRADE]

DB_TYPE = MS #Determines which database is used in the installation (SY=Sybase SQLAnywhere, MS=MS SQL Server, SA=Sybase Adaptive Server)

BACKUP_DIR = C:\Program Files\SAP\Retail Systems\Databases\Backup #backup locationof DB files

DATABASE_APP_PATH = C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Binn#Location of database service application

INSTALL_DIRECTORY = c:\program files\SAP\Retail Systems\dbtools

UPGRADE_BACKOFF = Y #Upgrade BACKOFF Database (Xpress Server, Store Manager)

UPGRADE_JOURNAL = Y #Upgrage Electronic Journal Database

UPGRADE_CONFIG = Y #Upgrade Configurator Database

CFG_DB_PATH = c:\program files\SAP\Retail Systems\store configurator # Location ofthe configurator database

BKDB_PATH = C:\Program Files\SAP\Retail Systems\Databases #Location of the SAP Retaildatabases

BKDB_USER = sa #DB Administrator User Name

BKDB_PASS = Bmcore1 #DB Administrator Password

JRLDB_PATH = C:\Program Files\SAP\Retail Systems\Databases #Location of the SAPRetail databases

JRLDB_USER = sa #DB Administrator User Name

JRLDB_PASS = Bmcore1 #DB Administrator Password

DATABASE_SERVER=localhost

BKDATABASE_SERVER=localhost

JRLDATABASE_SERVER=localhost

[MOBILE POS UPGRADE]

INSTALL_DIRECTORY = c:\Program Files\SAP\Retail Systems\Mobile POS #InstallationDirectory of application

THIN_SERVER_SUPPORT = Y #Thin Server that is installed on current machine will beupgraded to support Mobile POS

XPRESS_SERVER_SUPPORT = Y #Xpress Server that is installed on current machine will beupgraded to support Mobile POS

CREDIT = EF #Determines credit to be installed (TN=Concord, NC=No Credit, FD=FirstData, NB=Nabanco,NC=NCR2127, ND=NDC2, SA=SAGA, VI=Visanet,AL=Alliance Data Systems,AJ=AJB)

Page 43: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 43

HAND_HELD = 4 #Determines hand hend to be installed (1=8146, 2=MC3000,4=MC3090) (onlyrequired if XPRESS_SERVER_SUPPORT = Y)

THIN_SERVER_IP=127.0.0.1 #IP address of machine where Thin Server is located (onlyrequired if XPRESS_SERVER_SUPPORT = Y)

THIN_SERVER_PATH=C:\program files\SAP\Retail Systems\Point of sale #Location of ThinServer application (only required if THIN_SERVER_SUPPORT = Y)

PRINTER_IP=127.0.0.1 #IP address of printer hardware that will be utilized by MobilePOS (only required if THIN_SERVER_SUPPORT = Y)

THIN_SERVER_STORE = 0 # number of store that will be injected on to hand held device

THIN_SERVER_REGISTER = 51 # number of register that will be injected on to the handheld device

THIN_SERVER_PORT = 4000 # number of port that thin server will communicate with handheld device

The unattended upgrade generic batch filesSeveral batch files are created to perform the upgrade and patching tasks required for thevarious applications. You can use these batch files as they are, or you can modify them, oryou can create your own batch files. The following is a list of the generic batch files availableas well as a description of their basic functions.

apppatch.bat — used to copy patch files to a particular application directory. The batch filealso registers xrules.dll if it exists on that particular machine. The batch file uses thestandard input parameters it gets from the GMClient. Patch files are not normally releasedand full upgrades are recommended.

appupg.bat — used to run the MSI package for a particular application so that a full upgradeof that application is run in unattended mode. The batch file uses the standard inputparameters it gets from the GMClient.

appupg_UGC.bat — used to upgrade the upgrade client gmclient.exe application. Thebatch file takes in the standard input parameters and always returns ‘Success.’ This batch fileis used in conjunction with post_UGC.bat and cpy_client.bat to perform the upgrade of theupgrade client application.

appupg_UGS.bat — used to upgrade the upgrade server gmserver.exe application. It isalso used to upgrade the upgrade client gmclient.exe application on the machine thatcontains the upgrade server. All other machines use Appupg_UGC.bat to upgrade theclient. This batch file takes in the standard input parameters and always returns ‘Success.’ Itis used in conjunction with post_UGS.bat and cpy_server.bat to perform the upgrade of theupgrade server application, and the client on the upgrade server machine.

post_UGC.bat — used to upgrade the upgrade client gmclient.exe application. This batchfile launches cpy_client.bat and returns a value of ‘2’ (which represents ‘Success’), andcommands gmclient.exe to shut itself down.

post_UGS.bat – used to upgrade the upgrade server gmserver.exe application. This batchfile launches cpy_server.bat and returns a value of ‘2’ (which represents ‘Success’), andcommands gmclient.exe to shut itself down. Since this patch file is only triggered when theUGS.INI is present at the client, it only shuts down the client that resides on the machinecontaining the upgrade server.

cpy_client.bat – used to upgrade the upgrade client gmclient.exe. It is launched bypost_UGC.bat. Once launched, it waits until the upgrade client has been shut down and thenproceeds to upgrade the upgrade client.

cpy_server.bat – used to upgrade the upgrade server as well as the upgrade client thatresides on the same machine as the upgrade server. It is launched by post_UGS.bat. Oncelaunched, it waits until the upgrade client has been shut down and then proceeds to upgradethe upgrade server as well as the upgrade client on that machine.

Page 44: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

44 October 2008

post_XPS.bat – used to take the parm files from the gmserver\upgrade\ parm directory andcopy them into the Xpress Server\parm directory. This batch file is called after theappupg.bat or apppatch.bat is executed. This batch file is used to update the parms whenan upgrade has occurred. These parms are applied at the server once the server is started,and are subsequently applied at the Point of Sale registers once they have been upgradedand started up.

image.bat – used to extract the contents of a CD or CD image and populate the upgradeserver’s staging area with the necessary files it requires to perform an unattended upgrade.The batch file takes the arguments that can be specified in the ‘server.ini preprocess’ section.The parameters are:

%1 = Source Install Directory

%2 = Destination Directory (server/upgrade)

%3 = PARM Source directory

%4 = Upgrade.ini source directory

startclient.bat – used to run as a scheduled task. Every time the scheduled task executesthis batch file, the batch file checks if gmclient.exe is running. If it is not, the batch fileautomatically starts it.

startserver.bat – used to run as a scheduled task. Every time the scheduled task executesthis batch file, the batch file checks the gmserver.exe is running. If it is not, the batch fileautomatically starts it.

upgalerrt.bat – This optional batch file can launch at the beginning of the upgrade processand will be launched on all client machines. The batch file must reside in the upgrade clientdirectory c:\gmclient. When launched, the batch file displays a message indicating theupgrade is in progress. The batch file will be terminated by the upgrade client after theunattended upgrade has completed.

6.5 Appendix AFile Structure and Custom DistributionBefore you deploy the Unattended Upgrade Framework (UUF) to the stores, we recommendyou deploy, test, customize, and repackage the framework in a non-production environment.

This section discusses the structure of the distributed CAB files, the structure found on diskafter deployment, and how to repackage for custom deployment.

CAB FilesThe distributed CAB archives may contain components that require customization. Files thatmay require customization are listed in bold. However, you do not need to modify the files ifyou use the default install locations for both Point of Sale and infrastructure (for example,Database Servers).

The directory structure defined below is the same for the distributes CAB files, and the filesdeployed under the C:\GMServer and C:\GMClient directories.

Server File Distributionserverdeploy.bat

server.cab

clientserver.cab

tools.cab

Page 45: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 45

server.CAB and C:\GMServer contents and directory structure:

\console.exe

\GMServer.exe

\server.ini

\startserver.bat

\startserver.job

\up.exe

\uu.exe

\Upgrade (Directory)

\Batch Files (Directory)

\Upgrade \Batch\appatch.bat

\Upgrade \Batch\appupg.bat\Upgrade \Batch\appupg_UGC.bat

\Upgrade \Batch\cpy_client.bat

\Upgrade \Batch\cpy_server.bat\Upgrade \Batch\image.bat

\Upgrade \Batch\post_pos.bat\Upgrade \Batch\post_UGC.bat

\Upgrade \Batch\post_XPS.bat

\Upgrade \Batch\postupd.bat\Upgrade \Batch\startserver.bat

\Misc (directory)

\Upgrade \Misc \upgrade.ini \Parm (directory)

\Upgrade \Parm (directory)

Store specific Parameter files generated by the Configurator

clientserver.cab and C:\GMClient contents and directory structure:

\client.ini

\console.exe

\dbt.ini\ejv.ini

gmclient.exe

\pos.ini (only if POS is running on Server)

\smc.ini

startclient.bat

startclient.job

Page 46: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

46 October 2008

\tnt.ini

\ugc.ini\ugs.ini

\upgalert.bat

\xps.initools.cab contains:

beask.exe

up.exe

uu.exe

tools.cab does not require repackaging or customization

Client or POS File Distributiongo.bat

updsec.cab

POS terminal C:\GMClient contains the following files:

client.ini

console.exe

gmclient.exe

pos.ini

tools.cab

startclient.bat

startclient.job

ugc.iniupgalert.bat

Customize the batch and *.ini files under the C:\GMServer directory to match the environmentof your server and database engine (type and path).

For easier repackaging, edit the following files in their original directory structure:

Edit C:\GMServer\server.ini in the [Client Upgrade Applications] section to show‘YES’ for the applications and you need to upgrade. At the bottom of the file, changethe [Upgrade Threshold Failure] setting.

Edit the entry in C:\GMServer\server.ini for the first argument of image.bat to pointto the directory or CDROM that contains the MSI files that are to be used forupgrading. The distribution CDROM contains a subdirectory called MsiInstall.

If an upgrade CDROM is sent to the stores, edit image.bat as follows:Pre-Process = /MIN "Upgrade\Batch Files\image.bat" D:\MsiInstallc:\gmserver\upgrade "c:\gmserver\upgrade\misc"

If the MsiInstall directory is copied to the example directory c:\upgrade_files, editimage.bat as follows:Pre-Process = /MIN "Upgrade\Batch Files\image.bat" c:\upgrade_files\MsiInstallc:\gmserver\upgrade "c:\gmserver\upgrade\misc"

Page 47: SAP Point of Sale 2.0 SAP Transactionware GM 10.0

Upgrade Guide

October 2008 47

Edit C:\GMServer\Upgrade\Misc\upgrade.ini. This file should have a valid IP addressfor your server, the correct database engine type and the correct database servername. Editing is not usually necessary for the IP address and host names, these arereplaced by the deployment batch files at deployment time. Application paths andoptions are not replaced at deployment time.

The semicolon ‘;’ is used for commenting out a line in any upgrade *.ini file. Edit C:\GMServer\Upgrade\Batch Files\apppatch.bat in the SET VARIABLES section

to reflect the correct path names for your system. This batch file is preconfigured withinstallation defaults.

Edit C:\GMServer\Upgrade\Batch Files\appupg.bat in the SET VARIABLES sectionto reflect the correct path names for your system. This batch file is preconfigured withinstallation defaults.

Edit Serverdeploy.bat and GO.bat only if the installation paths for the POSapplications are not the default locations for versions 10.0 and 10.1

Use SAPCAB to repackage the files you edited in the C:\GMServer directory. Your updatedfiles should be in the original directory structure found in the distributed server.cab file.

Use the following steps to repackage the files for deployment:

1. Copy your files to a clean media, such as a USB drive.

2. Copy all files and the entire directory structure underneath the C:\GMServerdirectory

3. Change directory to your repackaging media and execute:

SAPCab /C c:\server.cab /F *.*