Copyright © 2015 Axway Software S.A.
All rights reserved.
This documentation describes the following Axway software: Transfer CFT
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 Software S.A.
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 Software S.A. may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this document. Axway Software S.A. does not warrant that this document is error free.
Axway Software S.A. recognizes the rights of the holders of all trademarks used in its publications.
The documentation may provide hyperlinks to thirdparty web sites or access to thirdparty content. Links and access to these sites are provided for your convenience only. Axway Software S.A. does not control, endorse or guarantee content found in such sites. Axway Software S.A. is not responsible for any content, associated links, resources or services associated with a thirdparty site.
Axway Software S.A. shall not be liable for any loss or damage of any sort associated with your use of thirdparty 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
What's new 2
Accessibility 4
Accessibility features of the documentation 4
Screen reader support 4
Support for high contrast and accessible use of colors 4
1 Prerequisites 6
Overview 6
License keys 6
Check your authorization 6
System requirements 7
About the Transfer CFT environment 7
Disk space and RAM requirements 7
Java 7
Installer screen resolution 8
GUI mode requirement 8
UNIX specific requirements 8
Using installer on HPUX 11i 9
Customize the kernel 10
About kernel customization 10
Why customize the kernel? 11
HPUX: Customize the kernel 12
Linux: Customize the kernel 13
Solaris: Customize the kernel 15
Default ports 16
Certificates 17
2 Install 19
Before you start 19
Installation package contents 19
Installation functions 19
Installation modes 20
Transfer CFT 3.1.3 Installation Guide 3
Installed directories 20
System language setting 20
Install Transfer CFT 20
Cluster mode screens 26
Auto import screens 26
Multinode options 28
Governance options 28
Connector options 29
Cluster installations 30
Using NFSv3 in an active/passive architecture 32
Silent mode installation 35
Installer functions 40
Installer functions 40
JRE customization 43
3 Post-installation 46
Verify your installation 46
Begin your registration with Central Governance 46
Start Copilot 46
Verify the Transfer CFT registration with Central Governance 46
Log in to Central Governance 46
Start Transfer CFT server 47
View log using Central Governance 47
4 Update 48
Use Central Governance for updates 48
Installer or products patches and service packs 48
Check product details 48
Update procedure in GUI mode 49
Remove an update 49
Remove updates in GUI mode 49
Remove updates in console mode 50
Update a multinode installation on multiple hosts 50
5 Upgade or migrate 52
Migration 52
Migrate and upgrade processes overview 52
Migrating or upgrading to enable Central Governance 52
Migration versus an upgrade 52
Upgrade Transfer CFT 55
Before you start 55
Upgrade Transfer CFT 2.6.4 to 3.1.3 57
Transfer CFT 2.7.1 to 3.1.3 60
Transfer CFT 3.0.1 to 3.1.3 62
Transfer CFT 3.1.3 Installation Guide 4
Transfer CFT 3.1.2 to 3.1.3 64
Post upgrade 66
Upgrade a Transfer CFT multinode installation 67
Before you start 67
Upgrade from Transfer CFT 3.0.1 multinode 68
Upgrade from Transfer CFT 3.1.2 multinode 70
Migration prerequisites 71
Important information before performing a migration procedure 71
Install and auto import 72
General procedure 72
Auto import in multinode architecture 74
Perform a manual migration 75
Prerequisites 75
Migrating from Transfer CFT 2.3.2 76
Migrating from Transfer CFT 2.4 79
Migrate from Transfer CFT 2.5 or 2.6 83
Migrating from Transfer CFT 2.6.4 SP2 or 2.7 86
Migrating from Transfer CFT 3.0.1 or 3.1.2 88
Activate Central Governance connectivity 92
Overview 92
Automatically activate connectivity 92
Manually activate connectivity 93
Connect to a different Central Governance system 96
Use former configuration objects 96
View managed features 97
Postmigration procedure 98
Post manual migration or auto import 98
Post manual migration only 99
Post upgrade 99
6 Uninstall 100
7 Deployment packages 102
Create a product deployment package 102
Install a template Transfer CFT 102
Generate the Express Package 103
Customize the Express Package 104
Install the Express Package 105
Limitations 106
8 Troubleshooting 107
Troubleshoot installation and registration 107
About startup and registration 107
Copilot server issues 107
Transfer CFT 3.1.3 Installation Guide 5
Central Governance 107
Transfer CFT server 108
Apply a license key 108
Obtain a license key 109
Apply a license key 109
Support tools and contacting Support 110
Accessing the Axway Support site 110
Using CFT_support 110
Troubleshoot updates and service packs 111
UNIX: Core dump recommendations 112
Transfer CFT 3.1.3 Installation Guide 6
Preface
This documentation provides information to aide you in installing, upgrading, or migrating Transfer CFT.
About Transfer CFTTransfer CFT is the file transfer component in the Axway 5 Suite platform, and provides a multiplatform, highvolume, file and message transfer service. This documentation explains how to install, configure, and manage Transfer CFT.
As of version 3.1, 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 outlineThis 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.1.3. 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.1.3 Installation 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 postinstallation.
Who should read this guideThis 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 setTransfer CFT provides a complete set of documentation, covering all aspects of using the product. These documents include the following:
l Transfer CFT 3.1.3 Release Notes
l Transfer CFT 3.1.3 User Guide (HTML)
l Axway 5 Suite Supported Platforms Guide
Support servicesThe Axway Global Support team provides worldwide 24 x 7 support, subject to validation of your license agreement. Email [email protected] or, for your local support telephone number, visit Axway Sphere at support.axway.com and click Contact Axway Support.
You can post comments and question to the Axway user forum at: forums.axway.com/index.php
What's newTransfer CFT3.1.3 offers Central Governance management for UNIX, Windows, z/OS, and IBM i platforms. Additional new product features are listed in the Changelog found in the Transfer CFT User Guide.
Documentation updates include:
Transfer CFT 3.1.3 Installation Guide 2
Preface
l General restructuring
l Getting started chapter
l Activating Central Governance chapter
l Updated installation guides for UNIX, Windows, z/OS, and IBM i
Transfer CFT 3.1.3 Installation Guide 3
Accessibility
At Axway, we strive to create accessible products and documentation for all our users.
This section describes the accessibility features of the documentation.
Accessibility features of the documentationThe 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 highcontrast mode.
l There is sufficient contrast between the text and the background color.
Transfer CFT 3.1.3 Installation Guide 4
1 Prerequisites
OverviewAxway 5 Suite products are delivered electronically from Sphere, the Axway support website. A welcome letter notifies you that your products are ready for download.
To install you will 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.
Check your authorizationVerify that you can access Sphere by going to support.axway.com and logging in. If you do not have an account, follow the instructions in your welcome letter.
Log in to download or access:
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 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, the Axway
Transfer CFT 3.1.3 Installation Guide 6
1 Prerequisites
User Forum, and documentation for all Axway products.
System requirementsThe following are the system requirements for Transfer CFT.
About the Transfer CFT environment
Unix/Linux system prerequisitesTransfer CFT requires that you install the appropriate library for your operating system:
l Linux requires the ncurses library
l Unix systems, except Linux, require the curses library
Supported operating systems and browsersRefer to the Axway 5 Suite Supported Platforms guide available on Axway Sphere at support.axway.com.
Disk space and RAM requirementsTransfer 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
JavaIf you intend to implement EBICS or Secure Relay (UNIX /Windows) you require Java 7, which is delivered with the product (except on HP PARISC and WIN IA64 where only Java 6 is delivered).
The Transfer CFT Copilot client is based on Java technology. To avoid compatibility issues, Axway provides the correct JRE which is installed during the component installation in the directory, <Axway home>/java/<platform name>/jre7, where jre7 represents the currently installed Java version.
Clients that connect to Copilot require Java 6 or higher.
Transfer CFT 3.1.3 Installation Guide 7
1 Prerequisites
Secure Relay Java prerequisites
When using Secure Relay, Java must be installed in the same environment as the Transfer CFT installation. The Master Agent is managed, but the Router Agent can be in another environment.
Installer screen resolutionWhen the Installer is run in GUI mode, a resolution of at least 800 x 600 is required.
GUI mode requirement UNIX only
To use GUI mode on UNIX note the following. GUI mode is supported on Windows, UNIX, and Linux. However, to use on UNIX platforms, the installer requires an XWindow environment. To use an XWindow distributed environment, you must export the DISPLAY environment variable: export DISPLAY=myhost.mydomain:0.0
UNIX specific requirementsUNIX users are required to have Korn Shell (ksh) installed on all UNIX machines.
UNIX user for starting the productsFor Transfer CFT you can use any user to install and start the product except the user root , which is forbidden. Make sure the user has the standard read and write permissions on the installation directory.
Umask informationThe various processes create files during the runtime execution.
To ensure that these files are properly used by all the processes, you must make sure that the user has all the rights on the created files. Use the command, umask S u=rwx.
Depending on your information system architecture and whether or not you need to share files with other products, you can grant rights on these files to users from group or others.
For this option use the command, umask S go=rx.
Red Hat 4 platformAxway Installer supports installation on a Red Hat 4 platform however:
Transfer CFT 3.1.3 Installation Guide 8
1 Prerequisites
l You must remove the JRE 7 that is delivered in the Transfer CFT package, as it is not compatible on Red Hat 4. To do so remove the following file from the package: Java/linux-x86/jre7_u51.zip
Red Hat 6 platformAxway Installer supports installation on a Red Hat 6 platform however:
l On a 64bit Linux operating system, the installer starts with the 64bit JRE by default. If it cannot find the 64bit JRE it will look for the 32bit JRE.
l If you want your installation to start smoothly on a Red Hat 6 operating system you must make sure you have the following packages installed on your system because they may not have been installed by default.
o glibc.i686
o nsssoftoknfreebl.i686
Global environment on a UNIX machineTo install on a UNIX machine, you need a specific UNIX user ID and enough free space to install in the users home directory.
The default installation path is the users home directory, but you can change the path and install all products in a specific file system.
The installation directory must not contain any subfolders or files that are owned by another user.
Using a temporary directoryThe installer needs a temporary directory when it starts to unzip and prepare the environment it requires for product or update installation.
By default, it will try one of the following directories: /tmp , /var/tmp , /usr/tmp , $HOME , $PWD.
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
Using installer on HP-UX 11iThe installer is packaged with an embedded JRE 6. For the JRE to run properly on a HPUX 11i operating system, you need to apply a linker patch to fix the problem loading libjli.sl.
The following patches are required:
Transfer CFT 3.1.3 Installation Guide 9
1 Prerequisites
HPUX 11i v1 (11.11) PARISC systems: PHSS_35385
HPUX 11i v2 (11.23) PARISC systems: PHSS_37201
HPUX 11i v3 (11.31) PARISC systems: PHSS_37202
If you do not apply the patch you will get an error message when you start the installer. Check that the AxwayInstaller# directory is deleted in the temp directory.
Customize the kernel
About kernel customizationDepending on the operating system, some customization may be mandatory to ensure that Transfer CFT operates correctly, and to maintain the overall system performance levels.
Kernel customization is not mandatory for installation, but is needed to run Transfer CFT.
This section describes the kernel parameters that you need to upgrade to ensure that the Transfer CFT operates correctly, and is comprised of the following topics:
l Why customize the kernel?
System specific customization procedures are described for the following systems:
l HPUX
l Linux
l Solaris
Note No additional steps are necessary to modify the IBM AIX kernel as the ODM (Object Data Manager) manages this.
For additional information on customization issues, contact your system administrator or the manufacturer's support service.
Customization detailsKernel customization concerns one or more of the following aspects:
l Size of the global shared memory segment: modification recommended but not mandatory
l Message queue depth: modification mandatory
l Memory allocated to TCP: modification mandatory
l Number of files used by a process: modification mandatory
Depending on the operating system, some customization may be mandatory to ensure that Transfer CFT operates correctly, and to maintain the overall system performance levels. Note the following:
Transfer CFT 3.1.3 Installation Guide 10
1 Prerequisites
l The following information requires an indepth knowledge of UNIX. To make the recommended changes, you must have superuser privileges (root). An incorrect setting could seriously affect the integrity of your system.
l The figures indicated are based on a standard system, which is the default configuration used when the operating system was installed. If you have already changed a specific setting for another application, the current parameter value must be increased by the one recommended for Transfer CFT.
Why customize the kernel?This topic explains the advantages of customizing the kernel, and additionally presents the following related subjects:
l Global memory segment
l Message queue depth
l Memory allocated to TCP
l Number of files used by a process
Global shared memory segmentBy default, you can only create a global memory segment for a size defined in terms of the kernel.
Transfer CFT can attempt to create a 32 MB global memory segment. Transfer CFT uses this global memory for data exchanges during the execution of various operational tasks. The 32 MB value represents the average size necessary to support efficient performance without slowing the system, due to memory saturation.
We strongly recommend that you change the kernel configuration, even though Transfer CFT automatically adapts to the maximum size authorized by the system. The reason for this is that if the memory is insufficient, Transfer CFT slows down significantly.
In some cases, when receiving transfers from highspeed systems via TCP, you may notice interlocks preventing Transfer CFT from running correctly. If the capacity of the system cannot support the resulting overload, you must reduce the number of concurrent transfers.
As the system can accommodate this modification, it is recommended that the maximum size of the shared memory segment be systematically increased to at least 32 MB.
Message queue depthBy default, some UNIX systems allow a maximum of 40 unread messages to transit in a message queue.
To guarantee optimum performance levels, Transfer CFT maximizes its use of the message queues. It may be that Transfer CFT requirements exceed the system capacity. This is the case particularly over TCP networks, when the remote monitor + network configuration allows a throughput exceeding the capacities of the local system. This phenomenon becomes even more likely if another application is also making intensive use of the message queues.
Transfer CFT 3.1.3 Installation Guide 11
1 Prerequisites
Memory allocated to TCPWhen first installed, Open Server allocates a certain amount of memory to allow the IP layer to operate correctly. Open Server adjusts this memory allocation as required, up to a given maximum.
When this maximum is reached, following a request by a local application, the request is refused. However, when this saturation is due to the network, Open Server waits for space to be released on the local system so that it can continue processing.
When this saturation phenomenon occurs, the remote monitor and network permit an overall throughput that is too high for the local system, given the close link between Transfer CFT and the data transiting on the network, so this space cannot be released. The phenomenon is even more likely if another application is also making intensive use of the network memory.
To ensure Transfer CFT operation, you must modify the kernel to increase the size of the memory allocated to TCP.
Number of files used by a processBy default, some UNIX systems allow a process to only open 64 files at the same time.
If you do not modify this limit, you cannot use Transfer CFT to its full potential: 64 concurrent transfers + link channels + listening channels + trace channels > 64 open files.
To achieve 64 concurrent transfers, you must modify some of the kernel properties so that it can open as many files as possible; 1024 is suggested.
HP-UX: Customize the kernelThis section provides information on customizing the HPUX kernel, and how to:
l Modify the message queue depth
l Modify the number of files used by a process
Modify the message queue depthBy default, HPUX only allows a maximum of 256 unread messages to transit in a message queue. To customize this information, increase the value of the msgtql kernel parameter to 8192.
To customize the message queue:
1. Log in as the root and enter the sam command.
2. Select the following submenus, respectively:
l Kernel Configuration
l Configurable Parameters
3. Set the pointer to the msgtql parameter.
4. Select the Modify Configurable Parameter option in the Actions menu.
Transfer CFT 3.1.3 Installation Guide 12
1 Prerequisites
5. Enter the new value of this parameter.
6. Click on OK to confirm the change.
7. Select the Add Exported File System option in the Actions menu.
8. Select the Exit option in the File menu.
9. Select the Create a new kernel now option and click on OK to confirm your selection.
Modify the number of files used by a processBy default, HPUX allows a process to open only 64 files. To customize this information, increase the value of the maxfiles kernel parameter to 1024. To do so:
1. Log in as the root and enter the sam command.
2. Select the following submenus:
l Kernel Configuration
l Configurable Parameters
3. Set the pointer to the maxfiles parameter.
4. Select the Modify Configurable Parameter option in the Actions menu.
5. Enter the new value for this parameter.
6. Click on OK to confirm the change.
7. Select the Add Exported File System option in the Actions menu.
8. Select the Exit option in the File menu.
9. Select the Create a new kernel now option and click on OK to confirm your selection.
Linux: Customize the kernelThis section describes suggested kernel customizations to perform prior to an installation to better enable Transfer CFT operations.
Kernel customization parametersThe following table lists IPC tuning parameters to consider customizing and recommended values.
Note To aid in correctly calculating semaphores, remember that each Transfer CFT has two semaphores per instance.
Parameter Recommended
value
Description
msgmax 8192 Maximum size of a message in bytes.
Transfer CFT 3.1.3 Installation Guide 13
1 Prerequisites
Parameter Recommended
value
Description
msgmnb 16384 Maximum size in bytes on a single IPC message queue.
msgmni 48 per Transfer CFT instance
See NOTE**
Maximum number of IPC message queue resources allowed.
You require as many message queues as processes per Transfer CFT instance (when using multiple instances, multiply the number of instances by the number of Transfer CFT processes).
shmall
(shmall*PAGE_SIZE)
2097152
(8 GB when page_size = 4096)
The total amount of shared memory available on the system is 2097152*4096 bytes (shmall*PAGE_SIZE) which is 8 GB.
This number may be affected by the use of a very large number of Transfer CFT instances.
shmmax 33554432 Maximum size in bytes for a shared memory segment.
shmmni 4096 Number of shared memory segment identifiers in the system.
For each Transfer CFT instance you need 2 shared memory segments, so when using multiple instances or multinode, multiply the number of instances by 2.
shmseg 10 Maximum number of shared memory segments per process.
semmsl 250 Maximum number of IPC semaphores per set.
semmns 32000 Number of IPC systemwide semaphores.
semopm 100 Maximum number of semaphore operations that can be performed per semop(2).
semmni 128 Maximum number of IPC systemwide semaphore sets.
For each Transfer CFT instance you need 2 semaphore sets, so when using multiple instances or multinode, multiply the number of instances by 2.
Transfer CFT 3.1.3 Installation Guide 14
1 Prerequisites
Note **This value is based on the number of processes started by the Transfer CFT. This minimum is typically 7, but can be in excess of 40 depending on the values for maxtask, sslmtask, Sentinel if enabled, one task for each exit, etc.
Solaris: Customize the kernelThis section describes how to customize Solaris for Transfer CFT.
l About resource controls
l Selecting a project
Solaris 10 Transfer CFT makes extensive use of System V IPC services and file access services. As of the Solaris 10 release, the corresponding configuration parameters are no longer kernel parameters, but instead can be defined as resource controls.
About resource controlsWhile most of the corresponding parameter default values are suitable for normal Transfer CFT functioning, three of these parameter values must have at least the following minimum values:
Resource control Transfer CFT minimum value
project.maxshmmemory 33554432
process.maxmsgmessages 8192
process.maxfiledescriptor 1024
This means that you must modify the corresponding resource controls to meet the requirements of the project associated with the user account that Transfer CFT will run under.
Selecting a projectIf you plan to run Transfer CFT under the "axway" user account, for example, create a project associated with the user "axway" using the following system command: projadd p 201 G axway U axway c "Axway" axway
This command creates the project "axway" and associates the uid axway and gid axway with this project.
Alternatively, you may choose to not associate a specific project with Transfer CFT. In this case, Transfer CFT will run under a project named "default".
Transfer CFT 3.1.3 Installation Guide 15
1 Prerequisites
For the following command examples, we use "cft_project" as the name of the project chosen for Transfer CFT. This can be either a specific project (named "axway", in the example above) or simply the project "default".
Change the maximum size of global memory segments
The following command sets this value to 32 MB:
projmod -s -K "project.max-shm-memory=
(privileed,33554432,deny) cft_project
Change the maximum number of messages
The following command sets this value to 8192:
projmod -s -K "process.max-msg-messages=(privileged,8192,
deny) cft_project
Change the maximum number of open files per process
The following command assigns a value of 1024 to this parameter:
projmod -s -K "process.max-file-descriptor(privileged,1024,
deny) cft_project
Default portsThe 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 17611768 for Transfer CFT. For more information, refer to: www.iana.org/assignments/servicenamesportnumbers/servicenamesportnumbers.
Component Port
PeSIT 1761
Transfer CFT 3.1.3 Installation Guide 16
1 Prerequisites
Component Port
SSL 1762
COMS 1765
Copilot 1766
Copilot for Central Governance 1767
Central Governance 12553
Central Governance SSL 12554
Secure Relay MA
ma.comm_port
6801
Secure Relay RA
ra.comm_port
ra.admin_port
6811
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 forCentral Governance (mutual authentication)
l Central Governance: Used to connect to Central Governance
CertificatesUsing 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
Transfer CFT
<Transfer_CFT>/home/extras/pki Axway_MFT_Demonstration_Root_Certificate.der
August 2020
MFT_Demonstration_User_Certificate.der
August 2015
Transfer CFT 3.1.3 Installation Guide 17
1 Prerequisites
Type Location Certificate Expires
MFT_Demonstration_User_Certificate.p12 (user)
MFT_Demonstration_User_Certificatek.der
Copilot <Transfer_CFT>home/distrib/template/conf/pki
MFT_Demonstration_User_Certificate.p12
August
2015
copilot.ssl.sslcertpassword = ********
Secure Relay
<Transfer_CFT>/home/distrib/xsr SecureRelayCA.pem January
2015
SecureRelayMasterAgent.p12
Central Governance
<Transfer_CFT>/runtime/conf/pki passportCA.pem November 2019
When using a DER certificate, you must first create a file that has a record length equal to the size of the certificate (in bytes). You can then upload the certificate to this newly created file.
Example
If the 2k_l1_user1_key.der certificate size is 1,191 bytes:
1. Create a file with a record length of 1,191.
CRTPF FILE(YOURLIB/DER_CERT) RCDLEN(1191)
2. Upload 2k_l1_user1_key.der to YOURLIB/DER_CERT on the IBMi server.
Transfer CFT 3.1.3 Installation Guide 18
2 Install
Before you startAxway Managed File Transfer is part of the Axway 5 Suite 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 documentation.
Axway Central Governance is the Axway 5 Suite 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 Sphere.
l Uncompressed or unzipped the package.
Installation package contentsThe installation package is a zip archive. Once you unzip it, it contains the product and installer program files.
Installation functionsThe installer is used to install, configure, update and uninstall Transfer CFT, which is part of the Axway 5 Suite. You can run the following installation modes:
l Install
l Configure
l Update
l Uninstall
Transfer CFT 3.1.3 Installation Guide 19
2 Install
Installation modesLocate and run the setup file in the root folder of the installation package.
GUI mode:
l UNIX/Linux: setup.sh
Console mode:
l UNIX/Linux: setup.sh m console
The setup32.exe is a 32bit build executable and will run on a 64bit platform provided that the compatibility layer has been installed.
For more information, see Installer functions.
Installed directoriesOnce you install a product, the following subdirectories 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
System language settingIf your system uses a language other than English, you will need to change the system to English for the installation and then reset to your original language as needed.
Example in a Linux environment
If you are uncertain as to the current system language setting, use the command env|grep LANG.
export LANG=en_US.utf8
Install Transfer CFT Start the installation
Transfer CFT 3.1.3 Installation Guide 20
2 Install
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.
Screen Description
Welcome Provides links to the Axway website and Sphere, the Axway support site.
Transfer CFT 3.1.3 Installation Guide 21
2 Install
Screen Description
License agreement
Select the checkbox "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 subdirectory of 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 subdirectory 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 If you select Yes in the Auto Import screen, additional screens display.
Axway Transfer CFT: Identity
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.
Axway Transfer CFT: Multinode Architecture
Select to enable multinode 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 If you enter a number to enable multinode, additional screens display.
Transfer CFT 3.1.3 Installation Guide 22
2 Install
Screen Description
Axway Transfer CFT: License key
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 option.
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 multinode 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
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 multinode, you are also prompted for the load balancer details.
Transfer CFT 3.1.3 Installation Guide 23
2 Install
Screen Description
Axway Transfer CFT: UI Server startup mode
For Windows installations, specify whether you want to start Axway Transfer CFT manually, or to have Windows start and stop it as a Windows service. Select:
l Normal mode: You must manually start and stop the Transfer CFT server
l Service mode: Windows automatically starts and stops the Transfer CFT server. If you select this option, the next installer screen sets the Service parameters.Note: To start Transfer CFT server using service mode from the Copilot server, it is imperative that Transfer CFT service be set up with a specific user account (not using the default system user). If the user is the system user, the Copilot will not be able to start Transfer CFT in service mode.
Axway Transfer CFT: UI Server startup mode
For Windows installations, specify whether you want to start Transfer CFT UI manually, or to have Windows start and stop it as a Windows service. Select:
l Normal mode: You must manually start and stop it.
l Service mode: Windows automatically starts and stops it. If you select this option, you use the next installer screen to set Service parameters.
Transfer CFT 3.1.3 Installation Guide 24
2 Install
Screen Description
Axway Transfer CFT: UI Server service
If you selected Service mode, enter values for the Windows service parameters:
l Service Name: Enter a Windows service name
l Display Name: Enter a Windows service display name
You can accept the default Service names or modify them. The installer uses these names to create a Transfer CFT service entry in the Windows registry.
l Start Type: Automatic, Manual, Disabled
l Error Control: Ignore, Normal, Severe, Critical
l Use specific account to start the service: Enables you to use a local account instead of a system account
l Domain: Enter the domain name
l Username: Name of the local account
l Password: Enter the user password
Note In multinode, 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 If you select any of the available connectors, additional screens display.
Axway Transfer CFT: Ready to install
Click Install to complete the installation process, or Previous to review or modify installation options.
Transfer CFT 3.1.3 Installation Guide 25
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 subdirectory of 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 subdirectory 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.
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.
Transfer CFT 3.1.3 Installation Guide 26
2 Install
Screen Description
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.1.3 Installation Guide 27
2 Install
Multi-node options
Screen Description
Axway Transfer CFT: Multinode Architecture
Select to enable multinode 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 check the Check key option.
You can configure up to four keys. If you do not have a license key, you can select the check box.
Deselect Check key to continue with the installation without a key. However, you cannot run Transfer CFT until you supply the license key.
Note If you are installing in multinode 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 multinode features refer to the Transfer CFT User's Guide, in the topic About multinode 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.1.3 Installation Guide 28
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 Installation 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.1.3 Installation Guide 29
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.
l Use SSL
l PKI server public certificate
l Copy certificate
l PKI server login
l PKI Server Password
l 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
l Use SSL
l AM Server public certificate
l Component instance
l Domain
l Component Login
l Component Password
l Confirm Password
Cluster installationsThis section describes the recommendations when installing Transfer CFT multinode architecture.
Note Before starting a new Transfer CFT multinode installation, check the prerequisites and Release Notes.
OverviewA multinode installation architecture allows installing Transfer CFT binaries on several hosts, physical or virtual server, and Transfer CFT runtime files on shared file system.
Transfer CFT 3.1.3 Installation Guide 30
2 Install
The multinode feature allows for executing multiple Transfer CFTs (called Transfer CFT nodes) on one or several hosts. The set of Transfer CFT nodes is called a Transfer CFT instance.
A combination of both features provides following possibilities:
l A single installation of Transfer CFT with multinode (HA)
o Install Transfer CFT using the Single installation architecture of the Axway Installer and enable the multinode architecture.
o Only one execution of the installation procedure is needed.
o Transfer CFT binaries and runtime files must be installed on a shared file system in order to be accessed from several hosts.
o Both binaries and runtime files are shared.
Note To patch Transfer CFT binaries, the Transfer CFT instance (all of Transfer CFT nodes) must be completely stopped.
Active/active multi-node (HA) installationFor a cluster installation of Transfer CFT with multinode (HA):
l Install Transfer CFT using the Cluster installation architecture of the Installer and enable the multinode architecture.
l Installation procedure must be executed on each host:
o The first host installation (meaning the first node as defined in the Axway Installer) sets the Shared directory, the <Transfer_CFT Shared> directory and all of the Transfer CFT configurations.
o During each hosts installation (meaning additional nodes as defined in the Axway Installer), you are prompted to specify the shared directory, and all parameters from the first installation will be automatically loaded.
l Transfer CFT binaries are installed on several hosts and runtime files are installed on a shared file system.
l Only runtime files are shared.
l At any given time:
o One or several hosts are active.
o All Transfer CFT runtime environments (Transfer CFT nodes) are running.
Note Transfer CFT binaries can be patched on each host one after the other without stopping the Transfer CFT instance (all of the Transfer CFT nodes).
Active/passive cluster installationFor a cluster installation of Transfer CFT without multinode (active/passive):
l Install Transfer CFT using the Cluster installation architecture of the Axway Installer and disable the multinode architecture.
Transfer CFT 3.1.3 Installation Guide 31
2 Install
l Installation procedure must be executed on each host:
o The first host installation (meaning the first node as defined in the Axway Installer) sets the Shared directory, the <Transfer_CFT Shared> directory and all of the Transfer CFT configurations.
o During each hosts installation (meaning additional nodes as defined in the Axway Installer), you are prompted to specify the Shared directory, and all parameters from the first installation will be automatically loaded.
l Transfer CFT binaries are installed on several hosts and runtime files are installed on a shared file system (such as NFSv3, NFSv4, GPFS, etc.).
l Only runtime files are shared.
l At any given time:
o Only one host is active
o Only one Transfer CFT runtime environment is running on the active host
Install the cluster nodesThere are two general steps for installing a product in a cluster.
1. Install first node in cluster.
2. Install additional nodes in cluster.
After installing a product on two or more nodes, you must configure the cluster for highavailability operations. The procedure for cluster configuration varies depending on the type of platform on which the cluster is installed.
Install first node in clusterUse this procedure to install the product on the first node in a cluster:
1. Launch the installer on the machine that supports the first node.
2. On the Installation architecture page, select Cluster and click Next.
3. On the Cluster page, select First node and click Next.
4. On the installation directories page, specify values for the following and click Next.
Note After installing applications in active/passive mode, you are required to implement the cft start, cft stop, and cft status scripts for the cluster.
Using NFSv3 in an active/passive architectureThe recommendations in this topic apply to a Transfer CFT active/passive mononode architecture based on an NFSv3 shared file system.
Transfer CFT 3.1.3 Installation Guide 32
2 Install
l Required NFSv3 mount options
l Mount options summary
l Synchronous / asynchronous option impact
Required NFSv3 mount options
Set the hard and nointr optionsMount NFSv3 using the hard and nointr options. The intr mount option should not be available for NFSv3, but if you are in doubt, you should explicitly specify the nointr option.
Define file lockingSet 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.
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 summaryThe following table summarizes the recommended NFSv3 mount options.
Correct option Incorrect option
nolock (default) "lock" specified
hard (default) "soft" specified
nointr (not the default) "intr" specified
cto (default) "nocto" specified
Synchronous versus asynchronous optionTo 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.
Transfer CFT 3.1.3 Installation Guide 33
2 Install
ClientOn the client side, use the mount command to specify the async/sync option.
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.
ServerOn the server side, use the exports command to specify the async/sync option (NFS server export table).
Async
The async option allows the NFS server to violate the NFS protocol and reply to requests before any changes made by that request have been committed to stable storage (the disk drive, for example), even if the client is set to sync. This option usually improves performance, however data may be lost or corrupted in the case of an unclean server restart, such as an NFS server crash.
This possible data corruption is not detectable at the time of occurrence, because the async option instructs the server to lie to the client, telling the client that all data was written to stable storage (regardless of the protocol used).
Sync
Enables replies to requests only after the changes have been committed to stable storage.
Note For more information on these options, refer to NFS mount and export options in the UNIX man pages (for example, here).
Transfer CFT 3.1.3 Installation Guide 34
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 installationSilent mode enables you to perform an installation or configuration in a noninteractive 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 conceptsThe 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.
CreationA silent file can be created:
l After an installation
Transfer CFT 3.1.3 Installation Guide 35
2 Install
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.
LocationThe 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.
VariablesA silent file is a collection of parameters in the form of keyvalue 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
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).
Transfer CFT 3.1.3 Installation Guide 36
2 Install
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 UNIX and Linux: ${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
Using silent modeTo run the installer in silent mode, you need the following commands:
UNIX:
Transfer CFT 3.1.3 Installation Guide 37
2 Install
l setup.sh –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 the installer properties file (Install_Axway_Installer_V<version>.properties) and the product property files you might need to install. You should always call the Axway_Installer silent file from the command line no matter 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. You will see 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,SynchronyLogicalName and list of IncludeFiles.
The following related to the installation above is very important:
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
Install products silently in a directory with white spacesIn 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 modeTo configure an installation in silent mode, you need the following commands:
UNIX:
l configure.sh –s <the absolute path to the installer Silent File>
Silent File EditorUse 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.
Transfer CFT 3.1.3 Installation Guide 38
2 Install
LocationThe 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 lineTo modify a silent file using the command line, run:
l In UNIX: SilentFileEditor.sh
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
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
Transfer CFT 3.1.3 Installation Guide 39
2 Install
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 functionsThis section describe functions you can perform with the installer.
Display commandThe 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:
display -n <product name>
Install productTo 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 UNIX/Linux: setup.sh
Console mode
l UNIX/Linux: setup.sh m console
Transfer CFT 3.1.3 Installation Guide 40
2 Install
setup32.exe is a 32bit build executable and will run on a 64bit platform provided that the compatibility layer has been installed.
Configure productThis section describes running the installer in configure mode to change a product's configuration.
The following describes running the installer in configure mode.
GUI mode
l UNIX: configure.sh –m gui
Console mode
l UNIX: configure.sh –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 nameHost 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.
Transfer CFT 3.1.3 Installation Guide 41
2 Install
Using a temporary directoryThe 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.
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 modesYou 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 XWindow environment. To use an XWindow 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 noninteractive mode. You do not have to enter any parameters in the GUI or console.
Installer functionsThe installer command files are for invoking installer functions in GUI or console mode.
Before installing, install is the only available function, invoked with the setup file in the root directory of the installation package.
After installing, the configure, update and uninstall functions are available. The scripts for those functions are in the root installation directory.
Function Mode UNIX/Linux Windows
Install GUI setup.sh setup32.exe
setup64.exe
Console setup.sh –m console setup32 –m console
setup64 –m console
Transfer CFT 3.1.3 Installation Guide 42
2 Install
Function Mode UNIX/Linux Windows
Configure GUI configure.sh configure32.exe
configure64.exe
Console configure.sh –m console
configure32.exe –m console
configure64.exe –m console
Update GUI update.sh update32.exe
update64.exe
Console update.sh –m console update32 –m console
update64 –m console
Uninstall GUI uninstall.sh uninstall32.exe
uninstall64.exe
Console uninstall.sh –m console uninstall32.exe –m console
uninstall64.exe –m console
The configure function lets you change settings that were applied during installation.
The update function lets you apply or remove service packs and patches.
After installing the following functions are available:
l Install product
l Configure product
l Update product and Remove updates
l Uninstall product
l Transfer installation packages on remote machines
JRE customizationTo 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.
Transfer CFT 3.1.3 Installation Guide 43
2 Install
Installer-dependent deliverablesThe installerdependent 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:
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 JRETo 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 JREThis section describes running products after installing in various modes.
Normal installationWhen 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.
Transfer CFT 3.1.3 Installation Guide 44
2 Install
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.
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 installationThe 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 recomputes 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.1.3 Installation Guide 45
3 Post-installation
Verify your installation You can check the installation log in the <installation directory>/install.log file. See the installation troubleshooting section of the User Guide if you encounter problems with starting Transfer CFT or registering with Central Governance.
Begin your registration with Central Governance
Begin your registration with Central Governance by starting the Copilot server, which launches the registration process.
Start CopilotTo set the environment variables from the runtime directory prompt enter:
../profile
To start the Copilot server, run the command:
copstart
Verify the Transfer CFT registration with Central Governance
Log in to Central GovernanceIf you have not already done so, log on Central Governance.
In Central Governance from the Product page, check the Product List for your installed Transfer CFT.
Transfer CFT 3.1.3 Installation Guide 46
3 Postinstallation
See the Troubleshooting installation section in the Transfer CFT User Guide for tips in case of an error.
Start Transfer CFT serverTo start Transfer CFT from the Central Governance interface, use the following procedure.
1. Click Products on the top toolbar to open the page.
2. Select the product (Transfer CFT) to start.
3. Click Start. When started successfully, the Status column displays Started.
View log using Central Governance1. Click the name of the Transfer CFT system on the Product List page to open its details page.
2. Click Logs on the right side of the page.
The log page is displayed where you can:
l Click Refresh anytime to update the log entries.
l Sort the entries by newest or oldest.
l Filter the entries, saving filters for future use.
Note For details on starting, stopping and viewing the Transfer CFT refer to the Central Governance User Guide.
47 Installation Guide Transfer CFT 3.1.3
4 Update
This section describes how to update Transfer CFT with a patch or service pack. You can manually perform the operation, or use Central Governance.
For more information, please refer to the Central Governance documentation.
Use Central Governance for updatesYou 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
Stop Transfer CFT prior to installing a service pack or patch.
Check product detailsTo check the version, or product details prior to updating, use the display command.
The display command lists information about all installed products. The command is display.bat on Windows and display.sh on UNIX/Linux.
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.1.3 Installation Guide 48
4 Update
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 UNIX: Go to the installation folder you want to update and run update.sh
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.
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 updateThis 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.
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.
49 Installation Guide Transfer CFT 3.1.3
Update a multinode installation onmultiple hosts
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 modeFor UNIX/Linux environments:
1. From the installation root directory, launch the installer in update mode: update.sh –m gui
2. In the Welcome section, press Enter to continue.
3. In the License agreement section, accept the terms of the license agreement.
4. In the Updates Management section, select option 2, Remove one or more patches and/or service packs.
A tree of products is displayed that represents all the installed products , each of them with their latest updates.
5. Select the update you want to uninstall.
6. When you move to the next section Updates Management is displayed again, where you can perform another update action if you need to. If you do not have anymore updates to do, move to the next section.
7. Start the update execution.
8. Review the summary and exit.
Update a multi-node installation on multiple hosts
This section describes the procedure to apply a patch or service pack on a multinode architecture based on N hosts. You update a Transfer CFT multinode architecture with multihosts using the same procedure as for a patch or service pack, one host at a time.
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 restarted on the other hosts.
3. Check that the nodes are restarted 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.1.3 Installation Guide 50
5 Upgade or migrate
Migration
Migrate and upgrade processes overviewThis 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.1.3.
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 GovernanceCentral 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.1.3 you can then use the Activate Central Governance connectivity information to configure and register with Central Governance.
Migration versus an upgradeThere are three methods available for updating your Transfer CFT product version.
l Upgrade (an existing installation)
l Automatic migration
l Manual migration
About upgradesAn upgrade is the process of updating to a newer, enhanced version of the software.
Transfer CFT 3.1.3 Installation Guide 52
5 Upgade 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 multinode 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
Note The Axway Installer keeps a history of your installation and configuration updates. This means that after performing an upgrade procedure, the Transfer CFT 3.1.3 Installation directory size will be larger than (possibly significantly) the initial Transfer CFT 313 installation directory size.
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 migrationsA 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 OSappropriate installation kit to install the Transfer CFT 3.1.3 in a new directory, and select the installation option to migrate the existing configuration to this new version. You are only required to provide the path of the Transfer CFT (n1) version to retrieve this old configuration.
About install and automatic importYou can use the automatic installation procedure to migrate from your current version of Transfer CFT to Transfer CFT 3.1.3. This automigration procedure occurs when you perform the Transfer CFT 3.1.3 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.
Transfer CFT 3.1.3 Installation Guide 53
5 Upgade or migrate
About manual migrationsA manual migration procedure, also used for migrating your existing Transfer CFT to Transfer CFT 3.1.3, is available and described in this document.
The general procedure for migrating from a previous version of Transfer CFT to Transfer CFT 3.1.3 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.1.3.
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 detailsTo check the version, or product details prior to updating, use the display command.
The display command lists information about all installed products. The command is display.bat on Windows and display.sh on UNIX/Linux.
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 informationIf you encounter issues when migrating Transfer CFT, contact Axway Support at https://support.axway.com.
Transfer CFT 3.1.3 Installation Guide 54
5 Upgade 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, or 3.1.2 to Transfer CFT 3.1.3. It begins by detailing the prerequisites for a standalone (non multinode) upgrade. For details on upgrading a multinode installation, see Upgrade Transfer CFT on page 55.
Before you startBefore 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 Sphere at support.axway.com. The Transfer CFT Upgrade Pack name has the general format 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_<OS>_BN<build_number>.jar.
Where:
** is the UP number
<OS> is the operating system
l Stop the Transfer CFT server and the Transfer CFT UI server. Enter:
cft stop
copstop -f
Determine the Axway Installer and product versionYou 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 40 and JRE customization on page 43.
Start the Axway Installer. The method depends on the Installer version and your OS:
l Versions lower than 4.5.x:
o Windows: setupwin32.exe update
o Unix: update.sh update
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
Transfer CFT 3.1.3 Installation Guide 55
5 Upgade or migrate
Display product information The display command lists information about all installed products. The command is display.bat on Windows and display.sh on UNIX/Linux.
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.1.3 Installation Guide 56
5 Upgade or migrate
Upgrade Transfer CFT 2.6.4 to 3.1.3Preconditions: 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 prior 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 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.
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_UP7from4.3.1_winx8664_BN16272.jar.
3. Start the Axway Synchrony Installer in update mode.
Windows: C:\Axway\Synchrony\setupWIN32.exe update
Unix/Linux: ***Axway/Synchrony/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_winx8664_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.1.3 Installation Guide 57
5 Upgade or migrate
Unix/Linux: setupUNIX.sh update
2. Apply the Synchrony_Installer_4.5.0_UP1from4.4.04.4.1_allOS_BN1204251050.jar.
3. Start the Axway Installer.
Note The program commands change in this step!
Windows: update32.exe or 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_winx8664_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 5: Upgrade to Axway Installer 4.8.0
Run the Axway Installer in update mode.
1. Start the Axway Installer.
Windows: update32.exe or update64.exe
Unix/Linux: update.sh
2. Apply the Axway_Installer_4.8.0_UP2from4.5.x4.6.14.7.0_*****_multiOS_BN2.jar.
Where ***** represents the platform
Example: Axway_Installer_4.8.0_UP2from4.5.x4.6.14.7.0_winx86_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP1from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_*****_BN8294000.jar
Where ***** represents the platform
Transfer CFT 3.1.3 Installation Guide 58
5 Upgade or migrate
Example: Transfer_CFT_3.1.3_UP1from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_winx8664_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the platform
For example, Transfer_CFT_3.1.3_SP3_aixpower64_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.
Transfer CFT 3.1.3 Installation Guide 59
5 Upgade or migrate
Transfer CFT 2.7.1 to 3.1.3Preconditions: 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 completing the upgrade).
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_winx8664_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, 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.5.0_UP1from4.4.04.4.1_allOS_BN1204251050.jar.
3. Start the Axway Synchrony Installer.
Note The program commands change in this step!
Windows: update32.exe or 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.1.3 Installation Guide 60
5 Upgade or migrate
For example, JREUpdateTool_4.5.0_Utility_winx8664_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Axway_Installer_4.8.0_UP**from4.5.x4.6.14.7.0_*****_multiOS_BN2.jar
Where ** is the UP version and ***** represents the platform
For example, Axway_Installer_4.8.0_UP2from4.5.x4.6.14.7.0_winx86_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP**from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_*****_BN8294000.jar
Where ** is the UP version and ***** represents the platform.
For example, Transfer_CFT_3.1.3_UP2from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_winx8664_BN8294000.jar
Step 6: Upgrade to the latest Transfer CFT 3.1.3 Service Pack
1. Start the Axway Installer:
Windows: update32.exe or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the platform
Example: Transfer_CFT_3.1.3_SP3_aixpower64_BN8712000.zip
Note In this step you are now working with a zip file (it was a jar file 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.1.3 Installation Guide 61
5 Upgade or migrate
Transfer CFT 3.0.1 to 3.1.3Preconditions: 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.
Step 1: Upgrade to Axway Installer 4.8.0
Use the Axway Installer in update mode:
1. Start the Axway Installer:
Windows: update32.exe or update64.exe
Unix/Linux: update.sh
2. Apply Axway_Installer_4.8.0_UP2from4.5.x4.6.14.7.0_*****_multiOS_BN2.jar
Where ***** represents the platform
For example, Axway_Installer_4.8.0_UP2from4.5.x4.6.14.7.0_winx86_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP**from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_*****_BN8294000.jar
Where ** is the UP version and ***** represents the platform.
Example: Transfer_CFT_3.1.3_UP2from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_winx8664_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 or update64.exe
Unix/Linux: update.sh
Transfer CFT 3.1.3 Installation Guide 62
5 Upgade or migrate
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the platform
Example: Transfer_CFT_3.1.3_SP3_aixpower64_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.
Transfer CFT 3.1.3 Installation Guide 63
5 Upgade or migrate
Transfer CFT 3.1.2 to 3.1.3Preconditions: Minimum versions for this procedure
The current installation must be at least at the levels listed below.
l Transfer CFT version is 3.1.2_SP1
l Installer 4.6.1_SP3
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 or update64.exe
Unix/Linux: update.sh
2. Apply the Axway_Installer_4.8.0_UP**from4.5.x4.6.14.7.0_*****_multiOS_BN2.jar
Where ** is the UP version and ***** represents the platform.
Example: Axway_Installer_4.8.0_UP2from4.5.x4.6.14.7.0_winx86_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_UP**from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_*****_BN8294000.jar
Where ** is the UP version and ***** represents the platform.
Example: Transfer_CFT_3.1.3_UP2from2.6.22.6.32.6.42.7.02.7.13.0.13.1.2_winx8664_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 or update64.exe
Unix/Linux: update.sh
2. Apply the Transfer_CFT_3.1.3_SP*****.zip
Where ***** represents the SP level and the platform
Transfer CFT 3.1.3 Installation Guide 64
5 Upgade or migrate
Example: Transfer_CFT_3.1.3_SP3_aixpower64_BN8712000.zip
Note In this step you are working with a zip file (not a jar as in earlier Installer versions). Do NOT unzip/uncompress the zip file.
Transfer CFT 3.1.3 Installation Guide 65
5 Upgade or migrate
Post upgradeAfter completing the upgrade procedure, your Transfer CFT 3.1.3, exec scripts, APIs, and Exits are all operational.
Check the new versionUse the ABOUT command to check the Transfer CFT version, license key and system information. Enter:
CFTUTIL ABOUT
Transfer CFT 3.1.3 Installation Guide 66
5 Upgade or migrate
Upgrade a Transfer CFT multi-node installation
This section describes how to upgrade a multinode, multihost Transfer CFT from version 3.0.1 or 3.1.2 to Transfer CFT 3.1.3.
Before you startBefore 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 Axway Installer and product version on page 55.
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.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_<OS>_BN<build_number>.jar, where ** is the UP number.
Transfer CFT 3.1.3 Installation Guide 67
5 Upgade or migrate
Upgrade from Transfer CFT 3.0.1 multi-nodeFor details on shared disks, node commands, and other multinode considerations, refer to the Transfer CFT 3.1.3 User Guide > Manage multinode 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
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 the additional hostsRepeat the above upgrade procedure on each additional host.
Restart the upgraded Transfer CFT multihost multi-node 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
2. Check the new version using the following command:
CFTUTIL ABOUT
3. Start Copilot (start each of the Copilots in the multinode environment).
copstart
4. After restarting the Copilots, restart the Transfer CFT server:
cft restart
Transfer CFT 3.1.3 Installation Guide 68
5 Upgade or migrate
5. Check the upgraded Transfer CFT multinode 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 3.1.3, 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.1.3 Installation Guide 69
5 Upgade or migrate
Upgrade from Transfer CFT 3.1.2 multi-nodeFor details on shared disks, node commands, and other multinode considerations, refer to the Transfer CFT 3.1.3 User Guide > Manage multinode 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
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 the additional hostsRepeat the above upgrade procedure on each additional host.
Restart the upgraded Transfer CFT multihost multi-node 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
2. Check the new version using the following command:
CFTUTIL ABOUT
3. Start Copilot (start each of the Copilots in the multinode environment).
copstart
4. After restarting the Copilots, restart the Transfer CFT server:
cft restart
Transfer CFT 3.1.3 Installation Guide 70
5 Upgade or migrate
5. Check the upgraded Transfer CFT multinode 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 3.1.3, 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.
Check the new versionUse the ABOUT command to check the Transfer CFT version, license key and system information. Enter:
CFTUTIL ABOUT
Migration 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.8.0, if you are not at this version or higher, prior to upgrading your Transfer CFT 3.1.3.
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.1.3 PKI database.
About license keysYou require a new license key if you are migrating from a version 2.x Transfer CFT to a version 3.x.
Transfer CFT 3.1.3 Installation Guide 71
5 Upgade or migrate
Install and auto import The install and auto import option allows you to perform a new Transfer CFT installation and import configuration files and data from an 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.
Use the ABOUT command to check the Transfer CFT version, license key and system information. Enter:
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 procedureIn 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 installationBegin a typical installation using the Transfer CFT 3.1.3 installation instructions that correspond to your operating system.
Importing configuration and dataPending the existing version of Transfer CFT, the installer will propose available import options.
Auto import screensAt 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.
Transfer CFT 3.1.3 Installation Guide 72
5 Upgade or migrate
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 importIf you used the install and auto import procedure with your existing Transfer CFT to Transfer CFT 3.1.3, 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 reimport 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.
cftconf.cfg Transfer CFT general configuration, which is applied to the new installation (contained in CFTPARM/CFTPART internal datafiles).
cftconfwarning.txt
Contains file path declarations from the cftconf.cfg file that were used in the former Transfer CFT environment and that cannot be imported into the new installation.
cftpki.cfg The PKI configuration that is applied to the new installation (as of version 2.4).
PKI directory Contains extracted SSL certificates (pending version).
cftuconf.(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.
Transfer CFT 3.1.3 Installation Guide 73
5 Upgade or migrate
File Directory Description of extracted data
cftuconfwarning.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 reimport 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 multinode in multihosts.
ProcedureThe automatic import is performed during the Transfer CFT 3.1.3 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.1.3 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 reimport this data at any time.
If you are installing and performing an auto import from a Transfer CFT with multinode 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.
cftconf.cfg Transfer CFT general configuration, which is applied to the new installation (contained in CFTPARM/CFTPART internal datafiles).
Transfer CFT 3.1.3 Installation Guide 74
5 Upgade or migrate
File Directory Description of extracted data
cftconfwarning.txt
Contains file path declarations from the cftconf.cfg file that were used in the former Transfer CFT environment and that cannot be imported into the new installation.
cftpki.cfg The PKI configuration that is applied to the new installation, as of version 2.4.
PKI directory Contains extracted SSL certificates (pending version).
cftuconf.(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.
cftuconfwarning.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 reimport the collected data into a new installation, and includes the PKI, general configuration, UCONF parameters, catalog and communication media files.
Perform a manual migration
Prerequisites
Install Transfer CFT 3.1.3Perform a Transfer CFT installation, as described in the OSspecific installation section.
Note Do not use the Install and auto import option available in the Installer.
After performing a Transfer CFT 3.1.3, you should update the to the most recent service pack.
Transfer CFT 3.1.3 Installation Guide 75
5 Upgade or migrate
Load the environment Before beginning the manual migration procedure, you must load the old Transfer CFT environment.
UNIX procedure
Transfer CFT 2.3.2 and 2.4
From the console, execute the profile file for your version of Transfer CFT, which is by default located in the home directory. Enter: . ./ENV_CFT
Transfer CFT 2.5 and higher
From the console, change directory to the Transfer CFT runtime directory and execute the profile file using the command: . ./profile
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.1.3.
Migrating the configuration
Migrating the main configurationMigrate PARM, PART, IDF and other static configuration objects.
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, cftextract.conf, and update the file paths with those of the Transfer CFT 3.1.3 installation.
4. Load the Transfer CFT 3.1.3 environment.
5. Import your static configuration objects using the cftinit command. Enter:
cftinit cft-extract.conf
Transfer CFT 3.1.3 Installation Guide 76
5 Upgade or migrate
Migrating trkapi.cfg file parameters
1. In the trkapi.cfg file, select the parameters you want to import into 3.1.3.
2. Create a script file, for example:
o UNIX: trkapiimport.sh
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
XFB.Sentinel sentinel.xfb.enable
XFB.Trace sentinel.xfb.trace
XFB.Transfer sentinel.xfb.transfer
Load the Transfer CFT 3.1.3 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 UNIX: CFTUTIL @trkapiimport.sh
Transfer CFT 3.1.3 Installation Guide 77
5 Upgade or migrate
Migrating PKI certificatesExporting 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.1.3 runtime using the PKIUTIL PKIFILE command. Next import each certificate using the PKIUTIL PKICER command.
For more information, refer to the Transfer CFT 3.1.3 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.1.3 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 UNIX: _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 3.1.3 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 systemspecific environment variable:
o UNIX: _CFTCOM
CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_
filename_new_installation>
Transfer CFT 3.1.3 Installation Guide 78
5 Upgade or migrate
Migrating from Transfer CFT 2.4 This topic describes how to migrate from Transfer CFT 2.4 to version 3.1.3. Before starting this migration procedure you must perform the steps described in Before you start.
Migrating the configuration
Migrating the main configurationMigrate 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=cftextract.conf
3. Open the extract configuration files, cftextract.conf, and update the file paths with those of the Transfer CFT 3.1.3 installation.
4. Load the Transfer CFT 3.1.3 environment.
5. Import your static configuration objects using the cftinit command. Enter:
cftinit cft-extract.conf
Migrating trkapi.cfg file parametersMigrate 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.1.3.
2. Create a script file, for example:
o UNIX: trkapiimport.sh
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
Transfer CFT 3.1.3 Installation Guide 79
5 Upgade or migrate
Parameter in trkapi.cfg Parameter names in UCONF
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.1.3 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 UNIX: CFTUTIL @trkapiimport.sh
Migrating copconf.ini parametersMigrate 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.1.3.
2. Create a script file, for example:
o UNIX: copconfimport.sh
3. For each selected parameter add a UCONF command line in your new script file using the format:
UCONFSET id=<parameter_id>, value=<value>
Transfer CFT 3.1.3 Installation Guide 80
5 Upgade or migrate
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
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.1.3 environment.
Transfer CFT 3.1.3 Installation Guide 81
5 Upgade or migrate
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 UNIX: CFTUTIL @copconfimport.sh
Migrating PKI certificatesYou 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.1.3 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_database_filename> with the appropriate variable:
o UNIX: $CFTPKU
PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’
5. Import your PKI certificates into Transfer CFT 3.1.3 using the command PKIUTIL. Replace the <script_filename> with the new script file path.
PKIUTIL <prefix_character><script_filename>
Example
l UNIX: PKIUTIL @pkiextract.conf
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.1.3 environment.
Transfer CFT 3.1.3 Installation Guide 82
5 Upgade or migrate
4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_installation> with the corresponding environment variable:
o UNIX: _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.1.3 environment.
4. Import the communication media file using command CFTMI. Replace <com_filename_new_installation> with the corresponding environment variable:
o UNIX: _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.1.3.
Migrate the configuration
Migrating the main configurationMigrate 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, cftextract.conf, and update the file paths with those of the new Transfer CFT 3.1.3 installation.
4. Load the new Transfer CFT 3.1.3 environment.
Transfer CFT 3.1.3 Installation Guide 83
5 Upgade or migrate
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.1.3.
4. Create a script file such as:
l UNIX: uconfimport.sh
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.1.3 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 UNIX: CFTUTIL @uconfimport.sh
Migrating PKI certificatesFor 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=pkiextract.conf
3. Load the new Transfer CFT 3.1.3 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’
l UNIX: $CFTPKU
Transfer CFT 3.1.3 Installation Guide 84
5 Upgade or migrate
5. Import your PKI certificates into the new Transfer CFT 3.1.3 using the command PKIUTIL. Replace the <script_filename> with the new script file path: PKIUTIL <prefix_character><script_filename>
Example
l UNIX: PKIUTIL @pkiextract.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.1.3 environment.
4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_installation> with the corresponding environment variable:
l UNIX: _CFTCATA
Table 4. Example
CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_installation>
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.1.3 environment.
4. Import the communication media file using command CFTMI. Replace the <com_filename_new_installation> with the corresponding environment variable:
o UNIX: _CFTCOM
Transfer CFT 3.1.3 Installation Guide 85
5 Upgade or migrate
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.7This topic describes how to migrate Transfer CFT 2.6.4 SP2, or higher, or 2.7 to version 3.1.3.
Migrating the main configuration and UCONF parametersYou 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, cftextract.conf, and update the file paths with those of the new Transfer CFT 3.1.3 installation.
4. Load the new Transfer CFT 3.1.3 environment.
5. Import your static configuration objects using the cftinit command. Enter:
cftinit cft-extract.conf
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.1.3 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’
Transfer CFT 3.1.3 Installation Guide 86
5 Upgade or migrate
5. Import your PKI certificates into the new Transfer CFT 3.1.3 using the command PKIUTIL. Replace the <script_filename> with the new script file path:
PKIUTIL <prefix_character><script_filename>
Examples
• UNIX: PKIUTIL @pkiextract.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.1.3 environment.
4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_installation> with the corresponding environment variable:
l UNIX: _CFTCATA
Example
CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,
ofname=<catalog_filename_new_installation>
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.1.3 environment.
4. Import the communication media file using command CFTMI. Replace the <com_filename_new_installation> with the corresponding environment variable:
l UNIX: _CFTCOM
Example
Transfer CFT 3.1.3 Installation Guide 87
5 Upgade or migrate
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.2This topic describes how to migrate Transfer CFT 3.0.1 or 3.1.2 to version 3.1.3. It is divided in 2 sections, the first section describes migration for a single node architecture, and the second section multinode 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, cftextract.conf, and update the file paths with those of the new Transfer CFT 3.1.3 installation.
4. Load Transfer CFT 3.1.3 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.1.3 environment.
4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_database_filename> with the appropriate value: $CFTPKU for UNIX, . Enter:
Transfer CFT 3.1.3 Installation Guide 88
5 Upgade or migrate
PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’
5. Import your PKI certificates into Transfer CFT 3.1.3 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.1.3 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:
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.1.3 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:
Transfer CFT 3.1.3 Installation Guide 89
5 Upgade or migrate
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, cftextract.conf, and update the file paths with those of the new Transfer CFT 3.1.3 installation.
4. Load Transfer CFT 3.1.3 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=pkiextract.conf
3. Load the Transfer CFT 3.1.3 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.1.3 using the command PKIUTIL. Replace the <prefix_character> based on your system, @ for UNIX and # for Windows. Enter:
PKIUTIL <prefix_character>pki-extract.conf
Transfer CFT 3.1.3 Installation Guide 90
5 Upgade or migrate
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.1.3 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>
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.1.3 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>
Transfer CFT 3.1.3 Installation Guide 91
5 Upgade or migrate
Single node architecture to Multi node architectureThe 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 multinode, you should import the catalog exported from single node architecture to the catalog of any of the nodes in the multinode architecture.
Activate Central Governance connectivityCentral 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.1.3.
OverviewThere are two ways to active 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 96
l Activate Central Governance connectivity on page 92
l Use former configuration objects on page 96
l View managed features on page 97
Automatically activate connectivityUNIX/Windows
The automatic activation is only available in UNIX/Windows. Please refer to the Manual activation procedure 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 did the initial installation (or same type of user) must start the installer.
Transfer CFT 3.1.3 Installation Guide 92
5 Upgade or migrate
PrerequisiteYou 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 configure mode.
GUI
l UNIX: configure.sh –m gui
l Windows: In Windows Start menu, select Axway Software > Axway [installation name] > Configure
Console
l UNIX: configure.sh –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.
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 connectivityAll 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 connectivity after an upgrade implies replacing any standalone connectors. Therefore, prior to connecting to Central Governance deactivate all previously activated connectors, for example PassPort AM, PassPort PS, and Sentinel.
3. Start a CFTUTIL command session, and then enter:
Transfer CFT 3.1.3 Installation Guide 93
5 Upgade or migrate
uconfunset id=am.type
uconfunset id=sentinel.xfb.enable
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.
4. 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
From a CFTUTIL command session, use the format:
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.
ProcedureThe 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 certificatesYou 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',
Transfer CFT 3.1.3 Installation Guide 94
5 Upgade or migrate
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.
From a CFTUTIL command session, enter:
uconfset id=cg.ca_cert_id, value='CG_CA'
Set UCONF valuesUse 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
From a CFTUTIL command session, enter:
uconfset id=cg.host, value=<host_value>
Enable Central GovernanceFrom a CFTUTIL command session, enter:
uconfset id=cg.enable, value=yes
RegisterStart the Transfer CFT Copilot to trigger an automatic registration with Central Governance.
You can check in the Central Governance Product List to confirm that the registration was successful.
Transfer CFT 3.1.3 Installation Guide 95
5 Upgade or migrate
Connect to a different Central Governance systemIf Transfer CFT was 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.
From a CFTUTIL command session, enter:
uconfunset id=cg.registration_id
Use former configuration objectsIn 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.
Transfer CFT 3.1.3 Installation Guide 96
5 Upgade or migrate
View managed featuresAfter 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 Governance
Folder monitoring yes (1) yes
Multinode architecture no yes
CRONJOB no yes
Exits no yes
Network features
IPv6 yes yes
pTCP (UNIX/Windows only) yes yes
UDT (UNIX/Windows only) yes yes
SOCKS no yes
Heartbeat embedded yes
Interoperability
Secure Relay no yes
TrustedFile no yes (Not available on IBM i)
PassPort AM embedded no (2)
PassPort PS no yes
Sentinel embedded yes
Composer no no
Protocols
Transfer CFT 3.1.3 Installation Guide 97
5 Upgade or migrate
Feature Manage using Central Governance
Supported but not configurable using Central Governance
PeSIT yes yes
ODETTE no yes
EBICS no yes
1. IBM i and z/OS only support folder monitoring on UNIX file systems.
2. If you are performing a migration or upgrade from a previous version, you must migrate your PassPort AM.
Post-migration procedure
Post manual migration or auto importIf 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 ExitsTo manually migrate your API and exit binary files after migrating, copy your program's source code to the new Transfer CFT 3.1.3 runtime directory and compile them.
1. Copy the API source code to <new_Transfer CFT_3.1.3_installation_dir>/runtime/src/capi and compile.
2. Copy the Exit source code to <new_Transfer CFT_3.1.3_installation_dir>/runtime/src/exit and compile.
Exec scriptsCopy the exec scripts to <new_Transfer CFT_3.1.3_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.
Transfer CFT 3.1.3 Installation Guide 98
5 Upgade or migrate
Post manual migration only
Migrating UCONF parameters from a previous Transfer CFT versionYou 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.FORMERPARAMETERNAME. 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.PARAMETERNAME 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 upgradeIf you performed an upgrade, you need only recompile your APIs and Exits.
Transfer CFT 3.1.3 Installation Guide 99
6 Uninstall
This topic describes how to uninstall Transfer CFT. If you uninstall a Transfer CFT, you will lose the complete Transfer CFT configuration. To avoid this, save your environment (sample, exit, …) before removing the Transfer CFT.
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:
GUI mode
UNIX/Linux: uninstall.sh –m gui
Console mode
UNIX/Linux: uninstall.sh –m console
1. Click Uninstall when prompted. A warning message displays; click Yes to continue with the uninstall.
2. Click Next to see the uninstall summary, and Finish to exit.
Transfer CFT 3.1.3 Installation Guide 100
7 Deployment packages
Create a product deployment package A product deployment package in Transfer CFT is called an ExpressPackage.
The Express Package section describes how to create a reusable and distributable Transfer CFT package to simplify and ease the task of installing and configuring Transfer CFTs on multiple servers of the same architecture.
Note You can only install a Transfer CFT Express Package on the same platform as the one on which it was generated. For example, a Transfer CFT Express Package that is generated on linuxx8664 can only be installed on a linuxx8664 platform.
The procedure consists of:
l Installing a template Transfer CFT 3.1.3
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 CFTBegin 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.1.3 Installation Guide 102
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 PackageTo 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.
UNIX: The default Axway installation directory is $HOME/Axway.
Run the configure.sh script.
3. The Installer wizard displays. In the Welcome page select Next.
4. In the Configuration Type page, select Create an Express Package. Click Next to continue.
5. Specify the file name of the Transfer CFT installation package that you used to install the Transfer CFT template. The package name format is Transfer_CFT_<version>_Install_<platform>_BN<buildNumber>.zip.
6. Optionally, specify the file name of the service pack and/or patch to embed in the Express Package.
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.1.3 Installation Guide 103
7 Deployment packages
ResultsThe Express Package, Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>.zip, is generated and located in the directory you selected in the previous steps.
Customize the Express Package You can customize the Transfer CFT Express Package prior to deploying and installing it. The Transfer CFT Express Package is nearly the same as the Transfer CFT Install package, the only difference being the additional ExpressPackage directory. If you are not customizing the Express Package (for example the installation directories), you can skip this section.
The ExpressPackage directory contains the:
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 partner 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.
UNIX
unzip Transfer_CFT_<version>_ExpressPackage_<platform>_
<timestamp>.zip –d tempdir
2. Edit the expressPackage.properties file located in the ExpressPackage directory, for example tempdir/ExpressPackage. Customize installation parameters as needed.
Transfer CFT 3.1.3 Installation Guide 104
7 Deployment packages
3. Rezip the package.
UNIX
cd tempdir; zip -r Transfer_CFT_<version>_ExpressPackage_
<platform>_<timestamp>_new.zip *
Example: Install Transfer CFT in a different directory In this example, the Transfer CFT template was installed in the /home/cft/Axway/Transfer_CFT directory.
To install Transfer CFT in a different directory on the target server, edit the expressPackage.properties file, uncomment, and set the Axway_InstallDir, CFT_InstallDir, 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 accountsIn 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.
UNIX
Axway_InstallDir = $HOME/axway
CFT_InstallDir = $HOME/axway/cft
CFT_RuntimeDir = $HOME/axway/cft/runtime
Install the Express Package To deploy and install the Express Package:
1. Upload the generated Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>.zip file to the target server.
Transfer CFT 3.1.3 Installation Guide 105
7 Deployment packages
2. Unzip the package.
3. Browse to the ExpressPackage directory located within the unzipped package.
4. In UNIX only, add the execution rights to the install executable.
chmod +x install
5. Run the install executable.
Note If you run the install without an argument, the install executable uses the expressPackage.properties file, in the ExpressPackage directory, as the customization file. In command line you can specify a different file name using the following OSspecific syntax.
UNIX
./install <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.1.3 Installation Guide 106
8 Troubleshooting
Troubleshoot installation and registration
About start-up and registrationThis section lists some possible postinstallation 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 support at Axway Sphere.
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 registrationIf 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 See the Central Governance documentation for additional information and details.
Transfer CFT 3.1.3 Installation Guide 107
8 Troubleshooting
Re-register with Central GovernanceWhen 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.0.3 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.
Apply a license keyUNIX
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).
l A hardware upgrade changes the CPU ID (only applicable on certain UNIX).
Transfer CFT 3.1.3 Installation Guide 108
8 Troubleshooting
Obtain a license key 1. Install Transfer CFT. You can install Transfer CFT without a license key, and enter the key later.
2. After completing the installation, or for an existing installation, use the command cftutil about to retrieve your system information.
Note Use the ABOUT command to display the Transfer CFT product, host, and key information. This command displays the characteristics of the platform on which Transfer CFT is installed.
3. Contact the Axway Fulfillment team at the appropriate email address to obtain a valid key.
l For a US key, contact: [email protected]
l For an EMEA or APAC key, contact: [email protected]
4. Provide the hostname and system information for the installed or updated Transfer CFT.
Apply a license keyTo apply the license key from the Axway Fulfillment team, either:
l Enter the key directly.
l Enter the key(s) in the indirection file. Place the character @ before the path name of the indirection file, for example KEY=@conf\cft.key.
o The file can contain one or multiple license keys, but it must have one key per line.
o On start up the first valid key is used.
Note When working in multinode you must have one key per node and host.
ExampleUse the CFTUTIL utility to execute the about command to find the CPU ID and general system information.
Cftutil about
* cpuid = 000000000000E01A
In this example, the CPU ID is 0E01A. Your cpuid will differ from the one shown in the example.
Transfer CFT 3.1.3 Installation Guide 109
8 Troubleshooting
Support tools and contacting Support
Accessing the Axway Support siteIn the Axway Support web site, Sphere, click to select Contact us for the email address and phone number of your nearest Axway support site.
Opening a Support caseBefore 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 Web site 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 OSspecific guide for the correct syntax.
Using CopilotFrom 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.1.3 Installation Guide 110
8 Troubleshooting
Using command line
UNIX/WindowsIn command line enter: cft_support collect
Note ATM traces are available only when using Transfer CFT Local Administration. However Central Governance managed Transfer CFT is the recommended version.
Troubleshoot updates and service packsThis section lists some possible update and service pack issues along with corrective actions or workarounds.
l Cannot install product or updates due to system RAM limitations.
l Installation fails after accepting the terms in the Installer Agreement page.
l Cannot uninstall a Service Pack.
Cannot install product or updates due to system RAM limitationsCorrective action:
l If you receive a "memory limitation" type of error, begin by checking that your environment meets the prerequisites required to launch Java.
l If you have met the Java requirements, you can run the Axway Installer using one of the commands “Xmx512M”, “Xmx128M”, or “Xmx32M”, etc. for example.
Example
UNIX
setup.sh -d -javaargument "-Xmx64M"
update.sh -d -javaargument "-Xmx64M"
Installation fails after the installer Agreement page, and displays an error message “A fatal error has occurred while installing”Corrective action: As a workaround, start the Axway installer using the OS appropriate command:
UNIX
setup.sh -javaargument -Djava.awt.headless=true
Transfer CFT 3.1.3 Installation Guide 111
8 Troubleshooting
Cannot uninstall a Transfer CFT 3.1.3 Service PackCorrective action: As a workaround, execute the following command:
UNIX
update.sh -javaargument -Djava.awt.headless=true
If running this command does not correct the SP uninstall issue, perform the following steps.
UNIX
1. Run the command:
update.sh -u Transfer_CFT:SP2 -javaargument -Dforce=Transfer_CFT_
3.1.3_SP2 -javaargument -Djava.awt.headless=true
2. Run the following command to remove each update (both the installer and the Transfer CFT SP).
update.sh -u Axway_Installer:SP3 -javaargument -Dforce=Transfer_
CFT_3.1.3_SP2 -javaargument -Djava.awt.headless=true
3. Run the next command to record the complete removal of the composite, as it may be simply labeled as "broken".
update.sh -u Transfer_CFT_3.1.3_SP2
UNIX: Core dump recommendationsYou can use the ulimit command to set the size limitation for a core dump in Transfer CFT on UNIX systems. We recommend that you set the size of the core dump to 2GB.
Transfer CFT 3.1.3 Installation Guide 112