Техническая документация r_keeper_WhiteServer

Интеграции StoreHouse

Интеграция с DocsInbox

Введение

DocsInbox - сервис для электронного документооборота. Умеет выгружать номенклатуру и документы, читать/создавать накладные в StoreHouse 4 через WhiteServer (через OLE API SH). Имеет Веб-интерфейс, который токже позволяет работать с документами.

Подробнее о возможностях DocsInbox на сайте http://docsinbox.ru/.

Интеграция DocsInbox с системой StoreHouse 4 осуществляется через WhiteServer, расположенным в DataCentre компании UCS.

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

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

Дистрибутив

WSAgent доступен по следующей ссылке: ftp://ftp.ucs.ru/WS/WSAgent/versions/.

Утилиты для лицензирования и регистрации кассовых серверов на стороне WS доступны по ссылке: ftp://ftp.ucs.ru/WS/WSAgent/tools/

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

Для работы данной схемы необходимо наличие следующих лицензий на l.ucs.ru:

  1. Мастер лицензия « Интерфейс White Server» на работу WSA в этом ресторане;;
  2. Мастер лицензия на доступ агрегатора, в данном случае агрегатором выступает внешняя система DocsInbox (R-Keeper модуль Интерфейс к DocsInBox RK7 ПО)

Если мастер лицензий нет, то её необходимо запросить как любое другое ПО через создание Заявки на ПО. После подтверждения заявки проверить в карточке объекта и сгенерировать новую лицензию.

Запрос лицензии происходит в Конфигураторе на вкладке "Лицензирование"(подробнее в разделе Настройка ниже). Информация запишется в файл WSA.dat. После в l.ucs.ru появится лицензия WSClient.

Если мастер лицензии есть, но они просрочены (или истекает срок действия), то необходимо выполнить заявку на «Продление ПО».  Далее необходимо перегенерировать лицензию.

После продления лицензии необходимо повторно запросить лицензию на агента в Конфигураторе (вкладка Лицензирование).

После продления лицензии необходимо перезапустить Windows службы“WhiteServerAgent Service”, “WhiteServerAgentMonitor Service”. Об установке читайте ниже в разделе "Настройка". 

Настройка

Настройка WSAgent

Примечание: после обновления агента, конфигуратор импортирует настройки из старого формата wsa.ini в новый wsa.config (закодированный).

  1. Скачать последнюю версию WSAgent с фтп: ftp://WS/WSAgent/versions/1.0.5.19/wsa.rar

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

  3. Запустить WhiteServerAgentConf.exe и залогиниться под дилерским ID.

  4. На вкладке "Общее" выбрать одну из систем, с которой будет осуществлена связь. В нашем случае это "SH4". При использовании прокси-сервера, прописать параметры прокси.

  1. На вкладке "SH4" прописать параметры соединения с сервером StoreHouse. Проверит связь, нажав Check connection.

  1. На вкладке "Лицензирование" выбрать объект и запросить лицензию. На l.ucs.ru должна предварительно быть получена мастер-лицензия для объекта и активирована.

  1. На вкладке "White Server" прописать путь к White Server (по-умолчанию http://ws.ucs.ru/WSServerLP) и проверить соединение кнопкой "Check connection".

  1. На вкладке "Служба" конфигуратор позволяет установить WhiteServerAgent как службу.

Примечание: если служба была уже установлена ранее, то необходимо после всех настроек выше нажать кнопку "Применить настройки и перезагрузить службу".

В ресторанах, в которых WSAgent подключается к WS через файрвол с проверкой по IP адресу, нужно будет сделать изменения в настройках

  • Изменить IP адрес дополнительного сервера ws-p02.ucs.ru - 185.110.56.30
  • Изменить IP адрес основного сервера ws.ucs.ru - 185.110.56.24

На стороне клиентов (ресторанов):

  • Нужно разрешить исходящее соединение на адрема (ws-p02.ucs.ru - 185.110.56.30 и ws.ucs.ru - 185.110.56.24)

Примечание: Для выполнения API-процедур на стороне складского сервера необходимо добавить все файлы из Sh4Ole.rar (ftp://WS/WSAgent/tools/Sh4Ole.rar) в папку с WSA и зарегистрировать SH4ole.dll (в консоли под администратором regsvr32 Sh4Ole.dll). Помните, что WSagent требует дополнительной лицензии для склада в момент выполнения запросов DocsInbox (считается доп.местом).

Примечание: в sh4 должна быть разрешена и настроена связь через tcp/ip и указан порт по которому работает соединение с базой.

Рис. Включение Tcp/ip протокола в свойствах сервера SH4.

Интеграция с MixCart

Описание

Текущая версия сервиса интеграции позволяет выгружать приходные накладные из системы MixCart в систему учета UCS_Store House в полуавтоматическом режиме. 

Возможность создания и выгрузки накладных существует для Заказов, завершенных в системе MixCart.

В связи с необходимостью выгрузки данных о приходе в терминах и понятиях UCS_Store House, для правильного сопоставления справочников номенклатуры и ее характеристик, контрагентов и складов необходимо наличие в UCS_Store House существующей структуры соответствующих справочников.

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

Требования

  1. UCS_StoreHouse версии 4 и выше (рекомендовано 4.99)
  2. Настроенный агент WhiteServer, подключенный к UCS_StoreHouse
  3. Услуга (лицензия) MixCart, активированная в облаке WhiteServer
  4. Услуга (лицензия) UCS_StoreHouse, активированная в системе MixCart

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

Для работы данной схемы необходимо наличие следующих лицензий на l.ucs.ru:

  1. Мастер лицензия « Интерфейс White Server» на работу WSA в этом ресторане;;
  2. Мастер лицензия на доступ агрегатора, в данном случае агрегатором выступает внешняя система MixCart — MixCart интеграция с WhiteServer ПО

Если мастер лицензий нет, то её необходимо запросить как любое другое ПО через создание Заявки на ПО. После подтверждения заявки проверить в карточке объекта и сгенерировать новую лицензию.

Запрос лицензии происходит в Конфигураторе на вкладке "Лицензирование"(подробнее в разделе Настройка ниже). Информация запишется в файл WSA.dat. После в l.ucs.ru появится лицензия WSClient.

Если мастер лицензии есть, но они просрочены (или истекает срок действия), то необходимо выполнить заявку на «Продление ПО».  Далее необходимо перегенерировать лицензию.

После продления лицензии необходимо повторно запросить лицензию на агента в Конфигураторе (вкладка Лицензирование).

После продления лицензии необходимо перезапустить Windows службы“WhiteServerAgent Service”, “WhiteServerAgentMonitor Service”. Об установке читайте ниже в разделе "Настройка". 

Настройка

Настройка WSAgent

Примечание: после обновления агента, конфигуратор импортирует настройки из старого формата wsa.ini в новый wsa.config (закодированный).

  1. Скачать последнюю версию WSAgent с FTP: ftp://ftp.ucs.ru/WS/WSAgent/versions/
  2. Папку с с агентом добавить в исключения антивирусной программы, иначе возможно блокировка агента, соответственно не будут работать все запросы. Кроме того не будет работать автоматическое обновление и перезапуск агента. Т.е. Инженерам нужно будет вручную мониторить и обновлять агентов.
  3. Запустить WhiteServerAgentConf.exe и залогиниться под дилерским ID.
  4. На вкладке "Общее" выбрать одну из систем, с которой будет осуществлена связь. В нашем случае это "SH4". При использовании прокси-сервера, прописать параметры прокси.
  5. На вкладке "SH4" выбрать версию StoreHouse и параметры соединения. Проверит связь, нажав кнопку Check connection
  6. На вкладке "Лицензирование" выбрать объект и запросить лицензию. На l.ucs.ru должна предварительно быть получена мастер-лицензия для объекта и активирована.
  7. На вкладке "White Server" прописать путь к White Server (по-умолчанию http://ws.ucs.ru/WSServerLP) и проверить соединение кнопкой "Check connection".
  8. На вкладке "Служба" конфигуратор позволяет установить WhiteServerAgent как службу.

Настройка MixCart

Описание настройки связки MixCart - r_keeper_ - UCS_StoreHouse описано в приложенных в конце статьи файлах.

Настройка SH4

В приложении SH.exe откройте Меню > Сервис > Собственные реквизиты и заполните поля ИНН и КПП.

Интеграции r keeper 7

Интеграция c Rambler SmartReserv

Дистрибутив

WSAgent доступен по следующей ссылке: ftp://ftp.ucs.ru/WS/WSAgent/versions/.

Утилиты для лицензирования и регистрации кассовых серверов на стороне WS доступны по ссылке: ftp://ftp.ucs.ru/WS/WSAgent/tools/

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

Для работы необходимо наличие лицензии на l.ucs.ru:

  1. Мастер лицензия « Интерфейс White Server» на работу WSA в этом ресторане;;

Если мастер лицензий нет, то её необходимо запросить как любое другое ПО через создание Заявки на ПО. После подтверждения заявки проверить в карточке объекта и сгенерировать новую лицензию.

Запрос лицензии происходит в Конфигураторе на вкладке "Лицензирование"(подробнее в разделе Настройка ниже). Информация запишется в файл WSA.dat. После в l.ucs.ru появится лицензия WSClient.

Если мастер лицензии есть, но они просрочены (или истекает срок действия), то необходимо выполнить заявку на «Продление ПО».  Далее необходимо перегенерировать лицензию.

После продления лицензии необходимо повторно запросить лицензию на агента в Конфигураторе (вкладка Лицензирование).

После продления лицензии необходимо перезапустить Windows службы “WhiteServerAgent Service”, “WhiteServerAgentMonitor Service”. Об установке читайте ниже в разделе "Настройка". 

Настройка

Настройка r_keeper_7

Важно:  Для интеграции минимальная версия r_keeper_7 - 7.5.8.047

Для связи r_keeper_7 и WS необходимо добавить на кассовый сервер xml - интерфейс и прописать ему уникальный порт.

Далее необходимо завести отдельный стол на который будут записываться заказы. Заходим в "Настройки - Столы и залы - План залов и столы". Создаем новый план зала и в нем создает стол.

После этого нужно создать работника (официанта) на кассе через которого будет пробиваться заказы на кассе.

Заходим в "Персонал - Работники". Создаем новую роль и в ней создаем нового работника.

Задаем ему пароль и выбираем роль работника. После этого переходим во вкладку свойства и указываем кассовые ограничения (права).

Ниже показан минимальный набор прав для работника на кассовой станции r_keeper_7. В этой вариации ему доступны команды CreateOrder, SaveOrder, GetOrder, GetOrderList, VoidOrder, UpdateOrder

 

Примечание: Работника надо зарегистрировать на кассе или через запрос RegisterEmployee. Иначе будет ошибка вида ErrorText="Работник Кассир 1(5) не зарегистрирован."

Далее создаем новую валюту предоплаты. Переходим во вкладку "Деньги - Валюты". 

Рассмотрим на примере Рамблер Рубли.

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

Настройка WSAgent

Примечание: после обновления агента, конфигуратор импортирует настройки из старого формата wsa.ini в новый wsa.config (закодированный).

  1. Скачать последнюю версию WSAgent с фтп: ftp://WS/WSAgent/versions/

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

  3. Запустить WhiteServerAgentConf.exe и залогиниться под дилерским ID.

  4. На вкладке "Общее" выбрать одну из систем, с которой будет осуществлена связь. При использовании прокси-сервера, прописать параметры прокси.

5. На вкладке "RK7" прописать параметры соединения с кассовым сервером r_keeper_7. Проверить связь, нажав кнопку Check connection. Заполнить блок "Заказы".

6. На вкладке "Лицензирование" выбрать объект и запросить лицензию. На l.ucs.ru должна предварительно быть получена мастер-лицензия для объекта и активирована

7. На вкладке "White Server" прописать путь к White Server (по-умолчанию http://ws.ucs.ru/WSServerLP) и проверить соединение кнопкой "Check connection".

8. На вкладке "Служба" конфигуратор позволяет установить WhiteServerAgent как службу.

Примечание: если служба была уже установлена ранее, то необходимо после всех настроек выше нажать кнопку "Применить настройки и перезагрузить службу".

В ресторанах, в которых WSAgent подключается к WS через файрвол с проверкой по IP адресу, нужно будет сделать изменения в настройках

  • Изменить IP адрес дополнительного сервера ws-p02.ucs.ru - 185.110.56.30
  • Изменить IP адрес основного сервера ws.ucs.ru - 185.110.56.24

На стороне клиентов (ресторанов):

  • Нужно разрешить исходящее соединение на адрема (ws-p02.ucs.ru - 185.110.56.30 и ws.ucs.ru - 185.110.56.24)

Работа с кассовой станцией r_keeper_7

Открываем кассовую станцию r_keeper_7. Логинимся под созданным работником.

Через форму "Создание заказа" создаем новый заказ. Наполняем его несколькими блюдами и при выборе способа оплаты выбираем "Рамблер - Рубли"

Если настройки сделаны правильно то заказ закроется и появится рабочее меню кассовой станции.

 

К статье прикреплена инструкция для персонала ресторана, в котором доступна оплата через приложение Афиша-Рестораны

 

ВложениеРазмер
smartreserv_instrukciya_dlya_personala_restorana.doc1.88 МБ

Интеграция с DeliveryClub

Введение и сокращения

Интеграция с DeliveryClub работает через White Server Agent.

  1. WS — White Server
  2. WSA, WSAgent, WS-агент — White Server Agent

Системные требования

  • WSA — 1.14.0.31+
  • r_keeper — 7.6.2.156+ или 7.6.4.100+

WSAgent доступен по следующей ссылке: ftp://ftp.ucs.ru/WS/WSAgent/versions/.

Утилиты для лицензирования и регистрации кассовых серверов на стороне WS доступны по ссылке: ftp://ftp.ucs.ru/WS/WSAgent/tools/

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

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

  1. Лицензия — Интерфейс White Server для работы WS-агента
  2. Лицензия по подписке — R-Keeper модуль Интерфейс к DeliveryClub ПО для связи агрегатора и ресторана

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

Настройка интеграции

r keeper 7

  1. Для связи r_keeper_7 и WS добавьте на кассовый сервер драйвер XML-интерфейса и укажите ему свободный порт. Привяжите драйвер к логическому интерфейсу

    Если WSA и r_keeper установлены на разных компьютерах, используйте шифрование — укажите пароль в поле CryptKey.
  2. Создайте стол, на который будут записываться заказы. Зайдите в Настройки > Столы и залы > План залов и столы и создайте новый план зала
  3. Создайте работника-официанта, через которого будет пробиваться заказы на кассе. Зайдите в Персонал > Работники, и создайте нового работника. Назовите пользователя WSA, укажите пароль и активируйте
  4. Сохраните и закройте меню Работники
  5. Создайте причину внесения предоплат. Перейдите в меню Деньги > Причины внесения/выдачи денег
  6. Нажмите правой кнопкой мыши на свободном месте и выберите пункт Новая причина внесения/выдачи денег
  7. Назовите новую причину — Предоплата, активируйте и сохранитесь
  8. Перезапустите кассовый сервер.

WS-агент

  1. Скачайте последнюю версию WSA с FTP-сервера: ftp://WS/WSAgent/versions/
  2. Добавьте папку с агентом в исключения антивирусной программ — иначе возможна блокировка агента и не будет работать автоматическое обновление.
  3. Запустите WhiteServerAgentConf.exe и войдите под Dealer ID
  4. Проверьте обновления. Перейдите на вкладку Обновление и нажмите кнопку Обновить данные
  5. Если обновления есть — нажмите кнопку Скачать, а затем Обновить.
    1. Если WS не обновляется сам, остановите службу и закройте конфигуратор. 
    2. Зайдите в папку WS\updates и распакуйте с заменой новые версии.
  6. На вкладке Общее выберите систему, с которой настраиваете интеграцию. В нашем случае это RK7 — отметьте его галочкой.

    При использовании прокси-сервера, укажите параметры прокси.
  7. Перейдите на вкладку RK7 и укажите параметры созданного XML-интерфейса. CryptKey указывайте, если он есть в настройках интерфейса
  8. Нажмите кнопку Check connection. WSA проверит связь с кассовым сервером. Если всё в порядке, в разделе Заказы появятся значения [Не выбрано]
  9. Заполните блок Заказы
    1. Укажите кассовую станцию в поле Станция
    2. Выберите тип цены
    3. Выберите стол по умолчанию
    4. Выбирети причины внесения предоплаты — Предоплата
    5. Выберите созданного ранее работника для оплаты — WSA
    6. Выберите причину отмены заказа по умолчанию
    7. Отметьте необходимые галочки по желанию.
  10. Получение необходимы лицензий описано в разделе Лицензирование.
    Перейдите на вкладку Лицензирование и выберите объект. Нажмите на него 2 раза. Появится окно получения лицензии.
  11. Укажите дату окончания лицензии. Кнопка MaxDate служит для выбора максимальной даты
  12. Нажмите кнопку Далее... 

    Лицензия активирована.
  13. Перейдите на вкладку DeliveryClub
  14. Включите параметр Включено в разделе Интеграция с DeliveryClub 
  15. Укажите IP-адрес, на котором будет работать веб-интерфейс принятия заказа. Веб-интерфейс устанавливается вместе с WS-агентом и загружается на кассах. Кассы будут обращаться по этому адресу и получать в ответ веб-форму. 
    Не указывайте localhost — это неверно!
  16. Выберите, что делать с заказом, если кассир его не принял:
    1. Автоматически создавать на кассе
    2. Отклонять с ошибкой
  17. Укажите коды категорий заказов для создаваемого заказа.
    1. OrderCategoryCode — код категории заказа. Посмотреть можно в Заказ > Категории заказа
    2. OrderTypeCode — Код типа заказа, необязательное поле. Указывайте в случае, если в r_keeper настроено использование типа заказа. Посмотреть можно в Заказ > Типы заказа
    3. Укажите Валюту для онлайн оплаты
  18. Перейдите на вкладку White Server и укажите путь к White Server: https://ws.ucs.ru/WSServerLP
  19. Проверьте соединение кнопкой Check connection. Ошибок быть не должно.
  20. На вкладке Служба отображается статус службы WSA. Если служба не установлена, нажмите кнопку Установить
  21. Нажмите кнопку Применить настройки и перезапустить службу для сохранения настроек.

Работа на кассовой станции

Исходим из того что внешний заказ уже принят от DeliveryClub и открыт через WebInterface на кассовой станции.

Заказ не принят кассиром. В настройках WSAgent включен параметр Отклонить заказ — появится выбор причины отклонения заказа.

После подтверждения или создания заказа его можно посмотреть на кассовой станции. Заказ можно выбрать из списка в разделе Редактирование заказа или найти по номеру заказа, который ему присвоился при создании.

Если необходимо найти заказ по номеру, то нажмите на блок Комментарий и поле Фильтр по комментарию введите номер заказа. 

Интеграция с Фабрикой Лояльности

Описание

Для интеграции с системой Фабрика Лояльности потребуется установленная система r_keeper_7, PDS интерфейса на кассовом сервере, FarCards- Http

Дистрибутивы

Установочные файлы для r_keeper_7 можно скачать с ftp://ftp.ucs.ru/

Установочные файлы для FarCards можно скачать c ftp://ftp.ucs.ru/

Установочные файлы для FarCards-Http можно скачать с ftp://ftp.ucs.ru/ (Описание настройки и принципа работы в статье http://support.ucs.ru/ru/node/7785 )

Настройка менеджерской станции r_keeper_7

В свойствах интерфейса прописать имя сервера карт - параметр PDS Server Name, значение которого должно соответствовать значению параметра NetServerName из конфигурационного файла сервера карт CardServ.ini или ExtDllHttp.ini

при необходимости, заполнить или настроить остальные параметры интерфейса:

  • Currency Rate Class Code = 1 – код класса ставок валюты ПДС (1 – класс национальной валюты)
  • Tax Code = 1 – код налога
  • Call Timeout = 120 – таймаут обращения к серверу ПДС в секундах
  • Maximal Discount Value=0 = Discount limit spent totally – интерпретация нулевого значения лимита скидки, возвращаемого сервером карт: Discount limit spent totally – лимит скидки полностью исчерпан (значение по-умолчанию), No limits – игнорировать лимит скидки
  • Defaulter Type Code as = Defaulter type code – интерпретация кода неплательщика: Defaulter type code – использовать как код типа неплательщика (значение по-умолчанию), Currency subaccount base – добавка к номеру субсчёта, т.е. для разных карт будут добавляться разные числа (коды) к номеру субсчета
  • Look Up Card By Mail Addr = Yes  - Используйте адрес эл. почты для поиска информации по строке.

Далее заходим во вкладку "Сервис - Интерфейсы" и создаем копию предустановленного PDS интерфейса.

В секции "Файлы библиотек (DLL) выбираем на кассовом сервере созданный выше PDS интерфейс. 

Примечание: Обязательно перезагрузить кассовый сервер!

Далее переходим во вкладку "Сервис - Обработка сигналов и устройств - MCR алгоритмы" и создаем новый MCR алгоритм.

Указываем имя интерфейса, тип алгоритма, выбираем тип устройств по которым будет отрабатывать алгоритм, выбираем объект (созданный ранее интерфейс) указываем область и префикс.

Настройка FarCards-Http

Скачиваем архив FarCards. Распаковываем в любую удобную папку. После скачиваем архив с FarCards-Http и распаковываем в директорию с FarCards. 

Далее необходимо пролицензировать данный модуль. Для этого небходимо предварительно заказать лицензию на сайте l.ucs.ru

Заходим в приложение Http_LicGen.exe под дилерским логином, прописываем код ресторана и нажимаем активировать лицензию.

Открываем конфигурационный файл FarCards.ini. В секции [pds_netk] прописывает имя PDS интерфейса(в нашем случае это NetServerName=PDS-HTTP).

В конфигурационном файле ExtDllHttp.ini указываем IP адрес и порт подключения к ресурсу, где установлен считыватель QR-code

Установка и настройка кнопки активации камеры и считывания QR-code

Размерстите драйвер QR Camera на кассовой станции как показано на изображении ниже.

1

Создание скрипта активации камеры

Т. к. считыватель создает отдельно окно с потоком видео, то постоянное его присутствие не очень приятно. На данный момент для активации режима считывателя (и отображения окна) необходимо выполнить файл qrcamera.exe. Это можно сделать, написав небольшой скрипт (в последующих версиях механизм считывателей будет доработан и этот этап не будет требоваться).

Назначение операции

Скрипт можно использовать и без операции (создавая его на форме), но удобнее использовать для этой цели операции: не потребуется модификация форм и других мест, где нужно выполнять одно и то же действие. Привязываем какую-либо пользовательскую операцию к созданному нами скрипту. Настройка закончена. Следует разместить вызов этой операции в нужном месте (селекторе операций или валют, например) и использовать считыватель по назначению.

Далее переходим "Настройки - Графический интерфейс - Селекторы". Делаем копию предустановленного селектора

Далее переходим в "Настройки - Графический интерфейс - Функциональные клавиши" и создаем новую клавишу. В секции "Основное" указываем созданую ранее операцию.

Работа с кассовой станцией r_keeper_7

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

Кнопка QR Camera находится в блоке "Доп"