Transfer CFT Installation Guide Windows - docs.axway.com · Windows x86 operating system prerequisite 18 Install Transfer CFT 19 Start the installation 19 Cluster mode screens 24

Transfer CFT WindowsVersion 3.2.41 June 2018

User Guide

Copyright © 2017 Axway

All rights reserved.

This documentation describes the following Axway software:

Transfer CFT 3.2.4

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

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

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

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

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

Contents

Preface 1About Transfer CFT 1Installation guide outline 1Who should read this guide 2Transfer CFT documentation set 2Support services 2

Accessibility 3Accessibility features of the documentation 3Screen reader support 3Support for high contrast and accessible use of colors 3

1 Prerequisites 5Overview 5License keys 5End User License Agreement 6Check your authorization 6Windows x86 operating system prerequisite 6

System requirements 7Supported operating systems and browsers 7Disk space and RAM requirements 7Java 7Installer screen resolution 7

Windows-specific prerequisites 9Windows requirements 9Cluster installation requirements 10

Default ports 13Certificates 15Shared file system prerequisites 15Standalone installation 15Active/passive cluster 15Active/active cluster 16

2 Install 17Before you start 17Installation package contents 17Installation functions 17Installation modes 18Installed directories 18

Transfer CFT 3.2.4 Installation and Operation Guide 3

Windows x86 operating system prerequisite 18Install Transfer CFT 19Start the installation 19Cluster mode screens 24Auto import (for migration purposes) 24Multi-node options 26Governance options 27Connector options 27Installing services in command line 29Cluster installations 30Silent mode installation 34

Installer functions 39Installer functions 39JRE customization 43

3 Post-installation 45Perform an update 45Create a basic configuration 45Update the profile 45UCONF 45Configuration 46License key 46Installed directories 46Transfer CFT internal datafile and configuration 46User interface configuration 47Configuration for Service Mode 47

Start the Transfer CFT Copilot server 47Start Transfer CFT 47

4 Update, upgrade, migrate 48Start here 48Updates versus upgrade or migrate 48Update or upgrade using Central Governance 50Important information 50

Determine the installer and product version 50Update Transfer CFT 52Download the update file 52Check product details 52Use Central Governance for updates 52Windows users 53Install patches and service packs 54Remove an update 55Install patches and service packs in a multi-node, multi-host environment 56

Upgrade Transfer CFT 57


Before you start 57About upgrades 57Use Central Governance to upgrade Transfer CFT 57Upgrade Transfer CFT 2.6.4 to 3.2.4 58Upgrade Transfer CFT 2.7.1 to 3.2.4 61Upgrade Transfer CFT 3.0.1 to 3.2.4 64Upgrade Transfer CFT 3.1.3 to 3.2.4 66Upgrade Transfer CFT 3.2.2 to 3.2.4 67Post upgrade 68

Upgrade a Transfer CFT multi-node installation 69Before you start 69Upgrade from Transfer CFT 3.0.1 multi-node 70Upgrade from Transfer CFT 3.1.2 multi-node 72

How to free disk space from service packs 73Use the purge command 73

Perform a manual migration 74Migration prerequisites 74Upgrade prerequisites 76Install and auto import 76Migrating from Transfer CFT 2.3.2 80Migrating from Transfer CFT 2.4 82Migrate from Transfer CFT 2.5 or 2.6 87Migrating from Transfer CFT 2.6.4 SP2 or 2.7 90Migrating from Transfer CFT 3.0.1 or 3.1.3 92

Activate Central Governance connectivity 96Overview 96Automatically activate connectivity 96Manually activate connectivity 97Connect to a different Central Governance system 100Use former configuration objects 100View managed features 100

Post-migration procedure 102Post manual migration or auto import 102Post-manual migration only 102Post upgrade 103

5 Uninstall 104About uninstalling in Windows 104

6 Create a product deployment package 106Install a template Transfer CFT 106Generate the Express Package 107Customize the Express Package 108Install the Express Package 109


Limitations 110

7 Troubleshooting 111Troubleshoot installation and registration 111Copilot server issues 111Central Governance 111Transfer CFT server 112

Applying a license key 113Obtain a license key 113Apply a license key 113

Support tools /contact Support 114Accessing the Axway Support site 114Using CFT_support 114

8 Operations 116About Windows operations 116Transfer CFT Windows specific operations 116Product presentation 116

116About Windows operations 116Transfer CFT communication systems 117Applying a license key 118

Running Transfer CFT for the first time 119The software protection key 119Validating the communication layers 119Setting the environment 120Starting Transfer CFT 121Shutting down Transfer CFT 121Service mode 121Starting a CFTW desktop window 121Running Transfer CFT for the first time 122Transfer CFT user interfaces 124Defining user rights 125Using system users Windows 132Specific network functions 134Define additional environment variables 135

About Windows-specific system functions 135About environment variables 135About Windows-specific system functions 136Environment variables in Windows 137Symbols and default files 138Transferable files 139General operating functions 141Communication media 144


File management functions 145Automated functions 151Trace functions in CFT Windows 153

Setting protocol parameters 154Setting up the TCP/IP layer 154Defining TCP/IP parameters 155

About Windows Application Programming Interfaces (API) 158Constraints 159About Windows Application Programming Interfaces (API) 160Building API in Visual Basic 163Building an API in C 166Developing exits 167


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 multi-platform, high-volume, file and message transfer service. This documentation explains how to install, configure, and manage Transfer CFT.

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

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

Installation guide 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.2.4. 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.


http://www.axway.com/

Preface

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

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

Who should read this 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.2.4 Release Notes

l Transfer CFT 3.2.4 User Guide (HTML)

l Transfer CFT 3.2.4 Local Administration User Guide

l Axway Supported Platforms Guide

l Axway Interoperability Matrix

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.


mailto:[email protected]

http://www.support.axway.com/

Accessibility

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

This section describes the accessibility features of the documentation.

Accessibility features of the 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 high-contrast mode.

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


Accessibility

4 Installation and Operation Guide Transfer CFT 3.2.4

1 Prerequisites

OverviewAxway 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. Depending on your OS, see:

l Windows: Applying license key

l UNIX: Applying a license key

l z/OS Applying a license key

l IBM i Applying a license key

Multi-node license keysTransfer CFT in multi-node architecture requires:

l One key per node must have the cluster option (see key), and if there is more than one host you require at least one valid key per host.

Example

If you have 2 hosts and 4 nodes, you require 4 keys with at least one key per host. Possible key combinations could be:


1 Prerequisites

o On each of the two hosts, you have two keys.

o On one host you have 1 key, and on the second host you have 3 keys.

l A shared file system for use of a multi-node architecture on several hosts (active/active). Additionally, the system must be configured prior to the multi-node installation and the shared disk ready when starting the Copilot server.

o Windows only: You must map the shared disk to a drive letter. Windows UNC is not supported.

o Windows only: The Copilot Service Mode cannot be started as the LocalSystem account.

o Windows only: If you are running Copilot in Service Mode, you must set up a dependency with the shared disk's service for multi-node.

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

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 Axway Supported Platforms Guide

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

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

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


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


https://support.axway.com/

1 Prerequisites

System requirementsThe following are the system requirements for Transfer CFT.

Supported operating systems and browsersRefer to the Axway Supported Platforms Guide available on Axway Support at https://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

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

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

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

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

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

Secure Relay Java installation directory prerequisite

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

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



1 Prerequisites


1 Prerequisites

Windows-specific prerequisites The following are tasks to perform or issues to address before installing Transfer CFT.

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

Hardware and software requirementsBefore installing Transfer CFT Windows check the following:

l OS version

l Communication system type

These selections affect the minimum hardware and software requirements for the product and may be inter-dependent.

Transfer CFT is based on an external network layer, which must be installed before operating the product. And note that if other applications are running at the same time as Transfer CFT, the RAM requirement needs to be increased.

Apply a service pack or patch, or upgrade using Central GovernanceTo upgrade or install a Transfer CFT Service Pack or patch from Central Governance, you must:

l Run the Transfer CFT UI (Copilot) as administrator.

l Disable the Windows User Account Control (UAC).

Configure Windows UACUser Account Control (UAC) is an option to add security infrastructure on Windows operating systems.

For Windows versions that support UAC, Windows Vista, Windows Server 2008, Windows 7, Windows Server 2008 R2, and Windows 2012, you must disable the UAC when using Central Governance to apply patches, service packs or upgrades for Transfer CFT.

1. From the Start menu, type UAC and click to search.

2. In the User Control Account settings pop-up window, set the slider to Never Notify.


1 Prerequisites

3. Click OK.

4. Reboot to make the change effective.

For Windows versions prior to the versions listed above, perform the following steps to add yourself in Log on as a service group:

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

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

Note On some systems the path may be Start > Control Panel > System and Security > Administrative Tools > Local Security Policy.

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

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

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

Tasks that required elevated rightsThe following tasks require that you have elevated rights and fail if one of the above setup options was not performed:

l Create or remove shortcuts in Start menu or desktop

l Create or remove Windows services

l Installing in %SystemRoot% or %ProgramFiles%

l Running product scripts that require elevated rights

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

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

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


1 Prerequisites

A best practice therefore, when using Transfer CFT clusters in Windows, is to install Transfer CFT in cluster mode and permanently map the network shared directory to a drive. Using this method the mapped drive is then accessible to the Transfer CFT Windows Services. There is no need to modify the Transfer CFT profile after the installation.

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

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

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

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

CD <the_previously_unzipped_directory>

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

psexec -i -s cmd.exe

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

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

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

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

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

Remove a mapped driveTo remove the mapped drive:

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

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

CD <the_previously_unzipped_directory>

3. Login as the NT AUTHORITY\SYSTEM account:

psexec -i -s cmd.exe


https://technet.microsoft.com/en-us/sysinternals/bb842062.aspx

https://technet.microsoft.com/en-us/library/cc770556(v=ws.11).aspx

https://technet.microsoft.com/en-us/library/cc770556(v=ws.11).aspx

1 Prerequisites

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

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

net use Z: /delete


1 Prerequisites

Default 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 1761-1768 for Transfer CFT. For more information, refer to: www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.

Component Port

PeSIT 1761

SSL 1762

COMS 1765

Copilot 1766

Copilot for Central Governance 1767

Central Governance 12553

Central Governance SSL 12554

Secure Relay MAma.comm_port

6801

Secure Relay RAra.comm_portra.admin_port

68116810

Legend:

l PeSIT (PESITANY protocol): PeSIT in plain text

l SSL: PeSIT protocol over SSL/TLS

l COMS: Synchronous transfers

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

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


http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?&page=31

http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?&page=31

1 Prerequisites

authentication)

l Central Governance: Used to connect to Central Governance


1 Prerequisites

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

Secure Relay

<Transfer_CFT>/home/distrib/xsr SecureRelayCA.pem November 2021

SecureRelayMasterAgent.p12 November 2021

Central Governance

<Transfer_CFT>/runtime/conf/pki

passportCA.pem November 2019

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

CRTPF FILE(YOURLIB/DER_CERT) RCDLEN(1191)

Shared file system prerequisitesThis section provides general information concerning the prerequisites for shared file systems for the following types of files used with Transfer CFT in a Windows environment.

l Transfer CFT data files: This refers to all files managed by Transfer CFT other than transferable application files (including database files), which are stored in the Transfer CFT runtime directory.

l Transferable application files: This refers to the files transferred by Transfer CFT.

Standalone installationYou can use any POSIX compliant shared file system for both Transfer CFT data files and transferable application files.

Active/passive clusterYou can use any POSIX compliant shared file system for both Transfer CFT data files and transferable application files.


1 Prerequisites

Active/active cluster

Transfer CFT data filesSupported shared file systems for multi-node, multi-host architecture (active/active)

The following non-exhaustive table lists shared file systems that have been tested with Transfer CFT.

Operating system

Supported Unsupported

AIX GPFS (recommended), NFSv4 NFSv3, CXFS, VeritasSF

HP-UX NFSv4 NFSv3, CXFS, VeritasSF

Linux-x86 GPFS (recommended), GFS2, NFSv4, AWS EFS

NFSv3, CXFS, ACFS, OCFSv1, OCFSv2, QFS, VeritasSF

OpenVMS RMS

Solaris NFSv4 NFSv3, CXFS, QFS, VeritasSF

Windows-x86 CIFS CXFS, NFS

z/OS Sharing DASD across Sysplex

Transfer CFT transferable application filesYou can use any POSIX compliant shared file system for transferable application files.


2 Install

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

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

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

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

Before you start the installation, you should:

l Downloaded the installation package from Axway 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


2 Install

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

GUI mode:

l Windows: setup32.exe or setup64.exe

Console mode:

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

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

For more information, see Installer functions.

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

l Configuration: Includes the configuration file for each installed product

l Documentation: User documentation

l Installer: Files used by the installer

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

l SilentFile: Includes the silent file for each installed product

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

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






2 Install

Install Transfer CFT

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

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

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

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


2 Install

Screen Description

Welcome Provides links to the Axway website and Sphere, the Axway support site.

License agreement

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

Installation architecture

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

Note If you select cluster, additional screens display.

Installation directory

Where product files and documentation will reside.

Axway Transfer CFT: Installation directory

Specify the directory where you want to install Transfer CFT.By default, Transfer CFT is installed in a sub-directory 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 sub-directory of the Transfer CFT installation directory. Use the default directory, or specify a new directory. A runtime directory will be created if it does not already exist.Directory paths cannot contain spaces.

Axway Transfer CFT: Auto Import

Specify if you want to import data from an existing Transfer CFT by selecting Yes or No.You can install and import configuration and data from v2.3.2, v2.4, v2.5, v2.6, v2.7, v3.0.1, v or 3.1.2.

Note 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.


2 Install

Screen Description

Axway Transfer CFT: Multi-node Architecture

Select to enable multi-node architecture.Enter the number of nodes. The first node is zero, and you may have up to four nodes. Enter the host name and address for each node, up to four nodes. You must enter at least one host.

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

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 multi-node you require:

l One (1) valid key per node

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

Axway Transfer CFT: Governance Mode

Enable Central Governance connectivity:

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

l No: Installs Transfer CFT without Central Governance.

Axway Transfer CFT: Configuration

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

l Synchronous communication: enter the COMS port

l PESITANY: Enter the PeSIT protocol port number

l Select the default database size:

o Catalog: Modify the default catalog file size

o Communication File: Modify the default communication file size


2 Install

Screen Description

Axway Transfer CFT: User Interface Server

Enter the Transfer CFT UI Server values:

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

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

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

Axway Transfer CFT: Server startup mode

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

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

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

Axway Transfer CFT: UI Server startup mode

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

l Normal mode: You must manually start and stop it.

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


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

Axway Transfer CFT: Shortcuts

This screen enables you to install Start Menu shortcuts.

l Yes: Creates shortcuts

l No: Does not create shortcutsThis 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 PassPortNote 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.


2 Install

Cluster mode screensSee also Cluster installations on page 30.

Screen Description

Installation architecture

Select either:

o Single - installs Transfer CFT on a single machine

o Cluster - installs Transfer CFT on several machines. Select this option if you want to install Transfer CFT in multihost/multi-node or in active/passive mode.

Cluster o First node: Install on a first machine before adding additional machines (nodes). You must install on a first node before you can select the option to install on additional nodes.

o Additional nodes: After installing on the first machine, you can select this option to install on an additional machine(s).

Installation directories

Specify the root shared directory (shared disk) where the Axway installer programs will reside, and the root installation directory where the product files and the documentation will reside.Directory paths cannot contain spaces.

Axway Transfer CFT: Installation directory for Transfer CFT

Specify the directory where you want to install Transfer CFT. This directory will store all of the Transfer CFT binaries.By default, Transfer CFT is installed in a sub-directory of the Axway installation directory. Use the default directory, or specify a new directory.Select the directory that will store shared data between Transfer CFT machines. It will contain the Transfer CFT runtime.Directory paths cannot contain spaces.

Axway Transfer CFT: Runtime directory

Specify the directory where you want to install the Transfer CFT runtime directory.By default, the runtime directory is installed in a sub-directory of the Transfer CFT installation directory. Use the default directory, or specify a new directory. A runtime directory will be created if it does not already exist.Directory paths cannot contain spaces.

Auto import (for migration purposes)If you select Yes in the Auto import screen, the following Installer pages display.


2 Install

Screen Description

Axway Transfer CFT: Migration

Specify if you want to import data from an existing Transfer CFT by selecting Yes or No.You can migrate from V2.3.2, V2.4, V2.5, V2.6, v2.7, v3.0.1 or v3.1.2.

Axway Transfer CFT: Migration

Specify the path to the profile file.

Axway Transfer CFT: Migration Options

This screen is only displayed during a migration operation. You should see the Version, SP, Installation directory and runtime directory listed on the screen.Select the objects that you want to import:For V2.5.x and higher:

l Functional configuration objects (PARM/PART)

l Environment objects (UCONF)

l Catalog: CFTCATA

l Communication medium: CFTCOM

l Local PKI base (since V2.5.1 - SP2)For V2.4.x:


l 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 Environment objects (Sentinel : trkapi.cfg)

l Catalog (CFTCATA)

l Communication medium (CFTCOM)You have to migrate the following objects manually:

l Executables

l Exits

l APIs

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


2 Install

Multi-node optionsA multi-node installation architecture allows installing Transfer CFT binaries on several hosts, physical or virtual server, and Transfer CFT runtime files on shared file system.

The multi-node 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. See the Cluster installations topic and the Manage multi-node section for details.

Screen Description

Axway Transfer CFT: Multi-node Architecture

Select to enable multi-node architecture.Enter the number of nodes. The first node is zero, and you may have up to four nodes. Enter the host name and address for each node, up to four nodes. You must enter at least one host.

Axway Transfer CFT: License key

Enter the license key for the Transfer CFT component.If you have a license key issued for a previous version of Transfer CFT, enter your license key in the Key field and 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 multi-node you require:

l One (1) valid key per node

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

Back to core installation screens (Governance Mode).

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


2 Install

Governance optionsScreen 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.

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

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

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

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

l Shared Secret

l Confirm Shared Secret

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

Connector optionsScreen 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


2 Install

Screen Description

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:PassPort PKI connector

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

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

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

o Use SSL

o PKI server public certificate

o Copy certificate

o PKI server login

o PKI Server Password

o Confirm PKI Server Password


2 Install

Screen Description

Transfer CFT:PassPort Access Management connector

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

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

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

o Use SSL

o AM Server public certificate

o Component instance

o Domain

o Component Login

o Component Password

o Confirm Password

Installing services in command line

Windows only

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

cd %TransferCFT_directory%

2. Enter the following:

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

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

Copilot servicesFrom the Transfer CFT home directory, run:

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

Example

For Transfer CFT version 3.2.4 Copilot you would enter:

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

c:\CFT313\Transfer_CFT\runtime


2 Install

Cluster installationsThis section describes the recommendations when installing a Transfer CFT cluster architecture. Before starting a new Transfer CFT multi-node installation though, check the prerequisites and Release Notes. See also the User Guide section Manage muli-node architecture.

Note Active/passive shared disks must be POSIX compliant.

OverviewA multi-node installation architecture allows installing Transfer CFT binaries on several hosts, physical or virtual server, and Transfer CFT runtime files on shared file system.

The multi-node 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 multi-node (HA)

o Install Transfer CFT using the Single installation architecture of the Axway Installer and enable the multi-node 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.

PrerequisitesThe user who installs the Transfer CFT cluster must:

l Be a domain user who is part of the Administrators group.

l Be the same user on all machines.

l Have all rights (create/modify/delete) to the shared disk on all machines when Transfer CFTis installed in a multihost architecture.


http://docs-dev.ecd.axway.int/u/documentation/transfer_cft/3.2.4/webhelp_portal/content/multi_node/about_multinode.htm

2 Install

Platform and shared file system supportTransfer CFT supports the following OS for multi-node architecture: Windows-x86, Linux-x86, AIX-power, HPUX-parisc, HPUX-ia64, Sun-SPARC, Sun-x86, OpenVMS and z/OS.

IBM i supports a mono-host, multi-node architecture. For more information, refer to the IBM i Transfer CFT 3.2.4 Installation and Operations Guides.

Supported shared file systems for multi-node, multi-host architecture

The following non-exhaustive table lists shared file systems that have been tested with Transfer CFT.

Operating system

Supported Unsupported

AIX GPFS (recommended), NFSv4 NFSv3, CXFS, VeritasSF

HP-UX NFSv4 NFSv3, CXFS, VeritasSF

Linux-x86 GPFS (recommended), GFS2, NFSv4, AWS EFS

NFSv3, CXFS, ACFS, OCFSv1, OCFSv2, QFS, VeritasSF

OpenVMS RMS

Solaris NFSv4 NFSv3, CXFS, QFS, VeritasSF

Windows-x86 CIFS CXFS, NFS

z/OS Sharing DASD across Sysplex

Active/active multi-node (HA) installationA cluster installation of Transfer CFT with multi-node (HA)

l Install Transfer CFT using the Cluster installation architecture of the Installer and enable the multi-node 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.


2 Install

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 installationA cluster installation of Transfer CFT without multi-node (active/passive)

l Install Transfer CFT using the Cluster installation architecture of the Axway Installer and disable the multi-node 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 (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

Note Transfer CFT supports all POSIX file systems.

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 high-availability operations. The procedure for cluster configuration varies depending on the type of platform on which the cluster is installed.

There are two general steps for installing a product in a cluster.

1. Install first node in cluster.

2. Install additional nodes in cluster.

After installation, but before you can use the cluster installation, you must configure the cluster.


2 Install

After installing a product on two or more nodes, you must configure the cluster for high-availability 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.

Installation NameOn Windows this is required and lets you to provide a functional name for the installation.

Installation Directory

Path and name of the local directory where you want to install the first cluster.

Shared Directory

Path and name of the directory where you want to create a shared directory for the cluster installation. The shared directory is used to store product data files.

The installer proceeds with the standard sequence of pages for the product.

Install additional nodes in cluster

Use this procedure to install the product on additional nodes in a cluster:

1. Launch the installer on the machine that hosts the additional node.

2. On the Installation architecture page, select Cluster and click Next.

3. On the Cluster page, select Additional nodes and click Next.

4. On the installation directories page, specify values for the following and click Next.

Installation NameOn Windows, the installation name you provided for the first node.

Installation directory

Path and name for the local installation directory that is identical to the location of the local directory you created on the first node.

Shared directory

Path and name for the shared directory that you entered for the first node. The shared directory is used to store product data files.


2 Install

The installer installs the product on the second node and configures the shared directory for sharing between the installed nodes.

Silent mode installationNote Windows only. If you have implemented a firewall, deactivate the firewall prior to

installation in silent mode.

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

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

Silent file 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

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.10.0.properties) and the product property files you might need to install. You must not modify anything in this file except the InstallDir,InstallationLogicalName and list of IncludeFiles. The product property files cannot be used outside of the main installer file.

The installer embeds some security features. For this reason if you want to execute silent installations, you must enter the required passwords during the initial installation.

LocationThe silent file is created in:

<<install directory> >\SilentFile\<InstallationDateTime_Action>\<Install_ProductShortName_V<Version>.properties

Where:


2 Install

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 key-value pairs, each on one line. The variable stores the name of the parameter (it is the key) and the value stores the other string.

The structure of a variable inside the silent file is:

Variable = Value

Note The extra spaces around the variable are trimmed.

Some special types of variables can be identified.

Variable.Property = Value

Variable.Default = <LinkToAnotherVariable> | Value

A variable property signifies or provides some additional information about that specific variable (commonly known as metadata; it might be used for validation purposes, for parsing purposes, etc.).

For example, information on the creation date:

CreationDate = 13-02-2010

CreationDate.Format = dd-MM-yyyy

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

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

Encrypted variables

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

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

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

Environment variables

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


2 Install

installation. You can then use these variables instead of the Variable Values.

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

l In Windows: %env_var%

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

l Component properties

l Variable properties

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

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:

Windows:

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

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

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

The Silent File directory contains:

l Installer properties file (Install_Axway_Installer_V<version>.properties)

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

l The com.axway.installer folder

You should always call the Axway_Installer silent file from the command line regardless of the number of products you want to install. You can add or delete products from the silent installation if necessary, as long as they exist in the Silent File. Open the Axway_Installer properties file and scroll


2 Install

to the end. There are a number of IncludeFiles specifying the number of products included for an installation. You must not modify anything else in this file except the InstallDir, the InstallationLogicalName and the list of IncludeFiles.

Follow these recommendations concerning a silent installation:

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

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

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

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

Note When performing a silent installation, you must not use the "com.axway.installer" that already exists in the installation package (that is, where the setup.sh/bat file resides). Instead, you must copy this folder from the SilentFile directory and replace the existing one originally in the installation package.

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:

Windows:

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

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

Silent File 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.


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 Windows: SilentFileEditor.bat

The parameters for the Silent File Editor are:

l The path to the silent file that you want to modify

l Three arguments in this format:

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

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

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

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

Example

SilentFileEditor.bat SilentFilePath varName1 value1 –c/-u varName2

value2 –c/-u … varNameN valueN –c/-u

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


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 f(rom the Axway support site) and unzipped.

GUI mode

l setup32.exe or setup64.exe

Console mode

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


2 Install

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

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

Services modification

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

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

<domain>\<username>

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

Example

Local user: user1

.\user1

<hostname>\user1

Network user: user2

<domain_name>\user2

Configure 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 Windows: In Windows Start menu, select Axway Software > Axway [installation name] > Configure

Console mode

l Windows:

o configure32.exe –m console


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


2 Install

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.

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 X-Window environment. To use an X-Window distributed environment, you must export the DISPLAY environment variable: export DISPLAY=myhost.mydomain:0.0

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


2 Install

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

Installer 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.exesetup64.exe

Console setup.sh –m console setup32 –m consolesetup64 –m console

Configure GUI configure.sh configure32.exe configure64.exe

Console configure.sh –m console

configure32.exe –m consoleconfigure64.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.exeuninstall64.exe

Console uninstall.sh –m console uninstall32.exe –m consoleuninstall64.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


2 Install

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.

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

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

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.


2 Install

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 are reconfigured to use the new paths specified in the environment variables.

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

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

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 re-computes the Java paths required by the products, and transparently ignores the corresponding settings in the silent file (if any)

l The reverse case is handled in the same manner


3 Post-installation

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

l Perform an update

l Create a basic configuration

Otherwise you can go to:

l Start the Transfer CFT Copilot server on page 47

l Start Transfer CFT on page 47

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

Perform an updateIf you need to apply service packs or patches, refer to Update Transfer CFT.

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

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

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

l Windows: <CFTDIRRUNTIME>\profile.bat

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

CFTUTIL listuconf


3 Post-installation

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

For example, to change the user interface port:

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

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

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

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

Installed directoriesWhen you install Transfer CFT, the home directory is created and populated under the Transfer_CFT installation directory. This home directory contains installation libraries, binaries, and templates. Do not store any personal files in the home directory, as they are erased during updates.

Transfer CFT internal datafile and configuration Check the values, especially the key value, hostname, and port for TCP, in the following file:

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

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

cftinit cft-tcp.conf

To update the configuration at a later date, execute:

cftupdate cft-tcp.conf


3 Post-installation

User interface configurationTo view the Copilot user interface configuration, execute:

CFTUTIL LISTUCONF id=copilot*

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

Example

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

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

Refer to the Transfer CFT User Guide for details.

Configuration for Service ModeThis option is only available on Windows systems and must be selected during the installation process configuration.

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

Windows

1. Change directory to the runtime.

2. Execute profile.bat.

3. To start the Copilot server, enter: copstart

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

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

Enter:

cft start


4 Update, upgrade, migrate

Start hereThis section is designed to assist administrators or users who are tasked with updating Transfer CFT, or upgrading or migrating from an existing Transfer CFT version to Transfer CFT 3.2.4.

Updates versus upgrade or migrate

About updatesAn update brings Transfer CFT up-to-date with a patch or service pack offering fixes and minor enhancements. For example, you can update a Transfer CFT 3.1.3 SP3 to Transfer CFT 3.1.3 SP8. See Updating Transfer CFT.

About upgradesAn upgrade is the process of updating to a newer, enhanced version of the software. For example, you can update a Transfer CFT 3.1.3 to Transfer CFT 3.2.4. See Upgrading Transfer CFT.

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

This mode has the following advantages (as compared to a migration):

l Allows you to update in the same location

l You can perform this automatically using the Installer, and enables reverting to previous state if needed

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

This mode has the following restriction:

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

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


4 Update, upgrade,migrate

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 OS-appropriate installation kit to install the Transfer CFT 3.2.4 in a new directory, and select the installation option to migrate the existing configuration to this new version. You are only required to provide the path of the Transfer CFT (n-1) version to retrieve this old configuration.

The Transfer CFT versions that are available to migrate include 2.3.2, 2.4, 2.5, 2.6, 2.7, 3.0.1, 3.1.2, and 3.1.3-3.2.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.

About install and automatic importsYou can use an automatic installation procedure to migrate from your current version of Transfer CFT to Transfer CFT 3.2.4. This auto-migration procedure occurs when you perform the Transfer CFT 3.2.4 installation.

This mode has the following advantages:

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

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

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

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

This mode has the following restriction:

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

About standard migrationsA standard migration procedure, also used for migrating your existing Transfer CFT to Transfer CFT 3.2.4, is available.

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

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

2. Import the exported information into Transfer CFT 3.2.4.

This mode has the following advantages:

l Because this migration is not automated, you can customize as needed.

l You can perform a standard migration to move from versions older than version 2.6.x.



Update or upgrade using Central GovernanceCentral Governance simplifies the management of Transfer CFT and provides identity and access management, certificate security services, monitoring, alerting, and web dashboard services.

If you are using Transfer CFT 3.2.4 with Central Governance, you can use the information in Activate Central Unified Flow Management connectivity to configure and register with Central Governance.

Central governance allows you to update (to the latest Transfer CFT Service Pack or Patch) or upgrade Transfer CFT (as of Transfer CFT 3.1.3 with the latest SP to the new Transfer CFT version). However, you cannot perform a Transfer CFT migration using Central Governance.

Note You cannot perform an update or upgrade on the z/OS or IBM i platforms.

Important information Important information before performing an upgrade procedure:

l You must update your Transfer CFT to the most recent service pack version.

l Upgrade the Axway Installer to 4.10, if you are not at this version or higher, prior to upgrading your Transfer CFT 3.2.4.

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.

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

Determine the installer and product versionYou should determine the product and Installer version and service pack level prior to updating or upgrading. You can use the following procedure on any version of the Axway Installer. For more information on the installer, see Installer functions on page 39 and JRE customization on page 43.

The display command lists information about all installed products.

l Run the command from the root installation directory.

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




Use the name option (-n) to display the installation history of a single product.

<Transfer_cft_install_dir>\display -n <product_name>

Example

C:\Axway>display.bat -n Transfer_CFT

Transfer_CFT V3.1.3 SP12

Composite: Transfer_CFT_3.1.3_SP2

SP2 part of Transfer_CFT_3.1.3_SP2



Composite: Transfer_CFT_3.1.3_SP8_PATCH5

SP8_Patch5 part of Transfer_CFT_3.1.3_SP8_PATCH5



Composite: Transfer_CFT_3.1.3_SP11_PATCH4

SP11_Patch4 part of Transfer_CFT_3.1.3_SP11_PATCH4



To uninstall then:

C:Axway>display.bat -u Transfer_CFT_3.1.3_SP12

Alternatively, you can start the Axway Installer. The command depends on the Installer version and your OS, as follows:

l Versions lower than 4.5.x:

o setupwin32.exe update

l Version 4.5.x or higher:

o update32/64.exe

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



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

Download the update fileDownload product updates from the Axway support website to the machine you where you want to perform the update. Please note that the update file is a zip file. Do not unzip this file.

Tip To avoid possible issues if you need to uninstall a service pack, it is recommended that you install Transfer CFT 3.x.x SP1 before installing SP2.

Check product detailsTo check the version, or product details prior to updating, use the display.bat command.

Note Prior to beginning the update, see the section Determine the installer and product versions.

Example 1

Use the display command to retrieve the name of the update, as displayed in red below:

display.bat -n Transfer_CFT

Transfer_CFT V3.2.4 SP1


Example 2

Use this command to retrieve the name to uninstall (use the appropriate version, update64.exe or update32.exe depending on your system):

update64.exe -u Transfer_CFT_3.2.4_SP1

Use Central Governance for updatesYou can easily perform Transfer CFT updates using Central Governance s of Transfer CFT 3.1.3. Refer to the Central Governance documentation for details.

Note that from the Central Governance interface you cannot:

l Remove service packs or patches.

l Update Transfer CFT 3.1.3 version products.

l Update Transfer CFTs installed in multi-node/multi-hosts from Central Governance.




Windows usersThe same user that did the initial installation (or at least the same type of user) must start the update procedure. Additionally, if you install a service pack or patch for the installer, make sure all Windows services created by the installer are stopped.

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

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

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


<domain>\<username>


Example

Local user: user1

.\user1

<hostname>\user1

Network user: user2

<domain_name>\user2

Change the backup folder - PLEASE CHECK THIS - DO WE REMOVE???You can change the backup folder during the update. However, if the backup directory is changed, you must copy all the files in the previous backup folder to the new location, and keep the product directories structure. For example, the backup directory could have this format:

l BACKUP_DIR

l synInstall



l synPatch

l product.properties

l database.properties

l 001

The command UpdatesBackupDirectory changes the default update directory for all Axway products in the installation. When the default update directory is over written, be careful not to delete it or you cannot restore the installer to its previous state.

You can change the backup folder in two ways:

l From command line: UpdatesBackupDirectory <valid backup path>

l In the installer property file (Install_Axway_Installer_V4.5.2.properties), in the configuration directory of your home installation.

Install patches and service packsStop Transfer CFT prior to installing a service pack or patch.

Update in silent modeUse the following command to update Transfer CFT in silent mode:

update.exe -i <zip_file>

Example

update.exe -i Transfer_CFT_3.2.4-SP1_win-x86-64.zip

Update in console modeFrom the installation root directory, launch the installer in update mode:

l 32-bit executable: update32.exe –m


Update in GUI mode 1. Run the installer in update mode as follows:

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

l Or, alternatively, double-click update32.exe or update64.exe from the Transfer CFT installation folder



2. In the Updates Management page you can:

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

l Select file: Select the update file you want to install.

Information: Click to open the readme file.

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

4. Click Next to continue.

5. Review the updates you want to install.

6. To apply the update, click Update.

7. A warning message appears. Click Yes to continue.

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

9. Review the summary and click OK to exit the installer.

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

Remove an updateThis section describes uninstalling a patch or service pack. You can uninstall updates in silent, console, or GUI mode.

Remove an update in silent modeUse the following command to uninstall a patch or SP in silent mode:

update.exe -u <update-name>

Example

Use this command to uninstall a SP in silent mode:

update.exe -u Transfer_CFT_3.2.4-SP1_win-x86-64.zip

Remove an update in console modeFrom the installation root directory, launch the installer in update mode:





Remove an update in GUI mode 1. Run the installer in update mode. In the Windows Start menu, select Axway Software >

Axway <InstallationName> > Update

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


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

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

Install patches and service packs in a multi-node, multi-host environmentThis section describes the procedure to apply a patch or service pack on a multi-node architecture based on N hosts. You update a Transfer CFT multi-node architecture with multi-hosts using the same procedure as for a patch or service pack, one host at a time.

1. Connect to the first host.

2. Stop all nodes running on this host by running the command: copstop

Copilot services are stopped, and local nodes are automatically re-started on the other hosts.

3. Check that the nodes are re-started on the other host 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).



Upgrade Transfer CFT This section explains how to upgrade an existing Transfer CFT from versions 2.6 through 3.2.2 to Transfer CFT 3.2.4. It begins by detailing the prerequisites for a standalone (non multi-node) upgrade.

For details on upgrading a multi-node installation, see Upgrade a Transfer CFT multi-node installation on page 69.

Before you start Before beginning the update procedure, 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.

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

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

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

Note See also the topic on silent mode for detailed information on using this installation method.

Use Central Governance to upgrade Transfer CFTYou can perform Transfer CFT upgrades using Central Governance. However, from the Central Governance interface you cannot remove service packs or patches, and can only upgrade Transfer CFT as of Transfer CFT 3.1.3 with last service pack (to the latest version). You cannot perform a Transfer CFT migration via Central Governance.

Please refer to the Central Governance documentation for details.


https://docs.axway.com/bundle/CentralGovernance_113_UsersGuide_allOS_en_HTML5/page/Content/AxwayStartPage.htm


Upgrade Transfer CFT 2.6.4 to 3.2.4Preconditions: 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 Remember to update the product key between versions (after completing the upgrade).

Step 1: Upgrade to Axway Installer 4.4.0 SP8 or the latest SP

Run the Axway Installer in update mode. Here it is shown in the default installation directory.

1. Start the Axway Synchrony Installer in update mode, shown here in the default installation directory:

C:\Axway\Synchrony\setupWIN32.exe update

2. Apply the Synchrony_Installer_4.4.0_UP7-from-4.3.1_win-x86-64_BN16272.jar.

3. Start the Axway Synchrony Installer in update mode.

setupWIN32.exe update

4. Apply the Synchrony_Installer_4.4.0_SP8_allOS_BN25804.jar.

Step 2: Upgrade to JRE 160

Use the Axway JREUpdateTool to upgrade to JRE 1.6. This Axway tool is available on the Axway Support site.

1. Unzip the JREUpdateTool_4.4.0_Utility_*****_BN1205240348.zip.

Where ***** represents the platform

Example: JREUpdateTool_4.4.0_Utility_win-x86-64_BN1205240348.zip

2. Upgrade to Java 1.6 using the appropriate command:

<JRETOOLS_DIRECTORY_WITHOUT_BLANKS>\updatejre.bat C:\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:


2. Apply the Synchrony_Installer_4.5.0_UP1-from-4.4.0-4.4.1_allOS_BN1204251050.jar.

3. Start the Axway Synchrony Installer.





Note The program commands change in this step!

Windows: update32.exe or update64.exe

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


Example: JREUpdateTool_4.5.0_Utility_win-x86-64_BN1211090726.zip



Step 5: Upgrade to Axway Installer 4.8.0


1. Start the Axway Installer.

update32.exe or update64.exe

2. Apply the Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar.


Example: Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_BN2.jar

Step 6: Upgrade to Transfer CFT 3.1.3



Windows: update32.exe or update64.exe

Unix/Linux: update.sh

2. Apply the Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_BN8294000.jar


Example: Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_win-x86-64_BN8294000.jar

Step 7: Upgrade To the latest Transfer CFT 3.1.3 Service Pack

Use the Axway installer in update mode.

1. Start the Axway Installer:




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_aix-power-64_BN8712000.zip

Note In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip/uncompress the zip file.

3. If necessary, add the Transfer CFT 3.x license key in the conf/cft.key file.


Use the Axway Installer in update mode.


Interactive mode: update32.exe or update64.exe

Silent mode: update32.exe -i <zip_file> or update64.exe -i <zip_file>

2. Apply the Transfer_CFT_3.y.z_UP****-from-3.1.3_*****_BN*****.zip.


For example, Transfer_CFT_3.2.4_UP1-from-3.1.3_aix-power-32_BN9815000.zip



Step 9: Update Transfer CFT 3.2.4 to the latest Service Pack




This procedure requires that your current installation be at least at the levels listed below.

l Transfer CFT version 2.7.1_SP10

l Axway Installer version 4.4.0_SP8 or 4.4.1_SP3

l Embedded JRE version: 160

Note Remember to update the product key between versions after upgrading.

Step 1: Upgrade to JRE 160

Use the Axway JREUpdateTool to perform the JRE update.



For example, JREUpdateTool_4.4.0_Utility_win-x86-64_BN1205240348.zip

2. Use the following command to upgrade to Java 1.6:


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:


2. Apply the Synchrony_Installer_4.5.0_UP1-from-4.4.0-4.4.1_allOS_BN1204251050.jar.


Note The program commands change in this step!


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.



For example, JREUpdateTool_4.5.0_Utility_win-x86-64_BN1211090726.zip


Windows: <JRETOOLS_DIRECTORY_WITHOUT_BLANKS>\updatejre.bat C:\Axway\Synchrony\







2. Apply the Axway_Installer_4.8.0_UP**-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar

Where ** is the UP number, and ***** represents the platform.

For example, Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_BN2.jar





2. Apply the Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_BN8294000.jar


For example, Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_win-x86-64_BN8294000.jar

Step 6: Upgrade to the latest Transfer CFT 3.1.3 Service Pack





For example, Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip

Note In this step you are now working with a zip file (it was .a jar in previous Installer versions). Do NOT unzip the zip file.




1. Start the Axway Installer using one of the two installation methods:



2. Apply the Transfer_CFT_3.x.y_UP****-from-3.1.3_*****_BN*****.zip.


For example, Transfer_CFT_3.2.4_UP1-from-3.1.3_aix-power-32_BN9815000.zip



Note In this step you are working with a zip file (not a jar file as in earlier Installer versions). Do NOT unzip the zip file.






This procedure requires that your current installation is at least at the levels listed below.

l Transfer CFT 3.0.1_SP9

l Installer 4.5.0_SP4

l Embedded JRE version: JRE 160

Note Remember to update the product key between versions (after completing the upgrade).


Use the Axway Installer in update mode:



2. Apply Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_*****_multiOS_BN2.jar


For example, Axway_Installer_4.8.0_UP2-from-4.5.x-4.6.1-4.7.0_win-x86_multiOS_BN2.jar





2. Apply the Transfer_CFT_3.1.3_UP**-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_*****_BN8294000.jar

Where ** is the UP version and ***** represents the platform.

Example: Transfer_CFT_3.1.3_UP1-from-2.6.2-2.6.3-2.6.4-2.7.0-2.7.1-3.0.1-3.1.2_win-x86-64_BN8294000.jar







Example: Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip



Note In this step you are working with a zip file (it was a jar in previous Installer versions). Do NOT unzip the zip file.








For example, Transfer_CFT_3.2.4_UP1-from-3.1.3-3.2.2_win-x86-64_BN10690000.zip







The current installation must be at least at the levels listed below.

l Transfer CFT version is 3.1.3

Note Remember to update the product key between versions.



1. Launch the Axway Installer:




Example: Transfer_CFT_3.1.3_SP3_aix-power-64_BN8712000.zip

Note In this step you are working with a zip file (and not a jar as in earlier Installer versions). Do NOT unzip/uncompress the zip file.














Upgrade Transfer CFT 3.2.2 to 3.2.4Upgrade to Transfer CFT 3.2.4










4. Update Transfer CFT 3.2.4 to the latest Service Pack.



Post upgradeAfter completing the upgrade procedure, your Transfer CFT 3.2.4 the exec scripts are operational. However, you must rebuild both your exits and API programs.

Checking the new versionTo check the Transfer CFT version, as well as the license key and system information, enter the command:

CFTUTIL ABOUT



Upgrade a Transfer CFT multi-node installationThis section describes how to upgrade from a Transfer CFT 3.0.1, 3.1.2, or 3.1.3 multi-node, multihost installation to Transfer CFT 3.2.x.

Before you 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 Upgrade Transfer CFT on page 57.

l Download the Transfer CFT Upgrade Pack, available on Sphere at support.axway.com.




Upgrade from Transfer CFT 3.0.1 multi-node For details on shared disks, node commands, and other multi-node considerations, refer to the Transfer CFT 3.2.4 User Guide > Manage multi-node architecture.

Upgrade all hosts 1. Stop Copilot. This command stops Copilot as well all cftnodes running on that machine.

copstop -f

2. Connect to each machine and perform the following tasks:

l Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk. For example:

cd /<shared_disk>/<CFTdir>/Transfer_CFT/runtime

profile.bat

l Begin the upgrade procedure as described in Upgrade from Transfer CFT 3.0.1.

Restart the upgraded Transfer CFT multi-node multihost environment 1. Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk.


profile.bat

2. Check the new version using the following command:

CFTUTIL ABOUT

3. Start Copilot (start each of the Copilots in the multi-node environment).

copstart

4. After restarting the Copilots, restart the Transfer CFT server.

cft restart

5. Check the upgraded Transfer CFT multi-node multihost system.

CFTUTIL listnode


https://docs.axway.com/u/documentation/transfer_cft/3.2.2/webhelp_portal/content/multi_node/about_multinode.htm


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.



Upgrade from Transfer CFT 3.1.2 multi-node For details on shared disks, node commands, and other multi-node considerations, refer to the Transfer CFT 3.2.4 User Guide > Manage multi-node architecture.

Upgrade all hosts 1. Stop Copilot. This command stops Copilot as well all cftnodes running on that machine.

copstop -f

2. Connect to each machine and perform the following tasks:

l Launch the Transfer CFT profile from the Transfer CFT runtime directory on the shared disk. For example:


profile.bat

l Begin the upgrade procedure as described in Upgrade from Transfer CFT 3.1.2.

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.


profile.bat

2. Check the new version using the following command:

CFTUTIL ABOUT

3. Start Copilot (start each of the Copilots in the multi-node environment).

copstart

4. After restarting the Copilots, restart the Transfer CFT server:

cft restart

5. Check the upgraded Transfer CFT multi-node multihost system.

CFTUTIL listnode


https://docs.axway.com/u/documentation/transfer_cft/3.1.3/webhelp_portal/content/multi_node/about_multinode.htm


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.

Display product information The display command lists information about all installed products.

l Run the command from the root installation directory.

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

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

Windows

display.bat

UNIX

./display.sh

How to free disk space from service packsThis topic describes how to reclaim disk space that is taken up by Service Packs and updates applied to Transfer CFT over time.

Use the purge commandUse the purge command followed by the appropriate options to removed accumulated backups of installed Transfer CFT updates.

1. Navigate to the Transfer CFT installation directory.

2. Run the purge command as described in the following sections.

Syntax

purge [-h | --help] | [-k | --keep] [number] [-p | --pretend]

l UNIX: purge.sh

l Windows: purge64.exe or purge32.exe (from a command line window)

Where:



l [-h | --help]: Displays the command help.

l [-k | --keep] [number]: Specifies the number of updates that should be kept.

l [-p | --pretend]: Previews the action to be done.

l Examples

Keep only the last backup, meaning you can remove the current patch or SP.

<Transfer_CFT_install_dir>/purge.sh -k 1

Remove all backups, meaning that you cannot remove the current patch or SP.

<Transfer_CFT_install_dir>/purge.sh -k 0

<Options> include:

l [-d | --debug]: Generates debug information in the log file.

Example

<Transfer_CFT_install_dir>/purge.sh -k 1 -d

Perform a manual migration

Migration prerequisitesYou require a new license key if you are migrating from a version 2.x Transfer CFT to a version 3.x.

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

Check the TLS versionAs of Transfer CFT 3.2.0, the use of cipher suites 59, 60, and 61 is restricted to TLS 1.2 exclusively. This means that if some of your partners use a version of Transfer CFT lower than 3.2.0 that does not support TLS 1.2, and you are using ciphers 59, 60 and 61, which requires TLS 1.2 in version 3.2.0 and higher, you must add another cipher in the cipher list and remove ciphers 59, 60, 61 from the partner's cipher list.

Note You do not have to remove ciphers 59, 60, 61 in the partner cipher list if you apply the Transfer CFT patch 3.0.1 SP11.







Install Transfer CFT 3.2.4Perform a Transfer CFT installation, as described in the OS-specific installation section.

Note Do not use the Install and auto import option available in the Installer.

After performing a Transfer CFT 3.2.4, you should update the to the most recent service pack.

Load the environment Before beginning the standard migration procedure, you must load the old Transfer CFT environment.

Windows procedure

Transfer CFT 2.3.2 and 2.4

There is no profile file for Transfer CFT 2.3.2 or 2.4 in Windows.

To execute a command you must be in the correct directory. Therefore, before starting the migration, change the directory to the version-appropriate Transfer CFT installation directory.

Transfer CFT 2.5 and higher

From the console, change the directory to the Transfer CFT runtime directory and execute the profile file using the command: profile.bat

After loading the profile, you can execute commands from anywhere.



Upgrade prerequisites

Important information before performing an upgrade procedure l You must update your Transfer CFT to the most recent service pack version.

l Upgrade the Axway Installer to 4.10, if you are not at this version or higher, prior to upgrading your Transfer CFT 3.2.4.

l If needed, you can uninstall an Upgrade Pack. Doing so rolls back to the previous version before the upgrade, but all transfers and configuration modifications that were performed since the upgrade are lost.

l Backup Transfer CFT before beginning an upgrade or migration procedure.

l Before beginning the upgrade or migration procedure stop the existing version of Transfer CFT and the GUI server.

Caution For versions prior to and including Transfer CFT 2.6.4 SP1, there are export issues if you are using intermediate certificates that have a different ID. A fix was delivered in Transfer CFT 2.6.4 SP2 and in 2.4.1 SP11 to correct this PKI export issue. However, for Transfer CFT 2.5.1 you must use your original PKI configuration and corresponding certificates, and manually import these into the Transfer CFT 3.2.4 PKI database.

Install and auto import The Transfer CFT 3.2.4 Installation described in this section is assisted by the Axway installer.

The install and auto import option allows you to preform 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.

To check the Transfer CFT version, as well as the license key and system information, enter the command:

CFTUTIL ABOUT

You require a new license key if you are migrating from a version 2.x Transfer CFT to a version 3.x.

ProcedureRun 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.2.4 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 screens

At this point you can select to migrate. The Installer page asks if you want to import data from your existing Transfer CFT instance. In the following screen, you can select which types of data you'd like to import.

1. Select Yes to perform an automatic migration. Click Next.

2. Enter or navigate to the path for the existing profile file (profile.bat or profile.sh) for version 2.5 and higher. The profile file should be located in the runtime folder of the existing Transfer CFT installation.

3. Click to select configuration elements and objects that you want to import from the existing Transfer CFT instance. You must manually migrate execs, exits, and APIs.

Identity

1. You are prompted to confirm the local instance details. Modify if necessary, and click Next to continue.

2. Check the license key.

Post auto-importIf you used the install and auto import procedure with your existing Transfer CFT to Transfer CFT 3.2.4, at the end of the installation a new directory called migration is created in the runtime directory. This directory stores all of the information used during the auto import process. You can modify the extracted files and/or directory, and manually re-import this data at any time.

The contents of this Auto import directory are described in the following table.

File Directory Description of extracted data

cftcat.xml Catalog file.

cftcom.xml Communication media.

cft-conf.cfg Transfer CFT general configuration, which is applied to the new installation (contained in CFTPARM/CFTPART internal datafiles).




cft-conf-warning.txt

Contains file path declarations from the cft-conf.cfg file that were used in the former Transfer CFT environment and that cannot be imported into the new installation.

cft-pki.cfg The PKI configuration that is applied to the new installation (as of version 2.4).

PKI directory Contains extracted SSL certificates (pending version).

cft-uconf.(sh/bat)

Contains:

l UCONF parameters (as of V2.5.1)or

l Sentinel parameters (TRKAPI.cfg - V2.3.2 and V2.4.x)

and/or

l Copilot parameters (copconf.ini - V2.4.x)

This file is used to set the new installation UCONF parameters.

cft-uconf-warning.txt

Contains UCONF parameters set by the user in the former Transfer CFT environment and that cannot be imported into the new installation.

migration.(sh/bat)

Contains instructions on how to re-import the collected data into a new installation, and includes the PKI, general configuration, UCONF parameters, catalog and communication media files.

Auto import in multi-node architecture This section describes how to proceed to use auto import for Transfer CFT 3.0.1, 3.1.3, or 3.2.2 multi-node in multi-hosts.

ProcedureOn the first host:

The automatic import is performed during the Transfer CFT 3.2.4 installation. During the installation, dialog boxes let you select configuration data from the existing Transfer CFT to import.

While installing first node on cluster architecture, you should opt to import data from the previous Transfer CFT version. Execute the procedure as described here. During installation of additional nodes, the option of importing data from previous version of Transfer CFT should not be selected.



If you choose to migrate your existing Transfer CFT to 3.2.4 using the automatic import method, at the end of the installation a new directory called auto_import is created in the runtime directory. This directory stores all of the information used during the installation and auto import. You can modify the extracted files and/or directory, and manually re-import this data at any time.

If you are installing and performing an auto import from a Transfer CFT with multi-node architecture enabled, the contents of the Auto_import directory are as shown in the table below.

On additional hosts:

Repeat the installation steps, indicating the appropriate shared directories. See the information provided in Multi-node options.

Table 2. Auto_import directory


cftcatXX.xml Catalog files. XX represents the node number, from 00 to Total_Number_of_Nodes -1.

cftcom.xml Communication media for node manager.

cftcomXX.xml Communication media for nodes. XX represents the node number, from 00 to Total_Number_of_Nodes -1.

cft-conf.cfg Transfer CFT general configuration, which is applied to the new installation (contained in CFTPARM/CFTPART internal datafiles).

cft-conf-warning.txt

Contains file path declarations from the cft-conf.cfg file that were used in the former Transfer CFT environment and that cannot be imported into the new installation.

cft-pki.cfg The PKI configuration that is applied to the new installation, as of version 2.4.

PKI directory Contains extracted SSL certificates (pending version).

cft-uconf.(sh/bat)

Contains:

l UCONF parameters (as of V2.5.1)- or -

l Sentinel parameters (TRKAPI.cfg - V2.3.2 and V2.4.x)

- and/or -

l Copilot parameters (copconf.ini - V2.4.x)

This file is used to set the new installation UCONF parameters.




cft-uconf-warning.txt

Contains UCONF parameters set by the user in the former Transfer CFT environment and that cannot be imported into the new installation.

migration.(sh/bat)

Contains instructions on how to re-import the collected data into a new installation, and includes the PKI, general configuration, UCONF parameters, catalog and communication media files.

Migrating from Transfer CFT 2.3.2 This topic describes how to migrate Transfer CFT 2.3.2 to 3.2.4.

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 Migration prerequisites on page 74 for details.

2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter:

CFTUTIL CFTEXT type=all, fout=cft-extract.conf

3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the Transfer CFT 3.2.4 installation.

4. Load the Transfer CFT 3.2.4 environment.

5. Import your static configuration objects using the cftinit command. Enter:

cftinit cft-extract.conf

Migrating trkapi.cfg file parameters 1. In the trkapi.cfg file, select the parameters you want to import into 3.2.4.

2. Create a script file, for example:

o Windows: trkapi-import.bat

3. For each parameter you select, add a UCONF command line to your new script file using the format: UCONFSET id=<parameter_id>, value=<value>



4. Use the parameter mapping between trkapi and UCONF, as listed in the following table, to specify the correct parameter id.

Parameter mapping between the trkapi.cfg file and UCONF

Parameter in trkapi.cfg Parameter names in UCONF

TRACE sentinel.trktrace

TRKGMTDIFF sentinel.trkgmtdiff

TRKIPADDR_BKUP sentinel.trkipaddr_bkup

TRKIPPORT sentinel.trkipport

TRKIPPORT_BKUP sentinel.trkipport_bkup

TRKLOCALADDR sentinel.trklocaladdr

TRKPRODUCTNAME sentinel.trkproductname

XFB.BufferSize sentinel.xfb.buffer_size

XFB.Log (UNIX) sentinel.xfb.log

XFBLOG (Windows) sentinel.xfb.log

XFB.Sentinel sentinel.xfb.enable

XFB.Trace sentinel.xfb.trace

XFB.Transfer sentinel.xfb.transfer


6. Import the selected UCONF parameters using the command CFTUTIL. Replace <script_filename> with the new script file path: CFTUTIL <prefix_character><script_filename>

Example

l Windows: CFTUTIL #trkapi-import.bat

Migrating PKI 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.2.4 runtime using the PKIUTIL PKIFILE command. Next import each certificate using the PKIUTIL PKICER command.

For more information, refer to the Transfer CFT 3.2.4 User's Guide, sections Using the PKIFILE command and Using the PKICER command.



Migrating the runtime environment

Migrating the catalog 1. Load the Transfer CFT 3.2.4 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:

l UNIX: _CFTCATA

l Windows: $CFTCATA

CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_output.xml,

ofname=<catalog_filename_new_installation>

Migrating the communication media files 1. Load the Transfer CFT 3.2.4 environment.

2. Export the communication media file using command CFTMI230:

CFTMI230 MIGR type=COM, direct=FROMCOM, ifname=<com_2.3.2_filename>, ofname=com_output.xml

3. Import the communication media file using command CFTMI. Replace the <com_filename_new_installation> with the system-specific environment variable:

l UNIX: _CFTCOM

l Windows: $CFTCOM

CFTMI MIGR type=COM, direct=TOCOM, ifname=com_

ouput.xml, ofname=<com_filename_new_installation>

Migrating from Transfer CFT 2.4 This topic describes how to migrate from Transfer CFT 2.4 to version 3.2.4. Before starting this migration procedure you must perform the steps described in Before you start.





1. Load the Transfer CFT 2.4 environment. See the Migration prerequisites on page 74 for details.

2. Export your static configuration objects using the command CFTUTIL CFTEXT. Enter: CFTUTIL CFTEXT type=all, fout=cft-extract.conf

3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the Transfer CFT 3.2.4 installation.




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.2.4.


o Windows: trkapi-import.bat

3. For each parameter you select, add a UCONF command line to your new script file using the format:

UCONFSET id=<parameter_id>, value=<value>

Use the parameter mapping between trkapi and UCONF, as listed in the following table, to specify the correct parameter id.

Table 3. Parameter mapping between the trkapi.cfg file and 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


5. Import the selected UCONF parameters using the command CFTUTIL. Replace <script_filename> with the new script file path.

CFTUTIL <prefix_character><script_filename>

Example

l Windows: CFTUTIL #trkapi-import.bat

Migrating 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.2.4.


o Windows: copconf-import.bat

3. For each selected parameter add a UCONF command line in your new script file using the format:


Use the parameters mapping between copconf and UCONF as listed in the following table to specify the correct parameter id.



Table 4. 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


5. Import the selected UCONF parameters using the command CFTUTIL. Replace the <script_filename> with the new script file path.




Example

l Windows: CFTUTIL #copconf-import.bat

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.2.4 environment.

4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_database_filename> with the appropriate variable:

o Windows: The absolute path value for the CFTPKU environment variable

PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’

5. Import your PKI certificates into Transfer CFT 3.2.4 using the command PKIUTIL. Replace the <script_filename> with the new script file path.

PKIUTIL <prefix_character><script_filename>

Example

l Windows: PKIUTIL #pki-extract.conf


Migrating the catalog 1. Load the Transfer CFT 2.4 environment.


CFTMI240 MIGR type=CAT, direct=FROMCAT, ifname=<catalog_2.4_filename>,

ofname=catalog_output.xml


4. Import the catalog using the command CFTMI. Replace the <catalog_filename_new_installation> with the corresponding environment variable:

o Windows: $CFTCATA





Migrating the communication media files 1. Load the Transfer CFT V2.4 environment.


CFTMI240 MIGR type=COM, direct=FROMCOM, ifname=<com_2.4_filename>,

ofname=com_output.xml

3. Load Transfer CFT 3.2.4 environment.

4. Import the communication media file using command CFTMI. Replace <com_filename_new_installation> with the corresponding environment variable:

o Windows: $CFTCOM

CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_

filename_new_installation>

Migrate from Transfer CFT 2.5 or 2.6 This topic describes how to migrate Transfer CFT 2.5 or 2.6 to version 3.2.4.

Migrate the configuration


1. Load the former Transfer CFT (2.5 or 2.6) environment. See the Migration prerequisites on page 74 for details.



3. Open the extract configuration files, cft-extract.conf, and update the file paths with those of the new Transfer CFT 3.2.4 installation.


5. Import your static configuration objects using the cftinit command.

6. Enter:




Migrating UCONF parameters 1. Load the former Transfer CFT (2.5 or 2.6) environment.

2. Display your UCONF parameters using the CFTUTIL LISTUCONF command. Enter: CFTUTIL LISTUCONF scope=user

3. Select the UCONF parameters that you want to import into the new Transfer CFT 3.2.4.

4. Create a script file such as:

l Windows: uconf-import.bat

5. For each parameter you select, add a line to the new script file in the format:



7. Import the selected UCONF parameters using the script file and the CFTUTIL command. Replace the <script_filename> with the new script file path:


Example

l Windows: CFTUTIL #uconf-import.bat

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=pki-extract.conf


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 Windows: The absolute path value for the CFTPKU environment variable

5. Import your PKI certificates into the new Transfer CFT 3.2.4 using the command PKIUTIL. Replace the <script_filename> with the new script file path: PKIUTIL <prefix_character><script_filename>

Example



l Windows: PKIUTIL #pki-extract.conf


Migrating the catalog 1. Load the former Transfer CFT (2.5 or 2.6) environment.

2. Export the catalog using the command CFTMI240.





l Windows: $CFTCATA

Table 5. Example



Migrating the communication media files 1. Load the former Transfer CFT (2.5 or 2.6) environment.


CFTMI240 MIGR type=COM, direct=FROMCOM, ifname=<com_2.5_filename>,



4. Import the communication media file using command CFTMI. Replace the <com_filename_new_installation> with the corresponding environment variable:

o Windows: $CFTCOM

Table 6. Example





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.2.4.

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 Migration prerequisites on page 74 for details.







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:



4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_database_filename> with the OS appropriate value:

l UNIX: $CFTPKU

l Windows: The absolute path value for the CFTPKU environment variable: PKIUTIL PKIFILE fname=<pki_database_filename>, mode='CREATE’

5. Import your PKI certificates into the new Transfer CFT 3.2.4 using the command PKIUTIL. Replace the <script_filename> with the new script file path:

PKIUTIL <prefix_character><script_filename>

Examples



• Windows: PKIUTIL #pki-extract.conf


Migrating the catalog 1. Load the former Transfer CFT (2.6.4 or 2.7) environment.






l Windows: $CFTCATA

Example



Migrating the communication media files 1. Load the former Transfer CFT (2.6.4 or 2.7.0) environment.


CFTMI240 MIGR type=COM, direct=FROMCOM, ifname=<com_2.7.0_filename>,


3. Load the new Transfer CFT3.2.4 environment.

4. Import the communication media file using command CFTMI. Replace the <com_filename_new_installation> with the corresponding environment variable:

l Windows: $CFTCOM

Example





Migrating from Transfer CFT 3.0.1 or 3.1.3This topic describes how to migrate Transfer CFT 3.0.1 or 3.1.2 to version 3.2.4. It is divided in 2 sections, the first section describes migration for a single node architecture, and the second section multi-node architecture. Lastly there are instructions explaining what would be needed to migrate from single node architecture to multi node architecture.

Single node architecture


Migrating the 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.3 environment. See the Migration prerequisites on page 74 for details.







Migrating PKI certificates 1. Load former Transfer CFT 3.0.1 or 3.1.3 environment.

2. Export your PKI certificates using the command PKIUTIL PKIEXT. Enter:



4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_database_filename> with the appropriate value: $CFTPKU for UNIX, the absolute path value for the CFTPKU for Windows. Enter:

PKIUTIL PKIFILE fname=<pki_database_filename>,

mode='CREATE’



5. Import your PKI certificates into Transfer CFT 3.2.4 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 catalog

1. Load former Transfer CFT 3.0.1 or 3.1.3 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


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:

CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_

output.xml, ofname=<catalog_filename_new_cft >

Migrating the communication media files


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


4. Import the communication media file using command CFTMI. Replace the <com_filename > with the corresponding environment variable, _CFTCOM for UNIX or $CFTCOM for Windows. Enter:

CFTMI MIGR type=COM, direct=TOCOM, ifname=com_



ouput.xml, ofname=<com_filename_new_cft >

Multi node architecture


Migrating the main configuration and UCONF parameters

Migrate PARM, PART, IDF, other static configuration objects and UCONF parameters as follows:








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


4. Create a new PKI internal datafile using the command PKIUTIL PKIFILE. Replace <pki_database_filename> with the appropriate value, $CFTPKU for UNIX or the absolute path value for the CFTPKU for Windows. Enter:

PKIUTIL PKIFILE fname=<pki_database_

filename>, mode='CREATE’

5. Import your PKI certificates into Transfer CFT 3.2.4 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 catalog


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


4. Import all catalogs using the command CFTMI for each of them. Use the same node number on both <node> on command. Enter:

CFTMI MIGR type=CAT, direct=TOCAT, ifname=catalog_

output_<node>.xml, ofname=<catalog_filename_new_

cft><node>

Migrating the communication media files


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


4. Import all communication media files using command CFTMI for each of them. Use the same node number on both <node> on command.

l Enter: CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput.xml, ofname=<com_filename_for_node_manager_on_new_cft>



l For each node, enter: CFTMI MIGR type=COM, direct=TOCOM, ifname=com_ouput_<node>.xml, ofname=<com_filename_for_node_<node>_on_new_cft>

Single-node to multi-node architecture migrationThe only difference between migrating from single node to multi-node architecture and migrating from single-node to single-node architecture is the catalog migration step. Since there is no catalog named cftcata in multi-node, import the catalog exported from single-node architecture to the catalog of any of the nodes in the multi-node 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 or higher.

OverviewThere are two ways to activate Transfer CFT to Central Governance connectivity following an upgrade procedure:

l Automatically activate connectivity on page 96

l Manually activate connectivity on page 97

Additional information and tasks:

l Connect to a different Central Governance system on page 100

l Use former configuration objects on page 100

l View managed features on page 100

Automatically activate connectivityUNIX/Windows

The automatic activation is only available in UNIX/Windows. Please refer to the Manually activate connectivity on page 97 below for z/OS or IBM i instructions.



This section describes how to run the installer in configure mode to enable Central Governance connectivity.

Note If running in Windows, the same user who performed the initial installation (or same type of user) must start the installer.

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 in configure mode.

GUI

l UNIX: configure.sh –m gui

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

Console

l Windows:



3. In the installer screen, select Configure your existing installation.

4. Enter the license key if required.

5. Accept or modify the UI server and service mode screen values.

6. In the Governance Mode screen, select Central Governance.

7. In the CG connectivity screen, enter the Central Governance values. For Transfer CFT z/OS installations, see Use compliant characters for the z/OS shared secret on page 100.

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. Therefor, prior to connecting to Central Governance deactivate all previously activated connectors, for example PassPort AM, PassPort PS, and Sentinel.

CFTUTIL uconfunset id=am.type

CFTUTIL uconfunset id=sentinel.xfb.enable

CFTUTIL uconfset id=pki.type, value=cft

Note When running in a z/OS environment you must additionally set the am.passport.superuser with the user that will start the Copilot server.

3. Ensure that all UCONF values used to identify a Transfer CFT instance are defined. These parameters include:

l cft.full_hostname

l cft.instance_id

l cft.instance_group

Use the format:

CFTUTIL uconfset id=cft.instance_id, value=<cft_id>

You must set the UCONF parameter cg.configuration_policy if you want to override the default policy applied by Central Governance when you register a Transfer CFT in Central Governance.

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',

pkifname = '$CFTPKU',

pkipassw = 'CFT',

state = 'ACT',

mode = 'CREATE'

After inserting the correct certificate in the PKI database, define the UCONF variable cg.ca_cert_id. This value is required so that Transfer CFT knows which certificate to use when communicating with Central Governance.

CFTUTIL uconfset id=cg.ca_cert_id, value='CG_CA'

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

Use the format:

CFTUTIL uconfset id=cg.host, value=<host_value>

Enable Central Governance

CFTUTIL 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 GovernanceProduct List to confirm that the registration was successful.



Use compliant characters for the z/OS shared secretOn Transfer CFT z/OS

When setting the Central Governance "shared secret" during a Transfer CFT z/OS installation, translation issues may occur if you use certain characters. For example, if you enter !SECRET (using code page IBM-1147) the shared secret is translated to §SECRET during the Central Governance registration. Therefore, you must use compliant characters in the shared secret value when working in a z/OS environment.

Connect to a different Central Governance systemIf Transfer CFTwas previously registered on a Central Governance system but you now want to register it on a different one, perform the steps in Manually activate connectivity and as a final step, prior to starting Copilot, reset the Central Governance registration id.

CFTUTIL uconfunset id=cg.registration_id

.

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.

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

Multi-node architecture no yes

CRONJOB no yes



Feature Manage using Central Governance

Supported but not configurable using Central Governance

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

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 perform 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.2.4 runtime directory and compile them.

1. Copy the API source code to <new_Transfer CFT_3.2.4_installation_dir>/runtime/src/capi and compile.

2. Copy the Exit source code to <new_Transfer CFT_3.2.4_installation_dir>/runtime/src/exit and compile.

Exec scriptsCopy the exec scripts to <new_Transfer CFT_3.2.4_installation_dir>/runtime/exe. It is important that you update any paths that you were using in the exec scripts to reflect the new installation directory.

Post-manual migration only

Migrating UCONF parameters from a previous Transfer CFT 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.FORMER-PARAMETER-NAME. For example, TRKTNAME becomes sentinel.TRKTNAME.



l Copilot ini file (copconf.ini) This file no longer exists. All former Copilot parameters are named copilot.SECTION.PARAMETER-NAME in the UCONF interface. For example, the parameter ServerPort, located in the general section, is now copilot.general.serverport.

l The profile file, formerly ENV_CFT or cft.ini, now uses UCONF to set the environment variables.

Post upgradeIf you performed an upgrade, you need only recompile your APIs and Exits.


5 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.

About uninstalling in Windows The same user that did the initial installation (or at least the same type of user) must start the uninstall procedure.

Services modification

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


<domain>\<username>


Example

Local user: user1

.\user1

<hostname>\user1

Network user: user2

<domain_name>\user2

Before you begin uninstalling, you must stop the servers where you want to uninstall.

1. You can run the installer in uninstall mode using GUI or console mode as follows. Enter:

If you installed products on Windows in service mode, the installer removes the service.

GUI mode

Windows: In the Start menu, select Axway Software > Axway [installation name] > Uninstall

Console mode


https://docs.axway.com/bundle/TransferCFT_332_UsersGuide_allOS_en_HTML5/page/Content/multi_node/about_multinode.htm

5 Uninstall

Windows:

l uninstall32.exe –m console

l uninstall64.exe –m console

3. Click Uninstall when prompted. A warning message displays; click Yes to continue with the uninstall.

4. Click Next to see the uninstall summary, and Finish to exit.


6 Create a product deployment package

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

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

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

The procedure consists of:

l Installing a template Transfer CFT 3.2.4

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

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.

Windows: The default Axway installation directory is C:\Axway.

Run the configure32.exe or configure64.exe executable depending on the platform.

3. The Installer wizard displays. In the Welcome page select Next.

4. In the Configuration Type page, select Create an Express Package. Click Next to continue.

5. Specify the file name of the Transfer CFT installation package that you used to install the Transfer CFT template. The package name format is Transfer_CFT_<version>_Install_<platform>_BN<buildNumber>.zip.

6. Optionally, specify the file name of the service pack and/or patch to embed in the Express Package.

o The format of the service pack name is Transfer_CFT_<version>_SP<SPNumber>_<platform>_BN<buildNumber>.jar.

o The format of the patch name is Transfer_CFT_<version>_Patch<PatchNumber>_<platform>_BN<buildNumber>.jar.

7. Enter the path to the location where you want the new Express Package to be saved once generated.


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.

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.

Windows

Unzip the package using your favorite zip tool.

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



3. Rezip the package.

Windows

Browse to the ExpressPackage directory, and zip all contained files into a package named Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>_new.zip (excluding the original zip file).

Example: Install Transfer CFT in a different directory In this example, the Transfer CFT template was installed in the /home/cft/Axway/Transfer_CFT directory.

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

Axway_InstallDir = /opt/Axway

CFT_InstallDir = /opt/Axway/Transfer_CFT

CFT_RuntimeDir = /opt/Axway/Transfer_CFT/runtime

Example: Install Transfer CFT in the home directory of different user accountsYou 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 s

WINDOWS In this example, the Transfer CFT template was installed on server0 by the user account test, in the C:\Users\test\Axway\Transfer_CFT directory.

Axway_InstallDir = %USERPROFILE%\axway

CFT_InstallDir = %USERPROFILE%\axway\cft

CFT_RuntimeDir = %USERPROFILE%\axway\cft\runtime

Install the Express Package Note Windows only. If you have implemented a firewall, deactivate the firewall prior to

installation.

To deploy and install the Express Package:



1. Upload the generated Transfer_CFT_<version>_ExpressPackage_<platform>_<timestamp>.zip file to the target server.

2. Unzip the package.

3. Browse to the ExpressPackage directory located within the unzipped package.

4. Run the install executable. On Windows platforms (7/2008/2012) you must run the install executable with administrator rights.

Note If you run the install without an argument, the install executable uses the expressPackage.properties file, in the ExpressPackage directory, as the customization file. In command line you can specify a different file name using the following OS-specific syntax.

Windows

install.exe <file name>

Limitations l Transfer CFT Express Package does not support cluster mode installations.

l Transfer CFT Express Package cannot embed a Transfer CFT upgrade pack.


7 Troubleshooting

Troubleshoot installation and registrationThis section lists some possible post-installation issues along with corresponding corrective actions when applicable. If corrective actions do not remedy the issue, check the Support tools section for more information, or contact 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.


7 Troubleshooting

Registration fails after installing in service mode when using a firewall Windows only, firewall enabled

Transfer CFT cannot register in Central Governance when installing Copilot in service mode.

l Preventive measure: Deactivate the firewall to perform the registration.

l Workaround: If you encounter this error, perform the following steps to register:

1. Stop the Copilot Windows service.

2. Manually start the service in a DOSBOX to register.

3. Accept the authorization from the Windows firewall.

Re-register with Central 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.1.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.


7 Troubleshooting

Applying a license keyWindows

You need to apply a valid license key to Transfer CFT in the following situations:

l You perform an initial Transfer CFT installation.

l To replace an expired license key (typically after a year).

Obtain a license key 1. Install Transfer CFT. You can install Transfer CFT without a license key, and enter the key

afterward.

2. After completing the installation, or for an existing installation, use the command cftutil about to retrieve your system information.

3. Contact the Axway Fulfillment team at the appropriate email address, and provide the hostname and system information.

l For a US key, contact: [email protected]

l For an EMEA or APAC key, contact: [email protected]

Apply a license keyTo apply the license key(s) from the Axway Fulfillment team, enter the path to the indirection file. Place a # character before the path, for example KEY=#conf\cft.key.

l The file can contain one or multiple license keys, but it must have one key per line.

l On start up the first valid key is used.

Example Use the CFTUTIL utility to execute the about command to find the CPU ID.

Cftutil about

* model =

* hostname = ITEM-12345

* cpuid = 000000000000E01A

In this example, the CPU ID is 0E01A. Your hostname and cpuid will differ from the example.


7 Troubleshooting

Support tools /contact SupportThis section describes the tools available to help you collect information and contact support if you are unable to troubleshoot an error or issue.

Accessing the Axway Support siteIn the Axway Sphere Support web site, 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 OS-specific 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.



7 Troubleshooting

Using command line

UNIX/WindowsIn command line enter: cft_support collect

Activating Transfer CFT traces when a problem occurs during the transferNote ATM traces are available only when using Transfer CFT Local Administration. However

Central Governance managed Transfer CFT is the recommended version.

Transfer CFT traces are managed by the Advanced Trace Manager (ATM) component. ATM is a problem resolution assistance tool that is used to save Transfer CFT information, and retrieve previously saved Transfer CFT information.

You may need to initiate tracing in order to assist Transfer CFT Support service if an error occurs. The Transfer CFT Support service can analyze the traces to better help you resolve the issue.


8 Operations

About Windows operations

Transfer CFT Windows specific operationsThis section describes functioning and operations in a Windows environment, including:

l Operating the product

l Specific system functions

l Programming interfaces

l Transfer CFT client/server architecture

The information in the Windows operations section may be supplemented, corrected, or even contradicted by the README.TXT file or the Release Notes supplied with the product. The README.TXT file and Release take priority in this case.

Product presentationTransfer CFT can operate both as client and/or as server. The number of simultaneous transfers that Transfer CFT can support is defined by the start-up key. It is also limited by the properties of the networks used. The TCP/IP network is supported.

About Windows operations

Transfer CFT Windows specific operationsThis section describes functioning and operations in a Windows environment, including:

l Operating the product

l Specific system functions

l Programming interfaces

l Transfer CFT client/server architecture


8 Operations

The information in the Windows operations section may be supplemented, corrected, or even contradicted by the README.TXT file or the Release Notes supplied with the product. The README.TXT file and Release take priority in this case.

Product presentationTransfer CFT can operate both as client and/or as server. The number of simultaneous transfers that Transfer CFT can support is defined by the start-up key. It is also limited by the properties of the networks used. The TCP/IP network is supported.

Transfer CFT communication systemsThis topic presents basic information about the hardware devices and the software for each of the communications systems. Direct contact with the distributor ensures that you have an exhaustive and accurate list of devices than can be used with Transfer CFT Windows.

Transfer CFT Windows can use the TCP/IP network as its communications system.

Transfer CFT provides two options:

EICON option

This option was validated with the EICON card resident on the same machine on which Transfer CFT Windows executes.

EICON products used for validation were:

l On Windows:

o C21 card or a S51 card

o EICON WAN services for Windows (V3R4)

o Eicon WAN Adapters

Refer to the operations to perform prior to your first start-up with an EICON card, in Running CFT for the first time.

CAPI option

This option works with all types of cards. It has been validated with a CAPI interface card resident on the same machine on which Transfer CFT Windows is executed, under all operating systems.

The products used for validation are:

l DIVA card from EICON, or GAZEL card

l Corresponding CAPI driver

Refer to the operations to perform prior to your first start-up with ISDN-CAPI cards, in Running CFT for the first time.


8 Operations

TCP/IP networkTransfer CFT can be based on the TCP/IP layer supplied as standard by Windows.

When it operates in TCP/IP, Transfer CFT can use any type of link that can be implemented via the WINSOCK interface.

Refer to the operations to perform prior to your first start-up in TCP/IP, in Running CFT for the first time.

Applying a license keyWindows

You need to apply a valid license key to Transfer CFT in the following situations:

l You perform an initial Transfer CFT installation.

l To replace an expired license key (typically after a year).

Obtain a license key 1. Install Transfer CFT. You can install Transfer CFT without a license key, and enter the key

afterward.

2. After completing the installation, or for an existing installation, use the command cftutil about to retrieve your system information.

3. Contact the Axway Fulfillment team at the appropriate email address, and provide the hostname and system information.

l For a US key, contact: [email protected]

l For an EMEA or APAC key, contact: [email protected]

Apply a license keyTo apply the license key(s) from the Axway Fulfillment team, enter the path to the indirection file. Place a # character before the path, for example KEY=#conf\cft.key.

l The file can contain one or multiple license keys, but it must have one key per line.

l On start up the first valid key is used.

Example Use the CFTUTIL utility to execute the about command to find the CPU ID.

Cftutil about


8 Operations

* model =

* hostname = ITEM-12345

* cpuid = 000000000000E01A

In this example, the CPU ID is 0E01A. Your hostname and cpuid will differ from the example.

Running Transfer CFT for the first time The elements and tasks required to start Transfer CFT for the first time include:

l The software protection key

l Validating communication layers

l Setting the environment

l Starting Transfer CFT

l Shutting down Transfer CFT

The software protection keyA software protection key is required in order to start the Transfer CFT. The key defines certain technical and commercial options:

l The operating system

l The number of simultaneous transfers

l The period of the commercial contract

l The communications layers supported

l The transfer protocols supported

Users must obtain the correct key from the responsible departments.

Validating the communication layers Before starting Transfer CFT for the first time, you must validate the Transfer CFT communications layers.


8 Operations

Communication layer

Function

TCP/IP When installing the TCP/IP layer, you will find several utilities (ping.exe, telnet,…) to enable you to verify that the installed layer functions correctly.Note: These applications do not fully use the exact network layer on which Transfer CFT is directly based. As a result you must perform a test of this type, but it is not necessarily complete as a test prior to installing Transfer CFT/Windows

ISDN-CAPI The company supplying the card also generally supplies the test utilities for this type of network.

Setting the environment After installing Transfer CFT , but before starting Transfer CFT you should:

l Launch profile.bat in the Transfer CFT runtime directory to define environment variables.

l To create a new set of Transfer CFT working files, parameters, partners, catalog, communication, logs, use the sample configuration files cft-tcp.conf and cft-tcp-part.conf in the runtime\conf directory. You can configure these during the product installation or manually after installation.

l Use cftinit <configuration_file> to interpret the parameter and partner files. For example: cftinit conf\cft-tcp.conf

Sample file details

cft-tcp.conf: Contains only PARM object definitions (PARM, CAT, COM, LOG, ACCNT, PROT, SEND, RECV,...etc.)

cft-tcp-part.conf: Contains partner definitions (CFTPART, CFTTCP, CFTSSL)

Delivered partners are:

l PARIS - NEW YORK

l LOOP

l LOOPSSL0

Transfer CFT commands

Version 2.7.1 and higher Version 2.7.0 and lower

cft start cftstart

cft stop cftstop

cft status cftstatus


8 Operations


cft force-stop cftstop -kill

cft force-stop –kill cftstop -forcedkill

The former cftstart and cftstop commands are redirected to the new standardized command for continued compatibility.

Starting Transfer CFTIf you have not already done so, from the runtime directory launch profile.bat to set the Transfer CFT environment. Then in the same dos session, enter the command: cft start

Shutting down Transfer CFTTo shut down Transfer CFT use the shut command, CFTUTIL SHUT. Alternatively, in your dos session enter the command: cft stop

Service modeYou can retroactively install Service mode for Transfer CFT.

You can use the Installer Configure mode to install and uninstall the services for the Transfer CFT Server and Transfer CFT Copilot. To launch the Installer in Configure mode, from the Start menu select Programs > Axway Software > Axway Transfer CFT > Configure.

Starting a CFTW desktop windowYou can use the Windows utility cftw.exe to open a desktop window that displays the Transfer CFT CFT log messages and processes list in two separate tabs. The cft start command automatically launches this cftw.exe utility when the UCONF parameter cft.nt.start_graphmode is set to Yes (default value).

Note When Transfer CFT is running as a service, you must have the service configured to authorize desktop interaction. Additionally you must manually launch the cftw.exe.

If Transfer CFTis not running, use the -wait option with cftw so that the utility waits for Transfer CFT to start instead of exiting immediately.

cftw.exe -w


8 Operations

As of Transfer CFT v3.0.1, a second cftw UCONF parameter, cft.nt.cftw_display_log_messages, is available. To display log messages in the cftw window, change the parameter setting from No (default value) to Yes.

Running Transfer CFT for the first time The elements and tasks required to start Transfer CFT for the first time include:

l The software protection key

l Validating communication layers

l Setting the environment

l Starting Transfer CFT

l Shutting down Transfer CFT

The software protection keyA software protection key is required in order to start the Transfer CFT. The key defines certain technical and commercial options:

l The operating system

l The number of simultaneous transfers

l The period of the commercial contract

l The communications layers supported

l The transfer protocols supported

Users must obtain the correct key from the responsible departments.

Validating the communication layers Before starting Transfer CFT for the first time, you must validate the Transfer CFT communications layers.

Communication layer

Function

TCP/IP When installing the TCP/IP layer, you will find several utilities (ping.exe, telnet,…) to enable you to verify that the installed layer functions correctly.Note: These applications do not fully use the exact network layer on which Transfer CFT is directly based. As a result you must perform a test of this type, but it is not necessarily complete as a test prior to installing Transfer CFT/Windows

ISDN-CAPI The company supplying the card also generally supplies the test utilities for this type of network.


8 Operations

Setting the environment After installing Transfer CFT , but before starting Transfer CFT you should:

l Launch profile.bat in the Transfer CFT runtime directory to define environment variables.

l To create a new set of Transfer CFT working files, parameters, partners, catalog, communication, logs, use the sample configuration files cft-tcp.conf and cft-tcp-part.conf in the runtime\conf directory. You can configure these during the product installation or manually after installation.

l Use cftinit <configuration_file> to interpret the parameter and partner files. For example: cftinit conf\cft-tcp.conf

Sample file details

cft-tcp.conf: Contains only PARM object definitions (PARM, CAT, COM, LOG, ACCNT, PROT, SEND, RECV,...etc.)

cft-tcp-part.conf: Contains partner definitions (CFTPART, CFTTCP, CFTSSL)

Delivered partners are:

l PARIS - NEW YORK

l LOOP

l LOOPSSL0

Transfer CFT commands


cft start cftstart

cft stop cftstop

cft status cftstatus

cft force-stop cftstop -kill

cft force-stop –kill cftstop -forcedkill

The former cftstart and cftstop commands are redirected to the new standardized command for continued compatibility.

Starting Transfer CFTIf you have not already done so, from the runtime directory launch profile.bat to set the Transfer CFT environment. Then in the same dos session, enter the command: cft start


8 Operations

Shutting down Transfer CFTTo shut down Transfer CFT use the shut command, CFTUTIL SHUT. Alternatively, in your dos session enter the command: cft stop

Service modeYou can retroactively install Service mode for Transfer CFT.

You can use the Installer Configure mode to install and uninstall the services for the Transfer CFT Server and Transfer CFT Copilot. To launch the Installer in Configure mode, from the Start menu select Programs > Axway Software > Axway Transfer CFT > Configure.

Starting a CFTW desktop windowYou can use the Windows utility cftw.exe to open a desktop window that displays the Transfer CFT CFT log messages and processes list in two separate tabs. The cft start command automatically launches this cftw.exe utility when the UCONF parameter cft.nt.start_graphmode is set to Yes (default value).

Note When Transfer CFT is running as a service, you must have the service configured to authorize desktop interaction. Additionally you must manually launch the cftw.exe.

If Transfer CFTis not running, use the -wait option with cftw so that the utility waits for Transfer CFT to start instead of exiting immediately.

cftw.exe -w

As of Transfer CFT v3.0.1, a second cftw UCONF parameter, cft.nt.cftw_display_log_messages, is available. To display log messages in the cftw window, change the parameter setting from No (default value) to Yes.

Transfer CFT user interfacesTransfer CFT features the following user interfaces:

l CFTUTIL - a command line utility that can be used after installation in the following modes:

o Command mode

o File interpretation mode

o Interactive line mode

l Transfer CFT Copilot UI Transfer CFT Copilot UI - a graphical user interface that enables users to manage and use Transfer CFT via a series of windows and icons

Using either of the user interfaces you can create the working environment and configure Transfer CFT as follows:


8 Operations

l Create and delete parameter, partner, catalog, log, and account files (Transfer CFT must be stopped)

l Modify parameters

l View parameter, partner, catalog, log, and account files

l Send commands to Transfer CFT

Start Transfer CFT from the user interfaceTo start the Transfer CFT from the user interface:

1. Start the UI server. You must have appropriate rights to log on the Transfer CFT UI server.

2. Launch the Transfer CFT UI.

3. Enter the login/password.

4. Start the Transfer CFT. You must have appropriate rights to start the Transfer CFT.

For more information, refer to Transfer CFT Administration.

Related topics

l Define user rights

l Starting/stopping Transfer CFT

l Starting/stopping the GUI

Defining user rightsBefore you can start Transfer CFT from the Transfer CFT Copilot server, the Copilot server must be started. Additionally you will need rights to log on to this server. The overall process requires that you:

l Define rights before starting the Transfer CFT GUI server (Copilot)

l Define rights before logging on the Transfer CFT GUI server (Copilot)

l Define rights before starting Transfer CFT

l Define a domain user

Define rights before starting the Transfer CFT UI serverTo be able to start the Transfer CFT Copilot server you must give each Windows user read and write rights for the Transfer CFT installation folder as follows:

1. Right-click the Transfer CFT program folder.

2. Select Properties.

3. In the Properties window, select the Security tab.

4. In the Security tab, select the user and grant the user read and write rights. Click OK.


8 Operations

Additionally, if you want to start the Transfer CFT GUI server as a service with a user account, instead of the local system, it must have Log on as a service authority.

1. In a dos command window, type secpol.msc to open the Local Security Policy window.

2. Select Security Settings > Local Policies > User Rights Assignment.

3. Double-click Log on as a service.

4. Click Add user or group and define.

You can opt to control the file-access permissions and the batch execution environment by setting the UCONF copilot.misc.createprocessasuser identifier as follows:

l no: Any user who logs on the Transfer CFT GUI server will have their processes identified as the user who started the Transfer CFT Copilot server.

l yes: Any user who logs on the Transfer CFT GUI server will have their processes identified as their own.

Define rights before logging on the Transfer CFT UI (Copilot) server

copilot.misc.createprocessasuser PassPort AM

status

Rights to define

no

Not activated No need to set rights. All Windows users can log on to the Transfer CFT GUI server.

no Activated If PassPort AM is activated, you must use a PassPort AM user to log on. Check if the AM user has the rights to manage Transfer CFT.


8 Operations


status

Rights to define

yes Not activated The Windows user who is going to log on the Transfer CFT UI server, must have read and write rights for Transfer CFT install folder.Some user rights must be assigned to the user who launched the Transfer CFT UI server to permit other Windows users to log on. This is true except if it is the local system account when working in the service mode. The user rights to assign are:

l Adjust memory quotas for a process

l Impersonate a client after authentication (only on Windows 2008)

l Replace a process level token

l Create a token objectTo define user rights:

1. In a dos command window, enter lusrmgr.msc to open the system users list. Check available users.

2. In a dos command window, enter secpol.msc to open the Local Security Policy window.


4. Double-click the required right.



8 Operations


status

Rights to define

6. Close and re-open the Windows session to take into account the modifications.


8 Operations


status

Rights to define

yes Activated Some user rights must be assigned to the user who starts the Transfer CFT UI server to allow other Windows users to log on, unless it is the local system account working in service mode. The user rights are:




l Create a token object

1. In a dos command window, type lusrmgr.msc to open the system users list. Check available users.






Additionally, the user who wants to log on the Transfer CFT UI server must exist both in the


8 Operations


status

Rights to define

Windows system and PassPort AM. The Windows system performs the user authentication, and PassPort AM checks the other rights.Note: The PassPort user name is case-sensitive.

Define rights before starting Transfer CFTThe Windows user who is going to log on the Transfer CFT GUI server requires read/write rights for Transfer CFT install folder, defined as follows:





5. The same user name must exist in PassPort AM, and is allowed to manage Transfer CFT.

Note: The PassPort user name is case-sensitive.

Define domain userTransfer CFT supports domain user accounts, which allows a service to use Windows service security features.

File action executed for applicative usersTo enable for file actions, check that the USERID user has access to the transfer destination directory. To do this, copy the rights from the user's rights table and create a token object.

Post-transfer procedure executed for applicative usersTo enable for post-transfer procedures, check that the USERID user has rights to execute end-of-transfer procedures. To do this, copy the rights from the user's rights table and create a token object.


8 Operations

Define folder rights To be able to start the Transfer CFT server and the Transfer CFT GUI server (Copilot), you must give each user read and write rights for Transfer CFT as follows:





Service mode loginIf you are working in service mode, you must have Log on as a service authority.



3. Double-click Log on as a service.


Define system user access

System user enabled If copilot.misc.createprocessasuser=yes in UCONF , or Createprocessasuser=yes in [MISC], the user starting the Transfer CFT Copilot server must do the following tasks to allow other users to log on. Additionally, those users must exist in the Windows system users list.


l Simulate a client after authentication (only on Windows 2008)


Procedure






PassPort AM is activated


8 Operations

If PassPort AM is active (am.type=PassPort in UCONF), the user must exist both in the Windows system users list and PassPort AM users list. The Windows system user performs the authentication, and PassPort AM performs the other rights checks.

Note The PassPort user name is case-sensitive.

System user deactivated with PassPort AM managementIf copilot.misc.createprocessasuser=no in UCONF, all system users have the right to log on.

l PassPort AM is activated

l If PassPort AM is active (am.type=PassPort in UCONF), you must be a defined PassPort AM user to log on.

Note The PassPort user name is case-sensitive.

Related topics

About PassPort AM

UCONF parameters

Using system users WindowsThis section describes Windows specific tasks to perform to enable system user authentication and file system rights.

l Enable user authentication for Copilot on page 132

l Enable the file user rights (USERCTRL) on page 133

Enable user authentication for CopilotThis section describes how to define users for Transfer CFT Copilot server. The following information applies except if you are using the local system account when working in service mode.

The user rights to assign are:





To define user rights:





8 Operations




Some user rights must be assigned to the user who starts the Transfer CFT UI server to allow other Windows users to log on, unless it is the local system account working in service mode.

The user rights are:











Additionally, the user who wants to log on the Transfer CFT UI server must exist both in the Windows system and Central Governance (or PassPort AM). The Windows system performs the user authentication, and Central Governance (or PassPort AM) checks the other rights.

Note If using Central Governance, the user name is case-sensitive.

Enable the file user rights (USERCTRL)The Windows user who is going to perform transfers must have read and write rights for the files to be transferred.

Some user rights must be assigned to the user who launched the Transfer CFT server to permit other Windows users to perform transfers.

To assign user rights:





To define user rights:




8 Operations





Specific network functionsThis topic presents the TCP network supported by Transfer CFT Windows, and how to define the network parameters.

Supported networks TCP/IP is supported for Transfer CFT Windows.

You should consult the README file that is delivered with the product for more up to date information. If there is a contradiction between the README file and this document, the README file information takes precedence.

The network descriptions in this section are not guaranteed to be exhaustive. Additionally, the logical key can limit the maximum number of transfers.

Defining network parametersYou implement network functions by entering parameters into a single file, cftnet.cfg, located in the Transfer CFT runtime\conf folder.

This file is made up of lines using the same syntax, each of which corresponds to one function: typenet<parameter>=value, where:

l typenet is an element taking on one of the following values:

l TCP: concerns A TCP/IP network process parameter

l <parameter> is an element containing the value of one of the specific parameters indicated in this documentation . For more information see Environment Variables

l value is an element that takes on a value belonging to the parameter stated in field and according to the documentation

Comments

To edit a line of comments in the file CFTNET.CFG, you can place the ‘#’ character in the first column of this line.

Example

# this is a comment

Indication of the path for the cftnet.cfg file

Environment variable


8 Operations

CFTCFGPATH

Environment variable defining the sub-folder where the cftnet.cfg file is located. By default, Transfer CFT searches for this file in the application default folder.

Transfer CFT must be stopped when the cftnet.cfg file is created or modified.

Define additional environment variables Windows

When loading the Transfer CFT profile, files that are stored in the profile.d directory are also executed, and all defined environment variables are then available in the current environment. This enables you to use these variables in the Transfer CFT configuration or processing scripts.

How to define additional Transfer CFT environment variables 1. In the %CFTDIRRUNTIME%/profile.d directory, create a new file with .bat as the suffix. In

this file, add your customized variables as follows. For example:

set MYVARIABLE01=TheVariableValue01

set MYVARIABLE02=TheVariableValue02

2. Execute the profile command.

About Windows-specific system functionsThis section describes specific system functions when using Transfer CFT in Windows. It begins with this topic, which introduces the use of environmental variables.

About environment variablesThe operating system environment variables have an important role in Transfer CFT. In the standard Transfer CFT parameter setting, these variables establish the correspondence between the logical name and the physical name for all file names. The user uses the environment variable by prefixing its name with the character ‘$’. The variable name that corresponds to the logical file name is developed into the physical name.

Example

The environment variable [FULL_NAME] provides a definition to the operating system as follows:

FULL_NAME=C:\REP0\REP1\FILE.SUF which is used as follows by the Transfer CFT parameterization: FNAME = $FULL_NAME


8 Operations

The implementation of a certain number of non-standard functions is shown in Windows specific system functions. These functions are mostly system functions, but include some network functions.

Using the SET commandThe environment variables are set by the SET command, called beforehand in the same session as the CFTMAIN or CFTUTIL executable.

Using the profile.bat fileYou can set the equivalent environment variables using the profile.bat file located in the Transfer CFT runtime folder. For example, the CFTNODEL setting would be: SET CFTNODEL=YES

Note For more information, see Environment variables and specific parameters.

About Windows-specific system functionsThis section describes specific system functions when using Transfer CFT in Windows. It begins with this topic, which introduces the use of environmental variables.

About environment variablesThe operating system environment variables have an important role in Transfer CFT. In the standard Transfer CFT parameter setting, these variables establish the correspondence between the logical name and the physical name for all file names. The user uses the environment variable by prefixing its name with the character ‘$’. The variable name that corresponds to the logical file name is developed into the physical name.

Example

The environment variable [FULL_NAME] provides a definition to the operating system as follows:

FULL_NAME=C:\REP0\REP1\FILE.SUF which is used as follows by the Transfer CFT parameterization: FNAME = $FULL_NAME

The implementation of a certain number of non-standard functions is shown in Windows specific system functions. These functions are mostly system functions, but include some network functions.

Using the SET command

The environment variables are set by the SET command, called beforehand in the same session as the CFTMAIN or CFTUTIL executable.


8 Operations

Using the profile.bat file

You can set the equivalent environment variables using the profile.bat file located in the Transfer CFT runtime folder. For example, the CFTNODEL setting would be: SET CFTNODEL=YES

Note For more information, see Environment variables and specific parameters.

Environment variables in WindowsThis topic describes the environment variables and the specific parameters used in Transfer CFT Windows. The ‘*’ character indicates that all networks are concerned.

l Terms annotated with (ve) are symbolic variables.

l Terms annotated with (p * ) are specific parameters for TCP, networks, or are valid for all networks.

l In this list , the character ‘*’ indicates all networks, meaning that the key word must be set in the CFTNET.CFG file for a given network.

Variables

l CFT_CSFN (ve)

l CFTAACCN (ve)

l CFTACCNT (ve)

l CFTALOG (ve)

l CFTCATA (ve)

l CFTCFGPATH (ve)

l CFTCOM (ve)

l CFTCONTCP (ve)

l CFTEXITTIME (ve)

l CFTINQA (ve)

l CFTLCKMAX (ve)

l CFTLOG (ve)

l CFTNMLOG (ve)

l CFTNODEL (ve)

l CFTNOFLUSH (ve)

l CFTPARM (ve)

l CFTPART (ve)

l CFTSFMCPY (ve) (Deprecated. Use uconf:cft.server.force_heterogeneous_mode.)

l CFTSRVNP

l CFTSRVTO

l CFTSRVTS


8 Operations

l CFTSUFX (ve)

l CFTTRCPATH (ve)

l CFTTRCSIZE (ve)

l FTRACE (p * )

l PTRACE (p * )

l TRACE (p * )

l TZ ou TZSET (ve)

Symbols and default filesThis topic describes the symbols, default values, and variables used by Transfer CFT that are specific to Windows operations and comprises the following subjects:

l Specific symbols

l Default files used by CFTUTIL

Specific symbolsThe only FORG value supported for these systems is SEQ.

Subject Specific value

Prefix to logical names $

Wild card character ?

Separator (volume) none

Prefix to symbolic variables &

Character introducing a file name sent to CFTUTIL in parameter form

#

Character introduced in the path_name of the fname parameter (CFTRECV) from which a tree structure can be created.

+


8 Operations

Default files used by CFTUTIL

Subject Default name

Parameters file $CFTPARM

Partners file $CFTPART

Catalog file $CFTCAT

Communication file $CFTCOM

Mailbox CFTMBX

Transferable files This topic describes the Transfer CFT parameters that are specific to Windows concerning the characteristics of the transferable file.

l Characteristics of files automatically detected on transmission

l FTYPE values and FCODE values implicitly associated during transmission

l FTYPE and FRECFM values on receipt

Characteristics of files automatically detected on transmission

Parameter Automatically detected on transmission

FSPACE YES

FLRECL NO

FBLKSIZE NO

FRECFM NO

FTYPE NO

FTYPE values and FCODE values implicitly associated during transmission

FTYPE FCODE Type of sent file

' ' BINARY Binary


8 Operations

FTYPE FCODE Type of sent file

B BINARY Binary

V BINARY Binary file emulating locally a variable file format

T ASCII Text file with LF or CRLF as end-of-line separator

F ASCII Text file where the last character '1A' is transmitted (is not considered an EOF character)

O ASCII Text file with CRLF as end-of-line separator

X ASCII Text file with LF as end-of-line separator

J ASCII Stream textUsing stream text (J) allows a text type file to be sent that contains records that exceed 32 KB. As opposed to text type (FTYPE=T), stream text does not add an EOL sequence (LF or CRLF) to the received file.When using stream text (FTYPE=J), the sender and the receiver must both have the FTYPE set to J. Setting only the sender or receiver to FTYPE=J results in unexpected content for the transferred file.

FTYPE = J refers to stream text.The stream text type allows sending a text file that contains records that are larger than 32 KB. Unlike classical text types (T, O, X) the stream text type does not add an EOL sequence (LF or CRLF) at the end of the received file.

Note FTYPE J is available in Transfer CFT Transfer CFT 3.0.1 SP7 (UNIX and Windows) and higher.

FTYPE and FRECFM values on receipt

FTYPE FRECFM Type of received file

B F Binary fixed-length sequential file

B U/V Binary sequential file

V V Binary file emulating locally a variable file format

T F Fixed-length sequential text file with CRLF as end-of-line separator

T U/V Variable length sequential text file with CRLF as end-of-line separator


8 Operations

FTYPE FRECFM Type of received file

O F Fixed-length sequential text file with CRLF as end-of-line separator

O U/V Variable length sequential text file with CRLF as end-of-line separator

X F Fixed-length sequential text file with LF as end-of-line separator

X U/V Variable length sequential text file with LF as end-of-line separator

J U/V Variable length sequential text file with CRLF as end-of-line separator

General operating functions l Logical file names

l Using a definition file

Logical file namesTransfer CFT can use logical file names in order to designate the physical files and, if necessary, to state the characteristics of these files. There are two methods of doing this:

l Using the operating system environment

l Using a file to describe the logical names

Users can choose one or other of these two methods. For the same Transfer CFT, certain logical names can be described in the operating system and other in the logical names description file. A certain number of logical names are defined as standard in Transfer CFT. This is the case for Transfer CFT working files.

Note: The standard definition of the logical name for a Transfer CFT working file means that regarding this logical name, there is no prior operation to perform before operating Transfer CFT.

If not, one of the following three operations needs to be performed before operating Transfer CFT:

l The CONFIG command of CFTUTIL

l Sufficient screen parameter setting in the Copilot interface

l Transfer CFT API COM command

Logical working filesEnvironment variables


8 Operations

The following table lists the logical names of files, and defines the role.

Working file Logical name

Comment

Parameter CFTPARM Parameter file

Partner CFTPART Partner file

Catalogue CFTCATA Catalogue file

Communication CFTCOM Communication file

Log CFTLOG Log file

Log CFTALOG Alternate log file

Account CFTACCN Statistics file

Account CFTAACCN Alternate statistics file

Suffixes (1) CFTSUFX Suffixes file

Parameter SEC.INI System enabling file

Logical names CFTNMLOG Redefinition files

(1): see Recognizing file types

By default of definition for these logical names, the physical names correspond to the logical names.

Users who do not want to use the physical names of files by default, must redefine them in the operating environment where CFTMAIN, CFTUTIL, Transfer CFT Navigator (Copilot) and the Transfer CFT APIs execute. This operation must be performed BEFORE any Transfer CFT parameters are set.

When settings parameters for Transfer CFT, a user wanting to invoke a logical file name, must systematically prefix the character string for the logical name with the "$" symbol.

Example of a logical name statement: fname = $CFTCOM

Using operating system environment variables

Because it is simple and flexible, this is the preferred method and is used whenever a straightforward correspondence of logical name to physical name is sufficient.

When making re-definitions of this sort, users can use the environment variables provided by the various operating systems. Quite clearly, the redefined names must be legal for the file system used (FAT, NTFS, FAT32).

Examples of the using operating system environment variables:

SET CFTPARM=D:\MY_REP1\PARAMETSET CFTPART=D:\MY_REP2\PARTENAISET CFTCATA=D:\MY_REP3\CATALOG


8 Operations

SET CFTCOM=D:\MY_REP4\COM.CFTSET CFTLOG=D:\MY_REP5\LOG.JNLSET CFTALOG=D:\MY_REP6\ALOG.JNLSET CFTACCNT=D:\MY_REP7\ACCOUNTSET CFTAACCN=D:\MY_REP8\AACCOUNTSET CFTSUFX=D:\MY_REP9\SUFFIXESET CFTNMLOG=D:\MY_REP_10\NOMSLOG.SYS

Do not use suffixes for the physical parameter and partner file names, except in the case where Transfer CFT is operating in Client/Server with a UNIX Transfer CFT.

Note The CFTFILE command in CFTUTIL does not take into account any environment variables set and corresponding to the Transfer CFT logical file names. You can overcome this problem in a batch file by using certain operating system functions.

Example

The following command sets the CFTPARM environment variable to the value of TEST:

SET CFTPARM=TEST

The command file to be submitted contains the following line:

CFTUTIL CFTFILE type = param, fname = %CFTPARM%

When this command file is submitted, the operating system substitutes the string %CFTPARM% with the string TEST. The command submitted to CFTUTIL is as follows:

CFTFILE type = PARAM, fname = TEST

Using a definition fileUse this method when you want to associate a logical name with a physical name and file attributes. Since the content of these definitions is complex, refer to the samples supplied with the product.

The logical name of the file containing these definitions is CFTNMLOG.

For Transfer CFT Windows the only case where the use of a logical name definition file is necessary is when you use the extraction tool for standard traces (ATM tool).

Example

The following line provides an example of the content of a line in the definition file.

TRCATM=CFTTRACE.BIN O=C,F=F,R=1024,T=B

In this example, the logical name TRCATM is given as the exit file in parameter to the Transfer CFT trace extraction tool. The physical name CFTTRACE.BIN corresponds to the logical name TRCATM and the following characteristics: contiguous file organization (O=C), fixed format (F=F), record length 1024 characters (R=1024) and file is binary type (T+B).

Change of name or path of definition fileEnvironment variable


8 Operations

CFTNMLOG

By default the definition file is CFTNMLOG and it is located in the working directory.

To change the name and/or path of the definition file use the CFTNMLOG environment variable.

Communication media l About the communication media

l Defining the CFT user name

l Adjusting the time and changing the date

l CFTUTIL shutdown timeout

About the communication mediaFunctionally, Transfer CFT is made up of two parts:

l The Transfer CFT server

l The user interface

Transfer CFT uses a communication medium so that requests coming from the user interface can be communicated to the monitor section.

Transfer CFT can use a file as the communication media.

By default, the communication medium used is the file with the logical name of $CFTCOM.

Defining the Transfer CFT user nameThe Transfer CFT user name is the name under which the Windows user is logged. Under certain systems you can open a session without giving a user name. In this case, the Transfer CFT user name is USERCFT.

Adjusting the time and changing the dateThe time and date used or shown by Transfer CFT are those stated by the operating system.

By default the date changes at midnight, GMT. But as a general rule, if the country of use has been indicated, the date changes at midnight local time. However in some infrequent and rather specialized cases, the date can change at a different time (GM ± n).


TZ or TZSET


8 Operations

In general and to solve this problem the operating system provide a solution whereby users can indicate the time zone in which he is located. This solution is supplied by the environment and consists in general in setting an environment variable or a system parameter called TZ or TZSET. For additional information, consult the operating system documentation.

Transfer CFT takes this parameter into account, if it has been set.

File management functions l Managing file flushes

l Managing access conflicts to CFT working files

l Recognizing file types

l Sending a group of files

l Disabling the homogeneous mode

About file management functions

Managing file flushesIn certain circumstances, Transfer CFT performs an operation that forces a given file to be physically written to the disk - a physical flush operations.

During the transfer, Transfer CFT implements two types of flushes:

l Flushes on received files. These types of flush take place each time synchronization points are received.

l Flushes on the Transfer CFT catalog when synchronization points are received. See also the CFTCAT UPDAT parameter.

These flush operations tend to secure transfers against risks caused by serious hardware malfunctions and unexpected mains power failures. Since this security behavior is time-consuming,you may feel that such behavior is not warranted.

Deactivating the flush functionEnvironment variable

CFTNOFLUSH

You can modify one type of "flush", those implemented on received files, by setting the CFTNOFLUSH environment variable. Set the environment variable to 1 or to 0, depending on whether you want to suppress or implement this type of flush.

For example, to deactivating the "flush" function:

SET CFTNOFLUSH=1


8 Operations

By default, transfer flushes continue to occur.

Managing access conflicts with Transfer CFT working filesIn certain operating configurations, particularly in a Transfer CFT/Server – Transfer CFT/Client architecture, the Transfer CFT working files are subject to frequent requests for simultaneous write access; particularly for the communication file. To manage access conflicts the file (or part of it) is locked during the write operation. In other words, during the operation, only the process currently writing has access to the file being written.

During this time the other "waiting to write" processes repeat their access requests to the operating system.


CFTLCKMAX

You can modify the maximum number of attempts to access a file before a request fails (and a failed write attempt message is sent) to the operating environment.

The CFTLCKMAX environment variable gives users the option of adapting the maximum number of access attempts to their environment.

To access a file, Transfer CFT effects 50*CFTLCKMAX attempts.The time between two attempts is calculated randomly between 0 and 500 msec.

By default, CFTLCKMAX=1

For example, if the defined environment is CFTLMAX=10, there are 10*50 attempts to access files before a fail message is posted.

Recognizing file typesThe Windows operating systems only handle files known as binary "stream" files. Therefore, with these operating systems you do not know the type of data (binary, text, other) that a file contains.

An attempt to determine the type of data contained in a file by making a semantic study of its content is not adequate. To remedy this, Transfer CFT proposes a special file type recognition function using the suffix.

Change of name or path of suffix file


CFTSUFX

By default the suffix file is called CFTSUFX and it is located in the working directory.

To change the name and/or path of the suffix file use the CFTSUFX environment variable.


8 Operations

The data which enables Transfer CFT to ascertain a file type from its suffix is collected into a text file of which the logical name is CFTSUFX (see also the paragraph Logical File Names).

The CFTSUFX file is made up of lines that may consist of:

l A comment

l The definition of a suffix, possible followed by a comment

A comment is any item of text beginning with the character ‘#’.

A suffix is defined in accordance with the following syntax:

<suffix of 1 to 3 letters>=<letter defining the file type>

Only characters supported by the operating system can be within the first 1-3 letters defining the suffix. Wild cards, ‘?’ and ‘*’ cannot be used.

There are three main file types:

l Binary files

Transfer CFT treats this type of file as any collection of bytes. In this type of file, no binary configuration takes any particular role. In the Transfer CFT parameterization, this type of file is characterized by the letter "B".

l Text files

Transfer CFT treats this type of file as a series of text lines each separated by the pre-defined control code sequence CR-LF (0x0D – 0x0A).This type of file may or may not end in the binary code 0x5A (ctrl Z) For all Transfer CFTs, a text file is characterized by the letter "B".

l Variable files

In this type of file, records with binary contents are preceded by 2 bytes, stating the length of the record. This type of file can be generated, provided the parameterization is adequate, by Transfer CFT or by its COPYFILE utility. In the Transfer CFT parameter setting, this type of file is characterized by the letter "V".

Adding types for the Transfer CFT/Server – Transfer CFT/Client architecture

In this architecture, you can operate Transfer CFT/Client Windows with a UNIX Transfer CFT/Server.

When you select a Transfer CFT/Server-client architecture, the Transfer CFT/Server and Transfer CFT/Client elements should be specified in conjunction with Axway Sales Department.

There are certain differences in the way Transfer CFT manages text files between Windows machine and UNIX machines. These should be taken into account to obtain satisfactory functioning.

In a UNIX text file, the lines are separated from one another by the single character "0x0A", while in a Windows text file, the line separator is 2 characters "0x0D0A". When reading, this difference causes no problem at all. When writing, users must specify to Transfer CFT the type of text file it must create (UNIX text file, or Windows text file).

Transfer CFT provides you with two other letters, in addition to the letter "T", so that the text file properties can be given in full within a Transfer CFT server/client architecture, operating UNIX and Windows machines:


8 Operations

l O: forces Windows text type

l X: forces UNIX text type

The "T" type signifies native text (a Transfer CFT/Windows generates a readable text file in the Windows environments, a Transfer CFT/UNIX generates a UNIX text file).

Files of type "text" are managed in the same way on Windows systems, which are considered by Transfer CFT to be standardized environments.

The table below summarizes the letters indicating the type of file in the CFTSUFX file.

Letters defining a file type

Letter Type of file

B Binary file

O Text file (Windows text files)

V Variable file (in the Transfer CFT sense)

T Text file (native)

X Text file (UNIX)

Example of the content of the CFTSUFX file:

DOC=T #files with a ‘DOC’ suffix are text files.T*=T #files with a suffix beginning with the letter ‘T’#are text files.EXE=B #files with an ‘EXE’ suffix are binary files.V?R=V #files with a ‘V?R’ suffix are variable files.

Differentiation between upper and lower case


CFT_CSFN

Transfer CFT/Windows does not differentiate between upper and lower case in the suffix names described in the suffix file. Such differentiation does take place if the environment variable CFT_CSFN is set.

For example:

SET CFT_CSFN = 1

Sending a group of filesThis section describes how to create a command to send a group of files. To better understand this section, refer to the following general group file information:


8 Operations

l Sending a group of files

l The FNAME and WFNAME parameters in the CFTSEND and CFTRECV commands

A group file send request takes place implicitly when the value of the FNAME parameter for the CFTSEND command has the following two characteristics:

l The first character is a surrogate character ‘#’

l The FNAME parameter states a folder, or contains meta-characters

Example

FNAME = #FIC*.*

A group of files can be sent in two different ways depending on whether the two partners are standardized sites or not. The term of standardized sites means that the operating system of the two Transfer CFT partners have identical file systems (for example, Windows is considered a standardized system).

To indicate to a local Transfer CFT that it is not in standardized mode with a remote partner, the SYST parameter in the CFTPART command should be used. The SYST parameter makes it possible to indicate to the local Transfer CFT that it and the remote Transfer CFT are on different operating systems (not the same file system).

It is not necessary for the SYST parameter between standardized systems to contain data.

Sending a group of files in mixed mode

Transfer CFT detects that it is in a mixed environment because the SYST parameter of the CFTPART command contains data and is different from the local system.

In this mode, each file designated by the generic name of FNAME containing meta-characters is the object of a special transfer.

This request to send generates as many posts in the catalogue as there are files to transfer.

Sending a group of files in standardized mode

The fact that Transfer CFT is sending a group of files in standardized mode allows the supplementary functions described below to be implemented.

Transfer CFT detects that it is in standardized mode either because the SYST parameter in the CFTPART command contains no data, or because, containing data, the SYST parameter indicates the same system as that on which the local Transfer CFT is based.

In both cases, the two Transfer CFT partners implement a device which allows them to exchange only a single (large) file in place of all the files designated by the generic FNAME of the sending Transfer CFT.

This implementation is performed by calling a concatenation process external to Transfer CFT (before the transfer for the transmitter) then a "de-concatenation" process (after the transfer for the receiver).


8 Operations

These operations are performed on large and medium-sized systems, by standard tools within the operative system (for example, the IEBCOPY utilities on the IBM host or tar on UNIX). This type of standard tool does not exist on Windows. Therefore, the tools zip/unzip are provided in the Transfer CFT Windows package.

These tools operate, either with several incoming files and one outgoing (this is the concatenation called prior to the transmission), or with a single incoming and several outgoing files (this is the de-concatenation called after reception).

Transfer CFT/Windows ensures that this function is "opened" by calling different batches before transmission by the transmitter and after reception on the receiver, as follows:

l The batch file CFTSVG01 is called before transmission and on the transmitter

This batch should constitute the file called WFNAME in the CFTSEND command. This is the file which will actually be transmitted.

l The batch file CFTRST01 is called after reception and on the receiver

This batch should de-concatenate the file that has been received. This file takes the name stated in the WFNAME parameter of the CFTRECV command.

The CFTSVG01 and CFTRST01 batch files must be located in the folder as default, when Transfer CFT is executed.

These batch files are automatically called by the following parameters:

l For CFTSVG01:

o The 5th parameter (%5) designates all the files to concatenate and corresponds to the NFNAME of the CFTSEND command

o The 6th parameter (%6) gives the name of the out file for the concatenation utility and corresponds to WFNAME of the CFTSEND command

l For CFTRST01:

o The 5th parameter (%5) gives the name of the in file for the de-concatenation utility and corresponds to WFNAME of the CFTRECV command

o The 6th parameter (%6) designates all the out files to concatenate and corresponds to the NFNAME of the CFTRECV command

The other batch call parameters are unused, and therefore insignificant.

Parameter setting

To implement the transfer of a group of files in standardized mode, the conditions on the Transfer CFT parameters are as follows:

l The parameter FNAME in the CFTSEND command is in the form of #<string>, in which <string> indicates a folder or contains meta-characters

l The parameter WFNAME of the CFTSEND command is a string indicating the name of the out file for the concatenator on the transmitter

l The parameter WFNAME of the CFTRECV command is a string indicating the name of the IN file for the DE-concatenator on the receiverThis name does not need to be the same as that of WFNAME of the CFTSEND on the transmitter


8 Operations

l The parameter FNAME of the CFTRECV command indicates the full path of a folder name ending with the ‘/’ character

Example

CFTSEND.FNAME = #FIC*.*,WFNAME = &idtu.snd,.

CFTRECV.FNAME = E:\CFTN.301\RECEPT\,WFNAME = &idtu.rcv,.

Note WFNAME must contain an extension (& idtu.rcv in this example) otherwise the ZIP or UNZIP utilities add .zip to the file name. Certain operations in CFTSVG01.bat CFTRST01.BAT cannot be performed then, and return the message "unknown or empty file".

To use the above function between two different but standardized operating systems (such as Windows 7 for transmission and Windows Server for reception), check that the tool (or tool pair) can be used in your operating system. In the example above, the de-concatenation on Windows Server knows how to correctly restore on the Windows Server all of the files concatenated in Windows 7.

However there is a problem when the two Transfer CFT partners are standardized and you simply want to have recourse to the functions associated with transferring groups of files in mixed mode.

Disabling the homogeneous modeUse the unified configuration parameter uconf:cft.server.force_heterogeneous_mode to enable forced heterogeneous mode exchanges, and disable homogeneous mode.

Automated functionsThis topic describes how to use a batch procedure in Transfer CFT Windows.

l About automated CFT functions

l Updating batch procedures launched by Transfer CFT

l Using symbolic variables in batch files started by Transfer CFT


8 Operations

About automated Transfer CFT functions

Batch procedures started by Transfer CFTAfter a certain number of Transfer CFT events, such as transmissions, receptions, SWITCH commands, for example, Transfer CFT can automatically start batch procedures. These are defined in the parameters.

When these batch files are started, Transfer CFT generates a temporary batch file name into which it copies the content of the initial batch file, having resolved the symbolic variables which may have been invoked. Once executed, by default, Transfer CFT deletes these temporary batch files.

Non-deletion of temporary batch files after executionEnvironment variable

CFTNODEL

The CFTNODEL environment variable is able to stop Transfer CFT from definitively deleting the temporary file, it is usually deleted after it has been submitted and executed.

Updating batch procedures launched by Transfer CFTWhen automatic procedures are started, Transfer CFT performs the following operations:

l Reads the batch file concerned

l Specifies and creates a unique name for the temporary file

The unique name for the temporary file is specified by specifying a prefix in the form of CFTnnnnn, where nnnnn is a number between 0 and 99999. Each time a prefix is generated, the number nnnnn is incremented by 1. The following processes occur:

l Content of the batch file in which the symbolic variables have been resolved is written into this temporary file

l Temporary file executes

l Temporary file is deleted

If you have trouble using the batch procedures:

1. Start the batch file to be implemented manually and watch the effect this produces.

2. To observe the effect of the substitutions by Transfer CFT of the symbolic variables, use the CFTNODEL environment variable.

Using symbolic variables in batch files started by Transfer CFTDo not set an operating system variable directly into a batch file started by Transfer CFT.


8 Operations

If you do not take special precautions, there is a risk that a temporary file will be generated to Transfer CFT, where it provokes an illegal operation when submitted to the operating system. Such submission can be automatic or manual, it is still an illegal operation.

You can still use environment variables, provided that they are set in a different batch file to that started by Transfer CFT. The batch file started by Transfer CFT calls the batch file containing the environment variable settings.

Example

/* BATCH started by CFT */call pos_envCFTUTIL SEND PART = &part, IDF = %IDF%...

/* BATCH pos_env called by the batch file started by CFT */SET IDF=TEST...

Trace functions in CFT WindowsThis topic introduces trace functions in Transfer CFT Windows. Trace functions are processes that concern the system and network sections of Transfer CFT. These functions do not concern the application traces implemented in common by all the existing Transfer CFT products and described in the Trace function topics.

Automatic incident tracingTransfer CFT automatically generates a trace when it detects a system or network error that is fatal to its operation. Some of these traces are informational. These traces are specific to the Transfer CFT/Windows products.

Depending on the origin of the problem it has detected, these traces are recorded in one of the following files:

Name of the Trace file Source of the problem

CFTSYSP.TRC Intermediate system section

CFTSYSS.TRC Specific Windows system section

CFTNET.TRC Network section

TCPCLI.TRC and TCPSRV.TRC TCP/IP network section

By default Transfer CFT automatically generates these trace files in the folder:runtime\run folder

You can use UCONF to change the folder. For example:

CFTUTIL uconfset id=copilot.trace.trcfilename,value=c:\trc\copilot.trc


8 Operations

Only Axway Technical Support is able to interpret these traces. In a certain cases, Axway Technical Support may request users to send the content of these files.

The maximum size and the location of these specific trace files can be defined.

Defining the size of specific trace files


CFTTRCSIZE

CFTTRCSIZE defines the maximum size of each of the trace files in megabytes.If this value is set to 0, no trace file will be generated. If the environment variable has not been defined, the maximum size of these files is 100 Mb. Once the maximum file size has been reached, Transfer CFT/Windows saves the file as *b.trc and sets the file to 0.

Defining the location of specific trace files


CFTTRCPATH

CFTTRCPATH indicates the Transfer CFT/Windows the name of the folder where trace files discussed in this section are generated.

For more information, read the section Specific Network Functions

Network tracesRefer to Specific Network Functions.

Setting protocol parameters

Setting up the TCP/IP layer Before starting Transfer CFT with TCP/IP for the first time, you must setup your TCP/IP.

Procedure

1. Install and configure the TCP/IP layer.

2. In the SAMPLE folder, configure the PARMTCP.SMP sample file, with the key parameter in CFTPARM.

3. In the SAMPLE folder, configure the sample file PARMTCP.SMP. Configure the nspart and nrpart parameters in CFTPARM, and the host parameter of the CFTTCP command.

4. Start the batch file ..\CFT\SAMPLE\RESETTCP.

5. Start CFTMAIN.

6. Check that CFTMAIN started correctly.


8 Operations

7. From a command prompt on a different Windows, and in the Transfer CFT root folder, enter the command: > CFTUTIL SEND PART=PART1, IDF=TEST

Defining TCP/IP parameters This topic describes the parameter settings for Transfer CFT when using TCP/IP.

Specific parameter settings for TCP/IP

Modifying the connection wait timeout periodEnvironment variable

CFTCONTCP

This timeout period corresponds to a period for Transfer CFT to wait for a communication to be established. The default timeout period is 120 seconds.

To change this value, set the CFTCONTCP environment variable to the desired value in seconds.

Example

For a period of 20 seconds:

SET CFTCONTCP=20

Parameter settings for the initialization phaseTransfer CFT uses TCP/IP for data transfers with defined remote partners. It also uses this layer for its own internal exchanges. More particularly for exchanges between the cfttpro.exe and cftn_005.exe processes.

Certain configurations on the TCP/IP network are incompatible with the default options set for Transfer CFT internal exchanges. These configurations are generally associated with the use of the DNS and DHCP services. To remedy these difficulties, Transfer CFT’s TCP/IP layer can be parameterized using the method below:

Define the "TCP LOCALHOSTTYPE" parameter in the cftnet.cfg file.

This parameter can take on the following values:

l LOCALNAME

The HOSTS file or the DNS service is used to obtain the machine’s IP address. The HOSTS file (the DNS service) must contain the IP address that corresponds to the name of the machine.Default value:

l LOCALHOST


8 Operations

The standard name "localhost" is used. It is sometimes necessary for the HOSTS file to contain the IP address of the standard localhost name. In general the value of this IP address is 127.0.0.1.

l IPADDRESS

IP address of the local machine, obtained directly. This is stated in the LOCALHOSTADDR. Parameter.

If "TCP LOCALHOSTTYPE" is the IPADDRESS, the "TCP LOCALHOSTADDR" parameter can be defined. It must be the same as the machine’s IP address. Its default value is 127.0.0.1 (the standard IP address of the machine).

Note: These parameters are independent of the value of the HOST field in the CFTNET command. They are used for internal communication between Transfer CFT processes when the CFTNET command defines the characteristics of the local resource used for data exchange with remote partners.

Transfer CFT with RAS example

To use Transfer CFT with RAS, the IP address may be dynamic (DHCP server) without a predefined host name. You would therefore use the machine’s standard IP address of 127.0.0.1To do this, define the two following lines in the cftnet.cfg file:

TCP LOCALHOSTTYPE=IPADDRESSTCP LOCALHOSTADDR=127.0.0.1

Using the TCP/IP via the RAS layerYou can set the Transfer CFT Windows TCP/IP layer parameters to use the Windows RAS service. This service allows access to a remote TCP/IP via a modem using a PSTN line, Public Switched Telephone Network.

These services are always proposed when the two systems are installed. The system and network administrators for the machine on which Transfer CFT is installed are responsible for configuring these services.

Before attempting to use Transfer CFT via TCP/IP on RAS, the machine using RAS must integrate with the remote TCP/IP network. This integration is tested once the RAS connection has been made. The remote hosts specified for Transfer CFT can be reached by the standard utilities of the TCP/IP layer - PING, TELNET, and so on.

Transfer CFT’s management of the RAS layer is performed using the Microsoft API, the dynamic library rasapi32.dll. When a Transfer CFT partner is configured to utilize a RAS directory entry, it manages the RAS connection and disconnection dynamically. The disctd parameter in the CFTPROT command states the wait time before the RAS disconnects in the absence of another request to transfer.

Syntax of the CFTTCP HOST parameter:

HOST=PPPxx@host

Where:


8 Operations

l PPPxx: is the name of the section in the cftras.ini file (xx between 00 and 99 inclusive)

l host: corresponds either to the name of the remote host, or the IP address of theremote partner

The description of the RAS connections used by Transfer CFT is located in the cftras.ini file, in the Transfer CFT runtime\conf folder. This file has a standard *.INI file structure.

Structure of the cftras.ini file

Each section has the format:

l [PPPxx] : the name of the section (xx between 00 and 99 inclusive)

l linkentry=LINK1 : the entry defined in the Windows RAS directory

l phoneno=1234567890 : the telephone number of the RAS server

l server=server : the NT server on which the user is identified

l username=user : the name of the user connecting to the RAS server

l password=password : the password of the user connecting to the RAS server

Note

l The link entry field, as defined in the RAS directory, is mandatory.

l All the other fields in a section are optional. Their default values are as defined in the RAS directory entry. If necessary, these optional parameters can replace the parameters defined in the RAS directory entry.

SecurityIf a machine possesses several IP addresses, it can receive incoming calls only on the IP address given in the HOST field of the CFTNET command.

To receive incoming calls without taking account of the machine’s IP address, you need to set the value INADDR_ANY in the HOST field of the CFTNET command.

Flow performanceTo maximize the transfer flow performance in a CFT environment, you can modify the TCP Windows variable in the Windows registry database. Access the cftnet.cfg file and modify the variable: TCP TCPWINDOWSIZE. There is no minimum or maximum value. You must run Transfer CFT to test the new variable performance.

ExampleDefine the following line in the cftnet.cfg file:

TCP TCPWINDOWSIZE=64240


8 Operations

About Windows Application Programming Interfaces (API)

This section describes the application build features of the Transfer CFT Windows Application Programming Interfaces, and introduces concepts including:

l Product tool kit

l Before developing your first CFT API application

l Design constraints

l Coding constraints

l Compilation constraints

l Linking constraints

l Execution constraints

After installation, the runtime\src directory contains the API sources developed in C, Visual Basic, or DELPHI (capi, delphi, vb subfolders).

Product toolkitThe product comes with a tool kit that enables you to develop an application using the Transfer CFT programming interfaces, Transfer CFT API applications.

Transfer CFT API applications examples are written in C: Microsoft Visual C++ 4.1, Delphi 2 or Visual Basic 5.0.

Before developing your first Transfer CFT API applicationBefore beginning to write Transfer CFT API applications, you should:

1. Read this topic and the topics in Using APIs,.

2. Familiarize yourself with the sample source files.

l C: ..\CFT\API\C\SRC\APISAMPL.C

l Delphi: ..\CFT\API\DELPHI\SAMPLE\CFTAPIDP.DPR

l Visual Basic: ..\CFT\API\VBASIC\SAMPLE\CFTAPIVB.VBP

3. Copy APISAMPL, CFTAPIDP or CFTAPIVB in the Transfer CFT folder.

4. Start APISAMPL, CFTAPIDP or CFTAPIVB.

5. Rebuild the sample programs from the APISAMPL.C sources and other files (libraries and definition files) provided.

6. Run the resulting .EXE to test the executables in the sample that you have created.

For issued commands to be interpreted correctly by Transfer CFT, you must:


8 Operations

1. Define a CFTPART with an id of PART1.

2. Define a CFTSEND with an id of TEST and fname called TEST.

3. Set up a file called TEST in the CFT\SEND directory.

4. Start Transfer CFT.

5. Change Windows NT console sessions.

Constraints

Design The Transfer CFT API functions, which can be called from an application, are not re-entrant. This means that all Transfer CFT API function calls made by an application must be made in the same thread.

Coding A Transfer CFT API application must comply with two requirements:

l When the application starts, but before a Transfer CFT API is called, the Transfer CFT API initialization function must be called in:

l Visual Basic: Cft_Api_Open (ByVal Version As String) As Integer

l C++ or Delphi: CftInitialize of prototype BOOL CftInitialize (void)

l When the application terminates, it must inform Transfer CFT that it is stopping by calling the CftUninitialize function with the following prototype: BOOL CftUninitialize ( void )

If they are successful, both functions return TRUE.

Compilation The apicft.lib dynamic library and APISAMPL.C sample are compiled with the following options:

l Standard mandatory C option:

l Zp1 /* Structures and structure fields aligned on byte boundaries */

l Options specific to WIN32:

l D_X86=1 /* Machine code generation for Intel x 86 processors */

l DWIN32 /* Win 32 application */

l D_MT /* Multi-thread application */

l G3 /* Machine code generation compatible with 386 processors and compatibles */


8 Operations

Linking

Key OptionsLink-editing for a Transfer CFT API application can use all the default options.

Key LibrariesIn addition to any application libraries, the key libraries required to build a Transfer CFT API application are as follows:

l APICFT.LIB

l CFTSCP3.LIB

Execution To execute an application using Transfer CFT, APIs need the following files:

l Necessary dynamic libraries:

o apicft.dll

o cftscp3.dll

l Additional dynamic libraries for Visual Basic:

o cftvb.dll

l Other files:

o profile

These files must be installed with the application executables in C or DELPHI on the Windows workstation, so that the application developed with the Transfer CFT APIs can run correctly.

A Visual Basic program requires an additional DLL to encapsulate calls to the Transfer CFT APIs [cftvb.dll].

About Windows Application Programming Interfaces (API)This section describes the application build features of the Transfer CFT Windows Application Programming Interfaces, and introduces concepts including:

l Product tool kit

l Before developing your first CFT API application

l Design constraints

l Coding constraints


8 Operations

l Compilation constraints

l Linking constraints

l Execution constraints

After installation, the runtime\src directory contains the API sources developed in C, Visual Basic, or DELPHI (capi, delphi, vb subfolders).

Product toolkitThe product comes with a tool kit that enables you to develop an application using the Transfer CFT programming interfaces, Transfer CFT API applications.

Transfer CFT API applications examples are written in C: Microsoft Visual C++ 4.1, Delphi 2 or Visual Basic 5.0.

Before developing your first Transfer CFT API applicationBefore beginning to write Transfer CFT API applications, you should:

1. Read this topic and the topics in Using APIs,.

2. Familiarize yourself with the sample source files.

l C: ..\CFT\API\C\SRC\APISAMPL.C

l Delphi: ..\CFT\API\DELPHI\SAMPLE\CFTAPIDP.DPR

l Visual Basic: ..\CFT\API\VBASIC\SAMPLE\CFTAPIVB.VBP

3. Copy APISAMPL, CFTAPIDP or CFTAPIVB in the Transfer CFT folder.

4. Start APISAMPL, CFTAPIDP or CFTAPIVB.

5. Rebuild the sample programs from the APISAMPL.C sources and other files (libraries and definition files) provided.

6. Run the resulting .EXE to test the executables in the sample that you have created.

For issued commands to be interpreted correctly by Transfer CFT, you must:

1. Define a CFTPART with an id of PART1.

2. Define a CFTSEND with an id of TEST and fname called TEST.

3. Set up a file called TEST in the CFT\SEND directory.

4. Start Transfer CFT.

5. Change Windows NT console sessions.


8 Operations

Constraints

Design The Transfer CFT API functions, which can be called from an application, are not re-entrant. This means that all Transfer CFT API function calls made by an application must be made in the same thread.

Coding A Transfer CFT API application must comply with two requirements:

l When the application starts, but before a Transfer CFT API is called, the Transfer CFT API initialization function must be called in:

l Visual Basic: Cft_Api_Open (ByVal Version As String) As Integer

l C++ or Delphi: CftInitialize of prototype BOOL CftInitialize (void)

l When the application terminates, it must inform Transfer CFT that it is stopping by calling the CftUninitialize function with the following prototype: BOOL CftUninitialize ( void )

If they are successful, both functions return TRUE.

Compilation The apicft.lib dynamic library and APISAMPL.C sample are compiled with the following options:

l Standard mandatory C option:

l Zp1 /* Structures and structure fields aligned on byte boundaries */

l Options specific to WIN32:

l D_X86=1 /* Machine code generation for Intel x 86 processors */

l DWIN32 /* Win 32 application */

l D_MT /* Multi-thread application */

l G3 /* Machine code generation compatible with 386 processors and compatibles */

Linking

Key Options

Link-editing for a Transfer CFT API application can use all the default options.

Key Libraries

In addition to any application libraries, the key libraries required to build a Transfer CFT API application are as follows:


8 Operations

l APICFT.LIB

l CFTSCP3.LIB

Execution To execute an application using Transfer CFT, APIs need the following files:

l Necessary dynamic libraries:

o apicft.dll

o cftscp3.dll

l Additional dynamic libraries for Visual Basic:

o cftvb.dll

l Other files:

o profile

These files must be installed with the application executables in C or DELPHI on the Windows workstation, so that the application developed with the Transfer CFT APIs can run correctly.

A Visual Basic program requires an additional DLL to encapsulate calls to the Transfer CFT APIs [cftvb.dll].

Building API in Visual BasicThe Transfer CFT API toolkit contains a dynamic library, which enables users to develop a Transfer CFT API application, that was itself developed in Visual Basic. This library and the sample supplied have been validated for Visual Basic version 4.0 and higher.

The Transfer CFT APIs enable you to implement the facilities described in About API.

l Cftai: catalog consultation

l Cftau: transfer commands with syntactical analysis

l Cftac: transfer commands without syntactical analysis

The Transfer CFT API Visual Basic call structures and return codes are the same as for the equivalent functions for the Transfer CFT API functions in C. For more information, refer to Using Transfer CFT services in C.

Visual Basic toolkitTransfer CFT Windows provides:

l a sample of a Visual Basic program

l a dynamic library cftvb.dll to allow interfacing between Transfer CFT/Windows XXX with a Visual Basic application

l a file cftapivb.bas containing the statements necessary to use the cftvb.dll dynamic library

The cftvb.dll dynamic library:


8 Operations

l must be visible to all Visual Basic applications using the Transfer CFT APIs

l itself uses the dynamic library apicft.dll (programming interface in C) supplied with Transfer CFT/Windows, and must therefore be visible to that

l exports the functions set out below

The source Visual Basic file cftapivb.bas:

l contains the statements of structure and of functions required to use the Transfer CFT APIs in a Visual Basic program

l must be incorporated into all projects using the Visual Basic Transfer CFT APIs

Available Visual Basic functions

Initializing and closing a Transfer CFT API application in Visual BasicCft_Api_Open (ByVal Version As String) As Integer

API initialization.

This function must be called before any other Transfer CFT API function.

The parameter is the constant CFT_API_Version as defined in cftapivb.bas.

The return code is 0 if the APIs have correctly initialized.

Cft_Api_Close () As Integer

API close.

This function must be the last Transfer CFT API function called before the application closes.

The return code is 0 if the APIs have correctly closed.

Interrogating the catalogue in Visual BasicCft_Cat_Open (ByVal Catalog As String) As Integer

To open the catalog.

The parameter is the name of the catalog file.

The return code is 0 if the catalog is opened. If it does not, see the cftai function (OPEN).

Cft_Clear_Sel (CftSel As CftSelT) As Integer

Initializes a CftSelT structure by filling this structure with binary zeros.

This function must be called before defining the selection criteria to call the Cft_Cat_Select function.

The parameter is the CftSelT structure that requires cleaning.

The return code is 0.


8 Operations

Cft_Cat_Select (CftSel As CftSelT) As Integer

Selection of records within the open catalog.

The parameter is a correctly filled CftSelT structure (see the Cft_Clear_Cat function).

The return code is 0 if everything is correct. If not, refer to the cftai C function (SELECT).

Cft_Clear_Cat (CftCat As CftCatT) As Integer

Initializes a CftCatT structure by filling this structure with binary zeros.

This function must be called after every call to Cft_Cat_Next.

The parameter is the CftCat structure that will be used to call Cft_Cat_Next.

The return code is 0.

Cft_Cat_Next (CftCat As CftCatT) As Integer

To read a selected record in the catalogue.

The parameter is an empty CftSelT structure (see the Cft_Clear_Cat function).

The return code is 0 if a record has been raised. If it is not, see the cftai C function (NEXT).

Cft_Cat_Modify (ByVal CatState As String) As Integer

To modify the status of the last record read in the catalogue.

The parameter is a character designating the new status.

The return code is 0 if the status of the record has been modified, otherwise see the cftai C function (MODIFY).

Cft_Cat_Close () As Integer

To close the catalogue.

The return code is 0 if the catalog has closed. If not, refer to the cftai C function ("CLOSE").

Transfer commands in Visual BasicCft_Cmd_Analyse (ByVal Cmd As String, ByVal Parameter As String) As Integer

To send a Cft command with syntactical analysis.

For parameters and return codes (see the cftau function).

Cft_Cmd (ByVal Cmd As String, ByVal Parameter As String) As Integer

To send a Cft command without syntactical analysis.

For parameters and return codes (see the cftac function).


8 Operations

Building an API in CThis section explains how to build Transfer CFT API samples in C. You can also refer to the Transfer CFT User Guide Using APIs topics for information such as links to sample files.

The API samples and the makefile used to build them are located in your Transfer CFT <installdir>\runtime\src\capi directory.

PrerequisitesThe following steps require that you have Microsoft Visual Studio (VS) and a compiler, such as Visual C++, installed on your computer.

Procedure 1. From the Windows Start menu, select All programs > Axway software > [Transfer CFT

name] > Transfer CFT > Command Prompt. This opens a command window, which executes profile.bat.

2. In the same command window, initialize the VS environment by executing the appropriate vcvarsall.bat based on your system architecture.

l Windows 32 bits: <ProgramFiles>\<VS directory>\VC\vcvarsall.bat x86

l Windows 64 bits: <ProgramFiles>\<VS directory>\VC\vcvarsall.bat amd64

l Windows Itanium: <ProgramFiles>\<VS directory>\VC\vcvarsall.bat ia64

3. To set the CPU environment variable enter the following command based on your Transfer CFT architecture.

l Windows 32 bits: set CPU=X86

l Windows 64 bits: set CPU=AMD64

l Windows Itanium: set CPU=IA64

4. Go to the directory containing the C source files and makefile:

cd %CFTDIRINSTALL%\runtime\src\capi

5. Enter the command:

nmake /f capi.mak


8 Operations

ResultsThe nmake command generates the following as either 32-bit or 64-bit executable programs, depending on the Transfer CFT architecture. The current directory contains the generated object files and executable programs:

l api2xmp1.exe

l api2xmp2.exe

l apisampl.exe

l tcftsyn.exe

l utisyn.exe

Note The capi.makfile contains a variable called LIB_BUFFEROVERFLOWU whose value may be set to bufferoverflowU.lib, or left empty depending on the compiler version. You may have to manually change this variable if it is incompatible with your compiler. Normally this variable is empty in 64-bit environments.

Remove generated filesTo remove all of the generated .obj and .exe files, enter the command:

nmake /f capi.mak clean

Developing exitsThis topic describes using exits in Transfer CFT Windows. Every Transfer CFT is supplied with a toolkit that enables you to develop your own EXITs in C. This topic provides additional information for developing exits.

The following source examples are supplied in the toolkit:

l File exit

l Directory EXIT

Development environment compilersYou should develop the exits under the Windows operating system, using Microsoft Visual Studio 2003.

Before you begin developing exits

You are strongly advised to do the following before starting the development work itself:


8 Operations

1. Read the general section relating to the developing exits.

2. Read this section.

3. Familiarize yourself with the sample sources in runtime\src\exit.

4. Reconstruct the executable in the sample from the C source and the other files supplied: libraries, definition files, make files.

5. Test the exit of the sample you want to construct.

Functions associated with exitsThis section provides information for implementing exits that have already been developed and supplied with the product, or that are developed specifically by and for a particular user. See Using exits.

This section describes:

l The different types of exits:

l File exits

l Exit list

l Directory exits

l How to proceed when developing an exit

l How to define Transfer CFT parameters so that it will take account of the different types of exits

The Transfer CFT Exit list guide provides a description of a special EXIT file that is already developed and supplied with Transfer CFT.

Dynamic identification exit upon connectionThe aim of the directory type EXIT is to enable the Transfer CFT user to enter dynamically a user name and/or a password at the connection stage, before transmission in request mode.

The prefix for the executable corresponding to this EXIT is CFTEXPWD and it must contain data for the PROG parameter of the CFTEXIT command in the Transfer CFT parameterization.

The way the EXIT functions depends on the NSPART and NSPASSW parameters in the CFTPART command:

l If these parameters contain any text strings, these strings will be used when the connection is made.

l If these parameters contain the string of "*" (excluding the quotation marks), NSPART and NSPASSW are entered from a dialog box when the first connection is made to the partner.

l If these parameters contain the string of "**" (excluding the quotation marks), NSPART and NSPASSW are entered from a dialog box every time a connection is made to the partner.

l NSPART and NSPASSW may contain different strings; so if NSPART is entered and NSPASSW = **, then only the password will be requested each time a connection is made to the partner.

Example


8 Operations

CFTPART ID=PART1NSPART=*NSPASSW = **

In this example, Transfer CFT will request the NSPART to be entered when the connection is made for the first time, and for the password NSPASSW to be entered every time a connection is made.

Exit listThe Transfer CFT EXIT list is an exit that enables remote partners to consult the Transfer CFT catalog on the central site or on a server. The Exit list guide describes the functions provided by the Exit list and gives the indications required to implement them.

Transfer CFT Windows supplies the exit list in the form of an executable cftexl.exe (loaded into memory when the consultation takes place), accompanied by a sample file containing the selection criteria, exitlist.txt, which allows the data to be output by the Exit list to be selected from the central site (or from the server). To use the exit list you also need a definition file CFTNMLOG (see the section Logical File Names, the paragraph Using a definition file). This is supplied as a sample and can be used only on condition that the file name for the selection criteria is exitlist.txt.

Exit example

Exit-list : on server

cftexit id = exitl,

reserv = 8192,

prog = cftexl,

language = c,

mode = replace

cftsend id = texit,

impl = yes,

exit = exitl,

mode = replace

Exit-list remote partner side

cftrecv id = texit,

fname = '&idt.rcv',

fcode = binary,

frecfm = f,

faction = delete,

ftype = b,

mode = replace


8 Operations


Documents

Transfer CFT Installation Guide Windows - docs.axway.com · Windows x86 operating system prerequisite 18 Install Transfer CFT 19 Start the installation 19 Cluster mode screens 24