Вы находитесь на странице: 1из 110
I N S T A L L A T I O N G U I

I N S T A L L A T I O N

G U I D E

Transfer CFT

Version 3.2.2

Windows

19 October 2016

Copyright © 2016 Axway All rights reserved. This documentation describes the following Axway software: Transfer

Copyright © 2016 Axway

All rights reserved.

This documentation describes the following Axway software:

Transfer CFT 3.2.2

No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission of the copyright owner, Axway.

This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this document. Axway does not warrant that this document is error free.

Axway recognizes the rights of the holders of all trademarks used in its publications.

The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such sites. Axway is not responsible for any content, associated links, resources or services associated with a third-party site.

Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.

Contents

Preface

1

About Transfer CFT 1 Installation guide outline 1 Who should read this guide 2 Transfer
About Transfer CFT
1
Installation guide outline
1
Who should read this guide
2
Transfer CFT documentation set
Support services
2
2
Accessibility
3
Accessibility features of the documentation
Screen reader support
3
3
Support for high contrast and accessible use of colors
3
1 Prerequisites
5
Overview
5
License keys
5
End User License Agreement
Check your authorization
5
5
Windows x86 operating system prerequisite
System requirements
6
8
About the Transfer CFT environment
Disk space and RAM requirements
8
8
Java
8
Installer screen resolution
Pre-installation
9
10
Windows requirements
10
Cluster installation requirements
Default ports
11
13
Certificates
15
2 Install
16
Before you start
Installation
16
package contents
16
Installation functions
Installation modes
16
17
Installed directories
17
Windows x86 operating system prerequisite
Install Transfer CFT
17
18
Start the installation
Cluster mode screens
Auto import screens
Multi-node options
18
23
23
25
Governance options
25
Connector options
26
Installing services in command line
28
Using NFSv3 in an active/passive architecture
Silent mode installation
28
31
Installer functions 36 Installer functions 36 JRE customization 40 3 Post-installation 43 Perform an update
Installer functions
36
Installer functions
36
JRE customization
40
3 Post-installation
43
Perform an update
43
Create a basic configuration
Update the profile
43
43
UCONF
43
Configuration
44
License key
44
Transfer CFT internal datafile and configuration
User interface configuration
44
44
Configuration
for Service Mode
45
Start the Transfer CFT Copilot server
Start Transfer CFT
45
45
4 Update
46
Use Central Governance for updates
46
Installer or products patches and service packs
Check product details
46
46
Windows updates
47
Update procedure in GUI mode
47
Remove an
update
48
Remove updates in
Remove updates in
GUI mode
48
console mode
48
5 Upgrade or migrate
49
Upgrade and migration overview
49
Migrating
or upgrading to enable Central Governance
49
Migration versus an upgrade
Upgrade Transfer CFT
49
52
About upgrades
Before you start
52
52
Transfer CFT 2.6.4
Transfer CFT 2.7.1
Transfer CFT 3.0.1
Transfer CFT 3.1.3
Post upgrade
to 3.2.2
54
to 3.2.2
57
to 3.2.2
60
to 3.2.2
62
64
Upgrade a multi-node installation
Prerequisites
64
65
Important information before performing a migration procedure
Windows x86 operating system prerequisite
65
65
Install and auto import
General procedure
66
66
Auto import in multi-node architecture
Perform a manual migration
68
69
Prerequisites
69
Migrating
Migrating
from Transfer CFT 2.3.2
from Transfer CFT 2.4
70
73
Migrate from Transfer CFT 2.5 or 2.6
77
Migrating from Transfer CFT 3.0.1 or 3.1.2 Activate Central Governance connectivity 82 86 Overview 86
Migrating from Transfer CFT 3.0.1 or 3.1.2
Activate Central Governance connectivity
82
86
Overview
86
Automatically activate connectivity
Manually activate connectivity
87
88
Connect to a different Central Governance system
Use former configuration objects
90
90
View managed features
90
Post-migration procedure
92
Post manual
migration
or auto import
92
Post manual migration only
Post upgrade
92
93
6 Uninstall
94
About uninstalling in Windows
94
7 Deployment packages
96
Create a product deployment package
Install a template Transfer CFT
96
96
Generate the Express Package
97
Customize the Express Package
Install the Express Package
98
99
Limitations
100
8 Troubleshooting
101
Troubleshoot installation and registration
Copilot server issues
101
101
Central Governance
Transfer CFT server
Applying a license key
Obtain a license key
Apply a license key
101
102
103
103
103
Support tools and contacting Support
Accessing the Axway Support site
104
104
Using CFT_support
104

Preface

This documentation provides information to aide you in installing, upgrading, or migrating Transfer CFT.

About Transfer CFT

Transfer CFT is the file transfer component in the Axway platform, and provides a multi-platform, high-volume, file and message transfer service. This documentation explains how to install, configure, and manage Transfer CFT.

Using version 3.1 or higher, you can configure Transfer CFT and manage flows using Axway Central Governance. Central Governance simplifies Transfer CFT usage, and provides services such as identity and access management, certificate management, monitoring, alerting, and a web dashboard.

For more information on Axway products, visit www.axway.com.

Installation guide outline

This guide explains how to perform a full installation of Transfer CFT. It also describes how to:

Prepare and plan your installation – Describes what you should plan for deploying and configuring your system architecture, installing any prerequisite software, and configuring other components.

Install – Describes how to perform a complete install as well as apply a service pack.

Post installation – Provides instructions on how to check if the installation was successful and set up Transfer CFT. Additionally it describes any tasks to perform before the administrator can log on to the product for initial configuration.

Upgrade – Involves a change in product version and the replacement of binary artifacts; may also require configuration change.

Migrate– Involves a change in product versions, such as from 2.7.1 to 3.2.2. As part of this process, the existing configuration may need to be modified or updated to be compatible with the new version. For example, you may need to modify configuration files or the internal datafile schema. Because migration can be a complex process, organizations typically set up a migration project to study the new features and determine the impact on the existing configuration, and to plan for the changes across the various environments.

Uninstall – Describes how you can uninstall Transfer CFT.

Preface

ExpressPackage - Describes how to create a product package that you can deploy to multiple remote sites.

Troubleshoot the installation or registration process – Describes the different types of troubleshooting errors you can encounter during installation, upgrade and post-installation.

Who should read this guide

This guide is intended for enterprise personnel involved in installing software and Axway Professional Services personnel. Familiarity with Axway products is recommended.

This guide presumes you have knowledge of:

l

Your company’s business processes and practices

l

Your company’s hardware, software, and IT policies

l

The Internet, including use of a browser

Others who may find parts of this guide useful include network or systems administrators and other technical or business users.

Transfer CFT documentation set

Transfer CFT provides a complete set of documentation, covering all aspects of using the product. These documents include the following:

l

Transfer CFT 3.2.2 Release Notes

l

Transfer CFT 3.2.2 User Guide (HTML)

l

Transfer CFT 3.2.2 Local Administration User Guide

l

Axway Supported Platforms Guide

l

Axway Interoperability Matrix

Support services

The Axway Global Support team provides worldwide 24 x 7 support, subject to validation of your license agreement. Email support@axway.com or, for your local support telephone number, visit Axway Support at https://support.axway.comand click Contact Axway Support.

You can post comments and question to the Axway user forum at: forums.axway.com/index.php

Accessibility

At Axway, we strive to create accessible products and documentation for all of our users.

This section describes the accessibility features of the documentation.

Accessibility features of the documentation

The product documentation provides the following accessibility features:

l

Screen reader support

l

Support for high contrast and accessible use of colors

Screen reader support

l

Alternative text is provided for images whenever necessary.

l

The PDF documents are tagged to provide a logical reading order.

Support for high contrast and accessible use of colors

l

The documentation can be used in high-contrast mode.

l

There is sufficient contrast between the text and the background color.

Accessibility

Prerequisites

Overview

1

Axway products are delivered electronically from the Axway support website. A welcome letter notifies you that your products are ready for download.

To install perform the following tasks:

1. Check your license key and authorization.

2. Check the hardware and system requirements.

3. Download product.

4. Install products.

License keys

Before installing or upgrading, make sure you have obtained a license for Transfer CFT. Check that the license key is correct for the features and operating system you intend to install. It is not mandatory to enter the license key during the Transfer CFT installation, but you do require a key to start the product.

For information on applying a license key post installation, or if you have a problem with your license key, refer to the appropriate Troubleshooting topic.

Note

You require as many keys as instances of Transfer CFT running at same time, including when running in multi-node. For example, two Transfer CFT instances cannot run at the same time, on the same server, using the same license key.

End User License Agreement

You should read and accept the End User License Agreement (EULA) prior to installing Transfer CFT. The EULA file is located in the directory where you decompressed the Transfer CFT package.

Check your authorization

Verify that you can access and log on Axway Support at https://support.axway.com. If you do not have an account, follow the instructions in your welcome letter.

Log in to download or access:

1 Prerequisites

l

The product installation package

l

Your product license key

l

Product documentation

l

Product updates, including patches and service packs

l

Product announcements

l

Axway Supported Platforms Guide

l

The case center, to open a new case or to track opened cases

You can also access other resources, such as articles in the Knowledge Base and documentation for all Axway products.

Windows x86 operating system prerequisite

When using a Windows x86 (32-bit) or (64-bit) system, you must install the Visual C++ Redistributable Package for Visual Studio 2013 to provide necessary library files (DLL) for the compiler:

l

For a win-x86-32 target use: vcredist_x86.exe

l

For a win-x86-64 target use: vcredist_x64.exe

To download the redistribution package, visit: Visual C++ Redistributable Packages for Visual Studio 2013

Note

If the redistribution package is already installed on your Windows system, there is no need to reinstall.

1 Prerequisites

I spoke to Eric about your request. He said you should write up an email justification for travel and he will forward it to management to see if Axway can pay, at least for part of the travel. IMHO, you would stand a better chance of getting some reimbursement for an October trip than for one at the end of the year.

In any event, neither he nor I have any issues with you working in the Puteaux office, whether it’s an Axway-paid trip or on your own dime.

1 Prerequisites

System requirements

The following are the system requirements for Transfer CFT.

About the Transfer CFT environment

Supported operating systems and browsers

Refer to the Axway Supported Platforms Guide available on Axway Support at https://support.axway.com.

Disk space and RAM requirements

Transfer CFT has the following hardware requirements:

l

Disk space requirement

o 1.5 to 5 Gigabyte: minimum disk space to allow for future updates, SPs, and continued performance

l

RAM Requirement

o 128 Megabyte: minimum dedicated per host

Java

Transfer CFT is based on Java technology. To avoid compatibility issues Axway provides the correct JRE, which is installed during the product installation in the <Axway home>/java/<platform name>/jreX directory, where jreX represents the Java version.

Clients that connect to Copilot require Java 8. If you intend to implement EBICS (UNIX/Windows) or Secure Relay you also require Java 8.

Java 8 is delivered with the product, with the following exceptions:

l

Java 7: linux-s390-32, linux-s390-64, sun-sparc-32, sun-x86-32

l

Java 6: hpux-parisc-32, hpux-parisc-64, linux-ia64-64

Secure Relay Java installation directory prerequisite

When using Secure Relay, Java must be installed in the same environment as the Transfer CFT installation. The Master Agent is thus managed, while the Router Agent can be in another environment.

1 Prerequisites

Installer screen resolution

When the Installer is run in GUI mode, a resolution of at least 800 x 600 is required.

1 Prerequisites

Pre-installation

The following are tasks to perform or issues to address before installing Transfer CFT.

Windows requirements

The Windows installation directory must not contain any sub-folders or files that are owned by another user.

Apply service pack or patch using Central Governance

To install a Transfer CFT Service Pack or patch from Central Governance, you must run the Transfer CFT UI as administrator.

Windows UAC

User Account Control (UAC) is available in Windows Vista, Windows Server 2008, Windows 7, Windows Server 2008 R2, and Windows 2012.

For previous Windows versions, the following must be set. You must be in the ‘Log on as a service’ group and this is configured in:

1. Start > Control Panel > Administrative Tools > Local Security Policy.

2. From the tree, select: Local Policies > User Rights Assignment > Log on as a service.

When you have a Windows version that supports UAC you can:

l

Disable UAC.

l

If you choose not to disable the UAC, the installer requires administration rights at installation. You must be part of a group of administrators or have an administrator user account. The installer detects the type of user and sends the appropriate message:

l

Setup with administrator user account: Accept or decline if you want to make changes to your computer.

l

Setup with standard user account: Enter your administrator password first to continue.

The following task list requires that you have elevated rights and will fail if none of the two options are performed:

l

Create or remove shortcuts in Start menu or desktop

l

Create or remove Windows services

l

Installing in %SystemRoot% or %ProgramFiles%

l

Running product scripts that require elevated rights

1 Prerequisites

Windows itanium installation

If you want to start the installer on Windows itanium, use setup32.exe and not setup64.exe.

Cluster installation requirements

Because you cannot use a UNC path (\\address\folder) as a shared directory, when installing a Transfer CFT cluster the shared directory must be located in a mounted shared drive (u:\folder).

This is due to UNC path support limitations, such as the changedir function, which are needed by Transfer CFT server. Transfer CFT cannot start up properly if the CFTDIRRUNTIME environment variable is set to a UNC path.

A best practice therefore, when using Transfer CFT clusters in Windows, is to install Transfer CFT in

cluster mode and permanently map the network shared directory to a drive. Using this method the mapped drive is then accessible to the Transfer CFT Windows Services. There is no need to modify the Transfer CFT profile after the installation.

Create a mapped drive

To map network shares to a drive accessible to Windows Services, you must log in as the NT AUTHORITY\SYSTEM account.

1. Download the Sysinternals Suite from Microsoft, and unzip it to a directory.

2. Open a command window and start a session as Administrator (Run as administrator).

3. Go to the unzipped directory containing the Sysinternals Suite executable:

CD <the_previously_unzipped_directory>

4. Log in as the NT AUTHORITY\SYSTEM account:

psexec -i -s cmd.exe

Note

This launches a new command window. Perform the next step in this new window.

5. In the new window, create the persistent mapped drive.

net use Z: \\servername\sharedfolder /persistent:yes

6. Provide the credentials for a user having access to the shared folder.

7. Create a Startup script that contains only the command from step 5 (Create the persistent mapped drive), and implement using the instructions in the Microsoft article: Assign Computer Startup scripts.

1 Prerequisites

Remove a mapped drive

To remove the mapped drive:

1. Launch a command prompt as Administrator (Run ad administrator).

2. Go to the unzipped directory containing the Sysinternals Suite executable with command:

CD <the_previously_unzipped_directory>

3. Login as the NT AUTHORITY\SYSTEM account:

psexec -i -s cmd.exe

Note

This launches a new command window. Perform the next step in this new window.

4. In the new window, delete the mapped drive:

net use Z: /delete

1 Prerequisites

Default ports

The following list contains the default Transfer CFT port numbers used for installation. You can check in advance that these ports do not conflict with ports used by other applications on the same machine.

You may need to modify the default port numbers, depending on your configuration.

Table 1. Default ports by platform

The Internet Assigned Numbers Authority (IANA) reserves the TCP ports 1761-1768 for Transfer CFT. For more information, refer to: www.iana.org/assignments/service-names-port- numbers/service-names-port-numbers.

Component

Port

PeSIT

1761

SSL

1762

COMS

1765

Copilot

1766

Copilot for Central Governance

1767

Central Governance

12553

Central Governance SSL

12554

Secure Relay MA

ma.comm_port

6801

Secure Relay RA

ra.comm_port

6811

ra.admin_port

6810

Legend:

l

PeSIT (PESITANY protocol): PeSIT in plain text

l

SSL: PeSIT protocol over SSL/TLS

l

COMS: Synchronous transfers

l

Copilot: Provides access to Transfer CFT Copilot server from a user Internet browser

l

Copilot for Central Governance: Provides secure access for Central Governance (mutual

1 Prerequisites

authentication)

l Central Governance: Used to connect to Central Governance

1 Prerequisites

Certificates

Using the default certificates that are supplied with Transfer CFT is strongly discouraged in a production environment. You should use your own certificates to enhance security.

Type

Location

Certificate

Expires

Secure

<Transfer_CFT>/home/distrib/xsr

SecureRelayCA.pem

November

Relay

2021

 

SecureRelayMasterAgent.p12 November

 

2021

Central

<Transfer_CFT>/runtime/conf/pki

passportCA.pem

November

Governance

2019

For a DER certificate, the file must be created with a record length equal to the size of the certificate in bytes then the certificate can be uploaded to the newly created file.

CRTPF FILE(YOURLIB/DER_CERT) RCDLEN(1191)

Install

Before you start

2

Axway Managed File Transfer is part of the Axway family of managed file transfer (MFT) products. Transfer CFT is a transfer exchange system that enables reliable and secure internal file transfers between applications.

If you are installing Transfer CFT as part of an AxwayManaged File Transfer solution, you may want to check the installation order and prerequisites. For more information, please refer to the Central Governance documentation.

AxwayCentral Governance is the Axway management application, which provides a set of services for administering Transfer CFTs using a cohesive and intuitive user interface. From the Central Governance UI you can configure, access logs, and perform operational tasks for your Transfer CFT. Central Governance also simplifies the task of creating file transfers definitions, and supports mass deployment of configuration changes to groups of Transfer CFTs.

During the installation process you are prompted to select if you want to enable Central Governance. Please check that your license includes Central Governance and that you have the required information, such as the shared secret, to activate connectivity.

Before you start the installation, you should:

l

Downloaded the installation package from Axway Support.

l

Uncompressed or unzipped the package.

Installation package contents

The installation package is a zip archive. Once you unzip it, it contains the product and installer program files.

Installation functions

The installer is used to install, configure, update and uninstall Transfer CFT. You can run the following installation modes:

l

Install

l

Configure

l

Update

l

Uninstall

2 Install

Installation modes

Locate and run the setup file in the root folder of the installation package.

GUI mode:

l Windows: setup32.exe or setup64.exe

Console mode:

l Windows: setup32.exe -m console or setup64.exe -m console

The setup32.exe is a 32-bit build executable and will run on a 64-bit platform provided that the compatibility layer has been installed.

For more information, see Installer functions.

Installed directories

Once you install a product, the following sub-directories are installed.

l

Configuration: Includes the configuration file for each installed product

l

Documentation: User documentation

l

Installer: Files used by the installer

l

Java: The deployed JRE used by the installer and Axway products

l

SilentFile: Includes the silent file for each installed product

l

synInstall: Installer internal files that are used to manage the installed infrastructure

l

Tools: Tools used by the installer to manage infrastructure instances. You can use some of these for example, XDBM and SilentFileEditor

Windows x86 operating system prerequisite

When using a Windows x86 (32-bit) or (64-bit) system, you must install the Visual C++ Redistributable Package for Visual Studio 2013 to provide necessary library files (DLL) for the compiler:

l

For a win-x86-32 target use: vcredist_x86.exe

l

For a win-x86-64 target use: vcredist_x64.exe

To download the redistribution package, visit: Visual C++ Redistributable Packages for Visual Studio 2013

Note

If the redistribution package is already installed on your Windows system, there is no need to reinstall.

2 Install

Install Transfer CFT

Start the installation

You can use this topic to plan and execute installation of Transfer CFT. If you are using Adobe Reader, you can add comments to document the data you need to enter after launching the installer. Otherwise, you can print the topic, enter data manually and use the notes when installing.

Once you have completed planning, you are ready to install. See About the installer for how to start the installer in install mode.

To configure Transfer CFT for installation, perform the following procedure. Note that pending your license key options and environment, you may have only a subset of the following screen selections as schematically shown in the following diagram.

selections as schematically shown in the following diagram. This table displays a basic installation, a standalone

This table displays a basic installation, a standalone Transfer CFT, with no options.

2 Install

Screen

Description

Welcome

Provides links to the Axway website and the Axway support site.

 

"

License

agreement

Select the check-box "I accept to continue with the installation.

Installation

Select to install on either a single machine, or a cluster mode installation.

architecture

Note

If you select cluster, additional screens display.

Installation

Where product files and documentation will reside.

directory

Axway Transfer

Specify the directory where you want to install Transfer CFT.

CFT:

By default, Transfer CFT is installed in a sub-directory of the Axway installation directory. Use the default directory, or specify a new directory.

Installation

directory

Directory paths cannot contain spaces.

Axway Transfer

Specify the directory where you want to install the Transfer CFT runtime directory.

CFT:

Runtime

By default, the runtime directory is installed in a sub-directory of the Transfer CFT installation directory. Use the default directory, or specify a new directory. A runtime directory will be created if it does not already exist.

Directory paths cannot contain spaces.

directory

Axway Transfer

Specify if you want to import data from an existing Transfer CFT by selecting Yes or No.

CFT: Auto

Import

You can install and import configuration and data from v2.3.2, v2.4, v2.5, v2.6, v2.7, v3.0.1, v or 3.1.2.

Note

If you select Yes in the Auto Import screen, additional screens display.

Axway Transfer

Check or modify the supplied information concerting the Transfer CFT instance name, group name, and host address.

CFT:

Identity

An asterisk * denotes that these fields are mandatory.

2 Install

Screen

Description

 

Axway Transfer

Select to enable multi-node architecture.

CFT: Multi-node

Enter the number of nodes. The first node is zero, and you may have up to four nodes.

Architecture

Enter the host name and address for each node, up to four nodes. You must enter at least one host.

 

Note

If you enter a number to enable multi-node, additional screens display.

Axway Transfer

Enter the license key for the Transfer CFT product.

CFT:

If you have a license key issued for a previous version of Transfer CFT, enter your license key in the License Key field and select the Check key option.

You can configure up to four keys.

License key

Deselect Check key to continue with the installation without a key. However, you cannot run Transfer CFT until you supply the license key.

 

Note

If you are installing in multi-node you require:

 

l

One (1) valid key per node

l

Among the keys there must be at least one valid key per host

Axway Transfer

Enable Central Governance connectivity:

CFT:

 
 

l

Governance

Yes: Install Central Governance connectivity. For details, see the Central Governance topics in the Transfer CFT User's Guide.

Mode

 

l

No: Installs Transfer CFT without Central Governance.

Axway Transfer

Enter the TCP parameters for the host, PeSIT protocol, catalog, and communication media.

CFT:

Configuration

l

Synchronous communication: enter the COMS port

l

PESITANY: Enter the PeSIT protocol port number

l

Select the default database size:

o

o

Catalog: Modify the default catalog file size

Communication File: Modify the default communication file size

2 Install

Screen

Description

Axway Transfer

Enter the Transfer CFT UI Server values:

CFT: User

 

l

Listening Port: Listening port for the graphical user interface. This sets the port on which the Transfer CFT UI server listens for incoming TCP connections.

Interface Server

 

l

SSL Listening Port: Defines the SSL connection for the UI server, when Central Governance is selected.

Note: If you enabled multi-node, you are also prompted for the load balancer details.

Axway Transfer CFT: UI Server startup mode

For Windows installations, specify whether you want to start Axway Transfer CFT manually, or to have Windows start and stop it as a Windows service. Select:

l

Normal mode: You must manually start and stop the Transfer CFT server

l

Service mode: Windows automatically starts and stops the Transfer CFT server. If you select this option, the next installer screen sets the Service parameters. Note: To start Transfer CFT server using service mode from the Copilot server, it is imperative that Transfer CFT service be set up with a specific user account (not using the default system user). If the user is the system user, the Copilot will not be able to start Transfer CFT in service mode.

Axway Transfer CFT: UI Server startup mode

For Windows installations, specify whether you want to start Transfer CFT UI manually, or to have Windows start and stop it as a Windows service. Select:

l

Normal mode: You must manually start and stop it.

l

Service mode: Windows automatically starts and stops it. If you select this option, you use the next installer screen to set Service parameters.

2 Install

Screen

Description

 

Axway Transfer CFT: UI Server service

If you selected Service mode, enter values for the Windows service parameters:

l

Service Name: Enter a Windows service name

 

l

Display Name: Enter a Windows service display name

You can accept the default Service names or modify them. The installer uses these names to create a Transfer CFT service entry in the Windows registry.

l

Start Type: Automatic, Manual, Disabled

l

Error Control: Ignore, Normal, Severe, Critical

l

Use specific account to start the service: Enables you to use a local account instead of a system account

l

Domain: Enter the domain name

l

Username: Name of the local account

l

Password: Enter the user password

Note: In multi-node, to start the Transfer CFT server using service mode from the Copilot server, it is imperative that Transfer CFT service be set up with a specific user account and domain (not using the default system user). If the user is the system user, Copilot will not be able to start Transfer CFT in service mode.

Axway Transfer

This screen enables you to install Start Menu shortcuts.

CFT:

l

Yes: Creates shortcuts

Shortcuts

 

l

No: Does not create shortcuts

This screen enables you to install desktop shortcuts.

l

Yes: Creates shortcuts

l

No: Does not create shortcuts

Axway Transfer

This screen allows you to select from the following Axway product connectors:

CFT:

Connectors

l

Sentinel

l

Public Key Infrastructure with PassPort

l

Access management with PassPort

 

Note

If you select any of the available connectors, additional screens display.

Axway Transfer

Click Install to complete the installation process, or Previous to review or modify installation options.

CFT:

Ready to install

2 Install

Cluster mode screens

Screen

Description

Installation

Select either:

architecture

o

Single - installs on a single machine

o

Cluster - on cluster node

Cluster

o

First node: You must install on a first node before adding additional nodes.

o

Additional nodes: You must first install an initial node, before selecting this option.

Installation

Specify the root and shared directories where you want to install the product files and where the documentation will reside.

directories

Directory paths cannot contain spaces.

Axway

Specify the directory where you want to install Transfer CFT.

Transfer

By default, Transfer CFT is installed in a sub-directory of the Axway installation directory. Use the default directory, or specify a new directory.

CFT:

Installation

directory

Select the directory that will store shared data between the cluster nodes.

Directory paths cannot contain spaces.

Axway

Specify the directory where you want to install the Transfer CFT runtime directory.

Transfer

CFT:

By default, the runtime directory is installed in a sub-directory of the Transfer CFT installation directory. Use the default directory, or specify a new directory. A runtime directory will be created if it does not already exist.

Runtime

directory

Directory paths cannot contain spaces.

Auto import screens

If you select Yes in the Auto import screen, the following Installer pages display.

2 Install

Screen

Description

Axway Transfer Specify if you want to import data from an existing Transfer CFT by

CFT: Migration

selecting Yes or No.

You can migrate from V2.3.2, V2.4, V2.5, V2.6, v2.7, v3.0.1 or

v3.1.2.

Axway Transfer Specify the path to the profile file. CFT: Migration

Axway Transfer This screen is only displayed during a migration operation. You

CFT: Migration

Options

should see the Version, SP, Installation directory and runtime directory listed on the screen.

Select the objects that you want to import:

For V2.5.x and higher:

l

Functional configuration objects (PARM/PART)

l

Environment objects (UCONF)

l

Catalog: CFTCATA

l

Communication medium: CFTCOM

l

Local PKI base (since V2.5.1 - SP2)

For V2.4.x:

l

Functional configuration objects (PARM/PART)

l

Environment objects (Sentinel : trkapi.cfg)

l

Environment objects (Copilot : copconf.ini)

l

Catalog (CFTCATA)

l

Communication medium (CFTCOM)

l

Local PKI base (since V2.4.1 - SP6)

For V2.3.2:

l

Functional configuration objects (PARM/PART)

l

Environment objects (Sentinel : trkapi.cfg)

l

Catalog (CFTCATA)

l

Communication medium (CFTCOM)

You have to migrate the following objects manually:

l

Executables

l

Exits

l

APIs

For more information on importing configuration and data, see Install and auto import.

2 Install

Multi-node options

Screen

Description

Axway Transfer

Select to enable multi-node architecture.

CFT: Multi-node

Enter the number of nodes. The first node is zero, and you may have up to four nodes.

Architecture

Enter the host name and address for each node, up to four nodes. You must enter at least one host.

Axway Transfer

Enter the license key for the Transfer CFT component.

CFT:

License key

If you have a license key issued for a previous version of Transfer CFT, enter your license key in the Key field and check the Check key option.

You can configure up to four keys. If you do not have a license key, you can select the check box.

Deselect Check key to continue with the installation without a key. However, you cannot run Transfer CFT until you supply the license key.

If you are installing in multi-node you require:

Note

l

One (1) valid key per node

l

Among the keys there must be at least one valid key per host

Back to core installation screens (Governance Mode).

For more general information on using multi-node features refer to the Transfer CFT User's Guide, in the topic About multi-node architecture.

Governance options

Screen

Description

Axway Transfer

Enable Central Governance connectivity:

CFT: Governance

Yes: Install Central Governance connectivity. For details, see the Central Governance topics in the Transfer CFT User's Guide.

 

l

Mode

 

l

No: Installs Transfer CFT without Central Governance. For details, click Connector options.

2 Install

Screen

Description

CG connectivity

This screen is only displayed if you enabled Central Governance connectivity. Enter values for the following parameters:

l

CG Host Address: Sets the server hostname on which the connector will connect

l

CG Port: Sets the port on which the connector will connect

l

Specify Custom Certificate: If selected, enter the certificate to authenticate Central Governance.

l

Shared Secret

l

Confirm Shared Secret

For general information on Central Governance, see the Governance services topic in the Transfer CFT User Guide.

Connector options

Screen

Description

Axway Transfer

Specify the connectors that you want to configure and activate:

CFT: Connectors

l

Sentinel

l

PKI with PassPort

l

Access Management with PassPort

Transfer CFT:

This screen is only displayed if you enabled Sentinel connectivity. Enter values for the following parameters:

Sentinel

Connector

l

Sentinel Host Address: Sets the Sentinel server hostname on which the connector will connect to

l

Sentinel Port: Sets the Sentinel Server port on which the connector will connect to

Connector parameters

l

Log Filter

l

Transfer Filter: Select the level of information, warning, error and fatal messages you want to receive: All, Summary, No

l

Enable Sentinel Heartbeat: Check to enable

2 Install

Screen

Description

Transfer CFT:

This screen is only displayed if you enabled PassPort PKI connectivity. Enter values for the following parameters:

PassPort PKI

connector

l

PKI Server Host Address: Sets the PassPort server hostname on which the connector will connect.

l

PKI Server Port: Sets the PassPort PS port (PS socket server port, or PS secure socket server port) on which the connector will connect.

 

o

Use SSL

o

PKI server public certificate

o

Copy certificate

o

PKI server login

o

PKI Server Password

o

Confirm PKI Server Password

Transfer CFT:

This screen is only displayed if you enabled PassPort AM connectivity. Enter values for the following parameters:

PassPort Access

Management

l

AM Server Host Address: Sets the PassPort server hostname on which the connector will connect.

connector

 

l

AM Server Port: Sets the PassPort AM server port (API server, or secure API server) on which the connector will connect.

o

o

o

o

o

o

o

Use SSL

AM Server public certificate

Component instance

Domain

Component Login

Component Password

Confirm Password

2 Install

Installing services in command line

Windows only

Transfer CFT services

1. To install the Transfer CFT service access the Transfer CFT directory:

cd %TransferCFT_directory%

2. Enter the following:

cscript /nologo \home\bin\cftsrvin.vbs n=CFT310

Where n= <CFT plus the current version of Transfer CFT>

Copilot services

From the Transfer CFT home directory, run:

copsrv.exe -install <service_name> <displayname> <cftdirruntime>

Example

For Transfer CFT version 3.2.2 Copilot you would enter:

c:\CFT313\Transfer_CFT\home\bin>copsrv.exe -install CFT_Copilot313 CFT_Copilot31

c:\CFT313\Transfer_CFT\runtime

Using NFSv3 in an active/passive architecture

The recommendations in this topic apply to a Transfer CFT active/passive mono-node architecture based on an NFSv3 shared file system.

l

Required NFSv3 mount options

l

Mount options summary

l

Synchronous / asynchronous option impact

Required NFSv3 mount options

Set the hard and nointr options

Mount NFSv3 using the hard and nointr options.

2 Install

Define file locking

Set locking to the nolock option so that Transfer CFT can lock files locally, but note that such locks provide exclusion only against other applications running on the same NFS client. The locks are not propagated to the server. In the case of a failover Transfer CFT can restart on the backup node.

Caution

Since locks are not propagated to the NFS server, do not perform write operation on Transfer CFT data files (UCONF settings, parameters and partners file, the catalog, and the com file) from another NFS client other than the one where the Transfer CFT instance is running.

Set the cto option

NFS implements a weak data consistency called "Close To Open consistency" or cto. This means that when a file is closed on a client, all modified data associated with the file is flushed from the server. If your NFS clients allow this behavior, be certain that the cto option is set.

Mount options summary

The following table summarizes the recommended NFSv3 mount options.

Correct option

Incorrect option

nolock (default)

"lock"

hard (default)

"soft"

nointr (not the default)

"intr"

cto (default)

"nocto"

Synchronous versus asynchronous option

To improve performance, NFS clients and NFS servers can delay file write operations in order to combine small file IOs into larger file IOs. You can enable this behavior on the NFS clients, NFS servers, or on both, using the async option. The sync option disables this behavior.

Client

On the client side, use the mount command to specify the async/sync option.

2 Install

Async

The NFS client treats the sync mount option differently than some other file systems. If neither sync nor async is specified (or if async is specified), the NFS client delays sending application writes to the server until any of the following events occur:

l

Memory limitations force reclaiming of system memory resources.

l

Transfer CFT explicitly flushes file data (PeSIT synchronization points, for example).

l

Transfer CFT closes a file.

This means that under normal circumstances, data written by Transfer CFT may not immediately appear on the server that hosts the file.

Sync

If the sync option is specified on a mount point, any system call that writes data to files on that mount point causes that data to be flushed to the server before the system call returns control to Transfer CFT. This provides greater data cache coherence among clients, but at a significant cost to performance.

Server

On the server side, use the exports command to specify the async/sync option (NFS server export table).

Async

The async option allows the NFS server to violate the NFS protocol and reply to requests before any changes made by that request have been committed to stable storage (the disk drive, for example), even if the client is set to sync. This option usually improves performance, however data may be lost or corrupted in the case of an unclean server restart, such as an NFS server crash.

This possible data corruption is not detectable at the time of occurrence, because the async option instructs the server to lie to the client, telling the client that all data was written to stable storage (regardless of the protocol used).

Sync

Enables replies to requests only after the changes have been committed to stable storage.

Note

For more information on these options, refer to NFS mount and export options in the UNIX man pages (for example, here).

2 Install

Synchronous / asynchronous option impact

Client

Server

Internal data

Transferable

Performance

 

data

Sync

Sync

1

1

Low

Sync

Async

2 (secure the NFS server)

2 (secure the NFS server)

Medium

Async

Sync

1 (if cft.server.catalog. sync.enable=Yes)

1 (when using sync points)

Medium - high

Async

Async

3

3

High

Legend:

l

1 = Secure

l

2 = Fairly secure

l

3 = Not secure

l

Internal data = Transfer CFT runtime files, such as the catalog

l

Transferable data = Files exchanged using Transfer CFT

Silent mode installation

Note

Windows only. If you have implemented a firewall, deactivate the firewall prior to installation in silent mode.

Silent mode enables you to perform an installation or configuration in a non-interactive mode. You do not have to enter any parameters in the GUI or console.

To use this mode, you must install the product or run the installer program and perform configuration until just before you click Install. Then in your home installation directory you will have the silent file template you can use to duplicate installations on other machines.

Silent file concepts

The purpose of using a silent file is to quickly duplicate an installation on multiple machines without running the installer and entering the same parameters over and over again.

The installer's silent mode takes these values from existing or generated silent files. Before you can use this procedure, you must have the necessary silent files available. You can generate these files by installing a product at least once by completing the dialogs up until the point of clicking Install.

2 Install

Creation

A

silent file can be created:

l

After an installation

or

l

After completing the installer dialogs up until the point of clicking Install

The installer's SilentFile directory contains the properties file (Install_Axway_Installer_ V4.8.0.properties) and the product property files you might need to install. You must not modify anything in this file except the InstallDir,SynchronyLogicalName and list of IncludeFiles. The product property files cannot be used outside of the main installer file.

Location

The silent file is created in:

<<install directory> >\SilentFile\<InstallationDateTime_Action>\<Install_ProductShortName_ V<Version>.properties

Where:

l

InstallationDateTime corresponds to Year_Month_Day_Hour_Minute_Second.

l

Action corresponds to the action done, for example if you performed an install or configure.

Variables

A silent file is a collection of parameters in the form of key-value pairs, each on one line. The variable

stores the name of the parameter (it is the key) and the value stores the other string.

The structure of a variable inside the silent file is:

Variable = Value

Note

The extra spaces around the variable are trimmed.

Some special types of variables can be identified.

Variable.Property = Value Variable.Default = <LinkToAnotherVariable> | Value

A variable property signifies or provides some additional information about that specific variable

(commonly known as metadata; it might be used for validation purposes, for parsing purposes, etc.).

For example, information on the creation date:

CreationDate = 13-02-2010

2 Install

CreationDate.Format = dd-MM-yyyy

Specify the creation date of the silent file (currently, the date the silent file was last modified by the build tool – effectively the date of the build used by the current kit) and below, the format used to parse this date variable (the format used by the date variable).

If a value is missing, the installer takes the default value instead. If the default value links to another variable, the link is replaced by the value of the linked variable (this is called a feedback link).

Encrypted variables

For security reasons, some variables (passwords) are encrypted in the silent case. This means the Format property contains the used encryption algorithm (default is plain).

l

If you want to change the value of an encrypted variable, you must use the silent file editor tool

l

You can disable the encryption of the variable by deleting the Format property

Environment variables

If you need to deploy a product installation on several machines, with only a few changes to make on the installation parameters, use the same silent file. In the silent file you can replace the unwanted parameters with environment variables that you defined on your machine before the installation. You can then use these variables instead of the Variable Values.

You can use environment variables when installing or configuring in Silent mode (limited to Silent mode only.)

l In Windows: %env_var%

There are restrictions for certain variables and therefore you cannot use an environment variable for the following parameters:

l

Component properties

l

Variable properties

l

Installer variables (in the file Install_Axway_Installer_VX.Y.Z.properties), except InstallDir,SynchronyLogicalName

Example

You can use any text editor or the Silent File Editor to modify variables in the silent file.

An example of changing the installation directory:

InstDir = C:\<install directory>\

InstDir.Type = String

InstDir2 = C:\<install directory>\Composer

InstDir2.default = <InstDir>/Composer

2 Install

Using silent mode

To run the installer in silent mode, you need the following commands:

Windows:

l

setup32.exe –s <the absolute path to the installer Silent File>

l

setup64.exe –s <the absolute path to the installer Silent File>

The installer's silent file is located in <install directory>/SilentFile/<DirectoryDate>/ after installation and is called Install_Axway_Installer_V<version>.properties.

The Silent File directory contains:

l

Installer properties file (Install_Axway_Installer_V<version>.properties)

l

Transfer CFT properties file (Install_Transfer_CFT_V<version>.properties)

l

The com.axway.installer folder

You should always call the Axway_Installer silent file from the command line regardless of the number of products you want to install. You can add or delete products from the silent installation if necessary, as long as they exist in the Silent File. Open the Axway_Installer properties file and scroll to the end. There are a number of IncludeFiles specifying the number of products included for an installation. You must not modify anything else in this file except the InstallDir, the SynchronyLogicalName and the list of IncludeFiles.

Follow these recommendations concerning a silent installation:

l

You must use the absolute path to the silent file and not the relative one

l

The command must point to the installer silent file and not the product silent file

l

The product silent files installed in silent mode must be in the same directory as the installer silent file

l

The com.axway.installer folder/directory must be in the same directory as the silent files

Install products silently in a directory with white spaces

In Windows, the installer supports the silent installation in a folder, for example (c:\Program Files), with white spaces if:

l All products in the Silent File allow white spaces, regardless of the other products present in the installation package (which are not listed in the Silent File)

The installer does not support installation in a folder with white spaces and the installation will stop if:

l At least one of the products in the Silent File does not allow white spaces, regardless of the other products present in the installation package (which are not listed in the Silent File)

Configure product in silent mode

To configure an installation in silent mode, you need the following commands:

2 Install

Windows:

l

configure32.exe –s <the absolute path to the installer Silent File>

l

configure64.exe –s <the absolute path to the installer Silent File>

Silent File Editor

Use the Silent File Editor to modify variables in a silent file. It can be used from the command line or the GUI.

The most common values that you replace when preparing a new installation using a silent file are the InstallDir and CommonDir variables. The value of these fields is used to concatenate other paths in the products silent file properties file.

Location

The Silent File Editor is in the installation directory in Tools/SilentFileEditor.

Note

Copying the Silent File Editor from the installation package is not supported because it uses binary files from the installer.

Modifying a silent file using the command line

To modify a silent file using the command line, run:

l In Windows: SilentFileEditor.bat

The parameters for the Silent File Editor are:

l

The path to the silent file that you want to modify

l

Three arguments in this format:

o

o

o

The first argument is the name of the variable that you want to modify (for example, DB_ ADMIN_PASSWORD). Each variable name given must exist in the silent file

The second argument is the value that you want to assign to the variable given as the first argument

The third argument is –c if the value is to be encrypted first and then saved in the silent file, or –u if the value does not need to be encrypted

You can have more than one group of arguments as shown in the examples below.

Example

SilentFileEditor.bat SilentFilePath varName1 value1 –c/-u varName2 value2 –c/-u … varNameN valueN –c/-u

2 Install

Modifying a Silent File using the user interface

Starting the GUI

To start the Silent File Editor GUI, run SilentFileEditorGUI.bat or SilentFileEditorGUI.sh at <installation directory>\Tools\SilentFileEditor.

Using the GUI

The GUI displays the list of variables and values in the silent file.

Use File > Open to open the silent file you want to edit.

From the Tools menu you can:

l

Encrypt Selected: Encrypts the Values selected with the AES128 algorithm

l

Undo Selected: Undoes the changes made on the current selection

l

Undo all changes: Undoes all changes made on the current selection

l

Replace: Finds a variable and replaces it with the value you select. Inside of the Replace command there are other options:

l

Replace all: Replaces all paths in all the variable values

l

Find next: Goes to the next value occurrence and if you click Replace it replaces the value

l

Encrypt: Encrypts the value in the Replace Value with field

Once you have completed all the modifications, use File > Save to save the silent file, then File > Exit to quit the Silent File Editor UI.

Installer functions

Installer functions

This section describe functions you can perform with the installer.

Display command

The display command lists information about all installed products. The command is named display.bat on Windows and display.sh on UNIX and Linux. Run it from the root installation directory.

When run without parameters, the command lists all installed products and versions and all applied service packs.

Use the name parameter to display the installation history of a single product. For example:

2 Install

display -n <product name>

Install product

To start the installer to install a product:

Locate and run the setup file in the root folder of the installation package you downloaded from the Axway support site and uncompressed or unzipped.

GUI mode

l Windows: setup32.exe or setup64.exe

Console mode

l Windows: setup32.exe -m console or setup64.exe -m console

setup32.exe is a 32-bit build executable and will run on a 64-bit platform provided that the compatibility layer has been installed.

Windows installations

The same user that did the initial installation (or at least the same type of user) must start the installer.

Services modification

Some products support an installation in service mode with a user other than the default (Local System Account).

If the domain field is not shown in the products service configuration dialog, then it must be introduced in the username field, using this format:

<domain>\<username>

If it is a local user (a user that was created on the local machine) then the <domain> field can be . or the <hostname>.

Example

Local user: user1

.\user1

<hostname>\user1

Network user: user2

<domain_name>\user2

Configure product

This section describes running the installer in configure mode to change a product's configuration.

2 Install

The following describes running the installer in configure mode.

GUI mode

l Windows: In Windows Start menu, select Axway Software > Axway [installation name] > Configure

Console mode

l Windows:

o

o

Note

configure32.exe –m console

configure64.exe –m console

If you do not want to use either the GUI or console modes to configure your installation, refer to the Silent mode.

About host name

Host name corresponds to the object assigned to a physical server. In the installer, host name is required for the following reasons:

l

In a license key page, to validate that the entered key matches the host name. In this case, enter only the host name (without the domain name) and make sure not to confuse Hostname with Logical Server Name.

l

In a page where you configure which network interface the product is going to listen for an incoming connection. In this case, enter one of the following values:

 

o

Host name

o

The fully qualified name (host name and domain name)

o

IP address of the machine

o

Specific string (0.0.0.0 or *) indicating that you want the product to listen on all network interfaces if your machine has more than one

o

Logical host name or IP address if you are doing an installation on a machine that is part of a cluster

l

In a page where you configure how your product is going to connect to another product. In this case, it is strongly recommended to use either the fully qualified name or the IP address of the remote machine. If the remote machine you are connecting to is a cluster, then use the logical, fully qualified cluster host name or IP address.

Using a temporary directory

The installer needs a temporary directory when it starts to unzip and prepare the environment it requires for product or update installation. The temporary directory it uses is the first %TMPDIR%, %TMP% or %TEMP% environment variable that is not null. It is very important that the value of the variable does not contain any spaces. If it does, a NullPointerException java error occurs.

2 Install

You can force the use of another temporary directory by setting the following environment variable, TEMPORARY_DIR.

If you do this make sure the temporary directory has:

l

Enough disk space

l

Read/write access for starting the installer

Installation modes

You can use the following installer installation modes.

l

GUI mode is supported on Windows, UNIX and Linux. However, to use on UNIX platforms, the installer requires an X-Window environment. To use an X-Window distributed environment, you must export the DISPLAY environment variable: export DISPLAY=myhost.mydomain:0.0

l

Console mode displays a series of prompts requiring user responses or actions.

l

Silent mode enables you to perform an installation or configuration in a non-interactive mode. You do not have to enter any parameters in the GUI or console.

Installer functions

The installer command files are for invoking installer functions in GUI or console mode.

Before installing, install is the only available function, invoked with the setup file in the root directory of the installation package.

After installing, the configure, update and uninstall functions are available. The scripts for those functions are in the root installation directory.

Function

Mode

UNIX/Linux

Windows

Install

GUI

setup.sh

setup32.exe

 

setup64.exe

 

Console

setup.sh –m console

setup32 –m console

 

setup64 –m console

Configure

GUI

configure.sh

configure32.exe

 

configure64.exe

 

Console

configure.sh –m

configure32.exe –m

 

console

console

 

configure64.exe –m

console

2 Install

Function

Mode

UNIX/Linux

Windows

Update

GUI

update.sh

update32.exe

 

update64.exe

 

Console

update.sh –m console update32 –m console

 

update64 –m console

Uninstall

GUI

uninstall.sh

uninstall32.exe

 

uninstall64.exe

 

Console

uninstall.sh –m console uninstall32.exe –m console

uninstall64.exe –m console

The configure function lets you change settings that were applied during installation.

The update function lets you apply or remove service packs and patches.

After installing the following functions are available:

l

Install product

l

Configure product

l

Update product and Remove updates

l

Uninstall product

l

Transfer installation packages on remote machines

JRE customization

To avoid compatibility issues for a product based on Java, Axway provides the correct JRE, which is installed during the product installation. However, a lightweight installer does not have a JRE. You start the installer with the JRE already installed on your machine. In other words, the installer runs with an external rather than internal JRE.

The advantages are that it allows you more flexibility and saves you on disk space storage.

The infrastructure dependent artifact of the installer is separated into two artifacts (tools and java).

All Axway products can use an external JRE. This is specifically useful for C coded products as downloading the JREs is no longer mandatory as part of an installation kit.

Installer-dependent deliverables

The installer-dependent artifacts are split in two parts (tools and java), now that using a standard JRE is optional.

The names of the two artifacts have not changed from the previous ones except they have a -tools and -java suffix:

2 Install

l

The Axway_Installer_VG.M.m_<platform>-tools artifact contains the necessary tools required by the installer which are platform specific and are still mandatory in the installation kit.

l

The Axway_Installer_VG.M.m_<platform>-java artifact contains the standard JREs delivered by the installer which are platform specific and are now optional.

Run the installer using an external JRE

To run the installer with an external JRE:

l

Set the AXWAY_JAVA_HOME environment variable or JAVA_HOME environment variable.

l

The installer starts in the following order of precedence with the JRE specified in the:

l

Installation kit in the Java/<platform> folder

l

AXWAY_JAVA_HOME

l

JAVA_HOME

The environment variables need to point to the root of the JRE installation. The Java instance will run from <ENV_VAR_PATH>/bin/java.

Run a product using an external JRE

This section describes running products after installing in various modes.

Normal installation

When you perform a clean installation with the installer using an external JRE, all installed products are configured to use the external JRE. This also means the installer cannot install products that do not support the external JRE.

When you run the installer with either an internal or external JRE for the purpose of managing an existing installation (adding additional features or products), all the products including the newly installed ones will use the JRE configured for the existing installation and not the JRE configured to run with the installer.

When you run the installer in configure mode, it does not apply any changes on the type of internal JRE used. If the installation is configured to use an external JRE, all products will be reconfigured to use the new paths specified in the environment variables.

Caution

To set the JRE, the installer uses the path specified in the environment variable at install time, not the environment variable itself. This means that any manual changes you make to the environment variables will not be taken into account. If you want to change the external JRE used by an installation you need to first change the value of the environment variable and then run installer in Configure mode on that installation.

Note that some products do not currently support reconfiguring the Java path. It means that for these products, the Java path cannot be modified using the installer and, if necessary, will have to be done manually.

2 Install

Caution

Do not modify or delete the paths specified in the environment variables used to set the external JRE after installation. If you make any changes to these paths, it will directly affect the functioning of all the installations configured to use them. You should handle any modifications to these environment variables and Java paths with extreme caution.

Silent installation

The parameters from silent files used for specifying the JRE to use will always be overwritten depending on the context of the installation:

For example if you have silent files made from a package which contained Java and a silent installation that is generated with a package without the embedded Java:

l

The installer re-computes the Java paths required by the products, and transparently ignores the corresponding settings in the silent file (if any)

l

The reverse case is handled in the same manner

Post-installation

3

After installing Transfer CFT, but before starting Transfer CFT and the Copilot server, you may need to perform the following tasks:

l

Perform an update

l

Create a basic configuration

Otherwise you can go to:

l

Start the Transfer CFT Copilot server on page 45

l

Start Transfer CFT on page 45

For information on user rights, refer to the topic Defining user rights UNIX in the Transfer CFT User Guide.

Perform an update

If you need to apply service packs or patches, refer to Update Transfer CFT.

If you have already started Transfer CFT or Copilot, stop these servers prior to performing an update.

Create a basic configuration

This section describes how to create a basic Transfer CFT configuration if you did not do so during the installation process. If you started Transfer CFT or Copilot, stop these servers before modifying the configuration.

Update the profile

To add environment variables to your Transfer CFT profile edit the following script:

l Windows: <CFTDIRRUNTIME>\profile.bat

UCONF

To determine the Transfer CFT variable values list the values using the command:

CFTUTIL listuconf

3 Post-installation

To change or update a value, start the Transfer CFT profile and make modifications using either the Transfer CFT Copilot UI or command line UCONF tools.

For example, to change the user interface port:

CFTUTIL uconfset id=copilot.general.serverport,value=1766

Configuration

Before you can start Transfer CFT for the first time, Transfer CFT must have a basic configuration. Typically this is created during installation or migration.

License key

If you did not enter the license key during installation, you can enter it post installation in a cft.key file in: <CFTDIRRUNTIME>/conf/

You can enter a single key or a list of keys in this file. In the configuration default file, the variable <$CFTKEY> represents the cft.key file.

Transfer CFT internal datafile and configuration

Check the values, especially the key value, hostname, and port for TCP, in the following file:

l Windows and UNIX: <CFTRUNTIME>/conf/cft-tcp.conf

Start the Transfer CFT profile and, to create the Transfer CFT internal datafile and update the basic configuration, execute:

cftinit cft-tcp.conf

To update the configuration at a later date, execute:

cftupdate cft-tcp.conf

User interface configuration

To view the Copilot user interface configuration, execute:

CFTUTIL LISTUCONF id=copilot*

3 Post-installation

To change this configuration, you update the hostname and listening port for Transfer CFT UI using CFTUTIL uconfset.

Example

CFTUTIL uconfset id=copilot.general.serverhost, value="127.0.0.1" CFTUTIL uconfset id=copilot.general.serverport, value="7000"

Refer to the Transfer CFT User Guide for details.

Configuration for Service Mode

This option is only available on Windows systems and must be selected during the installation process configuration.

Start the Transfer CFT Copilot server

If you have implemented Central Governance, starting Copilot launches the registration process. For more information, see the topic Registering with Central Governance in the Transfer CFT User Guide

Windows

1. Change directory to the runtime.

2. Execute profile.bat.

3. To start the Copilot server, enter: copstart

4. To check the Copilot status, enter: copstatus -v

Start Transfer CFT

If you have implemented Central Governance, you can start and stop Transfer CFT via the Central Unified Flow Management user interface. Otherwise perform the following command from the Transfer CFT runtime directory.

Enter:

cft start

Update

4

This section describes how to update Transfer CFT with a patch or service pack. You can manually perform the operation, or use Central Governance.

For more information, please refer to the Central Governance documentation.

Use Central Governance for updates

You can easily perform Transfer CFT updates and apply Service Packs using Central Governance. Please see the Central Governance documentation for details. However note that you cannot remove SP or patches via the Central Governance interface.

Installer or products patches and service packs

If you install a service pack or patch for the installer, make sure all Windows services created by the installer are stopped.

Stop Transfer CFT prior to installing a service pack or patch.

Check product details

To check the version, or product details prior to updating, use the display command.

The display command lists information about all installed products.

l

Run the command from the root installation directory.

l

When you run this command without parameters, the command lists all installed products and versions, and all applied service packs.

Use the name parameter to display the installation history of a single product.

Windows

display.bat

UNIX

./display.sh

4 Update

Windows updates

The same user that did the initial installation (or at least the same type of user) must start the update procedure.

Services modification

Some products support an installation in service mode with a user other than the default (Local System Account).

If the domain field is not shown in the products service configuration dialog, then it must be introduced in the username field, using this format:

<domain>\<username>

If it is a local user (a user that was created on the local machine) then the <domain> field can be . or the <hostname>.

Example

Local user: user1

.\user1

<hostname>\user1

Network user: user2

<domain_name>\user2

Update procedure in GUI mode

1. Download product updates from the Axway support website at https://support.axway.com/ to the machine you want to update.

2. Stop the servers that you want to change.

3. Run the installer in update mode. Use the following commands:

l

Windows: In Windows Start menu, select Axway Software > Axway <InstallationName> > Update

l

Using the Console: Change to the installation directory you want to update and run update.exe

4.

Manage your updates. In the Updates Management page you have the following possibilities:

l

Select a directory: Select the directory or zip archive file containing all the updates you want to install.

l

Select file: Select the update file you want to install. The file can be a .jar file or a zip archive of .jar files.

Note

The installer allows the .zip file format containing the Service Packs to apply to more than one product in the same installation package.

l

Information: Click to open the readme file.

5. Click Next to continue.

6. Review the updates you want to install.

4 Update

7.

To apply the update, click Update.

8.

A warning message appears. Click Yes to continue.

9.

After the updates are installed, click Next to view the summary.

10.

Review the summary and click OK to exit the installer.

11.

View log file. The installation of updates are tracked in the updates.log file, located in your home directory.

Remove an update

This section describes uninstalling a patch or service pack. You can uninstall updates in GUI or console mode, depending on your operating system.

Remove updates in GUI mode

1. Run the installer in update mode.

In the Windows Start menu, select Axway Software > Axway <InstallationName> > Update

2. On the Updates Management page, Select the update you want to uninstall and click Remove. The update changes from blue when first selected to gray.

3. Click Next to continue.

4. Review the updates you want to uninstall. To remove the update, click Update.

5. After the updates have been uninstalled, click Next to view the summary. It displays the list of updates that were removed.

Remove updates in console mode

For Windows environment:

1. From the installation root directory, launch the installer in update mode: update32.exe –m gui or update64.exe –m gui if running on a 64-bit executable.

2. Follow the preceding steps for uninstalling an update.

Upgrade or migrate

5

Upgrade and migration overview

This chapter is designed to assist administrators or users who are tasked with upgrading or migrating from an existing Transfer CFT version to Transfer CFT 3.2.2.

The Transfer CFT versions that are available to migrate include 2.3.2, 2.4, 2.5, 2.6, 2.7, 3.0.1 and

3.1.2.

Note

If you are migrating from a previous version of Transfer CFT, be sure to check the Release Notes for new features as well as deprecated features and supported platforms per release.

Migrating or upgrading to enable Central Governance

Central Governance simplifies the management of Transfer CFT and provides identity and access management, certificate security services, monitoring, alerting, and web dashboard services. Central Governance replaces possible existing services from earlier Transfer CFT installations that required implementing and configuring multiple products, such as Transfer CFT Navigator, PassPort, Composer, and Sentinel.

If you are performing an upgrade or migration to Transfer CFT 3.2 you can then use the Activate Central Unified Flow Management connectivity information to configure and register with Central Governance.

Migration versus an upgrade

Migration options

There are three methods available for updating your Transfer CFT product version.

l

Upgrade (existing)

l

Automatic migration

l

Manual migration

About upgrades

An upgrade is the process of updating to a newer, enhanced version of the software.

5 Upgrade or migrate

Axway provides Upgrade Packs for products to simplify the process of updating from a previous version. When upgrading, you run the Axway Installer to apply the Upgrade Pack using a procedure that is similar to updating an Axway product. For more information, go to Upgrading Transfer CFT or Upgrading Transfer CFT in multi-node architecture.

This mode has the following advantages:

l

Allows you to update in the same location

l

You can perform this automatically using the Installer, and you can revert to previous state if needed

l

Scripts and APIs remain intact and only require a recompilation for the APIs

This mode has the following restriction:

l

You must uninstall the upgrade pack if you need to rollback.

l

You cannot upgrade on versions older than version 2.6.x.

About migrations

A migration means that an initial Transfer CFT is installed in a directory that is not removed or overwritten by the procedure. You can use the OS-appropriate installation kit to install the Transfer CFT 3.2.2 in a new directory, and select the installation option to migrate the existing configuration to this new version. You are only required to provide the path of the Transfer CFT (n-1) version to retrieve this old configuration.

About install and automatic import

You can use an automatic installation procedure to migrate from your current version of Transfer CFT to Transfer CFT 3.2.2. This auto-migration procedure occurs when you perform the Transfer CFT 3.2.2 installation.

This mode has the following advantages:

l

The new installation occurs in a new location, and existing configuration elements and data can be automatically imported

l

You can install and auto import from versions older than version 2.6.x.

l

You can choose to use either of the versions, if needed, in case of an issue with one of the installations

Note

Configuration and data, such as the catalog, are in two separate locations and data are not shared.

This mode has the following restriction:

l You must copy scripts and APIs from the previous version to the new installation.

About manual migrations

A manual migration procedure, also used for migrating your existing Transfer CFT to Transfer CFT 3.2.2, is available and described in this document.

5 Upgrade or migrate

The general procedure for migrating from a previous version of Transfer CFT to Transfer CFT 3.2.2 is as follows:

1. Export existing information from the previous version. Details vary depending on the existing Transfer CFT version.

2. Import the exported information into Transfer CFT 3.2.2.

This mode has the following advantages:

l

Because it is manual, you can customize as needed.

l

You can manually migrate from versions older than version 2.6.x.

Check product details

To check the version, or product details prior to updating, use the display command.

The display command lists information about all installed products.

l

Run the command from the root installation directory.

l

When you run this command without parameters, the command lists all installed products and versions, and all applied service packs.

Use the name parameter to display the installation history of a single product.

Windows

display.bat

UNIX

./display.sh

More information

If you encounter issues when migrating Transfer CFT, contact Axway Support at https://support.axway.com.

5 Upgrade or migrate

Upgrade Transfer CFT

This section explains how to upgrade an existing Transfer CFT from 2.6.x, 2.7.x, 3.0.1, 3.1.3 to a Transfer CFT3.2.2. It begins by detailing the prerequisites for a standalone (non multi-node) upgrade. For details on upgrading a multi-node installation, see Upgrade a multi-node installation on page 64.

About upgrades

Transfer CFT 3.1.3 introduced the CUP, Composite Upgrade Package, feature. This functionality enables you to upgrade both the installer and the product simultaneously.

Before you start

Before beginning the upgrade procedure:

l

You require the product and Installer version number and SP level in order to choose the appropriate procedure. See the section Determine the Installer and product version.

l

Download the Transfer CFT Upgrade Pack, available on Axway Support at https://support.axway.com. The Transfer CFT Upgrade Pack name has the general format Transfer_CFT_3.2.2_UP****-from-3.1.3_*****_BN*****.zip, where ** is the UP number.

l

Stop the Transfer CFT server and the Transfer CFT GUI server, by entering:

 

o

cftstop

o

copstop -f

l

Determine your Axway installer and product versions. The version dictates which of the following Transfer CFT upgrade procedures is correct for you.

Note

Windows: When upgrading, the same type of user that did the initial installation must start the installer.

Determine the Installer and product version

You should determine the product and Installer version and SP level prior to upgrading. You can use the following procedure on any version of the Axway Installer. For more information on the Installer,

see also Installer functions on page 36 and JRE customization on page 40 .

Start the Axway Installer. The command depends on the Installer version and your OS, as follows:

l Versions lower than 4.5.x:

o

o

Windows: setupwin32.exe update

Unix: update.sh update

5 Upgrade or migrate

l Version 4.5.x or higher:

o

o

Windows: update32/64.exe

Unix: update. sh

Accept the license and click Next to continue. In the Product list, check the:

l

Axway Installer version and the most recently installed SP level

l

Transfer CFT version and the most recently installed SP level

Display product information

The display command lists information about all installed products.

l

Run the command from the root installation directory.

l

When you run this command without parameters, the command lists all installed products and versions, and all applied service packs.

Use the name parameter to display the installation history of a single product.

Windows

display.bat

UNIX

./display.sh

Windows Application Experience recommendation

The "Application Experience" service should be enabled when using Transfer CFT. Otherwise you may encounter issues in accessing files when installing/upgrading the product.