installation guide - squirrel systemstechweb.squirrelsystems.com/mainsite/documentation/... · qsr...

Version 3.1

Installation Guide

QSR Automations, Inc. 2301 Stanley Gault Parkway Louisville, Kentucky 40223

Tel: 502-297-0221 Fax: 502-297-0223

www.qsrautomations.com

Version: 3.1

Date Revised: 11/30/2009

The information in this publication is subject to change without notice.

QSR AUTOMATIONS INCORPORATED SHALL NOT BE LIABLE FOR TECHNICAL OR EDITORIAL ERRORS OR OMISSIONS CONTAINED HEREIN, NOR FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES RESULTING FROM THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL. THIS INFORMATION IS PROVIDED “AS IS" AND QSR AUTOMATIONS INCORPORATED DISCLAIMS ANY WARRANTIES, EXPRESS OR IMPLIED OR STATUTORY AND EXPRESSLY DISCLAIMS THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR PARTICULAR PURPOSE, GOOD TITLE AND AGAINST INFRINGEMENT.

This publication contains information protected by copyright and is considered confidential. No part of this publication may be photocopied or reproduced in any form without the prior written consent from QSR Automations Incorporated.

© 1996-2009 QSR Automations Incorporated.

All rights reserved. Printed in the U.S.A.

QSR Automations, the marks QSR Automations, ePic, ConnectSmart, eXpert, and KP-4000 are registered trademarks or trademarks of QSR Automations, Inc.

Elo and MicroTouch are registered trademarks of their respective companies.

Window 95, 98, NT, 2000, and XP are registered trademarks of Microsoft Corporation.

Other products mentioned herein may be trademarks and/or registered trademarks of their respective companies.

Table of Contents BEFORE YOU BEGIN 1 ......................................................................................................................... 1

Introduction ............................................................................................................................................ 1 System Requirements ............................................................................................................................. 1

BackOffice Computer – Stand‐alone .................................................................................................................... 2 BackOffice Computer – With Hostess Client ........................................................................................................ 3 Hostess Client – Stand‐alone ............................................................................................................................... 4 Hostess Mobile .................................................................................................................................................... 4 Kitchen Client ....................................................................................................................................................... 5 CSK Server ............................................................................................................................................................ 5

INSTALLING BACKOFFICE 2 ................................................................................................................. 6

Introduction ............................................................................................................................................ 6 Permissions ............................................................................................................................................. 6

Turning off File Sharing ........................................................................................................................................ 6 Allowing Full Control ............................................................................................................................................ 7

Installation Steps .................................................................................................................................. 10 Print Spooler ......................................................................................................................................... 18 Windows Services ................................................................................................................................. 19

Reinstalling the Service ...................................................................................................................................... 19

INSTALLING CONTROLLERS 3 ......................................................................................................... 21

Introduction .......................................................................................................................................... 21 DX‐2000 eXpert Controller .................................................................................................................... 21

USB .................................................................................................................................................................... 21 PS/2.................................................................................................................................................................... 22 Serial .................................................................................................................................................................. 22 VGA .................................................................................................................................................................... 22 Network ............................................................................................................................................................. 22 Sound ................................................................................................................................................................. 22

DE‐4100 ePic CE Controller ................................................................................................................... 22 USB .................................................................................................................................................................... 22 PS/2.................................................................................................................................................................... 23 Serial .................................................................................................................................................................. 23 VGA .................................................................................................................................................................... 23 Network ............................................................................................................................................................. 23

Power Supply ........................................................................................................................................ 23

INSTALLING KITCHEN CLIENT 4 ......................................................................................................... 25

Introduction .......................................................................................................................................... 25 eXpert – Win32 (XP) Kitchen Client ....................................................................................................... 25

Folder Structure ................................................................................................................................................. 25 Requirements .................................................................................................................................................... 25

ePic CE – Kitchen Client ......................................................................................................................... 26 Folder Structure ................................................................................................................................................. 26 Requirements .................................................................................................................................................... 26

INSTALLING CSK SERVER 5 ............................................................................................................... 28

Introduction .......................................................................................................................................... 28 Installation Steps .................................................................................................................................. 28

INSTALLING HOSTESS CLIENT 6 ........................................................................................................ 33

Table of Contents i

QSR Automations, Inc. ConnectSmart 3.1 Installation Guide

Table of Contents ii

Introduction .......................................................................................................................................... 33 Installation Steps .................................................................................................................................. 33 Requirements ........................................................................................................................................ 37

ConnectSmartNetwork.xml ............................................................................................................................... 37 Images ............................................................................................................................................................... 37

INSTALLING PRINT CLIENT 7 ............................................................................................................. 38

Introduction .......................................................................................................................................... 38 Win32 Print Client ................................................................................................................................. 38

Folder Structure ................................................................................................................................................. 38 Requirements .................................................................................................................................................... 38

WinCE Print Client ................................................................................................................................. 39 Folder Structure ................................................................................................................................................. 39 Requirements .................................................................................................................................................... 40

INSTALLING PAGER INTERFACE 8 ..................................................................................................... 42

Introduction .......................................................................................................................................... 42 Installation Steps .................................................................................................................................. 42 Requirements ........................................................................................................................................ 46

ConnectSmartNetwork.xml ............................................................................................................................... 46

INSTALLING HOSTESS MOBILE DEVICES 9 ......................................................................................... 47

Introduction .......................................................................................................................................... 47 Setup for Hostess Mobile Handheld Devices ......................................................................................... 47 Wireless Network Connection for Handheld Devices ............................................................................ 48

APPENDIX A – EPIC VIDEO CONTROLLER .............................................................................................. 50

Model DE‐4100 ..................................................................................................................................... 50

APPENDIX B – EXPERT VIDEO CONTROLLER .......................................................................................... 51

Model DX‐2000 ..................................................................................................................................... 51

APPENDIX C – NETWORK CONFIGURATION .......................................................................................... 52

Overview ............................................................................................................................................... 52 General Settings ................................................................................................................................... 53 Application Configurations ................................................................................................................... 55

INDEX .................................................................................................................................................. 56

Before You Begin 1 Introduction

Your QSR ConnectSmart applications come on two installation discs. One disc installs BackOffice, which is driven by Microsoft’s SQL Server Express and the .NET 3.5 Framework. ConnectSmart Hostess connects to and shares data through the centralized BackOffice which can be installed on a primary and backup server for redundancy. ConnectSmart Kitchen (CSK) connects to and shares data through the CSK Server, which is installed (along with the Hostess Client and the Pager Interface) on the other installation disc.

NOTE: Since database backup does not occur with a blank database location, you must manually set Database folder permissions in order for database backup to work. It is recommended that you give Network Service full control permissions on the Database folder.

Figure 1.1 – ConnectSmart Software Installer - BackOffice

System Requirements Before performing the BackOffice and client installations, make sure that all of your hardware meets the minimum system requirements for the applications you will be installing and using according to the following tables.

Keep in mind that these requirements apply to stations or computers that are dedicated to QSR applications. Consideration should also be given to the resource needs of other applications when the hardware used is not dedicated to the ConnectSmart application suite.

NOTE: All prerequisite software versions are specific to the ConnectSmart installation.

Chapter 1 – Before You Begin 1


BackOffice Computer – Stand-alone

Component Type/Amount

Prerequisite Software Microsoft .NET Version 1.0.3705 or Microsoft .NET Version 1.1 (required by Site Manager)

Microsoft .NET Version 3.5

Microsoft Internet Explorer 6.0 Service Pack 1 or later (prerequisite for .NET)

RAM Minimum: 1 GB

Recommended: 2 GB

Display 1024x768

Hard Disk Space 2 GB free space

Processor Pentium 4 compatible or higher

Minimum: 1.4 GHz

Recommended: 1.8 GHz or higher

Operating System Windows XP SP2

Windows 2003 Server SP1

Windows Vista

Table 1.1 – BackOffice Stand-alone requirements



BackOffice Computer – With Hostess Client


Prerequisite Software Microsoft .NET Version 1.0.3705 or Microsoft .NET Version 1.1 (required by Site Manager)

Microsoft .NET Version 3.5

Microsoft Internet Explorer 6.0 Service Pack 1 or later (prerequisite for .NET)

RAM Minimum: 1.5 GB

Recommended: 2 GB

Video 1024x768 resolution Minimum: 32 MB RAM Recommended: 64 MB RAM

Hard Disk Space 2GB free space


Minimum: 1.5 GHz

Recommended: 2 GHz or higher



Windows Vista

Table 1.2 – BackOffice with Hostess Client



Hostess Client – Stand-alone


Prerequisite Software Microsoft .NET Version 3.5

RAM Minimum: 512 MB

Recommended: 1GB

Hard Disk Space 600 MB free space

Video 1024x768 resolution, Minimum: 32 MB RAM Recommended: 64 MB RAM


Minimum: 1.4 GHz




Windows Vista

Table 1.3 – Hostess Client Stand-alone

Hostess Mobile


Handheld device Symbol MC50

Operating System Windows Mobile 2003 Second Edition

Table 1.4 – Hostess Mobile




Kitchen Client


Prerequisite Software (Win32 version only)

Microsoft .NET Version 1.1 (required by Station Manager) Microsoft CRuntime Library version 8.0 and Microsoft CRuntime Library version 8.0 service pack 1

RAM Minimum: 256 MB

Recommended: 512 MB

Processor Pentium III compatible or higher

Minimum: 266 MHz

Recommended: 500 MHz or higher



QSR WinCE Image

QSR eXP Image

Table 1.5 – Kitchen Client

CSK Server


Prerequisite Software Microsoft .NET Version 3.5

RAM Minimum: 1 GB

Recommended: 2 GB


Minimum: 1.4 GHz




Table 1.6 – CSK Server requirements

Installing BackOffice 2 Introduction

The installation of the BackOffice is an essential step in using ConnectSmart applications. To use Hostess, BackOffice must be installed; it is the backbone of the Hostess applications. The BackOffice installation will install all of the necessary BackOffice application components as well as SQL Server 2005. Typically, the BackOffice is installed on a computer that resides in the restaurant’s management office. However, if Hostess is being used, the BackOffice can be installed on the Hostess touch screen station.

Permissions QSR recommends that you be logged into your PC with an administrative account before beginning BackOffice installation. If you have a limited account in Vista or restrictions set in XP, it is possible that BackOffice will not be able to connect to the database. Verifying administrative permissions is a two-stage process: turning off file sharing and allowing full control.

Turning off File Sharing 1. Click Start My Computer.

Figure 2.1—My Computer screen

2. Click Tools Folder Options. The Folder Options form appears. Click the View tab.

Chapter 2 – Installing BackOffice 6


Figure 2.2—Folder Options form – View tab

3. In the Advanced settings section, click to clear Use simple file sharing (Recommended).

4. Click OK.

Allowing Full Control 1. Go to C:\Program Files\Qsr Automations\ConnectSmart\BackOffice\

Database. 2. Right-click on BackOffice.mdf and select Properties. The BackOffice.mdf

Properties form appears.

Figure 2.3—BackOffice.mdf Properties form – General tab



3. Click the Security tab.

Figure 2.4—BackOffice.mdf Properties form – Security tab

4. Click Add. The Select Users, Computers, or Groups form appears.

Figure 2.5—Select Users or Groups form

5. Click Advanced. The Select Users, Computers, or Groups form appears with a Common Queries section.

6. Click Find Now or type sql and click Find Now. A list of users appears at the bottom of the form.



Figure 2.6—Select Users or Groups form with users

7. Select your user name, which will be written as SQLServer2005MSSQLUser$your PC user name$QSR01 and click OK.

8. On the previous Select Users, Computers, or Groups page, click OK. 9. On the Security tab of the BackOffice.mdf Properties form in the

Permissions section, select Allow for Full Control.

Figure 2.7—BackOffice.mdf Properties form – Security tab

10. Click OK.



NOTE: Do the same steps for the Metrics.mdf file, which is also located in C:\Program Files\Qsr Automations\ConnectSmart\BackOffice\ Database.

Installation Steps To begin the BackOffice installation, on installation disc 1, in the ConnectSmart Software Installer, click the “ConnectSmart BackOffice” link.

Figure 2.8—ConnectSmart BackOffice install link

With the latest release of Internet Explorer (IE 7), you may notice a bar at the top of the browser screen asking if you would like to allow active content. Right-click the bar and select Yes.

Click Run through any security warnings until the screen in Figure 2.10 appears.



NOTE: If you do not have .Net Version 3.5 installed, the following prompt appears.

Figure 2.9—.NET Framework prompt

Click OK. You can install .NET 3.5 from disk 1, which is located at: ..\DISC1\ ENGLISH\DOTNETFRAMEWORK3.5. Once this is installed, you will need to start the installation process from the beginning.

Figure 2.10—Welcome to ConnectSmart Setup Wizard

Click Next to continue through the ConnectSmart Setup Wizard. The License Agreement screen appears.



Figure 2.11—License Agreement screen

Please read the End-User Software License Agreement carefully. After reading the agreement, select I accept the terms in the license agreement and click Next.

Figure 2.12—Installation Path screen

Select the installation destination for the ConnectSmart software. QSR recommends you choose the default installation path. This can help with troubleshooting if you need to contact QSR Technical Support.

Note: All ConnectSmart applications have read/write access to the installation path.

Click Next to review installation settings.



Figure 2.13—Ready to Install screen

Review the installation settings that will be used to install BackOffice. To begin installation, click Next. To quit the installation, click Cancel.

Figure 2.14—Installation progress screen

ConnectSmart components are installed. You can see the progress of the installation.

If you are installing ConnectSmart for the first time, you will also need to install the SQL Server application. This part of the installation for the ConnectSmart components should take under a minute. Figures 2.16-2.19 show the SQL components install screens. If you are upgrading, you will not see these screens because SQL will already be installed. In that case, go to Figure 2.20 on page 16.

The necessary SQL Server files are auto-extracted into a temporary directory. This should also take under a minute.



Figure 2.15—SQL Server files extraction

After the SQL install files are extracted, the SQL Server install automatically begins, starting with the installation of prerequisite components.

Figure 2.16—Installing SQL Server prerequisites

When this process is complete, SQL Server Setup will scan your computer’s configuration to make sure it meets the minimum requirements for SQL Server 2005. If the component install process does not begin after this step, it means that your computer lacks the minimum SQL server requirements. In that case, review the minimum requirements tables in Chapter 1, beginning on page 2.



Figure 2.17—Scanning configuration for minimum requirements

Assuming your computer meets the minimum requirements, the SQL Server setup will continue by installing all of the components. This process will take several minutes.

Figure 2.18—SQL Server Installation

The SQL Server install is now complete. The SQLCSMD window appears.



Figure 2.19— SQLCMD window

During this time, the Crystal Reports XI R2 Client also installs.

Figure 2.20 — Crystal Reports XI R2 Client install screen

When the Crystal Reports install is complete, the Network Configuration application appears. For detailed information on the Network Configuration application, see Appendix C – Network Configuration on page 52.

Figure 2.21—Network Configuration for BackOffice



For Station ID, accept the default 0.

For Base Port, accept the default 32768.

Drag and drop the default IP address into the Local IP Address field.

For the applicable servers, enter the appropriate IP addresses. If you enter an IP address that is not compatible with that particular server, a warning icon will appear next to the IP address.

Figure 2.22—Warning for invalid IP address

Press Generate. The Network Configuration application appears with PrintSpooler as the application type.

Figure 2.23—Network Configuration for PrintSpooler






Press Generate. A network confirmation message appears.



Figure 2.25—Confirmation message

Click Yes.

Figure 2.26—BackOffice Installation complete screen

Click Finish.

Once installed, BackOffice will have added Print Spooler service entries into the Web Services Control Manager.

Print Spooler In addition to the BackOffice and SQL Server applications, the BackOffice installation will also install the Print Spooler, an application that you may or may not use. The Print Spooler is responsible for queuing and routing all print jobs to the appropriate Print Client applications. For more information on configuring the Print Spooler, see the ConnectSmart Kitchen Builder Pro User’s Guide or the ConnectSmart Hostess Builder Pro User’s Guide.

NOTE: Important Note for CSK 1.0 users: If you are running CSK 1.0 and using the Print Spooler in conjunction with the CSK 3.1+ Print Spooler, you will need to bind each Print Spooler to a separate IP Address. This can be accomplished by installing CSK 1.0 and CSK 3.1 on separate PCs or by configuring multiple IP Address to a single network card on one PC.

If running both applications on the same PC, make sure the CSK 3.1 Print Spooler service is started first by placing a dependency on it for the CSK 1.0 Print Spooler. For information on configuring multiple IP Addresses on a network interface card or placing dependencies on a Windows service, please see your Windows help documentation.



Windows Services In ConnectSmart 3.0, the QSR Process Monitor was installed as a Windows service as part of the ConnectSmart BackOffice and managed QSR application executables and maintains them as Windows services. Beginning with ConnectSmart 3.1, BackOffice along with the CSK Server, Print Spooler, and Pager Interface run as true, native Windows services.

When installed as a Windows service, these applications will default to “Manual” start and be set to run under the LocalSystem account.

To run servers as a process, as opposed to a service, right-click BackOffice.exe (and CSKServer.exe) and select Create Shortcut. Right-click the shortcut that you just created and select Properties. The Properties form appears.

Figure 2.27—BackOffice.exe Properties form – Shortcut tab

To run as processes (shown in the system tray the way it was done in ConnectSmart 3.0 and earlier), use “/p” in the command line. You can also add “/p” at the end of the path in the Target field on the Shortcut tab of the backOffice.exe Properties form.

NOTE: Make sure you put a space between the .exe” and the /p.

Reinstalling the Service During installation, the service was installed. If for any reason this does not occur, you will need to reinstall the service. Similarly, say you install the BackOffice software which creates the QSR ConnectSmart BackOffice service and the QSR ConnectSmart PrintSpooler service, but once the install is complete, you accidentally double-click, or start the installer again but then cancel it. At this point, the BackOffice and PrintSpooler services are removed (not the software, just the service). You can then take the following steps to reinstall the service.




1. Click Start Run. 2. Type the following in the new window (include the quotes):

“C:\Program Files\Qsr Automations\ConnectSmart\ BackOffice\Bin\BackOffice.exe” /i

3. Click OK. 4. Repeat the process for the following line (include the quotes):

“C:\Program Files\Qsr Automations\ConnectSmart\ PrintSpooler\Bin\PrintSpooler.exe” /i NOTE: To uninstall the service, follow these steps but use /u instead of /i.

Installing Controllers 3 Introduction

The QSR ConnectSmart Kitchen system can be configured with two different controllers (also known as video controllers): the DX-2000 eXpert controller and/or the DE-4100 ePic CE controller. You can configure and manage these controllers with applications that are developed for each specific type of controller.

For the eXpert controller, you can utilize the Site/Station Manager application to configure and manage these controllers in the kitchen environment. See the eXpert Site Manager User’s Guide for more information on installing and using the Site Manager application to manage eXpert devices.

If ePic CE controllers are used in the installation, you can utilize the QSR CE Device Console to configure how these controllers behave in the kitchen environment. See the CE Device Console User’s Guide for more information on using the QSR CE Device Console application for managing the ePic CE controller.

NOTE: Controllers may sometimes be referred to as devices.

DX-2000 eXpert Controller

Figure 3.1— DX-2000 eXpert controller

Unlike the ePic CE controller, the eXpert controller runs on a Windows XP Embedded operating system (OS) and has three USB ports (2 in front, 1 in back) and a multimedia sound port. The embedded Windows XP OS image is created and provided by QSR on all eXpert controllers.

USB The eXpert controller has 3 USB ports which will currently support a keyboard, mouse or Elo touch screen controller. (Additional drivers may be required.)

Chapter 3 – Installing Controllers 21


PS/2 The PS/2 connection supports standard PC keyboard, mouse or QSR bump bar. The QSR bump bar can be used with up to 100 feet of PS/2 cable.

Serial The 9 pin serial port is defined in the embedded XP OS as COM 2. Currently the serial port can support certain models of impact and thermal receipt printer as well as a serial Elo touch screen controller. (Additional drivers may be required.)

VGA The standard VGA port is used to connect to any VGA compatible display device. The eXpert controllers support resolutions of 800x600 and 1024x768.

Network The eXpert’s network interface uses an onboard Intel network chip supporting network speeds of 10/100 MB at full duplex.

Sound The sound port can be used to connect standard PC compatible speakers for use with multimedia applications.

DE-4100 ePic CE Controller The DE-4100 ePic CE controller operates on the Windows CE OS environment and has USB capability. Unlike the eXpert controller, this controller does not have multimedia capability. The Windows CE OS image is created and provided by QSR on all ePic CE controllers

Figure 3.2—DE-4100 ePic CE controller

USB The ePic CE controller has three USB ports which will currently support a keyboard, mouse or Elo touch screen controller (additional drivers may be required).



PS/2 The PS/2 connection supports standard PC keyboard, mouse or QSR bump bar. The QSR bump bar can be used with up to 100 feet of PS/2 cable.

Serial The 9-pin serial port is defined in the Windows CE operating system as COM 1. Currently the serial port can support certain models of impact and thermal receipt printer as well as a serial Elo touch screen controller (additional drivers may be required).

VGA The standard VGA port is used to connect to any VGA compatible display device. The ePic CE controller supports resolutions of 800x600 and 1024x768.

Network The ePic CE’s network interface uses an onboard Intel network chip supporting network speeds of 10/100 MB at full duplex.

NOTE: A hub connects multiple controllers. These can be eXpert or ePic controllers or a mix of both. Only one monitor can be run by a single controller, but a video splitter can be used to view two monitors. Both of these monitors, though, would show and bump the exact same thing since only one routing scheme and one bump bar are assigned to each controller.

Power Supply The power supply connection is standard on both controllers (ePic CE and eXpert). It is a self-locking plug mechanism that will prevent the power cable from easily disconnecting. To install, simply match up the prongs in the connector to the port on the back of the controller.

Figure 3.3 - QSR controller power connection

To unlock the power connector, pull back on the square-shaped locking mechanism and pull the three pronged connector out of the power connector on the controller as seen in Figure 3.4.



Figure 3.4 – Disconnecting the QSR controller power connector

NOTE: – It is important that only QSR power supplies be connected to the eXpert or ePic CE controllers. Use of any other power supply can damage the main board and render the controller inoperable.


Installing Kitchen Client 4 Introduction

QSR Automations provides two versions of its Kitchen Client executable: one version is designed for Windows XP, and the other is designed for Windows CE operating systems. As previously stated, the installation of Kitchen Client varies depending on which QSR controller (ePic CE or eXpert) is utilized in the installation and whether or not the Site Manager application or the CE Device Console is used to manage the controllers.

Those applications are not required but facilitate setup and configuration of the controllers. More information on the use of Site Manager and QSR CE Device Console can be found in their respective user guides. This chapter covers the manual setup and configuration of each QSR controller type.

eXpert – Win32 (XP) Kitchen Client The Win32 (XP) based Kitchen Client application was designed for the QSR eXpert controller but will run on any Windows PC meeting the specs of the application. This section lists the directory structure and necessary files required to run the Kitchen Client applications. For specifications on the QSR eXpert video controller, see Appendix A beginning on page 50.

Folder Structure To manually install the Kitchen Client application, create the following folder structure on the compatible Windows PC or QSR eXpert controller:

..\ConnectSmart

..\ConnectSmart\KitchenClient

..\ConnectSmart\KitchenClient\Bin

..\ConnectSmart\KitchenClient\Data

..\ConnectSmart\KitchenClient\Log

Requirements QSR provides the following files be placed in the Bin folder referenced above:

• KitchenClient.exe

• zlib.dll

Both of these files are included on the ConnectSmart installation disk(s). In addition, the kitchenclient.exe requires an xml file called ConnectSmartNetwork.xml in the Data folder. This file will also typically be included with the installation disk. However, it will likely need to be manually edited to change the local IP address, and it must be saved in Unicode format.

Chapter 4 – Installing Kitchen Client 25


Figure 4.1 is an example of a ConnectSmartNetwork.xml file. This file defines the local IP address and station ID for the kitchenclient.exe to use. It also “points” the application to the IP address of the BackOffice(s).

Figure 4.1 – ConnectSmartNetwork.xml file

NOTE: Any time new settings are configured in Kitchen Builder Pro, both the BackOffice and Kitchen Client applications must be restarted.

ePic CE – Kitchen Client The WinCE based Kitchen Client application was designed and certified for the QSR ePic CE controller. This section lists the directory structure and necessary files required to run the Kitchen Client CE applications. For specifications on the QSR ePic CE controller, see Appendix B beginning on page 51.

Folder Structure To manually install the Kitchen Client application, create the following folder structure on the compatible Windows PC or QSR eXpert controller:

..\ConnectSmart

..\ConnectSmart\KitchenClient

..\ConnectSmart\KitchenClient\Bin

..\ConnectSmart\KitchenClient\Data

..\ConnectSmart\KitchenClient\Log


• KitchenClientCE.exe

• zlib.dll

• msvcr80.dll

These files are included on the ConnectSmart installation disk(s). In addition to the previous requirements, the KitchenClientCE.exe requires the ConnectSmartNetwork.xml file in the Data folder referenced previously. This



file will also typically be included with the installation disk. However, it will likely need to be edited manually, and it must be saved in Unicode format.

Figure 4.2 is an example of a ConnectSmartNetwork.xml file. This file defines the local IP address and station ID for the kitchenclient.exe to use. It also “points” the application to the IP address of the BackOffice(s). This file is identical to the ConnectSmartNetwork.xml file used by the Win32 Kitchen Client.

Figure 4.2 – ConnectSmartNetwork.xml file

NOTE: Keep in mind that any time new settings are configured in Kitchen Builder Pro, both the BackOffice and Kitchen Client applications must be restarted.


Installing CSK Server 5 Introduction

The CSK Server is new to ConnectSmart 3.1. It powers all Kitchen applications and communicates directly with the SQL server database. When the CSK Server starts, it gets all of its XML settings from the CSK Server\Data folder. Then when client applications are started, they connect to the CSK Server and receive their respective XML settings directly from the CSK Server.

This centralized architecture of ConnectSmart allows the client applications to share data and information collected by the CSK Server and/or stored in the SQL Server database. See the CSK Server User’s Guide for more information.

NOTE: In order to use Kitchen Clients, you will need to run the CSK Server.

Installation Steps To begin the CSK Server installation, on installation disk 2, in the ConnectSmart Software Installer, click the ConnectSmart Kitchen Server link.

Figure 5.1—ConnectSmart KitchenServer install link

Click Run through any security warnings until you see the Welcome screen.

Chapter 5 – Installing CSK Server 28


Figure 5.2—Welcome to CSK Server Setup Wizard

Click Next to begin the CSK Server Setup Wizard. The License Agreement screen appears.

Figure 5.3—License Agreement screen

Please read the End-User Software License Agreement carefully. After reading the agreement, select I accept the terms in the license agreement and click Next. The Destination Folder screen appears.



Figure 5.4—Destination Folder screen

Select the directory to install ConnectSmart Pager Interface. It is recommended that you use the default directory: C:\Program Files\QSR Automations\ConnectSmart\. Click Next to continue. The Ready to Install screen appears.

Figure 5.5—Confirm CSK Server Installation

The installer is now ready to install the Pager Interface. Click Next to start the installation. The installation of the CSK Server should take under a minute. To quit the installation, click Cancel.



Figure 5.6—Installation progress

You can see the progress of the installation. The Network Configuration application appears. For detailed information on the Network Configuration application, see Appendix C – Network Configuration on page 52.

Figure 5.7—Network Configuration form








Press Generate.

A confirmation message appears.


Click Yes. When it has finished, the Setup Wizard Complete screen appears.

Figure 5.10—Confirm CSK Server Installation

CSK Server installation is now complete. Click Finish.


Installing Hostess Client 6 Introduction

The installation of the Hostess Client is only necessary if ConnectSmart Hostess is being utilized. If only ConnectSmart Kitchen is being used, skip this installation. The primary purpose of this installation is to create the HostessClient.exe (and all associated files) which is designed to run on a touch screen device. The Hostess Client installation should be run on every touch screen station that is going to run the Hostess software.

Installation Steps To begin the Hostess Client installation, in the ConnectSmart Software Installer, click the ConnectSmart Hostess Client link.

Figure 6.1—Hostess Client Install Link


Chapter 6 – Installing Hostess Client 33


Figure 6.2—Welcome to Hostess Client Setup Wizard

Click Next to begin the Hostess Client Setup Wizard setup. The Destination Folder screen appears.

Figure 6.3—HostessClient Destination Folder screen

Select the directory to install the Hostess Client. It is recommended that you use the default directory: C:\Program Files\QSR Automations\ConnectSmart.

Click Next to continue. The Ready to Install screen appears.



Figure 6.4—Ready to Install screen

Review installation settings that will be used to install the Hostess Client. To begin installation, click Next. To quit the installation, click Cancel.

Figure 6.5—HostessClient Installation

The installation of Hostess Client should take under a minute. The Network Configuration application appears. For detailed information on the Network Configuration application, see Appendix C – Network Configuration on page 52.



Figure 6.6—Network Configuration form

Enter a station ID that matches the ID on the Hostess Terminals form in Hostess Builder Pro.





Press Generate.



Click Generate. When it has finished, the Setup Wizard Complete screen appears.



Figure 6.9—HostessClient Installation Complete screen

After the installation is complete, click Finish to exit.

Requirements

ConnectSmartNetwork.xml Like the Kitchen Client, the Hostess Client also requires an xml data file to define the local IP address for the client to use as well as the station ID for that instance of the Hostess Client. Additionally it defines the IP address of the BackOffice(s) so that a connection can be established between the two.

Once a valid connection is made, the xml configuration files created in the Hostess Builder Pro will be streamed across the network to the client application. The ConnectSmartNetwork.xml file used by Hostess Client will be located in the ..\ConnectSmart\HostessClient\Data folder.

NOTE: If you already have the Hostess Client installed, and you are upgrading to a newer version, the Hostess Client installer will recognize that the ConnectSmartNetwork.xml file exists and display a pop-up message informing you that the installer will not attempt to overwrite it.

NOTE: Any time new settings are configured in Hostess Builder Pro, both BackOffice and Hostess Client applications must be restarted.

Images Any non default image files used by the Hostess Client such as custom floor maps must be manually copied into the appropriate image folder used by the Hostess Client. Floor map images are located in the ..\ConnectSmart\HostessClient\Images\FloorViews folder.


Installing Print Client 7 Introduction

The Kitchen Client and the Hostess Client both support the use of receipt printers for added functionality. If receipt printing is used, it will be necessary to install the Print Client software on each device or station that will have a printer connected to it.

Much like the Kitchen Client software, there are separate Print Client executables designed for both the Win32 and WinCE environments. Printer functionality can be generated by devices without physical printers attached. However, it will be directed to a device or terminal with a printer and Print Client application running.

Each instance of the Print Client software establishes a connection to the PrintSpooler application which is installed as part of the BackOffice installation. See the ConnectSmart Kitchen Builder Pro User’s Guide or the ConnectSmart Hostess Builder Pro User’s Guide for more information on printer and PrintSpooler settings.

Win32 Print Client The Win32 based ConnectSmart Print Client application was designed for the QSR eXpert or any Windows PC meeting the specs of the host application. This section includes the directory structure and necessary files required to run the Print Client applications.

Folder Structure To manually install the Print Client application, create the following folder structure on the compatible Windows PC or QSR eXpert controller:

..\ConnectSmart

..\ConnectSmart\PrintClient

..\ConnectSmart\PrintClient\Bin

..\ConnectSmart\PrintClient\Data

..\ConnectSmart\PrintClient\Log


• PrintClient.exe

• zlib.dll

Chapter 7 – Installing Print Client 38


• Print Client also requires crtdll.dll. This file can be found in C:\Windows\System32…should the controller call for this file.

These files are included on the ConnectSmart installation disk. In addition to the previous requirements, the Printclient.exe requires an xml file called ConnectSmartNetwork.xml in the Data folder referenced previously. This file will also typically be included with the installation disk.

However, it will likely need to be edited manually, and it must be saved in Unicode format. Figure 6.1 shows an example of a ConnectSmartNetwork.xml file.

NOTE: The file format of the xml file differs slightly from the same file used by the Kitchen and Hostess Clients. The IP address tag should contain the IP address of the BackOffice machine that is running the PrintSpooler software.

Figure 7.1 – Print Client ConnectSmartNetwork.xml file

WinCE Print Client The WinCE based Print Client application was designed for the QSR ePic CE. This section lists the directory structure and necessary files required to run the Print Client applications.

Folder Structure To manually install the Print Client application, create the following folder structure on the compatible Windows PC or QSR eXpert controller:

..\ConnectSmart

..\ConnectSmart\PrintClient

..\ConnectSmart\PrintClient\Bin

..\ConnectSmart\PrintClient\Data

..\ConnectSmart\PrintClient\Log



Requirements QSR provides the following files be placed in the Bin folder referenced in the previous section:

• PrintClient.exe

• zlib.dll

• msvcr80.dll

NOTE: The Print Client CE also requires crtdll.dll. This file can be found in C:\Windows\System32…should the controller call for this file.

These files are included on the ConnectSmart installation disk. In addition to the previous requirements, the Printclient.exe requires an xml file called ConnectSmartNetwork.xml in the Data folder. This file will also typically be included with the installation disk. However, it will likely need to be edited manually and it must be saved in Unicode format.

NOTE: The file format of the xml file shown in Figure 7.1 differs slightly from the same file used by Kitchen and Hostess Clients. The IP address tag should contain the IP address of the BackOffice computer that is running the PrintSpooler software.

Like other ConnectSmart applications, you can use the Network Configuration application, ConnectSmartNetworkConfig.exe, to set up network configuration and IP addresses. For detailed information on the Network Configuration application, see Appendix C – Network Configuration on page 52.



Figure 7.2 – Network Configuration - PrintClient

Enter the station ID for the terminal.





Press Generate.



Click Generate. When it has finished, the Setup Wizard Complete screen appears.

Figure 7.5—PrintClient Installation Complete screen

After the installation is complete, click Finish to exit.


Installing Pager Interface 8 Introduction

Kitchen and Hostess Clients both support the use of paging devices. If paging devices are used, it will be necessary to install the Pager Interface software on each device or station that will have a paging transmitter connected to it. The Pager Interface does not run on an ePic CE controller; it must run on a Windows terminal or PC. See the ConnectSmart Kitchen Builder Pro User’s Guide or the ConnectSmart Hostess Builder Pro User’s Guide for more information on configuring pagers and paging transmitters.

Installation Steps To begin the Pager Interface installation, in the ConnectSmart Software Installer, click the ConnectSmart Pager Interface link.

Figure 8.1—ConnectSmart Pager Interface install link


Chapter 8 – Installing Pager Interface 42


Figure 8.2—Welcome to Pager Interface Setup Wizard

Click Next to begin the Pager Interface Setup Wizard. The Destination folder screen appears.

Figure 8.3—Destination Folder screen

Select the directory to install ConnectSmart Pager Interface. It is recommended that you use the default directory: C:\Program Files\QSR Automations\ConnectSmart\. Click Next to continue. The Ready to Install screen appears.



Figure 8.4—Confirm Pager Interface Installation

The installer is now ready to install the ConnectSmart Pager Interface. Click Next to start the installation.

Figure 8.5—PagerInterface Installation

The installation of the ConnectSmart Pager Interface should take under a minute. The Network Configuration application appears. For detailed information on the Network Configuration application, see Appendix C – Network Configuration on page 52.



Figure 8.6—Network Configuration - Pager Interface




In the Servers section, enter an IP address for the primary BackOffice. If you enter an IP address that is not compatible with the primary BackOffice, a warning icon will appear next to the IP address.


Click Generate.


When it has finished, the Setup Wizard Complete screen appears.



Figure 8.9—PagerInterface Installation Complete

Click Finish to exit the installation.

Requirements

ConnectSmartNetwork.xml Like the Client applications, the Pager Interface also requires an xml data file to define the IP address of the BackOffice(s) so that a connection can be established between the two.

Once a valid connection is made, the xml configuration files created in the Builder Pro applications will be streamed across the network to the Pager Interface. The ConnectSmartNetwork.xml file used by Pager Interface will be located in the ..\ConnectSmart\PagerInterface\Data folder.

Figure 8.10 – Pager Interface ConnectSmartNetwork.xml file


Installing Hostess Mobile Devices 9 Introduction

The Hostess Client supports a mobile client that runs on certain handheld Windows Mobile devices. The Hostess Mobile Client gives you remote access to some of the functions that are available on the desktop Hostess Client application such as greeting parties and assigning a table status.

Setup for Hostess Mobile Handheld Devices Complete the following steps to properly install software and set up Hostess Mobile handheld devices.

1. Install ActiveSync 4.1 software from C:\Program Files\Qsr Automations\ConnectSmart\ClientInstalls\HostessMobile\ActiveSync4.1 to the BackOffice computer.

2. Dock the Symbol device to its cradle. 3. Hook up the cradle to the BackOffice computer via a USB connection. 4. On the BackOffice computer, ActiveSync should automatically start up.

Choose the “Guest Partnership” connection type. (Standard syncs all contacts, etc.)

5. On the BackOffice computer, use Windows Explorer to view the mobile device file system. The handheld should appear as “Mobile Device” in Windows Explorer.

6. Copy cab files to the Temp folder in the handheld directory: My Computer \Mobile Device\My Windows Mobile-Based Device\Temp.

• C:\Program Files\Qsr Automations\ ConnectSmart\ ClientInstalls\HostessMobile \symbol.all.arm.cab. (This file is only required to be run the first time the handheld device is configured. However, if you are in doubt, run it. Repeating the install won’t hurt the device.)

• C:\Program Files\Qsr Automations\ ConnectSmart\ ClientInstalls\HostessMobile \ HostessMobile_PPC.ARMV4.CAB

7. On the mobile device, run the cab files located in the Temp folder. Start Programs File Explorer My Device Temp.

• Run symbol.all.arm.cab. (This file is only required to be run the first time the handheld device is configured. However, if you are in doubt, run it. Repeating the install won’t hurt the device.)

• Run HostessMobile_PPC.ARMV4.CAB. 8. Add the HostessMobile program to the main program menu by selecting it

in Start Settings Menus. 9. The HostessMobile folder in the ClientInstalls does not contain the

ConnectSmartNetwork.xml file, so copy the ConnectSmartNetwork.xml file from the ClientInstalls\KitchenClientWin32\ folder. This file needs to be edited. Specifically, three main tags need to be modified:

• StationId: This should be a unique number from any other Hostess Mobile device on the network. If you have two Hostess Mobile devices, one could have a StationId of 1 and the other could have a StationId of 2. The numbers do not need to be consecutive, do not have to start with 1,

Chapter 9 – Installing Hostess Mobile Devices 47


and do not need to take into consideration the StationId of any other devices or terminals (such as Kitchen, Hostess, or GuestView terminals). It must be a valid positive integer, however.

• IpAddress: The IpAddress should be the device’s IpAddress. • BasePort: In most cases, this value should be the default 32768 value.

Only if the BackOffice is running on a different BasePort will you need to change this value to match the value of the different BasePort.

10. Copy this file to My Computer \Mobile Device\My Windows Mobile-Based Device\Program Files\ HostessMobile\ Data.

11. Remove the handheld device from its docking cradle; connect to your wireless network; confirm the BackOffice application is running, and start up HostessMobile on the handheld (Start HostessMobile).

Wireless Network Connection for Handheld Devices You should already know how to start up your handheld device. To set up wireless connections on the handheld, perform the following steps. Note: Use a static IP address.

1. Set up your wireless network profile by selecting the connection icon

on the bottom right corner of the handheld main screen. Select Find WLANs.

2. Highlight the correct WLAN from the list and select Connect. 3. Set the static IP address for the handheld device on the IP Config tab within

the WLAN profile. 4. Choose OK to accept your changes. (Note: Changes must be saved within

the tab before going to another tab for editing. For example, save the IP changes made on the IP Config tab before moving to the Encryption tab. If changes are not saved, they are not retained once you leave the tab.)

5. Continue with other setup as required by your wireless network configuration, such as encryption and authentication. (Note: WPA authentication is strongly recommended.)

NOTE: Mobile devices do not need to be added as a Hostess terminal in Hostess Builder Pro. Similar to Table Scout pagers, it will work as long as the ConnectSmartNetwork.xml file is edited correctly




To help further illustrate these procedures, the following chart shows portions of the ConnectSmartNewtork.xml file mentioned in the previous steps. The ConnectSmartNetwork.xml file is case sensitive.

ConnectSmartNetwork.xml text Action <ConnectSmartNetwork.xml> <Header> <FileVersion>1</FileVersion> <CreationDateTime>2003-05-14T15:26:18.8158750-04:00</CreationDateTime>

</Header>

You do not need to make any changes to this section.

<StationId>1</StationId> StationId must be a positive integer that is unique from other Hostess Mobile devices.

<IpAddress>192.168.0.100</IpAddress> This must be the Hostess Mobile’s IP address.

<BasePort>32768</BasePort> Leave unchanged, unless the BackOffice is running on a different BasePort.

Appendix A – ePic Video Controller

Model DE-4100

Component Specification

Physical 1.75”x7.25”x6.88” (HxWxD)

Plastic Enclosure

Weight 1.0 lb

Power Supply External Switching Power Supply

Input: 100-240VAC, 50-60Hz

Output: 9VDC, 1.7A Regulated

Interfaces 1 Locking Power

1 PS/2 Keyboard

2 USB (Rear)

1 10/100 Network

1 RS232 Serial

1 VGA

Memory SD-RAM

File System Flash Memory

Operating Systems Microsoft Windows® CE

Environmental 10˚ to 50˚ Celsius

Certification FCC Part 15, Class A

EN55022 (1944) Class A

Table 1A – DE-4100 requirements

Appendix A – ePic Video Controller 50

Appendix B – eXpert Video Controller Model DX-2000

Component Specification

Physical 1.75”x7.25”x6.88” (HxWxD)

Plastic Enclosure

Weight 1.0 lb

Power Supply External Switching Power Supply

Input: 100-240VAC, 50-60Hz

Output: 9VDC, 1.7A Regulated

Interfaces 1 Locking Power

1 PS/2 Keyboard

3 USB (1 Rear, 2 Front)

1 10/100 Network

1 RS232 Serial

1 VGA

1 Audio Out

Memory 1 MB

File System Compact Flash

Operating System Microsoft Windows® XP Embedded

Environmental 10˚ to 50˚ Celsius

Certification FCC Part 15, Class A

EN55022 (1944) Class A

Table 1B – DE-4100 requirements

Appendix B – eXpert Video Controller 51

Appendix C – Network Configuration Use the ConnectSmart Network Configuration application to configure IP addresses for ConnectSmart applications. So, instead of going into the ConnectSmartNetwork.xml file and making multiple changes for each application, you can use the Network Configuration application to create all settings for that application at once. You can, however, still create settings and make changes in the ConnectSmartNetwork.xml.

Overview Use the Network Configuration application to set up IP addresses for:

• BackOffice • HostessClient • GuestView • Kitchen Server (CSK Server) • PagerInterface • PrintClient • Print Spooler • Host Client (HostAlert+)

After installing ConnectSmart, you will find the Network Configuration application (ConnectSmartNetworkConfig.exe) in C:\Program Files\Qsr Automations\ConnectSmart\ClientInstalls\ConnectSmartNetworkConfig.

Figure 1C – Location of Network Configuration

If you make changes to an application in its ConnectSmartNetwork.xml file, they will appear in the Network Configuration application, and if you make changes in the Network Configuration application, they will appear in the ConnectSmartNetwork.xml file.

Appendix C – Network Configuration 52


General Settings When you open the Network Configuration application, the Application Type field will now include a drop-down list.

Figure 2C – Application Type drop-down

Select the application whose settings you want to change. For each application type, only the servers that are needed by that application are available. Any unavailable check boxes are invalid for that application type. The most commonly used servers are automatically selected. (If you enter an IP address but clear its server setting - remove the check mark – although the IP address remains in the field dimmed, it is not saved.)

For example, if a user selects BackOffice, all check boxes are available, but only the Primary BackOffice, Primary Kitchen Server, and the Primary PrintSpooler are selected. If the secondary servers will be utilized, you can select them and modify the IP address field appropriately. As another example, the Hostess Client does not use the CSK Server, so these fields are unavailable and cannot be selected when the HostessClient application type is selected.

For Station ID, accept the default 0 unless you have selected HostessClient or HostClient. If you select either of those, you must enter a station ID that matches the ID on the Hostess Terminals form in Hostess Builder Pro or HostAlert+ Builder Pro.

For Base Port, accept the default 32768. Contact QSR Customer Support if you need to change this value.




NOTE: A computer may not have just a single IP address assigned to it. For example, if you have software which assigns two extra IP addresses, you would have a total of three network IP addresses. Only one is attached to a physical network card. In this case, you may need to change your Local IP Address.

For the applicable servers, enter the appropriate IP addresses. If you enter an invalid IP address, a warning icon will appear next to the IP address. Also, if the primary and secondary servers contain the same IP address, the same warning icon will appear next to the IP address field because the primary and secondary server cannot run on the same IP address.

Figure 3C—Warning for invalid IP address

Click Generate. A network confirmation message appears.

Figure 4C—Confirmation message

Click Yes.

NOTE: If a warning icon appears next to a field, move the pointer over the icon for more information.

Figure 4D—Error Messages




Application Configurations This chart offers a quick summary of what settings can and need to be configured for which applications. For instance, it will answer questions like When setting up a Kitchen Server (CSK Server), do I need a primary BackOffice?

These settings are easily discerned in the Network Configuration application because servers not needed for a particular application type cannot be selected.

Application Type Available Servers

BackOffice Primary BackOffice Primary Kitchen Primary PrintSpooler Secondary Kitchen* Secondary PrintSpooler*

Hostess Client Primary BackOffice Primary PrintSpooler Secondary PrintSpooler *

GuestView Primary BackOffice

Kitchen Server Primary BackOffice Primary Kitchen Primary Print Spooler Secondary Kitchen* Secondary PrintSpooler*

Pager Interface PrimaryBackOffice

Print Client Primary BackOffice Primary PrintSpooler Secondary PrintSpooler*

Print Spooler Primary BackOffice Primary PrintSpooler Secondary PrintSpooler*

Host Client PrimaryBackOffice PrimaryPrintSpooler SecondaryPrintSpooler*

* Denotes that the secondary is recommended but not required.

Table 1C—Applications and Settings

Index B

BackOffice Installation, 10 File Sharing, 6 Full Control, 7 Permissions, 6

BackOffice Requirements Stand Alone, 2 With Hostess Client, 3

C ConnectSmartNetwork.xml, 37, 46 Controllers, 21 CSK Server Requirements, 5

D DE‐4100 ePic CE Controller, 22 DE‐4100 ePic Controller Specifications, 50 Display Controllers, 21 DX‐2000 eXpert Controller, 21 DX‐2000 eXpert Controller Specifications, 51

H Handheld Devices

Setup, 47 Wireless Network Connection, 48

Hostess Client Installation, 33 Hostess Client Requirements

Stand‐Alone, 4 Hostess Mobile Devices, 47 Hostess Mobile Requirements, 4

I Installation

BackOffice, 10 DE‐4100 ePic CE Controller, 22 DX‐2000 eXpert Controller, 21 Hostess Client, 33 Kitchen Client, 25 Pager Interface, 28, 42 Path, 12 Print Client, 38

K Kitchen Client Installation, 25 Kitchen Client Requirements, 5

N Network Configuration, 52

P Pager Interface Installation, 28, 42 Power Supply, 23 Print Client Installation, 38 Print Spooler, 18

S System Requirements, 1

W Wireless Connection, 48

Index 56

installation guide - squirrel systemstechweb.squirrelsystems.com/mainsite/documentation/... · qsr...

Documents