iikoArrivals application is an electronic display board where your guests may check the status of their order and time to pickup. The use of iikoArrivals looks like this:
- A guest places an order and receives a slip with the number.
- The system sends the order to the kitchen and displays its number on the board.
- Once an order is cooked, a chef marks it as ready which is reflected on the board as well.
- The guest sees that his or her order is ready and picks it up.
- A manager marks the order as served and it disappears from the board.
A board may display the following order details: number, status, pickup time, wait time, customer name, and his/her phone number.
The app looks like a web page where you can go to any of the board templates. A template defines how the board looks like: layout and color skin. You can set up the app using a special configuration file.
Before you install and use iikoArrivals, make sure:
- Your iiko version is 4.3.2 or later.
- You use the Kitchen Screen module (KDS) or iikoDelivery as part of your iiko system. You may only use iikoArrivals if you have at least one of these modules.
- Net.Framework version 4.5 or later (Windows XP and POS Ready 2009 are not supported) is installed.
Devices you wish to use for iikoArrivals and iikoFront terminals are in the same network.
Installation and startup
To install iikoArrivals, follow this:
- Check if your iikoOffice has an iikoArrivals_v3 (Web FrontApi) license. Each connection (running browser) takes a license.
- Download the app from ftp://iikoarrivals:email@example.com and copy to any directory.
- Install the Resto.Front.Api.WebServer plugin for iikoFront. For this, copy the plugin folder to C:\Program Files\iiko\iikoRMS\Front.Net\Plugins. Use the config.json configuration file to connect iikoArrivals to WebApi. Find this file in the iikoArrivals directory. For more details on the configuration parameters, check the next chapter.
To open iikoArrivals, start the mongoose-windows.exe file in the app directory. This will invoke the iikoArrivals welcome page in your default browser, where you can go to a template you want.
The main iikoArrivals settings are contained in the config.json file located in the app directory.
The table below provides description of parameters. See also the documentation.json file.
|webServiceUrl||WebApi address ||http://localhost:9042|
Delivery order procedure. This parameter defines which statuses to check. You can specify:
- Delivery. Which means delivery statuses will be used.
- KDS. Kitchen screen statuses will be used.
Order types to be displayed in iikoArrivals. Possible values:
- Ordinary – regular order.
- Pickup – pickup order.
- Courier – delivery order.
|Ordinary, Pickup, Courier|
|showStatus||Order status to be displayed on board. Status KDS ID is specified.||0|
|completeStatus||Order status not displayed on board. Status KDS ID is specified.||5|
|hideStatus||Ready order status. Status KDS ID is specified.||6|
|inProgressStatusName||Status format for an order in progress. Includes two parameters: type and format.|| |
Status output format type. Possible values:
- ServeTime – order pickup time.
- CookingTime – preparation time.
- RemainingTime – wait time.
- DeliverTime – delivery time.
- SpecialText – regular text.
|format||Status output format. Depends on the format type (type parameter). For instance, for time output types, use [HH:mm], and for a regular text (SpecialText) – specify this text.||HH:mm|
|completeStatusName||Text displayed when an order is ready.||Ready|
|orderNumberLength||Order number length.||2|
|leadOrderNumberSymbol||Character used at the beginning of an order number if it has fewer characters than orderNumberLength.||0|
|ordersRefreshTimeout||Board refreshment period in seconds.||15|
|imageChangeTimeout||Image change period in seconds.||30|
|notResponseTimeout||POS response timeout in seconds.||30|
|splashChangeTimeout||Change interval in seconds for ready order pop-up windows.||4|
|splashShowTimeout||Display time of ready order pop-up windows.||3|
|completeStatusImage||Ready order image. An image is displayed if its file is specified. If blank, the completeStatusName value is used.||complete.png|
|notResponseImage||POS error image.||error.png|
|licenseLimitImage||License number error image.||license-error.png|
|backgroundImage||Background image.||Blank value|
|orderCompleteSound||Ready order sound. Specify an MP3 file.||sound.mp3|
Table numbers of displayed orders. Several tables must be comma separated.
Empty row: display all tables.
Table numbers of not displayed orders. Several tables must be comma separated.
Empty row: display all tables.
|When you set up the showTables and hideTables parameters, table numbers must be unique in all the sections as iikoArrivals cannot recognize which section an order comes from. If both the Dining Room and Bar have the same table 101, it won’t be displayed on the screen. |
Order status codes (ID) used in setup:
- 0 - Queued.
- 1 - Time to cook.
- 2 - Cooking.
- 3 - Cooking2.
- 4 - Cooking3.
- 5 - Cooking4.
- 6 - Ready.
- 7 - Served.
- 8 - Deleted.
All the images used in the iikoArrivals configuration file are stored in the content folder. Here you can find logos, background images, sounds and other files that may be used for all the templates. Please do not use external file sources, they are not supported.
The content\images directory contains ad images alternating on the display board. Please do not use this folder for other images like logos, background images, etc.
The content\images-fullscreen directory contains images that alternate in the full-screen mode in the absence of orders.
For your convenience, you can create additional folders in the content directory. In this case, specify the right location in the config.json file. Suppose you’ve created the logo folder in the content directory and put there a logo.png file. Then you have to specify the path: logo\logo.png.
In iikoArrivals, we have several preset templates. They are located in the templates directory. Each has its own same-name folder. Each folder contains the following:
- HTML file. It defines the page layout to be displayed on the board.
- CSS file with the description of the HTML file layout.
You may use any of the preset templates or create a new one.
To create a new one, you may copy an existing template directory and rename it as you think fit. Then edit the directory files according to your corporate standards.