1. General information
1.1. For Webmonitoring RK7 version should be 7.3.9.0 and later. Webreports are OK since 7.4.21.39.
1.2. Use short pathways for each application obligatory (for example: C:\tomcat\; C:\java\; C:\ucs\).
1.3. It is possible to install Webmonitoring without Webreports or with them. Webreports cannot be used without Webmonitoring (properly installed and licensed).
1.4. In case of installation inside 64-bit OS you have to use 32-bit Webmonitoring components (including java and tomcat).
1.5. This software is deprecated now. Use to unstall webmonitoring.
2. Preparing for installation
2.1. Where can you get the original UCS webmonitoring distributive
2.1.1. Copy an archive with webmonitoring from the latest RK7 distributive (folder \bin\webmon\).
2.1.2. The latest RK7 distributive you are able to download from ucs FTPi server (ftp://ftpint.ucs.ru/dealers/rk7/).
2.2. What files and folders are there in the distributive
2.2.1. An archive webmonitoring.zip contains two folders: \MonDLL\ and \WebMonReps\.
2.2.2. Files in \MonDLL\ folder:
| borlndmm.dll dllman.dll errors32.dll MonASPCOM.dll MonDLL.dll MonDLL.ini Netkern.dll NetMonDLL.dll TCPSOC.dll Thread32.dll |
2.2.3. Files in \WebMonReps\ folder (also \WEB-INF\ directory and some other files there):
strings.xml reptypes.xml |
2.2.4. You may change images in webmonitoring folders also.
2.3. Non-UCS software
2.3.1. Download the latest version of Java runtime environment from official site: http://www.java.com/ (tested with version 6 update 27 x32).
2.3.2. Download the latest version of Apache Tomcat Windows Service Installer from official site:http://tomcat.apache.org/ (tested with version 7.0.22).
2.3.3. Do not forget to allow all necessary applications in environment security settings. In case of java client, you also have to allow running applet on each manager PC (picture below).
3. Installation
3.1. Non-UCS software
3.1.1. Install Java runtime environment. Write path to folder with Java DLL libraries to the windows system variable "Path" (see 3.5.).
3.1.2. Install Apache Tomcat (version 5.5 or later; we recommend you install the latest one); short pathway is obligatory.
3.2. UCS modules
3.2.1. Copy content of the archive webmonitoring.zip into \webapps\ folder of Apache Tomcat (from 3.1.2.).
3.2.2. Copy file MonASPCOM.dll from the distributive \MonDLL\ folder to \system32\ windows folder (enter these pathways into the windows operation system variable "PATH"; both to \MonDLL\ and \WebMonReps\ folders).
3.2.3. If you install webmonitoring for the restaurant with several cash servers, you have to create several copies of \MonDLL\ folder inside \webapps\ folder of Apache Tomcat. Give them unique names like \MonDLL1\ and \MonDLL2\ (that's because you cannot create several folders with the same name inside one directory). Please don't forget to enter all these pathways to the system variable "PATH".
3.2.4. In case of 3.2.3. you have to rename files MonDLL.dll and MonDLL.ini also. Rename them the same way as folders (for example: MonDLL1.dll and MonDLL1.ini - identical filenames obligatory, but extentions) correspondingly.
3.3. Setup files
3.3.1. MonDLL.ini
3.3.1.1. File format
| [Config] Station=WEBMONITORDEMO Server=ENGMIDSRV [NETKERN] Protocols=.\TCPSOC.dll [TCPSOC] LISTEN=0 [TCPDNS] ENGMIDSRV=127.0.0.1:49577 SECONDSERVER=1.1.1.123:9898 |
3.3.1.2. Settings description
3.3.1.2.1. The "Server=" parameter in [Config] section defines RK7 cash server network name (see in RK7 manager station or in RKEEPER.ini).
3.3.1.2.2. The "Station=" parameter defines webmonitoring client network name (unique one).
3.3.1.2.3. In case of 3.2.3. you have to set various "Server=" parameter values in each .ini file (for each cash server) and also various "Station=" parameter values.
3.3.1.2.4. The [TCPDNS] section parameters define RK7 cash servers IP addresses and ports as usually.
3.3.1.2.5. In case of 3.2.3. you have to set all cash servers [TCPDNS] strings in each .ini file (but only 1 and unique "Server=" parameter value).
3.3.1.2.6. You are recommended to use the following "Protocols=" parameter value format: "C:\tomcat\webapps\MonDLL\TCPSOC.dll" (see 3.3.2.1.).
3.3.2. settings.xml
3.3.2.1. File format
| <?xml version="1.0" standalone="yes"?> <Settings> <RepGenAddr/> <Enter/> <Strings File="strings.xml"/> <RepList/> <DLL File="C:\tomcat\webapps\MonDLL\MonDLL.dll"/> <RepPath Dir="C:\tomcat\webapps\WebMonReps\"/> <DataDir Dir="C:\tomcat\webapps\WebMonReps\"/> </Settings> |
3.3.2.2. Settings description
3.3.2.2.1. Strings "File=" – name of .xml file with translations (change to proper filename if necessary).
3.3.2.2.2. DLL "File=" – full name (with path) to the file MonDLL.dll (in case of 3.2.3. to any one).
3.3.2.2.3. RepPath "Dir=" and DataDir "Dir=" – pathway to the folder, where WebMonReps are installed (no gaps in pathway are possible).
3.3.2.2.4. Pay attention to capital and non-capital letters (program is register-sensitive, capital letters are considered as different).
3.3.2.2.5. If cash server for the DLL file from 3.3.2.2.2. is switched off, then monitoring doesn’t work, even if there are other started midservers.
3.3.2.2.6. <RepGenAddr /> tag "Addr=" parameter is the report server IP address (in RK7 report server properties Web reports->Bind port parameter you must set port 2211 obligatory).
3.3.2.2.7. <RepList /> tag "File=" parameter is the report list filename.
3.3.2.3. Settings with Webreports
| <?xml version="1.0" standalone="yes"?> <Settings> <RepGenAddr Addr="198.154.196.80"/> <Enter PWD="2"/> <Strings File="strings.xml"/> <RepList File="reptypes.xml"/> <DLL File="C:\tomcat\webapps\MonDLL\MonDLL.dll"/> <RepPath Dir="C:\tomcat\webapps\MonRep\WebReps\"/> <DataDir Dir="C:\tomcat\webapps\WebReps\"/> </Settings> |
3.3.2.3.1. 'RepGenAddr' tag 'Addr' parameter is RK7 report server IP address, which is currently running, licensed, with cubes recalculated, listening on TCP port 2211 for WebRep connections.
3.3.2.3.2. See 3.4.3. for RK7 report server settings.
3.3.3. monitors.xml
3.3.3.1. File format
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MIS> <MI Path="C:\tomcat\webapps\MonDLL\MonDLL.dll" Name="ENGMIDSRV"/> <MI Name="TOTALS" Sum="1"/> </MIS> |
3.3.3.2. Settings description
3.3.3.2.1. In case of 3.2.3. create as many copies of tag <MI /> as a number of cash servers in the restaurant. "Name=" parameter value is a name of cash server (that will appear on webmonitoring page). "Path=" parameter value is a full pathway to MonDLL.dll for this cash server.
3.3.4. monclnts.xml
3.3.4.1. File format
| <?xml version="1.0" encoding="UTF-8" standalone="true"?> <USERS> <USER PWD="1" UN="1"/> <USER PWD="2" UN="2"/> <USER PWD="3" UN="3"/> </USERS> |
3.3.4.2. Settings description
3.3.4.2.1. List of webmonitoring users (with passwords) is stored in this file. "UN=" – user login; "PWD=" – user password.
3.3.4.2.2. You are able to add or remove any quantity of <USER /> tags.
3.3.5. strings.xml
3.3.5.1. File format
| <?xml version="1.0" encoding="UTF-8" standalone="true"?> <ResStrings> <RS Value="Forward" Name="Forward"/> <RS Value="Back" Name="Back"/> <RS Value="Refresh" Name="Update"/> <RS Value="Clear" Name="Clear"/> <RS Value="Reports" Name="Reports"/> <RS Value="Report" Name="Report"/> <RS Value="Call report" Name="CallReport"/> <RS Value="Show" Name="Show"/> <RS Value="Password accepted" Name="PasswordAccepted"/> <RS Value="Username" Name="USERPWDTableName"/> <RS Value="Password" Name="USERPWDTablePWD"/> <RS Value="Day period" Name="WritePeriodPeriod"/> <RS Value="Parameter" Name="WritePeriodParam"/> <RS Value="Value" Name="WritePeriodValue"/> <RS Value="Order" Name="Order"/> <RS Value="Ordes" Name="Orders"/> <RS Value="Check list" Name="OrderList"/> <RS Value="Check" Name="Check"/> <RS Value="Plan" Name="Plan"/> <RS Value="Cash date" Name="CashDate"/> <RS Value="Date/Time" Name="DateTime"/> <RS Value="Balance" Name="Balance"/> <RS Value="Open orders sum" Name="OrderSum"/> <RS Value="Waiters sum" Name="WaitSum"/> <RS Value="Dish sales" Name="DishExp"/> <RS Value="Sales" Name="Ttl"/> <RS Value="Common" Name="Ttl0"/> <RS Value="by cashiers" Name="Ttl1"/> <RS Value="by waiters" Name="Ttl2"/> <RS Value="by stations" Name="Ttl3"/> <RS Value="by order categories" Name="Ttl4"/> <RS Value="Service-print" Name="PrintService"/> <RS Value="Hall Plan" Name="HallPlan"/> <RS Value="Statistics" Name="Statistics"/> <RS Value="Send message" Name="SendMessage"/> <RS Value="Reports (Cube)" Name="CallReports"/> <RS Value="Waiter" Name="SMName"/> <RS Value="Message" Name="SMMessage"/> <RS Value="Message was sucessfuly sent!" Name="SMMessageOK"/> <RS Value="There was error while sending message" Name="SMMessageErr"/> </ResStrings> |
3.3.5.2. Settings description
3.3.5.2.1. In this file you can edit screen strings. You are able to enter any language in parameter "Value=".
3.3.6. reports.xml
3.3.6.1. File format
| <?xml version="1.0" encoding="UTF-8"?> <Reports> <Server> <RepGr Name="Show"> <Report Name="Service-printing" ID="1"/> <Report Name="Cash station date" ID="2"/> <Report Name="Orders" ID="4"/> <Report Name="List of receipts" ID="5"/> <RepGr Name="Hall plans"> </RepGr> </RepGr> <RepGr Sum="1" Name="Statistic"> <Report Sum="1" Name="Balance" ID="6"/> <Report Sum="1" Name="Sums by orders" ID="7"/> <Report Sum="1" Name="Sums by waiters" ID="8"/> <RepGr Sum="1" Name="Revenue"> <Report Sum="1" Name="Common" ID="9"/> <Report Sum="1" Name="by cashiers" ID="10"/> <Report Sum="1" Name="by waiters" ID="11"/> <Report Sum="1" Name="by stations" ID="12"/> <Report Sum="1" Name="by groups of stations" ID="14"/> </RepGr> <Report Name="Sold dishes" ID="15"/> <Report Name="Work time control" ID="1002"/> </RepGr> <Report Name="Send message" ID="11111"/> </Server> </Reports> |
3.3.6.2. Settings description
3.3.6.2.1. In this file you can change or translate screen monitors names in the "Name" parameter.
3.3.6.2.2. <Report /> tag "Sum=" parameter with "1" value turns on this monitor on the webmonitoring "totals" tab (sum of all cash servers data).
3.3.7. servers.xml
3.3.7.1. File format
| <?xml version="1.0" encoding="UTF-8" standalone="true"?> <MIS> <MI Name="ENGMIDSRV"/> <MI Name="TOTAL (ALL CASH SERVERS)" Sum="1"/> </MIS> |
3.3.7.2. Settings description
3.3.7.2.1. This is a list of webmonitoring tabs. Translate them or change if necessary.
3.3.8. reptypes.xml
3.3.8.1. File format
| <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ReportTypes> <ReportType> <RepName>2006</RepName> <RepShowName>Waiters</RepShowName> <RepParamNum>2</RepParamNum> <RepParam1 showname="startdate" name="startdata" type="data"/> <RepParam2 showname="enddate" name="enddata" type="data"/> </ReportType> <ReportType> <RepName>2003</RepName> <RepShowName>Categories</RepShowName> <RepParamNum>2</RepParamNum> <RepParam1 showname="startdate" name="startdata" type="data"/> <RepParam2 showname="enddate" name="enddata" type="data"/> </ReportType> <ReportType> <RepName>2004</RepName> <RepShowName>Discounts</RepShowName> <RepParamNum>2</RepParamNum> <RepParam1 showname="startdate" name="startdata" type="data"/> <RepParam2 showname="enddate" name="enddata" type="data"/> </ReportType> <ReportType> <RepName>2005</RepName> <RepShowName>Stations</RepShowName> <RepParamNum>2</RepParamNum> <RepParam1 showname="startdate" name="startdata" type="data"/> <RepParam2 showname="enddate" name="enddata" type="data"/> </ReportType> <ReportType> <RepName>2001</RepName> <RepShowName>Payments</RepShowName> <RepParamNum>2</RepParamNum> <RepParam1 showname="startdate" name="startdata" type="data"/> <RepParam2 showname="enddate" name="enddata" type="data"/> </ReportType> <ReportType> <RepName>2002</RepName> <RepShowName>Dishes</RepShowName> <RepParamNum>2</RepParamNum> <RepParam1 showname="startdate" name="startdata" type="data"/> <RepParam2 showname="enddate" name="enddata" type="data"/> </ReportType> </ReportTypes> |
3.3.8.2. Settings description
3.3.8.2.1. <RepName /> tag content is a report Code from RK7, which must have layout assigned obligatory.
3.3.8.2.2. <RepShowName /> tag contains this report name shown inside Webmonitoring.
3.3.8.3. Additional info about Webreports
3.3.8.3.1. This version of Webreports is obsolete one. It is recommended to use FastReportServer software (or any other software which takes data from RK7 external database).
3.3.8.3.2. You are able to put any user report with layout assigned to Webreports list, setting proper codes in reptypes.xml.
3.3.9. WEBMonCli.html
3.3.9.1. File format
| <param name="Location" value="http://198.154.196.80:8080/WebReps"> |
3.3.9.2. Parameter "value=" change url to the legacy http pathway to the folder with WEBMonCli.html file.
3.3.9.3. You are allowed to connect to this application using only this url (entering as web browser address), trying to connect using another valid url will result in java error.
3.4. Setup RK7 manager station
3.4.1. You have to change webmonitoring layouts contents into your language by copying preset ones.
3.4.2. Remember changing layout views in printing scheme(s).
3.4.3. For webrep, you should set report server to listen on TCP port 2211 and save reports to 'RepPath' folder (see 3.3.2.3.).
3.5. How to edit system variable Path
3.5.1. Windows Control panel -> System -> Advanced properties -> Environment variables -> System variables -> Path and press Edit.
3.5.2. Pathways in the system variable "PATH" value should be divided with semicolon.
4. Webmonitoring licensing
4.1. License request
4.1.1. License is generated in LM or on UCS license site (http://support.ucs.ru:8080/rkeeper-license/).
4.1.2. As usually, you have to generate both master and sub licenses.
4.1.3. In new sub license form please choose:
4.1.3.1. Software name = RKeeper 7 Web Monitoring;
4.1.3.2. Reason = New license;
4.1.3.3. Station count = 1 (doesn’t play any role, so leave by default);
4.1.3.4. Request code = field is not to be filled in (leave empty).
4.1.4. Generate activation code (it will be shown in corresponding field) and copy it to the manager station.
4.2. Enter license to manager station
4.2.1. On manager station activation code for web-monitoring is entered in properties of restaurant:
4.2.1.1. In Service -> Stations and devices -> All -> [your restaurant] paste license code to the "License information" section "Web monitor" parameter:
4.3. Webreports license
4.3.1. You have to get separate master license for "Web reports" (+ generate sub-license and apply that) the same way (before start).
4.3.2. Client session quantity (web) is not limited.
5. Localization
5.1. Translate files strings.xml and reports.xml from \WebMonReps\ folder. Use UTF-8 coding.
5.2. Check pathway to these files in settings.xml.
5.3. Restart midserver, tomcat and browser to see changes.
6. Start applications
6.1. Start midserver and tomcat (after login you will see network name of your webmonitoring client in cash server GUI "stations" tab).
6.2. Start webmonitoring in internet browser = go to its page (we recommend you to use Internet explorer 6 or later): http://127.0.0.1:8080/WebMonReps/WEBMonCli.html.
6.3. If you start webmonitoring from another computers, in file WEBMonCli.html in string <param name="Location" value=http://localhost:8080/WebMonReps/WEBMonCli.html> change “localhost” to the legacy IP address or network computer name (where tomcat is installed). Connection is possible only to 1 (usually external public) hostname (DNS) or IP address.
6.4. After webmonitoring login window appeared in your browser, enter legacy username and password (from file monclnts.xml).
6.5. Each monitor is to be opened by doubleclick.
6.6. You may use menu buttons for windows sequencing:
7. Troubleshooting
7.1. In some cases webmonitoring may fail to operate properly because of other copies of its files exist in the system with wrong settings, than those extra files should be deleted.
7.2. Sometimes it won't work till restart.
7.3. Contact UCS techsupport.