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 Download

  • Service Host

CAL Directory and Package Contents

The CAL Package files and folders are located on the Simphony application server in the [Drive Letter]:\MICROS\Simphony2\EGatewayService\CAL directory. This is a very important directory. Handlers in this directory process messages that are sent to the Simphony application server. The EGatewayService directory includes the encrypted database information, as well as the web.config file that includes important Simphony settings. The following table lists the subdirectories that reside in the EGatewayService\CAL folder and the CAL package contents for various types of client devices.

Table 2-1 Simphony CAL Packages

Platform Type Type of Device CAL Folder Contents

Android

Devices running the Android mobile operating system

Service Host.19.8

WS KDS Display

Kitchen Display System (KDS) Controllers

  • CAL Client.160

  • KDS Handler.19.8

Oracle Linux for MICROS

Devices running the Oracle Linux for MICROS operating system

  • CAL Client.160

  • KDS Handler.19.8

  • Service Host Download.19.8

  • Service Host.19.8

  • WS KDS Display.19.8

Non-Supported (or not required) CAL Packages

  • CALVersionFixer2.0

  • CAPSOnIIS2.0

  • MediaViewer2.0

  • Simphony KDS Client (CE only)

Service Host

Not Applicable

A subdirectory is named for the Service Host ID which contains automatically generated setup information for each Service Host.

Win32 (Microsoft Windows)

Any Microsoft Windows machine, such as the MICROS Workstation 820 (running Microsoft Windows 10), Oracle MICROS Tablet 700 Series, Oracle MICROS Workstation 6 Series, or the Oracle MICROS Tablet E-Series

  • CAPSOnIIS.19.8

  • Device Information.100.0

  • MSSQLMySQLMigration

    Note:

    A check is made to ensure workstations are running a minimum version of Simphony 19.8, and there is 3.5GB of free disc space available, which is required to migrate from a Microsoft SQL Express database to an Oracle MySQL database. It is recommended to refer to the README.txt file for more details by clicking the Package Contents tab, and then from under the Files section, click the README.txt file, and then click the View Selected File link.

  • KDS Handler.19.8

  • SQLExpress2016SP3v2

    Note:

    A check is made to ensure workstations have a minimum version of Simphony 19.4, and there is 7GB of free disc space available, which is required to upgrade to Microsoft SQL Express 2016 SP3. It is recommended to refer to the README.txt file for more details by clicking the Package Contents tab, and then from under the Files section, click the README.txt file, and then click the View Selected File link.

  • CAL Client.160

  • Service Host Download.19.8

  • Service Host.19.8

  • WS KDS Display.19.8

The Simphony application installer imports CAL packages directly into the transaction database during installation. When this installation option is selected, all CAL packages included within a release are copied into the file system before being imported. Each Simphony release could include changes to internal CAL packages and their contents. Refer to the listing below for the specific CAL Package content of prior releases. These links direct you to the Simphony Configuration Guide, where this legacy information resides.

More About Platform Types

The following Platform Types are available for general use from the EMC CAL Package Configuration screen:

  • 0 - All Clients

  • 1 - Win32 Server

  • 50 - Win32 Client

  • 69 - Android (can be used for MC 40s running Android)

  • 80 - Linux Client

  • 101 - DTR Controller (KDS Display Controller)

Figure 2-1 CAL Package Configuration Tab


This figure shows the CAL Package Configuration tab and the available platform types as shown from the drop-down list.

Installation and Upgrade

The CAL Packages module configuration determines the clients to receive specific packages and the timing of package deployment. The Setup.dat file is a text file that contains installation instructions. New packages include the following information in the Setup.dat file:

  • Name: Identifies the CAL package

  • Version: Identifies the release version number using a four-number dotted notation format (for example, 2.80.4.25)

  • Commands: Indicates what, how, and where files are placed

The Simphony installer derives an internal name and version for Simphony packages from the Setup.dat file. The internal name and version typically differs from the package name and version. For example, ServiceHost 2.9 and ServiceHost 2.8 are two separate packages, but they share the same internal name, ServiceHost. The installer identifies the matching internal names and prevents installing and running two versions of ServiceHost.exe on the same client.

The CAL client uses the internal name and version from the Setup.dat file to determine whether to download the CAL package. EMC does not let you configure duplicate schedules for packages with the same internal name. For example, if you have a deployment schedule for ServiceHost.2.8 to deploy to the Enterprise, adding an Enterprise deployment for ServiceHost.2.8 and ServiceHost.2.7 results in the following error message: Cannot save duplicate deployments.

Beginning with Simphony release 2.10, prerequisite software is pre-loaded in a local directory on workstations, rather than downloading the prerequisite software from the Enterprise through CAL. This reduces the time between opening a new workstation and signing in to the Simphony POS client for the first time.

When you upgrade Simphony to a new release, the installer does not add new deployments and does not change existing packages or schedules. As a result, you do not need to change deployment schedules from Install to Skip. The installer preserves CAL packages and adds new release versions.