Frontol

Интеграция Frontol с HEADO

Общее описание этапов по подключению к сервису HEADO и описание интеграции с Frontol

Порядок задач по техническому подключению и разворачиванию ПО HEADO:

Версия от 2021-01-26

Описание интеграции

Интеграция реализована через COM API и сценария frontol (JavaScript) , методы которого описаны в руководстве интегратора frontol. На каждую кассу торговой точки устанавливается ПО «HEADO» и прописывается сценарий frontol, который служит кодом интеграции реагирующего на события о продажах/возвратах и передачей данных о них ПО «HEADO»

Для настройка подключения, необходимо получить уникальный ключ доступа (Auth_Key) для каждого кассового компьютера;
Frontol при наличии прописанного кода интеграции и установленного ПО «HEADO» при наступлении события о продаже/возврате, обращается к зарегистрированному на кассе COM-объекту ПО «HEADO», который из полученных данных формирует файл чека (XML формат) в директории пользователя (%appdata%\kkmsuite\exchange) под которым запущен Frontol;

ВАЖНО:

Если на ПК закончится место на жестком диске, то XML файлы не смогут формироваться и это приведет к расхождениям показателей.
Код интеграции реагирует только на кассовые операции выполняемые через Frontol, т.е. если продажа/возврат был выполнен вне frontol, то данные об операции не будут переданы в систему HEADO

ПО «HEADO» в реальном времени проверяет директорию пользователя (%appdata%\kkmsuite\exchange) на наличие файлов с данными о продажах для их обработки. Файлы при успешной обработки удаляются автоматически, а обработанные данные о продажах формируются пакетами данных в каталог очереди на оправку (%programfiles%\GiftomanKKMSuite\data\chuncked_queue) в облако HEADO (api.heado.ru). Если api.heado.ru недоступно по 80 и 443 портам, то данные в облако будут отправлены при возобновлении его доступности;

ВАЖНО: При переустановке ПО необходимо проверить директорию очереди данных на отправку и убедиться, что папка пуста. В случае наличия файлов, необходимо выполнить резервную копию папки очереди данных для их восстановления после переустановки ПО.

В облаке поступившая информация обрабатывается ядром системы HEADO. После обработки данных, информация о достигнутых KPI доступна по следующим каналам: продавцам через ПО «HEADO», руководителям через личный кабинет (web,мобильное приложение IOS/Android)

ВАЖНО: Если торговому предприятию необходимо настроить показатели в системе HEADO для отслеживания продаж по определенным категориям товаров (группы,классификаторы товаров, доп.текстовые метки) и они отсутствуют в номенклатурном справочнике товаров frontol, то необходимо реализовать выгрузку дополнительного номенклатурного справочника товаров с категориями, необходимыми для настройки показателей. В таком случае загружаемый дополнительный справочник товаров дополняет

1. Получить ключи (Auth_Key)

Необходимо добавить торговые точки и все кассы на них для получения уникальных Auth_Key/AccessKey (ключи доступа для установки ПО HEADO на кассы).
Добавление торговых точек/касс производится одним из способов:

Самостоятельно через личный кабинет при наличии доступа с правами администратора;
Через менеджера HEADO/Партнёра

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

2. Обеспечить доступность сервиса HEADO

API HEADO должен быть доступен по 80 и 443 портам с рабочей места подключенного к сервису HEADO. Описание проверки доступности портов доступно по ссылке

3. Синхронизировать время и проверить часовой пояс

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

4. Настройка Frontol

4.1 Скачайте файл со сценарием для своей версии Frontol:

Для версий Frontol 4
Для версий Frontol 5 и выше

4.2 Зайдите в Frontol Администратор и откройте закладку «Скидки и сценарии»,
после нажмите на иконку «Сценарии» (см.Рисунок 1)

Рисунок 1. Frontol Администратор, вкладка «Скидки и сценарии»

Для Frontol 4:
4.2.1. Создайте новый сценарий "Отправка данных в HEADO" на Момент действия "Закрытие документа" (см. Рисунок 2)

Рисунок 2. Окно добавления сценария

4.2.2. Вставьте в окно редактирования сценария содержимое скачанного файла сценария (заменяя автоматически созданный код) и нажимаем кнопку «ОК» для сохранения.
4.2.3. Далее открываем подменю «Скидки и сценарии» \ «Объекты» и добавляем «Объект скидки» (см. Рисунок 3)

Рисунок 3. Окно «Объект скидки»

4.2.4. Указываем в «Объект скидки" созданный сценарий «Отправка данных в HEADO» и нажимаем кнопку «ОК»
4.3. Для Frontol 5.0.0 cоздать сценарий "Отправка данных в HEADO" на Момент действия «Все»
4.4. Для Frontol 5.0.1 и более поздних версий, создать сценарий "Отправка данных в HEADO". В списке сценариев необходимо выбрать созданный сценарий в поле "В начале сеанса запускать:" (см. Рисунок 4)

Рисунок 4.

ВАЖНО: В случае, если уже установлен и выбран для запуска в начале сеанса иной сценарий, необходимо добавить в конец имеющегося сценария код из сценария HEADO, за исключением функции init(), а в функцию init() имеющегося сценария добавить следующую строку: frontol.addEventListener("closeDocument","GCloseDocument",false);

5. Установить ПО HEADO

Скачать последнюю версию инсталлятора suite_integration_setup.exe.
Используется для передачи данных о продажах в систему HEADO и для отображения показателей по торговой точке.
«Interactor type» - при установке ПО выбрать «Standart COM Interactor (21)».
Инструкция по установке ПО HEADO доступна по ссылке

ВАЖНО: На ПК управляющих торговых точек также можно установить ПО «HEADO», аналогично тому как это делается на кассе, но данные в облако отправляться не будут. В отличии от личного кабинета, ПО «HEADO» отображает KPI, только по торговой точке, где он установлен.

6. Сверка продаж

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

Возникли вопросы ?

Напишите нам

Создать обращение