[+]
System Settings
[+]
Programs
[+]
[+]
Reports
[+]
Card Operations
[+]
Administration
 
Updated on 10/6/2017
Direct link to topic in this publication:
iikoCard
iikoCard Local Installation

You can always use a local version of the iikoCard5 main server instead of the global one available at http://iiko.biz. One is able to connect iikoRMS and POS to the local server, and configure marketing programs the same way as it is done on the iiko server.

This document explains how to install and set up the main server on your equipment in the local area network.

System requirements

Minimum system requirements for the equipment you plan to install iikoCard5 server on:

  • Operating system - Windows Server 2012R2x64.
  • Processor - Intel Core i5 or similar.
  • RAM - 6GB.
  • Free disk space - 100GB.
  • DBMS - Microsoft SQL Server 2014 and higher.

Use a dedicated machine for iikoCard5 and its database. Do not use the same computer for both iikoCard5 server and iikoRMS server or iikoChain server!

Installation and setup of the main server

To install iikoCard5 server, follow this:

  1. Get approval for local installation of iikoCard5 from the iiko's Partner Department.
  2. Download the setup file from ftp and save it on the hard drive of the computer you plan to install the iikoCard5 server on.
  3. Run Setup.iikoBiz.exe under admin and follow installation instructions. As a result, the main server will be installed in the C:\ProgramFiles\iiko\iikoBiz directory with the following subdirectories:
    • Web Interface - iiko.biz files.
    • Host Service - iiko.biz service.
  4. IikoBiz Host Service will appear on the list of services, and website\websites\Default Web Site\iikoBiz in IIS.

    If MS SQL with a Resto copy has never been installed on this computer, MS SQL 2014 Express will be installed. You can keep SQL Express if you assume that iikoCard5 server load will be minimum. We recommend that you install a commercial MS SQL Standard or MS SQL Enterprise on the same computer or a dedicated one.

    If MS SQL with a Resto copy has already been installed on this computer, the database will be determined automatically during the installation.

  5. RabbitMQ messaging server will be installed along with the main iikoCard5 server. You have to create a new account to connect it to iikoRMS. For this:
    1. Open a browser on the machine where RabbitMQ has been installed and go to http://localhost:15672.
    2. Enter the default login and password - guest/guest, and click Login.
      Information For safety reasons, one is able to use this account to enter RabbitMQ server only within local network.
    3. Go to the Admin section.
    4. Expand the Add user item.
    5. Enter a username, set a password and click Add user.
    6. To access user properties, click on the username in the table.
    7. Provide the user with an access to virtual hosts. For this, click the Set Permissions button. Now you are able to specify the user data in the iikoRMS to RabbitMQ connection settings.
  6. Use this configuration file to change server settings.
  7. In case you have edited the server configuration override file (see §3), restart iikoBiz Host Service to apply the new settings.
  8. Check if the iikoCard5 server is operational. For this:
    1. Make sure iikoBiz Host Service is running.
    2. The service is logged in C:\logs\iikoNetServer. Once the server is installed and the service is running, check the iikonet -server-error.log file for errors.
    3. Make the following request http://localhost:9900/api/0/auth/access_token?user_id=test&user_secret=test. A server is operational if it returns the following:
    4. {"code": null,
      "description": null,
      "httpStatusCode": 500,
      "message": "Wrong user name [test] or password [test]." 
      }
    5. Go to http://localhost/iikobiz in a browser. If everything is set up properly, you will be taken to the iiko.biz login page.
      Information During the installation, an account with the default username and password will be created - admin/admin. The password cannot be changed in the current version of the system. This account has a wide range of permissions: it has all the iiko.biz companies available, as well as additional administrative functions.
  9. Write the RabbitMQ server connection key in the iikoRMS resto.properties configuration file: rabbit-mq-uri=amqp://USER:PASSWORD@HOSTNAME:5672. Here USER and PASSWORD are the login and password of the user you have created in §4; HOSTNAME and 5672 - name and port of the RabbitMQ server. You need this to register a company at the local iiko.biz portal.
  10. The connection string might be as follows: rabbit-mq-uri = amqp://user1:pass123@myhost:5672.

  11. Restart the iikoRMS server.
  12. In iikoRMS, specify connection settings of your iikoCard5 server and the RabbitMQ server. For how to do it, refer to the iikoCard5 Connection article.
  13. Register your company at your own local iiko.biz server. For details, refer to the Registration at iiko.biz article. Your company will be registered on your own copy of iikoCard5 server; connection to which you have set up under §7.
  14. Authenticate at the local iiko.biz portal using the credentials specified at the registration.

Alternative configuration file

IikoCard5.Pos.Host.exe.config is the main iikoCard5 configuration file. During an update, an installer overwrites the server. Any changes made will reset to their defaults. To avoid this, you can specify iikoCard5 server parameters in a special file which won’t be overwritten when an update takes place, and your settings will be preserved.

This configuration file is iikoBizServer.override.config and can be found in C:\Users\iikoBizSvc\AppData\Roaming\iiko\iikoBizServer.

By default, this file has the following structure:

<overridableAppSettings>
   <add key = “KEY"value =“VALUE"/> 
</overridableAppSettings>

Insert the required key and specify its value instead of <add key=”KEY” value=”VALUE” />. For example:

<overridableAppSettings>
   <add key="db.connection_string" value="Data Source=localhost\RESTO;Initial Catalog=iikoCard5;Integrated Security=True;" />; 
<addkey="db.connection_string.master" value="Data Source=localhost\RESTO;Initial Catalog=master;Integrated Security=True;Connection Timeout=5;" /> </overridableAppSettings>
Warning Each time you edit the configuration file, restart iikoBiz Host Service to apply the changes.

In the iikoBizServer.override.config file, you are able to specify the following:

  • MS SQL connection settings if the data base is other than default:
    • db.connection_string - data base connection string.
    • db.reports.connection_string - data base connection string used for reports.
    • db.connection_string.master - DB master connection string.
  • RabbitQ connection settings if other than default:  RabbitMqUri - RabbitMQ server connection string.
  • SMS sending parameters:
    Information You will be able to obtain the parameters from your provider upon registration. One is able to learn which SMS services iikoCard5 is compatible with as well as some configuration examples in the next  paragraph.
    • SmsProvider_Company - name of the company that provides SMS service.
    • SmsProvider_Login - API login obtained from an SMS provider.
    • SmsProvider_Password - API password obtained from an SMS provider.
    • SmsProvider_Gate - address (without port) an SMS provider API is available at.
    • SmsProvider_Port - port an SMS provider API is available at.
  • Email parameters:
    • EmailProvider_IsEnabled - enable/disable email.
    • EmailProvider_SmtpHost - smtp server address to send emails.
    • EmailProvider_SmtpUser - smtp server login.
    • EmailProvider_SmtpPassword - smtp server password.
    • EmailProvider_From - email address to be used to send emails from.
    • EmailProvider_UseSsl - use/do not use SSL when connecting to smtp server.
  • Email used for system status notifications:
    • iikoNetSupportEmails - emails where iikoCard5 server internal monitoring reports will be sent.
  • The iikoBizWebInterfaceUrl parameter to form correct URLs of server web interfaces in emails. It is used to send emails containing links to your iikoCard5 server website. It shall have a public URL of the server web interface available to users. For example, http://iiko.biz/.

SMS Provider Setup

To be able to send messages to your customers’ mobile phones containing, for example, account-related information, you have to enable the SMS service.

IikoCard5 is able to send messages using the following services:

To make iikoCard5 work with any provider, follow this:

  1. Enter into a service agreement with the chosen provider.
  2. Obtain the following from the provider:
    • Name of the company that provides SMS service.
    • SMS provider API login.
    • SMS provider API password.
    • Address an SMS provider API is available at.
    • Port an SMS provider API is available at.
  3. Specify the parameters received from your provider in the iikoBizServer.override.config configuration file. For more details on the file location and setup, see the Alternative Configuration File paragraph. To set up SMS sending, you can add the following strings to the configuration file:
    • In case of SMSC:
    • <add key="SmsProcessor" value="smsSmscProcessor" />
      <add key="SmsProvider_Company" value="iiko.biz" />
      <add key="SmsProvider_Login" value="Resto Software"/>
      <add key="SmsProvider_Password" value="password"/>
      <add key="SmsProvider_Gate" value="smsc.ru" />
      <add key="SmsProvider_Port" value="80" />
    • In case of TxtLocal:
    • <add key="SmsProcessor" value="txtLocalSmscProcessor" />
      <add key="SmsProvider_Company" value="iiko.biz" />
      <add key="SmsProvider_Login" value="login"/>
      <add key="SmsProvider_Password" value="password"/>
      <add key="SmsProvider_Gate" value="api.txtlocal.com" />
      <add key="SmsProvider_Port" value="80" />
  4. Once configuration files are edited, restart iikoBiz Host Service to apply the changes.