Transfer CFT 3.2.2 Installation Guide Windows

 Transfer CFT Windows
Version 3.2.2
5 October 2017
User Guide
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 CFT documentation set
2
Support services
2
Accessibility
Accessibility features of the documentation
3
3
Screen reader support
3
Support for high contrast and accessible use of colors
3
1 Prerequisites
Overview
5
5
License keys
5
End User License Agreement
5
Check your authorization
5
Windows x86 operating system prerequisite
6
System requirements
7
About the Transfer CFT environment
7
Disk space and RAM requirements
7
Java
7
Installer screen resolution
8
Pre-installation
Windows requirements
Cluster installation requirements
9
9
10
Default ports
12
Certificates
14
2 Install
Before you start
15
15
Installation package contents
15
Installation functions
15
Installation modes
16
Installed directories
16
Windows x86 operating system prerequisite
16
Install Transfer CFT
17
Start the installation
17
Cluster mode screens
22
Transfer CFT 3.2.2
Installation and Operation Guide 3
Auto import screens
22
Multi-node options
24
Governance options
24
Connector options
25
Installing services in command line
27
Using NFSv3 in an active/passive architecture
27
Silent mode installation
30
Installer functions
35
Installer functions
35
JRE customization
39
3 Post-installation
42
Perform an update
42
Create a basic configuration
42
Update the profile
42
UCONF
42
Configuration
43
License key
43
Transfer CFT internal datafile and configuration
43
User interface configuration
43
Configuration for Service Mode
44
Start the Transfer CFT Copilot server
44
Start Transfer CFT
44
4 Update
45
Use Central Governance for updates
45
Installer or products patches and service packs
45
Check product details
45
Windows updates
46
Update procedure in GUI mode
46
Remove an update
47
Remove updates in GUI mode
47
Remove updates in console mode
47
Update a multi-node installation on multiple hosts
5 Upgrade or migrate
Overview of migrations and upgrades
47
49
49
Migrating or upgrading to enable Central Governance
49
Migration versus an upgrade
49
Upgrade Transfer CFT
52
About upgrades
52
Before you start
52
Transfer CFT 2.6.4 to 3.2.2
54
Transfer CFT 2.7.1 to 3.2.2
57
Transfer CFT 3.2.2
Installation and Operation Guide 4
Transfer CFT 3.0.1 to 3.2.2
60
Transfer CFT 3 .1.3 to 3.2.2
62
Post upgrade
64
Upgrade a Transfer CFT multi-node installation
65
Before you start
65
Upgrade from Transfer CFT 3.0.1 multi-node
66
Upgrade from Transfer CFT 3.1.2 or 3.1.3 multi-node
68
Prerequisites
70
Important information before performing a migration procedure
70
Windows x86 operating system prerequisite
71
Install and auto import
71
General procedure
71
Auto import in multi-node architecture
73
Perform a manual migration
75
Prerequisites
75
Migrating from Transfer CFT 2.3.2
75
Migrating from Transfer CFT 2.4
78
Migrate from Transfer CFT 2.5 or 2.6
82
Migrating from Transfer CFT 2.6.4 SP2 or 2.7
85
Migrating from Transfer CFT 3.0.1 or 3.1.2
87
Activate Central Governance connectivity
91
Overview
92
Automatically activate connectivity
92
Manually activate connectivity
93
Connect to a different Central Governance system
95
Use former configuration objects
96
View managed features
96
Post-migration procedure
97
Post manual migration or auto import
97
Post manual migration only
98
Post upgrade
98
6 Uninstall
About uninstalling in Windows
7 Deployment packages
99
99
101
Create a product deployment package
101
Install a template Transfer CFT
101
Generate the Express Package
102
Customize the Express Package
103
Install the Express Package
104
Limitations
105
Transfer CFT 3.2.2
Installation and Operation Guide 5
8 Troubleshooting
Troubleshoot installation and registration
106
106
Copilot server issues
106
Central Governance
106
Transfer CFT server
107
Applying a license key
108
Obtain a license key
108
Apply a license key
108
Support tools and contacting Support
109
Accessing the Axway Support site
109
Using CFT_support
109
Transfer CFT 3.2.2
Installation and Operation Guide 6
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. Transfer CFT 3.2.2
Installation and Operation Guide 1
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
Transfer CFT 3.2.2
Installation and Operation Guide 2
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.
Transfer CFT 3.2.2
Installation and Operation Guide 3
Accessibility
4 Installation and Operation Guide
Transfer CFT 3.2.2
Prerequisites
1
Overview
Axway p roducts 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:
Transfer CFT 3.2.2
Installation and Operation Guide 5
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
Transfer CFT 3.2.2
If the redistribution package is already installed on your Windows system, there is no need to reinstall.
Installation and Operation Guide 6
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 Copilot 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. Transfer CFT 3.2.2
Installation and Operation Guide 7
1 Prerequisites
Installer screen resolution
When the Installer is run in GUI mode, a resolution of at least 800 x 600 is required.
Transfer CFT 3.2.2
Installation and Operation Guide 8
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
Transfer CFT 3.2.2
Installation and Operation Guide 9
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.
Transfer CFT 3.2.2
Installation and Operation Guide 10
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
Transfer CFT 3.2.2
Installation and Operation Guide 11
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-portnumbers/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
Secure Relay RA
6801
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 Transfer CFT 3.2.2
Installation and Operation Guide 12
1 Prerequisites
authentication)
l Central Governance: Used to connect to Central Governance
Transfer CFT 3.2.2
Installation and Operation Guide 13
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 Relay
<Transfer_CFT>/home/distrib/xsr
SecureRelayCA.pem November 2021
SecureRelayMasterAgent.p12
November 2021
Central Governance
<Transfer_CFT>/runtime/conf/pki
passportCA.pem
November 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)
Transfer CFT 3.2.2
Installation and Operation Guide 14
Install
2
Before you start
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 Axway Managed File Transfer solution, you may want to check the installation order and prerequisites. For more information, please refer to the Central Governance d ocumentation.
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
Transfer CFT 3.2.2
Installation and Operation Guide 15
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
Transfer CFT 3.2.2
If the redistribution package is already installed on your Windows system, there is no need to reinstall.
Installation and Operation Guide 16
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.
This table displays a basic installation, a standalone Transfer CFT, with no options.
Transfer CFT 3.2.2
Installation and Operation Guide 17
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 architecture
Select to install on either a single machine, or a cluster mode installation. Note
If you select cluster, additional screens display. Installation directory
Where product files and documentation will reside.
Axway Transfer CFT: Installation directory Specify the directory where you want to install Transfer CFT.
By default, Transfer CFT is installed in a sub-directory o f the Axway installation directory. Use the default directory, or specify a new directory.
Directory paths cannot contain spaces.
Axway Transfer CFT: Runtime directory Specify the directory where you want to install the Transfer CFT runtime directory.
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.
Axway Transfer CFT: Auto Import
Specify if you want to import data from an existing Transfer CFT by selecting Yes or No.
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
Axway Transfer CFT: Identity
Transfer CFT 3.2.2
If you select Yes in the Auto Import screen, additional screens display.
Check or modify the supplied information concerting the Transfer CFT instance name, group name, and host address.
An asterisk * denotes that these fields are mandatory.
Installation and Operation Guide 18
2 Install
Screen
Description
Axway Transfer CFT: Multi-node Architecture
Select to enable multi-node architecture.
Enter the number of nodes. The first node is zero, and you may have up to four nodes. Enter the host name and address for each node, up to four nodes. You must enter at least one host. Note
Axway Transfer CFT: License key
If you enter a number to enable multi-node, additional screens display. Enter the license key for the Transfer CFT product.
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 o ption.
You can configure up to four keys. 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 CFT: Governance Mode
Enable Central Governance connectivity:
l Yes: Install Central Governance connectivity. For details, see the Central Governance topics in the Transfer CFT User's Guide.
l No: Installs Transfer CFT without Central Governance. Axway Transfer CFT: Configuration
Enter the TCP parameters for the host, PeSIT protocol, catalog, and communication media.
l Synchronous communication: enter the COMS port
l PESITANY: Enter the PeSIT protocol port number
l Select the default database size:
o Catalog: Modify the default catalog file size
o Communication File: Modify the default communication file size
Transfer CFT 3.2.2
Installation and Operation Guide 19
2 Install
Screen
Description
Axway Transfer CFT: User Interface Server
Enter the Transfer CFT UI Server values:
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.
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: 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.
Transfer CFT 3.2.2
Installation and Operation Guide 20
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 o r 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 CFT: Shortcuts
This screen enables you to install Start Menu shortcuts.
l Yes: Creates 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 CFT: Connectors
This screen allows you to select from the following Axway product connectors:
l Sentinel
l Public Key Infrastructure with PassPort l Access management with PassPort
Note
Axway Transfer CFT: Ready to install
Transfer CFT 3.2.2
If you select any of the available connectors, additional screens display. Click Install to complete the installation process, or Previous to review or modify installation options. Installation and Operation Guide 21
2 Install
Cluster mode screens
Screen
Description
Installation architecture
Select either:
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 directories
Specify the root and shared directories where you want to install the product files and where the documentation will reside.
Directory paths cannot contain spaces.
Axway Transfer CFT: Installation directory Specify the directory where you want to install Transfer CFT.
By default, Transfer CFT is installed in a sub-directory o f the Axway
installation directory. Use the default directory, or specify a new directory.
Select the directory that will store shared data between the cluster nodes.
Directory paths cannot contain spaces.
Axway Transfer CFT: Runtime directory Specify the directory where you want to install the Transfer CFT runtime directory.
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.
Auto import screens
If you select Yes in the Auto import screen, the following Installer pages display. Transfer CFT 3.2.2
Installation and Operation Guide 22
2 Install
Screen
Description
Axway Transfer CFT: Migration
Specify if you want to import data from an existing Transfer CFT by 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 CFT: Migration
Specify the path to the profile file.
Axway Transfer CFT: Migration Options
This screen is only displayed during a migration operation. You 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.
Transfer CFT 3.2.2
Installation and Operation Guide 23
2 Install
Multi-node options
Screen
Description
Axway Transfer CFT: Multi-node Architecture
Select to enable multi-node architecture.
Enter the number of nodes. The first node is zero, and you may have up to four nodes. Enter the host name and address for each node, up to four nodes. You must enter at least one host. Axway Transfer CFT: License key
Enter the license key for the Transfer CFT component.
If you have a license key issued for a previous version of Transfer CFT, enter your license key in the Key field and c heck the Check key o ption.
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.
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
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 CFT: Governance Mode
Enable Central Governance connectivity:
l Yes: Install Central Governance connectivity. For details, see the Central Governance topics in the Transfer CFT User's Guide.
l No: Installs Transfer CFT without Central Governance. For details, click Connector options. Transfer CFT 3.2.2
Installation and Operation Guide 24
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 CFT: Connectors
Specify the connectors that you want to configure and activate:
l Sentinel
l PKI with PassPort
l Access Management with PassPort
Transfer CFT:
Sentinel Connector
This screen is only displayed if you enabled Sentinel connectivity. Enter values for the following parameters:
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
Transfer CFT 3.2.2
Installation and Operation Guide 25
2 Install
Screen
Description
Transfer CFT:
PassPort PKI connector
This screen is only displayed if you enabled PassPort PKI connectivity. Enter values for the following parameters:
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:
PassPort Access Management connector
This screen is only displayed if you enabled PassPort AM connectivity. Enter values for the following parameters:
l AM Server Host Address: Sets the PassPort server hostname on which the connector will connect.
l AM Server Port: Sets the PassPort AM server port (API server, or secure API server) on which the connector will connect.
o Use SSL o AM Server public certificate
o Component instance
o Domain
o Component Login
o Component Password
o Confirm P assword
Transfer CFT 3.2.2
Installation and Operation Guide 26
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. Transfer CFT 3.2.2
Installation and Operation Guide 27
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.
Transfer CFT 3.2.2
Installation and Operation Guide 28
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 d ata 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
Transfer CFT 3.2.2
For more information on these options, refer to NFS mount and export options in the UNIX man pages (for example, here).
Installation and Operation Guide 29
2 Install
Synchronous / asynchronous option impact
Client
Server
Internal data
Transferable
data
Performance
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.
Transfer CFT 3.2.2
Installation and Operation Guide 30
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
Transfer CFT 3.2.2
Installation and Operation Guide 31
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
Transfer CFT 3.2.2
Installation and Operation Guide 32
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: Transfer CFT 3.2.2
Installation and Operation Guide 33
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 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
o The second argument is the value that you want to assign to the variable given as the first argument
o 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
Transfer CFT 3.2.2
Installation and Operation Guide 34
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:
Transfer CFT 3.2.2
Installation and Operation Guide 35
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.
Transfer CFT 3.2.2
Installation and Operation Guide 36
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 configure32.exe –m console
o configure64.exe –m console
Note
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.
Transfer CFT 3.2.2
Installation and Operation Guide 37
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
Install
Mode
GUI
UNIX/Linux
setup.sh
Windows
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 console
configure32.exe –m console
configure64.exe –m console
Transfer CFT 3.2.2
Installation and Operation Guide 38
2 Install
Function
Update
Mode
GUI
UNIX/Linux
update.sh
Windows
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:
Transfer CFT 3.2.2
Installation and Operation Guide 39
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.
Transfer CFT 3.2.2
Installation and Operation Guide 40
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
Transfer CFT 3.2.2
Installation and Operation Guide 41
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 44 l Start Transfer CFT on page 44
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
Transfer CFT 3.2.2
Installation and Operation Guide 42
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 c onfiguration, execute: CFTUTIL LISTUCONF id=copilot*
To change this configuration, you update the hostname and listening p ort for Transfer CFT UI using CFTUTIL uconfset.
Transfer CFT 3.2.2
Installation and Operation Guide 43
3 Post-installation
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 d irectory 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
Transfer CFT 3.2.2
Installation and Operation Guide 44
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 d ocumentation.
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
Transfer CFT 3.2.2
Installation and Operation Guide 45
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. Transfer CFT 3.2.2
Installation and Operation Guide 46
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.
Update a multi-node installation on multiple
hosts
This section describes the procedure to apply a patch or service pack on a multi-node architecture based on N hosts. You update a Transfer CFT multi-node architecture with multi-hosts using the same procedure as for a patch or service pack, one host at a time.
Transfer CFT 3.2.2
Installation and Operation Guide 47
4 Update
1. Connect to the first host.
2. Stop all nodes running on this host by running the command: copstop
Copilot services are stopped, and local nodes are automatically re-started on the other hosts.
3. Check that the nodes are re-started by using the command: CFTUTIL listnode
4. Install the patch or the service pack as usual using the Axway Installer.
5. Start Copilot services.
6. Connect to the next host and repeat the procedure starting at of Step 2 (above).
Transfer CFT 3.2.2
Installation and Operation Guide 48
Upgrade or migrate
5
Overview of migrations and upgrades
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. Transfer CFT 3.2.2
Installation and Operation Guide 49
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 p ath 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.
Transfer CFT 3.2.2
Installation and Operation Guide 50
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.
Transfer CFT 3.2.2
Installation and Operation Guide 51
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 Transfer CFT on page 52.
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 35 and JRE customization on page 39.
Start the Axway Installer. The command depends on the Installer version and your OS, as follows:
l Versions lower than 4.5.x: o Windows: setupwin32.exe update
o Unix: update.sh update
Transfer CFT 3.2.2
Installation and Operation Guide 52
5 Upgrade or migrate
l Version 4.5.x or higher: o Windows: update32/64.exe o 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.
Transfer CFT 3.2.2
Installation and Operation Guide 53
5 Upgrade or migrate
Transfer CFT 2.6.4 to 3.2.2
Preconditions: Minimum versions for this procedure
This upgrade requires that your current installation is at least at the version levels listed below. Read the Before you start p rior to beginning this procedure.
l Transfer CFT version: 2.6.4_SP7
l Axway Installer version: 4.3.1_SP2
l Embedded JRE version: 1.5.0_15
Note
Remember to update the product key between versions (after completing the upgrade).
Step 1: Upgrade to Axway Installer 4.4.0 SP8 or the latest SP
Run the Axway Installer in update mode. Here it is shown in the default installation directory. 1. Start the Axway Synchrony Installer in update mode, shown here in the default installation directory: Windows: C:\Axway\Synchrony\setupWIN32.exe update
Unix/Linux: ***Axway/Synchrony/setupUNIX.sh update
2. Apply the Synchrony_Installer_4.4.0_UP7-from-4.3.1_win-x86-64_BN16272.jar.
3. Start the Axway Synchrony Installer in update mode. Windows: setupWIN32.exe update
Unix/Linux: setupUNIX.sh update
4. Apply the Synchrony_Installer_4.4.0_SP8_allOS_BN25804.jar.
Step 2: Upgrade to JRE 160
Use the Axway JREUpdateTool to upgrade to JRE 1.6. This Axway tool is available on the Axway Support site.
1. Unzip the JREUpdateTool_4.4.0_Utility_*****_BN1205240348.zip.
Where ***** represents the platform
Example: JREUpdateTool_4.4.0_Utility_win-x86-64_BN1205240348.zip
2. Upgrade to Java 1.6 using the appropriate command:
Windows: <JRETOOLS_DIRECTORY_WITHOUT_BLANKS>\updatejre.bat C:\Axway\Synchrony\
Unix/Linux: <JRETOOLS_DIRECTORY>/updatejre.sh / home/user/Axway/Synchrony/
Step 3: Upgrade to Axway Installer 4.5.0 SP4 or the latest SP
Run the Axway Installer in update mode.
1. Start the Axway Synchrony Installer in updated mode:
Windows: setupWIN32.exe update
Transfer CFT 3.2.2
Installation and Operation Guide 54
5 Upgrade or migrate
Unix/Linux: setupUNIX.sh update
2. Apply the Synchrony_Installer_4.5.0_UP1-from-4.4.0-4.4.1_allOS_BN1204251050.jar.
3. Start the Axway Synchrony Installer.
Note
The program commands change in this step!
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
4. Apply the Axway_Installer_4.5.0_SP4_allOS_BN22715.jar.
Step 4: Upgrade to JRE 160 update 37 using the JREUpdateTool
Use the Axway JREUpdateTool to update the JRE.
1. Unzip the JREUpdateTool_4.5.0_Utility_*****_BN1211090726.zip
Where ***** represents the platform
Example: JREUpdateTool_4.5.0_Utility_win-x86-64_BN1211090726.zip
2. Upgrade to Java 1.6 using the appropriate command:
Windows: <JRETOOLS_DIRECTORY_WITHOUT_BLANKS>\updatejre.bat C:\Axway\Synchrony\
Unix/Linux: <JRETOOLS_DIRECTORY>/updatejre.sh / home/user/Axway/Synchrony/
S tep 5: Upgrade to Axway Installer 4.8.0 Run the Axway Installer in update mode.
1. Start the Axway Installer.
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar.
Where ***** represents the platform
Example: Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_
BN2.jar
Step 6: Upgrade to Transfer CFT 3.1.3 Run the Axway Installer in update mode.
1. Start the Axway Installer.
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_
BN8294000.jar
Where ***** represents the platform
Transfer CFT 3.2.2
Installation and Operation Guide 55
5 Upgrade or migrate
Example: Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_
win-x86-64_BN8294000.jar
Step 7: Upgrade To the latest Transfer CFT 3.1.3 Service Pack
Use the Axway installer in update mode.
1. Start the Axway Installer: Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the p latform
For example, Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip)
Note
In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
3. Add the Transfer CFT 3.x license key in the conf/cft.key file.
Step 8: Upgrade to Transfer CFT 3.2.2 Upgrade Pack
Use the Axway Installer in update mode.
1. Start the Axway Installer: Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.2.2_UP****-from-3.1.3_*****_BN*****.zip.
Where ***** represents the SP level and the p latform
For example, Transfer_CFT_3.2.2_UP1-from-3.1.3_aix-power-32_BN9815000.zip
Note
In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
3. Add the Transfer CFT 3.x license key in the conf/cft.key file.
Transfer CFT 3.2.2
Installation and Operation Guide 56
5 Upgrade or migrate
Transfer CFT 2.7.1 to 3.2.2
Preconditions: Minimum versions for this procedure
This procedure requires that your current installation be at least at the levels listed below.
l Transfer CFT version 2.7.1_SP10
l Axway Installer version 4.4.0_SP8 or 4.4.1_SP3
l Embedded JRE version: 160
Note
Remember to update the product key between versions after upgrading.
Step 1: Upgrade to JRE 160
Use the Axway JREUpdateTool to perform the JRE update.
1. Unzip the JREUpdateTool_4.4.0_Utility_*****_BN1205240348.zip
Where ***** represents the platform For example, JREUpdateTool_4.4.0_Utility_win-x86-64_BN1205240348.zip 2. Use the following command to upgrade to Java 1.6:
Windows: <JRETOOLS_DIRECTORY_WITHOUT_BLANKS>\updatejre.bat C:\Axway\Synchrony\
Unix/Linux <JRETOOLS_DIRECTORY>chmod 755 *.sh/updatejre.sh /home/user/Axway/Synchrony
Step 2: Upgrade to the Axway Installer 4.5.0_SP4 or the latest SP
Run the Axway installer in update mode.
1. Start the Axway Synchrony Installer:
Windows: setupWIN32.exe update
Unix/Linux: setupUNIX.sh update
2. Apply the Synchrony_Installer_4.5.0_UP1-from-4.4.0-4.4.1_allOS_BN1204251050.jar.
3. Start the Axway Installer.
Note
The program commands change in this step!
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
4. Apply the Axway_Installer_4.5.0_SP4_allOS_BN22715.jar.
Step 3: Upgrade to JRE 160 update 37
Use the Axway JREUpdateTool to update the JRE level.
1. Unzip the JREUpdateTool_4.5.0_Utility_*****_BN1211090726.zip
Where ***** represents the platform
Transfer CFT 3.2.2
Installation and Operation Guide 57
5 Upgrade or migrate
For example, JREUpdateTool_4.5.0_Utility_win-x86-64_BN1211090726.zip
2. Upgrade to Java 1.6 using the appropriate command:
Windows: <JRETOOLS_DIRECTORY_WITHOUT_BLANKS>\updatejre.bat C:\Axway\Synchrony\
Unix/Linux: <JRETOOLS_DIRECTORY>/updatejre.sh / home/user/Axway/Synchrony/
Step 4: Upgrade to Axway Installer 4.8.0
Run the Axway Installer in update mode.
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Axway_Installer_4.8.0_UP**-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar
Where ** is the UP number, and ***** represents the platform.
For example, Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_
BN2.jar
Step 5: Upgrade to Transfer CFT 3.1.3
Run the Axway Installer in update mode.
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_
BN8294000.jar
Where ***** represents the platform
For example, Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.13.1.2_win-x86-64_BN8294000.jar
Step 6: Upgrade to the latest Transfer CFT 3.1.3 Service Pack
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the p latform
For example, Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip
Note
In this step you are now working with a zip file (it was .a jar in previous Installer versions). Do NOT unzip/uncompress the zip file.
3. Add the Transfer CFT 3.x license key in the conf/cft.key file.
Transfer CFT 3.2.2
Installation and Operation Guide 58
5 Upgrade or migrate
Step 7: Upgrade to Transfer CFT 3.2.2 Upgrade Pack
Use the Axway Installer in update mode.
1. Start the Axway Installer: Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.2.2_UP****-from-3.1.3_*****_BN*****.zip.
Where ***** represents the SP level and the p latform
For example, Transfer_CFT_3.2.2_UP1-from-3.1.3_aix-power-32_BN9815000.zip
Note
In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
3. Add the Transfer CFT 3.x license key in the conf/cft.key file.
Transfer CFT 3.2.2
Installation and Operation Guide 59
5 Upgrade or migrate
Transfer CFT 3.0.1 to 3.2.2
Preconditions: Minimum versions for this procedure
This procedure requires that your current installation is at least at the levels listed below.
l Transfer CFT 3.0.1_SP9
l Installer 4.5.0_SP4
l Embedded JRE version: JRE 160
Note
Remember to update the product key between versions (after completing the upgrade).
Step 1: Upgrade to Axway Installer 4.8.0
Use the Axway Installer in update mode:
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar
Where ***** represents the platform
For example, Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_
BN2.jar
Step 2: Upgrade to Transfer CFT 3.1.3
Run the Axway Installer in update mode.
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP**-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_
BN8294000.jar
Where ** is the UP version and ***** represents the platform.
Example: Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_
win-x86-64_BN8294000.jar
Step 3: Upgrade to the latest Transfer CFT 3.1.3 Service Pack
Run the Axway Installer in update mode.
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
Transfer CFT 3.2.2
Installation and Operation Guide 60
5 Upgrade or migrate
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the p latform
Example: Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip
Note
In this step you are working with a zip file (it was a jar in previous Installer versions). Do NOT unzip/uncompress the zip file.
Step 4: Upgrade to Transfer CFT 3.2.2 Upgrade Pack
Use the Axway Installer in update mode.
1. Start the Axway Installer: Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.2.2_UP****-from-3.1.3_*****_BN*****.zip.
Where ***** represents the SP level and the p latform
For example, Transfer_CFT_3.2.2_UP1-from-3.1.3_aix-power-32_BN9815000.zip
Note
In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
3. Add the Transfer CFT 3.x license key in the conf/cft.key file.
Transfer CFT 3.2.2
Installation and Operation Guide 61
5 Upgrade or migrate
Transfer CFT 3.1.3 to 3.2.2
Preconditions: Minimum versions for this procedure
The current installation must be at least at the levels listed below.
l Transfer CFT version is 3.1.3
Note
Remember to update the product key between versions.
Step 1: Upgrade to Axway Installer 4.8.0 Run the Axway installer in update mode:
1. Start the Axway Installer:
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Axway_Installer_4.8.0_UP**-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar
Where ** is the UP version and ***** represents the platform.
Example: Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_
BN2.jar)
Step 2: Upgrade to Transfer CFT 3.1.3
Run the Axway Installer in update mode.
1. Start the Axway Installer.
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_
BN8294000.jar
Where ***** represents the platform
Example: Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_
win-x86-64_BN8294000.jar
Step 3: Upgrade to the latest Transfer CFT 3.1.3 Service Pack
Run the Axway Installer in update mode.
1. Launch the Axway Installer
Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the p latform
Example: Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip
Transfer CFT 3.2.2
Installation and Operation Guide 62
5 Upgrade or migrate
Note
In this step you are working with a zip file (and not a jar as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
Step 4: Upgrade to Transfer CFT 3.2.2 Upgrade Pack
Use the Axway Installer in update mode.
1. Start the Axway Installer: Windows: update32.exe o r update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.2.2_UP****-from-3.1.3_*****_BN*****.zip.
Where ***** represents the SP level and the p latform
For example, Transfer_CFT_3.2.2_UP1-from-3.1.3_aix-power-32_BN9815000.zip
Note
In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
3. Add the Transfer CFT 3.x license key in the conf/cft.key file.
Transfer CFT 3.2.2
Installation and Operation Guide 63
5 Upgrade or migrate
Post upgrade
After completing the upgrade procedure, your Transfer CFT 3.2.2 the exec scripts are operational. However, you must rebuild both your exits and API programs.
Checking the new version
To check the Transfer CFT version, as well as the license key and system information, enter the command: CFTUTIL ABOUT
Transfer CFT 3.2.2
Installation and Operation Guide 64
5 Upgrade or migrate
Upgrade a Transfer CFT multi-node installation
This section describes how to upgrade from a Transfer CFT 3.0.1, 3.1.2, or 3.1.3 multi-node, multihost installation to Transfer CFT 3.2.x. 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 Determine the Installer and product version on page 52.
l Download the Transfer CFT Upgrade Pack, available on Sphere at support.axway.com. The Transfer CFT Upgrade Pack name has the general format Transfer_CFT_3.2.x_UP**-from2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2-3.1.3_<OS>_BN<build_number>.jar.
Where: ** is the UP number
<OS> is the operating system
Transfer CFT 3.2.2
Installation and Operation Guide 65
5 Upgrade or migrate
Upgrade from Transfer CFT 3.0.1 multi-node
For details on shared disks, node commands, and other multi-node considerations, refer to the Transfer CFT 3.2.2 User Guide > Manage multi-node architecture.
Upgrade the first host
1. Connect to the first machine where Transfer CFT is running.
2. Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk. For example:
cd /<shared_disk>/<CFTdir>/Transfer_CFT/runtime
profile.bat
3. Stop Copilot. This command stops Copilot as well all cftnodes running on that machine.
copstop -f
4. Begin the upgrade procedure as described in Upgrade from Transfer CFT 3.0.1.
Upgrade additional hosts
Repeat the above upgrade procedure on each additional host.
Restart the upgraded Transfer CFT multi-node
multihost environment
1. Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk.
cd /<shared_disk>/<CFTdir>/Transfer_CFT/runtime
profile.bat
2. Check the new version using the following command: CFTUTIL ABOUT
3. Start Copilot (start each of the Copilots in the multi-node environment).
copstart
4. After restarting the Copilots, restart the Transfer CFT server.
cft restart
Transfer CFT 3.2.2
Installation and Operation Guide 66
5 Upgrade or migrate
5. Check the upgraded Transfer CFT multi-node multihost system.
CFTUTIL listnode
l All of the Copilot should be started
l All of the Transfer CFT nodes must be started
Your Transfer CFT, exec scripts, APIs, and Exits are now operational. Once Transfer CFT has been upgraded on a host you can start that instance, there is no need to wait until Transfer CFT is upgraded on every host.
Transfer CFT 3.2.2
Installation and Operation Guide 67
5 Upgrade or migrate
Upgrade from Transfer CFT 3.1.2 or 3.1.3 multinode
For details on shared disks, node commands, and other multi-node considerations, refer to the Transfer CFT 3.2.2 User Guide > Manage multi-node architecture.
Upgrade the first host
1. Connect to the first machine where Transfer CFT is running.
2. Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk. For example:
cd /<shared_disk>/<CFTdir>/Transfer_CFT/runtime
profile.bat
3. Stop Copilot. This command stops Copilot as well all cftnodes running on that machine.
copstop -f
4. Begin the upgrade procedure as described in Upgrade from Transfer CFT 3.1.2.
Upgrade additional hosts
To update additional hosts, in the same session perform the following commands.
Set the environmental variable:
set JAVA_TOOL_OPTIONS='-Dcft.migrate=no'
Update the host:
update64.exe
- or (according to your system) update32.exe
Repeat these steps for each additional host.
Transfer CFT 3.2.2
Installation and Operation Guide 68
5 Upgrade or migrate
Restart the upgraded Transfer CFT multihost multinode environment
1. Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk.
cd /<shared_disk>/<CFTdir>/Transfer_CFT/runtime
profile.bat
2. Check the new version using the following command: CFTUTIL ABOUT
3. Start Copilot (start each of the Copilots in the multi-node environment).
copstart
4. After restarting the Copilots, restart the Transfer CFT server: cft restart
5. Check the upgraded Transfer CFT multi-node multihost system.
CFTUTIL listnode
l All of the Copilots should be started
l All of the Transfer CFT nodes must be started
Your Transfer CFT, exec scripts, APIs, and Exits are now operational. Once you have upgraded Transfer CFT on one host you can start that instance, there is no need to wait until Transfer CFT is upgraded on every host.
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
Transfer CFT 3.2.2
Installation and Operation Guide 69
5 Upgrade or migrate
Check Copilot status
To check the Copilot status, enter:
copstatus
The copstatus return code is 0 when Copilot is running, and 1 when Copilot is stopped.
Additional copstatus commands include:
copstatus [-p] [-v] [-h|--help]
-p print copsmng pid if copilot is started
-v print status message
-h|--help copstatus help
Prerequisites
Important information before performing a
migration procedure
l You must update your Transfer CFT to the most recent service pack version.
l Upgrade the Axway Installer to 4.10, if you are not at this version or higher, prior to upgrading your Transfer CFT 3.2.2.
l If needed, you can uninstall an Upgrade Pack. Doing so rolls back to the previous version before the upgrade, but all transfers and configuration modifications that were performed since the upgrade are lost.
l Backup Transfer CFT before beginning an upgrade or migration procedure.
l Before beginning the upgrade or migration procedure stop the existing version of Transfer CFT and the GUI server.
Caution
For versions prior to and including Transfer CFT 2.6.4 SP1, there are export issues if you are using intermediate certificates that have a different ID. A fix was delivered in Transfer CFT 2.6.4 SP2 and in 2.4.1 SP11 to correct this PKI export issue. However, for Transfer CFT 2.5.1 you must use your original PKI configuration and corresponding certificates, and manually import these into the Transfer CFT 3.2.2 PKI database.
About license keys
You require a new license key if you are migrating from a version 2.x Transfer CFT to a version 3.x. Transfer CFT 3.2.2
Installation and Operation Guide 70
5 Upgrade or migrate
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.
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.
Install and auto import
The install and auto import option allows you to preform a new Transfer CFT installation and import configuration files and data from a existing Transfer CFT instance. During the procedure, you can select options for your new instance, and additionally can select which of the available types of data and configuration elements that you want to import. Note
Previous versions that are available for auto importing the configuration data include v2.3.2, 2.4, v2.5, v2.6, v2.7, v3.0.1 and v3.1.2.
To check the Transfer CFT version, as well as the license key and system information, enter the command: CFTUTIL ABOUT
You require a new license key if you are migrating from a version 2.x Transfer CFT to a version 3.x. General procedure
In this procedure, run the installer to perform a new Transfer CFT installation. During this process you are prompted with the option of importing existing data and configuration.
Start your installation
Begin a typical installation using the Transfer CFT 3.2.2 installation instructions that correspond to your operating system. Transfer CFT 3.2.2
Installation and Operation Guide 71
5 Upgrade or migrate
Importing configuration and data
Pending the existing version of Transfer CFT, the installer will propose available import options. Auto import screens
At this point you can select to migrate. The Installer page asks if you want to import data from your existing Transfer CFT instance. In the following screen you can select which types of data you'd like to import.
1. Select Yes to perform an automatic migration. Click Next.
2. Enter or navigate to the path for the existing profile file (profile.bat or profile.sh) for version 2.5 and higher. The profile file should be located in the runtime folder of the existing Transfer CFT installation.
3. Click to select configuration elements and objects that you want to import from the existing Transfer CFT instance. You must manually migrate execs, exits, and APIs.
Identity
1. You are prompted to confirm the local instance details. Modify if necessary, and click Next to continue.
2. Check the license key. Post auto import
If you used the install and auto import procedure with your existing Transfer CFT to Transfer CFT 3.2.2, at the end of the installation a new directory called migration is created in the runtime directory. This directory stores all of the information used during the auto import process. You can modify the extracted files and/or directory, and manually re-import this data at any time. The contents of this Auto import directory are described in the following table.
File
Directory
Description of extracted data
cftcat.xml
Catalog file.
cftcom.xml
Communication media.
cft-conf.cfg
Transfer CFT general configuration, which is applied to the new installation (contained in CFTPARM/CFTPART internal datafiles).
cft-confwarning.txt
Contains file path declarations from the cft-conf.cfg file that were used in the former Transfer CFT environment and that cannot be imported into the new installation.
Transfer CFT 3.2.2
Installation and Operation Guide 72
5 Upgrade or migrate
File
Directory
Description of extracted data
cft-pki.cfg
The PKI configuration that is applied to the new installation (as of version 2.4).
PKI directory
Contains extracted SSL certificates (pending version).
cft-uconf.
(sh/bat)
Contains:
l UCONF parameters (as of V2.5.1)
or
l Sentinel parameters (TRKAPI.cfg - V2.3.2 and V2.4.x)
and/or
l Copilot parameters (copconf.ini - V2.4.x)
This file is used to set the new installation UCONF parameters.
cft-uconfwarning.txt
Contains UCONF parameters set by the user in the former Transfer CFT environment and that cannot be imported into the new installation.
migration.
(sh/bat)
Contains instructions on how to re-import the collected data into a new installation, and includes the PKI, general configuration, UCONF parameters, catalog and communication media files.
Auto import in multi-node architecture
This section describes how to proceed to use auto import for Transfer CFT 3.0.1 or 3.1.2 multi-node in multi-hosts.
Procedure
The automatic import is performed during the Transfer CFT 3.2.2 installation. During the installation, dialog boxes let you select configuration data from the existing Transfer CFT to import. While installing first node on cluster architecture, you should opt to import data from the previous Transfer CFT version. Execute the procedure as described here. During installation of additional nodes, the option of importing data from previous version of Transfer CFT should not be selected.
If you choose to migrate your existing Transfer CFT to 3.2.2 using the automatic import method, at the end of the installation a new directory called auto_import is created in the runtime directory. This directory stores all of the information used during the installation and auto import. You can modify the extracted files and/or directory, and manually re-import this data at any time. Transfer CFT 3.2.2
Installation and Operation Guide 73
5 Upgrade or migrate
If you are installing and performing an auto import from a Transfer CFT with multi-node architecture enabled, the contents of the Auto import directory are as follows.
File
Directory
Description of extracted data
cftcatXX.xml
Catalog files. XX represents the node number, from 00 to Total_Number_of_Nodes -1.
cftcom.xml
Communication media for node manager.
cftcomXX.xml
Communication media for nodes. XX represents the node number, from 00 to Total_Number_of_Nodes -1.
cft-conf.cfg
Transfer CFT general configuration, which is applied to the new installation (contained in CFTPARM/CFTPART internal datafiles).
cft-confwarning.txt
Contains file path declarations from the cft-conf.cfg file that were used in the former Transfer CFT environment and that cannot be imported into the new installation.
cft-pki.cfg
The PKI configuration that is applied to the new installation, as of version 2.4.
PKI directory
Contains extracted SSL certificates (pending version).
cft-uconf.
(sh/bat)
Contains:
l UCONF parameters (as of V2.5.1)
- or l Sentinel parameters (TRKAPI.cfg - V2.3.2 and V2.4.x)
- and/or - l Copilot parameters (copconf.ini - V2.4.x)
This file is used to set the new installation UCONF parameters.
cft-uconfwarning.txt
Contains UCONF parameters set by the user in the former Transfer CFT environment and that cannot be imported into the new installation.
migration.
(sh/bat)
Contains instructions on how to re-import the collected data into a new installation, and includes the PKI, general configuration, UCONF parameters, catalog and communication media files.
Transfer CFT 3.2.2
Installation and Operation Guide 74
5 Upgrade or migrate
Perform a manual migration
Prerequisites
Install Transfer CFT 3.2.2
Perform a Transfer CFT installation, as described in the OS-specific installation section.
Note
Do not use the Install and auto import option available in the Installer.
After performing a Transfer CFT 3.2.2, you should update the to the most recent service pack.
Load the environment
Before beginning the manual migration procedure, you must load the old Transfer CFT environment.
Windows procedure
Transfer CFT 2.3.2 and 2.4
There is no profile file for Transfer CFT 2.3.2 or 2.4 in Windows.
To execute a command you must be in the correct directory. Therefore, before starting the migration, change the directory to the version-appropriate Transfer CFT installation directory.
Transfer CFT 2.5 and higher
From the console, change the directory to the Transfer CFT runtime directory and execute the profile file using the command: profile.bat
After loading the profile, you can execute commands from anywhere.
Migrating from Transfer CFT 2.3.2
This topic describes how to migrate Transfer CFT 2.3.2 to 3.2.2.
Migrating the configuration
Migrating the main configuration
Migrate PARM, PART, IDF and other static configuration objects.
Transfer CFT 3.2.2
Installation and Operation Guide 75
5 Upgrade or migrate
1. Load the Transfer CFT 2.3.2 environment. See the Prerequisites on page 75 for details.
2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter:
CFTUTIL CFTEXT type=all, fout=cft-extract.conf
3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the Transfer CFT 3.2.2 installation.
4. Load the Transfer CFT 3.2.2 environment.
5. Import your static configuration objects using the cftinit command. Enter:
cftinit cft-extract.conf
Migrating trkapi.cfg file parameters
1. In the trkapi.cfg file, select the parameters you want to import into 3.2.2.
2. Create a script file, for example:
o Windows: trkapi-import.bat
3. For each parameter you select, add a UCONF command line to your new script file using the format: UCONFSET id=<parameter_id>, value=<value>
4. Use the parameter mapping between trkapi and UCONF, as listed in the following table, to specify the correct parameter id.
Parameter mapping between the trkapi.cfg file and UCONF
Parameter in trkapi.cfg
Parameter names in UCONF
TRACE
sentinel.trktrace
TRKGMTDIFF
sentinel.trkgmtdiff
TRKIPADDR_BKUP
sentinel.trkipaddr_bkup
TRKIPPORT
sentinel.trkipport
TRKIPPORT_BKUP
sentinel.trkipport_bkup
TRKLOCALADDR
sentinel.trklocaladdr
TRKPRODUCTNAME
sentinel.trkproductname
XFB.BufferSize
sentinel.xfb.buffer_size
XFB.Log (UNIX)
sentinel.xfb.log
XFBLOG (Windows)
sentinel.xfb.log
Transfer CFT 3.2.2
Installation and Operation Guide 76
5 Upgrade or migrate
Parameter in trkapi.cfg
Parameter names in UCONF
XFB.Sentinel
sentinel.xfb.enable
XFB.Trace
sentinel.xfb.trace
XFB.Transfer
sentinel.xfb.transfer
Load the Transfer CFT 3.2.2 environment.
5. Import the selected UCONF parameters using the command CFTUTIL. Replace <script_
filename> with the new script file path: CFTUTIL <prefix_character><script_
filename>
Example
l Windows: CFTUTIL #trkapi-import.bat
Migrating PKI certificates
Exporting PKI certificates from Transfer CFT 2.3.2 is not supported. For this reason, you must create a new PKI database in the Transfer CFT 3.2.2 runtime using the PKIUTIL PKIFILE command. Next import each certificate using the PKIUTIL PKICER command. For more information, refer to the Transfer CFT 3.2.2 User's Guide, sections Using the PKIFILE command and Using the PKICER command.
Migrating the runtime environment
Migrating the catalog
1. Load the Transfer CFT 3.2.2 environment.
2. Export the catalog using the command CFTMI230:
CFTMI230 MIGR type=CAT, direct=FROMCAT, ifname=<catalog_2.3.2_
filename>, ofname=catalog_output.xml
3. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_
installation> with the corresponding environmental variable:
o Windows: $CFTCATA
CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_installation>
Transfer CFT 3.2.2
Installation and Operation Guide 77
5 Upgrade or migrate
Migrating the communication media files
1. Load the Transfer CFT 3.2.2 environment.
2. Export the communication media file using command CFTMI230:
CFTMI230 MIGR type=COM, direct=FROMCOM, ifname=<com_2.3.2_filename>, ofname=com_
output.xml
3. Import the communication media file using command CFTMI. Replace the <com_
filename_new_installation> with the system-specific environment variable:
o Windows: $CFTCOM
CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_
filename_new_installation>
Migrating from Transfer CFT 2.4
This topic describes how to migrate from Transfer CFT 2.4 to version 3.2.2. Before starting this migration procedure you must perform the steps described in Before you start.
Migrating the configuration
Migrating the main configuration
Migrate PARM, PART, IDF and other static configuration objects.
1. Load the Transfer CFT 2.4 environment. See the Prerequisites on page 75 for details.
2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter: CFTUTIL CFTEXT type=all, fout=cft-extract.conf
3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the Transfer CFT 3.2.2 installation.
4. Load the Transfer CFT 3.2.2 environment.
5. Import your static configuration objects using the cftinit command. Enter: cftinit cft-extract.conf
Migrating trkapi.cfg file parameters
Migrate the parameters from the Transfer CFT 2.4 trkapi.cfg file.
1. In the trkapi.cfg file, select the parameters you want to import in 3.2.2.
2. Create a script file, for example:
o Windows: trkapi-import.bat
Transfer CFT 3.2.2
Installation and Operation Guide 78
5 Upgrade or migrate
3. For each parameter you select, add a UCONF command line to your new script file using the format:
UCONFSET id=<parameter_id>, value=<value>
Use the parameter mapping between trkapi and UCONF, as listed in the following table, to specify the correct parameter id.
Table 2. Parameter mapping between the trkapi.cfg file and UCONF
Parameter in trkapi.cfg
Parameter names in UCONF
TRACE
sentinel.trktrace
TRKGMTDIFF
sentinel.trkgmtdiff
TRKIPADDR_BKUP
sentinel.trkipaddr_bkup
TRKIPPORT
sentinel.trkipport
TRKIPPORT_BKUP
sentinel.trkipport_bkup
TRKLOCALADDR
sentinel.trklocaladdr
TRKPRODUCTNAME
sentinel.trkproductname
XFB.BufferSize
sentinel.xfb.buffer_size
XFB.Log (UNIX)
sentinel.xfb.log
XFBLOG (Windows)
sentinel.xfb.log
XFB.Sentinel
sentinel.xfb.enable
XFB.Trace
sentinel.xfb.trace
XFB.Transfer
sentinel.xfb.transfer
4. Load the Transfer CFT 3.2.2 environment.
5. Import the selected UCONF parameters using the command CFTUTIL. Replace <script_
filename> with the new script file path.
CFTUTIL <prefix_character><script_filename>
Example
l Windows: CFTUTIL #trkapi-import.bat
Transfer CFT 3.2.2
Installation and Operation Guide 79
5 Upgrade or migrate
Migrating copconf.ini parameters
Migrate parameters from the Transfer CFT 2.4 copconf.ini file.
1. From the copconf.ini file, select the parameters you want to import into version 3.2.2.
2. Create a script file, for example:
o Windows: copconf-import.bat
3. For each selected parameter add a UCONF command line in your new script file using the format: UCONFSET id=<parameter_id>, value=<value>
Use the parameters mapping between copconf and UCONF as listed in the following table to specify the correct parameter id.
Table 3. Parameter mapping between copconf file and UCONF
Parameter in copconf.ini
Parameter name in UCONF
BatchList
copilot.batches
CFTCOM
copilot.cft.com
CFTMEDIACOM
copilot.cft.mediacom
ChildProcessTimeout
copilot.misc.childprocesstimeout
HttpRootDir
copilot.http.httprootdir
MinNbProcessReady
copilot.misc.minnbprocessready
NbProcessToStart
copilot.misc.nbprocesstostart
NBWAITCFTCATA
copilot.cft.nbwaitcftcata
ServerHost
copilot.general.serverhost
ServerPort
copilot.general.serverport
SslCertFile
copilot.ssl.sslcertfile
SslCertPassword
copilot.ssl.sslcertpassword
SslKeyFile
copilot.ssl.sslkeyfile
SslKeyPassword
copilot.ssl.sslkeypassword
TcpTimeout
copilot.misc.tcptimeout
Transfer CFT 3.2.2
Installation and Operation Guide 80
5 Upgrade or migrate
Parameter in copconf.ini
Parameter name in UCONF
TIMERWAITCFTCATA
copilot.cft.timerwaitcftcata
TrcMaxLen
copilot.trace.trcmaxlen
TrcType
copilot.trace.trctype
wlogComment
copilot.batches.wlog.comment
wlogParams
copilot.batches.wlog.params
WsiComplience
copilot.webservices.wsicomplience
4. Load the Transfer CFT 3.2.2 environment.
5. Import the selected UCONF parameters using the command CFTUTIL. Replace the <script_filename> with the new script file path.
CFTUTIL <prefix_character><script_filename>
Example
l Windows: CFTUTIL #copconf-import.bat
Migrating PKI certificates
You must be at Transfer CFT 2.4.1 SP5 or higher before performing this procedure.
1. Load the Transfer CFT 2.4 environment.
2. Export your PKI certificates using the command PKIUTIL PKIEXT:
PKIUTIL PKIEXT fout=pki-extract.conf
3. Load the new Transfer CFT 3.2.2 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_
database_filename> with the appropriate variable:
o Windows: The absolute path value for the CFTPKU environment variable
PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’
5. Import your PKI certificates into Transfer CFT 3.2.2 using the command PKIUTIL. Replace the <script_filename> with the new script file path.
PKIUTIL <prefix_character><script_filename>
Example
l Windows: PKIUTIL #pki-extract.conf
Transfer CFT 3.2.2
Installation and Operation Guide 81
5 Upgrade or migrate
Migrating the runtime environment
Migrating the catalog
1. Load the Transfer CFT 2.4 environment.
2. Export the catalog using the command CFTMI240:
CFTMI240 MIGR type=CAT, direct=FROMCAT, ifname=<catalog_2.4_filename>,
ofname=catalog_output.xml
3. Load the Transfer CFT 3.2.2 environment.
4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_
installation> with the corresponding environment variable:
o Windows: $CFTCATA
CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_installation>
Migrating the communication media files
1. Load the Transfer CFT V2.4 environment.
2. Export the communication media file using command CFTMI240:
CFTMI240 MIGR type=COM, direct=FROMCOM, ifname=<com_2.4_filename>,
ofname=com_output.xml
3. Load Transfer CFT 3.2.2 environment.
4. Import the communication media file using command CFTMI. Replace <com_
filename_new_installation> with the corresponding environment variable:
o Windows: $CFTCOM
CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_
filename_new_installation>
Migrate from Transfer CFT 2.5 or 2.6
This topic describes how to migrate Transfer CFT 2.5 or 2.6 to version 3.2.2.
Transfer CFT 3.2.2
Installation and Operation Guide 82
5 Upgrade or migrate
Migrate the configuration
Migrating the main configuration
Migrate PARM, PART, IDF and other static configuration objects.
1. Load the former Transfer CFT (2.5 or 2.6) environment. See the Prerequisites on page 75 for details.
2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter:
CFTUTIL CFTEXT type=all, fout=cft-extract.conf
3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the new Transfer CFT 3.2.2 installation.
4. Load the new Transfer CFT 3.2.2 environment.
5. Import your static configuration objects using the cftinit command. 6. Enter: cftinit cft-extract.conf
Migrating UCONF parameters
1. Load the former Transfer CFT (2.5 or 2.6) environment.
2. Display your UCONF parameters using the CFTUTIL LISTUCONF command. Enter: CFTUTIL LISTUCONF scope=user
3. Select the UCONF parameters that you want to import into the new Transfer CFT 3.2.2.
4. Create a script file such as:
Windows: uconf-import.bat
l
5. For each parameter you select, add a line to the new script file in the format: UCONFSET id=<parameter_id>, value=<value>
6. Load the new Transfer CFT 3.2.2 environment.
7. Import the selected UCONF parameters using the script file and the CFTUTIL command. Replace the <script_filename> with the new script file path: CFTUTIL <prefix_character><script_filename>
Example
l Windows: CFTUTIL #uconf-import.bat
Transfer CFT 3.2.2
Installation and Operation Guide 83
5 Upgrade or migrate
Migrating PKI certificates
For Transfer CFT 2.5, you must be at Transfer CFT 2.5.1 SP2 or higher before performing this procedure. For Transfer CFT 2.6.4, you must be at Transfer CFT 2.6.4 SP2 or higher before performing this procedure.
1. Load the former Transfer CFT environment (2.5 or 2.6).
2. Export your PKI certificates using the command PKIUTIL PKIEXT: PKIUTIL PKIEXT fout=pki-extract.conf
3. Load the new Transfer CFT 3.2.2 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_
database_filename> with the appropriate value: PKIUTIL PKIFILE fname=<pki_
database_filename>, mode='CREATE’
Windows: The absolute path value for the CFTPKU environment variable
l
5. Import your PKI certificates into the new Transfer CFT 3.2.2 using the command PKIUTIL. Replace the <script_filename> with the new script file path: PKIUTIL <prefix_character><script_filename>
Example
l Windows: PKIUTIL #pki-extract.conf
Migrating the runtime environment
Migrating the catalog
1. Load the former Transfer CFT (2.5 or 2.6) environment.
2. Export the catalog using the command CFTMI240.
CFTMI240 MIGR type=CAT, direct=FROMCAT, ifname=<catalog_2.5_filename>,
ofname=catalog_output.xml
3. Load the new Transfer CFT 3.2.2 environment.
4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_
installation> with the corresponding environment variable:
l Windows: $CFTCATA
Table 4. Example
CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_installation>
Transfer CFT 3.2.2
Installation and Operation Guide 84
5 Upgrade or migrate
Migrating the communication media files
1. Load the former Transfer CFT (2.5 or 2.6) environment.
2. Export the communication media file using command CFTMI240:
CFTMI240 MIGR type=COM, direct=FROMCOM, ifname=<com_2.5_filename>,
ofname=com_output.xml
3. Load the new Transfer CFT 3.2.2 environment.
4. Import the communication media file using command CFTMI. Replace the <com_
filename_new_installation> with the corresponding environment variable:
o Windows: $CFTCOM
Table 5. Example
CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_
filename_new_installation>
Migrating from Transfer CFT 2.6.4 SP2 or 2.7
This topic describes how to migrate Transfer CFT 2.6.4 SP2, or higher, or 2.7 to version 3.2.2. Migrating the main configuration and UCONF
parameters
You can migrate the PARM, PART, IDF, other static configuration objects and UCONF parameters as follows:
1. Load the former Transfer CFT environment. See the Prerequisites on page 75 for details.
2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter: CFTUTIL CFTEXT type=all, fout=cft-extract.conf
3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the new Transfer CFT 3.2.2 installation.
4. Load the new Transfer CFT 3.2.2 environment.
5. Import your static configuration objects using the cftinit command. Enter: cftinit cft-extract.conf
Transfer CFT 3.2.2
Installation and Operation Guide 85
5 Upgrade or migrate
Migrating PKI certificates
1. Load the former Transfer CFT (2.6.4 or 2.7) environment.
2. Export your PKI certificates using the command PKIUTIL PKIEXT. Enter: PKIUTIL PKIEXT fout=pki-extract.conf
3. Load the new Transfer CFT 3.2.2 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_
database_filename> with the OS appropriate value:
l UNIX: $CFTPKU
l Windows: The absolute path value for the CFTPKU environment variable: PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’
5. Import your PKI certificates into the new Transfer CFT 3.2.2 using the command PKIUTIL. Replace the <script_filename> with the new script file path: PKIUTIL <prefix_character><script_filename>
Examples
• Windows: PKIUTIL #pki-extract.conf
Migrating the runtime environment
Migrating the catalog
1. Load the former Transfer CFT (2.6.4 or 2.7) environment.
2. Export the catalog using the command CFTMI240:
CFTMI240 MIGR type=CAT, direct=FROMCAT, ifname=<catalog_2.7_filename>,
ofname=catalog_output.xml
3. Load the new Transfer CFT 3.2.2 environment.
4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_
installation> with the corresponding environment variable:
l Windows: $CFTCATA
Example
CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_installation>
Transfer CFT 3.2.2
Installation and Operation Guide 86
5 Upgrade or migrate
Migrating the communication media files
1. Load the former Transfer CFT (2.6.4 or 2.7.0) environment.
2. Export the communication media file using command CFTMI240:
CFTMI240 MIGR type=COM, direct=FROMCOM, ifname=<com_2.7.0_filename>,
ofname=com_output.xml
3. Load the new Transfer CFT3.2.2 environment.
4. Import the communication media file using command CFTMI. Replace the <com_
filename_new_installation> with the corresponding environment variable:
l Windows: $CFTCOM
Example
CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_
filename_new_installation>
Migrating from Transfer CFT 3.0.1 or 3.1.2
This topic describes how to migrate Transfer CFT 3.0.1 or 3.1.2 to version 3.2.2. It is divided in 2 sections, the first section describes migration for a single node architecture, and the second section multi-node architecture. Lastly there are instructions explaining what would be needed to migrate from single node architecture to multi node architecture.
Single node architecture
Migrating the configuration
Migrating the main configuration and UCONF parameters
Migrate PARM, PART, IDF, other static configuration objects and UCONF parameters as follows:
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment. See the Prerequisites on page 75 for details.
2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter: CFTUTIL CFTEXT type=all, fout=cft-extract.conf
3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the new Transfer CFT 3.2.2 installation.
Transfer CFT 3.2.2
Installation and Operation Guide 87
5 Upgrade or migrate
4. Load Transfer CFT 3.2.2 environment.
5. Import your static configuration objects using the cftinit command. Enter: cftinit cft-extract.conf
Migrating PKI certificates
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export your PKI certificates using the command PKIUTIL PKIEXT. Enter: PKIUTIL PKIEXT fout=pki-extract.conf
3. Load the Transfer CFT 3.2.2 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_
database_filename> with the appropriate value: the absolute path value for the CFTPKU for Windows. Enter: PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’
5. Import your PKI certificates into Transfer CFT 3.2.2 using the command PKIUTIL. Replace the <prefix_character> based on your system, @ for UNIX and # for Windows. Enter: PKIUTIL <prefix_character>pki-extract.conf
Migrating the runtime environment
Migrating the catalog
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export the catalog using the command CFTMI. Replace the <catalog_filename > with the corresponding environment variable, _CFTCATA for UNIX or $CFTCATA for Windows. Enter: CFTMI MIGR type=CAT, direct=FROMCAT, ifname=<catalog_filename_former_
cft>, ofname=catalog_output.xml
3. Load Transfer CFT 3.2.2 environment.
4. Import the catalog using the command CFTMI. Replace the <catalog_filename > with the corresponding environment variable, _CFTCATA for UNIX or $CFTCATA for Windows. Enter: Transfer CFT 3.2.2
Installation and Operation Guide 88
5 Upgrade or migrate
CFTM MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_cft >
Migrating the communication media files
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export the communication media file using command CFTMI. Replace the <com_
filename > with the corresponding environment variable, _CFTCOM for UNIX, or $CFTCOM for Windows. Enter: CFTMI MIGR type=COM, direct=FROMCOM, ifname=<com_filename_former_cft>,
ofname=com_output.xml
3. Load Transfer CFT 3.2.2 environment.
4. Import the communication media file using command CFTMI. Replace the <com_
filename > with the corresponding environment variable, _CFTCOM for UNIX or $CFTCOM for Windows. Enter: CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_
filename_new_cft >
Multi node architecture
Migrating the configuration
Migrating the main configuration and UCONF parameters
Migrate PARM, PART, IDF, other static configuration objects and UCONF parameters as follows:
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter: CFTUTIL CFTEXT type=all, fout=cft-extract.conf
3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the new Transfer CFT 3.2.2 installation.
4. Load Transfer CFT 3.2.2 environment.
5. Import your static configuration objects using the cftinit command. Enter: cftinit cft-extract.conf
Transfer CFT 3.2.2
Installation and Operation Guide 89
5 Upgrade or migrate
Migrating PKI certificates
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export your PKI certificates using the command PKIUTIL PKIEXT. Enter: PKIUTIL PKIEXT fout=pki-extract.conf
3. Load the Transfer CFT 3.2.2 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_
database_filename> with the appropriate value, $CFTPKU for UNIX or the absolute path value for the CFTPKU for Windows. Enter: PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’
5. Import your PKI certificates into Transfer CFT 3.2.2 using the command PKIUTIL. Replace the <prefix_character> based on your system, @ for UNIX and # for Windows. Enter: PKIUTIL <prefix_character>pki-extract.conf
Migrating the runtime environment
Migrating the catalog
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export all catalogs (one per node, named as cftcataXX, where XX is the node number with range from 00 to <number of nodes - 1>) using the command CFTMI. For each catalog. Enter: CFTMI MIGR type=CAT, direct=FROMCAT, ifname=<catalog_
filename_former_cft_for_node_<node>>, ofname=catalog_output_
<node>.xml
3. Load Transfer CFT 3.2.2 environment.
4. Import all catalogs using the command CFTMI for each of them. Use the same node number on both <node> on command. Enter: CFTM MIGR type=CAT, direct=TOCAT, ifname=catalog_output_<node>.xml,
ofname=<catalog_filename_new_cft><node>
Transfer CFT 3.2.2
Installation and Operation Guide 90
5 Upgrade or migrate
Migrating the communication media files
1. Load former Transfer CFT 3.0.1 or 3.1.2 environment.
2. Export all communication media files (cftcom and cftcomXX, where XX is the node number with range from 00 to <number of nodes - 1>) using the command CFTMI. For each communication media file.
l Enter: CFTMI MIGR type=COM, direct=FROMCOM, ifname=<com_filename_for_node_manager_on_
former_cft>, ofname=com_output.xml
l For each node, enter: CFTMI MIGR type=COM, direct=FROMCOM, ifname=<com_filename_for_
node_<node>_on_former_cft>, ofname=com_
output_<node>.xml
3. Load Transfer CFT 3.2.2 environment.
4. Import all communication media files using command CFTMI for each of them. Use the same node number on both <node> on command.
l Enter: CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_filename_
for_node_manager_on_new_cft> l For each node, enter: CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput_<node>.xml, ofname=<com_filename_for_node_<node>_on_
new_cft> Single node architecture to Multi node architecture
The only difference between migrating from single node to multi node architecture and migrating from single node to single node architecture is the catalog migration step. Since there is no catalog named cftcata in multi-node, you should import the catalog exported from single node architecture to the catalog of any of the nodes in the multi-node architecture.
Activate Central Governance connectivity
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.
You can perform this activation procedure only after completing an upgrade or migration to Transfer CFT 3.2.
Transfer CFT 3.2.2
Installation and Operation Guide 91
5 Upgrade or migrate
Overview
There are two ways to activate Transfer CFT to Central Governance connectivity following an upgrade procedure:
l Automatically activate connectivity on page 92
l Manually activate connectivity on page 93
Additional information and tasks:
l Connect to a different Central Governance system on page 95
l Use former configuration objects on page 96
l View managed features on page 96
Automatically activate connectivity
UNIX/Windows
The automatic activation is only available in UNIX/Windows. Please refer to the
Manually activate connectivity on page 93 below for z/OS or IBM i instructions.
This section describes how to run the installer in configure mode to enable Central Governance connectivity.
Note
If running in Windows, the same user who performed the initial installation (or same type of user) must start the installer.
Prerequisite
You must set the UCONF parameter cg.configuration_policy if you want to override the default policy applied by Central Governance when you register a Transfer CFT in Central Governance.
Procedure
1. Stop Transfer CFT and Copilot.
2. Start the installer's configure mode.
GUI
l UNIX: configure.sh –m gui
l Windows: In Windows Start menu, select Axway Software > Axway [installation
name] > Configure
Console
Transfer CFT 3.2.2
Installation and Operation Guide 92
5 Upgrade or migrate
l Windows: o configure32.exe –m console
o configure64.exe –m console
3. In the installer screen, select Configure your existing installation.
4. Enter the license key if required. 5. Accept or modify the UI server and service mode screen values.
6. In the Governance Mode screen, select Central Governance.
7. In the CG connectivity screen, enter the Central Governance values. For Transfer CFT z/OS installations, see Use compliant characters for the shared secret on on page 95. 8. Click Next and complete the configure procedure.
9. Once completed start Copilot, which automatically completes the registration process. You can check in Central Governance to see that the Transfer CFT displays in the Product List.
Manually activate connectivity
All OS
This section describes how to manually modify the Transfer CFT configuration to enable Central Governance connectivity in command line.
Prerequisites
1. Stop Transfer CFT and Copilot if running.
2. Enabling Central Governance c onnectivity after an upgrade implies replacing any standalone connectors. Therefor, prior to connecting to Central Governance deactivate all previously activated connectors, for example PassPort AM, PassPort PS, and Sentinel.
CFTUTIL uconfunset id=am.type
CFTUTIL uconfunset id=sentinel.xfb.enable
CFTUTIL uconfset id=pki.type, value=cft
Note
When running in a z/OS environment you must additionally set the am.passport.superuser with the user that will start the Copilot server.
3. Ensure that all UCONF values used to identify a Transfer CFT instance are defined. These parameters include:
l cft.full_hostname
l cft.instance_id
l cft.instance_group
Use the format:
Transfer CFT 3.2.2
Installation and Operation Guide 93
5 Upgrade or migrate
CFTUTIL uconfset id=cft.instance_id, value=<cft_id>
You must set the UCONF parameter cg.configuration_policy if you want to override the default policy applied by Central Governance when you register a Transfer CFT in Central Governance.
Procedure
The manual procedure consists of the following steps, which are detailed below:
1. Include certificates in the PKI database.
2. Set the UCONF parameter values for Central Governance.
3. Enable Central Governance.
4. Start Copilot.
Include certificates
You must include the certificate authority that is used to validate communication with Central Governance in the PKI database. You can personalize this certificate on the Central Governance side, so be sure to use the correct iname in the pkicer command.
You can use any ID for this certificate. Transfer CFT uses the certificate ID defined in UCONF to communicate with Central Governance.
Note
Modify the filename syntax to accommodate your specific platform.
PKIUTIL pkicer
id = 'CG_CA',
iform
= 'PEM',
iname
= '$CFTPKIDIR/passportCA.pem',
itype
= 'ROOT',
pkifname = '$CFTPKU',
pkipassw = 'CFT',
state
= 'ACT',
mode
= 'CREATE'
After inserting the correct certificate in the PKI database, define the UCONF variable cg.ca_cert_id. This value is required so that Transfer CFT knows which certificate to use when communicating with Central Governance.
CFTUTIL uconfset id=cg.ca_cert_id, value='CG_CA'
Transfer CFT 3.2.2
Installation and Operation Guide 94
5 Upgrade or migrate
Set UCONF values
Use the Central Governance installation values for the following UCONF settings. Transfer CFT uses these values to identify Central Governance.
l cg.host
l cg.port
l cg.mutual_auth_port
l cg.shared_secret
Use the format:
CFTUTIL uconfset id=cg.host, value=<host_value>
Use compliant characters for the shared secret
When setting the Central Governance "shared secret" during a Transfer CFT z/OS installation, translation issues may occur if you use certain characters. For example, if you enter !SECRET (using code page IBM1147) the shared secret is translated to §SECRET during the Central Governance registration. Therefore, you must use compliant characters in the shared secret value when working in a z/OS environment.
Enable Central Governance
CFTUTIL uconfset id=cg.enable, value=yes
Register
Start the Transfer CFT Copilot to trigger an automatic registration with Central Governance.
You can check in the Central GovernanceProduct List to confirm that the registration was successful.
Connect to a different Central Governance
system
If Transfer CFTwas previously registered on a Central Governance system but you now want to register it on a different one, perform the steps in Manually activate connectivity and as a final step, prior to starting Copilot, reset the Central Governance registration id.
CFTUTIL uconfunset id=cg.registration_id
Transfer CFT 3.2.2
Installation and Operation Guide 95
5 Upgrade or migrate
.
Use former configuration objects
In Central Governance you can use the Legacy Flows feature to view and use an imported configuration. For more information, please refer to the Central Governance documentation.
View managed features
After successfully upgrading and activating Central Governance connectivity, you can manage the following Transfer CFT features from Central Governance. The "Supported but not configurable" column lists features that you can retain, though you cannot manage them from the Central Governance interface.
Feature
Manage using
Central Governance
Supported but not
configurable using
Central Unified Flow
Management
yes (1)
yes
Multi-node architecture
no
yes
CRONJOB
no
yes
Exits
no
yes IPv6
yes
yes
pTCP (UNIX/Windows only)
yes yes UDT (UNIX/Windows only)
yes
yes
SOCKS
no
yes
embedded
yes
Secure Relay no
yes
TrustedFile no
yes Folder monitoring
Network features
Heartbeat Interoperability
(Not available on IBM i)
Transfer CFT 3.2.2
Installation and Operation Guide 96
5 Upgrade or migrate
Feature
Manage using
Central Governance
Supported but not
configurable using
Central Unified Flow
Management
PassPort AM
embedded
no (2)
PassPort PS
no
yes
embedded
yes
no
no
PeSIT
yes
yes ODETTE
no
yes
EBICS no
yes
Sentinel
Composer
Protocols
1. IBM i and z/OS only support folder monitoring on UNIX file systems.
2. If you perform a migration or upgrade from a previous version, you must migrate your PassPort AM. Post-migration procedure
Post manual migration or auto import
If you performed an install and auto import or a manual migration, you must manually import compiled objects and exec scripts from the old configuration. There are no Transfer CFT commands to import these compiled objects and exec scripts, and they are not included in the auto import process.
Note
After completing an upgrade or a migration procedure, you must update to the most recent SP. Compiled objects: APIs and Exits
To manually migrate your API and exit binary files after migrating, copy your program's source code to the new Transfer CFT 3.2.2 runtime directory and compile them.
1. Copy the API source code to <new_Transfer CFT_3.2.2_installation_
dir>/runtime/src/capi and compile.
Transfer CFT 3.2.2
Installation and Operation Guide 97
5 Upgrade or migrate
2. Copy the Exit source code to <new_Transfer CFT_3.2.2_installation_
dir>/runtime/src/exit and compile.
Exec scripts
Copy the exec scripts to <new_Transfer CFT_3.2.2_installation_dir>/runtime/exe. It is important that you update any paths that you were using in the exec scripts to reflect the new installation directory.
Post manual migration only
Migrating UCONF parameters from a previous Transfer
CFT version
You must manually migrate UCONF parameters for versions prior to Transfer CFT 2.5.1. The UCONF configuration replaces the following configuration files: l Sentinel configuration file (trkapi.cfg, trkapi.conf, and so on...)
The parameters in the Sentinel file are integrated in UCONF as sentinel.FORMER-PARAMETERNAME. For example, TRKTNAME becomes sentinel.TRKTNAME. l Copilot ini file ( copconf.ini) This file no longer exists. All former Copilot parameters are named copilot.SECTION.PARAMETER-NAME in the UCONF interface. For example, the parameter ServerPort, located in the general section, is now copilot.general.serverport. l The profile file, formerly ENV_CFT or cft.ini, now uses UCONF to set the environment variables.
Post upgrade
If you performed an upgrade, you need only recompile your APIs and Exits. Transfer CFT 3.2.2
Installation and Operation Guide 98
Uninstall
6
This topic describes how to uninstall Transfer CFT. If you uninstall a Transfer CFT, you will lose the complete Transfer CFT c onfiguration. To avoid this, save your environment (sample, exit, …) before removing the Transfer CFT.
About uninstalling in Windows
The same user that did the initial installation (or at least the same type of user) must start the uninstall 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
Before you begin uninstalling, you must stop the servers you want to uninstall. 1. You can run the installer in uninstall mode using GUI or console mode as follows. Enter:
If you installed products on Windows in service mode, the installer removes the service.
GUI mode
Windows: In the Start menu, select Axway Software > Axway [installation name] > Uninstall
Console mode
Transfer CFT 3.2.2
Installation and Operation Guide 99
6 Uninstall
Windows: l uninstall32.exe –m console
l uninstall64.exe –m console
3. Click Uninstall when prompted. A warning message displays; click Yes to continue with the uninstall. 4. Click Next to see the uninstall summary, and Finish to exit. Transfer CFT 3.2.2
Installation and Operation Guide 100
Deployment packages
7
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:
l Installing a template Transfer CFT 3.2.2
l Configuring as required to meet your business needs
l Generating an Express Package that is based on the configured template
l Optionally customizing the Express Package
l 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:
l Static configuration, such as protocols (CFTPROT), networks (CFTNET), UCONF parameters, and so on
l 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.
l Flows (CFTSEND and CFTRECV)
l SSL certificates
l Processing scripts and EXITs
l Additional Axway components that you use with Transfer CFT, such as Central Governance
Transfer CFT 3.2.2
Installation and Operation Guide 101
7 Deployment packages
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. Windows: The default Axway installation directory is C:\Axway.
Run the configure32.exe or configure64.exe executable depending on the platform.
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. o The format of the service pack name is Transfer_CFT_<version>_SP<SPNumber>_
<platform>_BN<buildNumber>.jar.
o 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.
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.
10. In the Configuration confirmation page, click Configure to generate the Express Package. Transfer CFT 3.2.2
Installation and Operation Guide 102
7 Deployment packages
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 c an skip this section.
The ExpressPackage directory contains the:
l data directory: This directory contains the data exported from the Transfer CFT template. o bin directory: This directory contains all files retrieved from CFTDIRRUNTIME/bin. o exec directory: This directory contains all files retrieved from CFTDIRRUNTIME/exec.
o pki directory: This directory contains all exported certificates.
o cft-parm.cfg: This file contains all of the parameter database objects ( CFTPARM, CFTCAT, CFTLOG, CFTSEND, CFTRECV, and so on).
o cft-part.cfg: This file contains all of the exported Transfer CFT p artner database objects (CFTPART, CFTTCP, and so on).
o cft-cftparm.cfg: This file contains only the CFTPARM objects to be imported during the Express Package installation.
o cft-uconf.cfg: This file contains any UCONF parameters that were configured in the template Transfer CFT.
o cft-pki.cfg: This file contains all of the PKICER commands to be executed during the Transfer CFT Express Package installation.
l 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.
l 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.
Windows
Unzip the package using your favorite zip tool.
2. Edit the expressPackage.properties file located in the ExpressPackage directory, for example tempdir/ExpressPackage. Customize installation parameters as needed. Transfer CFT 3.2.2
Installation and Operation Guide 103
7 Deployment packages
3. Rezip the package.
Windows
Browse to the ExpressPackage directory, and zip all contained files into a package named Transfer_CFT_<version>_ExpressPackage_<platform>_
<timestamp>_new.zip (excluding the original zip file).
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, and CFT_
RuntimeDir parameters.
Axway_InstallDir = /opt/Axway
CFT_InstallDir = /opt/Axway/Transfer_CFT
CFT_RuntimeDir = /opt/Axway/Transfer_CFT/runtime
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.
WINDOWS
Axway_InstallDir = %USERPROFILE%\axway
CFT_InstallDir = %USERPROFILE%\axway\cft
CFT_RuntimeDir = %USERPROFILE%\axway\cft\runtime
Install the Express Package
Note
Windows only. If you have implemented a firewall, deactivate the firewall prior to installation.
To deploy and install the Express Package:
Transfer CFT 3.2.2
Installation and Operation Guide 104
7 Deployment packages
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. Run the install executable. On Windows platforms (7/2008/2012) you must run the install executable with administrator rights.
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.
Windows
install.exe <file name>
Limitations
l Transfer CFT Express Package does not support cluster mode installations.
l Transfer CFT Express Package cannot embed a Transfer CFT upgrade pack.
Transfer CFT 3.2.2
Installation and Operation Guide 105
Troubleshooting
8
Troubleshoot installation and registration
This section lists some possible post-installation issues along with corresponding corrective actions when applicable. If corrective actions do not remedy the issue, check the Support tools section for more information, or contact Axway Support at https://support.axway.com.
Copilot server issues
Copilot doesn't start
l Check that the port is not already used by another application.
l Close all active sessions, use the syntax: copstop -f
l Check that there are no orphan "cop*" processes. If there are, manually kill these processes.
Central Governance
Troubleshoot the registration
If Copilot starts, but the Transfer CFT either does not display in the Central Governance Product
List or registers in error:
l Verify the Central Governance IP address (or FQDN) used in the Transfer CFT configuration.
l On the computer running Transfer CFT, check that you can reach Central Governance at the IP address used in the Transfer CFT configuration.
l Check that the Transfer CFT appears in the Central Governance logs. If not, typically this is because the Transfer CFT is unable contact Central Governance.
l In Central Governance check Administration > Services to ensure that Central Governance is correctly started. l Verify the shared secret for Central Governance used in the Transfer CFT configuration.
Note
Transfer CFT 3.2.2
See the Central Governance documentation for additional information and details.
Installation and Operation Guide 106
8 Troubleshooting
Registration fails after installing in service mode when
using a firewall
Windows only, firewall enabled
Transfer CFT cannot register in Central Governance when installing Copilot in service mode. l Preventive measure: Deactivate the firewall to perform the registration.
l Workaround: If you encounter this error, perform the following steps to register:
1. Stop the Copilot Windows service.
2. Manually start the service in a DOSBOX to register.
3. Accept the authorization from the Windows firewall. Re-register with Central Governance
When Central Governance sends the SSL certificates to Transfer CFT, the uconf:cg.registration_id parameter is set to a positive integer. If an error occurs, the registration process ends in error. To repeat the registration, perform the following steps: 1. Stop Transfer CFT.
2. Stop Copilot.
3. Set the uconf:cg.registration_id to its default value (-1) using the command: CFTUTIL uconfunset id=cg.registration_id
4. Start the Transfer CFT Copilot. Copilot starts the registration process.
More information
For more information on Central Governance, refer to the Central Governance1.1.2 documentation.
Transfer CFT server
Cannot start my Transfer CFT
l Check my Transfer CFT's log in Central Governance l From the local Transfer CFT runtime, try to manually start the server
o If you cannot manually start the server, refer to Support tools Support tools in the Transfer CFT User Guide. Transfer CFT 3.2.2
Installation and Operation Guide 107
8 Troubleshooting
Applying a license key
Windows
You need to apply a valid license key to Transfer CFT in the following situations:
l You perform an initial Transfer CFT installation.
l To replace an expired license key (typically after a year).
Obtain a license key
1. Install Transfer CFT. You can install Transfer CFT without a license key, and enter the key afterward. 2. After completing the installation, or for an existing installation, use the c ommand cftutil
about to retrieve your system information. 3. Contact the Axway Fulfillment team at the appropriate email address, and provide the hostname and system information.
l For a US key, contact: fulfillment@us.axway.com l For an EMEA or APAC key, contact: product.key@axway.com Apply a license key
To apply the license key(s) from the Axway Fulfillment team, enter the path to the indirection file. Place a # character before the path, for example KEY=#conf\cft.key.
l The file can contain one or multiple license keys, but it must have one key per line.
l On start up the first valid key is used.
Example
Use the CFTUTIL utility to execute the about command to find the CPU ID. Cftutil about
* model
=
* hostname = ITEM-12345
* cpuid
= 000000000000E01A
In this example, the CPU ID is 0E01A. Your hostname and cpuid will differ from the example.
Transfer CFT 3.2.2
Installation and Operation Guide 108
8 Troubleshooting
Support tools and contacting Support
This section describes the tools available to help you collect information and contact support if you are unable to troubleshoot an error or issue.
Accessing the Axway Support site
From Axway Support at https://support.axway.com, click to select Contact us for the email address and phone number of your nearest Axway support site. Opening a Support case
Before contacting Customer Support, we suggest that you start by using the Axway online patch library to see if there is a patch available for your problem, or by searching for a solution in the Knowledge Database. If you still need to contact Support, have the following information available if possible:
l Product version
l Operating system
l Cft_support
To submit a Support request, you can do the following: l Submit and track your request through the Axway Support site at support.axway.com.
l Each time you submit a support request, that request is assigned a unique number. Use this specific number when you contact Customer Support concerning that case.
l You must have a user account to submit a Support request.
Using CFT_support
The cft_support tool collects all of the needed information from the customer's Transfer CFT installation environment, including the static configuration (PARM/PART), Unified Configuration parameters (UCONF), catalog information, communication media file status (CFTCOM), log files, execution environment (variables), disk space, and so on. This information is then packaged into a archive file called cft-support-<date>(.tar.gz|.zip).
Note
When using the cft_support tool on other Operating Systems, refer to the OS-specific guide for the correct syntax.
Using Copilot
From the UI, click the debug icon. The report is saved in the Transfer CFT runtime directory, after which you are prompted to download the report to your desktop.
Transfer CFT 3.2.2
Installation and Operation Guide 109
8 Troubleshooting
Using command line
UNIX/Windows
In command line enter: cft_support collect
Activating Transfer CFT traces when a problem occurs
during the transfer
Note
ATM traces are available only when using Transfer CFT Local Administration. However Central Governance managed Transfer CFT is the recommended version.
Transfer CFT traces are managed by the Advanced Trace Manager ( ATM) component. ATM is a problem resolution assistance tool that is used to save Transfer CFT information, and retrieve previously saved Transfer CFT information.
You may need to initiate tracing in order to assist Transfer CFT Support service if an error occurs. The Transfer CFT Support service can analyze the traces to better help you resolve the issue.
Transfer CFT 3.2.2
Installation and Operation Guide 110
Download PDF
Similar pages