Installing the Deployment Framework

This page tells you how to install the Caplin Deployment Framework. You get the Framework as a zipped up kit that you need to install on all the servers that are to host Caplin Platform components. You can then use the Framework to install and run all the other components.

Supported operating systems

For operating systems supported by the Caplin Platform, see Caplin Platform system requirements.


Install Java

Java is required to run Java-based modules of Liberator and Transformer, and to run the majority of integration adapters.

Caplin Platform components are each tested against a version of the Oracle Java Development Kit (JDK). For the specific JDK version required by a component, please see the component’s installation instructions.

To install Java so that it is compatible with the Deployment Framework, follow the instructions below.

  1. Install the Oracle JDK.

    Choose the JDK that is compiled for the same CPU architecture (32-bit or 64-bit) as the Liberator and Transformer binaries you will be installing. Note that Caplin Platform components are only available in 32-bit binaries for Windows, and so you should install a 32-bit JDK even on 64-bit Windows platforms.

  2. Set the value of the JAVA_HOME environment variable to the installation path for the Oracle JDK.

    Configure the JAVA_HOME environment variable for all shell environments from which you start Caplin Platform components.

For platform-specific help on installing Java and setting the JAVA_HOME variable, see Installing Java.

The Deployment Framework will attempt to locate a Java Virtual Machine (JVM) relative to the path in the JAVA_HOME variable. If the Deployment Framework fails to find a JVM in the location it expects, you will need to configure the Deployment Framework with the full path to a JVM. To specify the full path to a JVM library, use the ./dfw java command.

Install a Bash shell

The Deployment Framework’s dfw command is designed to be run from a Bash shell. Bash is the default shell for Red Hat Linux and Mac OS X.

For Windows installations, the Deployment Framework supports the following Bash shells:

For help on installing Cygwin, see Installing Cygwin.

Install the Deployment Framework

The instructions below cover how to install the Deployment Framework from the ZIP file available for download from the Customer Download Portal. If you manage the Deployment Framework under source control, follow the instructions in How can I retrieve the Deployment Framework from source control.

To install the Deployment Framework from ZIP file:

  1. On a Bash command line, extract the Deployment Framework archive to a directory of your choice using the unzip command:

    unzip -q -o -a DeploymentFramework-<version>.zip

    All platforms: Use the unzip command exactly as illustrated above. If you use unzip with different parameters, or if you use a different command or GUI application, then the extraction process may fail to extract symlinks and convert line-endings as intended.

    Microsoft Windows: When choosing a directory for the Deployment Framework, you should choose the highest directory-level possible to avoid exceeding the Win32 API’s 259 character limit on file paths.

  2. Set up dfw command completion (version 6.2 of the Deployment Framework and later).

  3. Check file and directory permissions for the user account that will start and stop the Deployment Framework (see below).

File permissions

Ensure that the user account used to stop and start the Deployment Framework has the following permissions:

  • Write permission to the directory (or directories) where log files are written to.

    By default, logs are written to the var subdirectory in each DataSource component’s directory hierarchy, but the location can be overridden for each component with the log-dir configuration item.

  • Write permission to the directory where Liberator’s licence-usage database is located.

    By default, the licence-usage database is located at <dfw-root>/servers/Liberator/users/uupp-rttpd.db, but the location can be overriden with Liberator’s uupp-qdbm-name configuration item.

  • Write permission to the directory where Transformer’s file-based persistence store is located.

    This only applies if you have activated Transformer’s Persistence Service and you are using file-based persistence.

    File-based persistence is not supported for production use.
  • Write permission to Transformer’s Charting Service cache directory.

    This only applies if you have installed Transformer’s Charting Service. See the service’s charting.conf file for the location of the cache directory.

  • Write permission to the directory where core dumps are written to, or permission to pipe core dumps to the program used to process core dumps.

    This only applies if the operating system is configured to generate core dumps. See your operating system manual for details.

See also: