The following guide explains how to integrate KitchenGo services and Logic Control Hardware with Envibe POS Module.
KitchenGo is a food & beverage order display system linked to point of sale, replacing printed dockets (popular in the fast-food industry)
The KitchenGo integration utilises an XML file drop implementation. When sales transactions are completed, an XML file pertaining to the relevant sales elements is generated and placed in a folder determined by the deployment area settings.
If an unexpected error occurs while producing or writing the XML file, Envibe will fall back to the default docket printing implemen
Orders are populated from the related sales record and transaction as follows:
Order.ID > SalesRecord.Identifier
Order.PosTerminal > SiteTerminal.Name
Order.GuestTable > SalesTransaction.PagerNumber (if present)
Order.ServerName > SalesTransaction.StaffRecord.Alias
Order.Destination > populated with the comma separated SalesDocket.Name values of the items included on the order
Order.OrderStatus > hard-coded to "0" (paid)
Order.OrderType > not specified (standard)
Order.Customer.UserInfo > SalesRecord.ContactRecord.Name/Company (if present), SalesRecord.ContactName (if present), otherwise "Anonymous"
Sales elements will be included as items on a KitchenGo order if:
they are not an upgrade of another sales element
they have a positive quantity
they have a configured Sales Ticket
the configured Sales Ticket has the Send to KitchenGo option toggled on
Items are populated from the related sales element as follows:
Item.ID > SalesElement.Key
Item.Name > SalesElement.Name (by default, populated from the underlying SalesItem name)
Item.Category > not specified
Item.Quantity > SalesElement.Quantity
Item.KDSStation > hard-coded to "1:0", which will deliver to device "1" on its 1st (primary) screen
KitchenGo does not support fractional (non-whole number) quantities. The Envibe POS does not support adding fractional quantity elements, but in the case that one is encountered, the user will be prompted with a message indicating that the element will not be sent to KitchenGo.
As a fall back, these elements will be sent to the docket printer as usual.
If the sales element has had comments recorded against it, the comments will be included as the first condiment as follows:
Condiment.ID > SalesElement.Key
Condiment.Name > SalesElement.Comments
Any upgrade sales elements for a sales element included as an item on a KitchenGo order will be included as a condiment for that item, regardless of sales ticket configuration.
Upgrade sales elements with negative quantities will still be omitted from KitchenGo orders.
Condiments are populated from upgrade sales elements as follows:
Condiment.ID > UpgradeSalesElement.Key
Condiment.Name > UpgradeSalesElement.Name
As KitchenGo does not support condiments having a quantity, if the upgrade sales element has a quantity greater than 1, the quantity will be prepended to the Condiment Name. e.g. "2 x <SalesElement.Name>"
If the upgrade sales elements has had comments recorded against it, these will not be included as part of the KitchenGo order.
Follow these steps to initiate an integration:
acquire a license for the KitchenGo module
register deployment details of shared folder.
For example:
integration KG with [Kitchen Go]
{
[Xml API Folder Path] = “C:\{path-to-shared=folder]”;
}
set checked Send associated items to KitchenGO
Server service will require a restart after changes to the deployment area.