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

  • Подойдёт любая операционная система начиная от Windows 7 SP2 и выше.

или

Установка

Первичная установка осуществляется с помощью инсталлятора, доступного на ftp://ftp.ucs.ru/WS/WSAgent/versions/

Выберите папку, в которой будет произведена установка и нажмите Установить.

.Net Core 3.0 включен в дистрибутив агента и его отдельная установка не требуется.

После установки потребуется выбрать сервер подключения службы ws agent, а также ввести ключ лицензии WsClient:

Выбор сервера

Выбирайте https://ws-test.ucs.ru/wsserverlp в случаях тестовых окружений.
Если вы настраиваете агента для боевого окружения - выбирайте https://ws.ucs.ru/wsserverlp. Даже если вы используете агента на демо-стенде.

Ключ лицензии можно взять из системы лицензирования. Перейдите в меню Редактирование объекта

В нижнем блоке нажмите значок лупы и введите WS. Нажмите Enter

Лицензии отфильтруются и отобразится одна — WSClient. Она вам и нужна. Скопируйте лицензионный ключ из столбца Лицензия.

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

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

Нажмите Закрыть.

После окончания установки создадутся и запустятся службы Windows для Агента и Монитора WS.

Обновления агента

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

Монитор

Монитор выполняет команды с WS по каналу, отличному от WSA. Он понимает такие команды, как:

  • получение логов;
  • получение конфигурации;
  • перезапись конфигурации агента;
  • остановка/запуск агента;
  • обновление агента.

Монитор также следит за тем, чтобы Агент был виден в процессах. Если его нет, то запускает заново (если для агента разрешен запуск).
Агент следит за тем, чтобы Монитор был активен.

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

Конфигурирование агента производится удалённо из административной панели.
На стороне Агента все изменения настроек принимает Монитор, как изменения конфигурационных файлов Агента.

  1. 1. Перейдите в административную панель https://newadmin-ws.ucs.ru/
  2. 2. Авторизуйтесь, используя дилерские логин и пароль
  3. 3. Перейдите в раздел "Рестораны"
  4. 4. Выполнить поиск ресторана по коду объекта и перейти на карточку ресторана
  5. 5. На карточке ресторана выбрать агент и выбрать необходимый агент
  6. 6. Перейдите в карточку агента (кнопка с иконкой шестеренка). 
  7. 7. Перейдите на вкладку "Конфигурация".
  8. 8. После изменения настроек нажимаем Применить настройки для сохранения настроек на стороне агента.




Пример конфигурации подключения к r_keeper

{
    "RKeeper": {
        "TcpConnetion": {
            "Port": 2233
        }
    }
}

// Пример полной конфигурации подключения к r_keeper
{
    "RKeeper": {
        "TcpConnetion": {
            "IP": "127.0.0.1",
            "Port": 2233,
            "CryptKey": ""
        }
    }
}
YML

Пример полной конфигурации

{
  "RKeeper": {
    "OrderCreationPreferences": {
      "PriceTypeId": 1126163,
      "DefaultStationId": 16865,
      "DefaultCashierId": 1000037,
      "DefaultTableCode": 1,
      "OrderCategoryCode": 5,
      "OrderTypeCode": 5,
      "VoidingReasonCode": 1,
      "CashierTimeoutSec": 120,
      "OrderConfirmationHost": "127.0.0.1",
      "ConfirmOrderIfIgnoredOnKass": true
    },
    "TcpConnetion": {
      "IP": "127.0.0.1",
      "Port": 22333,
      "CryptKey": "",
      "ConnectionName": "R-Keeper XML API",
      "ErrorBufferDefaulSize": 1024
    },
    "RefServer": {
      "TcpConnetion": {
        "IP": "127.0.0.1",
        "Port": 5555
      }
    }
  },
  "Crm": {
    "BaseAddress": "http://172.18.5.35:9192",
    "TimeoutSec": 10,
    "ContactTypeId": 2,
    "TerminalType": 10,
    "AddressTypeId": 250
  },
  "Kestrel": {
    "EndPoints": {
      "Http": {
        "Url": "http://0.0.0.0:1234"
      }
    }
  }
}
YML

Другие примеры конфигурации

// Пример полной конфигурации подключения к серверу справочников R-Keeper
{
    "RKeeper": {
        "RefServer": {
            "IP": "127.0.0.1",
            "Port": 2222,
            "CryptKey": ""
        }
    }
}

// Пример конфигурации
{
    "RKeeper": {
        "TcpConnetion": {
            "IP": "127.0.0.1",
            "Port": 2233,
            "CryptKey": ""
        },
        "OrderCreationPreferences": {
            "DefaultStationID": 15003,
            "DefaultCashierID": 1000003,
            "DefaultTableCode": 107,
            "CurrencyCode": 1,
            "PriceTypeID": 3,
            "OrderConfirmationHost": "127.0.0.1",
//далее - необязательные параметры:
            "CashierTimeoutSec": 20,
            "TradeGroupID": 3,
            "VoidingReasonCode": 1,
            "CustomExtSource": "42",
            "PickupPreferences": {
                "OrderTypeCodeForCustomerTaker": 42,
                "OrderCategoryCodeCustomerTaker": 42
            }
 
        }
    },
    "StoreHouse5Connection": {
        "IP": "172.18.2.26",
        "Port": "9797",
        "User": "Admin",
        "RequestTimeoutSec": 10
    }
}
YML

Описание параметров конфигурации

ПараметрОбязательностьОписание
Подключение к r_keeper через TCP: RKeeper:TcpConnetion
  • IP
даIP-адрес, по которому Агент может увидеть кассовый сервер r_keeper.
  • Port
даTCP-порт, для подключения к XML API r_keeper.
  • CryptKey
даКлюч доступа к XML API r_keeper.

Подключение к серверу справочников R-Keeper через TCP: RKeeper:TcpConnetion
  • IP
нужно для создания заказа

IP-Адрес, по которому Агент может увидеть сервер справочников R-Keeper

Уточнить данные подключения к Серверу Справочников можно в Менеджерской

  • Port
нужно для создания заказаTCP-порт, для подключению к XML API сервера справочников R-Keeper
  • CryptKey
нужно для создания заказаКлюч доступа к XML API сервера справочников R-Keeper

Подключение к StoreHouse 5: StoreHouse5Connection
  • IP
даIP адрес WEB-интерфейса StoreHouse 5.
  • Port
даПорт WEB-интерфейса StoreHouse 5.
  • User
даИмя пользователя WEB-интерфейса StoreHouse 5.
  • Password
нетПароль пользователя WEB-интерфейса StoreHouse 5.
  • RequestTimeoutSec
нетВремя ожидания ответа от WEB-интерфейса StoreHouse 5.

Предпочтения, используемые для создания заказа: RKeeper:OrderCreationPreferences
PriceTypeIdдаИдентификатор r_keeper типа цены, используемый при получении меню.
TradeGroupIdнетИдентификатор r_keeper торговой группы блюд. Если указан, оставляет в меню только блюда, входящие только в эту торговую группу.
DefaultStationIdдаИдентификатор r_keeper кассы, на которой: будет показано окно для подтверждения создания заказа, будет создан заказ, будет оплачен заказ.
DefaultCashierIdдаИдентификатор r_keeper кассира, от имени которого будут проводится оплата заказа.
CurrencyCodeнетКод r_keeper валюты, которой будет проводится оплата онлайн-заказов (по умолчанию используются рубли).
DefaultTableCodeдаКод r_keeper стола, для которого будет создан заказ.
OrderCategoryCodeдаКод r_keeper категории заказа.
OrderTypeCodeдаКод r_keeper типа заказа.
VoidingReasonCodeнетКод r_keeper причины отмены отказа (точнее, удаления из него блюд).
CashierTimeoutSecнетВремя в секундах ожидания подтверждения создания заказа на кассе. По истечении этого времени окно на кассе закроется и Агент будет знать, что заказ проигнорирован.
OrderConfirmationHostдаВидимое на кассе R-Keeper имя узла (или его IP-адрес), на котором развёрнут сайт Агента с формой подтверждения создания заказа.
ConfirmOrderIfIgnoredOnKassнетЕсли true, агент продолжит создавать заказ, если он был проигнорирован на кассе (просрочен CashierTimeoutSec). Если false - на WhiteServer будет передано сообщение об ошибке (об отказе заказа).
CustomExtSourceнетЕсли значение задано, при отправке заказа в r_keeper к нему добавляется атрибут "ExtSource" с этим значением. Сейчас известно только значение "42" для этого атрибута.

Миграция с WSA v1 на wsa v2

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

Внимание

Не обновляйтесь до WSA v2 в случае, если на стенде используете интернет заказы

  1. Перейдите в административную панель https://newadmin-ws.ucs.ru/
  2. Авторизуйтесь, используя дилерские логин и пароль
  3. Перейдите в раздел "Агенты"
  4. С помощью поиска и кода объекта найдите в списке ваш агент
  5. Нажмите на кнопку с молнией
  6. В выпадающем списке выберите команду wsamon_update
  7. Выберите доступную вторую версию агента
  8. Галочка "Принудительно" должна быть включена
  9. Нажмите на кнопку "Ок"

После миграции ваш агент появится в списке Агентов второй версии (Раздел Агенты v2).
Теперь необходимо сконфигурировать агент.