Overview

Quick Service Restaurant (QSR) solutions, or Kitchen Display Systems (KDS) are used by Volanté to improve efficiency in food service operations. These solutions serve to relay information from kiosk or cashier orders to a Kitchen display.

This page covers processes for the RESTful QSR KDS integration for KitchenServer, also known as the RESTful API version. This process differs from the processes used for the previous QSR version, now referred to as the Legacy version. This change can be made through General Setup > System Configuration, where users may switch between QSR versions.

Open

Choosing between Legacy and RESTful API in System Configuration.

Table of Contents

• 1 Overview
  • 1.1 Table of Contents
• 2 Menu Setup Guide
• 3 Certification
• 4 Improvements by Version
  • 4.1 Build 1777_0000
• 5 Enabling RESTful API – New QSR Setup on BO/HO
  • 5.1 Steps for BackOffice
  • 5.2 Steps HeadOffice and Syncing to BackOffice 
  • 5.3 Additional Menu Setup Prerequisites
    • 5.3.1 Modules Setup
    • 5.3.2  Printer Types
    • 5.3.3 Menu Setup
    • 5.3.4  Hardware Setup
• 6 Ordering via Kiosk
  • 6.1 SMS and Telephone Number Details
  • 6.2 Flags
• 7 Setting Priority Value for QSR Items
  • 7.1 Priority Value
  • 7.2 Prerequisites
  • 7.3 Workflow for Priority Items
• 8 Customer Notes
  • 8.1 Customer Name Attached to Seats
  • 8.2 Allergy / Allergens
• 9 Setup SMS Notifications in BackOffice
• 10 Developer Guide on New 1777 QSR integration API fields
  • 10.1 Related Articles
    • 10.1.1 QSR Guide and Specifications (Hardware and General Usage)

Menu Setup Guide

Basic SMS functionality for POS is also covered in the Volante Menu Setup guide.For more details, please see:

Volanté Menu Setup Guide (PDF)

Certification

QSR Partner Development requires a completed questionnaire from the partner for review prior to the scheduling of certification work. Please contact partnerdevelopment@qsrautomations.com for additional information about the questionnaire, certification requirements or related topics.

https://www.dropbox.com/s/hnltmq2yh1nt8r7/ConnectSmart_Volante_POS%20%26%20eCommerce%20Integration%20Questionnaire%20-%20Final%20Copy.pdf?dl=0

Improvements by Version

Build 1777_0000

Volante Build 1777 features improvements to QSR functionality:

• When ordering items for a second course, TableName, Server ID, and Server Name are now added to the data sent

• Customer name data will no longer be sent if the field is empty

• Item Categories of the course option modifier (e.g., course 1, 2) will be the same as the parent item

• Custom items will now have a department ID of 9999

Enabling RESTful API – New QSR Setup on BO/HO

These instructions will allow users to configure newer QSR devices with the RESTful API QSR Version, allowing it to be used with the ConnectSmart KitchenServer integration.

This can be accomplished on both the BackOffice and HeadOffice.

Steps for BackOffice

The following covers setting up the QSR version in the BackOffice.

1. Launch the BackOffice

2. Go to General Setup > System Configuration > Page 2 > Kitchen Display Options
    

3. Click the QSE Version drop-down list, and select RESTful API.

   Open

   

4. If testing, launch SQL and verify the "qsrVersion" field value is valid.

Steps HeadOffice and Syncing to BackOffice 

The following covers setting up the QSR version in the HeadOffice and syncing information to the BackOffice.

1. Launch HeadOffice.

2. Go to Change Store and select the local store.

3. Navigate to General Setup > System Configuration > Page 2 > Kitchen Display Options

4. From the QSR Version drop-down list, select RESTful API, then click Save.

5. Launch BackOffice.

6. Go to Data Synch > Sync with Corporate.

7. Go to General Setup > System Configuration > Page 2 > Kitchen Display Options. Verify that your changes have synced.

8. If testing, launch SQL and verify the "qsrVersion" field value is valid.

Additional Menu Setup Prerequisites

Modules Setup

1. From Volanté BackOffice, select General Setup.

2. From the General Settings tab, select Volante Modules, then select Properties.

3. Ensure the QSRModule is checked.

 Printer Types

1. From Volanté BackOffice, select General Setup.

2. From the POS Settings tab, select Printer Types, then select Properties.

3. Make sure there is a printer type where is Kitchen Video is enabled (checked).

Menu Setup

1. From Volanté BackOffice, select Menu Setup.

2. Make sure the menu items you want routed to QSR has the Printer Type (with is Kitchen Video) checked.

3. Menu item department Id must be set to the appropriate food type.

 Hardware Setup

1. From Volanté BackOffice, select Hardware.

2. From the Terminal Setup, highlight the applicable POS Terminal from your list of terminals (left pane).

3. Select the Advanced Options tab.

4. Under KDS Properties, enter a KDS Terminal ID (-1 if QSR not used for terminal).

Ordering via Kiosk

SMS Notifications allows customers to be notified when their order is ready when ordering via Kiosk.

User should be able to confirm if they wish to be notified via SMS once their order is ready, confirm if the existing number is correct or add a new cell number and save if user exists in our CDB, but has no number saved on file. Then, SMS should be sent automatically to the user, if user selected to be notified via SMS. 

SMS and Telephone Number Details

• The SMS message for Order Ready is set up by customers via the Volante QSR Kitchen Portal.

• The pop-up message itself is customizable to an extent; users may customize the wording, and have access to several tags (SiteName, CompanyName, CustomerName, GuestFirstName, GuestLastName, and CheckNumber).

Flags

• Existing functionality: right now we have a flag that identifies items that need to go to the kitchen to get prepared. This new functionality on POS - to be notified via SMS about user's order being ready should be enabled only if that flag is on for one or more menu items. Meaning, user should not be prompted to get an SMS when their order is ready if user purchased items that do not require kitchen preparation (e.g. water, apple). 

• If user's order contains menu items needing preparation, a POS cashier should be prompted to a new screen asking if I as a user wish to be notified when my order is ready via SMS. If not, it should take me to the screen asking user if they would like their receipt to be sent electronically. If yes, they should be prompted to confirm or state their phone number.

Setting Priority Value for QSR Items

Priority Value

Priority value attributes display the order of the items on the QSR terminal. The first name should display at the top followed by all other items. 

The Priority Value should be as follows:

1. The custom item for the customer's first name should be 0

2. All other custom items should be 1

3. Menu items should be 2

Prerequisites

Prior to configuration, ensure the following criteria are met:

1. There are QSR items present in the POS Quick Menu

2. The QSR version is set to "RESTful API", via BO > General Setup > System Configuration > Page 2 > Kitchen Display Options.

Workflow for Priority Items

1. Launch POS and login as a Cashier.

2. Add QSR items, option items, combo items to the transaction.

3. Add a customer to the transaction.

4. Add transaction note to the transaction.

5. Close transaction after the payment.

6. Click Yes. Click Confirm.

7. Go to QSR capture player and verify value for "PriorityValue" attribute.  

Customer Notes

This feature allows customers to identify orders more readily. Customer names are often used to identify orders, for table service orders, as well as identifies which specific customer is at each seat.

Customer Name Attached to Seats

Volanté offers the ability to attach the customer name to the seat so the kitchen knows which customer made a specific order, on the QSR screens similar to our kitchen chits. 

Volanté will show each customer’s name per seat on the kitchen display by sending it as a “fake menu item” (with a unique ID number).

Allergy / Allergens

Volanté records individual Customer allergies via 'Customer Notes', or using other custom attributes in the Volante CDB.

• If the customer does not exist in the CDB, cashiers will need to manually record preferences and allergies in the 'Transaction Notes A' field.

• Volanté can also display items with Allergies (via customer notes and transaction notes A) in red on kitchen chits and on the QSR Kitchen Display.

• This is displayed in via Customer Notes (first position) and Transaction Notes A (second position) on the kitchen display.

Configuring colors for items can be accomplished via GRDS Color Schemes in the ConnectSmart Kitchen Builder Pro application.

Setup SMS Notifications in BackOffice

Prior to using the SMS notification feature, users must perform some configuration to prepare it for service.

SMS notifications are enabled through Hardware > Terminal Setup > Advanced Options > Other > Customer Order Notification via SMS.

Developer Guide on New 1777 QSR integration API fields

Available as of Build 1777.

The KitchenServer POS Web API SDK supports a web service interface available for POS integration partners to interact with the ConnectSmart KitchenServer application. The intended use of the KitchenServer POS Web API is to be implemented locally (“on premises”) in the restaurant, invoked by a locally hosted interface service or POS component.

QSR KitchenServer POS Web API