Параметры агента

Все параметры

Подключение к кассовому серверу r_keeper через TCP
Параметр	Секция конфигурации	Значение по умолчанию	Параметр обязателен?	Описание
IP	RKeeper:TcpConnetion	"127.0.0.1"	нет	IP-адрес, по которому Агент может увидеть кассовый сервер r_keeper
Port	RKeeper:TcpConnetion	2233	да	TCP-порт, для подключения к XML-интерфейсу кассового сервера r_keeper
CryptKey	RKeeper:TcpConnetion	""	да	Ключ доступа к XML API кассового сервера r_keeper
ConnectionName	RKeeper:TcpConnetion	"r_keeper XML API"	нет	Имя подключения к кассовому серверу
RequestTimeoutSec	RKeeper:TcpConnetion	300	да	Время ожидания ответа кассового сервера r_keeper в секундах
Подключение к серверу справочников r_keeper через TCP
IP	RKeeper:RefServer:TcpConnetion	"127.0.0.1"	нет	IP-адрес, по которому Агент может увидеть сервер справочников r_keeper
Port	RKeeper:RefServer:TcpConnetion		нет	TCP-порт, для подключения к XML API сервера справочников r_keeper На стороне r_keeper настраивается в менеджерской: Настройки > OLAP отчеты > Серверы отчетов > Сервер справочников > раздел XML интерфейс > поле Порт привязки
CryptKey	RKeeper:RefServer:TcpConnetion	""	нет	Ключ доступа к XML API сервера справочников r_keeper
ConnectionName	RKeeper:RefServer:TcpConnetion	"r_keeper XML API"	нет	Имя подключения к серверу справочников
RequestTimeoutSec	RKeeper:RefServer:TcpConnetion	300	да	Время ожидания ответа сервера справочников r_keeper в секундах
Подключение к WebDelivery
IP	RKeeper:WebDelivery:BaseAddress		да	Адрес подключения к WebDelivery
Port	RKeeper:WebDelivery:Sid		да	Ключ доступа к WebDelivery
Альтернатива — подключение кассовому серверу к r_keeper через HTTP. Сейчас есть проблемы с лицензией на создание заказа
IP	RKeeper:HttpConnetion	"127.0.0.1"	нет	IP-Адрес, по которому Агент может увидеть сервер r_keeper
Port	RKeeper:HttpConnetion		да	HTTP-порт, для подключению к XML API кассового сервера r_keeper
User	RKeeper:HttpConnetion		да	Пользователь r_keeper
Password	RKeeper:HttpConnetion		да	Пароль пользователя r_keeper
RequestTimeoutSec	RKeeper:HttpConnetion	10	нет	Время ожидания ответа r_keeper в секундах
Альтернатива — подключение серверу справочников к r_keeper через HTTP
IP	RKeeper:RefServer:HttpConnetion	"127.0.0.1"	нет	IP-Адрес, по которому Агент может увидеть http порт сервера справочников r_keeper
Port	RKeeper:RefServer:HttpConnetion		нет	HTTP-порт, для подключению к XML API сервера справочников r_keeper
User	RKeeper:RefServer:HttpConnetion		нет	Пользователь r_keeper
Password	RKeeper:RefServer:HttpConnetion		нет	RKeeper:RefServer
RequestTimeoutSec	RKeeper:RefServer:HttpConnetion	10	нет	Время ожидания ответа r_keeper в секундах
Подключение к StoreHouse 5
IP	StoreHouse5Connection		да	IP адрес WEB-интерфейса StoreHouse 5
Port	StoreHouse5Connection		да	Порт WEB-интерфейса StoreHouse 5
User	StoreHouse5Connection		да	Имя пользователя WEB-интерфейса StoreHouse 5
Password	StoreHouse5Connection		нет	Пароль пользователя WEB-интерфейса StoreHouse 5
RequestTimeoutSec	StoreHouse5Connection	15	нет	Время ожидания ответа от WEB-интерфейса StoreHouse 5
Предпочтения, используемые для создания заказа
IncludeTariffsToMenu	RKeeper:OrderCreationPreferences	false	нет	Если true, в меню будут возвращаться категории с блюдами-тарифами
AllowRetryCreateOrder	RKeeper:OrderCreationPreferences	false	нет	Если true, можно будет повторно отправлять команду на создание заказа, если он ранее не попал в r_keeper, так как ему не был присвоен r_k Guid.
UseGetOrderMenuOnly	RKeeper:OrderCreationPreferences	false	нет	Игнорировать фильтрацию меню по торговым группам и типу цены. При построении меню будет использоваться метод GetOrderMenu
PriceTypeId	RKeeper:OrderCreationPreferences		нет	Идентификатор r_keeper типа цены, используемый при получении меню.
TradeGroupId	RKeeper:OrderCreationPreferences		нет	Идентификатор r_keeper торговой группы блюд. Если указан, оставляет в меню только блюда, входящие только в эту торговую группу.
DefaultMenuSelectorCode	RKeeper:OrderCreationPreferences		нет	Код селектора, который (если указан) будет использоваться для построения дерева категорий и фильтрации блюд.
DefaultStationId	RKeeper:OrderCreationPreferences		да	Идентификатор r_keeper кассы, на которой: будет показано окно для подтверждения создания заказа будет создан заказ будет оплачен заказ.
DefaultCashierId	RKeeper:OrderCreationPreferences		да	Идентификатор r_keeper кассира, от имени которого будут проводится оплата заказа.
CurrencyCode	RKeeper:OrderCreationPreferences		нет	Код r_keeper валюты, которой будет проводится оплата онлайн-заказов. По умолчанию используются рубли.
OrderCategoryCode	RKeeper:OrderCreationPreferences		да	Код r_keeper категории заказа.
DefaultTableCode	RKeeper:OrderCreationPreferences		да	Код r_keeper стола, для которого будет создан заказ.
OrderTypeCode	RKeeper:OrderCreationPreferences		да	Код r_keeper типа заказа.
VoidingReasonCode	RKeeper:OrderCreationPreferences	-1	нет	Код r_keeper причины отмены отказа — удаления из него блюд.
CashierTimeoutSec	RKeeper:OrderCreationPreferences	120	нет	Время в секундах ожидания подтверждения создания заказа на кассе. По истечении этого времени окно на кассе закроется и Агент будет знать, что заказ проигнорирован.
OrderConfirmationHost	RKeeper:OrderCreationPreferences	"127.0.0.1"	нет	Видимое на кассе r_keeper имя узла или его IP-адрес, на котором развернут сайт Агента с формой подтверждения создания заказа.
ConfirmOrderIfIgnoredOnKass	RKeeper:OrderCreationPreferences	false	нет	Если true, агент продолжит создавать заказ, если он был проигнорирован на кассе, просрочен CashierTimeoutSec. Если false — на WhiteServer будет передано сообщение об ошибке — отказе заказа.
CustomExtSource	RKeeper:OrderCreationPreferences		нет	Если значение задано, при отправке заказа в r_keeper к нему добавляется атрибут ExtSource с этим значением. Сейчас известно только значение 42 для этого атрибута.
GuestTypeId	RKeeper:OrderCreationPreferences		нет	Идентификатор R_keeper типа гостя, для которого будет создан заказ.
CreateOrdersAsDeffered	RKeeper:OrderCreationPreferences	false	нет	Если true, все заказы будут создаваться как отложенные, то есть черновики. Значение по умолчанию — true.
OrderTypeCodeForCustomerTaker	RKeeper:OrderCreationPreferences:PickupPreferences		нет	Опциональный код типа заказа для самовывоза. То есть если pickup.taker = custmer
OrderCategoryCodeCustomerTaker	RKeeper:OrderCreationPreferences:PickupPreferences		нет	Опциональный код категории заказа для самовывоза. То есть если pickup.taker = custmer.
rPos
Port	rPos:Farcard	7778	нет	7778 — порт PDS-интерфейса Plazius. Необходим WSA для работы PDS Plazius. Для изменения порта PDS в конфигурацию агента добавьте секцию: `"rPos": {"Farcard": {"Port": номер_порта}}`

Параметры для Delivery

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

Примеры конфигурационных файлов

Регистр не имеет значения.

RuntimeConfig.json

{
    "RKeeper": {
        "TcpConnetion": {
            "IP": "127.0.0.1",
            "Port": 2233,
            "CryptKey": ""
        },
        "OrderCreationPreferences": {
            "DefaultStationID": 15003,
            "DefaultCashierID": 1000003,
            "DefaultTableCode": 107,
            "OrderCategoryCode": 8,
            "OrderTypeCode": 9,
//далее - необязательные параметры:
            "CurrencyCode": 1,
            "PriceTypeID": 3,
            "DefaultMenuSelectorCode": 42,
            "OrderConfirmationHost": "127.0.0.1",
            "CashierTimeoutSec": 20,
            "TradeGroupID": 3,
            "VoidingReasonCode": 1,
            "CustomExtSource": "42",
            "ConfirmOrderIfIgnoredOnKass": true,
            "UseGetOrderMenuOnly": true,
            "CreateOrdersAsDeffered": false,
            "IncludeTariffsToMenu": false,
            "GuestTypeId": 1,
            "AllowRetryCreateOrder": false
            "PickupPreferences": {
                "OrderTypeCodeForCustomerTaker": 42,
                "OrderCategoryCodeCustomerTaker": 42
            }
 
        }
    },
    "StoreHouse5Connection": {
        "IP": "172.18.2.26",
        "Port": "9797",
        "User": "Admin",
        "RequestTimeoutSec": 10
    }
}

JSON