Oracle® Hospitality Simphony Client Deployment Guide
Oracle® Hospitality Simphony Client Deployment Guide
Oracle® Hospitality Simphony Client Deployment Guide
Release 18.2
F11597-06
May 2021
Oracle Hospitality Simphony Client Deployment Guide, Release 18.2
F11597-06
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed or activated on delivered hardware, and modifications of such programs)
and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government
end users are "commercial computer software" or "commercial computer software documentation" pursuant
to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works,
and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs
embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle
computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the
license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud
services are defined by the applicable contract for such services. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc,
and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not
be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Preface
2 CAL Packages
Configuring CAL Packages 2-4
CAL Directories and Package Contents 2-4
Viewing, Reloading, and Saving CAL Package Contents 2-4
Changing a CAL Package Version 2-5
Changing a Custom CAL Package 2-5
iii
Simphony 18.2.2 Deployment 3-10
CAL Deployment Order 3-10
Manually Deploying CAL Packages 3-11
Adding a Deployment Schedule for One CAL Package 3-12
Adding a Deployment Schedule for a Group of CAL Packages 3-13
Configuring the Deployment Schedule to Install the Simphony Client on
Workstations 3-15
Viewing CAL Package Deployment Schedules 3-15
Viewing the CAL Package Download Status 3-16
Scheduling and Viewing Device Information 3-20
Device Information Needs Attention State 3-21
4 CAL Authentication
Automatic Authentication 4-1
7 CAL on Workstations
Allowing Employees to Install and Authenticate POS Clients and Service Hosts 7-1
CAL Installation Prerequisites for Microsoft Windows Devices 7-1
Adding a Workstation 7-2
Assigning Default Touchscreen Pages 7-4
Installing the CAL Client on a Microsoft Windows Device 7-4
Updating CAL Client Workstations 7-4
POS Clients Running Android Mobile Operating System 7-4
Allowing Employees to Access the CAL Admin Page on Android Devices 7-5
Installing CAL on the Android Device 7-5
Installing the Simphony Service Host on an Android Device 7-15
Configuring the Service Host for CAPS Running as a Service on a Client 7-17
iv
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-
Only Workstation) 7-18
Configuring the Deployment Schedule to Install the Simphony Client on
Workstations 7-18
Installing the Simphony Client on a Workstation without the POS Interface 7-19
8 Pre-Upgrade Checklist
9 Post-Upgrade Checklist
v
Preface
Preface
Oracle Hospitality Simphony is a cloud-based Point-of-Sale (POS) solution that
provides business management capabilities using a single tool with vast integration
capabilities to property management systems, paperless kitchen display systems,
credit card interfaces, and reporting applications.
Purpose
This Simphony Client Deployment Guide provides instructions to deploy clients for
Simphony release 18.2.
Audience
This document is intended for system administrators of Oracle Hospitality Simphony
release 18.2.
Customer Support
To contact Oracle Customer Support, access My Oracle Support at the following URL:
https://support.oracle.com
When contacting Customer Support, please provide the following:
• Product version and program/module name
• Functional and technical description of the problem (include business impact)
• Detailed step-by-step instructions to re-create
• Exact error message received and any associated log files
• Screen shots of each step you take
Documentation
Oracle Hospitality product documentation is available on the Oracle Help Center at
https://docs.oracle.com/en/industries/food-beverage/pos.html.
Simphony eLearning
The Simphony Learning Subscription provides additional product knowledge through
interactive training, guided video tours, and helpful knowledge checks. After exploring
the documentation library, use your Oracle Single Sign On to check out the Simphony
learning opportunities at Hospitality Learning Subscriptions.
Revision History
vi
Preface
vii
1
Client Application Loader (CAL)
The Client Application Loader (CAL) allows seamless distribution, installation, and
maintenance of Simphony software from a CAL server to all Simphony client
workstations and service hosts. The CAL stores software packages in the transaction
database, providing a central storage location. The CAL enables clients to:
• Obtain a list of configured workstations from the CAL servers.
• Establish unique workstation IDs and network configuration (either Dynamic Host
Configuration Protocol (DHCP) or static Internet Protocol (IP) based on the
information received from the CAL server).
See the following topics for more information about CAL and Distributed CAL (DCAL).
1-1
Chapter 1
Planning and Considerations
• Verify access to the Enterprise Management Console (EMC): Use the EMC to
complete the initial steps required to start the installation process. Verify that you
can access EMC as well as the CAL Packages modules within EMC.
• Verify employee privilege to download and install updates: A property user
(employee) needs to have the authority to download, install, and authenticate
clients and service hosts using the CAL. Identify this employee and verify that the
role assigned to them in the EMC has Miscellaneous option 10065 enabled. See
Allowing Employees to Install and Authenticate POS Clients and Service Hosts for
details
• Verify Simphony Enterprise certificate from the workstations: A secure (TLS
1.2) connection to the Enterprise is required when installing or upgrading the
Simphony client to release 2.9.1 or later. Verify that the workstations can establish
a secure connection with the Enterprise before the installation. Enterprise
Certificate Verification contains more information.
• Document your Simphony server name and your Check and Posting Service
(CAPS) client: When you log in to EMC, write down the server name used with
your login credentials. If you do not know which client is your CAPS client, log in
to EMC, click the Setup tab, select the Property Parameters module, and then
click the Workstations tab. Write down the name of the CAPS client service host.
Using the CAPS service host name, locate the physical CAPS client machine at
your property and make note of its location.
• Verify software versions on the workstations: After the installation completes,
ensure that all workstations are on the same release of the Simphony client
software before performing any transactions.
• Test normal operations: Set aside time to test normal operations after the
installation completes. Make a checklist of all critical business functions to test
so that you can verify that they are working post installation.
1-2
Chapter 1
CAL / DCAL Infrastructure and Terminology
Deployment Schedules are the configuration settings defined at the Enterprise and
used to deploy packages to CAL or DCAL clients. You can create deployments for the
entire Enterprise, specific properties, and individual service host clients. Deployments
can also be scheduled for immediate or future delivery.
DCAL Download Schedules are the configuration settings defined at the Enterprise
that specify which CAL packages are delivered and stored on the DCAL workstation.
DCAL Workstation is the workstation at the property designated as the local CAL
server. DCAL Download Schedules are used by this workstation to determine which
packages should be downloaded from the Enterprise. Deployment Schedules are used
by this workstation to determine which downloaded CAL packages should be made
available to DCAL clients.
DCAL Client is the workstation at the property that receives CAL packages from the
DCAL workstation. DCAL clients still use the CAL client application, but the CAL client
is configured to communicate with the DCAL workstation rather than the Enterprise.
CAL Client is the application component responsible for installing CAL packages.
Typically, the CAL client communicates with the Enterprise application server unless a
DCAL workstation exists on the property.
1-3
Chapter 1
Configuring CAL Package Permissions
privilege and a valid EMC username and password, a user cannot authenticate a client
and load Simphony applications through CAL. To configure the privilege in the EMC:
1. Select the Enterprise level, click Configuration, and then click Roles.
2. Identify existing roles or add new roles for employees that need to have this
privilege.
3. Double-click the roles record assigned to the soon-to-be privileged user.
4. Click the Operations tab, and then click the Miscellaneous subtab.
5. In the Miscellaneous Options section, select 10065 - Download Software, Install
and Authenticate Clients and Service Hosts Using CAL, and then click Save.
6. Repeat these steps for each role as needed.
Security Considerations
Each organization has a unique security policy in place, which could affect the
software upgrade process. Security policies that restrict or block access to resources
required by Oracle software can cause the upgrade to fail completely or prevent the
upgrade from completing without manual user intervention.
Account Privileges
• Local machine administrative privileges are required. In domain environments,
ensure that the domain user has local administrative privileges until the upgrade is
complete. This is minimally required for the initial setup of the workstation.
1-4
Chapter 1
Security Considerations
1-5
Chapter 1
Resizing the Initial Workstation Database
1-6
Chapter 1
Resizing the Initial Workstation Database
Field Description
Initial Size Enter the initial size of the database
file. Define the size with a number
followed by M, G, or T suffixes to indicate
megabytes, gigabytes, or terabytes.
Maximum Size (AutoGrow mode only) Enter the maximum size to which the
database can grow. If there is not enough
unreserved space to fit the maximum
size, the configuration does not validate.
The NonDB Percentage value you
entered determines how much of the
free space is not available for the
databases.
1-7
Chapter 1
Changing the DCAL Server Location
Table 1-2 (Cont.) Data File and Log File Database Configuration
Field Description
Auto Grow Floor (AutoGrow mode only) Enter the size of the free space within
the database that triggers a nightly grow
event. If you set this value to 10M
and the free space inside the data file
goes below 10M, the nightly resize job
attempts to resize the database.
Auto Grow Increment (AutoGrow mode Enter the auto growth increment for
only) the database. This value is used by the
nightly resize job when the database
must grow.
1-8
2
CAL Packages
CAL packages are a method of distributing software to the clients through an
installation script. Rather than having to manually install software on a workstation,
a CAL package automates this process over the network. This increases the efficiency
of deploying and upgrading client software on the workstation. You can configure the
packages to be distributed to:
• All devices in the Enterprise
• Devices in selected properties
• Specific devices
Each customer has specific needs to deploy to the Enterprise, property, or specific
devices. If you are unsure, the safer route is to deploy the CAL packages to the
specific devices or property you plan to upgrade.
A typical Simphony installation has a set of pre-defined CAL packages available
for deployment. This document provides the basic steps required to complete a
successful upgrade. Additional package deployments could be required for custom
applications or other features not explicitly reviewed.
A Simphony POS client requires the following basic packages at a minimum. This
document focuses on these packages.
• CAL Client
• Service Host Prerequisites (Only with Simphony releases 18.2 and 18.2.1) OR
Service Host Download (Only with Simphony release 18.2.2)
• Service Host
2-1
Chapter 2
2-2
Chapter 2
2-3
Chapter 2
Configuring CAL Packages
do not need to change deployment schedules from Install to Skip. The installer
preserves CAL packages and adds new release versions.
Command Description
Switch View Change the grouping of CAL packages from name to
version and vice versa. For example, you can view
packages belonging only to Simphony release 18.1.
Add Custom CAL Package Upload a CAL package from a local file system to the
EMC and database. Uploaded packages appear in the
Custom subgroup.
Refresh Refresh the entire page.
Delete Delete the highlighted CAL package.
2-4
Chapter 2
Changing a CAL Package Version
3. From the Files list, select a platform to see all files included in the package.
• To open the file in Notepad, click View Selected File.
• To reload the entire CAL package for all platforms and files from the specified
file location, click Reload Package From Disk. You must be signed on with
the same hierarchy level as the CAL package to see this command.
After you modify an existing default or custom package, reload the package.
Ensure that the Setup.dat version matches the file before it loads to avoid
reloading the package on all POS clients.
After installation and when the load balanced address changes, replace the
local machine with the load balanced address in SimphonyInstall.xml, and
then reload the entire package.
• To save the entire CAL package for all platforms and files to the specified file
location, click Save Package To Disk, select an empty output folder, and then
click OK.
2-5
Chapter 2
Changing a Custom CAL Package
• Platform Type: Select the type of platform to receive the CAL package.
4. In the Limit To Services section, select specific Service Host types to deploy to
workstations.
• If you do not select a service, the package deploys to every Service Host
based on the deployment schedule.
• If you select one or more services, the package deploys only to Service Hosts
that run selected services. That is, when you configure a new service for
the existing Service Host, there is no additional deployment for the Service
Host. If a CAL package exists that is specific to the service, the Service Host
downloads it immediately.
For example, if you select Cash Management, you must also select the Check
And Posting service (CAPS) because the Enterprise Cash Management
(ECM) module only runs on CAPS Service Hosts. This causes all Service
Hosts that run CAPS to automatically download the ECM CAL package if a
deployment schedule exists for the Enterprise or property.
2-6
3
CAL Package Deployment
See the appropriate Simphony release for more information about deploying CAL
packages:
• Simphony 18.2 and 18.2.1 Deployment
• Simphony 18.2.2 Deployment
3-1
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
3-2
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
• Deployment Type
4. Select the Property or Service Host (depending on the Deployment Type).
5. In the Action to Take field, select 0 - Install.
6. Click Save. The CAL package downloads to the appropriate POS client
workstations.
Note:
The date and time selected in Effective From and Effective To fields
are determined by the application server’s time zone, not by the property
or workstation time zone.
10. (Optional) In the Effective To field, select the date when the CAL packages
automatically stop installing, and select the stop time (in 24-hour format).
To keep the installations perpetual, do not set an Effective To time.
11. Click Save.
3-3
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
Note:
The date and time selected in Effective From and Effective To fields
are determined by the application server’s time zone, not by the property
or workstation time zone.
3-4
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
11. (Optional) In the Effective To field, select the date when the CAL packages
automatically stop installing, and select the stop time (in 24-hour format).
To keep the installations perpetual, do not set an Effective To time.
12. Click Save.
3-5
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
3-6
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
3-7
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
b. To limit the Service Hosts shown in the middle pane, select the filters for
Status (All, No Issues, Need Attention), Name, Software Version, and CAL
Version.
c. Click a Service Host to change the view in the right pane.
d. To expand and collapse the views in the right pane, click the individual green
triangle icons, or click the Expand/Collapse All link in the upper right corner.
3-8
Chapter 3
Simphony 18.2 and 18.2.1 Deployment
3-9
Chapter 3
Simphony 18.2.2 Deployment
3-10
Chapter 3
Simphony 18.2.2 Deployment
3-11
Chapter 3
Simphony 18.2.2 Deployment
• Deployment Type
4. Select the Property or Service Host (depending on the Deployment Type).
5. In the Action to Take field, select 0 - Install.
6. Click Save. The CAL package downloads to the appropriate POS client
workstations.
3-12
Chapter 3
Simphony 18.2.2 Deployment
You can configure multiple deployment schedules for the same CAL package.
Simphony uses the most granular deployment when given multiple deployment
schedules. For example, if you configure a deployment schedule for a workstation
and for the property, Simphony uses the workstation deployment. If you configure
a CAL package deployment for a property with 0 - Install and a deployment for a
workstation with 1 - Skip, the CAL package is not installed on the workstation.
9. (Optional) In the Effective From field, select the start date when the CAL
packages automatically stop installing, and select the stop time (in 24-hour
format).
You can use this field to schedule Simphony upgrades.
Note:
The date and time selected in Effective From and Effective To fields
are determined by the application server’s time zone, not by the property
or workstation time zone.
10. (Optional) In the Effective To field, select the date when the CAL packages
automatically stop installing, and select the stop time (in 24-hour format).
To keep the installations perpetual, do not set an Effective To time.
11. Click Save.
3-13
Chapter 3
Simphony 18.2.2 Deployment
The list of available CAL packages in the dialog changes depending on the node
highlighted within the tree. For example, if you highlight the Simphony node, the
list of packages contains all Simphony CAL packages. If you select the Service
Host node, the list contains only the Service Host packages.
6. From the Deployment Type drop-down list, select the type of deployment:
• 1 - Property/Enterprise
• 2 - Specific Service Host
Simphony release 18.2.2 does not require Service Host Prerequisites. If a
Service Host Prerequisites deployment is shown for an earlier release, remove
the Service Host Prerequisites from the deployment schedule. Set the Service
Host Download for 18.2.2 instead.
The Service Host Download is required in Simphony 18.2.2. When scheduled
independently of the CAL client package, the Service Host Download occurs
silently in the background to avoid end user interruption. If you schedule the
CAL client package and the Service Host Download package to run at the
same time, the Service Host Download does not run in the background. You
can schedule the Service Host Download file transfer to begin in the early
morning hours during non-peak business times (for example, 2:00 a.m.).
7. Click the ellipsis point (...) button.
8. From the Select Properties or Select Service Host dialog (depending on your
selection in Step 6), select one or more workstations or service hosts where the
package downloads, and then click OK.
• Filter lengthy lists by property number or name, or by workstation number or
name.
• If you selected 1 - Property/Enterprise in Step 6, select Show already
configured properties to prevent yourself from configuring duplicate
deployment schedule records.
• If you selected 2 - Specific Service Host in Step 6, press and hold the Ctrl
key while performing a left mouse click to select multiple service hosts. You
can click the Select All or Clear All links to affect all service hosts in the list.
• You can select multiple service hosts or specific workstations.
9. In the Action To Take field, select one of the following options:
• To allow the deployment to proceed, select 0 - Install.
• To prevent a package from being downloaded, select 1 - Skip.
10. (Optional) In the Effective From field, select the start date when the CAL
packages automatically begin installing, and select the start time (in 24-hour
format).
You can use this field to schedule Simphony upgrades.
Note:
The date and time selected in Effective From and Effective To fields
are determined by the application server’s time zone, not by the property
or workstation time zone.
3-14
Chapter 3
Simphony 18.2.2 Deployment
11. (Optional) In the Effective To field, select the date when the CAL packages
automatically stop installing, and select the stop time (in 24-hour format).
To keep the installations perpetual, do not set an Effective To time.
12. Click Save.
3-15
Chapter 3
Simphony 18.2.2 Deployment
3-16
Chapter 3
Simphony 18.2.2 Deployment
3-17
Chapter 3
Simphony 18.2.2 Deployment
4. To limit the Enterprise View to specific installation statuses, enter text in the Filter
field in the lower area of the screen.
5. To expand and collapse the Enterprise View, select the Expand and Collapse
links in the lower area of the screen. The Enterprise View is collapsed by default.
6. To view detailed status information in Enterprise View, highlight a property or
device in the left pane. The Install Status tab shows the latest status for each
device’s corresponding CAL packages. The following information is available:
3-18
Chapter 3
Simphony 18.2.2 Deployment
a. In the Install Date, From, and To fields (upper right area), select the check
box, and then select the date range of the CAL deployment to search.
Use the From and To fields if you are searching for an older package or need
a specific date range.
To view the latest status, ensure that Latest is checked.
3-19
Chapter 3
Simphony 18.2.2 Deployment
3-20
Chapter 3
Simphony 18.2.2 Deployment
b. To limit the Service Hosts shown in the middle pane, select the filters for
Status (All, No Issues, Need Attention), Name, Software Version, and CAL
Version.
c. Click a Service Host to change the view in the right pane.
d. To expand and collapse the views in the right pane, click the individual green
triangle icons, or click the Expand/Collapse All link in the upper right corner.
3-21
Chapter 3
Simphony 18.2.2 Deployment
3-22
Chapter 3
Simphony 18.2.2 Deployment
3-23
4
CAL Authentication
CAL authentication over TLS 1.2 is required for clients upgrading from any release
prior to Simphony release 2.9.1. CAL authentication was introduced in Simphony
release 2.9.1 to prevent unauthorized users from downloading or reinstalling CAL
packages onto the workstations.
Automatic Authentication
CAL clients must be authenticated to communicate with a Simphony release 2.9.1
or later enterprise. To facilitate automated upgrades from releases prior to Simphony
release 2.9.1, the CAL client automatically authenticates itself on upgrades using the
existing authenticated Simphony client. This capability relies on several factors:
• The Simphony Enterprise must have a properly configured secure HTTPS
endpoint and CAL clients must be able to negotiate an HTTPS connection with
the Enterprise. Enterprise Certificate Verification contains more information on
verifying the Enterprise URL. The Device Information module in the EMC identifies
issues that may prevent the client from upgrading. Scheduling and Viewing Device
Information contains more information.
• CAL client upgrades must be deployed from the Simphony application server
before other CAL packages.
• The existing Simphony client installation must have the workstation (POS client)
and/or CAPS Services configured and authenticated prior to deploying a new CAL
client.
Devices that do not have the workstation (POS client) or CAPS Services configured,
such as KDS Displays or KDS Controllers, cannot use the Automatic Authentication
feature. Additionally, devices without touchscreens need a keyboard or mouse
connected to the device to enter EMC credentials.
4-1
5
Enterprise Certificate Verification
Review the following information about enterprise certificate verification.
5-1
Chapter 5
Testing the Enterprise Certificate
5-2
6
Distributed CAL (DCAL)
When new client applications or support files are available, the CAL sends the new
set of files from the Enterprise application server to the clients. A standard Simphony
Service Host CAL package is usually about 50 megabytes (MB) in size. Based on
that, a property with 100 workstation clients needs to download 5000 MB of data
through the Wide Area Network (WAN). When the network bandwidth of a property
cannot support simultaneous requests made by numerous clients, properties might
experience bandwidth bottlenecks.
To alleviate bandwidth problems, the Distributed CAL feature lets you configure one
or more Service Hosts above or within a property as a DCAL server. To distribute
CAL packages, the DCAL server uses the Local Area Network (LAN), which has a
higher bandwidth and a higher data transfer rate than a WAN. Updated files and new
packages are downloaded to the DCAL server, and then workstations retrieve the
updated files from the DCAL server over the LAN.
You can also use DCAL to distribute packages to workstations when a property loses
connectivity to the Enterprise application server. After deploying CAL packages to the
DCAL server, clients can use the DCAL server to get the new CAL packages without
relying on connectivity to the Enterprise application server.
See the related topics listed here for more information about DCAL.
6-1
Chapter 6
Configuring the Distributed CAL (DCAL) Server
6-2
Chapter 6
Viewing the DCAL File Download Status
CAL Package contains more information about scheduling CAL packages to deploy at
preset times.
6-3
7
CAL on Workstations
Review the topics listed below for information about using CAL on workstations.
7-1
Chapter 7
CAL Installation Prerequisites for Microsoft Windows Devices
and Authenticate POS Clients and Service Hosts contains more information on
assigning the privilege.
• Set the CAL deployment schedule. Configuring the Deployment Schedule to Install
CAL on Workstations contains information on deploying CAL packages.
• Set the default sign in and transaction pages. Assigning Default Touchscreen
Pages contains more information.
Adding a Workstation
1. Select the property, click Setup, and then click Workstations.
2. Insert a record for the workstation, enter the name, and then click OK.
3. Double-click the new workstation record.
4. On the General tab, enter information in the following fields:
Field Description
Type Select the type of workstation from the drop-down list:
• 1 - Mobile MICROS: Mobile devices
• 2 - Workstation Client: Workstations, virtual
machines, and Android tablets
Select this option for the Oracle MICROS
Workstation 6 Series and the Oracle MICROS
Tablet 700 Series.
• 3 - POSAPI Client: Simphony Transaction Services
• 6 - MICROS Tablet Client: Oracle MICROS Tablet
E-Series
Select this option for the Oracle MICROS Tablet
E-Series 11-inch.
Language Select the default language of the workstation. This is
the language that appears on the workstation’s Sign
On screen. If an employee has a different default
language set, the employee sees their default language
after signing in to the workstation.
Resolution Cols Enter the number of Resolution Columns for the
workstation’s display. The default value is 0 (zero).
Resolution Rows Enter the number of Resolution Rows for the
workstation’s display. The default value is 0 (zero).
Log Verbosity Select the logging verbosity for the workstation. Select
0 (zero) for minimal logging. Higher log verbosity
provides more information in the log file, which might
be helpful to you in troubleshooting issues.
(Optional) Workstation Select a Workstation Class to allow similar
Class workstations to be grouped together and to share
certain page configuration settings.
Database Update Frequency Enter the number of seconds for the workstation to
receive changes. The default value is 1800 seconds (30
minutes).
The value in this field overrides the Property
Parameter’s Database Update Frequency setting.
7-2
Chapter 7
CAL Installation Prerequisites for Microsoft Windows Devices
Field Description
Check Inactivity Timeout Enter the number of seconds before the workstation
shows the message (Do you need more time?),
prompting the workstation operator to cancel the
transaction. When you enter 0 (zero), the message
does not appear.
When you select Enable Follow Me from the
RVC Parameters module, the check is automatically
suspended rather than canceled.
Check Inactivity Dialog Enter the number of seconds that the workstation
Timeout shows the Inactivity dialog before automatically
canceling the transaction. This field is unavailable
when you set the Check Inactivity Timeout value to 0
(zero).
Report Timeout Enter the number of seconds the workstation waits for
a response before showing a communication failure
notice.
Address / Host Name Enter the IP address or host name of the Oracle
Hospitality Simphony Service Host where the
workstation application runs.
Subnet Mask Enter the subnet mask of the Service Host where the
workstation application runs.
Default Gateway Enter the default gateway of the Service Host where
the workstation application runs.
Is Connectionless Select this option to have the Service Host open and
close a new connection for each web service call. This
prevents the workstation from reaching the maximum
number of web connections allowed, although the
connection becomes slightly slower.
Is Windows Service Select this option to allow the Service Host to start
as a Windows service. The Service Host service starts
on Microsoft Windows startup with other Microsoft
Windows services. The POS client starts only when the
workstation operator signs on to the operating system.
If you select this option, you need to change the
ports of the services being run (for example, Check
and Posting Service (CAPS) and Oracle Hospitality
Simphony Kitchen Display System (KDS) Controller) in
addition to the POS client. Use the EMC modules to
change the ports.
If a non-POS client is required to run on the Service
Host, it must run on a different port than the
workstation port.
You can also set the Service Host to run as a Microsoft
Windows service from the Service Host module
(rather than from the Workstations module). If you
set this option in the Service Host module, you do not
need to change the ports of the services being run as
the device is not intended to run the POS client.
7-3
Chapter 7
Installing the CAL Client on a Microsoft Windows Device
7. Click Save.
7-4
Chapter 7
Allowing Employees to Access the CAL Admin Page on Android Devices
The UI is the same on all devices and workstations. Android devices have special
requirements to consider, including deployment method, configuration requirements,
and the procurement process.
7-5
Chapter 7
Installing CAL on the Android Device
If you are using an Android device with the pre-installed Chrome browser, the
SWP home page may not show the menu options in portrait view. To work
around this issue:
i. Go to the SWP at: https://<ServerName>:<Port>/SimphonyApp/
Download/AndroidCAL.
ii. Log in if prompted, and then download the CAL setup.apk file on the
Android device.
d. Select Client Application Loader (CAL) - Android from the Download Type
drop-down list, and then click the Download button.
7-6
Chapter 7
Installing CAL on the Android Device
7-7
Chapter 7
Installing CAL on the Android Device
j. CAL starts automatically and then the device shows the CAL home page.
k. Tap the CAL desktop icon.
See Installing the Simphony Service Host on an Android Device for more
information on installing or upgrading the Service Host on an Android device.
2. To initiate CAL configuration on an Android device:
a. Tap the CAL shortcut from the Home screen, and then tap Configure CAL.
7-8
Chapter 7
Installing CAL on the Android Device
b. Enter the correct code based on the six-digit number shown at the top, and
then tap Next.
Step 3 in Changing the CAL URL contains information about the code.
c. Enter the Enterprise server URL, and then configure the server settings as
follows:
7-9
Chapter 7
Installing CAL on the Android Device
7-10
Chapter 7
Installing CAL on the Android Device
h. Tap the correct workstation for the device to populate the workstation
information and tap Save.
7-11
Chapter 7
Installing CAL on the Android Device
If you have not scheduled and deployed the Android ServiceHost CAL
package, you see this screen:
7-12
Chapter 7
Installing CAL on the Android Device
j. Once the CAL package download completes, you are prompted to install the
Simphony application. Tap Install.
7-13
Chapter 7
Installing CAL on the Android Device
k. When the installation of the Simphony application is complete, tap Done. The
installation generates a Simphony desktop icon on the device’s CAL home
screen.
7-14
Chapter 7
Installing the Simphony Service Host on an Android Device
If you tap Open, you are required to manually configure your Android
ServiceHost again.
l. As previously stated, Android devices (Android version 5.0 and later) and
Simphony requires you to ensure that data encryption and a lock mechanism
is enabled on the device. If no such locking mechanism (PIN) has been
configured, you receive this prompt message:
Tap OK to continue.
m. Enter your Simphony EMC User Name, and then press OK.
7-15
Chapter 7
Installing the Simphony Service Host on an Android Device
and Authenticate POS Clients and Service Hosts for information about configuring the
privileges.
When working with Android devices (Android version 5.0 and later), Simphony
requires you to ensure that data encryption and a lock mechanism is enabled on the
device that prevents unauthorized people from accessing it. To protect your Android
device, configure a Personal Identification Number (PIN) by accessing the device’s
Settings, select Security, and then select Encrypt Device. This requires users to
provide a PIN before they can start the Android ServiceHost (POS Client).
If you are using an earlier Simphony release (prior to 18.2), follow steps 1 through 4.
1. Tap Install.
2. Tap Open.
3. Enter your Simphony EMC User Name, and then tap OK.
4. Enter your Simphony EMC Password, and then tap OK.
The following page appears:
7-16
Chapter 7
Installing the Simphony Service Host on an Android Device
Note:
If you are performing a fresh installation of the Android ServiceHost,
select the Done button. Do not select the Open button. Wait for Android
CAL to open the ServiceHost (approximately five seconds). If you
accidentally press the wrong button in error, ServiceHost prompts you
to manually configure the device with the page shown in the Android
CAL ServiceHost Manual Setup figure.
7-17
Chapter 7
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-Only Workstation)
2. To configure the Service Host for a hosted Enterprise with Simphony Premium
Cloud Service users:
a. Select the Enterprise level, click Setup, and then click Service Hosts.
b. Insert a new Service Host record, and then double-click it to open in form view.
c. In the Host Name field, enter the host name of the remote server where CAPS
will be configured.
d. Enter the Subnet Mask and the Default Gateway of the remote server.
e. If you are configuring CAPS as a Windows Service, select Is Windows
Service. Otherwise, skip this step.
f. Click Save.
3. Select the property, click Setup, and then click Property Parameters.
4. Click the Workstations tab.
5. From the Service Hosts section, select the CAPS Service Host created in Step 1
or 2, and then enter the Port number for CAPS configuration.
This Port is the unused port number and is different from the EGateway service
port.
6. Click Save.
7-18
Chapter 7
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-Only Workstation)
When using Distributed CAL (DCAL), you must add both the major version and the
hotfix to the DCAL download schedule. After the download occurs, it is made available
in the DCAL server. Then you can schedule the POS client update.
1. Select the Enterprise, click Setup, and then click CAL Packages.
2. If you are using Simphony 18.2 or 18.2.1, select Service Host Prereqs from the
left pane.
If you are using Simphony 18.2.2, skip this step. You need to deploy the CAL
Client and then the Service Host Download. Oracle recommends that you
schedule the CAL Client and the Service Host Download separately at different
dates or times. When scheduled independently of the CAL client package, the
Service Host Download occurs silently in the background to avoid end user
interruption. If you schedule the CAL client package and the Service Host
Download package to run at the same time, the Service Host Download does
not run in the background.
3. Click the Deployment Schedule tab, and then click Add Deployment.
4. In the Choose CAL package to upload dialog, select 2 - Specific Service Host as
the Deployment Type, click the ellipsis (...) point button adjacent to the drop-down
list, select the appropriate workstation, and then click OK.
5. Click OK to close the Choose CAL package to upload dialog.
6. In the Action To Take column, select 0 - Install, and then click Save.
7. Select CAL Client from the left pane, and then repeat Steps 4 through 7.
8. (Simphony 18.2.2 only) Select Service Host Download from the left pane, and
then repeat Steps 4 through 7.
9. Select Service Host from the left pane, and then repeat Steps 4 through 7.
7-19
Chapter 7
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-Only Workstation)
7-20
Chapter 7
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-Only Workstation)
10. If you are using Simphony release 2.9 or Simphony release 2.9.2, after the CAL
process completes:
a. Browse to [Drive letter]:\\MICROS\Simphony\webserver, and then click
AuthenticationServer.
b. For Simphony release 2.9, enter the following details in the Authentication
Server application:
• Client Service ID: Enter the Service ID for Check and Posting. You can
find the Service ID in the Workstations tab of the Property Parameters
module.
• Installer Username: Enter the Install User Security Username
configured in the Security tab of the Property Parameters module. Contact
your system administrator for assistance.
• Installer Password: Enter the Install User Security Password
configured in the Security tab of the Property Parameters module. Contact
your system administrator for assistance.
7-21
Chapter 7
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-Only Workstation)
c. For Simphony release 2.9.2 and later, enter the following details in the
Authentication Server application:
• Service Host ID: The service host ID. This value is automatically
populated.
• EMC Username: Enter your EMC user name.
• EMC Password: Enter your EMC password.
7-22
Chapter 7
CAL Installation Prerequisites for a Workstation Without the POS Interface (CAPS-Only Workstation)
d. Click Authenticate.
e. Restart the workstation.
7-23
8
Pre-Upgrade Checklist
(Optional) Print this page to help plan and prepare for upgrading.
For complete details, see Planning and Considerations.
Pre-Upgrade Checklist:
• Verify Supported Technology and Devices
• Verify Security Policy Compatibility
• Verify adequate disk space exists on the workstations
• Verify all checks have been closed and replayed
• Launch to test environment
• Prepare for and schedule downtime
• Check the network constraints on the day of the install
• Verify latest Microsoft Windows and SQL Express updates are installed
• Verify the CAL Package deployment schedule expiration date
• Verify access to your Enterprise Management Console (EMC)
• Verify Employee Privilege to download and install updates
• Write down your Simphony server name
• Write down your Check and Posting Service (CAPS) client name
• Test normal operations
8-1
9
Post-Upgrade Checklist
(Optional) Print this page to help plan and prepare for upgrading.
For complete details, see Planning and Considerations.
• Verify that all workstations are running the expected software release versions
• Verify that all workstations are running the same Simphony client version
• Test normal operations
9-1
10
Windows Advanced Configuration Settings
for CAL
File transfer settings normally do not need to be changed, except in the case of very
low available bandwidth.
By default, the CAL client takes a best effort approach to transferring files from the
Simphony application server as quickly as possible. Files are transferred from the
application server in blocks and these blocks are assembled into a complete file at the
client.
Configuration
Configuration settings are available for tuning file transfers to specific customer
network environments. These registry configuration settings are available in Windows
CAL 146 under the key HKEY_LOCAL_MACHINE\Software\Micros\CAL\Config.
This is a client setting, so an administrator must add the following registry values:
• FileTransferBlockSize: DWORD: Controls the block size for each request to the
application server. If not present, the default 512kb is assumed. The minimum
value is 1024 (1kb).
• FileTransferTimeout: DWORD: Controls the maximum time (seconds) that CAL
waits for a response from the application server before considering the transfer a
failure. If not present, a default of 60 seconds is assumed.
• FileTransferMaxBlocksPerSec: DWORD: Controls the maximum number of file
block requests that the CAL client sends to the application within a second.
10-1
Chapter 10
10-2
11
Troubleshooting CAL and DCAL
The Simphony Installer provides the ability to switch an Enterprise URL
during the application server upgrade. When the Enterprise URL changes, the
SimphonyInstall.xml file included within existing CAL packages becomes out-of-date.
Existing CAL packages (from a previous upgrade) that are still being deployed must be
manually reloaded. The McrsCAL and ServiceHost are the only Oracle CAL packages
that include this file.
Make a backup copy of the current SimphonyInstall.xml on the application server
before reloading any CAL packages in case the file is accidentally overwritten.
Viewing, Reloading, and Saving CAL Package Contents contains more information.
Simphony Release 2.9
Viewing, Reloading, and Saving CAL Package Contents
Simphony Release 2.10
Viewing, Reloading, and Saving CAL Package Contents
Simphony Release 18.1
Viewing, Reloading, and Saving CAL Package Contents
11-1
Chapter 11
Upgrading CAL on Simphony 2.8 Clients or Later
may overwrite the truncated name during startup. When this occurs, DCAL clients may
not be able to communicate with the DCAL workstation.
Workaround:
Use EMC to change the DCAL workstation computer name to 15 characters or less.
Applies to: All Simphony releases
11-2
Chapter 11
ServiceHost Upgrades Prior to Simphony Release 2.8
11-3
Chapter 11
Changing the CAL URL
Workaround #1:
Use the secure enterprise URL when configuring the CAL client rather than the
DCAL workstation URL. The workstation automatically switches back to the DCAL
workstation after the Simphony client has finished installing.
Workaround #2:
1. Close the Simphony POS client on the workstation.
2. Run the %AppRoot%\WebServer\AuthenticationServer.exe utility
3. Confirm that the application server EGateway URL and Service Host ID are
correct.
4. Enter the EMC username and EMC password.
5. Click the Authenticate button.
6. Confirm that the ‘Authentication is successful’ message appears.
11-4
Chapter 11
Changing the CAL URL
• The six-digit challenge number changes with every attempt and is solved with
the formula: Digit 1 x Digit 2 + Digit 4 + Digit 6.
• Using the challenge number 391229 as an example, the solution is 3 x 9 + 2 +
9 = 38.
4. Make the following updates for the Enter CAL Server configuration:
a. Select the Secure Connection option.
b. Enter 443 as the Port.
c. Click Update, and then click Next.
The POS Type varies and is unique based on your installation and the
Simphony release.
Prior to Simphony release 2.9.1:
• MICROS Simphony is used as the POS Type with Simphony Premium.
• Simphony Multi-Te is used as the POS Type for Simphony Standard.
For Simphony release 2.9.1 or later, use MICROS Simphony for both
Simphony Standard and Simphony Premium.
5. For CAL Authentication, enter the EMC credentials that have the required role
privileges enabled, and then click Login.
11-5
Chapter 11
Changing the CAL URL
6. If the Enterprise has multiple properties, select the property from the Property
Search and Select window, and then click Next.
If the property does not appear in the list, enter the property name in the Property
Name field, and then press Search.
If only one property is configured, or if there are multiple properties but only one
property is using Microsoft Windows devices, you do not see a property list and
you can skip this step.
11-6
Chapter 11
Changing the CAL URL
7. Do not make changes on the Select WS Identity window, and then click Save.
11-7