Agent parameters
All parameters
Parameter | Configuration section | Default value | Required parameter? | Description |
|---|---|---|---|---|
Connecting to the r_keeper cash register server via TCP | ||||
IP | RKeeper:TcpConnetion | "127.0.0.1" | no | IP address by which the Agent can see the r_keeper cash register server |
Port | RKeeper:TcpConnetion | 2233 | yes | TCP port for connecting to the XML interface of the r_keeper cash register server |
CryptKey | RKeeper:TcpConnetion | "" | yes | Access key to XML API of the r_keeper cash register server |
ConnectionName | RKeeper:TcpConnetion | "r_keeper XML API" | no | Connection name to the cash register server |
| Connecting to the r_keeper directory server via TCP | ||||
IP | RKeeper:RefServer:TcpConnetion | "127.0.0.1" | no | IP address at which the Agent can see the r_keeper directory server |
Port | RKeeper:RefServer:TcpConnetion | no | TCP port for connecting to the XML API of the r_keeper directory server | |
CryptKey | RKeeper:RefServer:TcpConnetion | "" | no | Access key to the XML API of the r_keeper directory server |
ConnectionName | RKeeper:RefServer:TcpConnetion | "r_keeper XML API" | no | Directory server connection name |
| Connecting to WebDelivery | ||||
IP | RKeeper:WebDelivery:BaseAddress | yes | WebDelivery connection address | |
Alternative: connecting the cash register server to r_keeper via HTTP. There are currently problems with the order creation license | ||||
IP | RKeeper:HttpConnetion | "127.0.0.1" | no | IP address where the Agent can see the r_keeper server |
Port | RKeeper:HttpConnetion | yes | HTTP port for connecting to the XML API of the r_keeper cash register server | |
User | RKeeper:HttpConnetion | yes | r_keeper User | |
Password | RKeeper:HttpConnetion | yes | r_keeper User password | |
| Alternative: Connecting the directory server to r_keeper via HTTP | ||||
IP | RKeeper:RefServer:HttpConnetion | "127.0.0.1" | no | IP address where the Agent can see the http port of the r_keeper directory server |
Port | RKeeper:RefServer:HttpConnetion | no | HTTP port for connecting to the XML API of the r_keeper directory server | |
User | RKeeper:RefServer:HttpConnetion | no | r_keeper User | |
Password | RKeeper:RefServer:HttpConnetion | no | RKeeper:RefServer | |
Connecting to StoreHouse 5 | ||||
IP | StoreHouse5Connection | yes | IP address of StoreHouse 5 WEB interface | |
Port | StoreHouse5Connection | yes | StoreHouse 5 WEB Interface Port | |
User | StoreHouse5Connection | yes | StoreHouse 5 WEB interface username | |
Password | StoreHouse5Connection | no | StoreHouse 5 WEB interface user password | |
Preferences used to create an order | ||||
| IncludeTariffsToMenu | RKeeper:OrderCreationPreferences | false | no | If true, categories with dish-tariffs will be returned to the menu |
| AllowRetryCreateOrder | RKeeper:OrderCreationPreferences | false | no | If true, the order creation command can be re-sent if it was not previously entered into r_keeper because it was not assigned an r_k Guid. |
| UseGetOrderMenuOnly | RKeeper:OrderCreationPreferences | false | no | Ignore menu filtering by trade groups and price type. The GetOrderMenu method will be used when constructing the menu |
PriceTypeId | RKeeper:OrderCreationPreferences | no | The r_keeper identifier of the price type used when retrieving the menu. | |
TradeGroupId | RKeeper:OrderCreationPreferences | no | r_keeper identifier of the food trade group. If specified, it keeps only food items in this trade group on the menu. | |
DefaultMenuSelectorCode | RKeeper:OrderCreationPreferences | no | The selector code that (if specified) will be used to build the category tree and filter dishes. | |
DefaultStationId | RKeeper:OrderCreationPreferences | yes | The r_keeper identifier of the cash register on which:
| |
DefaultCashierId | RKeeper:OrderCreationPreferences | yes | The r_keeper identifier of the cashier on whose behalf the order payment will be made. | |
CurrencyCode | RKeeper:OrderCreationPreferences | no | R_keeper currency code, which will be used to pay for online orders. By default, rubles are used. | |
OrderCategoryCode | RKeeper:OrderCreationPreferences | yes | R_keeper order category code. | |
DefaultTableCode | RKeeper:OrderCreationPreferences | yes | The r_keeper code of the table for which the order will be created. | |
OrderTypeCode | RKeeper:OrderCreationPreferences | yes | R_keeper code of the order type. | |
VoidingReasonCode | RKeeper:OrderCreationPreferences | -1 | no | The r_keeper code which indicates the reason for canceling the refusal — removing dishes from it. |
CashierTimeoutSec | RKeeper:OrderCreationPreferences | 120 | no | Time in seconds to wait for confirmation of order creation at the cash register. After this time, the window at the checkout will close and the Agent will know that the order has been ignored. |
OrderConfirmationHost | RKeeper:OrderCreationPreferences | "127.0.0.1" | no | The name of the node visible at the r_keeper cash register or its IP address, on which the Agent's website with the order creation confirmation form is deployed. |
ConfirmOrderIfIgnoredOnKass | RKeeper:OrderCreationPreferences | false | no | If true, the agent will continue to create the order if it was ignored at cash register, CashierTimeoutSec expired. If false, an error message will be sent to WhiteServer – order rejection. |
CustomExtSource | RKeeper:OrderCreationPreferences | no | If the value is set, an ExtSource attribute with this value is added to the order when it is sent to r_keeper. Currently, the only known value for this attribute is 42. | |
| GuestTypeId | RKeeper:OrderCreationPreferences | no | R_keeper ID of the guest type for which the order will be created. | |
| CreateOrdersAsDeffered | RKeeper:OrderCreationPreferences | false | no | If true, all orders will be created as pending, i.e. drafts. |
OrderTypeCodeForCustomerTaker | RKeeper:OrderCreationPreferences:PickupPreferences | no | Optional order type code for pickup. That is, if pickup.taker = customer | |
| rPos | ||||
| Port | rPos:Farcard | 7778 | no | 7778 — Plazius PDS interface port. WSA is required for Plazius PDS to work. To change the PDS port, add a section to the agent configuration: "rPos": {"Farcard": {"Port": port_number}} |
Parameters for Delivery
Parameter | Requires? | Parameter Description |
|---|---|---|
PriceTypeId | yes | The r_keeper identifier of the price type used when retrieving the menu. |
ConfirmOrderIfIgnoredOnKass | yes | Required to save the order to the cash register. |
| OrderConfirmationHost | yes | The name of the node visible at the r_keeper cash register or its IP address, on which the Agent's website with the order creation confirmation form is deployed. |
DefaultStationId | yes | The r_keeper identifier of the cash register on which:
|
DefaultCashierId | yes | The r_keeper identifier of the cashier on whose behalf the order payment will be made. |
DefaultTableCode | yes | The r_keeper code of the table for which the order will be created. |
OrderCategoryCode | yes | Код r_keeper категории заказа. |
OrderTypeCode | yes | r_keeper code of the order type. |
VoidingReasonCode | no | The r_keeper code is the reason for canceling the refusal, or more precisely, removing dishes from it. |
| CreateOrdersAsDeffered | no | If false, the order will appear in KDS Pro. If true, it will not appear until saved. |
| CashierTimeoutSec | no | Time in seconds to wait for confirmation of order creation at the cash register. After this time, the window at the cash register will close and the Agent will know that the order has been ignored. |
CurrencyCode | no | R_keeper currency code, which will be used to pay for online orders. By default, rubles are used. |
| TradeGroupId | no | r_keeper identifier of the food trade group. If specified, it keeps only food items in this trade group on the menu. |
CustomExtSource | no | If the value is set, when an order is sent to r_keeper, an ExtSource attribute with this value is added to it. |
Примеры конфигурационных файлов
Регистр не имеет значения.
RuntimeConfig.json
JSON
|