5 Client Application Loader (CAL)

The Client Application Loader (CAL) is a process that allows seamless distribution, installation, and maintenance of Simphony software from a CAL server to all Simphony client workstations and service hosts. CAL is the only method for installing Simphony workstation software and service software (such as Kitchen Display System (KDS) Controller software and System Interface Module (SIM) file access software). The CAL stores software packages in the transaction database, providing a central storage location. The CAL allows the 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

Packages

Packages are a sophisticated method of distributing software to the clients. Files that need to be copied or run on the client are bundled together, given a name, and placed in a separate directory on the server. A CAL Package is a group of files and folders that are copied to workstations and other CAL-enabled devices. You can configure the packages to be distributed to:
  • All devices in the Enterprise

  • Devices in selected properties

  • Specific devices

CAL Directory and Package Contents

The CAL Package files and folders are located on the Simphony application server in the EGatewayService directory. This is the most 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 5-1 CAL Package Contents

Platform Type Type of Device CAL Packages

ANDROID

Devices Running the Android Mobile Operating System

ServiceHost2.0

DC

Kitchen Display System (KDS) Controllers

  • DCKDS

  • DCKDS2.0

  • DCKDSPrintServer2.0

  • McrsCAL

  • McrsCAL2.0

MC40

Motorola MC40

  • FuseboxSTunnel2.0

  • McrsCAL

  • McrsCAL2.0

  • ServiceHost2.0

ServiceHosts

Not Applicable

Subdirectory named for the Service Host ID that contains automatically generated setup information for each Service Host

Windows

Any Windows machine, such as the Oracle MICROS Tablet 720, Oracle MICROS Workstation 6 Series, Oracle MICROS Tablet E-Series, and Oracle MICROS PC Workstation 2015

  • CALVersionFixer2.0

  • CashManagement2.0

  • DigitalPersona2.0

  • McrsCAL

  • McrsCAL2.0

  • MediaViewer2.0

  • PosToKdsHandler

  • PosToKdsHandler2.0

  • ServiceHost2.0

  • ServiceHostPrereq2.0

  • ServiceHostPrereq2015SQL2.0

  • WSKDS2.0

WS5A

Oracle MICROS Workstation 5A

  • McrsCAL

  • McrsCAL2.0

  • WSKDS

  • WSKDS2.0

Installation and Upgrade

The configuration in the CAL Packages module of the EMC determines when a client receives a new CAL package. 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.800.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.7 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 allow you to 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.

When you upgrade Simphony to a new version, the installer does not add new deployments (with one exception) 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 versions.