Installation and Connection

This article describes the installation of r_k Guest Screen. Hereafter, the following names may also be used: r_k GS, Guest Screen.

Installation and configuration consist of several stages:

1. Guest Screen Installation
2. Licensing
3. Settings in the Manager Station
4. Settings in Guest Screen.

Starting from version 3.1.0-dev.13, GS can be launched using the HTTPS protocol. All new installations will use it by default.
When updating older versions, the HTTP protocol will be retained. Settings can be changed in the appsettings.json file, in the directory where GS is installed, in the urls section:

The HTTPS protocol is not available on Windows 7; HTTP will remain there.

Guest Screen Installation

To install:

1. Download the installation file from the FTP server at https://files-rkcloud.ucs.ru/d/65231391cff842d49a1a/?p=/rk7/other/Guest_Screen&mode=list
2. Install GuestScreen by following the installer prompts.
3. Select the installation path. Note that if you install GS in Program Files, the program will need to be run as administrator each time.
4. Specify the port on which GS will run. You can leave the suggested one.
5. Starting from Guest Screen 1.0.0.68, the installer includes a selection of preset themes. Themes available for selection:
   • Bakery
     
   • Сafe
     
   • Pizza
     

6. During installation, select a preset theme and screen resolution. Click Next
   
   These themes are available for the following screen resolutions:

   For landscape orientation, pixels	For portrait orientation, pixels
   800*600	600*800
   1024*600	600*1024
   1024*768	768*1024
   1024*1280	1280*1024
   1366*768	768*1366
   1440*900	900*1440
   1600*900	900*1600
   1920*1080	1080*1920
   1280*800	800*1280

7. Complete the installation.

After installation, an r_k GS client shortcut will appear on the desktop. The first launch of r_k GS must always be performed as administrator.

After installation, go to Settings > Modes and check for the presence of mode and scene templates. There should be 8 standard modes in the list. If they are missing, import the templates.

Licensing

r_k Guest Screen must be licensed. 

Two types of licenses are required for operation:

• A subscription license for Guest Screen – R-Keeper Guest Screen 12 months Software module. It is verified online.
• For r_keeper 7.6.5 and higher, an additional license for the HttpOrderNotify interface is required. It is called R-Keeper Order Notification Interface Software module. The license is added automatically when purchasing the r_k GuestScreen license. The validity period of the HttpOrderNotify license equals the validity period of the r_k GuestScreen license.

The number of R-Keeper Order Notification Interface Software module licenses must equal the number of additional connections to HttpOrderNotify.

For detailed information, read the article Licensing.

Settings in the Manager Station

Updating the Driver

Integration of r_keeper and r_k Guest Screen requires the HTTP Order Notify driver version 18 or higher. If the driver version is outdated, perform the following steps:

1. Stop the directory server and the cash server.
2. Download the httpnotf.udb file. It can be taken from an archived version of rk7 at \base\workmods or from the link.
3. Copy the httpnotf.udb file to the [RK7 installation folder]\base\workmods folder, replacing the existing file.
4. Start the r_keeper servers.

Settings in the Manager Station

1. Open the r_keeper manager station.
2. Go to the Service > Cash Stations and Devices
3. Select the restaurant and the cash server that will send data to r_k GS.
4. In the Properties:
   • Enable the use of HTTP port on the cash server
     
   • Specify a free port in the HTTP Data Port field and do not set the Use Free Listen Port flag
     
     
5. Next, you need to configure the HTTP order notify driver. 

For r_keeper 7.6.5 and higher

Starting from version 7.6.5.371, the Http Order Notify settings have moved from Devices to the Cash server properties. The procedure for these versions is as follows:

1. In the driver parameter DestURLs, specify the connection string as:
   http://GS_server_address:GS_server_port/api/httpNotify/postOrders
2. Save the changes.
3. Restart the cash server.
   If you need to specify multiple connection strings, they can be specified separated by semicolons ";".
   For example: http://127.0.0.1:2121/api/httpNotify/postOrders;http://127.0.0.1:1234/orderTaker
   
   

   If multiple connection strings are used, the cash server property HTTP Order Notify must be licensed. Read more in the article Licensing.

For r_keeper older than 7.6.5

If your r_keeper version is lower than 7.6.5, you need to add the HTTP Order Notify interface to the cash server yourself. To do this:

1. For KDS PRO to work, driver version 18 or higher is required. Therefore, if your version is lower, download the driver from FTP before adding the interface to the cash server:
   ftp://ftp.ucs.ru/rk7/other/KDS_PRO/Extra_Files/httpnotf.udb
2. Copy the httpnotf.udb file, replacing it in the directory server folder.
3. Restart the cash server.
4. Add the HTTP Order Notify driver to the cash server.
   
5. Configure the driver for all cash servers as needed.
6. In the driver parameter DestURLs, specify the connection string as:
   http://GS_server_address:GS_server_port/api/httpNotify/postOrders
7. Go to Service > Interfaces and create a new interface.
8. In the Library Files (DLL) section, select the desired restaurant and assign the HTTP Order Notify driver to the cash server.
   
9. Activate the interface and save.

Next, create a user that will link r_k GS and r_keeper. To do this:

1. Go to Personnel > Employees.
2. Select the restaurant where r_k GS will be used.
3. Create a role and name it HTTP Access.
4. Go to the role's Properties.
5. Expand the Manager Restrictions > Privilege on Objects section and set the flag in the HTTP Access/HTTP Driver
   
   
6. Create an employee in the HTTP Access role. The employee's name must be written in Latin letters without spaces, for example, http.
   
7. In the Account field, specify the employee's password and save the changes.

Settings in r_k are complete. Restart the cash server. 

Launch Parameters

The following parameters must be specified in the shortcut properties:

• /port 2121 — application launch port, numbers are specified after a space; default is 2121
• /db gs.db — application database name after a space; default is gs.db
• /theme C:/ucs_1.0.95.zip — theme import parameter at startup; specify the full path to the theme file after a space
• /exp C:/GS-UCS-0.0.1.33.exp — template import parameter at startup; specify the full path to the exp file after a space
• /screenres 1024.768 — window size setting at startup; two numbers separated by a dot, after a space
• /gpu-acceleration — enable GPU acceleration in the CEF embedded browser.
  

Settings in r_k GuestScreen

To enter the settings of r_k GS, run the program and click 5 times in the upper right corner of the screen. A white circle should appear when clicking.

After five clicks, the settings will open. To open the menu, click the button with three lines in the left corner
To enter settings, click the gear icon in the upper right corner.

The connection settings screen will open. Enter the connection data to the cash server via the HTTP interface.

1. XML int.: address – IP address of the cash server.
2. XML int.: port – HTTP port of the cash server.
3. RK7: login – the username from the HTTP-Access group.
4. RK7: password – the password for this user.
   
5. Click the Check button. The system will check the connection and display a message depending on the result.
   1. If the data is entered correctly, a connection established message will appear
      
   2. If the login and password are incorrect, an Unauthorized error will appear
      
   3. An error occurred while sending the request means the connection settings to the cash server are incorrect. Check the IP and connection port.
      
6. After a successful connection, the restaurant and cash register codes will be loaded from the cash server. Select the required cash registers from which orders should be received in the Cash register code field
   
7. If cash registers are not displayed, click the Refresh button
8. In the Excluded order type code field, if necessary, specify the order category that should not be displayed on the GS screen.
   
   If order categories are not displayed, click the Refresh button.
9. Optionally, specify the synchronization frequency with r_keeper and the number of minutes after which cash XML packets will be ignored (e.g., if the cash server was turned off for a long time and then turned on, sending unsent packets that will be displayed in r_k GS)
   
   
10. Click the Save button.

Connection setup is complete.

For the settings to take effect correctly, restart the computer.