Admin User Guide
The following is intended for users with administrator access permissions to the 抖阴Portal.
Administrators have access to the following 抖阴Portal editors:
Editor | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
|
All Companies
鈫� 鈫� 鈫�
The All Companies homepage lists all companies in the enterprise.
 |
1 | Add a new company record. | |
2 | Search | Search for a company record. |
3 | Name | Company name. |
4 | Address | Street address for the company. |
5 | Brands | Identifies brands associated with the company. |
6 | Subscriptions | Identifies service subscriptions associated with the company. |
7 | Site Count | Number of sites in the company. |
8 | 3-Dot Menu | From the dropdown, select an action to perform on the company:
|
Add Company
鈫� 鈫�
To add a company:
From the left menu pane on the Admin homepage, select All Companies.
From the upper-right of the Company List homepage, select Add Company.
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
Define company profile settings.
Add related brands and child companies by brand (if applicable).
Enable product subscriptions.
Setup company services.
Add Identity Providers for user authentication.
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:
From the upper-right of the Brands section, select Add Brands.
From the Add Brand window, select the brand(s).
From the lower-right of the Add Brand window, select Add # Brands.
To add child companies by brand:
From the Brands page, locate the Child Companies by Brand section.
From the upper-right of the Child Companies by Brand section, select Add Child Company.
From the Add Child Company window, select the child companies.
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:
From the Subscriptions list, select the product subscription.
From the product window, toggle Enabled to Yes to enable the product subscription.
From the lower-right of the product window, select Done.
Services
From the Services page of the Companies editor, configure the company services:
From the Services homepage, select the service.
From the Edit service window, toggle Enabled to Yes to enable the service subscription.
Configure the service settings, if applicable.
From the lower-right of the services form, select Done.
Identity Providers
Nota
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:
From the upper-right of the Identity Providers page, select Add Identity Provider.
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.
Site Assignment via IDP
Determines if user site assignment is managed by the Identity Provider.
Yes - User site assignment is managed by Identity Provider
No - User site assignment is managed via 抖阴Portal.
Role Assignment via IDP
Determines if user role assignment is managed by the Identity Provider.
Yes - User role assignment is managed by Identity Provider
No - User role assignment is managed via 抖阴Portal.
User Group Assignment via IDP
Determines if user group assignment is managed by the Identity Provider.
Yes - User group assignment is managed by Identity Provider
No - User group assignment is managed via 抖阴Portal.
Email Domains
Type a comma-delimited list of email domains that provide the identity to the Portal.
POS Authentication Only
Determines if users on the exclusion list are able to access the 抖阴Portal via a non-federated URL. Add users to the exclusion list at the bottom of the Identity Providers form.
Yes - Restrict users on the exclusion list from accessing the 抖阴Portal via a non-federated URL.
The users are only permitted to login to the 抖阴Cloud POS application.
No - Users on the exclusion list are able to access the 抖阴Portal via a non-federated URL.
Enable Just In Time Provisioning
Determines if a 抖阴Portal user account is automatically created when a new user logs into the Portal for the first time.
Yes - Automatically create 抖阴Portal user account when a new user logs into the Portal for the first time.
No - New users must be manually added to the 抖阴Portal before that user is able to login.
(Optional) From the User Exclusion List section, select Add Users to identify users that are excluded from Single Sign-On (SSO).
From the lower-right of the Identity Provider window, select Save.
Admin Options
From the Admin Options page of the Companies editor, enable various 抖阴Cloud Portal administrative options:
Option | Description |
|---|---|
Event-Based Accounting | Determines if event-based accounting is used (e.g. Suite Catering). Events are configured through 抖阴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 | Determines if Single Sign-On (SSO) is enabled for 抖阴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, an Identity Providers page is added to the New Company聽editor and the Company Settings editor.
|
Opt Out MFA | Determines if Multi-Factor Authentication (MFA) is disabled for users logging on to 抖阴Cloud Portal.
|
Additional POS Themes | From the dropdown, select additional color themes that can be applied to POS terminal schemes. The selected themes are available for selection from the Theme dropdown on the General page of the Terminal Scheme editor. |
Allow XKM Encryption | Determines if 抖阴Kitchen Management (XKM) data sent to POS via WebSocket channels is encrypted. Data received from POS via HTTP is decrypted. Encrypting data adds another level of security to prevent unauthorized persons from accessing the data.
|
Generate Calendars Automatically | Determines if calendars for next year are automatically generated based on current year calendars.
|
All Sites
鈫� 鈫� 鈫�
罢丑别听All Sites聽homepage lists all sites in the company.
 |
1 | Search | Search for a site record. |
2 | Name | Site name. |
3 | Company | Company name. |
4 | Address | Street address for the company. |
5 | Subscriptions | Identifies service subscriptions associated with the site. |
6 | Actions | Select an action to perform on the site:
|
All Applications
鈫� 鈫� 鈫�
罢丑别听Applications聽homepage lists all the applications that are supported in the enterprise.
 |
1 | Name | Application name. |
2 | Code | ID code for the application. |
3 | Current release | Current release version of the application. |
4 | Actions | Select an action to perform on the application:
|
5 | Add a new application to the list. | |
6 | Page Controls | Use the provided controls to navigate the pages. |
Add Application
鈫� 鈫� 鈫�
To add an application:
From the lower-left of the Applications homepage, select Add Application.
From the General Information section of the new application form, define the following settings:
Setting
Description
Name
Type the application name.
Code
Type a unique ID code for the application.
Service
Toggle ON if the application runs as a service.
When toggled ON, the following settings are displayed:
URI - Type the Uniform Resource Identifier for the service.
Version - Type the installed version of the service.
From the Required Subscriptions section of the new application form, toggle ON the subscriptions that the application requires.
From the lower-right of the new application form, select Submit.
All People
鈫� 鈫� 鈫�
The All People homepage lists all people in the enterprise.
 |
1 | Search | Search for a person. |
2 | First Name | The person's first name. |
3 | Last Name | The person's last name. |
4 | The person's email address. Select Send invite email to send an invitation to join the 抖阴Portal. A toast notification appears when the email invitation is sent successfully. | |
5 | Roles | Identifies the roles assigned to the person. |
6 | Actions | Select an action to perform on the record:
|
7 | Add a new person to the list. | |
8 | Page Controls | Use the provided controls to navigate the pages. |
Add Person
鈫� 鈫�
To add a person:
From the lower-left of the People homepage, select +Add person.
From the Add new person form, define the follow settings:
Setting
Description
First Name
Person's first name.
Last Name
Person's last name.
Email
Person's email address.
Preferred Language
From the dropdown, select the preferred language for the system text.
Roles
From the dropdown, select the 抖阴Cloud Portal roles to assign to the person.
抖阴Cloud Portal roles can only be assigned to people with internal email domains.
Documentation Access
Toggle API Documentation Access to Yes to allow the person access to the 抖阴Cloud API documentation.
Before enabling this permission, a Developer Agreement and an NDA (Non-Disclosure Agreement) both signed by the individual must first be provided to Xenial.
Enabling this permission without the required documentation may result in disciplinary action.
From the lower-left, select Save as New to create the user without closing the Add new person form.
-OR-
From the lower-right, select Create to create the user and close the Add new person form.
All Roles
鈫� 鈫� 鈫�
A "role" is a collection of access and editing permissions for the 抖阴Cloud Portal, Data Management and 抖阴Cloud applications. The relationship between a user and a company, or between a user and a site, is defined by the assigned role of the user.
From Roles management homepage, create new user roles and edit existing roles, including the access permissions for each application.
 |
From the Select Role dropdown, select a role to edit its permissions.
-OR-
Select Create Role to create a new role.
Edit Role
鈫� 鈫� 鈫�
When an existing role is selected from聽the Roles management聽homepage, its defined permissions are listed. The following provides an overview of the Roles Management screen:
 |
1 | Select Role | Identifies the currently selected role. From the dropdown, select a role to edit its permissions. |
2 | Copy Role | Copy the defined permissions for the current role, and create a new role with the same permissions. When prompted, type a name for the new role. |
3 | Save Permissions | Save the defined permissions for the role. |
4 | Create a new role. | |
5 | Delete Role | Delete the current role. If the role is assigned to one or more people, the role cannot be deleted. |
6 | Permissions Search | In the provided field, type a permission name to search for the permission. |
7 | Enable / Disable Permissions | From the dropdown:
|
8 | Permissions | Select the application name header to expand/collapse the permissions for the application. |
9 | Enable/Disable All | Use the provided toggle to enable / disable all permissions for the application. This toggle is not available for all applications. |
Create Role
鈫� 鈫� 鈫�
From the Roles management homepage, select Create Role. The following provides an overview of the Roles Management screen:
 |
1 | Role Name | Type a name for the role. Select Cancel to cancel the operation. |
2 | Save Role | Save the defined permissions for the role. |
3 | Permissions Search | In the provided field, type a permission name to search for the permission. |
4 | Enable / Disable Permissions | From the dropdown:
|
5 | Permissions | Select the application name header to expand/collapse the permissions for the application. |
6 | Enable/Disable All | Use the provided toggle to enable / disable all permissions for the application. This toggle is not available for all applications. |
All Brands
鈫� 鈫� 鈫�
The All Brands homepage lists all product brands in the enterprise.
 |
1 | Add a new brand record to the list. | |
2 | Search | Search for a brand record. |
3 | Name | Brand name. |
4 | ID | ID code for the brand. |
5 | Description | Description of the brand. |
6 | 3-Dot Menu | From the dropdown, select an action to perform on the brand:
|
Add Brand
鈫� 鈫� 鈫�
To add a brand:
From the upper-right of the Brands homepage, select Add Brand.
From the General section, define the following settings:
Setting
Description
Brand Name
Brand name.
ID
ID code for the brand.
Description
Description of the brand.
All Integrators
鈫� 鈫� 鈫�
The All Integrators homepage lists all the integrators and their target companies. Access the integrator keys for a target company.
 |
1 | Integrator Search | Search for an integrator record. |
2 | Integrator Company | Name of the integrator's company. |
3 | Target Company | Name of the company that is targeted for integration. |
4 | Name | Name of the integrator. |
5 | Created |
|
6 | Keys Last Changed |
|
7 | Last Accessed | Date / time when the keys were last accessed. |
8 | Active Keys | Specifies the number of active keys associated with the integrator. |
9 | Add a new integrator record. | |
10 | Page Controls | Use the provided controls to navigate the pages. |
Add Integrator
鈫� 鈫� 鈫�
To add a new integrator record:
From the lower-left of the All Integrators homepage, select Add Integrator.
From the Create Integrator page, define the following settings:
Setting
Description
Name
Type the integrator name.
Description
Type a description of the integrator.
Middleware / External Company
Type the external company name. Select the company name from the list of suggestions.
Leave this field blank when creating an integrator key for a 抖阴Service.
Client Company
Type the client company name. Select the company from the list of suggested names.
Leave this field blank when creating a wildcard key that provides access to all 抖阴clients.
From the lower-right of the page, select Create.
All Services
鈫� 鈫� 鈫�
The All Services homepage lists all the services that are supported in the enterprise.
 |
1 | Service Name | Service name. |
2 | Type | Specifies if the service is recognized as a Service or Subscription. |
3 | Description | Description of the service. |
4 | Available by | Specifies if availability of the service is restricted to specific companies or brands. |
5 | Companies | Specifies the number of companies where the service is added. |
6 | 3-Dot Menu | From the dropdown, select an action to perform on the service:
|
Edit Service
鈫� 鈫� 鈫�
To edit a service:
From the All Services homepage, locate the service.
From the 3-dot menu on the row of the service, select Edit.
From the General section, define the following settings:
Setting
Description
Name
Service name.
Description
Description of the service.
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.