Introduction and Abbreviations

The Kitchen Display Systems — hereinafter KDS — is the system for visual representation of order movement from the cash station to customers. KDS displays orders on monitors installed for cooks and waiters. Order movement can be controlled using touch-screen stations or a keyboard.

Abbreviations

1. The KDS server — dbmangr_RK7.exe, located in the Server folder
2. The KDS client — kdsclient.exe, located in the Client folder

Installing KDS 1.3.3.2

The initial installation is performed using the installer and then the current version is installed in the same place. Download the installer distribution kit from the FTP server: ftp://ftp.ucs.ru/r-keeper/KDS/1.3.0/KDS_1.3.3.2.exe
First, install KDS_1.3.3.2 and then upgrade it to the current version, 1.3.5.xx.

Create an XML interface at the manager station beforehand as it is required during installation.

To perform installation, run the installer and follow the instructions in the dialog windows.
If you have previously installed copies of KDS and Firebird, before the installation starts, you will have to choose between several options:

• To install a new KDS instance
• To delete an installed instance
• To upgrade an installed instance

If you want delete an installed KDS instance, select the required one.

While installing a new instance, do the following:

1. Accept the license agreement
2. Select the installation folder and specify the instance name
3. Select the components to be installed and the system for integration
   
   The following components are available:
   • Firebird 2.5.2
   • Server — the KDS server components. You should select the server version that is integrated with r_keeper — 6 or 7
   • Client — usually installed on the server and on client computers. If the KDS client is to be located on UCS controllers, it is installed separately
   • Statistics — additional components allowing to generate and print reports on KDS operations
   • Supervisor — additional components for cooking supervising and sorting of processed dishes
   • RK7tmsrv — terminal server components for working with KDS clients installed on UCS controllers. Select this item if you plan to use them
4. Specify the IP address and port for Firebird
5. If you have selected the RK7tmsrv component, specify the number of clients. The installer will create client folders to be used by the terminal server
6. Specify the cash server IP address and the port of the previously created XML interface
7. Choose the components to be installed as a service
8. Select the components to create the desktop icons for
9. Click Install

KDS 1.3.32 installation is now complete.

After installing, KDS cannot be installed as service. To run the server, use the dbmangr_RK7.exe file. To install the server as service, run dbmangr_RK7.exe with the /install key. This makes sense only after all the settings are done because a service cannot be configured.

Folder Structure after Installation

After installation, the structure of catalogs and their contents will be as follows:

• Client — KDS client files
• DB — the database and scripts
• Encoding — the folder containing the encoding utility
• Firebird — the folder containing the working copy of the Firebird database
• KDS Statistics — the folder containing the statistics and report utility
• RK7tmsrv — the folder containing the terminal server
• RK7tmsrv_Clients — the folder containing terminal clients
• Server — the folder containing the KDS server data
• Supervisor — the folder containing the Supervisor utility

KDS Upgrade

Below you can find a brief instruction. The detailed one is available in the article on KDS upgrade.

After installing version 1.3.x, upgrade KDS to the latest version. Download version 1.3.5 or later from FTP:ftp://ftp.ucs.ru/r-keeper/KDS/. To upgrade, it is enough to copy new files to the KDS installation folder (replacing previous files) and update the database.

Copy new files to the installation location. Confirm file replacement.

• Client
• Server
• RK7tmsrv if it is installed.

What remains is updating the database. For this purpose, the DB folder has the utility DBUpdate.exe. Run it and specify the Firebird database connection parameters: the IP address and port.

Press the Update DB button. If connection settings are indicated correctly and Firebird is launched, the database will be updated and you will see the text, "Update DB Complete".

In case you need to install or update Firebird, the folder containing the KDS that is located at the FTP has the distribution packages Firebird 2.5.7, x32/x64.

Upgrading an Older Database to Version 1.3.Х

To transfer data from databases of an older KDS format <1.2.x to a new one, the utility DBConverter.exe is used that is in the DB folder.

Before upgrading, install Firebird that can be found in the relevant distribution package. As a result, you will have two operating Firebird servers.
To upgrade, connect to the old database using the old Firebird server and to the new database using the newly installed server. The database to which data are going to be transferred must be empty.
Run the utility, indicate the path to the older database in the From section and new database settings in the To section.

Press the Convert Data button.

Important!

Starting from version 1.3.3.Х licensing to the current version is performed within one branch. When upgrading to the branch 1.3.4.Х or higher, you should perform an intermediate update to the first version of a new branch.

Licensing

In the KDS system, the server is licensed. The license name is R-Keeper KDS Module Software. Obtain the master license and generate the license key without the request code.
Run the file \server\dbmangr_RK7.exe. The server is launched in the minimized mode so click the icon in the tray two times to expand it. The server window will appear. Click the License button.

The server will connect to the licensing system, check the license, and activate the product if everything is fine. Instead of No License you will see your facility code and the license expiry date.

Licensing is complete.

Important: starting from version 1.3.4.7, the configuration file of the KDS server (dbmangr.ini) has changed

If the system was licensed before the update, copy the license key from the License string of the FSVDU.INI file

License=21184-10432-12135-21664-82834-11484-05367-40256

And insert it to dbmangr.ini. Save your changes and restart the server.

KDSGuard

The KDSGuard utility is designed to counter possible failures. It is in the \Server folder.
To launch in KDSGuard.ini, indicate the full path to the server dbmangr_RK7.exe. Save changes and run KDSGuard.exe.

Example of KDSGuard Working Configuration:

tiInterval=00:00:05
tiControlTime=00:01:30
tiMSgWaitTime=00:00:20
program1=   

V:\UCS\KDS\KDS\Server\dbmangr_RK7.exe   

If everything is configured correctly, the KDSGuard window will have the message, "Started...<path to the KDS server>" and no indication of errors.

Setup of connection to r_keeper_7

For the KDS to function, service print should be configured.

1. Open the KDS server. In the Server Name field, indicate the IP address of the POS server
2. KDS can handle only categories and not general classifications. Let us take service print as an example and create categories for it:
3. Distribute dishes on the menu by classification categories. The categories will appear in the menu on the right:
4. Select the required ones and press ОК
5. Return to the manager station. Create an interfaceand bind it to the server driver.
6. In the directory Settings > Parameters > Installation > Connection to Other Systems > KDS and VDU > Classification for KDS and VDU, indicate the reference to the KDS classification. In this case it is Service Print.
7. Check KDS layouts Go to the directory Settings > Print > Documents and Layouts > For KDS. Make sure that pre-installed layouts are added to the current print layout.
8. In the employee settings (POS restrictions), add the right Delete a Ready Dish.
9. Optionally, you can change the text that a waiter will see at the POS station. To do so, go to Settings > Parameters > Enterprise Operation Parameters > Messages to Waiters > Dish Readiness Message Textand indicate a required text in the Stringfield. For example: "Ready for %0;s" which means "Ready for table No."

Available parameters:

1. 1. %0:s is the table number
   2. %1:s is the category name for the KDS
   3. %2:s is the dish name

KDS Operations

For the KDS to operate, the following launched items are required:

1. Directory Server
2. POS Server
3. POS Station
4. KDS Server
5. KDS Client

Create an order the POS station. The KDS can work only in the order creation mode. The KDS does not function in the quick receipt mode. 
For an order to appear in the KDS, it must be saved and not closed. Create an order and press Save:

KDS Deletion

To delete the KDS, run the installer and select the item Deleting One of the Existing Copies

Database

In the \DB folder there is a ready-for-operation database (KDS.FDB) and a script (Kds.sql) for creating a similar empty database. You can work with the ready-to-operate database or create yours using the program IBExpert or the utility UPDConsol.exe from the folder \DB\UPВConsol\.

Below you will find out how to create a database using the utility UPDConsol.exe.
If needed, edit the file workscript.ini:

[DB]DB=   

KDS_NEW.FDB    

; the name of the database file that will be created by the script in the folder containing the utility   

CharSet=NONE                      

 ; the applied encoding. Must match the CharSet field of other INI files   

UserName=   

SYSDBA                     

; the database user name   

Password=   

masterkey                 

; the database user password    

 
Create=1
[Work]
Script =   

 KDS.sql    

  ; the script name for creating a new database. Can be found in the folder containing the utility   

ShowAfterError=30

Run the utility UPDConsol.exe to create a new database. The file KDS_NEW.FDB will appear in the folder containing UPDConsol.exe.