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

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

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

Дата

Версия

Автор

Комментарий

13.11.13

1.00

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

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

29.11.13

1.01

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

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

18.12.15

2.00

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

Действительно для 2.1.0 и выше

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

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

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

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

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

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

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

Обновление

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

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

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

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

FAQ

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

iikoMonitoring версии 2.1.x cовместим с версией iiko 3.3.x и выше. Рекомендуется использовать для версий iiko 4.2 и выше.

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

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

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

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

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

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

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

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

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

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

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

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

Для iiko до версии 4.3

Для установки скопируйте файлы в папку:

Для iiko с версии 4.3

Для установки скопируйте файлы в папку:

Подпапку iikoMonitoring необходимо создать вручную.

Действует правило: одна подпапка - один плагин.

При первом запуске нужно запустить iikoFront с правами админа.

Чтобы в дальнейшем запускать без прав админа в командной строке с правами админа выполните команду:

netsh http add urlacl url=http://+:8803/ArbusMonitoringPluginService/ user = DOMAIN\user

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

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

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

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

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

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

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

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

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

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

Скриншот

Описание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

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

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

Скриншот

Описание

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

 

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

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

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

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

Обновление

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

  1. Остановите iikoFront;
  2. В папку "C:\Program Files\iikoRMS\Front.Net\Plugins" ("C:\Program Files\iikoRMS\Front.Net\Plugins\iikoMonitoring для 4.3 и выше") скопируйте с заменой файлы iikomonitoring.dll и iikomonitoring.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\

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

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

Лицензирование осуществляется через стандартное iiko-лицензирование. Информация о количестве доступных подключений получается плагином со стороны RMS в момент запуска плагина и обновляется при перезапуске iikoFront.

 

Плагин стартует только при условии наличия свободных подключений со стороны RMS. В противном случае плагин не стартует, лог не создается, а фронт выдает на экран стандартное сообщение о лицензионном ограничении с указанием названия ограниченного модуля. Сам факт старта плагина занимает одну лицензию. В случае успешного старта плагин по умолчанию начинает пытаться занять все имеющиеся свободные лицензии до тех пор пока они не закончатся. Общее количество активных подключений рассчитывается как количество полученных подключений + 1 (факт старта плагина).

В случае конфигурации с несколькими группами станций под управлением одного RMS общее количество лицензий RMS необходимо разделить между группами станций. При этом сумма значений для всех групп станций не должна превышать общее количество лицензий на уровне RMS. Разделение происходит статично и не перераспределяется динамически при освобождении лицензий на одной из групп станций в процессе работы.

Для выполнения настройки распределения лицензий в конфигурационные файлы плагинов %appdata%\iiko\CashServer\PluginConfigs\iikoMonitoring\config.xml на главных кассах каждой из групп необходимо прописать параметр <ConnectionsLimit>. По умолчанию значение параметра равно 0, что означает, что ограничения на потребление лицензий отсутствуют и плагин будет стремиться занять все свободные лицензии. Если настройка в принципе отсутствует в конфигурационном файле, то это приравнивается к значению 0.

При наличии настройки <ConnectionsLimit> отличной от нуля плагин со стороны RMS будет занимать не более указанного количества лицензий при наличии свободных со стороны RMS.

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

Для контроля и мониторинга за лицензиями на RMS можно использовать скрипты:

http://ip_iikoRMS:8080/resto/service/monitoring/connections.jsp (предоставляет информацию о занятых слотах с указанием IP фронта. Точная информация доступна только в случае рестарта всех фронтов при работающем Tomcat)

http://ip_iikoRMS:8080/resto/api/licence/info?moduleId=1900180200

! При старте Tomcat при работающих кассах информация по данным запросам может не соответствовать действительности.

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

FAQ