[+]
System Settings
[+]
Programs
[+]
[+]
Reports
 
[+]
Administration
 
 
 
Updated on 11/8/2018
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

IikoCard5 server has two services:

  • IikoBiz Host Service is in charge of the main iikoCard5 functions: campaigns, guests, balances, etc. Use port 9900 to have an API access.
  • IikoRMS API Service processes API iikoRMS server requests. It uses port 9901. 
Once iikoCard5 is updated to version 48, call API requests, processed by iikoRMS, using new port - 9901 (instead of 9900).
[-] Hide
http://localhost:9901/api/0/auth/access_token
http://localhost:9901/api/0/organization/supportedProtocols


http://localhost:9901/api/0/orders/add
http://localhost:9901/api/0/orders/info
http://localhost:9901/api/0/orders/checkCreate
http://localhost:9901/api/0/orders/checkAddress
http://localhost:9901/api/0/orders/deliveryOrders
http://localhost:9901/api/0/orders/deliveryHistory
http://localhost:9901/api/0/orders/deliveryHistoryByPhone
http://localhost:9901/api/0/orders/deliveryHistoryByCustomerId
http://localhost:9901/api/0/orders/sendDeliveryOpinion
http://localhost:9901/api/0/orders/get_courier_orders
http://localhost:9901/api/0/orders/AssignCourier
http://localhost:9901/api/0/orders/add_order_problem
http://localhost:9901/api/0/deliverySettings/getDeliveryTerminals
http://localhost:9901/api/0/deliverySettings/getDeliveryRestrictions
http://localhost:9901/api/0/deliverySettings/deliveryDiscounts
http://localhost:9901/api/0/deliverySettings/getSurveyItems
http://localhost:9901/api/0/deliverySettings/getDeliveryCourierMobileSettings
http://localhost:9901/api/0/mobile/signIn
http://localhost:9901/api/0/mobile/sync
http://localhost:9901/api/0/rmsSettings/getRoles
http://localhost:9901/api/0/rmsSettings/getCouriers
http://localhost:9901/api/0/rmsSettings/getCouriersActiveOnDeliveryTerminal
http://localhost:9901/api/0/rmsSettings/GetEmployees
http://localhost:9901/api/0/rmsSettings/GetOrderTypes
http://localhost:9901/api/0/rmsSettings/GetRestaurantSections
http://localhost:9901/api/0/rmsSettings/GetMarketingSources
http://localhost:9901/api/0/rmsSettings/GetPaymentTypes
http://localhost:9901/api/0/paymentTypes/GetPaymentTypes
http://localhost:9901/api/0/stopLists/getDeliveryStopList
http://localhost:9901/api/0/olaps/olapColumns
http://localhost:9901/api/0/olaps/olap
http://localhost:9901/api/0/olaps/olapPresets
http://localhost:9901/api/0/olaps/olapByPreset
http://localhost:9901/api/0/events/events
http://localhost:9901/api/0/events/eventsMetadata
http://localhost:9901/api/0/events/sessions
http://localhost:9901/api/0/employees_data/get_orgnization_base_info
http://localhost:9901/api/0/employees_data/get_employee_base_info
http://localhost:9901/api/0/employees_data/get_employee_data_in_batch
http://localhost:9901/api/0/employees_data/get_employee_transactions
http://localhost:9901/api/0/employees_data/get_employee_attendance
http://localhost:9901/api/0/employees_data/employee_schedule
http://localhost:9901/api/0/employees_data/get_employee_news
http://localhost:9901/api/0/employees_data/get_personal_report
http://localhost:9901/api/0/employees_data/get_deleted_entities

To install iikoCard5 server, follow this:

  1. Get approval for local installation of iikoCard5 from the iiko's Partner Department.
  2. Download the server components setup files from ftp and save them on 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:\Program  Files\iiko\iikoBiz directory with the following subdirectories:
    • Web Interface - iiko.biz files.
    • Host Service - iiko.biz service.

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.

RabbitMQ messaging server will be installed along with the main iikoCard5 server. At this point, a corpit account is created automatically with the password: xGh4RApm7v. It is used to connect iikoRMS and iikoCard5. 

  1. Run Setup.iikoRMS.ApiService.msi under admin and follow installation instructions. As a result, the service will be installed in C:\Program Files\iiko\iikoBiz\RMSAPI. iikoRMS API Service will appear in the list of services.
  2. If you want to change iikoCard5 server settings, use a special configuration file. Once configuration files are edited, restart iikoBiz Host Service to apply the changes.
  3. 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 service 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:

{"code": null,

"description": null,

"httpStatusCode": 500,

"message": "Wrong user name [test] or password [test]." }

  1. Go to http://localhost/iikobiz in a browser. If everything is set up properly, you will be taken to the iiko.biz login page.
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.
  1. Change the RabbitMQ server connection key in the iikoRMS resto.properties configuration file:

instead of rabbit-mq-uri=amqps://corpit:xGh4RApm7v@mq.iiko.biz:5671

paste rabbit-mq-uri=amqp://corpit:xGh4RApm7v@BIZ_LOCAL_HOSTNAME:5672.

Where corpit:xGh4RApm7v - automatic username and password, BIZ_LOCAL_HOSTNAME:5672 - username and port of RabbitMQ server. You need this to register a company at the local iiko.biz portal. 

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

aAlternative configuration file

iikoNet.Host.WinService.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 located in the C:\Users\iikoBizSvc\AppData\Roaming\iiko\iikoBizServer directory and is called iikoBizServer.override.config.

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;" />
<add key="db.connection_string.master"value="Data Source=localhost\RESTO;Initial Catalog=master;Integrated Security=True;Connection Timeout=5;" />
</overridableAppSettings>
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 defaultRabbitMqUri - RabbitMQ server connection string.
  • SMS sending parameters:
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 SMS Provider Setup section.
  • SmsProvider_Company - name of the company that provides SMS service.
  • SmsProvider_Login - SMS provider API login.
  • SmsProvider_Password - SMS provider API password.
  • 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/.

aSMS 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 Alternative configuration file. For instance, 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" />

  1. Once configuration files are edited, restart iikoBiz Host Service to apply the changes.

Item images

If you integrate iiko into a delivery website and export a menu containing images of meals, you have to set up an image storage. Use the Selectel service to store item images. If you install iiko.biz locally, you have to register by yourself and set up the connection. For this:

  1. Register in Selectel and pay for the service. For how to do it, see Selectel knowledge base.
  2. Create the following in your personal Selectel account:
    • Two storages: one for item images and another for other images.

  • User under which the data will be written to and read from a storage.

  1. Add Selectel connection parameters to the iikoBizServer.override.config configuration file:

<add key="SelectelLogin" value="64060_API_USER" />

<add key="SelectelPassword" value="YourPassword" />

<add key="SelectelDomainUrl" value="http://111111.selcdn.ru" />

<add key="SelectelNomenclatureContainerName" value="nomenclature_images" />

<add key="SelectelImagesContainerName" value="images" />

<add key="SelectelPosLogsContainerName" value="pos_logs_test" />

<add key="SelectelAttemptsToUploadImage" value="3" />

<add key="SelectelPosLogsAutoDeleteDays" value="3" />

in the parameters that follow change the values -

  • SelectelLogin and SelectelPassword - username and password of a Selectel user created earlier (see §2).
  • SelectelDomainUrl - URL specified in the settings of both containers. 
  • SelectelNomenclatureContainerName - container of item images. 
  • SelectelImagesContainerName - container for other images. 
  1. Restart iikoBiz Host Service to apply the changes.
  2. Export a menu to iikoOffice.