Installing Transformer

This page explains how to install an instance of Transformer using the Caplin Deployment Framework.

For instructions on upgrading and existing installation of Transformer, see Upgrading Transformer.

Contents:

Requirements

Transformer 6.2 must be deployed on the Deployment Framework 6.2.

Transformer 7 must be deployed on the Deployment Framework 7.

For server hardware and operating system requirements, see Caplin Platform System Requirements.

The Microsoft Windows build of Transformer 7 requires the Microsoft Visual C++ 2015 Redistributable.

Note: the Microsoft Windows build of Transformer is not supported for use in production environments.

Installation instructions

If you are upgrading an existing installation of Transformer, see Upgrading Transformer.

Follow the instructions below to install Transformer:

  1. Install the Deployment Framework
  2. Stop all running Caplin Platform components
  3. Install the Transformer licence file
  4. Deploy Transformer
  5. Confirm deployment
  6. [Optional] Activate Transformer's JMX interface
  7. Start Transformer
  8. Confirm Transformer is running
Tip: In the following steps you'll be using the dfw command of the Deployment Framework. Before entering any dfw command as ./dfw <command-name>, make sure your current (working) directory is set to the Deployment Framework's topmost directory.

For a list of dfw commands, click here.

1. Install the Deployment Framework

If you have already installed the Deployment Framework, you may skip this step.

To install the Deployment Framework, follow the instructions in Installing the Deployment Framework.

2. Stop all running Caplin Platform components

If you installed the Deployment Framework in step 1, you may skip this step.

It is important that all Caplin Platform components are stopped before installing new components or making configuration changes.

To stop all Caplin Platform components running under the Deployment Framework, type the command below from the root directory of the Deployment Framework:

./dfw stop

3. Install the Transformer licence file

If you have a licence for this Transformer, copy the licence file (license-transformer.conf) to the Deployment Framework's licence directory: <Framework-root>/global_config/licenses

If you don't have a licence file, then, on deployment of Transformer (step 4), the Deployment Framework will copy Transformer's evaluation licence to the licence directory: <Framework-root>/global_config/licenses. The evaluation licence allows Transformer to run for 30 minutes, after which time Transformer will automatically shutdown. To use Transformer for production or development use, contact Caplin Support for an authorised licence.

Tip: You only need to copy licenses to the server machines on which the licensed Transformers run.

4. Deploy Transformer

To deploy Transformer:

  1. Copy the Transformer installation file into the <Framework-root>/kits directory
  2. Issue the command below to deploy Transformer:
    1. ./dfw deploy
    2. Note: If this command writes one or more warning messages of the format "Not copying override file..." to the console, then you are upgrading an existing installation of Transformer. See Upgrading Transformer.

The ./dfw deploy command performs the following tasks:

  1. Unpacks Transformer
  2. If no Transformer licence is found in <Framework-root>/global_config/licenses directory, copies Transformer's evaluation licence to the directory.
  3. If no override files for Transformer are found in <Framework-root>/global_config/overrides/servers/Transformer directory, copies Transformer's override files to the directory.
  4. Moves the Transformer installation file into the <Framework-root>/kits/archive/ directory.
    1. Note: the installation file is moved to the archive directory regardless of whether the blade installed successfully.

5. Confirm deployment

To confirm that Transformer has been deployed correctly, issue the command below:

./dfw versions

Example output:

Deployment Framework                     7.0.1-307522

Core components                          Version
---------------------------------------------------------------------
Transformer                              7.0.0-307538

Deployed blades                          Version            State
---------------------------------------------------------------------
PersistenceService                       7.0.0-307538       Inactive
PersistenceServiceClient                 7.0.0-307538       Inactive
TransformerDemoDataSource                7.0.0-307538       Inactive
TransformerJMX                           7.0.0-307538       Inactive
TransformerToLiberatorConnection         7.0.0-307538       Active
TransformerToLiberatorSSLConnection      7.0.0-307538       Inactive

Note: on first deployment of Transformer, the TransformerToLiberatorConnection configuration blade is activated by default. Subsequent deployments (see Upgrading Transformer) to the same Framework respect your configuration and do not change blade activation status.

6. Activate Transformer's JMX interface

[Optional] To activate Transformer's Java Management Extensions (JMX) interface, so that Transformer can be monitored by the Caplin Management Console (CMC) or other JMX client, follow the instructions below:

  1. Enter the command below from the root directory of the Deployment Framework:
    1. ./dfw activate TransformerJMX
  2. To confirm that the TransformerJMX blade has activated, enter the command below from the root directory of the Deployment Framework:
    1. ./dfw versions

For information on how to install the Caplin Management Console, see Installing the CMC.

7. Start Transformer

To start Transformer and all other components on the Deployment Framework, enter the command below:

./dfw start

8. Confirm Transformer is running

To confirm Transformer is running, enter the command below:

./dfw status

If you have previously installed Liberator, you can confirm that Transformer has connected successfully to a Liberator by checking the Liberator's status page.


See also: