Installation of the White Server Agent v2

This article describes a separate installation of White Server Agent v2.

In r_keeper, starting with versions 7.6.5.459, it is included in the installer and is installed automatically. The installation process of r_keeper + WSA v2 is described in the article silent installation of r_keeper 7 and WSA v2.

The process of migrating from WSA v1 to WSA v2 is described in a separate article.

To use WSA, it is necessary to purchase licenses.

Installation

You can install WSA using the installer available at ftp://ftp.ucs.ru/WS/WSAgent/versions/.

1. Open the link  ftp://ftp.ucs.ru/WS/WSAgent/versions/  in Explorer or FTP client
2. Login with Dealer ID
3. Select the latest version of the installer and download it to your computer. The easiest way to do this is to sort the files by modification date
4. Run the installer and follow the steps in the installation wizard.
5. Select installation language
   
6. Select server region:
   Ru — to connect to RU server
   Eu — to connect to EU server
   Test — to connect to the test server.
   

   The servers are isolated and not synchronized with each other. When choosing a server, keep in mind that integration solutions, including r_k Delivery and the objects themselves, must operate in the server's hosting zone.

   
   
   
7. Select the systems the agent will connect to
   

8. Specify the path to the directory server folder. The XML interface port field will be filled in automatically after specifying the correct path.

   
   
   

   Please note!

   To configure r_k Cloud, in this window, uncheck the "Directory server installed locally" checkbox and fill in the "Directory server IP" field instead of the "Path to installed R-Keeper" field. Specify the desired XML interface port.

9. Click Next. The installer will indicate what settings should be made in the manager station:
   
   1. Open the manager station and go to the menu Settings > OLAP reports > Report servers
   2. Select the desired report or reference server
   3. In the XML Interface section, specify the Bind Port. The port must be free and accessible over the network.
   4. In the HTTP Server section, specify a free port in the HTTP Data Port field, while the Use Free Listen Port setting should be disabled.
   5. Save the changes and accept the warnings that the server needs to be rebooted.
      
   6. In the HTTP Rights section, specify the HTTP Access right in all fields.
      
      

   7. If the HTTP Access privilege does not exist, create a new privilege with this name.

   8. Restart the reference or reporting server. After the server is restarted, the settings in the WSA v2 json file will be updated.
   9. Restart the cash server
   10. In the installer, check the Done box.
10. Specify the path to the cash server folder. 
    
11. In the StoreHouse 5 setup step, specify:
    
    1. IP — StoreHouse 5 location address
    2. Port — Web API port
    3. Пользователь — User login in Store House 5
    4. Пароль — User password.
       Click the Next button. 
12. At the RK restart step:
    
    1. Turn off the cash server and check the box R-keeper stopped
    2. Check the box File copied, no need to copy anything
    3. Start the cash server and check the box R-keeper started
    4. Click the Next button
       
13. Click Install
14. Wait for WSA to install on your computer.
    During installation, WSA will check if r_keeper is licensed. For information on the required licenses, see the Licensing article.
    If everything is OK, the agent will be launched after installation.

WSA v2 installation completed successfully.

WSA will connect to the server within 15 minutes and will be displayed in the admin panel. You can check the connection.

Setting up WSA for delivery is described in the article Setting up the agent for Delivery.

After successfully starting WSA, two interfaces will appear on the cash server. To check the interfaces, follow these steps:

1. In the r_keeper manager station, go to the menu Service > Stations and devices
2. In the Cash Registers and Devices window, select the desired establishment, and then select Cash Register Server
3. The Devices window will display PDS and XML interfaces.
   

If the interfaces do not appear, restart the cash register server. Without these interfaces, WSA will not work.

For WSA to work properly, you need to check the following parameters:

1. HTTP Rights:
   1. Go to menu Service > Stations and devices
   2. In the desired restaurant, select the cash register server for which the integration will be configured and go to the Properties tab
   3. In the HTTP Rights block, set the HTTP Access value in the fields:
      
      • HTTP API
      • Web interface
      • XML interface.
        
2. Rights:
   1. Go to menu Personnel > Employees
   2. Expand the Central Office, select the WSA and go to the Properties tab
   3. In the Cash Register Restrictions block:
      
      1. In the Operations field, allow all operations.
      2. In the Rights > WSA Rights field, check the box.
   4. In the Manager Restrictions block:
      
      1. In the Object Privileges field, allow all objects.
      2. In the Privileges field, allow all privileges.