Skip to main content

Xenial Product Documentation

Suite Catering: Getting Started

Suite Catering is a venue-focused Xenial Cloud service accessed through Xenial Cloud Portal. It allows venue staff to manage suites, accounts, advanced day order and event day order workflows, and their associated business processes; the fan-facing SuiteSpot allows authorized users to view events, manage their account settings, and place advanced day orders online.

Please be aware that all the mentioned operations are contingent upon the completion of essential configurations. This section provides guides on achieving the goal of placing orders on both the Suite Catering Admin Portal and SuiteSpot with minimal configuration.

The configuration procedure is outlined in the table below, with each step being a distinct process.

Step

Process

Description

1

Login to Xenial Cloud Portal

log in to the Xenial Cloud Portal

2

Add Company

add the company to the Xenial Cloud Portal

Important

It is imperative to toggle Event-Based Accounting to Yes on the Admin Options tab page.

3

Create Site

create a site for the company

4

Subscribe to services at the company level

enable the Suite Catering and Online Ordering services at the company level

5

Enter the newly added company

  1. From the left menu pane on the Admin homepage, select All Companies.

  2. Locate the newly added company.

  3. Select the ellipsis menu of the company.

  4. Select Select from the dropdown menu.

6

Add the Freedom Pay service for XCAT

  • Service Name can be any value that makes sense to you.

  • Service URL must be set to https://hpc.uat.freedompay.com for the test environment or https://hpc.freedompay.com for the production environment.

  • Type must be Payment.

  • Merchant Name can be any value that makes sense to you.

  • Xenial ID must be freedompay.

7

Add the Freedom Pay section to the Freedom Pay service

add one section named Freedom Pay

8

Add four fields to the Freedom Pay section

set the parameters of the four fields as outlined below:

  • Type: Text Entry

  • Label: Secondary URL, Merchant Key, Merchant Site ID, and Merchant Terminal ID (respectively)

    Note

    The labels correspond to the names of the four fields.

  • Required: On

9

Configure the Freedom Pay service at the company level

  1. Enable the Freedom Pay service.

  2. Set Service URL to https://hpc.uat.freedompay.com for the test environment or https://hpc.freedompay.com for the production environment.

  3. Go to the Freedom Pay tab and set the parameters as outlined below:

    • Secondary URL: https://cs.uat.freedompay.com for the test environment or https://cs12.freedompay.us for the production environment.

    • Merchant Key: TFMBH4CWQCMJ68GW8CT2XRXF27FY3HMY

    • Merchant Site ID: 1521301976

    • Merchant Terminal ID: 2523918973

Important

The configuration of the parameters, namely Merchant Key, Merchant Site ID, and Merchant Terminal ID, is specific to the test environment. Adjust the parameters according to site conditions.

10

Add and configure the Freedom Pay service at the site level

  1. Add the Freedom Pay service to the company's site.

  2. Toggle Active to Yes.

  3. Set Environment to Use Company Settings.

Important

To use the Freedom Pay payment gateway for your company, ensure that the Xenial Payment Router service is disabled.

11

Subscribe to services at the site level

add the Suite Catering and Xenial Payment Router services to the site

12

Configure the Xenial Payment Router service

configure the parameters for the Xenial Payment Router service with the following settings:

  • Environment: Production

  • Merchant Name: Test Xenial

  • Merchant Site ID: L7AYDTR5

  • Merchant Key: Y6VFU-5V44G-Y6AUW-XDJOG-E16IS

  • Web Checkout Key: V1S0CCKS16LSPJL3

Important

The settings of these parameters apply exclusively to the test environment. Adjust the parameters according to site conditions.

13

Activate services for the site

activate the Suite Catering and Xenial Payment Router services for the site

Important

If the Xenial Payment Router service is enabled, your company may still use Genius as the payment gateway, even if the Freedom Pay service is activated.

14

Create an admin user

create an admin user and assign the user to the company's site

15

Register the admin user

  1. Go to the email address of the newly added admin user.

  2. Locate and open the Your confirmation link email.

  3. Select the Complete My Registration link to register the user.

16

Configure the sequence number maximum length and order number maximum length in Site Preferences

Order Number = Terminal Number + Sequence Number

Note

The order number must not exceed 8 characters in length. If it does, payment processing for orders on the Suite Catering Admin Portal and POS is not feasible.

17

Enable floor plans

enable floor plans to ensure proper display of suite views on the POS

18

Create order sources

create four order sources: SCP ADO, SS ADO, EDO, and Par Stock

Note

The ADO Order Source toggle must be turned on for advanced day orders (SCP ADO and SS ADO) and must be turned off for event day orders and par stock orders (EDO and Par Stock).

19

Create products

  • On the Suite Catering Admin Portal, the value of a product's Formal Name is displayed as the product name. For more information, see Naming.

  • On the SuiteSpot, the value of a product's Short Description is displayed as the product name. If Short Description is left blank, Formal Name is displayed as the product name. For more information, see Additional Information.

  • On the POS, the value of a product's Menu Caption is displayed as the product name. If Menu Caption is left blank, Formal Name is displayed as the product name. For more information, see Menu Display Options.

20

Create menus

create menu item groups, menu categories, and menus

21

Create price points

create price points to enable a site to charge a different price and/or enforce a different pricing rule during special events

22

Create event types

create the event type records that are used with events

23

Create events

create user-defined calendar events that influence or affect sales and business operations at one or more sites

24

Add four menu delivery services

  • Service Name for the four menu delivery services must be SCP_ADO, SCP_EDO, SS_ADO, and SCP_PARSTOCK. Note that service names cannot contain spaces.

  • Type must be Delivery.

  • Order Source determines which orders this service can refresh the menu for. Ensure that order sources match service names to avoid confusion.

  • Service URL can be any URL.

25

Add the Suite Catering section to menu delivery services

add one section named Suite Catering

Note

The section must be named Suite Catering to prevent menu refresh anomalies.

26

Add fields to the Suite Catering section

add the following three fields and set their parameters as outlined below:

  • menu_engine_callback_url

    • Type: Text Entry

    • Label: menu_engine_callback_url

    • Required: On

    • Placeholder Text: Suite Catering Webhook

    • Retain default values for other parameters

  • include_image_sets

    • Type: Toggle

    • Label: include_image_sets

    • Default State: On

    • On Description: True

    • Off Description: False

    • Help Text: include image set

    • Parameter Key: include_image_sets

  • allow_price_point_injection

    • Type: Toggle

    • Label: allow_price_point_injection

    • Default State: On

    • On Description: True

    • Off Description: False

    • Retain default values for other parameters

27

Configure menu delivery services at the company level

  1. Enable menu delivery services.

  2. In the menu_engine_callback_url field on the Suite Catering tab, type https://{{env}}-xcat-backend.xenial.com/menus/status, for example, https://uat-xcat-backend.xenial.com/menus/status. In the production environment, the address should be https://xcat-backend.xenial.com/menus/status.

28

Add and configure menu delivery services at the site level

  1. Add the four menu delivery services to the company's site.

  2. Toggle Active to Yes.

  3. Set Environment to Custom.

29

Create payment types

create payment types for the Suite Catering

Important

  • Suite Catering Admin Portal supports payment types of three payment classes: Custom, Credit Card, and House Account. Meanwhile, SuiteSpot supports payment types of two payment classes: Credit Card and House Account.

  • If the payment type is invoice, Payment Class and House Account Type must be set to House Account and Xenial House Account respectively.

  • If you set Payment Class and House Account Type of a payment type to House Account and Xenial House Account respectively but instead of setting its name to invoice, you set it to some other value, such as Honor Pay (which is not recommended), this payment type is still considered as an invoice payment type. Invoice-related pages on the Suite Catering Portal and SuiteSpot will still use the word "Invoice".

  • If the Account Invoicing toggle is turned off, payment types of the House Account class are unavailable on the SuiteSpot but are still available on the Suite Catering Admin Portal.

30

Create a payment type scheme

create a payment type scheme and add payment types to it

31

Create a terminal scheme

create a terminal scheme, select Table Map in Available System Navigation Options, and add the payment type scheme in Payment

Important

Only after Table Map is selected, table maps can be properly displayed on POS.

32

Create a terminal

create a terminal and add the terminal scheme

33

Create an order destination

create an order destination and specify the following three parameters with their required values:

  • Name: Dine In

  • ID: dine-in

  • Active: Active

34

Refresh menus

refresh menus by using the four delivery services

Important

  • This method is applicable if a new menu is added, a menu is deleted, or a menu's name is changed.

  • If any modification are made to a menu category, menu item group, or item (product), or if items are added to or deleted from the menu, refresh menus by following procedures outlined in Configure Menu Settings or Refresh Menu.

35

Configure ordering settings

ensure that order sources must match, for example, the order source of SuitSpot - ADO must be SS ADO

36

Configure menu settings

select menus for Advanced Day Order Menu, Event Day Order Menu, Advanced Day Order Online Menu, Advanced Day Order Transition Online Menu, Event Day Order Online Menu, and Par Stock

37

Create tags

create tags with Suite Catering and Table Maps in the Usage section selected

38

Create suite classes

establish suite categories

39

Create suite representatives

create representatives who oversees the order fulfillment, and assists with suite issues that may arise

40

Create suites

create suites to deliver orders

41

Create accounts

create temporary guest accounts or permanent accounts

Important

  • To place orders on the SuiteSpot, create at least one permanent account.

  • If necessary, import accounts to batch create accounts and their authorized users.

42

Add authorized users

add at least one authorized user to a permanent account and enable the Place Advanced Day Orders permission for it

Important

Only authorized users with the Place Advanced Day Orders permission can place orders on the SuiteSpot.

43

Place orders on the Suite Catering Admin Portal

create orders for permanent accounts or temporary guests on the Suite Catering Admin Portal

44

Place orders on the SuiteSpot

  1. Log in to SuiteSpot.

  2. Place orders.