Adding Kiosk Clients

In the EMC, add two workstation records.
For the first record:
- Select the 2 - Workstation Client type.
- Specify the Database Update Frequency (for example, 90).
- On the Revenue Centers tab, select the revenue center from the first drop-down list.
- On the Options tab, Offline/Misc sub-tab, select 17 - Allow Offline Operations. This ensures the check flows from the kiosk workstation to the Check and Posting Service (CAPS) when the kiosk workstation is offline.
- If you are using a barcode scanner to support ordering menu items, on the Devices tab, add a peripheral device for the scanner. Select Barcode Reader as the Type and Generic Barcode Reader as the Device.
For the second record:
- Select the 3 - POSAPI Client type.
- For Service Host ID, select the workstation client for the first record you created.
- Select the Simphony Transaction Services version for your implementation:
  - For on-premise, select Enable Simphony Transaction Services (Gen 1) Location API.
  - For cloud, select Enable Simphony Transaction Services (Gen 2) Cloud API.
- Specify the Database Update Frequency (for example, 90).
- On the Revenue Centers tab, select the revenue center from the first drop-down list.
- To specify a minimum and maximum check number range, on the Transactions tab, set the Minimum Check Number and Maximum Check Number values.
- On the Printers tab, select the printers for Customer Receipt Printer and Guest Check Printer.
  To support printing the customer receipt:
  
  On the Configuration tab, click Employee Classes, and open the employee class for the kiosk. On the Operator Options tab, select 0 - By Round from the Operator Type drop-down menu.
  
  For the Revenue Center parameter, deselect 9 - On Demand Customer Receipt.
See Adding a Workstation and Printers for more information.
Add standard Client Application Loader (CAL) packages and the custom kiosk CAL package, and then add deployment schedules for the packages.
See the Oracle Simphony Client Deployment Guide for more information.
Add a tag to the menu item definition under the Tags tab. You can create new or use existing tag groups and tags. You can have only one menu for each revenue center. Tags and tag groups are required for the items to load on the kiosk screen.

See Configuring Menu Tag Groups and Tags and Associating a Menu Item Definition with a Tag for more information.
Optionally, create screen look ups (SLUs) to organize tagged menu items. You can use existing SLUs. For example, use a SLU to group all appetizers.

See Creating Screen Look Ups for Menu Items for more information.
Assign images to the menu item definitions.

The kiosk user interface shows the Image 1 picture on the Menu page, cart page, and as the small image anchored to the top of the menu item details page when you scroll. It shows the Image 3 picture as the large image at the top of the menu item detail page.

You can use existing menu item definitions or create new ones.

See Associating Images to Menu Item SLUs for more information. See the Networking Reference Guide for more information about hosting images.
Set up the tender media.
For example, you can set Pay on Pick Up with the Service Total key type and SPI Default with the Payment key type. You can use existing tender media or create new tender media.
Note:
Partial payments are not supported.

You must predefine tender media for valid cards.

Guests can pay through the Simphony Payment Interface (SPI) with debit cards and credit cards such as Visa, Master Card, American Express, and Diners Club.

SPI replaces the tender based on the issuer ID in the response.

Create the content file with the parameters that define the order types, tenders, filters, and SLUs used by the kiosk for each configured revenue center.

The parameter values you define in the content file must match the values defined in the EMC.

Use the following code sample as a template. Copy it to a text editor, replace the template values with your values, and then save the file as KioskParameters.json. The table that follows the code template describes the parameters.

{
    "kioskParameters": [
        {
            "kioskParameterId": 1,
            "orgShortName": "kmp",
            "locRef": "lifeworks",
            "rvcRef": 1,
            "kioskEmployeeNumber": 2,
            "uiOptions": {
                "showUpsellPage": true, 
                "showAllergenFilter": true,
                "defaultCultureCode": "en-US", 
                "selfCheckoutMode": false,
		   "showGuestNameEntry": false,
                "showPostOrderInstructions": false
            },
            "paymentDataSettings":{
                "siteId": "Oracle_US_POS",
                "transCurrency": "USD"
            },
            "orderTypes": [
                {
                    "orderTypeRef": 1,
		    "postOrderInstructions": {
                        "paidInFull": {
                            "en-US": [
                                "1. Take your receipt and proceed to the pickup area.",
                                "2: Look for the status of your order on the order status boards.",
                                "3. Once your order number is called, proceed to the order collection station."
                            ]
                        },
                        "balanceRemaining": {
                            "en-US": [
                                "1. Bal remaining.Take your receipt and proceed to the pickup area.",
                                "2: Look for the status of your order on the order status boards.",
                                "3. Once your order number is called, proceed to the order collection station."
                            ]
                        }
                    }
                }               
            ],
            "tenders": [
                {
                    "tenderId": 2 
                },
                {
                    "tenderId": 201, 
                    "useSPIPayments": true 
                }
            ],
            "kioskMenuFilters": { 
                "tagGroups": [
                    {
                        "id": "Kiosk All Day",
                        "tags": [
                            "All-Day",
                            "Evening"
                        ] 
                    }
                ]
            },
            "categories": { 
                "slus": [
                    {
                        "sluNumber": 2,
                        "sluImageIndex": 3 
                    },
                    {
                        "sluNumber": 4,
                        "sluImageIndex": 3
                    }
                ],
                "upsellSlu": [ 
                    {
                        "sluNumber": 8,
                        "sluImageIndex": 1
                    }
                ]
            }
        }
    ]
}

Table 7-1 Kiosk Parameters

Name	Parent Name	Type	Description
Kiosk Parameters		KioskParameters[]	Kiosk Parameters configuration for each revenue center.
kioskParameterId	Kiosk Parameters	number	Kiosk Parameter ID.
orgShortName	Kiosk Parameters	string	Organization short name in Simphony. For example `ksk`.
locRef	Kiosk Parameters	string	Location reference for Property as shown in the EMC at Enterprise, Property, Report Location, Edit.
rvcRef	Kiosk Parameters	number	Revenue center reference. Object number of revenue center as shown in the EMC at Property, RVC Configuration.
kioskEmployeeNumber	Kiosk Parameters	number	Object number of the employee record used for all check operations.
uiOptions	Kiosk Parameters	uiOptions{}	Options applicable to kiosk user interface
showUpsellPage	uiOptions	Boolean	true/false If set to true, show the upsell page only once for each ordering session.
showAllergenFilter	uiOptions	Boolean	true/false If set to true, show the Allergens filter on the Menu page.
defaultCultureCode	uiOptions	string	Language Culture code is ISO Code Example: “en-US”
selfCheckoutMode	uiOptions	Boolean	true/false If true, order starts from cart page. User can directly scan their menu items using the barcode scanner and check out. If false, takes the user to Menu page. User can search for menu item, add to cart, and proceed to check-out.
showGuestNameEntry	uiOptions	Boolean	true/false If set to true, shows the Guest name page after proceeding to check out on the Review your order page.
showPostOrderInstructions	uiOptions	Boolean	true/false If set to true, display configured Post Order Instructions on Thank You page based on Order Type and Paid in Full/Balance Remaining.
paymentDataSettings	Kiosk Parameters	paymentDataSettings{}	Payment settings for payment using SPI.
siteId	paymentDataSettings	string	Merchant Account Name or Number.
transCurrency	paymentDataSettings	string	Transaction currency .It is the base currency for transactions. Enter the country-specific ISO currency code.
orderTypes	Kiosk Parameters	orderTypes[]	Order types for Kiosk. Examples: Dine-In, Take Away.
orderTypeRef	orderTypes	number	Object number of Order type as shown in the EMC at Property, Descriptors, Miscellaneous, Order Types.
postOrderInstructions	orderTypes	postOrderInstructions{}	Post-order instructions.
paidInFull	postOrderInstructions	paidInFull{}	Post-order instructions when paid in full.
en-US	paidInFull	en-US []	Specify post-order instructions when order is paid in full in en-US language.
balanceRemaining	postOrderInstructions	balanceRemaining{}	Post-order instructions when a balance is remaining.
en-US	balanceRemaining	en-US []	Specify post-order instruction when a balance is remaining in en-US language.
tenders	Kiosk Parameters	tenders[]	Specify the list for tenders. Tenders appear in on the kiosk user interface in the order they are specified in the parameters file.
tenderId	tenders	number	Object number of Tender Media.
useSPIPayments	tenders	Boolean	true/false If true, for credit or debit payment, SPI replaces the tender based on the issuer Id in the response. If false, user cannot make a payment using credit or debit.
kioskMenuFilters	Kiosk Parameters	kioskMenuFilters{}	Filters to decide which menu items are available for ordering on the kiosk. The kiosk front-end shows the first price found on the tagged definitions.
tagGroups	kioskMenuFilters	tagGroups[]
id	tagGroups	string	Enter the name of the Tag group. For example, Kiosk All Day.
tags	tagGroups	string	Enter the name of the tags associated with tag group and with menu item definitions. For example, All-Day, Evening.
tags	kioskMenuFilters	tags[]	List the name of tags that are not associated to a tag group.
categories	Kiosk Parameters	Categories{}	Menu categories to show on the Menu page. Supported category is only SLUs.
slus	categories	Slus[]
sluNumber	slus	number	SLU key number from Menu item definition as shown in the EMC at General, Touchscreen Properties where the SLU is selected.
sluImageIndex	slus	number	Image index from the SLU where the kiosk user interface retrieves the image to be shown on the user interface.
upsellSlu	categories	upsellSlu[]	Front end looks for any tagged definitions that have the SLU number configured and shows them on the Upsell page if showUpsellPage parameter is set to true.
sluNumber	upsellSlu	number	SLU key number from Menu item definition ash shown in the EMC at General, Touchscreen Properties where the SLU is selected.
sluImageIndex	upsellSlu	number	Image index from the SLU where the kiosk user interface retrieves the image to be shown on the user interface.

Import the KioskParameters.json file:
1. In the EMC, select the property or revenue center, click Setup, and then click Content in the Custom Content section.
2. Add a record and name it _KioskParameters_.
3. Select 23 - Text from the Content Type drop-down list.
4. Click Import from a file, and then select the KioskParameters.json file with your values.

Create the content file with your payment server details.

Use the following code sample as a template. Copy it to a text editor, replace the template values with your values, and then save the file as KioskServerParameters.json. The table that follows the code template describes the parameters.

{ 
    Payment :
    {
        TransCurrency: 840,
        SiteId: "123456789",
        HostURL: "https://localhost:8991",
        Timeout: 1000
    }
}

Table 7-2 Payment Server Parameters

Name	Parent Name	Type	Description
Payment		Payment{}
TransCurrency	Payment	number	Enter the transaction currency ISO 4217 number. For example, 840 for United States dollars.
SiteId	Payment	string	Merchant Account.
HostURL	Payment	string	Host URL of payment device. For example: `https://localhost:<Port Number>`
Timeout	Payment	number	Value in seconds 1000

Import the KioskServerParameters.json file:
1. In the EMC, select the property or revenue center, click Setup, and then click Content in the Custom Content section.
2. Add a record and name it _KioskServerParameters_.
3. Select 23 - Text from the Content Type drop-down list.
4. Click Import from a file, and then select the KioskServerParameters.json file with your values.

Parent topic: Kiosks