Introduction

Common Server is the basis for the microserver architecture of the r_keeper company. It is intended for connecting various r_keeper software modules to one another. Any r_keeper software module publishes its GUID and URL on the Common Server. Other modules of r_keeper products can connect to this module.

r_keeper services and applications that can connect to the Common Server are called Feature Server. At the moment, the Feature Server technology is supported by several r_keeper software modules: MenuBoard, RK7 SecondScreen, R-Keeper CRM 507 Replication, TimeKeeper, interactive reports (IRs), and others. If several Feature Servers are included in some software, they all deal with one Common Server using it to connect to each other.

If the Common Server is unavailable, any of Feature Servers, trying to connect to it, reports an error to the log file saying that the Common Server is unavailable.

During its work process, a Feature Server occasionally updates its registration on the Common Server. If the Feature Server does not update its registration during a certain period, the Common Server stops working with it and deletes it from the list of Feature Servers. So, if a Feature Server tries to connect to a server that is not registered on the Common Server, the Common Server will return an error on Feature Server unavailability.

The Common Server is required to manage Feature Servers.

Setup and Installation

The installer and uninstaller can be found at the FTP: ftp://ftp.ucs.ru/rk7/other/UCS_CS/, or in the distribution package of the software dealing with a Feature Server. Download the installer and save it to a convenient location. Run the file CSSetup.exe and follow the instructions step by step.

  1. Accept the license agreement
  2. Specify the destination folder
  3. Specify the instance name
  4. Specify the port for the Common Server. Any free port will be suitable. By default, it is 7007
  5. Specify the SSL-port
  6. If you have no certificates, choose No
  7. Select a suitable log level
  8. It is recommended to install the Common Server as a service
  9. Click Install

  10. The installation is complete

The Feature Server connects to the Common Server without any assistance. If you run the Common Server after the Feature Server, press the button Registration on Common Server.

Parameter Setting

During installation, the server creates the CS_Service.ini settings file where all the parameters are stored. By default, it looks like this:

[CS_CONNECTION]
connect_timeout(s)=30
receive_timeout(s)=30
send_timeout(s)=30
compression=c_Base64_ZLib
def_port=7007
SSL_port=7008
db_path=V:\Program Files (x86)\UCS\CommonServer\CommonServer7007\UCS.csdb

[CS]
Name=CS_CommonServer7007
loglevel=0
Log_level=3
i_guid={E35D7CBF-D999-4BED-AAC4-F5C876B6C6A5}
certificate_path=V:\Program Files (x86)\UCS\CommonServer\CommonServer7007\
Root_Cert_File=ca.cer
Cert_File=work.cer
Key_File=work.key

You can change these parameters if you wish to.

Parameters description

  1. def_port is the HTTP port of the server. By default, it is 7007, the SSL is 7008
  2. i_guid is the GUID of the server instance
  3. certificate_path is the full path to the folder containing HTTPS certificates
  4. db_path is the path of the operating SQlite database
  5. SSL_port is the HTTPS port of the server
  6. connect_timeout(s),receive_timeout(s), send_timeout(s) are connection timeouts
  7. compression: by default, the c_Base64_ZLib compression is used
    The parameter can have only the following values:
    1. c_Base64
    2. c_Base64_LZ
    3. c_Base64_ZLib

Examples

The correctly functioning Common Server looks like this:

The correctly functioning Feature Server looks like:

 

  • No labels