R_keeper_7 web_reports based on interactive +Dashboard


1. Common


1.1. RK7 modern web_reports is additional module for interactive reports of RK7 report server DB.

1.2. Download installer from UCS FTP: ftp://ftp.ucs.ru/rk7/other/webreports/ (previous versions) or ftp://ftp.ucs.ru/rk7/other/dashboard/ (latest versions).

1.2.1. Deprecated versions had two sites: WebInterface and r_frame.

1.2.2. Version WebReportsSetup_1.1.6.11.exe used in this manual. There may be difference in later versions.

1.2.3. Versions after 1.9 have major changes in structure: only DashBoard interface left (other deprecated).

1.3. You have choice of web server: XSP or IIS. 

1.3.1. For latest versions you should use IIS.

1.3.1. You do set up IIS-server similar to other UCS software.

1.4. Make sure you do set unique TCP port for each service, avoid conflists with other software.

1.5. Different modules and applications you are allowed to install to different OS if necessary.


2. Installation


2.0. Get ready

2.0.1. Get files (distributive) from ftp://ftp.ucs.ru/rk7/other/dashboard/

2.0.1.0. You can get WebReports installer from other source as well

2.0.2. Check that all those UCS and alien software installed and running before:

2.0.2.1. UCS Common server

2.0.2.1. UCS RK7 interactive reports feature server, at least 1.25.1.0.

2.0.2.1.1. This FS must have "MasterServer=1" in ini.

2.0.2.2. UCS RK7 (core) report server, at least 7.5.4.180.

2.0.2.3. Microsoft SQL server with SQLNCLI11.1.

2.0.2.4. Microsoft .Net Framework 4.0+ (and .Net Framework 4.5+ for r_keeper_Dashboard) with  WCF HTTP activation.

2.0.2.5. Miscosoft IIS for Windows (in case you have chosen this web server).

2.0.2.5.1. IIS must have ASP.NET, ASP, .NET  extensions.

2.0.2.5.2. IIS must be registered in ASP.NET (using aspnet_regiis.exe from .NET Framework 4.0 package).

2.0.3. You have to install both API server and Web application for WebReports

2.0.4. You are able to install without installer, copy pre-configured folders to (new) server, add site and applications manually.

2.1. Start installer and follow steps.

2.1.1. You can install new instance or update existing with WebReportsSetup_x.x.x.x.exe.

2.1.1.1. There might be issues installing both IIS and XSP modes in one OS.

2.1.1.2. Correct path to IIS application site is http:\\address:port\webinterface\home\login, for XSP it is http:\\address:port.

2.1.2. Choose installation and press "next".

2.1.3. Select path for installation and instance name.

2.1.3.1. Path must have write permissions for web server and web user.

2.1.3.2. Instance name must be unique at least in current OS.

2.1.4. Select web server type and list of modules (connectors) will be used. At least choose "Web interface" and "Report browser".

2.1.4.1. In case you choose XPS web server type, it will be installed from this distributive (no need to download separately).

2.1.5. Choose port and protocol for web_reports, which will be used in client (browser).

2.1.5.1. Think about usage of non-default port (80) for security.

2.1.6. In case you chosen Dashboard link - set up DB connection on this step.

2.1.7. On this step enter Common server IP-address and port (CS must be online and FS "IR" connected to it).

2.1.8. Now choose one of installed in current OS IR FS and its version. This FS will provide reports from DB to web interface.

2.1.9. Press next and finish installation. There may be confirmation in cmd.exe window - do confirm.

2.2. Set rk7man

2.2.1. Go to "Extensions"->"Web menu" and set paramenets "Url" and "Visible" for each wannable report.

2.2.2. Go to "Option"->"Head office"->"Conceptions". Add at least one.

2.2.3. Go to "Option"->"Head office"->"Regions". Add at least one.

2.2.4. Assign Conception and Region to each restaurant in "Service"->"Stations and devices".

2.2.5. Go to "Employees"-> and set e-mail for each web user. This e-mail user as username in web login form.

2.2.5.1. For dealer, you can use "dealer ID" for login.

2.2.6. Go to "Extensions"->"Interactive reports (IR)" and set paramenets "Use as web-report" and "Visible" for each wannable report.

2.3. Config website

2.3.1. Check settings for WebInterface app in file ucsconfig.ini in folder [instance_name]\WebInterface\

[CommServer]
URL=http://172.22.3.200:7007/soap/UCSCommonWS
[FeatureServ]
FS_GUID={F4DED846-8913-4F1D-B5B5-5699CAC45DA9}

2.3.1.1. Set correct URL for common server

2.3.1.2. Set correct FS_GUID (that feature server must have compatible version.

2.3.2. Check settings for WebInterface app in folder [instance_name]\WebInterface\ file Web.config

<appSettings>
        <add key="webpages:Version" value="2.0.0.0"/>
        <add key="webpages:Enabled" value="false"/>
        <add key="PreserveLoginUrl" value="true"/>
        <add key="ClientValidationEnabled" value="true"/>
        <add key="UnobtrusiveJavaScriptEnabled" value="true"/>
        <add key="support_visible_attribute" value="true"/>
        <add key="logo_cloud" value="0"/>
        <add key="InstanceGuid" value="9C775E32-4D05-4012-B90B-7E2F73E35CEF"/>
        <add key="version_plugin" value="1.26.2.0"/>
        <add key="path_images" value="~/content/img/"/>
        <add key="maxJsonLength" value="50000000"/>
        <add key="langInterface" value="eng"/>
        <add key="enable_metrika" value="0"/>
    </appSettings>

 

2.3.2.1. make sure "version_plugin" is the same as your IR feature server

2.3.3. Check settings for ReportBrowser app in folder [instance_name]\ReportBrowser\ file Web.config

<appSettings>
        <add key="webpages:Version" value="2.0.0.0"/>
        <add key="webpages:Enabled" value="false"/>
        <add key="PreserveLoginUrl" value="true"/>
        <add key="ClientValidationEnabled" value="true"/>
        <add key="UnobtrusiveJavaScriptEnabled" value="true"/>
        <add key="InstanceGuid" value="9C775E32-4D05-4012-B90B-7E2F73E35CEF"/>
        <add key="logo_cloud" value="0"/>
        <add key="version_plugin" value="1.26.2.0"/>
        <add key="cs_server_url" value="http://127.0.0.1:7007/soap/UCSCommonWS"/>
        <add key="fs_server_guid" value="{F4DED846-8913-4F1D-B5B5-5699CAC45DA9}"/>
        <add key="dateFormat" value="dd.MM.yyyy"/>
        <add key="datetimeFormat" value="dd.MM.yyyy HH:mm:ss"/>
        <add key="timeFormat" value="HH:mm:ss"/>
        <add key="dayOfWeekStart" value="6"/>
        <add key="langInterface" value="eng"/>
        <add key="enable_metrika" value="0"/>
    </appSettings>

2.3.3.1. make sure "version_plugin" is the same as your IR feature server.

2.3.4. Check settings for Dashboard app in folder [instance_name]\Dashboard\ file Web.config

<appSettings>
        <add key="webpages:Version" value="2.0.0.0"/>
        <add key="webpages:Enabled" value="false"/>
        <add key="InstanceGuid" value="9C775E32-4D05-4012-B90B-7E2F73E35CEF"/>
        <add key="loggerOff" value="0"/>
        <add key="type_datasource" value="sql"/>
        <add key="version_plugin" value="1.26.2.0"/>
        <add key="cs_server_url" value="http://127.0.0.1:7007/soap/UCSCommonWS"/>
        <add key="fs_server_guid" value="{F4DED846-8913-4F1D-B5B5-5699CAC45DA9}"/>
        <add key="restaurant_code" value="199990024"/>
    </appSettings>

2.3.4.1. "restaurant_code" used for licensing check


3. Use


3.1. Check web server

3.1.1. In case use IIS, open "inetmgr" (cmd) and see Web site installed.

3.1.2. Web site must have several apps: WebInterface, ReportBrowser (and DashBoard - in case you have chosen it above).

3.1.2.1. Version 1.9 has WebReports application replacing ReportBrowser

3.1.3. In each app properties check which application pool assigned. Usually one "UCS_AppPool" for them all.

3.1.4. Go to application pools and check that each of used pools has correct .Net version.

3.2. Test web sites

3.2.1. Navigate your web browser to http://[server_ip]:[server_port]/webinterface/Home/Login , enter user e-mail and password (RK7).

3.2.1.1. After login navigate in menu to some report (on final click you will be transferred to reportbrowser or dashboard web app).

3.2.2. Navigate to http://[server_ip]:[server_port]/reportbrowser (with proverly formed request from webinterface)

3.2.2.0. In version 1.9+ link is http://[server_ip]:[server_port]/webreports

3.2.2.1. Submit report filter and get your report

3.2.3. DashBoard link is just to move to that separate application.

3.2.3.1. First login to DashBoard you need to do with dealer account (licensing procedure).


4. Licensing


4.1. WebReports module does need license

4.2. DashBoard module does need license

4.3. Modules use online licensing (no hardware key), but license linked to restaurant code.

4.4. Get master license and generate sub-license for each module in l.ucs.ru system for proper restaurant code.

4.4.1. There is no license request. Simply choose software and go to next step.

4.4.2. No need to save license code, it will be sent to application with automatic request.

4.5. License check will go automatically on web application start. Internet connection required (including firewall exceptions).


5. Update or delete


5.1. Use installer for upgrade. All steps there are self-explanatory.

5.2. Same simple installer usage for deletion (software uninstall).


6. Translate


6.1. Use UCS localization server project http://localize.ucs.ru/projects/WebInterface/

6.2. Choose your language or request support to create new language path.

6.3. Do translation up to 100% for each app:

6.3.1. WebInterface.xliff

6.3.2. ReportBrowser.xliff

6.3.3. WebDashboard.xliff

6.4. Download translated XLIFF files to different folders as below and rename as [language_name].xliff (example: de.xliff)

6.5. Put translated files to corresponding folders:

6.5.1. [instance_name]\WebInterface\SettingsFiles\

6.5.2. [instance_name]\ReportBrowser\SettingsFiles\

6.5.3. [instance_name]\Dashboard\SettingsFiles\

6.6. Edit web.config for each application as follows:

6.6.1. WebInterface

<add key="langInterface" value="de"/>

6.6.2. ReportBrowser

<add key="langInterface" value="de"/>

6.6.3. DashBoard

<langSettings>
        <values>
            <add key="en_calendar_format_date" value="DD.MM.YYYY"/>
            <add key="en_calendar_firstday" value="0"/>
            <add key="de_calendar_format_date" value="DD.MM.YYYY"/>
            <add key="de_calendar_firstday" value="1"/>
            <add key="fs_alt_lang" value="en"/>
            <add key="fs_alt_lang_Name" value="English"/>
            <add key="default_lang" value="de"/>
            <add key="default_lang_Name" value="German"/>
        </values>
    </langSettings>