Установка и настройка iikoMonitoring

Статус документа: архивная версия

Актуальная версия инструкций находится здесь:

Список изменений

Дата

Версия

Автор

Комментарий

13.11.13

1.00

Мясников С.А.

Действительно, начиная с версии 2.0.3.8

29.11.13

1.01

Мясников С.А.

Действительно, начиная с версии 2.0.4.3

Общие сведения

Требования и совместимость

Архитектура решения

Установка и настройка

Установка плагина

Установка приложения

Настройка списка подключений

Ввод ключа доступа

Обновление

Обновление плагина

Обновление приложения

Перенос пользовательских настроек

Лицензирование

Виды лицензий iikoMonitoring

Запрос и активация лицензии

FAQ

Общие сведения

Данный документ содержит информацию по установке и настройке программного продукта iikoMonitoring версии 2.x.

Требования и совместимость

iikoMonitoring версии 2.x cовместим с версией iiko 3.3.x и выше.

Поддерживаемые ОС:

Windows XP SP3, Windows 7, Windows 8, Windows Server 2008 R2, Windows Server 2012.

Для работы используется Windows Communication Foundation (WCF).

Для удаленной работы через интернет необходимо настроить на маршрутизаторе проброску порта (по умолчанию порт 8804) с внешнего IP-адреса до терминала главной кассы или организовать VLAN сеть.

Архитектура решения

Архитектурно программный продукт iikoMonitoring разделен на следующие программные модули:

Схема взаимодействия модулей:

iikoFront <API Front> ArbusMonitoringPlugin.dll <-> iikoMonitoring

Плагин обеспечивает взаимодействие с основным фронтом посредством фронтового API iiko, выполняет функцию лицензатора и осуществляет авторизацию клиентов.

Установка и настройка

Установка плагина

Плагин устанавливается на терминал главной кассы (ГК).

На главную кассу в папку C:\Program Files\iikoRMS\Front.Net\Plugins\ нужно скопировать файлы:

Плагин запускается автоматически при старте iikoFront.

Факт успешного запуска плагина можно проследить через лог-файл

%appdata%\iiko\CashServer\Logs\plugin-ArbusMonitoringPlugin.log

Установка приложения

  1. Скопируйте из дистрибутива на компьютер конечного пользователя папку \iikoMonitoring. Создайте на рабочем столе ярлык запуска приложения.
  2. Запустите приложение.
  3. Согласно инструкциям ниже выполните:

Настройка списка подключений

Приложение iikoMonitoring позволяет поочередно подключаться и получать данные от разных ресторанов (плагинов). Из одной копии приложения пользователь может быть одномоментно подключен только к одному ресторану. Для одновременной работы с несколькими ресторанами требуется запустить несколько копий приложения. Выбор источника данных осуществляется через окно списка подключений.

Каждое подключение может иметь сетевые реквизиты для работы как в локальной сети ресторана, так и удаленно через интернет. При этом программа сама автоматически определяет предпочтительное соединение.

Порядок редактирования списка подключений:

Скриншот

Описание

При запуске приложения открывается окно со списком настроенных подключений.

Для добавления и изменения реквизитов подключения нужно в окне списка вызвать контекстное меню правой кнопкой мыши.

Для нового подключения необходимо задать его название, а также сетевые реквизиты.

Можно задать только локальный или только внешний адрес. Если пользователь будет работать локально через внутреннюю сеть и через интернет, то нужно задать локальный и внешний адрес.

Для связи с плагином по умолчанию выбран порт 8804.

После добавления нового подключения, оно появится в списке доступных подключений.

Для завершения настройки нового подключения необходимо установить ключ доступа и возможно активировать лицензию.

Если плагин доступен по сети и все настройки выполнены корректно, то статус подключения меняется на соответствующий.

Восклицательный знак означает, что касса доступна, но требуются дополнительные настройки, а именно:

а) есть несовместимость версий приложения и плагина

б) не активирована лицензия

в) не подтвержден ключ доступа пользователя

Для перехода в список подключений и изменения подключения нажмите на ссылку текущего подключения в статус-строке приложения.

Ввод ключа доступа

Ключ доступа позволяет предотвратить несанкционированный доступ к данным и используется как упрощенная альтернатива авторизации по логину и паролю.

 

Ключ доступа создается автоматически при первом запуске плагина в виде файла authTokenFile в собственном каталоге плагина %appdata%\iiko\CashServer\PluginConfigs\ArbusMonitoringPlugin\authTokenFile. В файле содержится уникальный шифрованный код. Ключ доступа уникален для каждого отдельного плагина (не пользователя).

Для предоставления конечным пользователям доступа просто откройте блокнотом файл authTokenFile, скопируйте оттуда его содержимое и отправьте его по электронной почте на личные ящики согласованного круга лиц. При подключении пользователя к данным в iikoMonitoring предусмотрен сценарий самостоятельно ввода ключа.

Скриншот

Описание

Если для существующего подключения не обнаружен действительный ключ доступа, то при попытке соединения приложение выдаст форму ввода нового ключа.

 

Для подтверждения доступа вставьте в поле ввода через буфер обмена код ключа и нажмите Ввести.

При успешном результате в текущем окне будет показано соответствующее сообщение и после небольшой задержки окно закроется.

Конечные пользователи не должны передавать известный им ключ доступа третьим лицам. Ответственность за передачу ключа доступа третьим лицам лежит на самих пользователях.

Если есть подозрения, что к данным получили доступ посторонние пользователи, то существующий файл authTokenFile удаляется и при перезапуске фронта генерируется новый с новым уникальным кодом. Новый ключ высылается обновленному кругу пользователей и они его самостоятельно активируют. Старый ключи доступа при этом перестанут работать.

Обновление

Обновление плагина

  1. Остановите iikoFront;
  2. В папку "C:\Program Files\iikoRMS\Front.Net\Plugins\" скопируйте с заменой файлы ArbusMonitoringPlugin.dll и ArbusMonitoringPlugin.cfg из дистрибутива новой версии;
  3. Запустите iikoFront.

Обновление приложения

  1. Завершите работу приложения iikoMonitoring;
  2. Переименуйте текущую папку с установленным iikoMonitoring в iikoMonitoring.ГГ-ММ-ДД;
  3. Скопируйте на компьютер пользователя папку iikoMonitoring из нового дистрибутива;
  4. Запустите приложение и проверьте работоспособность.

Перенос пользовательских настроек

Все пользовательские настройки приложения индивидуальны для каждого пользователя Windows и при обновлении сохраняются. При смене пользователем компьютера их можно при желании перенести на другой.

Все пользовательские настройки приложения iikoMonitoring хранятся в папке %appdata%\iikoMonitoring\.

В Windows XP это C:\Documents and Settings\%UserName%\Application Data.

В Windows 7 это C:\Users\%UserName%\AppData\Roaming.

Перечень пользовательских настроек

Вид

Место хранения

Примечание

Общие настройки для всех запущенных копий iikoMonitoring

Список подключений

\ConnectionsFile.xml

Для каждого отдельного подключения хранятся данные:

- Имя подключения

- IP адреса и порты

- Ключ доступа

- ID (GUID группы станций в РМС)

Логи

\logs\

ГГГГ-ММ-ДД-monitoring.log

Файл лога общий. При записи каждая отдельно запущенная копия iikoMonitoring.exe  указывает свой process_id.

Настройки индивидуальные для каждого ресторана (группы станций)

Хранятся в отдельных подпапках, именованных как GUID групп станций

Параметры раздела “Настройки”

\GUID\iikoMonitoring.cfg

Период автообновления, список активных событий, масштаб колонок длительности и др.

Вид таблиц

\GUID\MRU\

Группировка, фильтры, перечень и ширина активных столбцов

Архив сообщений на фронт

\GUID\SendMessArch\

Разбиваются по дням

Лицензирование

Лицензирование осуществляется через программный ключ.

Выданная лицензия привязывается к оборудованию (Hardware ID), на котором установлен плагин мониторинга (к терминалу главной кассы), и не будет работать на другом оборудовании без перегенерации.

Лицензирование iikoMonitoring является конкурентным. Плагин контролирует и ограничивает количество одновременных подключений разных пользователей.

Лицензия хранится на фронтовой станции (обычно на ГК), где установлен плагин, в папке

%appdata%\iiko\CashServerPluginConfigs\ArbusMonitoringPlugin\

в файле следующего вида:

48CC-A59D-FA90-0613-94FB-AB1D-8E49-DF5E.lic, где имя файла соответствует HWID.

Виды лицензий iikoMonitoring

Код лицензии

Наименование лицензии

Описание варианта поставки

Лицензии для продажи (боевые)

При заказе требуется счет от iiko

(только номер)

96012000

iikoMonitoring LifeTime

Бессрочная LifeTime лицензия

96012001

iikoMonitoring SaaS1M

Срочная SaaS на 1 месяц

96012002

iikoMonitoring SaaS3M

Срочная SaaS на 3 месяца

96012003

iikoMonitoring SaaS12М

Срочная SaaS на 12 месяцев

Лицензии не для продажи

При заказе не требуется счет от iiko

96012008

iikoMonitoring Test

Тестовая полнофункциональная лицензия. Для полноценного тестирования на объектах потенциальных Клиентов.

Срочная на 1 месяц.

Привязывается к Hardware ID.

96012009

iikoMonitoring Demo

Демонстрационная полнофункциональная лицензия. Для демонстрационных, тестовых и обучающих целей.

Срочная на 3 месяца.

Привязывается к Hardware ID.

Между собой суммируются подключения только по лицензиям из группы Для продажи. Одномоментно могут использоваться либо боевые, либо тестовые, либо демо - лицензии (в приоритете по порядку перечисления).

Запрос и активация лицензии

Для получения и активации лицензии необходимо выполнить следующие действия:

  1. Выполнить установку плагина и приложения и получить HardwareID.
  2. На странице http://arbus.biz/Produkty/iikoMobileFront/lickey заполнить форму на получение лицензионного ключа.

    Или отправить по электронной почте запрос на почтовые адреса:
    - lic@arbus.biz
    - partners@iiko.ru

    с указанием следующих реквизитов:
    - Название ресторана: (торговая вывеска);
    - Адрес ресторана: Город, Улица, Дом;
    - Название группы станций (если в ресторане несколько ГК);
    - Hardware ID;
    - Номер и дату счета в ООО “Рестософтвер”;
    - Спецификацию заказа: Вид лицензии, Количество, Дата начала, Дата окончания;
    - Причина генерации ключа: новая продажа / продление / доп. продажа / замена оборудования.
  3. В отчет на запрос получить файл ims.lic и активировать лицензию.

Порядок действий для активации лицензии:

Скриншот

Описание

Если для настроенного подключения не обнаружена лицензия, то при попытке соединения приложение выдаст форму активации лицензии.

Порядок запроса и получения лицензии описан в соответствующем разделе.

Для активации лицензии нужно в поле ввода лицензионного ключа через буфер обмена вставить полное содержимое полученного фала *.lic и нажать Активировать.

При успешной активации лицензии в текущем окне будет показано соответствующее сообщение и после небольшой задержки окно активации закроется.

FAQ