Deployment packages

Create a product deployment package

A product deployment package in Transfer CFT is called an ExpressPackage.

The Express Package section describes how to create a reusable and distributable Transfer CFT package to simplify and ease the task of installing and configuring Transfer CFTs on multiple servers of the same architecture.

Note You can only install a Transfer CFT Express Package on the same platform as the one on which it was generated. For example, a Transfer CFT Express Package that is generated on linux-x86-64 can only be installed on a linux-x86-64 platform.

The procedure consists of:

  • Installing a template Transfer CFT 3.3.2
  • Configuring as required to meet your business needs
  • Generating an Express Package that is based on the configured template
  • Optionally customizing the Express Package
  • Deploying and installing the Express Package

Install a template Transfer CFT

Begin by installing a Transfer CFT instance, and configure as required to meet your business needs. This configured Transfer CFT serves as the template for the Express Package you are about to create.

Configure the:

  • Static configuration, such as protocols (CFTPROT), networks (CFTNET), UCONF parameters, and so on
  • Partners (CFTPART, CFTTCP)
    Note
    : If you create partners to export, DO NOT use the NSPART parameter in the CFTPART definition. The target Transfer CFT will instead use the CFTPARM PART/NPART values.
  • Flows (CFTSEND and CFTRECV)
  • SSL certificates
  • Processing scripts and EXITs
  • Additional Axway components that you use with Transfer CFT, such as Central Governance
Note You can embed the contents of the CFTDIRRUNTIME/bin and CFTDIRRUNTIME/exec directories in the generated Express Package.

Generate the Express Package

To generate an Express Package from the template Transfer CFT:

  1. Stop the Transfer CFT instance.
  2. Navigate to the Axway installation directory of the template Transfer CFT, and run the Installer in configuration mode.

    The default Axway installation directory is $HOME/Axway.

    Run the configure.sh script.

  3. The Installer wizard displays. In the Welcome page select Next.
  4. In the Configuration Type page, select Create an Express Package. Click Next to continue.
  5. Specify the file name of the Transfer CFT installation package that you used to install the Transfer CFT template.
    The package name format is Transfer_CFT_<version>_Install_<platform>_BN<buildNumber>.zip.
  6. Optionally, specify the file name of the service pack and/or patch to embed in the Express Package. 
    • The format of the service pack name is Transfer_CFT_<version>_SP<SPNumber>_<platform>_BN<buildNumber>.jar.
    • The format of the patch name is Transfer_CFT_<version>_Patch<PatchNumber>_<platform>_BN<buildNumber>.jar.
  7. Enter the path to the location where you want the new Express Package to be saved once generated.
  8. Click Next to continue.
  9. Select the configuration elements that you want to include in the Express Package, such as the partners and parameters database, the UCONF parameters, and the local PKI database. Click Next to continue.
  10. Note 1: If you are using Central Governance, you should only include the UCONF parameters and the local PKI database. The other configuration elements are deployed by Central Governance.
    Note 2: If you selected the auto import feature during the Transfer CFT template installation, you can only include the CFTDIRRUNTIME/bin and CFTDIRRUNTIME/exec contents.
  11. In the Configuration confirmation page, click Configure to generate the Express Package.

Results

The Express Package, Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>.zip, is generated and located in the directory you selected in the previous steps.

Customize the Express Package

You can customize the Transfer CFT Express Package prior to deploying and installing it. The Transfer CFT Express Package is nearly the same as the Transfer CFT Install package, the only difference being the additional ExpressPackage directory. If you are not customizing the Express Package (for example the installation directories), you can skip this section.

The ExpressPackage directory contains the:

  • data directory: This directory contains the data exported from the Transfer CFT template.
    • bin directory: This directory contains all files retrieved from CFTDIRRUNTIME/bin.
    • exec directory: This directory contains all files retrieved from CFTDIRRUNTIME/exec.
    • pki directory: This directory contains all exported certificates.
    • cft-parm.cfg: This file contains all of the parameter database objects (CFTPARM, CFTCAT, CFTLOG, CFTSEND, CFTRECV, and so on).
    • cft-part.cfg: This file contains all of the exported Transfer CFT partner database objects (CFTPART, CFTTCP, and so on).
    • cft-cftparm.cfg: This file contains only the CFTPARM objects to be imported during the Express Package installation.
    • cft-uconf.cfg: This file contains any UCONF parameters that were configured in the template Transfer CFT.
    • cft-pki.cfg: This file contains all of the PKICER commands to be executed during the Transfer CFT Express Package installation.
  • expressPackage.properties: This file contains all of the installation parameters that can be overwritten. All parameters are documented within this file. To personalize any of these parameters, uncomment the respective line and add the new value.
  • install executable: The executable to install the Express Package.

To customize the Express Package before deploying it:

  1. Unzip the package to a temporary directory, for example tempdir.

    unzip Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>.zip –d tempdir

  2. Edit the expressPackage.properties file located in the ExpressPackage directory, for example tempdir/ExpressPackage. Customize installation parameters as needed.
  3. Rezip the package.

    cd tempdir; zip -r Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>_new.zip *

Example: Install Transfer CFT in a different directory

In this example, the Transfer CFT template was installed in the /home/cft/Axway/Transfer_CFT directory.

To install Transfer CFT in a different directory on the target server, edit the expressPackage.properties file, uncomment, and set the Axway_InstallDir, CFT_InstallDir, CFT_RuntimeDir , CFT_Crypto_KeyFilename, and CFT_Crypto_SaltFilename parameters.

Axway_InstallDir = /opt/Axway

CFT_InstallDir = /opt/Axway/Transfer_CFT

CFT_RuntimeDir = /opt/Axway/Transfer_CFT/runtime

CFT_Crypto_KeyFilename = /opt/Axway/Transfer_CFT/runtime/data/crypto/crypkey

CFT_Crypto_SaltFilename = /opt/Axway/Transfer_CFT/runtime/data/crypto/crypsalt

Example: Install Transfer CFT in the home directory of different user accounts

In this example, the Transfer CFT template was installed on server0 by the user account test, in the /home/test/Axway/Transfer_CFT directory.

You can install the Transfer CFT on a target server in the home directory of different user accounts in a generic way using environment variables. Edit the expressPackage.properties file, uncomment, and set the Axway_InstallDir, CFT_InstallDir, and CFT_RuntimeDir parameters as follows.

Axway_InstallDir = $HOME/axway

CFT_InstallDir = $HOME/axway/cft

CFT_RuntimeDir = $HOME/axway/cft/runtime

Install the Express Package

To deploy and install the Express Package:

  1. Upload the generated Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>.zip file to the target server.
  2. Unzip the package.
  3. Browse to the ExpressPackage directory located within the unzipped package.
  4. Add the execution rights to the install executable.
  5. chmod +x install
  6. Run the install executable.
Note If you run the install without an argument, the install executable uses the expressPackage.properties file, in the ExpressPackage directory, as the customization file. In command line you can specify a different file name using the following OS-specific syntax.
./install <file name>

Limitations

  • Transfer CFT Express Package does not support cluster mode installations.
  • Transfer CFT Express Package cannot embed a Transfer CFT upgrade pack.

Related Links