[toc]

1. Setup RK7 manager station

1.1. Adding drivers

1.1.1. Add an XML interface driver to the cash server and assign a port (obligatory the same as in "Addr=" parameter value in iPadServer.ini), pathway to the “XMLs” folder (if you want to log the interface), and password (if you want to encrypt the connection).
1.1.2. Do the same settings as in 1. of.

1.2. Report server link settings /deprecated

1.2.1. In the report server settings (it's better if this server is reference server), in the "XML interface" field, assign the port (obligatory the same as in "Addr=" parameter value in iPadServer.ini). No password obligatory.
1.2.2. Find additional information about the interface in 4.1.3. of http://support.ucs.ru/en/node/5670 .

 1.3. Adding new properties to the objects

1.3.1. Create eight basic extended RK7 object properties (Options -> Extended properties) as provided in 1.4. Note that all the fields are case-sensitive.

1.3.2. In "Types List" window you are able to add RK7 object types which objects should have those new properties.

1.3.3. Seven is a minimum properties quantity (for one GUI language). You have to create and fill in as many properties in different languages as you need to (see 1.4.8.).
1.3.4. Extended property system name consists of its name and language ident (exception: InfoWaite has no language ident) written one by one with no gaps (see examples in 1.4.).

1.4. Extended properties

1.4.1. InfoWaite

1.4.2. name0409

1.4.3. longComment0409

1.4.4. shortComment0409

1.4.5. Weight0409

1.4.6. TotalWeight0409

1.4.7. prompt0409

1.4.8. Other languages

1.4.8.1. To use more than one language in RK-Order user interface you should add your language strings to locres.xml file (or just take language ident if it is already there) and create more extended properties with those language idents in "Options" -> "Extended properties".
1.4.8.2. You are able to copy and paste 6 basic properties with language ident change from 0409 to specific language ident. You can see a languages list here https://www.autoitscript.com/autoit3/docs/appendix/OSLangCodes.htm

1.4.9. Description

1.4.9.1. There should be exactly 4 digit numeric language ident a part of System name (take it from locres.xml).

1.4.10. forClient

1.4.10.1. This property has 2 possible values: "1" - show on Rk-Order, and "0" - not to show (empty = "0").
1.4.10.2. On Rk-Order you will be able to choose only Courses with: "EnableForRkOrder" =1 and "Manually" enabled and "Draft" disabled.

1.5. Menu tree

1.5.1. In the Menu tree (Menu -> Menu Tree), create selector pages which will be displayed on the iPad. All the pages have to be created inside only one "Menu Tree" selector.

1.5.2. Then these selector pages to be filled with menu items and selector subpages, but not all of them are the same. "Initial choice" is the root page - all "menu groups" should be put to this one.

1.5.3. The "Menu Tree" selector must have pages of 3 levels obligatory. For that, as usually, you have to create pages of all levels inside the selector itself and add links to the lower level pages for the higher level pages.

1.5.4. The preset “Initial Choice” selector page is compulsory to be first level page. It is not a real (visible) selector page, it is like a root (selector itself for this external application use). In menu tree you might create another top level (start, initial) pages for other applications.

1.5.5. You have to create a number of second level selector pages ("menu groups"), they are for menu classification purpose. You will see these groups on the left panel of the iPad Rk-Order screen.
1.5.6. First and second level selector pages must have only selector pages inside (no menu items possible).

1.5.7. You have to create a number of third level selector pages ("menu subgroups"), they are for menu classification purpose.
1.5.8. Third level selector pages allow only menu items inside. You cannot add subpages there - add only Menu items.

1.5.9. No simple or combo menu items possible to be put inside “Initial Choice” (and obsolete “By Usage”) selector page.
1.5.10. After the menu tree is ready, all the second level selector pages are to be placed into the “Initial Choice”.
1.5.11. Also, for some other application use, second level pages can be placed to the obsolete “By Usage” selector "root" page. In this case, inside this application, they will be placed at the bottom of the left panel of menu screen form.
1.5.12. Those selector pages placed inside the “By Usage” (“By Usage” you have not to put inside “Initial Choice”) should not be placed inside the “Initial Choice” in order to avoid duplication.
1.5.13. If you can't understand 3 level selector pages structure, imagine file system: “Initial Choice” is like a disk drive root (for example, c:\), folders are 2 level selector pages, folders inside those folders are 3 level selector pages, and files inside 3rd level pages are menu items.

1.6. Check new obligatory properties

1.6.1. Check that all the objects of the types from 1.3.2. have got extended "name" (recommended).

1.6.2. The objects that you have put to "Menu Tree" selector must have the "Name" property in "Extended" section set (obligatory):

1.7. Menu items images

1.7.1. In order the user can assign menu items images which will be displayed in the Rk-Order application for the needed menu items, as long as change another application images, you have to put all the images to use in this iPad application to the folder \Images\ from 2.1.1.1.
1.7.2. Specify the pathway to the folder with images in the RK7 parameters (Options -> Parameters -> Installation -> Large images path).You have to enable "Large images path" parameter obligatory in order to set images for each menu item:

1.7.3. If the iPadServer is on the same computer where the RK7 reference server is, the folder with images should be inside the folder with the iPadServer.exe. If these servers are on different computers, image folders can be placed on both computers and should have identical pathway. Another way is to specify the network pathway to the images folder in the parameter mentioned (Options>Parameters>Installation>Large images path).
1.7.4. There is one more RK7 parameter to be enabled in order to assign images to corresponding dishes (menu items); it is "Self-Service":

1.7.5. Images of menu items are specified in its “Self-Service” section "Large image file" properties:

1.7.6. Requirements to menu item images: “.jpg” format, size 460x320 pixel.

1.8. Hall plans

1.8.1. Add image background (.bmp file) in RK7 manager station for those hall plans which you want to see in Rk-Order application.

1.8.2. Put the same pictures converted to .jpg to the same image folder (see 1.7.2.) as menu item pictures, but renamed to the "hall_"+[hall plan code]+".jpg" format (like "hall_4.jpg" for the hall plan from the picture below).

1.8.3. Fill in Extended names for hall plans in Options->Tables and plans->Hall plans and tables->[your restaurant] reference as shown above.

1.8.4. Set to [HALLPLAN] section "hall_codes=" parameter in iPadServer.ini codes of your hall plans (prepared in 1.8.2.), comma separated (like "hall_codes=1,2,3,4,5").

2. Setup iPadServer

2.1. Files and folders

2.1.1. What files are there in the distributive

2.1.1.1. The iPadServer distributive contains 3 folders: XMLs, localization and \Images\ - and 3 more files within: iPadServer.exe, iPadServer.ini and iPadLUpdater.exe.
2.1.1.2. In the XMLS folder are placed 2 significant setting files: locres.xml and settings.xml.
2.1.1.3. In the localization folder there are 2 language files for server application: russian.xml and english.xml.

2.1.2. What files to put there during installation

2.1.2.1. You have to put all the images to be used in Rk-Order to the \Images\ folder from 2.1.1.1. (and select them when setting up according to 1.7.2.).

2.1.3. Where to get the distributive

2.1.3.1. Download most recent files from UCS ftp server /dealers/r-keeper/WaiterNotepad/iPad/iPadServer/  folder.
2.1.3.2. Find RkOrder application on official appStore and load through iTunes.

2.2. Setup files

2.2.1. iPadServer.ini

2.2.1.1. File format

2.2.1.2. Settings description

2.2.1.2.1. [RKSERV] section "StationCode=" parameter value is a code of the RK7 actual cash station that should be ON to save orders.
2.2.1.2.2. [RKSERV] section "CourseCode=" parameter value is a code of the course of an order that you are going to save with this wireless device application.
2.2.1.2.3. Reference Server:                        
Addr=198.154.196.37:14441   the same as Addr= - .
PWD=                                  the same as PWD=        /deprecated since 2.1.5. - now = Cash server properties: all references come from cash server. Cash server version later than 7.4.19.33

2.2.1.2.4. Cash server:

ServAddr=198.154.196.80:14441            - The IP address and the port (the same as in 1.1.1.) of the cash server XML interface
ServPWD=                                           - The password of the cash server XML interface (may be empty)
2.2.1.2.5. Hall Plans:
hall_codes=1,2,3 – Hall plans’ codes The files with hall plans images should be called by mask hall_code.jpg или hall_code.bmp  (hall_1.jpg, hall_2.bmp).
2.2.1.2.6. Set [RK7SERV] section "AddIfOrderExists=" parameter value to "1" if you want to add next time orders for the same table into the order exists (if it exists at the next batch creation time after relogin to Rk-Order). That means if the new batch will be saved to the same order (=1) as previous (during 1 session) or not (=0).
2.2.1.2.7. [Service] section "Lang=" parameter is the language code for iPadServer (from \localization\ folder .xml files). Here and below language codes are ISO 639-3:2007 international standard ones: three letter codes.

2.2.1.2.8. [RK7SERV] section "OrderDraft=" parameter sets the saved batch Draft property enabled (=1) or disabled (=0).

2.2.1.2.8.1. "Draft" order property is the couple of "Active" one (opposite values). "Draft" means that this order is not yet sent to production.

2.2.1.2.9. [SERVICE] section "VirtualTable" parameter is the RK7 valid active table code available for order saving from assigned in 2.2.1.2.1. station.

2.2.1.2.10. [MESSAGESDB] section parameters are for guest message (service quality feedback) DB connection. DSN= DB name (default is "iPadMR"), UserID= user name, PWD= user password.

2.2.1.2.11. RestCode= parameter is used for license check since 2015 versions. It must be set to 9-digit code as in licensing system.

2.2.1.2.12. [SERVICE] section gives iPadServer own parameters

2.2.1.2.12.1. TCPAddr= is network interface IP version4 address, where current server listens for TCP port (for client connections)

2.2.1.2.12.2. TCPPort= is TCP protocol port to be opened by current server for its client connections

2.2.2. Settings.xml

2.2.2.1. File format

2.2.2.2. Settings description

2.2.2.2.1. <TOPMENU> tag contains selector pages links in its <TMI> tags. "Ident=" parameter value is the page ident in the "menu tree" (only third level pages possible). These menu groups will be in the navigation area on the top (will be permanently seen like subpages of open level 2 pages). You may not set these groups.

2.2.2.2.2. <DEFDISHGROUP/> tag "Ident=" parameter value is the same type as 2.2.2.2.1., but sets the default page (obligatory): which will be opened automatically when the program is launched.
2.2.2.2.3. <CURLANG/> tag "Lang=" parameter value is the default language to show in application, should be taken from locres.xml <RES> tag "Lang=" parameter.

2.2.2.2.4. <HALLPLAN /> tag "Show=" parameter value "1" enables "Hall plan" form; "0" disables that.

2.2.3. locres.xml

2.2.3.1. File format

2.2.3.2. Settings description

2.2.3.2.1. <RES> tag "Ident=" parameter is the language ident for those strings which are inside this tag. Please, remove all languages that you do not use strings from this file.

2.3. Additional settings in iOS

2.3.1. Open iOS "Settings" Apps section.
2.3.2. Choose "RkOrder" and put in iPadServer IP and port (you may not set server name).

2.3.3. You may not set these parameters if you use UDP instead of TCP.

2.4. Licensing

2.4.1. The server is protected with a Guardant key.
2.4.2. You should also get a license key which restricts your device number to some quantity. This quantity is saved to log file on server start and license check.
2.4.3. To get and save license follow 3.2.instructions.
2.4.4. Your iPadServer key with license is the only Rk-Order protection method. No licensing in RK7 manager station required.
2.4.5. Note that licensing has been changed since iPadServer version 2.0.9. Use new LUpdater (iPadLUpdaterNew.exe) application for recent versions. Delete old licensing utility than.
2.4.6. It is NOT possible to use one Guardant key both for MobileWaiter and Rk-Order at the same time, because of UCS licensing policy.
2.4.7. In case of RK6 TMS server should also be licensed (only 1 device license for iPadServer connection required).

3. Start and use

3.1. Start RK7 modules.
3.2. Start iPadServer.exe
3.3. Start iOS application and log in.

3.4. Note that you cannot see previous order on Rk-Order after relogin to the application, only in cash station waiter can see total order (merge of saved batches).

4. Troubleshooting (RK7)

4.1. For general troubleshooting follow instructions.
4.2. For xml interface related issues follow 6. instructions.
4.3. If you've got all \XMLs\ inside iPadServer folders downloaded from RK7 (not empty files with correct structure), but something showed not correctly in Rk-Order application, it should be wrong referenced structure made in RK7.
4.4. If you are able to login with some employee credentials, but there is no menu structure shown, you have to check: language idents, menu structure in RK7, menu in iPadServer \XMLs\ folder.

4.5. If you cannot upload newly added menu items to application, restart iPadServer and execute "reload" options in its GUI. Also check all intermediate files to have these items inside.

5. R-Keeper 6 Rk-Order installation

5.1. RK6 settings

5.1.1. In Editor

5.1.1.1. Minimum E_Rest version to use with Rk-Order is 6.93.10.
5.1.1.2. Rk-Order takes all RK6 data from shared folder. You have to put dishes images to this folder also. Set this pathway as in 5.1.2.1.
5.1.1.3. Menu hierarchy should be of 3 level: menu groups -> menu subgroups -> dishes obligatory. If your RK6 menu is not 3 level one, change that. You should use station view reference also to do that as in 5.1.1.7. The same way as in RK7, you have to put dishes only to 3rd level, 1st and 2nd levels are only selector pages, but they have to be created.
5.1.1.4. There are special dishes properties: yield, recipe short, recipe full (all these fields have 2 languages).

5.1.1.5. To export references changes to Rk-Order you have to push "Menu" -> "Transfer to Rk-Order". This operation will create an xml file with necessary data in the exchange folder.

5.1.1.6. Enable propery "not to show to guests" in modifiers reference if you don't want these modifiers be available in Rk-Order. Allowed modifiers will be in application as shown below.

5.1.1.7. You have to create a station screen ecpecially for Rk-Order with corresponding check box property enabled ("for Rk-Order"). In this station screen you need to set up only "menu" area.

5.1.1.8. Set all dishes to be available to guests (by timetable, by option "absent now"). Make sure you have set proper conditions for dishes availability.
5.1.1.9. There are 2 special tabs in dish properties: Rk-Order and Description. Their fields should be filled in obligatory.

5.1.1.10. Make sure that menu structure is 3 level with dises only in 3rd level, complete all properties for this view in RK6 before exporting RK6ORDER.XML.
5.1.1.11. Export changes to Rk-Order by pressing "Menu" -> "Transfer to Rk-Order" and the file RK6ORDER.XML will be updated.

5.1.2. In Rkeeper.ini

5.1.2.1. Exchange folder is to be set in Rkeeper.ini.

5.1.2.2. "RKOrderDir=" is a pathway to \iPadServer\Images\ , the same as in TMS2.ini , but folder only (without filename).

5.2. TMS2 settings

5.2.1. TMS2 server is additionally used for communication between RK6 and iPadServer (use version 6.3.5.5.24 and later).
5.2.2. In tms2.ini set the pathway to RK6ORDER.XML, both languages idents.

5.2.2.1. XMLPath is a full pathway to RK6ORDER.XML file, which is manually loaded from РК6 editor and has all necessary references inside (for Rk-Order).
5.2.3. All the other setting do as usually (for mobile waiter).

5.3. iPadServer settings

5.3.1. Set [RK6] section in iPadServer.ini.

5.3.2. You have to fill in legacy TMS2 server connection properties.
5.3.3. Set all the other parameters RK7 like, and do not forget that [KEY] section "KeyPublicNo=" cannot be the same as for TMS.
5.3.4. Do not forget that in settings.xml you should set connection to iPadServer, not to TMS.