Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Info

Since version 7.05.03, the installation process has been changed.
It is necessary to license the reference server.

Before installing r_keeper 7, make sure that you have the required certificate installed in your operating system.
For version 7.07.00.232, it is obligatory to install the certificate

Installation Procedure

Note

Important!

R_keeper 7 requires licensing. See details in the Licensing section. Starting from version 7.05.03.ХХ, the installation procedure is different.

The distribution kit is

...

presented by installation packages

...

— setup.exe

...

. Install the system only using such packages — this will allow you to easily and quickly update system components.

If you need to update a previously installed version, go to the STANDALONES directory. Please note that distributions from this directory do not install TimeKeeper, Interactive Reports, and others.

...

Missing modules will

...

need to be installed and

...

updated manually.

...

Since version 7.05.03, the cash server

...

works only

...

on Windows OS.

By default, the cash station is installed with the new user interface. If previous versions are upgraded, the interface remains as it was.

...

Scenario

To install r_keeper 7 from an archive:

  1. Get licenses for the cash server and report server
  2. Download an archive from the FTP and unzip it.
    If you plan to use a version

...

  1. earlier than 7.6.4, download

...

  1. a distribution kit from the FTP server and

...

  1. the RAL.dat file from the License system
  2. Edit configuration files
  3. Run the reference server

...

  1. Run the manager station

...

  1. Add the cash server

...

  1. and license it

...

  1. Add a cash station

...

  1. Run the cash server

...

  1. Run the cash station

...

...

  1. Install MS SQL Server

...

  1. 2012  and configure

...

  1. connection between

...

  1. r_keeper 7 and the database managed by MS SQL

...

  1. .

...

Installation Process

  1. Copy the installer package archive from the FTP server (ftp://ftp.ucs.ru/rk7/versions/).
    The archive name indicates its version. If you do not know which version to install, it is better to install the penultimate one or contact the UCS r_keeper support service.
  2. Unpack the archive and remove the read-only attribute on for the whole package including the sub-folders and files
  3. . Add the folder containing r_keeper software to your antivirus exclusions. Further on run all applications as administrator.
  4. Copy the INI files from the /BIN/WIN/INI folder to the /BIN/WIN folder

    . Download the RAL.dat file from the licensing website (http://l.ucs.ru/ral.dat) and place it into the /BASE/ folder of the distribution kit. This file allows signing into the manager station as a dealer having unlimited rights, that is important for licensing.
Note

Note

See detailed information on the parameters of the reference server configuration file and its launch in the article on the reference server.

...

  1. Info

    If you plan to use a physical key for licensing, install the Guardant driver. You can download it from the official website.

...


  1. Edit the

...

  1. configuration file of the reference server

...

  1. :

    1. Open the rk7srv.INI

    2. In the Server parameter of the [REFSERVER] section, specify the unique name of the server, for example, RK7
    3. Add the UseSql parameter for using external database for cumulative data, where:
      • 0 — no to use
      • 1 — to use
        When launching the server for the first time, specify UseSql=0
    4. In the [TCPSOC] sectionm specify a free port for the reference server
    5. Save the changes.

      Code Block
      [REFSERVER]
      
      Server=RK7SRV_REST01   
      UDBFILE=..\..\base\rk7.udb
      MainLang=.\RefSrv.Rus
      AltLang=
      WorkModules=..\..\base\workmods
      UpgradeTranslateRussian=0
      ;; UpgradeAltTranslateRussian by default have value different with UpgradeTranslateRussian
      UpgradeAltTranslateRussian=0
      DisableSMARTVerify=1
      USESQL=0
      
      [NETKERN]
      Protocols=tcpsoc.DLL
      
      [TCPSOC]
      PORT=3639

6. Edit the INI file (rk7man.ini) and launch the manager station (rk7man.exe).

Info

Note

See details on configuring and launching the manager station in the Manager Station Setup article.

...

    1. For more information about the configuration file and launch of the reference server, read the special article

  1. Create the reference server's desktop shortcut — Refsrv.exe and specify /desktop in its properties
    Image Added
  2. Edit the configuration file of the manager station:
    1. Open the rk7man.ini
    2. In the Server parameter of the [REFSERVER] section, specify the name that you wrote in rk7srv.ini. In the given example, it is RK7
    3. In the [TCPDNS] section, find the server name and change it to this of yours. In our example, it is RK7
    4. Save the changes

      Code Block
      [REFEDIT]
      Server=RK7SRV_REST01   
      Client=TESTMAN-%RANDOM%
      LOCKONEDIT=0
      LongTimeout = 200000
      
      [NETKERN]
      PROTOCOLS=tcpsoc.dll
      
      [TCPSOC]
      PORT=3637
      

...

    1. LISTEN=0
      
      [TCPDNS]
      ;; for speeding up. Sometimes necessary (if Broadcast messages cannot pass)    
      RK7SRV_REST01=127.0.0.1:3639

...

To sign in, you can use the «Administrator» username and the password «=». To sign in as dealer (to perform any editing of references), it is required that the /BASE/ folder contains a fresh ral.dat file (see par. 1.2.3).

If the file is placed there after the reference server is launched, it is required to restart the reference server. The name must have the following format: "RK7 XXXX", where XXXX is the dealer ID.

7. Indicate the corporation code (Settings - Parameters - Installation - Enterprise Code) and the restaurant code (the CODE restaurant property) according to the facility accounting data from l.ucs.ru.

8. Add the cash server of your restaurant to the Stations and Devices refernce. Assign a unique network ID, for example MIDSRV3001 .

9. License the cash server. See details in the article on the cash server setup.

10. Configure the INI file (Rkeeper.ini) and launch the cash server (MIDSERV.EXE) with the /desktop * parameter.

...

    1. For more information about configuring and launching the manager station, read a separate article.
      The rk7srv.ini and rk7man.

...

    1. ini files must have different ports in the [TCPDNS] section

  1. Run the reference server and wait until its icon becomes green or yellow in the tray.
    Agree when the system offers you to create a new database
  2. Run the manager station
  3. Log in
    • You can use standard credentials:
      • Account — Administrator
      • Password — =
    • To log in with dealer's rights, use the following credentials:
      • Account — RK7 DealerID, for example, RK7 1234
      • Password — the password for the License system
        Image Added
  4. When logging in for the first time, an error will appear. It is a normal behavior. Click OK and log in once again
  5. Specify the corporation code. For this:
    1. Go to Options > Parameters
    2. Select Installation > Enterprise Code
    3. Go to Properties and expand the Basic section
    4. In the Integer field, specify the corporation code in accordance with your data from the License system
    5. Save the changes
      Image Added
  6. Specify the restaurant code. For this:
    1. Go to Service > Stations and devices
    2. Right-click on All and select New Restaurant
    3. In the Main section of Properties:
      • Specify the name
      • In the Code field, enter the restaurant code in accordance with your data from the License system
      • In the Status field, select Active
        Image Added


  7. Add the cash server and specify your network ID. For this:
    1. Right-click on the restaurant name and select New Cash Server
    2. In the Main:
      • Specify the server Name
      • In the Status field, select Active
      • In the Network ID field, enter the unique network ID. You can use latin letters, digits and special symbols, for example MID
  8. License the cash server. Get more information in the article about configuring the cash server
  9. Add the cash station to the cash server and add the network ID name, for example, CASH. For more information, read the article about configuring the cash station
  10. Edit the configuration file of the cash server:
    1. Open the rkeeper.ini file
    2. In the [Config] section, edit the parameters:
      • Change Client to the network ID of the cash server. In our case, it is MID
      • Change RefServer  to the reference server name. In our case, it is RK7
      • Add the UseNetChecking=1 parameter, if you plan to use a virtual key for the system licensing
    3. In the [TCPSOC] section, add the line PORT=XXXX, where XXXX is the number of the port for the cash server
    4. In the  [TCPDNS] section, find the server name and change it to yours. In our case, it is RK7
    5. Save the changes


    1. Code Block
      [Config]
      Client =  MIDSRV3001   
      RefServer =  RK7SRV_REST01   
      BasePath = ..\..\MIDBASE
      TwoFilesMode=1
      KeepModules=0
      
      [NewBaseGenerators]
      ;;When a new work.udb is created, the following will be used:
      InvoiceGen=0
      CheckGen=100000
      PrintNumberGen=0
      
      [NETKERN]
      Protocols=TCPSOC.dll;localnet.dll
      [TCPSOC]
      [TCPDNS]
      ;; Optional but if indicated, the connection will be faster; the same goes for the cash station
      ;; Sometimes needed (if broadcast messages fail to pass)   
      RK7SRV_REST01=127.0.0.1:3639
    ! At the manager station, add a POS station having a network name, for example, CASH_ST01 , to the POS server from par. 8. Select the OS type (Windows), add the video driver to the Devices tab (right-click in the popup menu Video Driver -> Windows Video Driver (Window Mode).
    Note: see details on POS station setup in the article POS setup
    12. Configure the INI file (wincash.ini) and launch the POS station (wincash.bat) on Windows.
    Edit wincash.ini, namely indicate the POS server name (Server= MIDSRV3001 ) and the station name (STATION= CASH_ST01 ) according to par. 11.

[Config]STATION=    

CASH_ST01   

Server =    

MIDSRV3001   

...


  1. Edit the configuration file of the cash station:
    1. Open the wincash.ini file
    2. In the [Config] section, edit the parameters:
      • Change the Station to the network ID of the cash station. In our case, it is CASH
      • Change the Server to the network ID of the cash server. In our case, it is MID
    3. In the [TCPDNS] section
      • Find the cash server name and change it to yours. In our case, it is MID
      • After the IP-address, put the colon and specify the cash server port
    4. Save the changes

      Code Block
      [Config]
      STATION = CASH  
      Server = MID 
      
      [NETKERN]
      ;possible protocols are nbhdup.dll, SPXSOC.dll
      Protocols=.\TCPSOC.dll

...

    1. 
      
      [TCPSOC]

...

    1. 
      LISTEN=0

...

    1. 
      
      [TCPDNS]

...

    1. 
      
      ;;Optional but if indicated, connection will be faster. Sometimes necessary (if broadcast messages cannot pass)

...

    1. 
      ;;

...

MIDSERVER01   

    1.  MIDSERVER01=127.0.0.1

...

  1. Install the SQL server, license the directory server and configure the external database connection.

Note

Configuring the directory server connection to the database on the SQL Server and its licensing is mandatory if you need to view reports at the manager station!

  1. Configure additional modules (corresponding ini files) and run them (as needed).

Upgrading Procedure

Important!

Downgrading is impossible!

Important!

If R-Keeper 7 modules were installed from the installer individually (each module has its own copy) or one copy was installed for several modules, upgrades must also be performed via the installer and using a relevant copy.

    1. :2350


  1. Create the shortcut of the reference server (MIDSERV.EXE), add /desktop to its properties and run the server.
    If the cashdesk icon appears in the tray, everything is correct
  2. Run the cash station using the wincash.bat file
  3. Install MS SQL Server 2012 or higher. You can use the Express version
  4. License the reference server. For more details, read the article on the reference server setup
  5. Set up connection with an external database. For more details, read the article on setting connection with MS SQL

    Info

    If you plan to view reports in the manager station, it is obligatory to set up connection between the reference server and the SQL database.

    That's it — you have installed and configured r_keeper. If necessary, you can configure additional modules, their config files and start them.

Upgrading Procedure

If you want to upgrade the system, remember how it was installed. If r_keeper modules were installed using the installer, upgrade the system using the installer as well.

Info

Downgrading is impossible.

To upgrade the system:

  1. Close the common shift at the cash station
  2. Close all the stations, including the manager station, Close all the stations (including the manager station) and stop all the servers. If servers function as services, stop them.:
    • To stop a
    directory
    • reference server run as service, you can use the Windows tools or enter
    "
    • net stop RKeeperRefServer
    " in
    •  in the command line
    .
    • To stop a
    directory
    • reference server run as a standard app, it is enough to
    press 
    • click Shutdown in the main window
    (
    • or in the
    popup
    • popup icon menu
    of the icon
    • in the tray
    ).
  3. It is recommended to perform an upgrade after closing a general shift.
  4. Make an Before upgrading, it is recommended to make an archive copy of the entire /\RK7/ \ folder or at least copies of databases from the folders \base\ and \midbase\. folders
  5. Copy the folders from the new distribution package (base,bin) and replace all the existing folders in base.bin distribution kit to the folder containing the RK7 r_keeper 7 version to be upgraded. Agree to files replacements.
    If you have made changes to in the wincash.bat file, do not replace it or . Or replace it after acting on par. 2 but first compare comparing the contents and make necessary adjustments if required.making necessary cahnges
  6. Go to base\drvlocalize and run Defparam.exe by selecting defparams.rus or a file for another language from the list (for .
    For versions below 7.5.2.269, see readme.txt in the same folder).
    New default driver settings will be added. This is particularly important for adding new universal FR fiscal register drivers. All the existing defparams.ini contents will be saved.
    Please, pay special attention to translation files. If needed, it is possible to perform additional translation.
  7. Launch the directory reference server refsrv.exe.
    When upgrading, it is recommended to launch all servers as services so that you can see errors if they appear (refsrv.exe/desktop). Wait for the server to upgrade (for the icon in the tray to will turn green), then launch
  8. Run the report

    servers

    server (if any) and wait for

    them

    it to upgrade

    , too.

Important!

...

  1. Note

    After upgrade, make sure to restart the

...

  1. reference and report servers

...

  1. .

    Then


  2. launch the POS servers Run the cash server and wait for them to upgrade.its upgrade
  3. Run the cash station
    • If preload and movemod run on DOS and Wincash.bat runs on Windows, then the cash station will upgrade automatically
    • Both obligatory modules and the modules specified on the Drivers tab of the Stations and Devices reference at the manager station
    At POS stations, everything will upgrade automatically (if preload and movemod are launched on DOS or Wincash.bat is launched on Windows). This includes downloading of modules that are considered mandatory and modules selected on the Devices page of the Stations and Devices directory at the Manager station.
    • If the station configuration is changed, dll files are downloaded when the station is launched next time. When a new version is found, the
    POS
    • cash server will upgrade and restart
    .
  4. To upgrade a manager station, it should be run via via rk7man.bat.

Upgrades

...

since Versions 7.4.21.Х

If your version of r_keeper is from 7.4.21 to 7.5.3, upgrade the system as follows:

  1. Stop the directory reference server;
  2. Upgrade from your 7.4.21.Х to the latest 7.4.21.Х;
  3. Launch the directory reference server;
  4. Stop the directory reference server;
  5. Upgrade from your 7.4.21.Х to the latest 7.5.2.Х;
  6. Launch the directory reference server.

The principle is the same for upgrading to 7.5.3.Х and the subsequent version ranges.
The procedure is as follows:

  1. Upgrade your version to the latest in the range;
  2. Launch the directory reference server;
  3. Once the directory reference server icon turns green, stop (export) the directory reference server;
  4. Upgrade RK7 to the latest version of the subsequent range;
  5. If you need to upgrade to later versions, return to par. 2. If there is no need to upgrade any further, this is the end of instructions.

Upgrading from the Automatic Installer

To upgrade from the automatic installer, it is required that the previous version is also installed from the installer.

In practice, the most common situation is when installation was performed from Standalone, but upgrade is needed from Setup.exe.

In this case you can do the following: install a new R-Keeper v.7 version from the installer and add the old databases (rk7.udb, check.udb) to the new installation. But remember that it is impossible to skip versions so maybe you will first have to perform a standard R-Keeper upgrade.

If it is impossible to use setup.exe because of an OS type incompatibility, you can decompress setup.exe using third-party software to take the required files (not recommended).
* Servers can be launched as apps or services.

Attention

On the first launch, run servers as applications with the /desktop key. This way you will be able to monitor server operations by the icon color in the tray.

...

  1. .

...

To install relevant services, run the executable service files with the /install key or just run the exe file and in the window that appears press the Yes button to agree to install a service. By default, created services have the autorun type. This does not require users to log in to the system to launch the servers. If a service needs to be started or stopped manually, you should use the Windows tools or the net console command with the start/stop key. For example:

  • net stop RKeeperRefServer
  • net start RKeeperMidServer

...