Skip to main content

Add Company

Xenial Cloud Portal User Name Dropdown Admin

Important

Only Admin users have the ability to add a company to the Xenial Cloud Portal.

To add a company:

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

  2. From the upper-right of the Company List homepage, select Add Company.

  3. From the left menu pane, select a page and define the respective settings.

    The following introduces the pages of the New Company editor.

    Page

    Description

    General

    Define company profile settings.

    Brands

    Add related brands and child companies by brand (if applicable).

    Subscriptions

    Enable product subscriptions.

    Services

    Setup company services.

    Identity Providers

    Add Identity Providers for user authentication.

    Admin Options

    Enable various administrative options, including Event-Based Accounting.

General

From the General page of the Company editor, define the following company profile settings:

Setting

Description

Name

Type the company name.

Type

From the dropdown, select the company type (e.g. Production, Lab).

Business Class

From the dropdown, select the applicable business class: Enterprise or SMB (small or midsize business).

Address

Company address.

City

City where the company is located.

State

From the dropdown, select the state where the company is located.

Zip / Postal Code

Company zip or postal code.

Country

From the dropdown, select the country where the company is located.

Time Zone

From the dropdown, select the time zone where the company is located.

Preferred Language

From the dropdown, select the preferred language for UI components to enable users to more efficiently interact with the application.

Support Phone Number

Type the phone number to contact support. The site manager calls this number in the event issues arise that require assistance.

Brands

From the Brands page of of the Company editor, add related brands and child companies.

To add related brands:

  1. From the upper-right of the Brands section, select Add Brands.

  2. From the Add Brand window, select the brand(s).

  3. From the lower-right of the Add Brand window, select Add # Brands.

To add child companies by brand:

  1. From the Brands page, locate the Child Companies by Brand section.

  2. From the upper-right of the Child Companies by Brand section, select Add Child Company.

  3. From the Add Child Company window, select the child companies.

  4. From the lower-right of the Add Child Company window, select Add # Child Companies.

Subscriptions

From the Subscriptions page of the Companies editor, enable product subscriptions:

  1. From the Subscriptions list, select the product subscription.

  2. From the product window, toggle Enabled to Yes to enable the product subscription.

  3. From the lower-right of the product window, select Done.

Messaging Settings

When the Messaging subscription is enabled, define the following:

Setting

Description

Core Services

Enable the desired messaging services. At least one Core Service selection is required.

Company Type

From the dropdown, select the applicable business class: Enterprise or SMB (small or midsize business).

Primary Contact Name

Type the name of the primary contact for this product subscription.

New Messaging UI Enabled

Toggle Yes to enable the user interface for the new messaging service.

Toggle No to use the legacy messaging service.

The New Messaging UI Enabled toggle is only available when the selected company type is Enterprise.

Online Ordering Settings

See Online Ordering Settings for instructions on how to configure the Online Ordering service.

Xenial Back Office Settings

When the Xenial Back Office subscription is enabled, define the following:

Setting

Description

Domain

Type the domain value that is used to identify the company in Xenial Back Office.

Services

From the Services page of the Companies editor, configure the company services:

  1. From the Services homepage, select the service.

  2. From the Edit service window, toggle Enabled to Yes to enable the service subscription.

  3. Configure the service settings, if applicable. See Service Settings for definitions of the configurable settings for each service.

  4. From the lower-right of the services form, select Done.

Service Settings

The following table identifies the configuration settings for select services.

Service

Settings

Altametrics

  • Application URL - Paste the Application URL.

  • Partner ID - Type the partner identifier provided by Altametrics.

  • Partner Key - Paste the Partner Key.

  • Client ID - Type the client identifier provided by Altametrics.

  • eRest Site Number - Type the identifier for eRestaurant client.

  • Calculation Values - From the dropdown, select the set of Calculation Values that corresponds with the reporting data set.

  • Active - Toggle Yes to enable the service.

Analytics

  • Business Owner Name

  • Merchant Legal Name

  • Merchant Name

  • Merchant Category Code

Avalara

  • Contact email

  • Contact first name

  • Contact last name

  • Link to Avalara Terms and Conditions

  • Agreements - Select the check boxes to acknowledge agreement to the terms and conditions.

Citcon

  • Transaction URL - The authentication URL for the Citcon payment merchant.

Deputy

The following credentials are used by default if credentials are not specified at the site-level:

  • Access API Link - Link to the service API.

  • Access Token - Token for the service API.

Esper

  • Service URL - The Esper Console service link.

Food Delivery Services (DoorDash, GrubHub, Uber Eats)

Toggle on the delivery services used at the company and define the following settings:

  • Delivery Service URL - The delivery service link for the company. This link is required by some Valued Partners.

  • Callback URL - (Optional) The Menu Engine link for Web site validation.

  • Order Source - From the dropdown, select the order source to associate with the delivery provider.

    This provides the ability to filter out orders from the provider on reports and designate specific menus for the provider.

Important

Contact the Xenial EngOps team to setup the tokens for both links.

DoorDash Self-Service Integration

Xenial manages integration (tokens, subscriptions, test stores) and monitors integration health in real-time via the new self-service DoorDash Developer Portal.

From the DoorDash Onboarding section of the service form, directly activate sites for the DoorDash delivery platform.

FreedomPay

  • Environment - From the dropdown, select the environment where the service is installed.

  • Enhanced Security Key - Type the enhanced security key provided by FreedomPay.

  • Device Management Activation Key - Type the device management key provided by FreedomPay.

Loyalty

From the Loyalty Provider dropdown, select the loyalty provider to enable.

Configure the settings for the loyalty provider:

Macromatix

Specify the target FTP server credentials. The data is sent and retrieved from the server.

  • Host - The host name of the FTP server.

  • Username - The username to access the FTP server.

  • Password - The password to access the FTP server.

  • Port - The port number of the FTP server.

  • Directory - The root folder route of the FTP server.

Select Validate to determine if the provided credentials are valid.

NCR/Aloha Service

  • Integration Type - Identifies how the POS service integrates with DMB Enterprise.

  • Integration Company ID - Identifies the unique Company ID within the company and integrator type.

The following settings are only available when Xenial Scheduled Pull is selected from the Integration Type dropdown:

  • Frequency - From the dropdown, select the interval at which to perform the Xenial Scheduled Pull.

  • Time Interval - The field labels for the time interval fields are dependent on the selected frequency. Use the provided fields to define the frequency at which updates are performed.

PayPal QR Code

  • Connect Merchant to PayPal - Connect and link to PayPal.

  • Environment - From the dropdown, select the type of environment where the service is run.

  • Polling Timeout (s) - Specify the number of seconds to keep a request open before timing out. The minimum is 30.

  • Polling Interval (ms) - Specify the number of milliseconds to wait between requests to the payment service. The minimum is 1500.

  • Enable Tips - Toggle on to allow guests to add tips. Define the custom tip percentages to provide to the guest.

QU POS Service

  • Integration Type - Identifies how the POS service integrates with DMB Enterprise.

    POS Sends Data to Xenial API is the default type.

  • Integration Company ID - Identifies the unique Company ID within the company and integrator type.

The following settings are only available when Xenial Scheduled Pull is selected from the Integration Type dropdown:

  • Frequency - From the dropdown, select the interval at which to perform the Xenial Scheduled Pull.

  • Time Interval - The field labels for the time interval fields are dependent on the selected frequency. Use the provided fields to define the frequency at which updates are performed.

Revenu Québec WEB-SRM

The Sales Recording Module (SRM) service records all financial transactions made at the POS.

Stock On Hand

Xenial Cloud POS service supporting real-time stock level lookups across multiple sites for retail operations.

Undefined POS

  • Integration Type - Identifies how the POS service integrates with DMB Enterprise.

  • Integrator Company ID - Identifies the unique Company ID for the integration type.

Xenial Partner Relay (XPRL)

Integrator support for real-time stock level lookups across multiple sites from Xenial Cloud POS to retail operations.

Xenial Payment Router

Note

This service is only available at the site-level. It is not available at the company-level.

  • Environment - From the dropdown, select the type of environment where the service is run.

  • Merchant Name

  • Merchant Site ID

  • Apple Pay Merchant ID

  • Google Pay Merchant ID

  • Merchant Key

  • Web Checkout Key

Yellow Dog

Use the Yellow Dog API to update product list retail items. Item orders and returns processed at the POS are sent to the Yellow Dog service to update stock levels. Credentials are encrypted per Yellow Dog requirements.

General Settings

  • Enabled - Toggle Yes to enable the service.

  • Environment - From the dropdown, select the type of environment where the service is run.

  • Token URL - (Custom Environment Only) Specifies the URL for the authentication token used to connect a client to the service.

  • Data URL - (Custom Environment Only) Specifies the URL for the URI scheme used to inline data in a document.

  • Client ID - Type the provided client identifier.

  • Username - The username to access the server.

  • Password - The password to access the server.

Product Configuration Settings

For the following product settings, specify the default value for the product when a value is not provided by the provider:

  • Tax Group

  • Major Reporting Category

  • Minor Reporting Category

  • Image Set

Status/Info

Reference the date/time when Yellow Dog data was last synchronized for company sites, and the status of the synchronization.

  • Sync All Sites - Synchronize Yellow Dog data for all company sites.

Data Exclusions

If a delivery provider service does not support one or more Xenial Cloud POS data keys (e.g. nutritional data, modifier collections), exclude the data keys from the delivery service configuration.

Delivery services include a Data Exclusions page where the data keys to exclude from the service are identified.

To exclude a data key collection from a delivery service:

  1. From the left menu pane of the Edit service window, select Data Exclusions.

  2. From the upper-right of the Data Exclusion List window, select Add Data Exclusions.

  3. From the Add Data Exclusions window, select the data keys to exclude.

  4. From the lower-right of the Add Data Exclusions window, select Add # Exclusions.

To exclude a custom data key from a delivery service:

  1. From the left menu pane of the Edit service window, select Data Exclusions.

  2. From the upper-right of the Data Exclusion List window, select Add Custom Data Exclusion from the dropdown.

  3. In the Value field, type the data key to exclude.

  4. From the lower-right of the Add Custom Data Exclusion window, select Add Custom Exclusion.

BK Loyalty Settings

Setting

Description

Environment

From the dropdown, select the environment to use.

When Custom is selected, additional fields are displayed:

  • In the Custom Merchant URL field, type the custom merchant URL.

Location Key

In the provided field, type the location key.

Order-Source Mapping

Map POS order sources to the order source values required by the loyalty provider.

Add Destination Mapping

Map POS order destinations to the order destination values required by the loyalty provider.

Send all orders

When toggled Yes, receipt printing is allowed for non-Loyalty orders.

Paytronix Settings

Setting

Description

Provider Merchant ID

ID for the loyalty provider merchant.

Username

The username for the loyalty provider service.

Password

The password for the loyalty provider service.

Send all orders

When toggled Yes, receipt printing is allowed for non-Loyalty orders.

Environment

From the dropdown, select the environment to use.

When Custom is selected, additional fields are displayed:

  • In the Custom Merchant URL field, type the custom merchant URL.

  • From the Mapping Style, select the desired environment for mapping.

Validate

Select Validate to validate the provided credentials

Punchh Settings

Setting

Description

Send all orders

When toggled Yes, receipt printing is allowed for non-Loyalty orders.

Environment

From the dropdown, select the environment to use.

When Custom is selected, additional fields are displayed:

  • In the Custom Merchant URL field, type the custom merchant URL.

  • In the Custom Data Sync URL field, type the custom Data Sync URL.

Xenial Loyalty Settings

Setting

Description

Provider Merchant ID

ID for the loyalty provider merchant.

Username

The username for the loyalty provider service.

Password

The password for the loyalty provider service.

Send all orders

When toggled Yes, receipt printing is allowed for non-Loyalty orders.

Environment

From the dropdown, select the environment to use.

When Custom is selected, additional fields are displayed:

  • In the Custom Merchant URL field, type the custom merchant URL.

Revenu Québec WEB-SRM Service

The following identifies the configuration settings for the Revenu Québec WEB-SRM service. The Sales Recording Module (SRM) service records all financial transactions made at the POS.

The POS application must be registered and certified for each operating system (OS) separately. The WEB-SRM service defines identifiers that are specific to each OS (i.e. Windows, Apple iOS, and Google Android).

WEB-SRM: General Settings

From the General page of the Revenu Québec Web-SRM form, define general and availability settings for the service:

  1. From the General section, define the following setting:

    Setting

    Description

    Partner Identifier

    In the provided field, type the Partner Identifier provided by Revenue Québec for the company on the My Account portal.

    Maximum of 128 characters. Special characters not allowed.

  2. From the Availability Conditions section, define conditions to restrict the availability of the service to specific companies or brands. By default, the service is available to all companies.

    Setting

    Description

    Available by

    Select the preferred option:

    • Companies - Select to restrict the service by company.

    • Brands - Select to restrict the service by brand.

    Condition

    From the dropdown, select the desired option:

    • All Brands/Companies - The service is available to all brands / companies.

    • Including the Following - The service is only available to the selected brands / companies.

      From the Included Brands/Companies section, add the brands / companies to include.

    • Excluding the Following - The service is NOT available to the selected brands / companies.

      From the Excluded Brands/Companies section, add the brands / companies to exclude.

WEB-SRM: Apple iOS Settings

From the Apple iOS page of the Revenu Québec Web-SRM form, add Apple iOS version certification information:

  1. From the Apple iOS section, define the following:

    Setting

    Description

    SRS Identifier

    In the provided field, type the Product Identifier provided by Revenue Québec for the SRS (Sales Recording System) on the My Account portal.

    Maximum of 128 characters. Special characters not allowed.

    The SRS Identifier is required if at least one (1) Version Certification is added.

  2. From the Version Certifications section, add version certifications for the OS with the Revenu Québec Web-SRM service.

To add a version certification:

  1. From the upper-right of the Version Certifications section, select Add Version Certification.

  2. From the Add Version Certification window, define the following settings:

    Setting

    Description

    POS Version

    Specify the parent version of the POS application that was used for the certification.

    Identifier of SRS Version

    Specify the Identifier of the SRS Version that was used for the certification.

    Maximum of 128 characters. Special characters not allowed.

    Certification Code

    The Certification Code is provided after a successful certification.

  3. From the lower-right of the window, select Done.

WEB-SRM: Google Android

From the Google Android page of the Revenu Québec Web-SRM form, add Google Android version certification information:

  1. From the Google Android section, define the following:

    Setting

    Description

    SRS Identifier

    In the provided field, type the Product Identifier provided by Revenue Québec for the SRS (Sales Recording System) on the My Account portal.

    Maximum of 128 characters. Special characters not allowed.

    The SRS Identifier is required if at least one (1) Version Certification is added.

  2. From the Version Certifications section, add version certifications for the OS with the Revenu Québec Web-SRM service.

To add a version certification:

  1. From the upper-right of the Version Certifications section, select Add Version Certification.

  2. From the Add Version Certification window, define the following settings:

    Setting

    Description

    POS Version

    Specify the parent version of the POS application that was used for the certification.

    Identifier of SRS Version

    Specify the Identifier of the SRS Version that was used for the certification.

    Maximum of 128 characters. Special characters not allowed.

    Certification Code

    The Certification Code is provided after a successful certification.

  3. From the lower-right of the window, select Done.

WEB-SRM: Windows Settings

From the Windows page of the Revenu Québec Web-SRM form, add Windows version certification information:

  1. From the Windows section, define the following:

    Setting

    Description

    SRS Identifier

    In the provided field, type the Product Identifier provided by Revenue Québec for the SRS (Sales Recording System) on the My Account portal.

    Maximum of 128 characters. Special characters not allowed.

    The SRS Identifier is required if at least one (1) Version Certification is added.

  2. From the Version Certifications section, add version certifications for the OS with the Revenu Québec Web-SRM service.

To add a version certification:

  1. From the upper-right of the Version Certifications section, select Add Version Certification.

  2. From the Add Version Certification window, define the following settings:

    Setting

    Description

    POS Version

    Specify the parent version of the POS application that was used for the certification.

    Identifier of SRS Version

    Specify the Identifier of the SRS Version that was used for the certification.

    Maximum of 128 characters. Special characters not allowed.

    Certification Code

    The Certification Code is provided after a successful certification.

  3. From the lower-right of the window, select Done.

Identity Providers

Note

This page is only available when Enable Single Sign-On is enabled on the Admin Options page of the Companies editor.

From the Identity Providers page of the Companies editor, add identity providers for Single Sign-On (SSO) user authentication:

  1. From the upper-right of the Identity Providers page, select Add Identity Provider.

  2. From the Identity Providers window, define the following settings:

    Setting

    Description

    Name

    Identity provider name.

    ID

    Identity provider ID.

    Identity Provider Type

    From the dropdown, select the authentication protocol for the specified email domains.

    Email Domains

    Comma-delimited list of email domains that provide the identity to the Portal.

    POS Authentication Only

    Toggle Yes to restrict users on the exclusion list from accessing the Xenial Portal via a non-federated URL. The users are only permitted to login to the Ordering application.

  3. (Optional) From the User Exclusion List section, select Add Users to identify users that are excluded from Single Sign-On (SSO).

  4. From the lower-right of the Identity Provider window, select Save.

Admin Options

From the Admin Options page of the Companies editor, enable various Xenial Cloud Portal administrative options:

Option

Description

Event-Based Accounting

Toggle Yes to enable event-based accounting (if applicable).

Toggle Yes if the Suite Catering feature is used.

Events are configured through Xenial Cloud Portal and Data Management. To create or edit an event, see Events. For information about Event Types, see Event Type.

Enable Single Sign-On

Toggle Yes to enable Single Sign-On (SSO) for Xenial Cloud Portal users.

SSO streamlines the user authentication process by enabling users to login to multiple applications with one (1) set of credentials.

When enabled, the Identity Providers page is added to the Companies editor.

Opt Out MFA

Toggle Yes to disable Multi-Factor Authentication (MFA) for users logging on to the Xenial Cloud Portal.

Additional POS Themes

From the dropdown, select additional color themes that can be applied to POS terminal schemes.

The selected themes will be available for selection from the Theme dropdown on the General page of the Terminal Scheme editor.

Allow XKM Encryption

Toggle Yes to encrypt all Xenial Kitchen Management (XKM) data that is sent to the POS via WebSocket channels, and decrypt data that comes from the POS via HTTP.

Encrypting data adds another level of security to prevent unauthorized persons from accessing the data.

Toggle No to NOT encrypt Xenial Kitchen Management (XKM) data.