[toc]

1. General information

1.1. Possible functions

1.1.1. There are 2 variants of report server function: additional and intermediate.
1.1.2. So, r
eport servers are used for 2 corresponding purposes:

1.1.2.1. For report making: recalculating cubes (agregates) and gathering data directly from particular cash servers (of particulars restaurants in case it is chain of restaurants) or other report servers (lower level).

1.1.2.2. Fot transport data: from upper level server to lower level and otherwise.

1.2. Additional server

1.2.1. See additional report server general scheme below.

 

1.2.2. For high loading systems it is recommended to build cubes separately from reference editing.

1.3. Intermediate server

1.3.1. Put this server between reference server and cash servers.

1.3.2. It is not a problem if you put new intermediate servers to some working configuration afterwards (previously having "cash server -> reference server" scheme), for example in case of restaurant chain enlargement.

1.3.3. Settings scheme (one network branch):

ini setting nameReference serverReport server 1Report server 2Report server 3Cash server(s)
Server=REF



RefServer=
REFREP1REP2REP3
Client=
REP1REP2REP3CSE1...2...3...

1.3.4. All reports servers in corresponding rk7man reference are the same (no any "intermediate" property exist).

1.4. Approximate installation actions sequence

1.4.1. Receive master license for reports server.
1.4.2. C
reate reports server in manager station, set its properties, generate sub-license for it.
1.4.3. Copy files to host, s
et repsserv.ini and start as desktop or service.

1.5. Applications to use

1.5.1. There are 2 applications that could be used as report server: RKREPORTSSERVER.EXE and REFSRV.EXE.
1.5.2. For high loading systems we recommend you not ot use reference server as report.

2. Licensing for reports server

2.1. General rules

* license for reports server is given for corporation

* before adding request in LicenseManager (to site), send request to license responsible person in usual xls-file.
Item ‘R-Keeper 7 Report server’ should be present in this request.

* license for report server depends on:

            1) USB key that will be used for this reports server

            2) hardware of computer, where reference server is installed.

            3) corporation code

* you create request (on site or in LM.jar) with reason = master license.

Station count in master license = number of sub-licenses for reports server (and in every sub-license station count will be = 1).

Example:

If you have chain of 4 restaurants and want 4 separate report servers for each restaurant and 1 – for central office, then you create master-license with station count = 4 + 1 =5. In this case you should have 5 different USB keys – 4 for each of report servers and 1 for report server in central office.

* All work with sub-licenses for reports server (new license, prolongation, license on key/hardware change) is the same as for R-Keeper 7 stations license (first you create new sub-license inside master-license, then prolong it, etc).

2.2. How to generate license request

* make sure that you have correct value in corporation code Options --- Parameters --- Installation --- Enterprise code

Options --- OLAP reports --- Reporting servers --- properties of report server --- section ‘License information’:

1) choose key number in property ‘Protection key actual number’

ATTENTION! This key number is used in license, so make sure that you have chosen proper key and plan to use it exactly with reports server.

2) make right-click on reports server, in context menu choose Actions --- Generate license request

3) license request will appear in property ‘License request data’

2.3. How to make request for master license in LM.jar

Note: search by objects (=restaurants) is used only for adding license request, master license itself is given for corporation.

* make search by objects (by name or by code)

* make a right-click on object (=restaurant) in search result area, choose ‘New request’

* in window with request properties choose:

1) Software = ‘RKeeper 7 Report Server’

2) Reason = ‘Master license’

3) Station count =number of reports server, that require sub-licenses

Example:

If you have chain of 2 restaurants and want 2 separate report servers for each restaurant and 1 – for central office, then you create master-license with station count = 2 + 1 =3.

4) Period – choose any period

5) Press ‘Apply’ to save your request.

2.4. How to search for requests in LM.jar

Search of particular request can be made via pressing ‘Requests’ in main window of LM.jar (after that fill filter – date, request ID, etc).

2.5. How to view requests and generated licenses in LM.jar

* Make search by corporations

* Make a double click on necessary corporation in search result area to open its properties

* All licenses can be seen in sections ‘Corporate active licenses’ and ‘Top 10 requests’.

2.6. How to generate sub-licenses for reports server inside master-license

* Make search by corporations.

* Make a double click on necessary corporation in search result area to open its properties

* Your master-license will be seen in section ‘Corporate active licenses’.

* Right-click on it --- Add license

* New window with properties of sub-license will be opened:

1) specify period

2) specify station count (in this case – 1)

Note: number of sub-licenses inside master-license = number of licenses of reports server.

2.7. License error messages on manager station

5234:License check for reporting server 'References server' failed with code 1 – no license exists for this reports server

5234:License check for reporting server 'References server' failed with code 2 – license for reports server is generated and saved, but it is wrong (hardware changes, license expired, license was generated for another key, etc).

3. Files and folders

3.1. Copy files

3.1.1. Before running report server make sure that there is no tick ‘read-only’ in properties of its folder (otherwise reports server can not create its database).
3.1.2. Also please make sure, that path to folder with RKREPORTSSERVER.EXE is less than 200 symbols and does not contain ‘spaces’.
3.1.3. Get Repsserv.ini file from RK7 disributive /BIN/WIN/ini/ folder and place near file RKREPORTSSERVER.EXE.

3.2. Repsserv.ini

3.2.1. Format

[CONFIG]
Client="my_repserver"
RefServer="refserver_name"
RefsBasePath=".\BaseData\refsdata.udb"
CheckBasePath=".\BaseData\check_db.udb"
ReceivedPath=".\Received\"
ErrorLog="repsserv.stk"
[NETKERN]
Protocols = tcpsoc.dll

 //network name of reports server itself

// the same as for corresponding reports server on manager

// (see 3 Options --- OLAP reports --- Reporting servers)

// network name of refserver

//path to references db of reports server, NOT rk7.udb

path to checks db of reports server, NOT check.udb

//path to folder with received data

//log file name (if needed – add path), by default log file is saved in the same folder as RKREPORTSSERVER.exe

list of protocols (comma separated), obligatory make sure that these DLL files are present in folder with file RKREPORTSSERVER.exe

4. Manager station settings

4.0. Where are all these sections

3.7.1. Options -> OLAP reports -> Reporting servers. Or use menu link Options -> Head office -> Reporting servers.

3.7.2. In this reference one report server is always present as preset: references server.

3.7.2.1. If you do not have license for this report server, you cannot recalculate cubes on reference server (does not matter, via UDB or SQL).

3.7.3. Create necessary number of report servers in this section (for example, if you want to separate servers by restaurants and you have chain of 7 restaurants, there will be 7 report servers created (each report server – for 1 restaurant) and also 1 report server for ‘central office’ (may be preset, ‘reference server’).

4.1. Section "Main"

4.1.1. Create new report server in Options -> OLAP reports -> Reporting servers or configure reference server as report there.
4.1.2. Set its name and status.
4.1.3. Property ‘NetworkID’ for corresponding report server must be the same as in repsserv.ini of this reports server.

4.2. Section ‘Basic’

4.2.1. ‘Build cubes’ - To build cubes or not. By default is switched on.
4.2.2. ‘Gather data’ - To collect data (=closed shifts) from corresponding midservers or not. Switch off, if you want only to recalculate cubes via this reports server.
4.2.3. ‘Data wait time interval’ - Interval (hh:mm) between last data gathering and start of cubes recalculation.
4.2.4. Cubes source type - where to get data for cubes (if SQL chosen 4.4. must be set properly).
4.2.5. UDB database mode - read about this property in 2.2.3. of .

4.3. Section ‘Other’

‘Cube timeout’

Timeout in seconds for building cubes

‘Logging type’
Type of logging (queries will be saved into separate folder). By default is switched off.

4.4. Section ‘External database link’

4.4.1. Note: only if you use SQL (UseSQL=1 in rk7srv.ini or repsserv.ini) you will be able to get reports, without SQL - intermediate servers without data gathering only.

4.4.2. In this section you define SQL database for every reports server: database that will be used for cubes recalculation (if tick ‘Build cubes’ is switched on) and for data gathering (if tick ‘Gather data’ is switched on).

4.4.3. Each reports server should have its separate SQL database (to gather data to) and recalculates cubes via this base (for example, separate databases for different restaurants).

4.4.4. Properties in this section:
External database settings – link to settings of SQL database of this reports server.
External database username – login for access to SQL server.
External database password – password for access to SQL server.

If you are using cube recalculation via SQL (and UseSQL=1 in rk7srv.ini), external database settings and logins/passwords for SQL server are now chosen in section ‘External database link’ in properties of reports server (parameters of SQL server in Options --- Parameters --- Installation --- Reference server --- SQL server configuration are blocked).

4.5. Section ‘License information’

Here you choose USB key number for your reports server and enter license key.

For more information see: 1 License for reports server

4.6. Section ‘Data gathering

There is a list of restaurants and their midservers.

Note: all midservers with ‘inactive’ or ‘deleted’ status are also present in this list.

For every reports server put ticks for corresponding midservers (from that you want to gather data or recalculate cubes).

4.7. Section 'FTP server'

4.7.1. Same as cash servers, report servers have FTP protocol settings for closed shifts exchange.

4.7.2. FTP connection will be established between RK7 cash server and RK7 report server in case that report server is not parent of that cash server in main RK7 TCPSOC chain.

4.7.3. You must set in "FTP synchronization" section in advance, to make this function work.

4.7.4. You must open FTP ports in both server OS firewalls, for incoming and outgoing data.

4.7.5. You must specify TCPDNS section in ini file, for each link to those servers, which are set to exchange data.

5. Running reports server

5.1. Possible ways

5.1.1. Can be run as application (/desktop) or installed as service in Windows. Name of ini-file by default is repsserv.ini (you could change as in 5.1.1.2.).

5.1.1.1. Service may be named using command line parameter:

/srvname:SomeName - where on place of "SomeName" you can put any name

5.1.1.2. You can change ini file for some server using command line parameter:

/ininame:fileName - where on place of "fileName" you can put any name of ini file, which exists in the same folder

5.1.2. If you do not have license for this reports server (or if it is invalid), reports server will not run with UseSQL=1. In case of transport server always set UseSQL=0

5.1.3. If you run refserver as application and make a double-click on its icon in tray, you will see your reports server name in list of connected servers (in case connection was successful). 5.1.4. After reports server is successfully started, its icon will appear in Windows tray(in case you start it as application).

5.2. Web interface

5.2.1 If you make a right-click on tray icon, servers web page will be opened in your browser. (http://127.0.0.1:port/).

5.2.2. You could change port in Options -> OLAP reports -> "Reporting servers" your report server "HTTP server" settings section.

Note: after running reports server checks connection. As it is seen on screenshot above, corresponding midservers are now shut down.

5.2.3. Web interface tabs:
LogData
Logs + information about connections. Also is written in file repsserv.stk.
ServJobs
List of jobs (cubes recalculations, notifications, etc) + their statuses.
Tasks
List of tasks + their work times
Settings
List of settings from repsserv.ini.
FTPStatusColl
List of midservers (FTP connections) with connection statuses.
References
Reference data
CubeStat
Cube data.

6. Connecting manager station to report server

6.1. Setting in rk7man.ini

6.1.1. ini file format

[REFEDIT]
Server=rep1             //name of your reports server
Client=ENVIET_MAN       //network name of manager station that will connect to reports server

6.1.2. You are able to use one manager station to connect to different report servers (Alt+Ctrl+s).

6.1.3. You may have desktop shortcut for this manager station with name something like ‘reports’, etc.

6.1.4. A few clients (more than 1) to use RK7 report server simultaneously need proper licensing.

6.1.5. To make remote manager you have to:
6.1.5.1. put the files: borlndmm.dll, dllman.dll, errors32.dll, netkern.dll, thread32.dll, tcpsoc.dll, rk7man.exe, rk7man.ini – from original RK7 distributive anywhere to client computer;

if you want to use a language different from English, put rk7man.xxx (where xxx=rus or any other language code) to the same directory also;
6.1.5.2 start RK7 report server;
6.1.5.3. start rk7man.exe application;
6.1.5.4. press "Ctrl+Alt+s" when login window is active if you are going to connect to the server different from set in rk7man.ini "server" parameter;

[CustomSettings]  ;; to switch between report servers by CTRL+ALT+S

CustomServer00=TEST_RK7SRV

CustomServer01=TEST_REPSRVRK7SRV_02

6.1.5.5. in left bottom field appeared enter the name of the report server you want to connect to and your login info above (the same way to connect to reference server);

Your dealer account should be written like "RK7 xxxx" (where xxxx=dealers ID) as usually.

6.2. Recalculating cubes

6.2.1. Options --> OLAP reports --> Cubes and reports (run manager station in usual way). With right mouse button click on cube there is "recalculate" operation available.

If report server license has expired or invalid, you’ll not be able to connect to report server with manager station.

6.2.2. In property ‘Data processing’ of every cube there is a list of report servers and cube recalculation data (last/next generation, errors, etc.).

6.3. View only

6.3.1. When connected to report server all references are read only, no reference editing possible! If you want to edit something - connect to reference server.
6.3.2. In such a connection (read-only) user cannot create new elements (including cubes and reports) or change properties of existing (error message will be shown). So, you have access to view (if set so - you may set cubes be even hidden to view), but cannot change.
6.3.3. In this mode it is reasonable to create new user with privileges only for cubes and reports and hide all other elements on manager station.

7. How to configure reports servers for chain of restaurants

Example of configuration below is made for 2 restaurants in chain + ‘head office’.

How it works:

After common shift is closed on midserver1 in restaurant1, data is gathered on reports server1 and on reports server in ‘central’ office (and not transferred to reports server 2). The same rule for restaurant2: data from corresponding midserver is gathered in central office plus in ‘local’ reports server base.

7.1. Structure

7.1.1. Scheme

7.1.2. Install to some computer in ‘head office’:

   - refserver (‘main’ report server included)

   - manager station

   - ‘main’ SQL server with database

7.1.3. Install to some computer in each restaurant:

   - midserver #i

   - ‘local’ SQL server with database #i

   - local report server #i

7.1.4. Install front office applications and devices in each restaurant the same way as you do in standalone restaurant installation.

7.2. SQL databases

- for HO (in example – ‘reports_HO’)

- for restaurant #1 (‘reports_rest1’)

- for restaurant #2 (‘reports_rest2’)

7.3. ‘Stations and devices’

Create 2 restaurants and midserver for every of them.

7.4. ‘External database configuration’

3 configurations:

- for HO (database  ‘reports_HO’)

- for restaurant1 (database ‘reports_rest1’)

- for restaurant2 (database ‘reports_rest2’)

 

7.5. ‘Reporting servers’

Don’t forget to receive 3 licenses for 3 report servers

7.6. Ini-files

For report server 1:

[CONFIG]

;; Client (self) network name

Client        = "rep1"

;; Reference server network name

RefServer     = "reports_ref"

;; References database path

RefsBasePath  = ".\BaseData\refsdata.udb"

;; Check database path

CheckBasePath = ".\BaseData\check_db.udb"

;;Overalls path (received data)

ReceivedPath  = ".\Received\"

;; Errors file path

ErrorLog      = "repsserv.stk"

 

[NETKERN]

;; Comma separated protocols list

Protocols = tcpsoc.dll

 

For report server 2:

[CONFIG]

;; Client (self) network name

Client        = "rep2"

;; Reference server network name

RefServer     = "reports_ref"

;; References database path

RefsBasePath  = ".\BaseData\refsdata.udb"

;; Check database path

CheckBasePath = ".\BaseData\check_db.udb"

;;Overalls path (received data)

ReceivedPath  = ".\Received\"

;; Errors file path

ErrorLog      = "repsserv.stk"

 

[NETKERN]

;; Comma separated protocols list

Protocols = tcpsoc.dll

 

Manager station that connects to refserver:

[REFEDIT]

Server=reports_ref

Client=reports_man

 

Manager station that connects to reports server 1

[REFEDIT]

Server=rep1 //network name of 1st reports server

Client=reports_man1

7.7. Employees and their rights

Additional 2 groups of employees:

* for reports server 1

* for reports server 2

Set in properties of their roles:

* all privileges to view reports

* manager restrictions --- report servers

Set in properties of employees:

* basic --- reports server

* basic --- current restaurant

* login and password

 (starting from version 7.1.20.20)