Уведомление об изменениях в заказах через httpordernotify
Введение
Интерфейс предназначен для транслирования информации по протоколу HTTP о событиях с кассовой станции на адрес, указанный в параметре драйвера. Основная задача - передача данных об изменениях в заказах и других событиях кассовой станции.
Есть два варианта настройки механизма отправки уведомлений:
Механизм подписок для версии 7.6.5.440 и старше
Через интерфейс HTTP Order Notify для версий ниже 7.06.05.440
Схема работы
После старта драйвер находится в ожидании событий от кассы, либо завершения работы кассового сервера.
События передаваемые драйвером идут в порядке поступления. На текущий момент размер очереди равен 256. При достижении максимального количества прием новых событий приостанавливается до освобождения места для события. Это необходимо для предотвращения переполнения памяти и аварийной остановки кассового сервера, если отправка сообщений невозможна.
Для каждого адреса подписки ведется своя очередь рассылки, так же как и свой файл логирования. При завершении работы кассового сервера оставшиеся в очереди события отправляться не будут.
Данные пытаются отправляться сразу при поступлении в драйвер. Времени ожидания события "приход данных" нет.
Драйвер загружается при старте кассового сервера. Независимо от наличия кассовой станции в очередь ставится сообщение о запуске кассового сервера с Situation="1". Событие аналогично старту кассы, но с ограниченным количество узлов.
Пример сообщения после загрузки и инициализации кассового сервера:
В данном событии указан только идентификатор кассового сервера. Если адрес задан в свойствах кассового сервера, то он уведомляет драйвер о готовности к работе. Далее происходит это событие.
После старта кассовой станции в очередь ставится похожее сообщение, но с расширенным набором узлов:
В нем указана расширенная информация о кассовом сервере и данные о кассовой станции. Данный механизм позволяет разделить события загрузки кассового сервера и кассовой станции для их раздельной обработки.
Указанный в примере GUID не является константой.
Поддерживаемые команды, передающиеся драйвером в атрибуте Situation:
Situation
Событие
Описание
1
Started Запуск станции обслуживания
Событие отправляется в момент запуска станции обслуживания (doscash.exe). Станция указывается в тэге Station передаваемого xml
Событие отправляется в момент внесения изменения в заказ на станции обслуживания, ДО фактического сохранения заказа. В теле запроса передается xml с составом заказа и ChangeLog.
Событие отправляется при переносе блюда из заказа в другой заказ. В теле запроса передается xml с составами заказов FromOrder и ToOrder, блюдо указывается в тэге ChangeLog/Dish.
Событие отправляется в момент создания заказа на кассе. В теле запроса передается xml с составом заказа.
12
Open Order Вход в редактор заказа
Событие отправляется в момент, когда на кассе существующий заказ открывается на редактирование. В теле запроса передается xml с составом заказа.
13
Save Order Сохранение заказа
Событие отправляется в момент сохранения заказа. В теле запроса передается xml с составом заказа.
14
Delete Receipt Удаление чека
Событие отправляется перед удалением чека. В теле запроса передается xml с составом заказа.
15
Print Bill Печать пречека
Событие отправляется перед печатью пречека. В теле запроса передается xml с составом заказа.
16
Undo Bill Отмена пречека
Событие отправляется перед отменой пречека. В теле запроса передается xml с составом заказа. Отменяемый пречек передается в тэге ChangeLog/PrintCheck
17
Main Selector Navigation Переход по группам меню на кассе
Событие отправляется в момент перехода между группами меню на кассе
18
Exit
Выход из программы
Событие отправляется в момент завершения приложения.
19
Confirm Save Order Подтверждение сохранения заказа
Событие отправляется перед сохранением заказа, в момент появления сообщения "Сохранить заказ?" на кассе. В теле запроса передается xml с составом заказа.
20
Order Props Changed Редактирование свойств заказа
Событие отправляется в момент закрытия формы Редактирований свойств заказа на кассе. В теле запроса передается xml с составом заказа.
21
Login Вход на кассу
Событие отправляется в момент логина на кассу. Работник указывается в тэге Waiter.
Событие отправляется в момент печати чека коррекции на кассе. В теле запроса передается xml с составом заказа
Лицензирование интерфейса HTTP Order Notify
Если требуется более одного подключения, необходимо лицензировать интерфейс HttpOrderNotify. Активировать лицензию следует начиная с версии7.6.5.459. Лицензия в системе лицензирования называетсяR-Keeper модуль Интерфейс уведомлений о заказах 12 мес ПО. Подробный процесс получения лицензии описан в статье Генерация лицензий без кода запроса
Интерфейс HTTP Order Notify
HTTP Order Notify работает на стороне кассового сервера к которому подключена кассовая станция. Драйвер добавляется на кассовый сервер. Для корректной загрузки драйвера необходимо привязать к нему интерфейс для кассового сервера. Об этом ниже.
Для версий r_keeper младше 7.6.5
Добавьте драйвер HTTP Order Notify на кассовый сервер:
Параметры:
Название
Описание и возможные значения
Log File
Путь к файлу, который будет использоваться в качестве лога действий драйвера. Может отсутствовать, но в этом случае будет затруднено выявление проблем при работе
LogLevel
Уровень логирования, может принимать одно из трех значений:
0 - errors only — В этом режиме в лог попадают только самые важные сообщения (например информация о загрузке интерфейса), либо сообщения о произошедших ошибках: превышение количества событий в очереди, сбой отправки данных на HTTP сервер и т.п.
1 - input xmls and errors — В этом режиме в дополнение к режиму errors only добавляются некоторые важные сообщения, например старт отправки XML на адрес HTTP-сервера.
2 - max log — Наиболее полный режим логирования, содержит максимально подробную информацию о работе драйвера, включая входящие и исходящие XML, текущее состояние очереди отправки и др.
DestURLs
HTTP-адрес, на который будет производится отправка данных. Задается в общепринятом формате адресов URL. Может содержать только один адрес. При необходимости отправки данных на несколько HTTP-серверов для каждого из них должен быть добавлен свой драйвер HTTP Order Notify
Для загрузки драйвера кассовым сервером привяжите его к интерфейсу:
В менеджерской станции перейдите на вкладку сервис
Нажмите на вкладку Интерфейсы
В справочнике добавьте новый интерфейс и заполните параметры:
Название
Описание и значение
[Название кассового сервера]
выберите драйвер, добавленный на кассовый сервер
Общее имя DLL
укажите имя файла драйвера, всегдаhttpnotf.dll
4. Перезагрузите кассовый сервер
Для версии r_keeper 7.6.5
Параметры работы драйвера настраиваются в свойствах кассового сервера в разделе HTTP Order Notify
Параметры:
Название
Описание и возможные значения
Имя файла лога
Путь к файлу, который будет использоваться в качестве лога действий драйвера. Может отсутствовать, но в этом случае будет затруднено выявление проблем при работе. К имени файла лога добавляется порядковый номер адреса в списке адресов, начиная с нуля. Т.е. если имя файла лога httpnotf.stk, то для первого адреса подписки имя файла будет httpnotf0.stk, для второго - httpnotf1.stk и т.д.
Уровень лога
Уровень логирования, может принимать одно из трех значений:
0 - Только ошибки — В этом режиме в лог попадают только самые важные сообщения (например информация о загрузке интерфейса), либо сообщения о произошедших ошибках: превышение количества событий в очереди, сбой отправки данных на HTTP сервер и т.п.
1 - XML и ошибки — В этом режиме в дополнение к режиму "Только ошибки" добавляются некоторые важные сообщения, например старт отправки XML на адрес HTTP-сервера
2 - Полная информация — Наиболее полный режим логирования, содержит максимально подробную информацию о работе драйвера, включая входящие и исходящие XML, текущее состояние очереди отправки и др.
DestURLs
HTTP-адреса, на которые будет производится отправка данных. Задаются в общепринятом формате адресов URL. Может содержать несколько адресов, разделенных точкой с запятой. На указание нескольких адресов действуют ограничения по лицензированию.
Значение параметра DestURLs используется только при старте кассового сервера. Изменив этот параметр, перезапустите кассовый сервер для изменения списка адресов. Чтобы список адресов изменился во время работы сервера, используйте механизм подписок.
Подробности настройки Http Order Notify
Для r_keeper 7.6.5 и старше
Начиная с версии 7.6.5.371 настройки Http Order Notify переместились из Устройств в свойства кассового сервера. Порядок действий для этих версий такой:
В параметре драйвера DestURLs пропишите строку подключения в виде: https://имя_пользователя:пароль_пользователя@адрес_сервера_KDS_PRO:порт_сервера_KDS_PRO/orderTaker
Сохраните изменения
Перезапустите кассовый сервер Если требуется указать несколько строчек подключения, их можно указать через точку запятой ";". Например: http://127.0.0.1:2121/api/httpNotify/postOrders;https://127.0.0.1:1234/orderTaker
Если используется несколько строчек подключения, необходимо пролицензировать свойство кассового сервера HTTP Order Notify. Подробнее читайте в статье Лицензирование.
Если строка DestURLs слишком длинная и по какой-то причине обрезается в свойстве кассового сервера, то можно использовать механизм подписок.
Для подписки на отправку, чтобы кассовый сервер начал отправлять уведомления об изменениях заказа, нужно вызвать POST-запрос (любым удобным для вас способом, например с помощью Postman) к кассовому серверу:
Скопируйте файл httpnotf.udb с заменой в папку сервера справочников
Перезапустите кассовый сервер
Добавьте на кассовый сервер драйвер HTTP Order Notify:
Настройте драйвер для всех кассовых серверов по необходимости.
В параметре драйвераDestURLsпропишите строку подключения в виде: https://имя_пользователя:пароль_пользователя@адрес_сервера_KDS_PRO:порт_сервера_KDS_PRO/orderTaker
Имя пользователя и пароль указывать не обязательно. Вписывайте их только, если они есть в личном кабинете. Эти данные есть в личном кабинете, ихописание ниже. Порт сервера находится в файле настроекkds_pro.config.
Перейдите вСервис > Интерфейсы и создайте новый интерфейс
В разделеФайлы библиотек (DLL) выберите нужный ресторан иукажите драйвер кассовому серверу HTTP Order Notify
Активируйте интерфейс и сохраните.
В версиях старше r_keeper 7.6.5 драйвер HTTP Order Notify работает только через механизм подписок, использование интерфейса не поддерживается.
Механизм подписок
Для отправки кассовым сервером уведомлений об изменениях отправьте POST-запрос к кассовому серверу:
При работе драйвер добавляет информацию о своей работе в логи для упрощения локализации возникших проблем при работе. Регулярно возникающая проблема - данные не приходят на принимающий HTTP-сервер. Здесь следует проверить корректность указания адреса в параметре DestURLs драйвера и работоспособность HTTP-сервера. Если невозможно отправить данные, в логе будут сообщения с подстрокой "HTTP: Post error", например:
18.12.2019 16:25:32:343 HTTP: Post error: Socket Error # 10061
XML
Часто встречающиеся коды ошибок:
Код HTTP
Описание
10061
Connection refused - невозможно соединиться с сервером
10054
Connection reset by peer - соединение сброшено сервером
В этом случае необходимо проверить настройки HTTP-сервера
В сообщениях вида:
SEND_THREAD: Signal [Send] ENTER, items in queue: 19
XML
содержится информация о текущем количестве объектов в очереди. При достижении максимального значения в логе будет сообщение: