1. General


1.1. System requirements

1.1.0. You have to prepare before oper_man (environment):

1.1.1. External software:

- Windows vista+
- Net framework 4.5+
 

1.1.2. UCS software:

- RKeeper 7.5.7.65 + access to RK7 References server's XML interface via HTTP
- CashMan 0.0.1.186+
- Store House 4.99+
- TimeKeeper:
    TK_forms.dll 7.5.26.333
    TK_FSServer.exe 7.5.26.195
    TKAServer.exe 7.5.19.34  
    TKReg.dll 7.5.19.29
    TK_DB_Setup.exe 7.5.26.52
- BKreport cofigured for SH4 and RK7 SQL DB

1.1.3.  at least 30 MB drive free space

1.2. Main functions

1.2.1. r_keeper_oper_man software is a web-based control center for management of:

1.2.1.1. r_keeper_7

1.2.1.2. store_house_4

1.2.1.3. time_keeper

1.2.1.4. r_keeper_cash_management

1.2.1.5. r_keeper_web_reports

1.3. Structure

1.3.1. Server (ApiServer.exe)

1.3.2. Client (Front web app)


2. Installation


2.1. ApiServer.exe configuring

2.1.1. You need to have in working folder properly set configuration files.
2.1.1.1. ApiServer.exe.config - main configuration file. near apiserver.exe.
2.1.1.1.1. ApiServer.exe.config description

<appSettings>

  <add key="HttpPort" value="9999" /> - self port for operMan
    <add key="UdlPassword" value="123456" /> - password for MSSQL (see Udl.Udl)
    <add key="Rk7XmlIp" value="192.168.101.82" /> - IP of RK7 References server's XML interface
    <add key="Rk7XmlPort" value="3355" /> - Port of RK7 References server's XML interface
    <add key="Rk7XmlUserName" value="User" /> - Login for user for access to HTPP XML interface
    <add key="Rk7XmlPassword" value="7" /> - Password for user for access to HTPP XML interface
    <add key="SH4ServerIP" value="192.168.101.140" /> - IP SH4 server
    <add key="SH4ServerPort" value="5672" /> - Port of SH4 server
    <add key="SH4ServerUserName" value="Admin" /> - Login for user SH4
    <add key="SH4ServerPassword" value="" /> - Password for user SH4
    <add key="BKReportExe" value="C:\UCS\BKReport\BKReport.exe" /> - path to BKReport.exe
    <add key="TKServerIP" value="192.168.101.82" /> - IP Feauture Server Time Keeper
    <add key="TKServerPort" value="8884" /> - Port Feauture Server Time Keeper

     <add key="IRUserName" value="d.morozov@ucs.ru"/>
      <add key="IRPassword" value="666"/>
      <add key="ReportBrowserUrl" value="http://127.0.0.1:8338/reportbrowser"/>
      <add key="ReportBrowserUrlExternal" value="http://127.0.0.1:8338/reportbrowser"/>
      <add key="UsedSystems" value="CashMan,SH,IR"/>
      <add key="ClientSettingsProvider.ServiceUri" value=""/>

</appSettings>

2.1.1.1.1.1. default port set by installer is 7777, you can change to any free port, but also set this for Front.
2.1.1.2. Udl.udl
2.1.1.2.1. for connection with RK7 SQL DB (MS OLE DB provider is recommended, DO NOT SAVE PASSWORD),
2.1.1.2.2. editable with Windows component
2.1.1.3. NLog.config
2.1.1.4. IRReportsDLL.dll.config
2.2. Use installer from ftp://ftp.ucs.ru/rk7/other/oper_man/0.6/
2.2.1. Start installer and choose instance or give name [instance_name]
2.2.2. Choose path with proper filesystem write permissions for IIS web server. This path will have subfolder named as [instance_name] from 2.2.1, resulting to [base_path].
2.2.2.1. ApiServer.exe will be installed to /API/ subfolder in [base_path].
2.2.2.2. The following settings will be saved to ApiServer.exe.config file inside \API\ folder.
2.2.3. Set TCP port for new web service
2.2.4. Select UCS software for connections of oper_man
2.2.5. Configure connectors
2.2.5.1. to r_keeper_7 cash server http interface
2.2.5.2. to store_house_4
2.2.5.2.1. Files for connector will be in \API\ShOle\ folder.
2.2.5.3. to web_reports
2.2.5.4. to cashman
2.2.5.5. to time_keeper
 
2.3. Front app configuration
2.3.1. This web application installed to subfolder \Front\
2.3.2. Configuration files
2.3.2.1. Web.config
<appSettings>
        <add key="ApiHost" value="http://127.0.0.1:9999"/>
        <add key="ApiTimeout" value="10000"/>
        <add key="ApiCookieName" value="X-UCS-LI-TOKEN"/>
        <add key="ApiCookieName_old" value="X-Token"/>
        <add key="webpages:Version" value="3.0.0.0"/>
        <add key="webpages:Enabled" value="false"/>
        <add key="ClientValidationEnabled" value="true"/>
        <add key="UnobtrusiveJavaScriptEnabled" value="true"/>
    </appSettings>

ApiHost - is connection link to ApiServer web interface

3. Startup and use

3.1. operMan server works as Windows service
3.1.1. installer will install OperManAPI: [instance_name] service and start that
3.1.2. For manual installation do start ApiServer.exe with /install parameter
3.2. Start "OperManAPI: [instance_name]" service (or "LiteInterfaceAPIService" - deprecated) in windows services.
3.2.1. Make sure that this server running on wannable HttpPort.
3.2.2. Log files will wrote into \Logs\ folder.
3.3. website installation
3.3.1. Open IIS manager in Windows and check that your new site named "oper_man_[instance_name]" running
3.3.2. On web site you must have application "Front"
3.4. Open browser and navigate to IP:port of website

4. Licensing


4.1. The same way as Dashboard.

5. Localization


5.1. There are english and russian preset.

5.2. You can chooose only one language for user interface.

5.3. Files must be in json format, and they are split into many folders in:

5.3.1. \Front\app\i18n\ folder

5.5. Change of language settings you do in [instance_name]\Front\app\app.config.js file

locale: 'ru'

or

locale: 'en'

5.6. Create new translation: http://localize.ucs.ru/projects/Oper_man/ for your language and complete it 100%.

5.6.1. When you translate string, keep variables unchanged (in {{ }} brackets)

5.7. Download .xliff file and use LocaleConverter.exe for conversion to json

5.7.1. LocaleConverter.exe has one settings file LocaleConverter.exe.config with the following parameters

<appSettings>
      <add key="dirJson" value="json"/>
      <add key="dirXliff" value="xliff"/>
</appSettings>

5.7.1.2. both parameters can be set as relative or absolute path to folders with source and target translation formats

5.7.2. Create folders for files as you set and put to "dirXliff" .xliff source file renamed as 2-letter language code (example: de.xliff)

5.7.3. you have to run LocaleConverter.exe with command line parameters (.bat file can be used)

localeconverter.exe -tojson -de

5.7.3.1. First parameter leave as shown above (this is conversion way)

5.7.3.2. Second parameter give as 2-letter language code (same as source file name)

5.8. Put resulting folders with json files into your "Front" subfolders correspondigly.