1. Common information


1.1. R-Keeper CRM v.7 has a set of new features and differences in comparison to R-Keeper CRM v.5. Main changes are described below, for full list please read  Changes in CRM 7.pdf  located in ftp://ftp.ucs.ru/R-Keeper.CRM/versions/CRM_7_doc_beta.7z.

1.2. If installer is unavailable It is possible to update CRM v.5 to v.7 with authorisation server from new version archive.

1.3. Differences between R-Keeper CRM 5 and v.7

  1. Deployment/Update of database moved to card server. Update can be performed from any version of CRM without installation of incremental updates. 

  2. Main files are renamed: 

  • card server (CS_Auth_Server.exe --> RKeeper_CRM_Server.exe)

  • editor (Cards_Editor.exe --> RKeeper_CRM_Manager.exe)

  • farcards library (CardSystem5_RK7.dll --> RKeeper_CRM.dll)

  • configurator (Configurator.exe --> RKeeper_CRM_Config.exe)

  • sever automatic processing(CS_Monitor.exe --> RKeeper_CRM_Monitor.exe)

  1. New files added:
  • localization for server, configurator and manager - RKeeper_CRM.lng

  • preliminary setting of tables for user changes saving  - RKeeper_CRM_history.cst

  • SSL-certificates

    • RKeeper_CRM_SSLca.cer

    • RKeeper_CRM_SSLwork.cer

    • RKeeper_CRM_SSLwork.key

  • SSL protocol libraries

    • libeay32.dll

    • ssleay32.dll

  • built-in farcards libraries

    • dllman.dll

    • errors32.dll

    • farcards.dll

    • netk.ini

    • Netkern.dll

    • pds_netk.dll

    • TCPSOC.dll

    • Thread32.dll

work contacts limitation file (mailing only to contacts from this file) - RKeeper_CRM_Limit_Contacts.txt

  1. Moved to on-line licensing (l.ucs.ru), Guardant keys are not used. License is defined by number of clients in database. 

  2. FarCards is integrated into card server (can be changed in configurator). Card server connection library renamed from CardSystem5.dll to Rkeeper_CRM.dll.

  3. Card server moved to HTTP(S) protocol.

  4. API Global_Type parameter is not used for outer sources.

  5. DLL-actions moved to SQL-actions.

  6. Changed Reports management:

  • view and edit reports (Reports_Manager.exe)

  • reports data provider (CS_DataProvider.exe)

  1. No mailing libraries necessary (csa_SendEMail.dll and csa_SendSMS.dll) any more, implemented in server application. Set up this in RKeeper_CRM_Config.exe.

  2. Note: R-Keeper CRM versions 7 or higher have limited support of RK6.


2. Installation


2.1. Preparing environment (OS)

2.1.1. Make sure you have set all security levels to allow running CRM without Windows UAC restrictions.

2.1.2. Check that your OS language and regional standards are set to your country national defaults.

 

To ensure problem-free and fast installation of R-Keeper CRM target computer must be appropriately prepared. User performing installation of R-Keeper CRM must have Administrator rights in Windows system. Any other software that uses midas.dll and Borland SocketServer must be removed from system to make sure that installation will register those services (midas.dll and SocketServer) correctly. Correct functioning of any third-party software that uses midas.dll and Borland SocketServer is not guaranteed!

Attention! R-Keeper CRM uses protection system that vaccinates protected files. These files are usually detected by antivirus software as infected (a virus). R-Keeper CRM files must be added to antivirus software exclusions( especially *.exe files, database files ang GrdVkc.dll).

2.1.5. Windows Firewall preparation

Windows Firewall must be configured to allow inbound connections to MSSQL server, both TCP and UDP. MSSQL by default uses port 1433 for TCP connection and port 1434 for UDP connection. Create new inbound rule in Windows Firewall with TCP and UDP ports of your MSSQL server. 

 

2.2. CRM installer

R-Keeper CRM installer can be downloaded from UCS FTP server ( ftp://ftp.ucs.ru/R-Keeper.CRM/versions).

Installer must be started with "Run as Administrator" option. Complete following installation steps:

 

 

 

 

 

R-Keeper CRM can work as a system service which is useful and simple to install.


3. Configuration (R-Keeper CRM Configurator)


Run RKeeper_CRM_Config.exe and set up system parameters.

 

1. Card system application

This page contains settings for R-Keeper CRM Card server, Authorisation server,  Automatic operations server and COM-readers.

1.1 Card server tab

1. MSSQL connection string must have this format: MSSQL IP Adress,Port:CRM Database name . Fill Login and Password fields then press Connection verification to test connection.

2. If Card editor and Server will be used on the same computer then leave default values in Editor connection to cars server field (port must not be in use be Borland Socket server).

3. Mask is input mask for identification of cards.

4. Press Save after each change of settings.

 

1.2 Authorisation server (API) tab

1. Port (HTTP) - HTTP port for external connection to CRM server. Default is 9192.

2. Port (HTTPS) - default HTTPS port for external connection to CRM.

3. Stream q-ty - number of concurrent processed threads.

4. Buffer size - exchange buffer size.

5. Registration code active time - waiting time for registration code sent by Email/SMS when registering from external system (virtual card, private account).

6. Logging level parameter controls logging process and regulates quantity of log files. Not recommended to change.

 

1.3 Automatic operations server tab

1. SW classifier default value is automatic operations monitor. Not recommended to change.

 

1.4 Input/output devices tab

Contains settings for card readers (magnet, contactless, etc.). Read http://support.ucs.ru/ru/node/7342 for more.

 

 

2. User management and reports application

This page contains settings for User management and reports.

All values in this tab are set automatically by installer. If User Manager fails to run then change connection type value to DCOM.

 


4. Licensing


  1. Submit a request for Master license on https://l.ucs.ru/WorkLicense.

1.1. There are several options of license depend on your card quantity limit.

1.2. Choose one of "R-Keeper module CRM V7 software".

  1. After license verification generate license code without request code thus activating the license. Detailed information about license without request can be found here: http://support.ucs.ru/ru/node/7161#header-22.

  2. Run RKeeper_CRM_Server.exe with /desktop parameter, right-click on the icon in notification area and click Restore.

  3. Click Licesnses tab in server window. Type dealer ID in User field then dealer password in Password field. Press Log in as a dealer button.

  4. Click drop-down list and choose your object, then press Request a license for object button. New license information should show up on right side of the window. Note that the system does not save User and Password.

Attention! If you do not receive license information then check if port 60606 is available.

 


5. Running R-Keeper CRM 7


  1. Run RKeeper_CRM_Server.exe with /desktop parameter.

  2. Click General tab and check if server registered (DB version, DB path and DB username are displayed). 

 

Attention! If DB path or DB version are not displayed then system is not working correctly.

Possible reasons:

  • Midas is not registered;
  • DB was not created correctly;
  • MS SQL Server is not running;
  • Incorrect DB connection credentials (check R-Keeper CRM Configurator settings);
  1. Run User Manager (User_Manager.exe). Default user and password are those you specified in DB creation script.

4.1. "Administrator" and "1". Edit users and rights then save changes. More at http://support.ucs.ru/ru/node/7710.

        Note: if User Manager fails to run see pt. 2 (User Manager and reports application).    

  1. Run Card Editor (RKeeper_CRM_Manager.exe). Use default or any other account created in User Manager.

  2. For actions (if used) run RKeeper_CRM_Monitor.exe.


6. Connection with R-Keeper 7


6.1. Common

6.1.1. Connection between R-Keeper CRM 7 and R-Keeper v7 is handled by FarCards card retranslator.

6.2. Ways

6.2.0. Current version of R-Keeper CRM has option to run FarCards internally (integrated into main server) without need to run external FarCard service.

6.2.1. Built-in FarCards is partially configured automatically by installer. 

6.2.2. Internal farcards.dll library used with farcards.ini settings as below.

6.3. Setup farcards

6.3.1. In order to use external FarCards it must be installed and configured according to CRM5 article: http://support.ucs.ru/en/node/5619

6.3.2. As for internal solution, farcards.ini settings have the following difference:

[Card System 5]

Address=http://127.0.0.1:9192

Log_Level = 10
Log_Count = 5
Qualifier=EHkZ98qrp4t82z4kj3Lq
QualifierMulti=1
QualifierMultiBlocked=1
Images_Path = C:\UCS\CRM7\images\
HasCredit=1
HasUnitInfo=1
HasPrintInfo=1

6.3.2.1. [Card System 5] section

6.3.2.1.1. «Address» parameter is HTTP url to CRM server HTTP port

6.3.2.1.2. QualifierMulti enables multiple restaurants to use one FarCards

6.3.2.2. [FarServer] section parameter «DLL» - link library filename (default RKeeper_CRM.dll)


6.4. Applications communication scheme

6.4.1. scheme presented below.

6.5. R-Keeper 7 configuration

6.5.1. Add PDS interface to the Drivers tab of cash server and give it the same name as your CRM instance. Parameter NetServerName in Farcards.ini has to have same value

6.5.2. Go to Service->Interfaces and make a copy of preinstalled Personal Discount System (PDS) interface. Name it and bind it to cash server PDS interface from previous step.

6.5.3. To enable display of client info go to Options -> Parameters -> Installation -> Link with other systems -> Personal Cards -> PDS Show card info. Enable parameter (Boolean).

6.5.4. To enable display of client photo go to Options -> Parameters -> Installation -> Link with other systems -> Personal Cards -> PDS Show card image. Enable parameter (boolean).

6.5.5. To enable display of "Pay Button" go to Options -> Parameters -> Station parameters -> Order editing -> Calc/Pay order -> Pay by payment card. Set value to "Ask".

6.5.6. Go to Service -> Device Signals Processing -> MCR Algorithms. Create new MCR Algorithm. Choose "Interface" in Scope parameter, then add previously added PDS Interface in Object parameter. Choose "Masked input" in Algorithm type parameter. Fill in Input mask parameter.

6.6. CRM configuration

6.6.1. Set up software classifier(s) for R-Keeper 7 in CRM Card Editor.

6.6.1.1. Classifiers are used to connect CRM with other systems (like R-Keeper, Delivery etc.). Each system has to have its own unique qualifier so it could have access to accounts in CRM.

6.6.1.2. For several restaurants, you need several classifers with unique codes.

6.6.1.2.1. Each classifier in CRM can use its own FarCards instance or one FarCards for several classifiers.

6.6.1.2.2. For multiple classifiers support in one farcards, you must have correct external restaurant codes set for each classifier. See also special ini parameters above.

6.6.1.3. All types of accounts used by particular system (RK7 in this case) must be tied to its classifier in CRM. 

6.6.1.4. Go to menu "File" -> "SW Classifiers" in Cards Editor (RKeeper_CRM_Manager.exe) and configure classifier(s) for RK7

6.6.1.4.1. Code: is unique "sw classifier" object identifier. Corresponding parameter "Qualifier" in farcards.ini has the same value.

6.6.1.4.2. "External" is full restaurant code from RK7 system (9 digit).

6.6.1.4.3. "Type" is partial restaurant code from RK7 system (4 digit).

6.6.2. Add accounts in Account types reference. Tie them to RK7 sofware classifier.

6.6.3. Add new group in Groups of cardholders reference.

6.6.4. Add new group in Groups of cards reference.

6.6.5. Add at least 1 card range in Card ranges reference.

6.6.6. Add at least 1 cardholder

6.6.7. Issue at least 1 card and attach it to cardholder.

6.7. Connection test

Check if cash server initialized PDS interface for CRM. Run cash server with /desktop parameter, double-click its icon in notification area then click "Interfaces" tab.

 

Run cash station. Create new order. Slide card (press ctrl+alt+k buttons to enter card number manually). Client info window should appear. This means that RK7 exchanged information with CRM and connection between them works correctly.

 


7. Localization


7.1. See manual http://support.ucs.ru/en/node/8917


8. Upgrade from R-Keeper CRM 5 to R-Keeper CRM 7


8.1. Create backup and copy of CRM5 SQL database.

8.1.1. In case you upgrade in-place, just duplicate DB.

8.1.2. In case your CRM5 uses FireBird DB, upgrade it to CRM5 with MSSQL first.

8.2. Extract distributive of CRM7 from installer to some folder (default: C:\UCS\CRM7)

8.2.1. Add missing files from CRM5 working folders

8.2.1.1. \Config\ folder with .xml file

8.3. Upgrade version of external modules and check OS

8.3.1. dbxsda70.exe

8.3.2. allow UCS license server connection in firewall (l.ucs.ru:80 and l.ucs.ru:60606)

8.4. Use RKeeper_CRM_Config.exe to change and set all the new settings .

8.5. Start in desktop mode RKeeper_CRM_Server.exe ( /desktop )

8.5.1. confirm DB upgrade.

8.5.2. Add license like for new installation (licensing tab in GUI). See p.4 above.

8.6. Import rights to upgraded database using User_Manager.exe from Rights_Cards_RUS.xml.

8.7. Change Actions from dll-type to csa-type.

csa_AccountRepeatDepositing.dll->csa_scheduler_AccountRepeatDepositing_700.csa

csa_AccountUseLimit.dll ->csa_accountinfo_UseLimit_700.csa

csa_BalanceToCoupon.dll->csa_scheduler_BalanceToCoupon_700.csa

csa_LevelTransitStandartExt.dll->csa_scheduler_LevelTransit_700.csa

csa_NotificationAndReward.dll->csa_scheduler_NotificationAndReward_700.csa

csa_Pyramid.dll->csa_scheduler_Pyramid_700.csa

csa_TransactionDopDepositing.dll->csa_transaction_OnlineAdditionalCharge_700.csa

8.8. Change settings for external connectors

8.8.1. For FarCards, set as in p.6 above (optionally). It is possible to run in CRM5 mode (partially compatible protocol).