WSA Parameters
Agent parameters
| Parameter | Mandatory | Description |
|---|---|---|
| Parameter | Mandatory | Description |
| AllowRetryCreateOrder | no | If true, it will be possible to resend the command to create an order if it has not previously been entered into r_Keeper, i.e. it has not been assigned an Rk-Guid |
| 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. |
| ConfirmOrderIfIgnoredOnKass | no | If true, the agent will continue to create the order if it was ignored at the cash register (CashierTimeoutSec expired). If false, an error message (about order rejection) will be sent to WhiteServer. |
| CreateOrdersAsDeffered | no | If true (default value), all orders will be created as "postponed" ("drafts"). |
| yes | Access key to the r_keeper XML API. |
| required to create an order | Access key to the XML API of the R-Keeper directory server |
| CurrencyCode | no | The r_keeper currency code in which online orders will be paid (rubles are used by default). |
| 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. Currently, only the value "42" is known for this attribute. |
| DefaultCashierId | yes | The r_keeper identifier of the cashier on whose behalf the order payment will be made. |
| DefaultMenuSelectorCode | no | The selector code that (if specified) will be used to build the category tree (and, accordingly, filter dishes) |
| DefaultStationId | yes | The r_keeper identifier of the checkout where: a window will be shown to confirm the order creation, the order will be created, the order will be paid for. |
| DefaultTableCode | yes | The r_keeper code of the table for which the order will be created. |
| GuestTypeId | no | R_keeper ID of the guest type for which the order will be created. |
| IncludeTariffsToMenu | no | If true, categories with dish-tariffs will be returned to the menu. |
| yes | IP address at which the Agent can see the r_keeper cash register server. |
| required to create an order | IP address at which the Agent can see the R-Keeper directory server You can check the connection data to the Directory Server in the Manager station |
| yes | IP address of StoreHouse 5 WEB interface. |
| OrderCategoryCode | yes | Order category r_keeper code. |
| OrderCategoryCodeCustomerTaker | no | Optional order category code for pickup — i.e. if pickup.taker = customer |
| OrderConfirmationHost | yes | The name of the node (or its IP address), visible at the R-Keeper cash register, on which the Agent’s website with the order creation confirmation form is deployed. |
| OrderTypeCode | yes | r_keeper code of the order type. |
| OrderTypeCodeForCustomerTaker | no | Optional order type code for pickup — i.e. if pickup.taker = customer |
| no | StoreHouse 5 WEB interface user password. |
| yes | TCP port for connecting to r_keeper XML API. |
| required to create an order | TCP port for connecting to the XML API of the R-Keeper directory server |
| yes | StoreHouse 5 WEB interface port. |
| PriceTypeId | yes | The r_keeper identifier of the price type used when retrieving the menu. |
| no | Response time from StoreHouse 5 WEB interface. |
| TradeGroupId | no | The r_keeper identifier of the food trade group. If specified, keeps only food items in that trade group on the menu. |
| UseGetOrderMenuOnly | no | When constructing a menu, use only filtering by the r_Kepeer GetOrderMenu XML method; do not use the previous filtering by price type and trade group. |
| yes | StoreHouse 5 WEB interface username. |
| VoidingReasonCode | no | The r_keeper code of the reason for canceling the order (or rather, removing dishes from it). |
| Connecting to r_keeper via TCP: RKeeper:TcpConnetion | ||
| Connecting to StoreHouse 5: StoreHouse5Connection | ||
| Connecting to the R-Keeper directory server via TCP: RKeeper:TcpConnetion | ||
| Preferences used to create an order: RKeeper:OrderCreationPreferences | ||
Configuration examples
Example of r_keeper connection configuration
|
Example of a complete configuration
|
Kestrel is a web server that comes with .net. It is used by the agent to create an order confirmation form on the site.
- By default it is configured on port 5050.
- The host is specified in the OrderConfirmationHost parameter of the RKeeper.OrderCreationPreferences block.
Other configuration examples
|