KDS install and setup guide
© Copyright 2013, LS Retail ehf. All rights reserved. All trademarks belong to their respective holders
Contents
1 Introduction 3
2 System overview 3
3 Kitchen service install 4
3.1 Step by step system setup 4
3.2 Database 4
3.3 Kitchen service 4
4 Kitchen display install 4
5 Kitchen service setup 4
5.1 Configuration file 4
6 Kitchen display setup 6
6.1 Running more than one Kitchen display on one machine 6
6.2 Running a single Kitchen display 6
6.3 Setting up the Kitchen Service connection 7
7 Troubleshooting 8
7.1 I have updated back office data but the data does not update on Kitchen Displays 8
7.2 Kitchen Display: Unable to connect to server. Retrying ... 8
7.3 Kitchen Display running but no orders are received 8
7.3.1 POS => Kitchen Service: 8
7.3.2 Kitchen Service => Kitchen Display 8
7.4 Kitchen Display not starting 9
7.5 Kitchen Service giving an database access error 9
7.6 Log files 9
LS Retail ehf.
Katrinartun 2, 105 Reykjavik, Iceland
Tel: +354 414 5700 Fax: +354 571 2728
KDS install and setup guide
1 Introduction
This guide walks you through the install and setup of the Kitchen Display System. After completing this guide you will have a fully functional system for sending orders from the POS and have them appear on any number of display stations.
2 System overview
Display station (DS): Shows orders from any number of POS. Which orders and which items it displays depends on routing settings.
Kitchen service (KS): Receives orders from any number of POS and routes them to any number of Kitchen displays.
3 Kitchen service install
3.1 Step by step system setup
1. Attach the KDS_HRC database to your 2012 (Express/full) SQL Server (chapter 3.2)
2. Install the Kitchen Service (chapter 3.3)
3. Install the Kitchen displays (chapter 4)
4. Send configuration to the Kitchen Service. You will need to input the database information of the system (chapter 5.1)
5. Set up each of your Kitchen Displays. Go through chapter 6 from start to finish.
3.2 Database
In the setup documents there is a database file KDS_HRC that need to be imported into your SQL Server. This is a SQL Server 2012 database so you need to have SQL Server 2012 installed on your computer. To be able to attach the database you need to save the database files to a folder on the C: drive on your computer.
3.3 Kitchen service
Run the Kitchen service setup.exe file that is included. Go through the typical installation wizard steps. This should only be performed on a single machine, the machine that hosts the service.
4 Kitchen display install
Run the Kitchen Display Station Setup.exe file that is included. Go through the typical installation wizard steps. Do this for every machine that is going to run a kitchen display.
5 Kitchen service setup
5.1 Configuration file
After the Kitchen service has been installed it needs to be told which database to talk to. To do this you run the file Configuration Tool.exe that is included in the kitchen service install folder. You will see the following window
Here I have assumed that the setup is being performed on the same machine as the Kitchen Service is running on. These settings will depend on each machines configuration.
· Test connection button: This button checks to see if the Kitchen Service is running on the given host. It does not check any database connections.
· Config management: Here the database configuration information needs to be entered.
o Database host: Usually this is local host but if you have a named instance of your database you need to include that to, i.e localhost\”NAMEOFINSTANCE”
o Database name: Here you enter the name of the database. In this case it is KDS_HCR.
o Database user: Enter the login for the sa user of the database. (Skipp if windows authentication is selected)
o Database password: Enter the password for the sa login to your database. (Skipp if windows authentication is selected.)
· Get config button: Gets the current configuration on the Kitchen Service. (Do not select at this time)
· Send config button: Sends the inputted settings to the Kitchen Service and then restarts the Kitchen Service.
· Debug level: When the system is first being set up this should be set to Trace since it will make it easiest to detect issues. When the system is up and running this should be reset to Error.
ATTENTION: If you select Use windows authentication you might run into trouble because the Kitchen Service might not run as the logged in user that is installing the system. What this means is that the Kitchen Service might not have access to the database. This can be fixed by either changing the user that is running the Kitchen Service or using a specific database user instead of using windows authentication.
6 Kitchen display setup
Chapters 6.1 and 6.2 explain how to set up a single Kitchen Display. You will have to go through them for each Kitchen Display you need to set up.
6.1 Running more than one Kitchen display on one machine
These steps are only required if you plan on running multiple Kitchen Displays on a single machine. If each Kitchen Display has its own machine, go to chapter 6.2.
In the Kitchen Display install folder you will find the file KitchenDisplayStation.exe. You will need to create one shortcut to this file for each Kitchen Display that this machine should run. For example if the machine should run two Kitchen Displays you create two shortcuts to the KitchenDisplayStation.exe file. Name them descriptive names of the stations each shortcut should run.
For each shortcut you will need to:
· Add a command line parameter describing the station that this shortcut should run. Below you see a screenshot of a shortcut that has the added parameter ‘GRILL’. The parameter is set in Target box outside the quotes. Don‘t forget to add a space.
· Run and go through chapter 6.3
6.2 Running a single Kitchen display
In the Kitchen Display install folder you will find the file KitchenDisplayStation.exe. Run this file and continue with chapter 6.3.
6.3 Setting up the Kitchen Service connection
When a Kitchen Display is run for the first time you need to tell it where it can find the Kitchen Service and which station it should be.
You will get the following window when you run the Kitchen Display
Here you need to tell the Kitchen Display where it can find the Kitchen Service (Kitchen Service Host) and which port it is running on (Kitchen Service port). The default port is 17750 and you will probably not have to change it.
Store Id is for logging purposes.
Kitchen Display Id: The ID of the Kitchen Display that this station should run. If you have filled out the Kitchen Service host and Kitchen Service you can click the drop down to the far right and you will get a list of available Kitchen Displays.
Set connection button confirms the selection and runs the Kitchen Display station
7 Troubleshooting
This chapter contains common setup issues and possible solutions. For extra debugging information see the Log files described below.
7.1 I have updated back office data but the data does not update on Kitchen Displays
The Kitchen Service caches the data it uses. When the underlying data is changed then the Kitchen Service has to be restarted to force it to use the new data. Caching is used to improve performance.
7.2 Kitchen Display: Unable to connect to server. Retrying ...
Chapter 6 explains setting up the Kitchen Displays. The Kitchen Display connection information is stored in file
C:\ProgramData\LS Retail\KitchenDisplayStation\Configurations.xml
Take a look at this file to see where the Kitchen Display expects to find the Kitchen Service. If this information is correct then make sure that the Kitchen Service is running (you can do this by using the Test connection button shown in chapter 5.1. If the Kitchen Service is indeed running then the problem is probably network related. Make sure that the Kitchen Display machine can see the Kitchen Service machine on the network.
7.3 Kitchen Display running but no orders are received
This issue can be caused by two factors. Either POS is not sending the orders to the Kitchen Service or the Kitchen Service is not sending the orders to the Kitchen Displays.
7.3.1 POS => Kitchen Service:
To see if the POS is sending orders to the Kitchen Service you need to make sure debug level is set to Trace in the Kitchen Service config (set up in chapter 5.1). When this is done the Kitchen Service will log down each order it receives from POS’s in its log files (chapter Log files). A Kitchen Service log file will have a name like KitchenService.exe-2524-1 and in the newest Kitchen Service log file you should see a line similar to this
2013-01-08 19:03:03:354 0225 2 New Order:[OrderId]. Items: [#Items]
If no such line exists then the POS is not sending orders to the Kitchen Service. This can be caused by a number of issues such as the Kitchen Service being offline, the POS not being network connected or maybe the POS does not know the location of the Kitchen Service
7.3.2 Kitchen Service => Kitchen Display
The other scenario is that the Kitchen Service is for some reason not sending orders to the Kitchen Displays. There are a few reasons this could be happening. Maybe the item routing has not been set up correctly. If the routing logic is not at fault then there might be a network issue. Just like in the previous scenario you can take a look the Kitchen Service log files to see if the Kitchen Service is sending orders to the Kitchen Displays. Here we have a sample log file
2013-01-08 19:03:03:354 0225 2 New Order: KOT100001. Items: 6
2013-01-08 19:03:04:302 0006 4 Send orders (1) to KDS ‘GRILL’ on host ‘POS HOST’. Total number of items: 6
Here we see that the Kitchen Service is receiving an order and then sending it to station GRILL.
7.4 Kitchen Display not starting
This can happen because another user created the configuration file of the Kitchen Display and thus has it locked to that user. This can be fixed by deleting the configuration file located in C:\ProgramData\LS Retail\KitchenDisplayStation\Configurations.xml.
Deleting this file will re-trigger the Kitchen Service connection described in chapter 6.3.
7.5 Kitchen Service giving an database access error
If the log files indicate that the Kitchen Service is unable to access the database the most probable cause is that the user running the Kitchen Service does not have access to the database. This can be fixed either by changing the user running the Kitchen Service or by changing the Kitchen Service from running on use windows authentication to running on a specific database user that has access to the database .
7.6 Log files
The log files for the Kitchen Service are located in the folder C:\ProgramData\LS Retail\Kitchen\Log
Chapter 7 - Troubleshooting 9