Transfer CFT Installation Guide IBM i - Axway Documentation ...

Transfer CFTVersion 3.77 December 2021

Installation and Operation Guide

Copyright © Axway Inc. 2020

All rights reserved.

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. Axway may change this publication, the product(s) 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.

Contents

Preface viAbout Transfer CFT viInstallation guide outline viAbout IBM i nomenclature viiWho should read this guide viiTransfer CFT documentation set viiSupport services vii

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

1 Prerequisites 3Hardware prerequisites 3Disk space 3

Software environment 3Java 4End User License Agreement 4Default ports 5Apply a license key 6Key management 6

Certificates 8Delivered certificates 8Create a PEM certificate for IBM i 8Upload certificates to iSeries 8

TCP/IP requirements 10Interface level used 10Execution environment 10Network environment 10Precautions 11

Create users and set security rights 12Create an additional user 12Create an APP1 user 13Grant the APP1 user permissions 13Manage user rights 14Update the APP1 profile to use Transfer CFT instance 14Grant the APP1 user Central Governance rights 14

Transfer CFT IBM i 3.7 Installation Guide i

2 Installation 17Before you start 17Installation and upload overview 17About the installed environment 18Transfer CFT libraries 18Transfer CFT specific objects and subsystems 18

Upload and restore the installation files 19About the INSTALL command 20Executing the INSTALL command 21

Silent installation 22Register with Central Governance 22

Use an independent ASP (optionally) 24About independent ASPs (IASP) 24IASP command 24Use an IASP in a Transfer CFT environment 24

Enable system user control (USERCTRL) 25Manually enable Central Governance 26Prerequisites 26Procedure 26

Manually enable Sentinel 27Sentinel configuration parameters 27About Transfer CFT heartbeat functionality 29

Transfer CFT IBM i utilities 31Using the Menu bar 32Using CFTUTIL Transfer CFT IBM i specific commands 33

3 Post-installation 35Transfer CFT in production 35Transfer CFT menu usage 35Create Transfer CFT system object 35Verify your installation 36Installed directories 36

Register with Central Governance 36Manage commands 37Standard commands 37Deprecated commands 37

Start and stop Copilot 39Start the Copilot server 39Stop the Copilot server 39Configure the Copilot server 39

Manage Transfer CFT using IFS 40How to use programs without menus 40Operating Transfer CFT 42Transfer CFT 3.2.x and higher 43

Transfer CFT IBM i 3.7 Installation Guide ii

Using the common Transfer CFT commands 43Submit CFTUTIL commands 45About transport security and PKIUTIL commands 46Using the PKIUTIL utility 47Interpreting source members 49Running Transfer CFT 50Starting Transfer CFT 51Shutting down Transfer CFT 54Configuring Transfer CFT parameters 54Exits in Transfer CFT Iseries 57

Viewing transfer messages 58Example 58

Performance optimization 60Prerequisites 61Procedure 61How to determine the Max Act values 61

Starting Transfer CFT in batch mode 62

4 Working with files and encoding 63Using native file types 63Configure send mode (native) 64Configure receive mode (native) 66Backup files 68

Using IFS hierachial files 69IFS overview 69Configure send mode on IFS 71Configure receive mode for files (IFS) 73

Conversion tables 74Using conversion tables 74Configuration sample 75Extended character set mapping 76

5 Create an Express Package 77Create a deployment package for Transfer CFTs used with Central Governance 77Create a Transfer CFT deployment package for standalone usage 78Procedure 79

Limitations 80

6 Update, upgrade, or migrate 81About updates 81About upgrades 81About migrations 81About manual migrations 82Prerequisites 82

Transfer CFT IBM i 3.7 Installation Guide iii

Important information before performing an upgrade or migration procedure 82About license keys 82

Prior to upgrading with a service pack 83Register with Central Governance 83Apply a service pack or patch 84Display information 84Update with a service pack 84Apply a patch 85

Uninstall a service pack or patch 86Uninstall a service pack 86Uninstall a patch 87

Upgrade Transfer CFT IBM i 87Before you start 87Automatic upgrade procedure 88Manual upgrade procedure 90

93Roll back an upgrade 93Before you start 94Automatically roll back 94Roll back to a version that predates the UPGRADE command 96Manually roll back 96

7 Uninstall Transfer CFT 99

8 Troubleshooting 101Using the support tool 101Using the CFTSUPPORT command 102Tracking Transfer CFT IBM i activities 103IFS access error codes: DIAGP 105Determine or change the CCSID 106

A About APIs 109About Transfer CFT services 109Catalog querying services 110Transfer services 112Synchronous communication services 114Description of functions 114

About Web services 115License key 115About the WSDL file 115General restrictions 116WS-I recommendations 116Limit the number of failed login attempts 117

Transfer CFT JPI 118

Transfer CFT IBM i 3.7 Installation Guide iv

Transfer CFT JPI 119About Transfer CFT services in C 120Call syntax 120About Transfer CFT services in C 121About cftapi2 122Transfer CFT catalog query services 129Synchronous communication services 135Transfer services in C 138

About Transfer CFT services in COBOL 142Call syntax 142Return codes 142About Transfer CFT services in COBOL 143Transfer CFT catalog query services 144Synchronous communication services 149Transfer services in COBOL 152

B Appendix B: Menu mapping 155Transfer CFT 2.7.1 155Transfer CFT 3.0.1 156Transfer CFT 3.1.3 SP4 157Transfer CFT 3.2.x and higher 158

Transfer CFT IBM i 3.7 Installation Guide v

Preface

Preface

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

About Transfer CFTTransfer CFT is the file transfer component in the Axway Managed File Transfer solution, 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.x 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.7. As part of this process, the existing configuration may need to be modified or updated to be compatible with the new version. For example, you may need to modify configuration files or the internal datafile schema. Because migration can be a complex process, organizations typically set up a migration project to study the new features and determine the impact on the existing configuration, and to plan for the changes across the various environments.

Uninstall – Describes how you can uninstall Transfer CFT.

Transfer CFT IBM i 3.7 Installation Guide vi

https://www.axway.com/en

Preface

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

About IBM i nomenclature This document may contain references to iSeries or OS/400 both of which refer to the same IBM i platform.

Who should read this guideThis guide is intended for enterprise personnel involved in installing software and Axway Professional Services personnel. Familiarity with AMPLIFY 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.7 Release Notes

l Transfer CFT 3.7 User Guide (HTML)

l AMPLIFY Supported Platforms Guide

Support servicesThe Axway Global Support team provides worldwide 24 x 7 support, subject to validation of your license agreement. Email [email protected] or, for your local support telephone number, visit support.axway.com and click Contact Axway Support.

Transfer CFT IBM i 3.7 Installation Guide vii

mailto:[email protected]

https://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.

Transfer CFT IBM i 3.7 Installation Guide 1

Accessibility

2 Installation Guide Transfer CFT IBM i 3.7

1 Prerequisites

This section describes the prerequisites for Transfer CFT 3.7 IBM i and covers:

l Hardware environment

l Software environment

Hardware prerequisitesTransfer CFT 3.7 IBM i can only be installed on an system based on the RISC architecture.

Disk spaceFor performance reasons, you are advised to configure a storage pool size of at least 250,000 Kbytes (245 MB). See .

You must ensure that the:

l Disk space used to restore the Transfer CFT objects is approximately 250 MB, excluding files to be transferred.

l Total disk space used on the system still allows acceptable performance levels to be maintained (< 80%).

Software environmentThis section describes the Transfer CFT 3.7 IBM i software environment:

l Transfer CFT IBM i 3.7 supports V7R2 (7.2) and higher.

l The file management mechanism uses the standard OS database management system and IFS (Integrated File System). The Transfer CFT IBM i Manager uses the PDM (Program Development manager) and SEU (Source Entry Utility).

l The Transfer CFT IBM i Manager uses the UIM (User Interface Manager) V7R2 and higher.

l The Transfer CFT APIs only support an ILE environment.


1 Prerequisites

JavaWhen using Secure Relay, you require Java to be installed in the same environment as the Transfer CFT installation. The Master Agent is managed, but the Router Agent can be in another environment.

Check your Java version, Secure Relay requires Java JRE 8.

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.


Default ports

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.

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

SFTP 1763

COMS 1765

Copilot 1766

Copilot for Central Governance 1767

REST API 1768

Central Governance 12553

Central Governance SSL 12554

Secure Relay MAma.comm_port

6801

Secure Relay RA

l ra.comm_port

l ra.admin_port

l 6811

l 6810

Legend:

l PeSIT (PESITANY protocol): PeSIT in plain text

l SSL: PeSIT protocol over SSL/TLS

l COMS: Synchronous transfers

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

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

l Central Governance: Used to connect to Central Governance


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

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

l You perform an initial Transfer CFT installation.

l A hardware upgrade changes the CPU ID (CPU serial number).

l After a year passes, to replace an expired license key.

l To ramp up a Transfer CFT Disaster Recovery instance (for example, on a DR LPAR for z/OS systems).

l If you are migrating from a version 2.x Transfer CFT to a version 3.x.

Key management

Obtain a license key 1. For a new installation, install Transfer CFT.

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

3. Contact the Axway Fulfillment team at the appropriate email address to obtain a valid key.

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

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

4. Provide the hostname where Transfer CFT is to be installed or updated.

5. Provide the list of characters in the CPU ID.

Apply a license keyApply the license key(s) that you received from the Axway Fulfillment team as follows:

l Navigate to the CFTPROD library, and edit the 'KEY' file.

l Edit the CFTPROD/KEY(KEY) member by entering (writing in) your key.

Examples

Use the CFTUTIL utility to execute the ABOUT command to find the CPU ID.

CFTUTIL PARAM(ABOUT)

Host information :

* model = 525 *

cpuid = 10A16B2

In this example, you would provide the CPU ID 10A16B2.


Apply a license key

Use the display system value command to get the serial number, known as QSRLNBR:

DSPSYSVAL SYSVAL(QSRLNBR)

System value . . . . . : QSRLNBR

Description . . . . . : System serial number

Serial number . . . . : 06890AP

In this example, you would provide the CPU ID 06890AP.

Note Your values will differ from those shown in the examples.


1 Prerequisites

Certificates

Delivered certificatesThe use of the default certificate supplied with Transfer CFT is strongly discouraged in a production environment. You should use your own certificates to enhance security.

Caution You must store certificates on the native side of the machine. Certificates located on the IFS partition are not supported.

Create a PEM certificate for IBM iFor a PEM certificate, you must create a file with a record length equal to the size of the certificate in bytes. You can then upload the certificate to the newly created file.

Example

In this example, assume that your certificate 2k_l1_user1_key.pem size is 1,191 bytes. Before uploading this certificate to the IBM i server, you would need to create a file with a record length of 1,191 bytes, as follows:

CRTPF FILE(YOURLIB/PEM_CERT) RCDLEN(1191)

You can use FTP, for example, to then upload 2k_l1_user1_key.pem to YOURLIB/PEM_CERT.

l You must transfer PEM certificates in ASCII mode

l All other certificates can be transferred in binary mode

Upload certificates to iSeriesYou can use 3 type of certificates with Transfer CFT IBM i - PEM, DER, and P12, which must be stored on the native partition. Before you upload a certificate though, you need to know if it is binary or text, as the process differs depending on the format. For example, PEM certificates are in text, while the p12 certificates are in binary format.

Using PEM (ASCII) certificates and keysTo use an ASCII certificate with Transfer CFT, perform the steps in this section.

On the Unix/Windows machine:

1. Use a text editor, such as Notepad, to open the certificate and modify it so that is has only one line, and save.


Certificates

2. Use a text editor, such as Notepad, to open the private key and modify it so that is has only one line, and save.

3. Use FTP to upload the certificate and key files (in ASCII mode) to the iSeries machine.

For example:

FTP open <HOST>

cd CFTPROD

ascii

put USER.pem USERPEM

put USERK.pem USERKPEM

Note If you have multiple certificates, repeat the process for each.

Using binary certificates and keys

P12Use FTP to upload the certificate file (in binary mode) to the iSeries machine. For example:

FTP OPEN <HOST>

cd CFTPROD

binary

put USER.P12 USERP12

DERUse FTP to upload the certificate and key files (in binary mode) to the iSeries machine. For example:

FTP open <HOST>

cd CFTPROD

binary

put USER.der USERDER

put USERK.der USERKDER


1 Prerequisites

TCP/IP requirementsThis section describes the specific requirements for TCP/IP in a Transfer CFT Transfer CFT IBM i environment.

Interface level usedThe interface is a SOCKET type.

Execution environmentA TCP/IP network must be installed and configured before the Transfer CFT Transfer CFT IBM i product is installed. Use the STRTCP command to start the TCP/IP environment. The configured servers are then started.

Network environment

Local domain and host name 1. To configure the domain and host names, enter GO CFGTCP.

2. In the CFGTCP menu, select the Changes local domain and host names option and modify the local domain and host names for your IBM i. The host name is used in the CFTNET command HOST parameter when the Transfer CFT/400 monitor is configured.

Host tableEach host with which you wish to transfer files must be declared in this table.

To do so, select the WORK WITH TCP/IP HOST TABLE ENTRIES option in the CFGTCP menu.

TCP/IP interfaceEach domain with which you wish to transfer files must be declared in an interface.

To do so, select the WORK WITH TCP/IP INTERFACE option in the CFGTCP menu and add an interface.

A partner address of 192.1.1.1 and the 255.255.255.0 mask are used to separate the network identifier part (192.1.1) from the host identifier part (1). For a site with the same network identifier, you do not need to configure another network interface.


TCP/IP requirements

TCP/IP port restrictionsThe SAPs used in the Transfer CFT configuration commands must be declared as ports for the TCP/IP protocol. They must also be associated with the Transfer CFT user profile.

Note Ports 1 to 1023 are reserved and must not be used by Transfer CFT.

Checking the network configurationThe PING command is used to test the connection with your partner.

To do so, enter the PING command on an Transfer CFT IBM i command line, followed by the name of the host to be tested. The test results are displayed on the message line.

PrecautionsAny incidents detected impact the following:

l SecurityTo start TCP, you do not need to have a user profile set to *IOSYSCFG, but it may be required for some Transfer CFT configuration commands in the TCP/IP environment: the Transfer CFT IBM i messages are explanatory.

Network interface is not started after the ENDTCPIFC command:

You can start the network interface via the WORK WITH TCP/IP INTERFACE option in the CFGTCP menu, or the STRTCPIFC or NESTAT command if the STRTCP command has already been called.


1 Prerequisites

Create users and set security rightsThis section describes the user rights procedures that you must perform prior to installing Transfer CFT IBM i. Additionally, verify that your operating system and environment requirements are met as described in Prerequisites on page 3.

Prior to installation, ensure the following:

l The CFTINST user who performs the Transfer CFT installation and applies Service Packs must have the following special authorities: *JOBCTL, *SPLCTL and *ALLOBJ.

l The CFT user who manages and uses Transfer CFT must have the following special authorities: *JOBCTL and *SPLCTL.

Please note that these users must exist prior to the Transfer CFT installation. If it is not the case, you can proceed as follows:

Example

CRTUSRPRF USRPRF(CFTINST) PASSWORD(CFTINST) PWDEXP(*YES) USRCLS(*USER)

INLPGM(*NONE) INLMNU(MAIN) LMTCPB(*NO) TEXT('*SHARED: MFT Axway Installer

User Profile') SPCAUT(*JOBCTL *SPLCTL *ALLOBJ) PWDEXPITV(*SYSVAL)

CRTUSRPRF USRPRF(CFT) PASSWORD(CFT) PWDEXP(*YES) USRCLS(*USER) INLPGM

(*NONE) INLMNU(MAIN) LMTCPB(*NO) TEXT('*SHARED: MFT Axway CFT Profile')

SPCAUT(*JOBCTL *SPLCTL) PWDEXPITV(*SYSVAL)

Create an additional user You can create an additional user that interacts with the Transfer CFT instance. For example, you may need an additional user related to a dedicated application. In this section, the example user account is APP1.

1. Create a user.

2. Give the user permission to use Transfer CFT.

3. Update the user profile.

4. Give the user permission to use Transfer CFT with Central Governance.


Create an additional user

Create an APP1 userIt is up to the system administrator to make the decision to create a Transfer CFT-specific user profile. We recommend that you do, if possible, use this type of profile to simplify security management, execution environment generation, and Transfer CFT operations.

Unless you wish to differentiate between several Transfer CFT IBM i instances running concurrently on the same system, you should use the Transfer CFT profile name (USRPRF = APP1). If you decide to use Transfer CFT as a profile, you must create this Transfer CFT profile prior to installing the product.

The profile used to install the product must be in the *SECOFR class.

The APP1 user has the following special authorities:

l *JOBCTL

l *SPLCTL

Example

CRTUSRPRF USRPRF(APP1) PASSWORD(APP1) PWDEXP(*YES) USRCLS(*USER) INLPGM

(*NONE) INLMNU(MAIN) LMTCPB(*NO) TEXT('*SHARED: APP1 Profile') SPCAUT

(*JOBCTL *SPLCTL) PWDEXPITV(*SYSVAL)

Grant the APP1 user permissions To avoid being blocked by the execution rights for commands used in Transfer CFT programs, you must assign user rights to the Transfer CFT profile. Enter the following command to assign user rights:

Grant this user the permission to use Transfer CFT at the system level.

GRTOBJAUT OBJ(CFTPGM/*ALL) OBJTYPE(*ALL) USER(APP1) AUT(*ALL)

GRTOBJAUT OBJ(CFTPROD/*ALL) OBJTYPE(*ALL) USER(APP1) AUT(*ALL)

You must give *RX rights to all objects created in the /home/cft/Transfer_CFT/install directory (default), and /home/cft/Transfer_CFT/runtime directory (default).

The system environment of the user who performs the installation procedure is applied by default if there is no Transfer CFT-specific profile applied during installation. The user profile owns the objects created during installation, but not restored objects such as programs, commands, etc.

As an aid, the CHGOWNCFT and GRTOBJCFT commands are supplied with the library and profile name as call parameters.


1 Prerequisites

Manage user rights System managers can use one of several methods to block Transfer CFT usage, as in some settings a system administrator may need to prohibit the general use of Transfer CFT IBM i.

One way for system administrators to manage users is to assign the right to execute Transfer CFT to any user with a group profile (*GRPPRF). Another is to give the Transfer CFT profile password only to certain users.

If Transfer CFT is used by several profiles, issues over object rights can occur, possibly affecting product operations. To grant specific authority for an object to a user or group, you may need to use the GRTOBJAUT command.

Additionally, when these programs create a file dynamically they grant all users [USER(*PUBLIC)] the default authorization(AUT(*LIBCRTAUT)

In a live environment, the security manager can modify:

l Program usage rights

l User profile usage rights

l Update rights for Transfer CFT service files (PARM, PART, CAT, COM, and optionally LOG and ACCNT files)

l Update rights for source members, such as:

l Source files that can be interpreted (particularly the configuration source file)

l Source files to be submitted by Transfer CFT at the end of the transfer

The method used to address security issues for specific rights depends on the:

l Number and diversity of the user profiles concerned by file transfers

l Required level of data protection, since most constraints when using the product are associated with data confidentiality issues

There are no preset security rules, as Transfer CFT security issues are closely associated with the administration of the system on which Transfer CFT is installed.

Update the APP1 profile to use Transfer CFT instanceCHGUSRPRF USRPRF(APP1) JOBD(CFTPROD/CFTJOBD)

Grant the APP1 user Central Governance rightsYou must create a user (for example, APP1) in Central Governance before you can use Transfer CFT in Central Governance. As this user is not a super user, assign the APP1 user a Transfer CFT role. For example, you can assign it the default role "Transfer CFT Administrator".


Create an additional user

Note The credentials required to log on to Copilot server are the system credentials. The password set in Central Governance for APP1 is not used.

You can now connect to the Copilot server using the APP1 user.


1 Prerequisites


2 Installation

Before you startYou require the following before you begin the Transfer CFT installation:

l Download the ESD file from Axway Support at https://support.axway.com.

l An FTP client that permits the transfer of files to the IBM i host.

Note ISO files were deprecated in version 3.0.1.

l To install the Transfer CFT IBM i product you need adequate space, as the file to upload is approximately 280 MB.

Installation and upload overviewTo install Transfer CFT IBM i:

l Upload and restore the installation files as described in Upload and restore the installation files on page 19.

l Install Transfer CFT using either the automatic or a customize procedure.



2 Installation

About the installed environment

Transfer CFT librariesAfter complete installation of the Transfer CFT product, the procedure will create the following libraries:

l CFTPGM: This library is generally reserved for Transfer CFT and which contains:

o Programs

o Examples of source files (CFTSRC file)

o Savf File for IFS environment

o CFTPROD: This library is generally reserved for customer and which contains:

o Source files customized by the client

o SAVF files when you apply Service Pack

o CFT specific objects and subsystems

Transfer CFT specific objects and subsystemsTransfer CFT IBM i runs on a specific subsystem and use specific objects. These objects are automatically created during the installation, in the production library. These objects are mandatory for Transfer CFT operations, but their name can be customized when executing the INSTALL command (see Install Transfer CFT on the IBM i system). These objects are:

l Job description (*JOBD)

l Job queue (*JOBQ)

l Subsystem with a private memory pool of 245 MB

l Standard batch class

For practical reasons, you may consider other configurations:

l If you foresee activity peaks for Transfer CFT and other applications at the same time, consider working in a shared pool.

l If Transfer CFT is being used in time slots corresponding to normal activity levels and when no other applications are running, the basic memory pool is sufficient.


Upload and restore the installation files

Upload and restore the installation filesThis section describes the upload and restore options available for Transfer CFT 3.7 for the IBM i platform to perform prior to installation, using FTP and the RSTLIB command.

Before starting a Transfer CFT session, you must add the value *none in the initial program call to call a screen menu directly. Otherwise the session cannot start.

Note CFTPGM is the standard name for the programs library.

Begin the installation process by uploading the Transfer CFT installation package, in binary mode, to the IBM i system:

1. Log in with the CFTINST user.

2. Create a temporary library:

CRTLIB CFTTMP

3. Create a SAVF file:

CRTSAVF FILE(CFTTMP/CFT37)

4. Upload the installation package to the SAVF in binary mode using FTP:

binary

cd CFTTMP

put Transfer_CFT_os400.bin CFT37

5. Restore the SAVF file:

RSTLIB SAVLIB(CFTPG) DEV(*SAVF) SAVF(CFTTMP/CFT37) OPTION(*NEW)

RSTLIB(CFTTMP)


2 Installation

About the INSTALL commandThe INSTALL command enables you to install:

l Transfer CFT binary objects, such as programs, to the Transfer CFT program library

l Transfer CFT files to production library

l Transfer CFT IFS files to IFS directory

After uploading the Transfer CFT IBM i CFT33XL file to the target location, in the Transfer CFT profile you must add the CFTTMP library to the library list. In command line execute:

ADDLIBLE LIB(CFTTMP) POSITION(*FIRST)

Note The Transfer CFT program library and Transfer CFT production library are created if they do not exist prior to performing this procedure.

During the installation you are prompted to configure your installation, for example:

l Install on an independent ASP

l CFT program library

l CFT production library

l User for whom Transfer CFT is installed

l CFT JOBD, CFT JOBQ, CFT Subsystem, CFT class, CFT OUTQ

l Encryption Password

l Confirm Encryption Password

l Key file name

l Salt file name

l Installation and runtime directory

l IDPARM (max length < 9)

l Copilot server hostname and port

l Catalog size

l Communication file size

You can also enable:

l Multi-node architecture

l Central Governance connectivity

l REST API server

l Sentinel

l SSL

And lastly, you can configure:


About the INSTALL command

l AM type

l PKI type

l cft instance id

l Synchronous transfer port

l PeSITany port

l PeSITssl port

Executing the INSTALL command Enter the INSTALL command and press PF4 to display the Transfer CFT IBM i installation screen.

Note Pressing ENTER at this stage performs an install using the default values. You can override any default value, as needed.

INSTALL CFT (INSTALL)

Install on an independent ASP. . . . . . . '2' 1:Yes / 2:No

Note To perform a silent installation, use the CFT Update menu as shown in Perform_auto_installation.htm.

Note The encryption password to enter for an installation contains special characters. To avoid an issue during installation, please ensure that the encoding of your terminal/keyboard is configured with CCSID 37.


../../../../../Content/ibm_i/installation/Perform_auto_installation.htm

../../../../../Content/ibm_i/installation/Perform_auto_installation.htm

2 Installation

Silent installation 1. Log in with the CFTINST user (with *ALLOBJ special authority).

CFT Update (UPDATE)

Type choices, press Enter.

Install on an independent ASP . > 2 1:Yes/2:No

Silent Installation . . . . . . > 1 1:Yes/2:No

CFT Program library . . . . . . > CFTPGM Name

CFT Production library . . . . . > CFTPROD Name

User for who CFT is installed . > CFT Character value

CFT JOBD ....................... > CFTJOBD Name

CFT JOBQ ....................... > CFTJOBQ Name

CFT Subsystem .................. > CFTSBS Name

CFT Class ...................... > CFTCLS Name

CFT Outq ....................... > CFTOUTQ Name

Encryption Password

Confirm Encryption password

Key file name ........... > CRYPTKEY Character value

Salt file name .......... > CRYPTSALT Character value

2. Select 1.

3. Install Transfer CFT. The following example installs Transfer CFT with the Central Governance option:

INSTALL INSTMODE('1') PGMLIB(CFTPGM) PRODLIB(CFTPROD) USERINST(CFT)

CFTJOBD(CFTJOBD) CFTJOBQ(CFTJOBQ) CFTSBSD(CFTSBS) CFTCLS(CFTCLS) CFTOUTQ

(CFTOUTQ) CRYPPASS('[YOUR_PASS]') CRYPPASS2('[YOUR_PASS]') CRYPKEY

(CRYPTKEY) CRYPSALT(CRYPTSALT) PTHINSTALL('/home/cft/Transfer_

CFT/install') PTHRUNTIME('/home/cft/Transfer_CFT/runtime') COPSRVHST

(Iserie.axway.int) COPSRVPRT(1766) COPPRTSSL(1767) ENCG(1) CGHOST

(CG.ptx.axway.int) CGPORT(12553) SHRDSCRT(Secret01) SHRDSCRT2(Secret01)

FULLHOST(Iserie.axway.int) CFTINSTID(CFTOS400) PORTCOMS(1765) PSITANYSAP

(1761) LICKEY(MY_KEY)

Register with Central Governance 1. Log in with the Transfer CFT user CFT.

2. Start Copilot.

COPSTART

1. Check that the Transfer CFT instance appears in Central Governance.


Silent installation

You can now operate your Transfer CFT instance with the CFT user.

After executing the installation, the following objects are created in the CFTPROD library:

l Files: CAT, COM, LOG, ALOG, ACCNT, AACCNT

l System objects: CFTJOBQ, CFTJOBD, CFTSBS, CFTCLS, CFTOUTQ


2 Installation

Use an independent ASP (optionally)

About independent ASPs (IASP)An independent ASP (or independent disk pool) is a collection of disk units that can be brought online or taken offline independent of other system storage, including the system ASP, user ASPs, and other independent ASPs. Independent ASPs are useful both in single and multiple system environments.

In a single system environment, you can take an independent ASP offline independent of other ASPs as the data in the independent ASP is self-contained. This means that all of the necessary system information associated with the independent ASP's data is contained within the independent ASP. You can also bring the independent ASP online while the system is active (no IPL required). This use of independent ASPs can be useful, for example if you have large amounts of data that are not needed for normal day-to-day business processing. The independent ASP containing this data can be left offline until it is needed. When large amounts of storage are systematically kept offline, you can shorten processing time for operations such as IPL and reclaim storage. (IBM)

IASP commandYou can use the following commands to manage IASP:

l To start or stop an IASP, use the command:

WRKDEVD

l To activate an environment, use the command:

SETASPGRP (ex: ‘SETASPGRP ASPGRP(IASP1)’)

l To disable an environment, use the command:

SETASPGRP ASPGRP(*NONE)

Use an IASP in a Transfer CFT environmentFor Transfer CFT to be able to access the files located on an Independent ASP (write or read mode), you must have an available IASP environment. To enable this access:

1. Connect to your system.

2. Start the IASP.


Enable system user control (USERCTRL)

3. Before starting Transfer CFT, use the EDTLIB command to add the following three libraries:

l CFTPGM: Contains the Transfer CFT programs

l CFTPROD: Contains the Transfer CFT configuration

l CFTSBSLIB: An additional library in the ASP that contains your SBS

4. Use the SETASPGRP command to enable your IASP.

5. Use the CFTSTART command to start Transfer CFT.

Enable system user control (USERCTRL) The system user control (USERCTRL) feature allows Transfer CFT to read and write files and execute processing procedures on behalf a user other than the one who operates Transfer CFT.

To enable this feature, in addition to setting the CFTPARM:USERCTRL parameter to YES, the user operating Transfer CFT requires the *ALLOBJ special authority.


2 Installation

Manually enable Central Governance 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. 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>

ProcedureThe manual procedure consists of the following steps, which are detailed below:

1. Set the UCONF parameter values for Central Governance.

2. Enable Central Governance.

3. Start Copilot to register.

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>


Manually enable Sentinel

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

Manually enable Sentinel When using Central Governance, the visibility features are managed by Central Governance. Do not modify these parameters when running with Central Governance.

Sentinel configuration parametersThe following table lists the Sentinel parameters in the unified configuration and the corresponding former Sentinel parameter.

UCONF parameter Default Former Sentinel parameter

TRKCNF

sentinel.xfb.enable NO XFB.Sentinel (TRKCNF)

sentinel.xfb.transfer ALL XFB.Transfer (TRKCNF)

sentinel.xfb.shut 0 XFB.Shut (TRKCNF)

sentinel.xfb.log IEWF XFB.Log (TRKCNF)

sentinel.trktname $(cft.runtime_dir)/data/trkapi.buf TRKTNAME (TRKCNF)

sentinel.trksharedfile No TRKSHAREDFILE

sentinel.trklenmsg TRKLENMSG

sentinel.trklocmaxtime 300 TRKLOCMAXTIME


2 Installation


TRKCNF

sentinel.trktmode DIFFER TRKTMODE

sentinel.trktconnretry 60 TRKTCONNRETRY

sentinel.trkretrydelay 10 TRKRETRYDELAY

sentinel.trkretrynb 6 TRKRETRYNB

sentinel.trkdelay 10 TRKDELAY

sentinel.trktimeout 60 TRKTIMEOUT

sentinel.trkproductname CFT TRKPRODUCTNAME

sentinel.trkipaddr sentinel-server-hostname TRKIPADDR

sentinel.trkipport 1761 TRKIPPORT

sentinel.trk_min_port 5000 TRK_MIN_PORT

sentinel.trk_max_port 32000 TRK_MAX_PORT

sentinel.trkipaddr_bkup TRKIPADDR_BKUP

sentinel.trkipport_bkup 1761 TRKIPPORT_BKUP

sentinel.trk_min_port_bkup 5000 TRK_MIN_PORT_BKUP

sentinel.trk_max_port_bkup 32000 TRK_MAX_PORT_BKUP

sentinel.trktype TCP TRKTYPE

sentinel.trkgmtdiff 60 TRKGMTDIFF

sentinel.trktrcfile $(cft.runtime_dir)/run/sentinel.trc TRKTRCFILE

sentinel.trktrace 0 TRKTRACE


Manually enable Sentinel


TRKCNF

sentinel.xfb.transfer_progress_periodThe frequency in seconds in which Transfer CFT notifies Sentinel (for both SENDING and RECEIVING states) that a transfer is running.0 = no notification

60

sentinel.xfb.transfer.send_relay_site_nidfEnables an NIDF on the relay site. This uses an NIDF instead of COMMUT when sending an event to Sentinel using the XFBTransfer object.

No

For more information on event messages, refer to the Axway Sentinel documentation.

About Transfer CFT heartbeat functionalityWhen the Transfer CFT heartbeat function is activated, it sends the attributes to the Axway Sentinel server via TRKUTIL.

For more information on tracked objects, refer to the Axway Sentinel User's Guide.

Sentinel Heartbeat implementation parametersThe following table lists the Heartbeat parameters that you can set in the unified configuration.

Each Transfer CFT environment number n (from 1 to 5) has its own corresponding Heartbeat script. You should check the default names (such as in the production library, jobd, and Transfer CFT file) that are used in the script.

Unified configuration parameter

Default value Description

sentinel.heartbeat.enable NO Enables sending Heartbeats to the Sentinel Server.


2 Installation

Unified configuration parameter

Default value Description

sentinel.heartbeat.periodicity 300 The delay in seconds between sending Heartbeats.

sentinel.heartbeat.script CFTPROD/HEARTBEAT Script for executing Heartbeats.

Table 1. Example

uconfset id=sentinel.heartbeat.enable,value=yes

uconfset id=sentinel.heartbeat.periodicity,value=300

uconfset id=sentinel.heartbeat.script,value=CFTPROD/HEARTBEAT

uconfset id=sentinel.trkipaddr,value=serveur.sentinel.address

uconfset id=sentinel.trkipport,value=11277

uconfset id=sentinel.trklocaladdr,value=as400.local.address


Transfer CFT IBM i utilities

Transfer CFT IBM i utilitiesThis section describes basic Transfer CFT operating procedures, and provides advice for using Transfer CFT in an IBM i environment. Topics include:

l Using the Menu bar

l Starting the Transfer CFT Transfer CFT IBM i Manager

l Purging residual Transfer CFT objects

l Programming interface applications

l Using CFTUTIL Transfer CFT IBM i specific commands

l Using the support tool

In this document, the terms Transfer CFT OS/400 and Transfer CFT IBM i may be used interchangeably.


../../../../../Content/ibm_i/operations/best_practices/Using_the_Menu_bar.htm

../../../../../Content/ibm_i/operations/best_practices/start_CFT_IBMi_Manager.htm

../../../../../Content/ibm_i/operations/api_exits/APIs_intro_ibmi.htm

../../../../../Content/ibm_i/operations/best_practices/using_cftutil.htm

../../../../../Content/ibm_i/operations/best_practices/os400_support tool.htm

2 Installation

Using the Menu barIn addition to the described functions, the menu bar provides features that can be used during product operations, such as setting the network traces, and submitting product and OS commands.

The Menu bar is comprised of the options:

l Job manager

l Network manager

l Assistant

l Options

l About

To select an option, position the cursor on the appropriate menu in the bar and click to select. Some of these menus include sub-menus.

ExampleSelect 2 Network manager, and then select 10 Start communications trace. The Network manager screen is displayed.


Transfer CFT IBM i utilities

Using CFTUTIL Transfer CFT IBM i specific commands

Line-mode commandsThe Transfer CFT utility CFTUTIL can accept line-mode commands. Enter the command at the CFTUTIL > prompt and press ENTER to validate. To exit CFTUTIL, enter the /end command.

Examples

l In an Transfer CFT IBM i command line, enter the command CFTUTIL and press ENTER.

Enter the selection or command at the prompt.

> CFTUTIL

l Enter the command LISTCAT and press ENTER to confirm.

1:Input :

> LISTCAT

l Enter the command /end and press ENTER to exit CFTUTIL.

1:Input :

> /END

Files and individual parametersCFTUTIL can accept commands passed either as individual parameters or in a command file.

Command passed as a parameterThe command line is passed as a CFTUTIL parameter using the following syntax:

CFTUTIL PARAM(‘command’ ‘parameter=value, parameter=value,..’)

Examples

CFTUTIL PARAM('LISTCAT’ ‘TYPE=ALL')

CFTUTIL PARAM('LISTCAT’ ‘CONTENT=DEBUG,DIRECT=SEND')

CFTUTIL PARAM('SEND’ ‘PART=LOOP,IDF=TEST')

CFTUTIL PARAM('LISTPARM’ ‘TYPE=RECV')


2 Installation

File passed as a parameterThe following command runs the CFTUTIL utility, which reads the commands to be executed in the scen.cft file and displays the results.

Example

CFTUTIL PARAM('#CFTPROD/UTIN(SCRIPT)')


3 Post-installation

Transfer CFT in productionThis chapter describes how to operate Transfer CFT, and is comprised of the following sections:

l Predefined commands

l CFTUTIL commands

l Source files interpretation

l Start/stop the UI server

l Run Transfer CFT jobs:

o Query Transfer CFT messages

o Start Transfer CFT

o Submit a transfer command

l Transfer CFT shutdown

Transfer CFT menu usageOther than during installation, which runs the Transfer CFT manager automatically, you can enter one of the following commands to start the manager:

l CFT

l CALL CFTMENU

Create Transfer CFT system objectNow that you have installed your Transfer CFT IBM i, you will want to recreate Transfer CFT objects. Proceed to the Transfer CFT menu and press 4 to access the following options:

1. Create job queue.

Create a JOBQ object to launch Transfer CFT jobs using the default values.

2. Create job description.

Create a JOBD object to launch Transfer CFT jobs using the default values. This programs the initial library list and the Transfer CFT IBM i production libraries (CFTPGM and CFTPROD).


../../../../../Content/ibm_i/operations/production/predefined_commands.htm

../../../../../Content/ibm_i/operations/production/Submit_CFTUTIL_commands.htm

../../../../../Content/ibm_i/operations/production/Interpret_source_member.htm

../../../../../Content/ibm_i/operations/copilot/Start_Copilot_server.htm

../../../../../Content/ibm_i/operations/production/Running_Transfer_CFT.htm

../../../../../Content/ibm_i/operations/production/Querying_Transfer_CFT_messages.htm

../../../../../Content/ibm_i/operations/production/Start_CFT.htm

../../../../../Content/ibm_i/operations/production/Submit_transfer_command.htm

../../../../../Content/ibm_i/operations/production/Shut_CFT.htm

3 Post-installation

3. Create subsystem.

Create an SBS object to launch Transfer CFT jobs. This creates a subsytem with a storage size of 250MB.

4. Add job-queue entry.

Add a job queue entry to the subsystem that you created in step 3 to link it with the JOBQ that you created in step 1. The maximum active job is unlimited.

5. Create class.

Create a class CLS object for Transfer CFT with a time slice of 5000 milliseconds.

6. Add routing entry.

Add a routing entry to the subsytem created in step 3 to link it with the class created in step 5. This uses the SEQNBR(9999) CMPVAL(*ANY) and PGM(QCMD) options.

7. Add communication entry.

Add a communication entry to link the subsystem created in step 3 with the JOBD created in step 2. This uses the DFTUSR(CFT) ??MODE(*ANY) ??MAXACT(*NOMAX) options.

8. Change profile.

Change the user profile of the current user to specify that the user now uses the JOBD in step 2, and subsequently the subsystem and JOBQ created in the other steps and linked with the JOBD.

Verify your installation See the installation troubleshooting section of the User Guide if you encounter problems with starting Transfer CFT.

Installed directoriesThe act of installing Transfer CFT creates a library that contains product binaries and templates. Do no store any personal files in this library, or modify existing files in this library, as both are erased during updates.

Note By default, this library is called CFTPGM.

Register with Central Governance If you intend to implement Central Governance, please refer to the Transfer CFT User's Guide > Register with Central Governance page for registration details.


https://docs.axway.com/bundle/TransferCFT_36_UsersGuide_allOS_en_HTML5/page/Content/cft_installation/migrate/register_CG.htm

Manage commands

Manage commandsThis section describes all of the command available to manage your Transfer CFT product.

Standard commands Command Comment

CFTSTART Start Transfer CFT

CFTSTOP Stop Transfer CFT

COPSTART Start the UI server

COPSTOP Stop the UI server

CFTMN This is the procedure to manage Transfer CFT and to configure multi-node. Add the following action(s) to manage your product:

l START

l STOP

l RESTART

l ADD_NODE

l REMOVE_NODE

l ADD_HOST

l REMOVE_HOST

l REMOVE_NODE

l ENABLE_NODE

l DISABLE_NODE Note CFTMN is the equivalent of cft script for UNIX or

Windows.

Deprecated commandsReplace this command... With the new command...

SHUT CFTSTOP + COPSTOPCFTMGSBM CFTSTARTSTARTCOPB COPSTARTCOPSMNG COPSTARTCOPSTOPM COPSTOP


3 Post-installation

Replace this command... With the new command...

STOPCOPL COPSTOPBACKGROUND_C BACKGROUNDSNDCFTF CFTUTIL (See Example 1)SNDCFTSPLF CFTUTIL (See Example 2)MAJSECINI No replacementMAJSECENVG No replacementGENEDICT No replacement

Example 1

Send a member:

CFTUTIL send PART=<PART>, IDF=<IDF>, FNAME=&LIB/&FILE(&MBR)

Example 2

Send a spool file:

CFTUTIL send PART=<PART>, IDF=<IDF>, FNAME=&FILE/&SPLNBR/&WORK/&JOBNBR


Start and stop Copilot

Start and stop CopilotWhen using the former Copilot UI and am.type=passport or am.type=cg, the user that connects to the former UI (Copilot) must be defined in the system as well as in PassPort/Central Governance.

Start the Copilot serverThis section describes how to start the Copilot server via either a menu or command. For more information on calling menus, see Transfer CFT menu usage on page 35.

Menu

1. Access the Transfer CFT Main Menu.

In the Main Menu enter the command cft and press Enter to open the Transfer CFT menu.

2. Enter 1 to access Common CFT commands.

3. Select option 1 Start Copilot. The Copilot server menu is displayed.

Command

Execute: COPSTART

Stop the Copilot serverThis section describes how to stop the Copilot server via either a menu or command.

Menu

1. Access the Transfer CFT Main Menu.

In the Main Menu enter the command cft and press Enter to open the Transfer CFT menu.

2. Enter 1 to access Common CFT commands.

3. Select option 2 Stop Copilot.Only the server waiting for a connection is stopped. Other servers that users have logged onto are shut down when the user logs off, or after a network timeout.

Command

Execute: COPSTOP

Configure the Copilot serverUse the UCONFSET commands to modify the configuration if you need to modify the Copilot server .


3 Post-installation

Manage Transfer CFT using IFSThis section explains how you can use Transfer CFT on the IFS environment. To do this you must run the following commands:

1. Log on the iSeries using the Transfer CFT account.

2. Execute the QSH command.

3. Change the directory:

cd /home/cft/TransfertCFT/runtime

4. Load the profile:

. ./profile

5. You can then use standard Transfer CFT programs, such as:

l CFTSTART: Start Transfer CFT

l CFTSTOP: Stop Transfer CFT

l COPSTART: Start UI Server

l COPSTOP: Stop UI Server

l CFTUTIL

l PKIUTIL

l Etc.

How to use programs without menusThis section describes ho to use programs such as CFTUTIL, CFTINIT, CFTMI, etc. For example, to migrate Transfer CFT you cannot use the standard Transfer CFT IBM i menus and require the following steps.

1. Enter: CALL and press F4.

2. In the Program field, enter the name of binary (CFTUTIL in the example).

3. In the Library field, enter your program library (*LIBLby default, CFTPROD in the example).

4. In the Parameters field you can enter an argument. CFTUTIL requires at least one argument (CFTEXT in the example).

Call Program (CALL)


Program . . . . . . . . . . . . > CFTUTIL Name


How to use programs without menus

Library . . . . . . . . . . . CFTPROD Name, *LIBL, *CURLIB

Parameters . . . . . . . . . . . > CFTEXT

+ for more values > type=all,fout=CFTPROD/cft_ext

The first argument is a CMD and the second argument is an OFORMAT. Here is an example command:

"CFTUTIL CFTEXT type=all, fout=CFTPROD/cft_ext"

Program : "CFTUTIL

CMD : "CFTEXT"

OFORMAT : "type=all, fout=CFTPROD/cft_ext"

The command executed is:

CALL PGM(CFTUTIL) PARM(CFTEXT 'type=all,fout=CFTPROD/cft_ext')


3 Post-installation

Operating Transfer CFTFrom the Main Menu, enter the command cft and press Enter to open the Manager Menu.

Select from:

1. Common CFT commands

2. Security commands

3. Administration commands

4. Create Transfer CFT system objects

5. Multi-node commands (only available if multi-node is enabled)


Operating Transfer CFT

Transfer CFT 3.2.x and higher1. Common CFT commands

1. Start Copilot 2. Stop Copilot 3. Start Transfer CFT 4. Stop Transfer CFT 5. CFTUTIL operations 6. Manage configuration File

1. Edit configuration file 2. Interpret configuration file

2. Security commands 1. Edit Security configuration file 2. Interpret Security configuration 3. PKIUTIL operation

3. Administration commands 1. Reinitialize Transfer CFT parameters 2. Submit Transfer CFT support request

4. Create system objects 1. Create job queue 2. Create job description 3. Create subsystem 4. Add job-queue entry 5. Create class 6. Add routing entry 7. Add communication entry 8. Change profile

Note: A highlighted menu item indicates there is a sub-menu.

If you have worked with earlier versions of Transfer CFT IBM i, you can compare menu options in Appendix B: Menu mapping on page 155.

Using the common Transfer CFT commandsSelect Option 1 to use the common Transfer CFT commands:

Option Command Details

1 Start Copilot Starts the Copilot server


3 Post-installation

Option Command Details

2 Stop Copilot Stops the Copilot server

3 Start CFT Starts the Transfer CFT server, and in multi-node configuration starts all enabled nodes

4 Stop CFT Stops the Transfer CFT server, and in multi-node configuration stops all enabled nodes

5 CFTUTIL operations

Open a CFTUTIL command line session

6 Interpret source member

Interpret a source member

7 Manage configuration file

Opens the manage configuration file screen



Submit CFTUTIL commands Select Option 1 then Option 5 to start a CFTUTIL session.

This enables you to submit CFTUTIL commands via the keyboard.

This option sequences Transfer CFT commands through to the end of the session.

Example

You can execute all CFTUTIL operations by entering the command as follows:

SEND PART=LOOP,IDF=TEST,FNAME=CFTPROD/FILE1


3 Post-installation

About transport security and PKIUTIL commandsThis section describes SSL security parameters. For more information on transport security concepts, refer to the Security sub-book in the Transfer CFT documentation.

Certificates Refer to the Transfer CFT User Guide for more information on certificates.

Configuration changesYou must define certain elements in the product configuration if you want to use transfer security. See the delivered samples in CFTPGM/CFTSRC(TCPPARAM).


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


Using the PKIUTIL utilityTo use the PKIUTIL utility:

1. Access the Transfer CFT Main Menu screen. In the Main Menu enter the command cft and press Enter to open the Manager Menu.

2. Select option 2. Security commands. Then select option 2. Interpret Security configuration and enter the member you want to interpret. By default this is the PKIBASE member in the UTIN file in CFTPROD library.

3. To edit the security configuration file selection option 2. Security commands then option 1. Edit Security configuration file and enter the member you want to edit. By default it is the PKIBASE member in the UTIN file in CFTPROD library.

Submitting PKIUTIL commandsSelect option 2. Security commands, and then 3. PKIUTIL operation in the Operations screen to start the PKUTIL session.

This option allows you to use the keyboard to enter and execute PKIUTIL commands.

PKIU20I

PKIU20I PKI

PKIU20I Version 3.2.4 2017/02/02

PKIU20I (C) Copyright AXWAY 1989-2017

PKIU20I ====> Starting Session on 03/03/2017 Time is 16:20:37

PKIU20I

===> LISTPKI

Create a databaseUse the following commands, in order, to create a database:

PKIFILE MODE=CREATE, FNAME= 'CFTPROD/PKIBASE'

PKICER ID=NEWCA, MODE=CREATE, PKIFNAME=CFTPROD/PKIBASE, ITYPE=ROOT,

INAME=CFTPROD/AXWRCA, IFORM=DER, STATE=ACT

PKICER ID=NEWUSER,MODE=CREATE, PKIFNAME=CFTPROD/PKIBASE, INAME=CFTPROD/MFTUSRCA, IKNAME=CFTPROD/MFTUSRCAK, ITYPE=USER,

IKPASSW=user, STATE=ACT, ROOTCID=NEWCA, IKFORM=DER


3 Post-installation

List PKI Internal datafiles contents 1. To list the PKI internal datafiles contents, enter the command: LISTPKI

2. Press ENTER to execute the command.

A correct execution displays the following messages:

> LISTPKI

1:¬PKU|Date = 03/03/2017 Time = 16:24:43PKI Fname =

Id. Root T S C K E Exp.Date Delivered to Delivered by------- ----- - - - - - ---------- ------------- ---------------

CAXMP CAXMP R A x 19/12/2017 CA SAMPLE FOR CA SAMPLE FOR CLIENT

CAXMP U A x x 18/12/2017 CLIENT SAMPLE CA SAMPLE FOR SERVER

CAXMP U A x x 18/12/2017 SERVER SAMPLE CA SAMPLE

PKIU00I LISTPKI _ Correct ()



Interpreting source membersSelect option 1. Common Transfer CFT commands, then option 6. Interpret source member in the Operation screen to interpret source files dynamically.

These files contain change configuration commands and submit Transfer CFT commands routines.

The send file command displays the following message if syntax parsing is successful:

CFTU20I CFT OS/400 CFTU20I Version 3.2.1 2015/03/12 CFTU20I (C) Copyright AXWAY 1989-2015 CFTU20I ====> Starting Session on 29/03/2013 Time is 16:03:47 CFTU20I Parameters file :CFTPARM

CFTU20I Partners file :CFTPART CFTU20I Catalog file :CFTCAT

CFTU20I

CFTU00I SEND _ Correct (PART=BOUCLE,IDF=TEST1,FNAME=CFTPROD/FILE1) CFTU20I Communication file row number used: 00000010 on 20130329 Time 1603470

1


2


3

CFTU00I RETURN _ Correct (CODE=0) CFTU20I Number of Command(s) 3 CFTU20I Number of error(s) 0


3 Post-installation

Running Transfer CFTTo start the Transfer CFT server from the Operations menu, enter 1. Common Transfer CFT commands, then 3. Start Transfer CFT. Press ENTER to execute. Note that this starts the Transfer CFT subsystem if it was not already running.

Operations that recreate files prior to the start-up are only required in specific restart conditions, such as after changing the configuration.

Note If you recreate the COM file, any transfer requests deposited since Transfer CFT was last run are lost. If you recreate a CAT file, information required to restart any interrupted transfers may be lost.

Transfer CFT jobs are submitted in the following order:

l 1: CFTMAIN (main task and transfer scheduling task)

l 2: CFTLOG (log management task)

l 3: CFTTCOM (command management task)

l 4: CFTTPRO (protocol management task)

l 5: Network handler(s)

l 6: CFTTFIL (file tasks)

Transfer CFT cannot run if any of the jobs are missing, except for the file task. The file task is only submitted after a send or receive transfer request, or a receive request from a remote site.



Starting Transfer CFTSelect Option 1. Common Transfer CFT commands, then 3. Start Transfer CFT in the Operations screen. Once Transfer CFT starts, the product is operational. You can perform transfer operations after the startup messages are displayed.

From . . . : CFT 04/02/15 17:04:56

Start CFT Monitor - Subsystem CFTSBS is started

From . . . : CFT 04/02/15 17:04:59

CFTS33I CFTLOG current file before switch :CFTPROD/LOG1

From . . . : CFT 04/02/15 17:04:59

CFTS34I+CFTLOG executed switch proc : *LIBL/CFTSRC(B_EXECLOG)

From . . . : CFT 04/02/15 17:04:59

CFTS35I+CFTLOG current file after switch :CFTPROD/ALOG1

From . . . : CFT 04/02/15 17:04:59

CFTI34I PID=2 CFTLOG Task started successfully

From . . . : CFT 04/02/15 17:04:59

CFTI18I CFT OS/400

From . . . : CFT 04/02/15 17:04:59

CFTI18I+Version 3.0.1 2015/03/12

From . . . : CFT 04/02/15 17:04:59

CFTI18I+Version 3.2.1

From . . . : CFT 04/02/15 17:04:59

CFTI18I+(C) Copyright AXWAY 1989-2015

From . . . : CFT 04/02/15 17:04:59

CFTI18I+

From . . . : CFT 04/02/15 17:04:59

CFTI18I+MODEL E4B

From . . . : CFT 04/02/13 17:04:59

CFTI18I+CPU 06890AP

From . . . : CFT 04/02/15 17:04:59

CFTI18I+ID IDPARM0

From . . . : CFT 04/02/15 17:04:59

CFTI18I+

From . . . : CFT 04/02/13 17:04:59

CFTI18I+Authentication Method: none

From . . . : CFT 04/02/13 17:05:00

CFTC08I Catalog: Loading...

From . . . : CFT 04/02/13 17:05:00

CFTC08I Catalog: Load Done

From . . . : CFT 04/02/13 17:05:00

CFTC08I Catalog: Size=5000, Used=3(0%)

From . . . : CFT 04/02/13 17:05:02

CFTC08I Purge Started.

From . . . : CFT 04/02/13 17:05:02

CFTC08I Purge catalog-size=5000 in-use=3 pre-filtered=0(0%)

From . . . : CFT 04/02/15 17:05:03

CFTI34I PID=4 CFTTCOM Task started successfully


3 Post-installation

From . . . : CFT 04/02/13 17:05:03

CFTI34I PID=5065 CFTPRX Task started successfully

From . . . : CFT 04/02/15 17:05:04

CFTI34I PID=8 CFTTCPS Task started successfully

From . . . : CFT 04/02/13 17:05:04

CFTI34I PID=0 CFTTCPS Task started successfully

From . . . : CFT 04/02/15 17:05:04

CFTN01I NET=TCP0 started

From . . . : CFT 04/02/13 17:05:04

CFTN02I NET=TCP0 PROTOCOL=PESITANY SAP=65535 started

From . . . : CFT 04/02/15 17:05:04

CFTI34I PID=5 CFTTPRO Task started successfully

From . . . : CFT 04/02/15 17:05:05

CFTI34I PID=37328 CFTMAIN Task started successfully

From . . . : CFT 04/02/15 17:05:05

CFTI18I CFT started by user CFT

From . . . : CFT 04/02/15 17:05:05

CFTI18I+On 1000 authorized simultaneous transfer(s), 32 is(are) active

From . . . : CFT 04/02/15 17:05:05

CFTI18I+

From . . . : CFT 04/02/15 17:05:05

CFTI18I+Be careful : the license of CFT will expire in 35 days.

From . . . : CFT 04/02/15 17:05:05

CFTI18I+

From . . . : CFT 04/02/15 17:05:05

CFTI18I+Edition : Advanced

From . . . : CFT 04/02/13 17:05:05

CFTI18I+TCP/IP Network Access Method Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+File Transfer Acceleration Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+Bandwidth Priority Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+Multi-node Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+X25 Network Access Method Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+DNA Network Access Method Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+DSA Network Access Method Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+LU6.2 Network Access Method Option is authorized

From . . . : CFT 04/02/13 17:05:05

CFTI18I+VFM File Access Method Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+SNA Network Access Method Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+Web Services for Copilot Option is authorized



From . . . : CFT 04/02/15 17:05:05

CFTI18I+FIPS Compliance Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+SSL Protocol Option is authorized

From . . . : CFT 04/02/15 17:05:05

CFTI18I+

From . . . : CFT 04/02/15 17:05:05

CFTI26I+Init complete _ Security not active

From . . . : CFT 04/02/15 17:05:05

CFTI28I+Init complete _

From . . . : CFT 04/02/13 17:05:05

CFTI18I+ FNAME : CFTCAT

From . . . : CFT 04/02/15 17:05:05

CFTI11I+Init complete _ Logger process ¬ID=IDLOG0|

From . . . : CFT 04/02/15 17:05:05

CFTI18I+ FNAME : CFTPROD/LOG1

From . . . : CFT 04/02/13 17:05:05

CFTI18I+ AFNAME : CFTPROD/ALOG1

From . . . : CFT 04/02/15 17:05:05

CFTI13I+Init complete _ Communication process ¬ID=IDCOM0|

From . . . : CFT 04/02/15 17:05:05

CFTI18I+ TYPE : File FNAME : +CFTCOM

From . . . : CFT 04/02/15 17:05:05

CFTI12I+Init complete _ Protocol process

From . . . : CFT 04/02/15 17:05:05

CFTI14I+CFT init complete _ CFT400

From . . . : CFT 04/02/15 17:05:05

CFTC08I Purge Treated : no record found to delete.

From . . . : CFT 04/02/15 17:05:05

CFTR12I PURGE Treated


3 Post-installation

Shutting down Transfer CFTTo stop the Transfer CFT server access the Operations screen and select option 1. Common Transfer CFT commands, then 4. Stop Transfer CFT. Press ENTER.

The following shutdown messages are displayed:

CFTU20I

CFTU00I SHUT _ Correct ( FAST=YES)

CFTU20I Communication file row number used: 00000022 on 20130329 Time 1612460

2

CFTU20I Number of Command(s) 1

CFTU20I Number of error(s) 0

CFTU20I Ending Session on 29/03/2015 Time is 16:12:46

CFTU20I Session active for 0:00:00

Press ENTER to end terminal session.

Job 729794/CFT/CFTCLEANUP ended abnormally.

From . . . : CFT 03/29/15 16:12:51

CFTR12I SHUT Treated for USER CFT

From . . . : CFT 03/29/15 16:12:51

From . . . : CFT 03/29/15 16:12:51

CFTI35I PID=9 CFTTFIL Task ended

From . . . : CFT 03/29/15 16:12:51

CFTI35I PID=8 CFTTCPS : Normal shut Task ended

Job 729786/CFT/CFTTCPS completed normally on 03/29/15 at 16:12:51.

From . . . : CFT 03/29/15 16:12:51

CFTI35I PID=0 CFTTCPS Task ended

From . . . : CFT 03/29/15 16:12:51

CFTI35I PID=37328 CFTMAIN Task ended

From . . . : CFT 03/29/15 16:12:51

CFTI35I PID=34704 CFTTPRO Task ended

Job 729785/CFT/CFTTPRO1 completed normally on 03/29/15 at 16:12:51.

Configuring Transfer CFT parametersFrom the Main Menu, enter the command cft and press Enter to open the Manager Menu.

1. Select option 1 Customization and press ENTER.

2. In the Customization screen, select option 1 CFT parameters and press ENTER.

3. You can select option 2 Interpret the selected member.



Interpreting a parameter sourceThe parameter file that you selected in the previous step, option 1 Editing the parameter source member, is interpreted by CFTUTIL. The options are confirmed before being interpreted. To interpret or update a parameter source, select option 2 Interpret selected member in the Customization screen. The following screen is displayed.

The parameter and partner files can be created, re-created, or updated prior to interpretation. If this is the first time that you are interpreting a parameter source, you must first create it.

l Select 1= Create for each time you interpret a new parameter source.

l Select 2 = Update to change existing command parameters. You can modify many of the Transfer CFT parameters while CFT is running, but some configuration command changes cannot be applied dynamically. For more information, refer to the Transfer CFT online documentation.

If you select 1 Configuration interpretation, Transfer CFT displays following messages.

Table 2. View messages

CFTU20I CFT OS/400

CFTU20I Version 3.2.1 2015/03/15

CFTU20I (C) Copyright AXWAY 1989-2015

CFTU20I ====> Starting Session on 02/04/2013 Time is 09:28:19

CFTU20I

CFTU00I CFTFILE _ Correct (type=param,mode=create,fname=CFTPROD/PARM1) CFTU20I Number of Command(s) 1





CFTU20I

CFTU20I CFT OS/400

CFTU20I Version 3.0.1 2013/03/15



CFTU20I

CFTU00I CFTFILE _ Correct (type=part,mode=create,fname=CFTPROD/PART1 )






CFTU20I

CFTU20I CFT OS/400

CFTU20I Version 3.2.1 2015/03/15



CFTU20I Parameters file :+CFTPARM


3 Post-installation

CFTU20I

CFTU00I CFTPARM _ Correct (MODE=REPLACE,ID=IDPARM0,CAT=IDCAT0,COM=IDCOM0,LOG

=

CFTU00I IDLOG0,NET=TCP0,PROT=PESITANY,MAXTASK=4,TRANTASK=8

CFTU00I ,MAXTRANS=32,BUFSIZE=32000,KEY='£CFTPROD/KEY',DEF

CFTU00I AULT=IDFDEFT,PART=CFT400,WAITRESP=900,EXECSF='*LIB

CFTU00I L/CFTSRC(B_EXECSF)',EXECRF='*LIBL/CFTSRC(B_EXECRF)

CFTU00I ',PARTFNAM='+CFTPART')

CFTU00I CFTCAT _ Correct (MODE=REPLACE,ID=IDCAT0,FNAME='+CFTCAT',SHARE=NO,UP

CFTU00I DAT=0,WSCAN=1,ST=2,RT=2,SX=1,RX=1)

CFTU00I CFTCOM _ Correct (MODE=REPLACE,ID=IDCOM0,TYPE=FILE,NAME='+CFTCOM',WS

CFTU00I CAN=10)

CFTU00I CFTLOG _ Correct (MODE=REPLACE,ID=IDLOG0,FNAME='CFTPROD/LOG1',AFNAM

CFTU00I E='CFTPROD/ALOG1',MAXREC=15000,SWITCH=1300,EXEC=

'

CFTU00I *LIBL/CFTSRC(B_EXECLOG)',OPERMSG=255,NOTIFY='

CFTU00I ')

CFTU00I CFTNET _ Correct (MODE=REPLACE,ID=TCP0,MAXCNX=32,CALL=INOUT,TYPE=TCP

CFTU00I ,HOST=INADDR_ANY)

CFTU00I CFTPROT _ Correct (MODE=REPLACE,ID=PESITANY,NET=TCP0,TYPE=PESIT,PROF=

CFTU00I ANY,CONCAT=YES,SEGMENT=YES,MULTART=YES,SCOMP=0,RCO

CFTU00I MP=0,SCHKW=2,RCHKW=2,SPACING=512,RPACING=512,SAP=6

CFTU00I 5535,RRUSIZE=32000,SRUSIZE=32000,RTO=250,DISCTC=40

CFTU00I 0,DISCTD=200,DISCTR=10,DISCTS=400)

CFTU00I CFTPART _ Correct (MODE=REPLACE,ID=BOUCLE,NSPART=LOOP,NRPART=LOOP,PRO

CFTU00I T=PESITANY,SAP=65535,SYST='OS400')

CFTU00I CFTTCP _ Correct (MODE=REPLACE,ID=BOUCLE,CNXOUT=16,CNXIN=16,CNXINOUT

CFTU00I =16,HOST=127.0.0.1)

CFTU00I CFTPART _ Correct (MODE=REPLACE,ID=CIBLE,NSPART=AS400,NRPART=CIBLE,PR

CFTU00I OT=PESITANY,SAP=65531,SYST='OS400')

CFTU00I CFTTCP _ Correct (MODE=REPLACE,ID=CIBLE,CNXOUT=16,CNXIN=16,CNXINOUT=

CFTU00I 16,HOST=CIBLE)

CFTU00I CFTSEND _ Correct (MODE=REPLACE,ID=TSTIMPL,IMPL=YES,FNAME='QGPL/QAUOO

CFTU00I PT',EXEC='*LIBL/CFTSRC(B_EXECSIMP)',FCODE=EBCDIC)

CFTU00I CFTSEND _ Correct (MODE=REPLACE,ID=TSTNCOMP,IMPL=NO,FCODE=EBCDIC,NCOM

CFTU00I P=0)

CFTU00I CFTSEND _ Correct (MODE=REPLACE,ID=IDFDEFT,IMPL=NO,FCODE=EBCDIC)

CFTU00I CFTRECV _ Correct (MODE=REPLACE,ID=SRC400,FTYPE='S',FDISP=BOTH,FACTIO

CFTU00I N=ERASE,FCODE=EBCDIC,FRECFM='F',FNAME='CFTPROD/UT

CFTU00I IN(R_?PARM)')

CFTU00I CFTRECV _ Correct (MODE=REPLACE,ID=SRCFILE,FDISP=BOTH,FACTION=ERASE,F

CFTU00I CODE=EBCDIC,FRECFM='F',FNAME='CFTPROD/UTIN(R_?PAR

CFTU00I M)')

CFTU00I CFTRECV _ Correct (MODE=REPLACE,ID=COMMUT,FDISP=BOTH,FACTION=DELETE,F

CFTU00I CODE=BINARY,FRECFM='V',FSPACE=65535,FNAME='CFTPROD

CFTU00I P/R_?IDTU')

CFTU00I CFTRECV _ Correct (MODE=REPLACE,ID=IDFDEFT,FDISP=BOTH,FACTION=DELETE

,



CFTU00I FCODE=EBCDIC,FRECFM='F',FSPACE=65535,FNAME='CFTPROD

CFTU00I /R_?IDTU')

CFTU00I CFTRECV _ Correct (MODE=REPLACE,ID=SAVEFILE,FDISP=BOTH,FACTION=DELETE

CFTU00I ,FCODE=BINARY,FTYPE='Z',FNAME='CFTPROD/R_?IDTU')

CFTU00I RETURN _ Correct (CODE=0)





An interpretation is considered to be valid when all messages are displayed as Correct.

If an interpretation error is detected, modify the invalid parameter or parameter, and select 2 Repeat the interpretation. When you select 2 Repeat the interpretation, only messages concerning configuration commands are displayed.

Exits in Transfer CFT IseriesAs of Transfer CFT 3.1.3, you no longer require the OVRDBF command in exits scripts. The CFTUTIL, PKIUTIL, SECUTIL utilities automatically perform the needed OVRDBF action.


3 Post-installation

Viewing transfer messagesAfter depositing a transfer command, such as the loop-back test, the following messages are displayed.

ExampleSEND PART=LOOP,IDF=TEST,FNAME=CFTPROD/TEST

From . . . : CFT 04/02/15 17:12:45

CFTR12I SEND PART=LOOP IDF=TEST Treated for USER CFT

From . . . : CFT 04/02/15 17:12:45

+

From . . . : CFT 04/02/15 17:12:45

CFTS20I Communication file row number deleted: 00000030

From . . . : CFT 04/02/15 17:12:45

+

From . . . : CFT 04/02/15 17:12:46

CFTW09I PART=LOOP IDF=TEST IDT=D0217124 CFTSEND IDFDEFT NIDF=TEST

From . . . : CFT 04/02/15 17:12:46

+

From . . . : CFT 04/02/15 17:12:46

CFTT13I PART=LOOP IDF=TEST IDT=D0217124 _ Session parameters

From . . . : CFT 04/02/15 17:12:46

+ PROT=PESITANY SAP=65535 HOST=127.0.0.1

From . . . : CFT 04/02/15 17:12:46

CFTI34I PID=9 CFTTFIL Task started successfully

From . . . : CFT 04/02/15 17:12:47

CFTT53I PART=LOOP IDF=TEST IDT=D0217124 Requester file selected

From . . . : CFT 04/02/15 17:12:47

CFTT55I PART=LOOP IDF=TEST IDT=D0217124 Requester file opened

From . . . : CFT 04/02/15 17:12:47

CFTH56I PART=LOOP IDS=00003 PESIT Server session opened

pi7=02:00512

From . . . : CFT 04/02/15 17:12:47

CFTH56I PART=LOOP IDS=00002 PESIT Requester session opened

pi7=02:00512

From . . . : CFT 04/02/15 17:12:47

CFTW09I PART=LOOP IDF=TEST IDT=D0217124 CFTRECV IDFDEFT NIDF=TEST

From . . . : CFT 04/02/15 17:12:47

+

From . . . : CFT 04/02/15 17:12:47

CFTT53I PART=LOOP IDF=TEST IDT=D0217124 Server file created

From . . . : CFT 04/02/15 17:12:47

CFTT55I PART=LOOP IDF=TEST IDT=D0217124 Server file opened

From . . . : CFT 04/02/15 17:12:47


Viewing transfer messages

CFTT57I PART=LOOP IDF=TEST IDT=D0217124 Server transfer started

From . . . : CFT 04/02/15 17:12:47

CFTT57I PART=LOOP IDF=TEST IDT=D0217124 Requester transfer started

From . . . : CFT 04/02/15 17:12:47

CFTT58I PART=LOOP IDF=TEST IDT=D0217124 Server transfer ended

From . . . : CFT 04/02/15 17:12:47

CFTT58I PART=LOOP IDF=TEST IDT=D0217124 Requester transfer ended

From . . . : CFT 04/02/15 17:12:47

CFTT56I PART=LOOP IDF=TEST IDT=D0217124 Server file closed

From . . . : CFT 04/02/15 17:12:47

CFTH58I PART=LOOP IDS=00003 IDF=TEST NIDT=9317124 transfer

deselected

From . . . : CFT 04/02/15 17:12:47

+ T=400

From . . . : CFT 04/02/15 17:12:47

CFTT54I PART=LOOP IDF=TEST IDT=D0217124 Server file deselected

From . . . : CFT 04/02/15 17:12:47

CFTT88I+IDT=D0217124 WORKINGDIR= FNAME=CFTPROD/R_A000000L NBC=160

From . . . : CFT 04/02/15 17:12:47

CFTH58I PART=LOOP IDS=00002 IDF=TEST NIDT=9317124 transfer

deselected

From . . . : CFT 04/02/15 17:12:47

+ T=200

From . . . : CFT 04/02/15 17:12:47

CFTT56I PART=LOOP IDF=TEST IDT=D0217124 Requester file closed

From . . . : CFT 04/02/15 17:12:47

CFTT54I PART=LOOP IDF=TEST IDT=D0217124 Requester file deselected

From . . . : CFT 04/02/15 17:12:48

CFTT88I+IDT=D0217124 WORKINGDIR= FNAME=CFTPROD/TEST NBC=160

From . . . : CFT 04/02/15 17:12:48

CFTS03I PART=LOOP IDF=TEST IDT=D0217124 _ *LIBL/CFTSRC(B_EXECRF)

From . . . : CFT 04/02/15 17:12:48

+ executed

From . . . : CFT 04/02/15 17:12:50

CFTS03I PART=LOOP IDF=TEST IDT=D0217124 _ *LIBL/CFTSRC(B_EXECSF)

From . . . : CFT 04/02/15 17:12:50

+ executed

From . . . : CFT 04/02/15 17:12:50

CFTR17I END PART=LOOP IDF=* IDTU=A000000L In progress for USER

From . . . : CFT 04/02/15 17:12:50

+ CFT

From . . . : CFT 04/02/15 17:12:50

CFTR12I END PART=LOOP IDF=* IDTU=A000000L Treated for USER

CFT

From . . . : CFT 04/02/15 17:12:50

+

From . . . : CFT 04/02/15 17:12:50



3 Post-installation

From . . . : CFT 04/02/15 17:12:50

+

From . . . : CFT 04/02/15 17:12:50

CFTR12I SEND PART=LOOP IDM=REP Treated for USER CFT

From . . . : CFT 04/02/15 17:12:50

From . . . : CFT 04/02/15 17:12:50


From . . . : CFT 04/02/15 17:12:50

+

From . . . : CFT 04/02/15 17:12:50

CFTT13I PART=LOOP IDM=REP IDT=D0217125 _ Session parameters

From . . . : CFT 04/02/15 17:12:50

+ PROT=PESITANY SAP=65535 HOST=127.0.0.1

From . . . : CFT 04/02/15 17:12:50

CFTT59I PART=LOOP IDM=TEST IDT=D0217124 Server reply

transfered

From . . . : CFT 04/02/15 17:12:50

CFTH60I PART=LOOP IDS=00002 IDM=TEST NIDT=9317124 reply

transfered

From . . . : CFT 04/02/15 17:12:50

CFTT59I PART=LOOP IDM=REP IDT=D0217125 Requester reply

transfered

From . . . : CFT 04/02/15 17:12:50

CFTH62I+ REF=9317124.LOOP.LOOP.0.TEST..

From . . . : CFT 04/02/15 17:12:51

CFTR17I END PART=LOOP IDF=* IDTU=A000000K In progress for USER

From . . . : CFT 04/02/15 17:12:51

+ CFT

From . . . : CFT 04/02/15 17:12:51

CFTR12I END PART=LOOP IDF=* IDTU=A000000K Treated for USER

CFT

From . . . : CFT 04/02/15 17:12:51

+

From . . . : CFT 04/02/15 17:12:51


From . . . : CFT 04/02/15 17:12:51

Performance optimizationThis section describes how to modify the subsystems in which Transfer CFT is running to optimize the Transfer CFT performance.

The initial subsystem that Transfer CFT uses is created with a 2 GB pool size, and a maximum of 64 active threads. However it is not the maximum number of threads that impacts performance, but rather the number of threads that can use the processor. For this reason, we recommend that you modify this value for improved performance.


Performance optimization

PrerequisitesThe subsystem must be running to perform the following procedure. If your subsystem is not running, call the STRSBS command to start the subsystem.

Procedure Update the subsystem values as follows:

1. Enter the WRKSYSSTS command to display the existing system configuration for the subsystems that are currently running.

a. Press F11 to display the subsystem name and determine your specific Transfer CFT subsystem.

2. Modify the value:

a. Place the cursor in the Max Act field (Maximum Active), and enter the new value (10 in the example below).

b. Press Enter to confirm.

c. Press F5 to update the screen display.

How to determine the Max Act valuesTo determine the maximum active (Max Act) values, use the following formula:

16 + SSLMTASK + MAXTASK = <Max Act>

Where:

l 16 = any basic Transfer CFT task

l SSLMTASK = maximum number of SSL tasks

l MAXTASK = maximum number of CFTFIL tasks

If you are using multinode, multiply the sum by the total number of nodes.


3 Post-installation

Starting Transfer CFT in batch modeThe CFTSTART program is used to start Transfer CFT IBM i without any required user action.

CFTSTART comprises:

ADDLIBLE LIB(CFTPGM) POSITION(*FIRST)

ADDLIBLE LIB(CFTPROD) POSITION(*FIRST)

CALL PGM(CFTSTART)

RMVLIBLE LIB(CFTPGM)

RMVLIBLE LIB(CFTPROD)


4 Working with files and encoding

The topics in this section describe parameters with IBM i specific functioning, as well as parameter mapping and configuration examples when applicable.

Using native file typesThis section describes the types of native files types that can be used:

l In a CFTSEND command according to the type of data to be sent

l In a CFTRECV command, according to the types of files to be received on an IBM i system

l As backup files


../../../../../Content/ibm_i/operations/file_types/Send_mode.htm

../../../../../Content/ibm_i/operations/file_types/Receive_mode.htm

../../../../../Content/ibm_i/operations/file_types/Backup_files.htm


Configure send mode (native)

Native file type definitionsThe following table lists the different types of files that can be used according to the type of data to be sent.

Note Bold values indicate a recommended combination. For example, when FTYPE=D and FRECFM=V then RCDLEN-5 is the recommended PF-DTA with variable data.

FTYPE FRECFM PF-DTAFixed data

PF-DTAVariable data

PF-SRC SAVF

FRECFL FRECFL FRECFL

‘D’ ‘F’ RCDLEN RCDLEN 1 RCDLEN 528

‘V’ RCDLEN RCDLEN-5 2 RCDLEN 528

‘S’ ‘F’ RCDLEN RCDLEN 1 RCDLEN ErrorDIAGI: 102DIAGP: 1140850696

‘V’ RCDLEN RCDLEN-5 2 RCDLEN ErrorDIAGI: 102DIAGP: 1140850696

‘E’ ‘F’ RCDLEN RCDLEN 1 RCDLEN-12 3

ErrorDIAGI: 102DIAGP: 1140850696

‘V’ RCDLEN RCDLEN-5 2 RCDLEN-12 3 ErrorDIAGI: 102DIAGP: 1140850696



‘Z’

‘F’ ErrorDIAGI: 102DIAGP: 1140850696



528

‘V’ ErrorDIAGI: 102DIAGP: 1140850696



528

Key

1 Truncates the 5 bytes variable header, preserving the original record length.

2 Truncates the 5 bytes variable header, adjusting the record length accordingly.

3 Truncates the 12 bytes, adjusting the record length accordingly.

Default FTYPE or FRECFM value

The behavior of the values ‘’ and ‘ ’, for FTYPE and FRECFM respectively, are not detailed in the following table. These values correspond to undefined, meaning that the transfer in emission takes the value of both the file type and the member content.

FTYPE FRECFM Supported files and data organizations (if applicable).

‘D’ ‘F’ PF-DTA Member containing fixed data

‘D’ ‘V’ PF-DTA Member containing variable data

‘D’ ‘F’ PF-SRC

‘Z’ ‘F’ SAVF



Configure receive mode (native)

File typeThe behavior of the values ‘’ and ‘ ’, for FTYPE and FRECFM respectively, are not detailed in the following tables. These values correspond to undefined, which means that the transfer in reception takes the value sent through the network.

File type when the file does not exist

The following table lists the different types of files that can be created on an IBM i system if the file to receive does not already exist:

FTYPE FRECFM Created file

Type Max record length

‘D’ ‘F’ PF-DTA FLRECL

‘V’ PF-DTA FLRECL + 5 bytes 1

‘S’ ‘F’ PF-SRC FLRECL

‘V’ PF-SRC FLRECL

‘E’ ‘F’ PF-SRC FLRECL +12 bytes 2

‘V’ PF-SRC FLRECL +12 bytes 2

‘Z’ - SAVF NA

File type when the file already exists

The following table describes the Transfer CFT IBM i behavior when trying to receive data in an existing file on the native side of an IBM i system.

Note Bold values indicate a recommended combination. For example, when FTYPE=D and FRECFM=V then FLRECL+5 / 5 is the recommended PF-SRC.



FTYPE FRECFM

Existing file

PF-DTA

Record length / member header

PF-SRC

Record length / member header

Overwriting on a SAVF

with FACTION=ERASE

‘D’ ‘F’ FLRECL / No FLRECL / No Yes 3

‘V’ FLRECL+5 / 5 FLRECL+5 / 5 Yes 3

‘S’

‘F’ FLRECL / 0 OK FLRECL / 12 ErrorDIAGI: 102DIAGP: 1140850696

‘V’ FLRECL+17 / 17 FLRECL+17 / 17 ErrorDIAGI: 102DIAGP: 1140850696

‘E’ ‘F’ FLRECL +12 / 0 FLRECL +12 / 12


‘V’ FLRECL+17 /17

FLRECL+17 / 5 ErrorDIAGI: 102DIAGP: 1140850696

‘Z’ - ErrorDIAGI: 102DIAGP: 1140850696


Yes 3

1 The file is created with a record length corresponding to the record length of the original file, plus 5 bytes corresponding to five header bytes in each record. These 5 bytes indicate the length of useful data.

2 The file is created with a record length corresponding to the record length of the original file, plus 12 bytes corresponding to five header bytes in each record. These 12 bytes indicate the date and the sequence number.

3 You must set FACTION to ERASE for the transfer. Otherwise, the transfer fails to overwrite the existing file, and ends in error.



Backup files The records in this type of file (SAVF) have a specific format. They contain backed-up sequencing and parity data controlled byTransfer CFT IBM i. SAVF files can generally only be used on Transfer CFT IBM i systems. Consequently, backup files are predominantly transferred between two Transfer CFT IBM i partners.

Another system can be used as an intermediate partner, in which it must process the SAVF file as a sequential file with a fixed format and a length of 528 (bytes).

Implementing SAVF file supportThe value Z for the CFTSEND / CFTRECV command FTYPE parameter designates SAVF files. It is mandatory in receive mode (CFTRECV) and optional in send mode (CFTSEND).

The only variable property of an SAVF file is its allocation size in Kilobytes (FSPACE parameter). FSPACE must be between 1 and 65535.

The configuration of the other properties (FORG, FRECFM, FLRECL and so on) is ignored. Consequently, they do not need to be specified in the CFTSEND / CFTRECV commands. However, if FLRECL is specified, it must be set to 528 (bytes).

The SAVF file access method, implemented in Transfer CFT Transfer CFT IBM i, does not support synchronization points in write mode. This mechanism is however supported in read mode. Consequently, a SAVF file transfer with a receiver Transfer CFT IBM i system will fail during a restart (abort on the receiver side). If the file is sent to a non-Transfer CFT IBM i (intermediate) system, resynchronization (restart points) can be performed in read mode with the sender Transfer CFT Transfer CFT IBM i.

Using spool filesIn addition to the possibilities available in the SNDCFTSPLF interactive command (see OS-Integrated Commands), spool files can be used in batch mode or in the Transfer CFT configuration.

The syntax is as follows:

SEND FNAME = Spool file/File n°/Job/Job n°, PART ...

Example:

SEND FNAME = QPRINT/2/CFTLOG/074556, IDF = SPLF, PART ...

You can transfer spool files from an IBM i system to any other system.The receive file is a fixed format sequential file. To use it as a spool file on a receiver IBM i system, you can add the commands in the following example to a receive procedure:

OVRPRTF FILE(QPRINT) CTLCHAR(*FCFC)CPYF FROM FILE(CFTPROD/R_SPLF) TO FILE (QPRINT)

The Qprint file is an exact copy of the initial spool file.



Using IFS hierachial files This topic describes the Integrated File System, IFS, functions available in Transfer CFT Transfer CFT IBM i.

It includes:

l Configure send mode (IFS)

l Configure receive mode (IFS)

l Copyfile (IFS)

See also IFS access error codes.

IFS overviewThe IFS provides a common interface to another system on the IBM i. After installing Transfer CFTTransfer CFT IBM i you can:

l Transfer IFS files

l Receive and store IFS files

l Copy IFS files to a native Transfer CFT IBM i system and vice versa (using CFTUTIL COPYFILE)

Naming conventionsRespect the following naming conventions:

l The file name must be prefixed by the slash character /

o For example: /home/filename

l You cannot replace environmental variables in the file name

o For example: $HOME/filename is not a recognized filename

l You cannot precede filenames by a relative path

o For example: ../filename is not a recognized filename

Encoding IFS dataIFS file data can be in an ASCII, EBCDIC, or BINARY format. The CCSID, Code Character Set Identifier, associated with the file determines the encoding for the data.

l Transfer CFT can read and write IFS files in these three formats: ASCII, EBCDIC, or BINARY. When using the ASCII or EBCDIC formats, the data translation for a Transfer CFT transfer, if necessary, is managed by the Transfer CFT translation tables (CFTXLATE).

l When Transfer CFT receives an IFS file, the CCSID for the file is set by default. This identifier is set to the Transfer CFT Transfer CFT IBM i job CCSID value.


../../../../../Content/ibm_i/operations/customize/ifs/send_files_ifs.htm

../../../../../Content/ibm_i/operations/customize/ifs/receive_files_ifs.htm

../../../../../Content/ibm_i/operations/customize/ifs/IFS_copyfile.htm

../../../../../Content/ibm_i/operations/customize/ifs/IFS_access_errors.htm


l The CFTRECV (or RECV) command FCODE=ASCII parameter creates an ASCII file with an associated CCSID code value of 819 (ISO 8859-1 common use default Internet code).

IFS file rights and authorizationsIn an Transfer CFT IBM i environment, files are subject to two types of control, data authorities and object authorities.

By default the Transfer CFT users and other general users are given the following:

l The RWX options for data authority

l The OBJMGT, OBJEXIST, OBJALTER and OBJREF options for object authority

The minimum IFS data authorities required to perform transfers with any user are:

l RX: readable and executable permission for any object in the IFS directory

l RWX: readable, writable and executable permission for any object in the IFS directory



Configure send mode on IFS

File typesThe following table lists the different types of files that can be used according to the type of data to be sent when using IFS.

Note The FRECFM possibilities for all FTYPE are: ‘V’, ‘F’, and ‘ ’ .

FTYPE Type of sent file

‘S’ Text

‘D’ , ‘ ’ Text

‘E’ Text

‘Z’ Binary

‘J’ Stream text is an alternative way to transfer a text file. Every line of a file must end with an LF or CR/LF. However, during a transfer the CR/LF are changed to LFs. This enables a quicker reading, and a faster transfer. 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.

Note This transfer mode is not available for native side transfers.

Key

When sending a file from the part of an IBM i machine in text mode, the file is expected to be a standard text file. This means that every line of the file to transfer is finished either by a LF, either by a CR/LF. If not, the file is considered to be binary and Transfer CFT cannot read it. Use the binary mode to allow it to be transferred.

Sending a group of IFS files

Send using a generic nameThis section describes how to send a group of files using a send command where there is one transfer per file.

When defining the filename, you must put a <file-symb> character (system-specific) before the FNAME parameter value. Transfer CFT IBM i environments use the ‘#’ and ‘£’ symbols.

Use one of the following commands to send a group of files using a generic name:

SEND FNAME=#path_name/wildcards



Or:

CFTSEND FNAME=#path_name/wildcards

The FNAME parameter is set to a generic name that includes wildcard characters. In this type of send, only the selected files are sent.

A receiving Transfer CFT can specify the name of each file received via the symbolic variables:

l ?FPATH the file path of the sending file, and

l ?FROOT the file name of the sending file

Example

l CFTSEND

FNAME = “#/home/send/FIC*.*”, FRECVFM = V

l CFTRECV

FNAME = “/home/recv/?FROOT”,

FRECVFM = V

Send using an IFS file that contains a list of filesThese rules apply to the structure of the file containing a list of files:

l A record can contain only one file name

l Each file name must be listed in the first column

l The file names must be written in EBCDIC

Example

Enter:

CFTSEND FNAME = “#/home/send/FICLIST”, FRECVFM = V

If the file FICLIST contains the following lists:

l /home/send/FIC1

l /home/send/FIC2

l /home/send/FIC3

Then the files FIC1, FIC2 and FIC3 are sent.



Configure receive mode for files (IFS)

File typesThe following table lists the different types of files that can be received on an IBM i system when using IFS.

Note The FRECFM possibilities for all FTYPE are: ‘V’, ‘F’, and ‘ ’ .

FTYPE Type of sent file

‘S’ Text

‘D’ , ‘ ’ Text

‘E’ Text

‘Z’ Binary

‘J’ Stream text is an alternative way to transfer a text file. Every line of a file must end with an LF or CR/LF. However, during a transfer the CR/LF are changed to LFs. This enables a quicker reading, and a faster transfer. 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.

Note This transfer mode is not available for native side transfers.

Key

If your partner sends a PF-SRC file to be received on IFS, the content is slightly different depending on if you use the FTYPE ‘S’ or ‘E’. With the FTYPE ‘E‘, the content of the file is only the original content of the PF-SRC file. When the FTYPE is ‘S’, the content is the original content of the PF-SRC file along with the record character in the header line.

When sending a file from the part of an IBM i machine in text mode, the file is expected to be a standard text file. This means that every line of the file to transfer is finished either by a LF, either by a CR/LF. If not, the file is considered to be binary and Transfer CFT cannot read it. Use the binary mode to allow it to be transferred.



Conversion tables This section describes how to use a conversion table in Transfer CFT Transfer CFT IBM i in the following sections:

l Using a conversion table

l Configuration sample

Using conversion tablesDuring Transfer CFT operations conversion problems may occur when:

l A file to be transferred contains various special characters: |, !, \, ̀ , #, ~, [, ], ̂ , {, }, /, $ and £

l The transfer is performed between two heterogeneous systems with different character sets (CCSID) and the default conversion fails.

l The transfer is performed between international sites.

Default valuesThe default EBCDIC character set used by Transfer CFT has code 297 (EBCDIC France).

The default ASCII character set used by Transfer CFT is not fully compatible with code 850 (IBM multilingual personal computer). For more information refer to the Transfer CFT User Guide. ADD LINK

Consequently, two files supplied in the production library are used to enter and create a conversion table in Transfer CFT:

l TABEBAS: file to be used to convert EBCDIC into ASCII (generally for send operations)

l TABASEB: file to be used to convert ASCII into EBCDIC (generally for receive operations)

These two files can be modified by DFU (Option 18 in PDM - Member Management).

Creating the conversion tableTo create the actual conversion table, you must run the make_tcd.c utility program after modifying the characters at fault: call make_tcd.c parm('CFTPROD/tabaseb')

The CFTPROD/tabaseb.x binary file is created: it constitutes the conversion table to be specified in the Transfer CFT configuration. The same applies to tabebas.x.



Configuration sampleThe following is a full Transfer CFT Transfer CFT IBM i configuration sample for a Windows system, which is a typical and frequent scenario.

Transfer CFT IBM i configuration

CFTXLATE MODE=REPLACE,

ID=TABASEB,

DIRECT=RECV,

FNAME=CFTPROD/TABASEB.X

CFTXLATE MODE=REPLACE,

ID=TABEBAS,

DIRECT=SEND,

FNAME=CFTPROD/TABEBAS.X

CFTSEND MODE=REPLACE, ID=……..,

XLATE=TABEBAS,

…………………….

CFTRECV MODE=REPLACE, ID=………,

XLATE=TABASEB,

…………………….

Transfer CFT WIN/NT configuration

============

cftrecv id = …………,

fcode = binary, /* to avoid needing conversion */

…………………

cftsend id = …………,

fcode = binary, /* to avoid needing conversion */

………………….



Extended character set mappingCharacter transcoding defines how data are encoded during the transfer process. This is important when transferring files that do not have the same coding requirements on the sending and receiving systems. See the section Character set transcoding in the Transfer CFT User Guide for more information.

NCHARSET and FCHARSET parameter mappingThe following table shows the mapping for the IBM i (OS/400) platform when using the NCHARSET and FCHARSET parameters.

CFT_ charset IBM i

CFT_UTF-8 01208

CFT_UTF-16 01204

CFT_UTF-16LE 01202

CFT_UTF-16BE 01200

CFT_UTF-32 01236

CFT_UTF-32BE 01232

CFT_UCS-2 N/A

CFT_CP850 00850

CFT_BIG5 00947

CFT_ISO8859-1 00819

CFT_ISO8859-15 00923

CFT_EBCDIC-FR 00297


5 Create an Express Package

A product deployment package in Transfer CFT is called an Express Package. For the iSeries platform, you can create a deployment package for Transfer CFTs to be used with Central Governance, or for standalone Transfer CFTs.

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

Create a deployment package for Transfer CFTs used with Central Governance

Perform the following steps:

1. Create a user profile using the command: CRTUSRPRF

2. Create a temporary library, for example:

CRTLIB CFTTMP

3. Create a save file (*SAVF) in the CFTTMP library, for example:

CRTSAVF FILE(CFTTMP/CFT32XL) TEXT('Transfer CFT Distribution save file')

4. Use FTP in binary mode to send the save file to an iSeries system. Open an FTP session, and enter:

Set Transfer Mode to bin

cd CFTTMP

put Transfer_CFT_os400.bin CFT32XL

quit

5. Restore the Transfer CFT save file, for example:

RSTLIB SAVLIB(CFTPG) DEV(*SAVF) SAVF(CFTTMP/CFT32XL) RSTLIB(CFTTMP)

6. Install a Transfer CFT 3.2.4 with Central Governance (you must use this command for all iSeries Transfer CFT deployments).



See the example and options described in the INSTALL section and customize to suit your business needs. Details on Silent installation on page 22.

Note If you want to add or modify the installation parameters, you must run the INSTALL command after selecting F4. Answer the prompted questions to configure the product for your production. At the end of your first installation, press F9 to execute the recall command. This command must be used for all your deployments.

7. Use Central Governance to deploy and configure your Transfer CFTs as needed.

Create a Transfer CFT deployment package for standalone usage

In this procedure, you must first create a SAVF file that contains all of your necessary configurations for your deployment including:

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 instead uses 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 Sentinel, PassPort, etc.



ProcedureOn the local machine where you have Transfer CFT installed:

1. Create a temporary library that will contain all the items you want to deploy, for example:

CRTLIB CFTCONF

2. Copy all the configuration elements you want to deploy into this library, for example:

CPYF FROMFILE(CFTPROD/UTIN) TOFILE(CFTCONF/UTIN) FROMMBR

(CGPARAM) TOMBR(TCPPARAM)

3. Create a backup for your library CFTCONF, for example:

1. CRTSAVF FILE(CFTCONF/CFTCONFSVF)

2. SAVLIB LIB(CFTCONF) DEV(*SAVF) SAVF(CFTCONF/CFTCONFSVF)

3. Get the CFTCONFSVF.savf (in binary mode)

On the other machines, where you want to deploy Transfer CFT:

1. Create a temporary library, for example:

CRTLIB CFTTMP

2. Create two save file (*SAVF) in the CFTTMP library, for example:

1. CRTSAVF FILE(CFTTMP/CFT32XL) TEXT('Transfer CFT Distribution')

2. CRTSAVF FILE(CFTTMP/CFTCONFSVF) TEXT('CFT configuration')

3. Use FTP in binary mode to send the save file to an Iserie system. Open an FTP session, and enter:

Set Transfer Mode to bin

cd CFTTMP

put Transfer_CFT_os400.bin CFT32XL (SAVF with Transfer CFT)

put CFTCONFSVF.savf CFTCONFSVF (SAVF with CFT configuration)

quit

4. Restore the Transfer CFT save file, for example:

RSTLIB SAVLIB(CFTPG) DEV(*SAVF) SAVF(CFTTMP/CFT32XL) RSTLIB

(CFTTMP)

5. Installing a Transfer CFT 3.2.4 without Central Governance

INSTALL



Note When you run INSTALL without parameters, you run the default installation with the CFTPGM and CFTPROD libraries.

Note As of Transfer CFT 3.3.2, you can define the user for the Transfer CFT installation. This user can be different from the current user. From the INSTALL command, select F4 (Prompt) and modify the USERINST value. This user must exist on the machine; if it does not, you can use the CRTUSRPRF command to create it.

6. Restore the Transfer CFT configuration save file, for example:

RSTLIB SAVLIB(CFTCONF) DEV(*SAVF) SAVF(CFTTMP/CFTCONFSVF)

RSTLIB(CFTPROD)

7. Apply your configuration to your new environment, for example:

1. CFTUTIL PARAM('#CFTPROD/<CFTCONF>)

2. PKIUTIL PARAM('#CFTPROD/<PKICONF>')

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

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


6 Update, upgrade, or migrate

This section describes how to update, upgrade, or migrate to Transfer CFT 3.7.

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.

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

This mode has the following advantages:

l Allows you to update in the same location

l You can perform this upgrade yet still revert to the previous state if needed

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

About migrationsA migration means that an initial Transfer CFT is installed in a directory that is not removed or overwritten by the procedure.


l The new installation occurs in a new location, and the existing configuration in the existing Transfer CFT environment is not affected.

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

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

This mode has the following restriction:

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



About manual migrationsThe manual migration procedure, used to migrate an existing Transfer CFT to Transfer CFT 3.7, is described in this document.

The general procedure for migrating from a previous version of Transfer CFT to Transfer CFT 3.7 is:

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


l Because it is manual, you can customize as needed.

l You can migrate from versions older than version 2.7.x.

Prerequisites

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

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 UI server. (I.e., you must stop all cluster nodes as a database migration occurs when performing an upgrade.)

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

l For details on how to apply or update a license key, and the new license key location, see the section Apply a license key.

Note You require as many keys as instances of Transfer CFT IBM i running at same time. For example, two Transfer CFT instances cannot run at the same time, on the same server, using the same license key.


Prior to upgrading with a service pack

Prior to upgrading with a service packUpgrading Transfer CFT by applying a new service pack can overwrite your Transfer CFT program and production library. Therefore, as a precaution, prior to upgrading you must:

l Copy the existing Transfer CFT program library, for example CFTPGM in CFTPGM.O.

l Copy the existing Transfer CFT production library, for example CFTPROD in CFTPROD.O.

The CFTPROD library contains your personal data and should not be cleared. Data may include:

l Files, the UCONF file, Transfer CFT batch procedures, system objects (*datara,*jobd, *sbsd,*cls,*jobq, etc.)

l Scripts, procedures, files used by the Transfer CFT Enabler OS/400 Connector

l Internal Access Management files

Note The libraries CFTPGM.O and CFTPROD.O enable a synchronized and rapid Transfer CFT restart if required.

Register with Central Governance If you intend to implement Central Governance, please refer to the Transfer CFT User's Guide > Register with Central Governance page for registration details.


https://docs.axway.com/bundle/TransferCFT_36_UsersGuide_allOS_en_HTML5/page/Content/cft_installation/migrate/register_CG.htm


Apply a service pack or patchThis section describes how to apply a patch or Service Pack to Transfer CFT in an IBM i environment.

Display informationUse the CFTUTIL ABOUT command to display the product information, including the service pack number and patch number.

Results

CFT information :

* product = CFT/OS400

* version = 3.2.4

* level = SP0_P1

* upgrade = 8668000

* target = os400

Update with a service packTo apply a service pack:

1. Log in as the CFT user (user with rights to manage and use Transfer CFT).

2. Stop Transfer CFT.

3. Log in as the CFTINST user (user with *ALLOBJ rights).

4. Create a SAVF on your IBM i system.

5. Upload the Transfer_CFT_3.2.x_SPx_os400.bin (in binary mode) to the SAVF you created in Step 2.

6. Restore the SAVF to a temporary library, add it to your library list, and then launch the UPDATE command.

Note The program library CFTPGM is cleared, and you are asked if the production library CFTPROD should be cleared.

7. Complete the required fields:

l In the first field, enter your program library.

l In the second field, enter your production library.

l In the third field, enter the name of the SAVF where the backup of your current version is stored.

l The SAVF must be in your production library. If there is no SAVF, it is created.

CFT Update (UPDATE)



Apply a service pack or patch

Silent Installation . . . . . . > 1:Yes/2:No

CFT Program library . . . . . . > CFTPGM Name

CFT Production library . . . . . > CFTPROD Name

SAVF name for current version . > CFTSAVF Name

l Press Enter to continue.

Use the CFTUTIL ABOUT command to check the service pack level.

Results, for example, after applying SP4:

CFT information :


* version = 3.2.4

* level = SP4

* upgrade = 8712000

* target = os400

Note You should keep the save file where the previous version was saved (for example, in CFTSAVF), in case you need to uninstall the service pack.

Note

When you install a service pack, the contents of the home directory are updated, but the runtime directory remains untouched. This is so that your customizations, such as APIs, are not overwritten.

Apply a patch 1. Stop Transfer CFT.

2. Create a SAVF on your IBM i system.

3. Upload the Transfer_CFT-SPx_Patchz_os400.bin (in binary mode) to the SAVF you created in Step 2.

4. Restore the SAVF to a temporary library, add it to the top of your library list, and then launch the PATCHER command.

5. Complete the required fields:

l In the first field, enter your CFT program library.

l In the second field, enter the name of the SAVF where the backup of current

Module versions impacted by the patch are stored. If the SAVF does not exist, it is created; if it exists, it is cleared.

Install Transfer CFT patch (PATCHER)


Program library . . . . . . . . CFTPGM Character value

SAVF for backup . . . . . . . . PATCHSAV Character value



Results

Use the CFTUTIL ABOUT command to check the patch level.

Results, for example, after applying SP2_Patch2:

CFT information :


* version = 3.2.4

* level = SP2_Patch2

* upgrade = 8712000

* target = os400

Uninstall a service pack or patch

Uninstall a service pack When you apply a service pack, a backup of your previous version is saved in a SAVF object (named, for example, SPXSAV). This SAVF is located in your production library. You can use the UNINSTALL command, delivered in the program library, to uninstall a service pack and roll back to the previous version.

Follow these steps to uninstall a service pack:

1. Stop Transfer CFT and Copilot.

2. Call the UNINSTALL command, press F4, and complete the following fields:

CFT Uninstall (UNINSTALL)


Silent installation . . . . . . '2' 1:Yes/2:No

CFT Program library . . . . . . CFTPGM Name

CFT Production library . . . . . CFTPROD Name

SAVF name of previous version . SPXSAV Name

Where:

o Parameter 1: Name of your program library

o Parameter 2: Name of your production library

o Parameter 3: Name of the SAVF where you saved your previous library when you updated Transfer CFT

3. Press Enter. The patch or service pack is removed, and you are returned to the previous version.

Note As with other Transfer CFT commands, ensure that your program library (CFTPGM) and production library are present in your EDTLIBL before calling the UNINSTALL command.


Upgrade Transfer CFT IBM i

Uninstall a patchWhen you apply a patch, a backup of your previous version is saved in a SAVF object (for example, PATCHSAV). This SAVF file is located in your program library.

If you need to uninstall a patch, please restore the previous SAVF to your CFT program library (PATCHSAV by default).

Example

RSTOBJ OBJ(*ALL) SAVLIB(CFTPGM) DEV(*SAVF) OBJTYPE(*ALL) SAVF

(CFTPGM/PATCHSAV) OPTION(*ALL) RSTLIB(CFTPGM)

Upgrade Transfer CFT IBM iThis page describes two upgrade procedures for Transfer CFT 3.7 IBM i. The automatic upgrade procedure requires fewer user inputs than the manual procedure, and is the procedure of choice. This upgrade procedure enables you to change the version of an installed Transfer CFT to a more recent version while conserving its current configuration. Additionally, you can use the rollback feature if a situation arises where you need to return to a previous version.

Note The UPGRADE procedure delivered in the installation package performs the same steps as those described in the manual upgrade procedure. However, we strongly recommend using the automatic upgrade procedure instead of the manual upgrade.

Tip CFTPGM is the standard name for the program library, and CFTPROD is the standard name for the library where the configuration files are usually located.

Before you startBefore beginning the upgrade procedure:

l Check that you can access the Transfer CFT upgrade pack available for download from Axway at support.axway.com.

l Stop the Transfer CFT server and the Transfer CFT Copilot (UI) server. Enter:

CFTSTOP

COPSTOP

Optionally, you can use the display command to check the version or product details prior to upgrading.

CFTUTIL about


#



Automatic upgrade procedure

Uploading the installation packageStart the UPGRADE process by uploading the Transfer CFT installation package in binary mode to the IBM i system:


2. Create a temporary library: CRTLIB CFTTMP

3. Create a SAVF file: CRTSAVF FILE(CFTTMP/CFT37)


binary

cd CFTTMP


5. Restore the SAVF file in the temporary library:


RSTLIB(CFTTMP)

6. After restoring the SAVF, you must add the library name in the first position of the library list for the user profile. Execute the command:


Note The user performing the upgrade requires the same rights as for a regular installation or update (*JOBCTL, *SPLCTL, and *ALLOBJ).

Executing the UPGRADE commandEnter the UPGRADE command and press F4 to display the Transfer CFT IBM i installation screen.

UPGRADE CFT (UPGRADE)

Extract lib for the CFT . . . . CFTEXTLIB __________

CFT Program Library . . . . . . CFTPGM __________

CFT Production Library . . . . . CFTPROD __________

Are you rolling back? . . . . . .ROLLBACK '2'

The following fields are mandatory; you should complete as per your system details:

l CFTEXTLIB: Enter the name of the temporary library used to process the upgrade. This can be existing or non-existent library, but its content is cleared during the process.

l CFTPGM: Enter the name of the library containing the binaries of your Transfer CFT to upgrade.



l CFTPROD: Enter the name of the library containing the working files of your Transfer CFT to upgrade.

l ROLLBACK: '1': Enables the rollback mode (YES). ‘2’: Indicates that you are NOT rolling back to a previous Transfer CFT version (NO).

l SAVF: This field only displays when you enter '1' in the ROLLBACK field. In this case, enter the name of the SAVF for the version you want to apply. The default value is the name of SAVF for the version that you downloaded. See Rolling back an upgrade for details.

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

CFTUTIL about

About the UPGRADE commandRunning the UPGRADE command:

1. Creates a temporary library.

2. Extracts your configuration, COM file, CAT file into this temporary library.

3. Saves your IFS directories by moving them to new directories having the same name but which are suffixed by “_save”.

4. Saves your Transfer CFT libraries in the SAVF located in the temporary lib.

5. Replaces the binaries in your CFTPGM libraries by those of the new Transfer CFT version.

6. Replaces your IFS directories by those of the new Transfer CFT version.

7. Imports your configuration into your upgraded Transfer CFT.

As a result, your Transfer CFT binaries are upgraded, but their location is conserved.

Upgrading multi-node installationsThe UPGRADE procedure supports multi-node configurations, where your configuration remains strictly the same.

About IASP installationsThe procedure supports the upgrade of Transfer CFT installed on an IASP. The process remains the same, the UPGRADE procedure itself detects if the Transfer CFT is an installation on ASP, and then keeps the Transfer CFT in the same ASP.



Note The UPGRADE procedure does not support the upgrade from a non-IASP CFT to an IASP Transfer CFT or vice versa. In the same spirit, an upgrade from one type of IASP to another is not supported.

Manual upgrade procedureThis section explains how to upgrade an existing Transfer CFT IBM i from 2.7.1, 3.0.1, 3.1.3, 3.3.2, 3.4, or 3.5 to Transfer CFT 3.7 for either a single installation or a multi-node installation.

Manually upgrade a single installationThe manual upgrade procedure is similar to the migration procedure.

1. Load the former Transfer CFT CFT 2.7.1, 3.0.1, or 3.1.3 environment.

2. Stop Transfer CFT.

3. Create a backup library to save your configuration:

CRTLIB LIB(CFTUPGLIB)

4. Export your configuration.

l Export your static configuration objects using the command CFTUTIL CFTEXT:

CALL PGM(CFTUTIL) PARM(‘CFTEXT’ ‘type=all,

fout=CFTUPGLIB/EXTCONF’)

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

CALL PGM(PKIUTIL) PARM(‘PKIEXT’ ‘fout=CFTUPGLIB/EXTPKI’)

l Export the catalog using the CFTMI command. Enter:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=CAT, direct=FROMCAT,

ifname=CFTPROD/CAT, ofname=CFTUPGLIB/EXTCAT’)

l Export the communication media file using the CFTMI command:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=COM, direct=FROMCOM,

ifname=CFTPROD/COM, ofname=CFTUPGLIB/EXTCOM’)

l Additionally, you must export any procedures that are specific to your production, sample APIs, exits, and execs to your backup library.

5. Rename the INSTALL directory, the RUNTIME directory, and the Transfer CFT libraries.

STRQSH CMD('mv /home/cft/install /home/cft/install_save')



STRQSH CMD('mv /home/cft/runtime /home/cft/runtime_save')

RNMOBJ OBJ(QSYS/CFTPROD) OBJTYPE(*LIB) NEWOBJ(CFTPRODSAV)

RNMOBJ OBJ(QSYS/CFTPGM) OBJTYPE(*LIB) NEWOBJ(CFTPGMSAV)

6. You can now install the new Transfer CFT version. See About the INSTALL command on page 20.

7. Import the configuration.

l Import your static configuration objects using the command:

CFTINIT FILES('CFTUPGLIB/EXTCONF')

l Import your PKI certificates using the PKIUTIL command:

CALL PGM(PKIUTIL) PARM('PKIFILE' 'fname=CFTPROD/PKIBASE, mode=CREATE')

PKIUTIL LIBRARY(EXTLIB) FILE(EXTPKI) MEMBER(EXTPKI)

l Import the catalog using the CFTMI command:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=CAT, direct=TOCAT,

ifname=CFTUPGLIB/EXTCAT, ofname=CFTPROD/CAT’)

l Import the communication media file using the CFTMI command:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=COM, direct=TOCOM,

ifname=CFTUPGLIB/EXTCOM, ofname=CFTPROD/COM’)

l Import specific procedures to your production, for example APIs, EXITs, and execs from the CFTUPGLIB backup library.

Note You must recompile these after upgrading.

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

CFTUTIL about

Manually upgrade a Transfer CFT 2.7.1, 3.0.1, or 3.1.3 multi-node installationThe multi-node procedure is similar to the single instance upgrade procedure. However, when exporting CAT and COM, you must export your configuration for each node.

1. Load the former Transfer CFT 2.7.1, 3.0.1, or 3.1.3 environment.

2. Stop Transfer CFT IBM i.



3. Create a temporary library for your exported configuration:

CRTLIB LIB(CFTUPGLIB)

4. Export your configuration.

l Export your static configuration objects using the command:

CALL PGM(CFTUTIL) PARM(‘CFTEXT’ ‘type=all,

fout=CFTUPGLIB/EXTCONF’)

l Export your PKI certificates using the PKIUTIL PKIEXT command:

CALL PGM(PKIUTIL) PARM(‘PKIEXT’ ‘fout=CFTUPGLIB/EXTPKI’)

l Export the catalog using the CFTMI command:

CFTMI MIGR type=CAT, direct=FROMCAT, ifname=<catalog_filename_

former_cft_for_node_<node>>, ofname=catalog_output_<node>.xml

l Export the communication media file using the command:

o For each communication media file, enter:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=CAT, direct=FROMCAT,

ifname=CFTPROD/CAT, ofname=CFTUPGLIB/EXTCAT’)

o For each node, enter:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=COM, direct=FROMCOM,

ifname=CFTPROD/COM<nodenumber>,

ofname=CFTUPGLIB/EXTCOM<nodenumber>’)l

l You must also export any procedures that are specific to your production, such as APIs, exits, execs, etc. (Copy your API, exit sources, exec, and specific scripts.)

5. Change the hostname for each Transfer CFT. Rename the INSTALL and RUNTIME directories, and the Transfer CFT libraries:

STRQSH CMD('mv /home/cft/install /home/cft/install_save')

STRQSH CMD('mv /home/cft/runtime /home/cft/runtime_save')

RNMOBJ OBJ(QSYS/CFTPROD) OBJTYPE(*LIB) NEWOBJ(CFTPRODSAV)

RNMOBJ OBJ(QSYS/CFTPGM) OBJTYPE(*LIB) NEWOBJ(CFTPGMSAV)

6. You can now install the new Transfer CFT version. See About the INSTALL command on page 20.

7. Import the configuration that you saved previously in the temporary directory created in Step 3:

CFTINIT FILES('CFTUPGLIB/EXTCONF')


Roll back an upgrade

l Import the PKI certificates using the PKIUTIL command:

CALL PGM(PKIUTIL) PARM('PKIFILE' 'fname=CFTPROD/PKIBASE, mode=CREATE')

PKIUTIL LIBRARY(EXTLIB) FILE(EXTPKI) MEMBER(EXTPKI)

l Import the catalog using the CFTMI command:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=CAT, direct=TOCAT, ifname=CFTUPGLIB/EXTCAT, ofname=CFTPROD/CAT’)

l Import the communication media file using the CFTMI command:

o For each communication media file, enter:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=COM, direct=TOCOM, ifname=CFTUPGLIB/EXTCOM, ofname=CFTPROD/COM’)

o For each node, enter:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=COM, direct=TOCOM, ifname=CFTUPGLIB/EXTCOM<nodenumber>, ofname=CFTPROD/COM<nodenumber>’)

l Import specific procedures to your production, for example APIs, EXITs, and execs from the CFTUPGLIB backup library.

Note You must recompile these after upgrading.

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

CFTUTIL about

Roll back an upgradeIn the event that after upgrading a version you need to revert back to the previous version, you can perform the steps in this section using either the automatic procedure or the manual roll back and restore catalog procedure.

Note If you executed transfers in Transfer CFT IBM i the new version that use parameters or metadata not available in the previous version, when you rollback the new metadata is lost.



Tip CFTPGM is the standard name for the program library, and CFTPROD is the standard name for the library where the configuration files are usually located.

Before you startBefore beginning the rollback procedure:

l Check that you can access the Transfer CFT installation or upgrade packages for download from Axway at support.axway.com.

l Stop the Transfer CFT server and the Transfer CFT Copilot (UI) server. Enter:

CFTSTOP

COPSTOP

Optionally, you can use the display command to check the version or product details prior to upgrading.

CFTUTIL about

Automatically roll back

Uploading the installation packageStart the rollback process by uploading the Transfer CFT installation package in binary mode to the IBM i system:


2. Create a temporary library: CRTLIB CFTTMP

3. Create a SAVF file: CRTSAVF FILE(CFTTMP/CFT37)


binary

cd CFTTMP


5. Restore the SAVF file in the temporary library:


RSTLIB(CFTTMP)

6. After restoring the SAVF, you must add the library name in the first position of the library list for the user profile. Execute the command:





Note The user performing the upgrade requires the same rights as for a regular installation or update (*JOBCTL, *SPLCTL, and *ALLOBJ).

7. Call the UPGRADE command for your Transfer CFT. Applying an UPGRADE of a version older than the version of your Transfer CFT rolls it back to this older version, but keeps your configuration.

In rollback mode, the UPGRADE command prompt resembles the following screen:

UPGRADE CFT (UPGRADE)

Extract lib for the CFT . . . . CFTEXTLIB __________

CFT Program Library . . . . . . CFTPGM __________

CFT Production Library . . . . . CFTPROD __________

Are you rolling back? . . . . . .ROLLBACK '1'

Lib of the SAVF . . . . . . . . LIBSAVF '*LIBL'

SAVF of the version to apply . . SAVF CFT37X

The following fields are mandatory; you should complete as per your system details:

l CFTEXTLIB: Enter the name of the temporary library used to process the upgrade. This can be existing or non-existent library, but its content is cleared during the process.

l CFTPGM: Enter the name of the library containing the binaries of your Transfer CFT to upgrade.

l CFTPROD: Enter the name of the library containing the working files of your Transfer CFT to upgrade.

l ROLLBACK: '1': Enables the rollback mode (YES). ‘2’: Indicates that you are NOT rolling back to a previous Transfer CFT version (NO).

l SAVF: This field only displays when you enter '1' in the ROLLBACK field. In this case, enter the name of the SAVF for the version you want to apply. The default value is the name of SAVF for the version that you downloaded.

Caution When performing a rollback, the default value of the SAVF field MUST match the version you want to roll back to. Please determine the name of the SAVF corresponding to the version you want to roll back to, as shown below:

Transfer CFT version SAVF name

3.1.3 CFT31X

3.2.4 CFT32X

3.3.2 CFT33X

3.6 CFT36X

Tip The UPGRADE command is available as of Transfer CFT 3.7.



Roll back to a version that predates the UPGRADE command The UPGRADE command was not available in Transfer CFT 3.6 and lower; however you can still execute the UPGRADE command to roll back to those versions. Use FTP in binary mode for the various upload steps to your system.

To roll back to version 3.6 or lower:

1. Follow the Upload instructions to upload the rollback version SAVF to a temporary library, for example CFTTMP.

2. Restore the SAVF in CFTTMP.

3. Repeat the Upload instructions to upload the most recent Transfer CFT version SAVF to a second temporary library, for example CFTTMP2.

4. Add the CFTTMP2 temporary library in the first position of your library list.

ADDLIBLE LIB(CFTTMP2) POSITION(*FIRST)

5. Call the UPGRADE command, and then press F4 to fill the fields. Remember to enable the rollback mode by changing the ROLLBACK value. The command to execute, again for example for version 3.6, should resemble the following:

UPGRADE CFTEXTLIB(CFTEXTLIB) CFTPGM(CFTPGM) CFTPROD(CFTPROD) ROLLBACK

('1') LIBSAVF(CFTTMP) SAVF(CFT36X)

Manually roll back

Prerequisites l Save all the CFTPGM and CFTPROD before installing Transfer CFT 3.7.

l Install to upgrade from Transfer CFT IBM i 3.4, 3.5, 3.6 (3.x) to Transfer CFT IBM i 3.7.

Manual procedurePerform the following tasks (we use 3.x in this example step procedure to indicate the version to roll back to):

1. Migrate the Transfer CFT catalog file. On the IBM i system:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=CAT, direct=FROMCAT, ifname=CFTPROD/CAT, ofname=CFTUPGLIB/CAT35’)

Where CFTUPGLIB is a temporary backup library.



2. Downgrade from Transfer CFT 3.6 to Transfer CFT 3.x version:

a. Rename CFTPGM and CFTPROD.

b. Install Transfer CFT3.x.

3. Restore your EXEC procedures and the CFTPROD library template.

4. Create a new Transfer CFT catalog file.

5. Import the saved cftcat_35 to the new Transfer CFT catalog file:

CFTMI migr type=cat,direct=tocat,ifname=cftcat_35,ofname=$CFTCATA

6. On the IBM i system:

CALL PGM(CFTMI) PARM(‘MIGR’ ‘type=CAT, direct=TOCAT, ifname=CFTUPGLIB/CAT35, ofname=CFTPROD/CAT’)


7 Uninstall Transfer CFT

To uninstall Transfer CFT in an IBM i environment, delete the following libraries:

l CFTPROD

l CFTPGM

In the HFS partition remove:

l /home/cft/cft332/install

l /home/cft/cft332/runtime

Note The user performing the uninstall must have delete rights for the CFTPGM and CFTPROD libraries, and the files in IFS /home/user/cft3x.


7 Uninstall Transfer CFT


8 Troubleshooting

Using the support toolTo assist Axway Customer Support, the CFTSUPPORT command collects useful information from a Transfer CFT environment including the configuration, Unified Configuration parameters (UCONF), catalog information, log files, and so on. This information is then packaged and stored in a tar file in the specified IFS folder.

Collected information for the Transfer CFT Transfer CFT IBM i platform includes these different CFTPROD/SUPOUT file members:

File Comment

ABOUT About information

ALOG Cftlog file

CFTOUTQ List the Transfer CFT Out Queue messages

CFTEXT CFT parameter extract

CFTOUT CFT jobs outputs

COPJLOG.CSV Primary Copilot QPJOBLOGs

COPJLOG2.CSV Secondary Copilot QPJOBLOGs

COPOUT Copilot jobs outputs

COPTRC Copilot traces

JLOG.CSV Primary CFT QPJOBLOGs

JLOG2.CSV Secondary CFT QPJOBLOGs

LISTCAT Brief listcat

LISTCATD Debug listcat

LISTCATF Full listcat

LISTCOM listcom


8 Troubleshooting

File Comment

LISTNODE Listnode

LISTPKI Listpki output

LISTPKID Listpki debug output

LISTPKIF Listpki full output

LISTUCONF Listuconf output

LOG Cftlog file

SAVFOUTQ.bin Back up the Transfer CFT Out Queue (in *SAVF format)

WRKACTJOB List system activity

Using the CFTSUPPORT commandThe CFTSUPPORT command executes the CFTSUPPORT program, which retrieves information about the Transfer CFT and stores it in a tar file.

Note CFTSUPPORT is currently not supported with an independent ASP (IASP).

You can use Transfer CFT IBM i command line to execute the command:

1. Enter the CFTSUPPORT command and press PF4.

2. Enter the IFS path where the CFTSUPPORT.tar file should be created. If the IFS path does not exist it will be created.

Note Alternatively, from the CFT menu select 3. Administration commands then 2. Submit CFT support request.

If the generated CFTSUPPORT.tar is too large, you can compress it prior to sending it to Axway support.

Example

In the following example, the command creates the CFTSUPPORT.tar and SAVFOUTQ.bin files in /home/cft/cftsupport/.

CFTSUPPORT IFSPATH('/home/cft/cftsupport')


Tracking Transfer CFT IBM i activities

Tracking Transfer CFT IBM i activitiesTransfer CFT activities are tracked using the:

l Transfer CFT Catalog, which can be queried by CFTUTIL, Copilot, and CFTAPI

l Transfer CFT LOG, a file designated by the CFTLOG configuration command [A]FNAME parameter. This file contains, for example, INIT COMPLETE, SEND TREATED and SERVER SESSION OPENED

l Message queue echoing the Transfer CFT logging associated with the user designated by NOTIFY in the CFTLOG command:

l Specific values: NOTIFY='______' / NOTIFY='OP______'

l Echo level: OPERMSG= 0 to 255

When monitoring operating incidents, information may be logged in the:

l Message queue that receives specific incident messages from the interface functions; by default, the function associated with the submitter user (same as NOTIFY='______')

l QSYSOPR message queue that receives messages generated by specific network or work-management commands, and any Transfer CFT file and data management error messages

l JOBLOG (history message queue and QPJOBLOG spool file), LOGCLPGM parameter in the *JOBD:

Logging level (0 to 4) (default = 4)

Severity level (00 to 99) (default = 50)

MSGQ -> spool copy control (*MSG/*SECLVL/*NOLIST)(default = *NOLIST)

l Transfer CFT IBM i LOG (QHST) which records job start and end times, status changes for network objects and so on

l Interactive log file (DSPJOBLOG)

The output spool files (QPRINT) contain:

l CFTUTIL batch execution reports

l Messages corresponding to CFT logging, if Transfer CFT is run without a LOG file (without the CFTLOG command)

l Any traces taken at function level

l Any network traces

l Reports from procedures submitted by Transfer CFT (see the transfer variables that can be retrieved as symbolic variables)

CFT ACCNT, accounting, the file designated by the CFTACCNT configuration command [A]FNAME parameter, is used to store information on all terminated transfers.


8 Troubleshooting

Note The file and data management systems display a system code (40000000 < SC < 5FFFFFFF) if an error is detected on transferred files. An associated error label, when it is not stored in any of the ways described above, can be retrieved from a file containing all CFT file management system error codes and labels:DSPPFM FILE (CFTPGM/FMDM3ERR).The hexadecimal value of the error code must be used in the search profile.

In the line-sharing mode, unlike the exclusive mode, Transfer CFT checks the status of the line without implementing it. If the line is not operational, a message is displayed:

From.....: CFT 06/12/17 15:56:04

CF1LX021 : This line is out of order.

After it has been implemented manually:

CF1LX021 line implemented.

From.....: CFT 06/12/17 15:56:04CF1LX021 : Now this line is operational.

All messages stored in the log are described in the Transfer CFT 3.7 User's Guide sub-book Messages and Codes. There are a few exceptions when messages are not stored in the log, for example messages that are self-explanatory and OS related.

For more information, refer to the Transfer CFT User Guide.


IFS access error codes: DIAGP

IFS access error codes: DIAGPError code Description

1 Kernel error

13 Invalid key

14 Invalid record address

15 File does not exist

16 Access not authorized

17 Inconsistent file structure

18 Record too big

19 Invalid record size

1A End of file reached

1B Record locked by another user

1C Record not locked

1D Record not found

1E Record already exists

1F Directory path error

20 File name error

21 File descriptor error

22 File not open

23 Invalid mode

24 File access not authorized

25 Invalid file attribute(s)

26 Invalid access unit


8 Troubleshooting

Error code Description

27 System dependence error

28 Backspace not possible

29 File already open

2A File already exists

2B File read error

2C File write error

2D Secondary key duplicated

2E Empty file

2F Security attribute mismatch

30 File not empty

31 File access conflict

FF System error

Determine or change the CCSIDA coded character set identifier (CCSID) is a value that allows you to define a specific page code for your IBM i system. This value can be defined in your system, user profile, or subsystem. The value 65535 is an IBM i specific value that enables automatic resolution by the system.

You should pay particular attention to this value as it may impact Transfer CFT depending on the language installed on the system. Note that Axway uses CCSID 37 when generating the product.

If you want to know the CCSID used in your current environment or if you want to change it, perform the following steps:

1. Connect with the Transfer CFT profile.

2. Start Transfer CFT: CFTSTART

3. Enter: WRKACTJOB

4. Before the CFTMAIN process, enter the value 5 and then ENTER.

5. Enter the value 2 and then ENTER.

Example


Determine or change the CCSID

The screen displays the coded character set identifier. In the following example, you can see the values to apply in production are CHGUSRPRF USRPRF(CFT) LANGID(EN_US) CCSID(37).


8 Troubleshooting


A About APIs

Application Programming Interfaces, or APIs, are a set of functions that use a service. The service is followed by an application program.

Each of these services is described in one of the following sections, which provides an overview of the service. Applications can address requests to Transfer CFT via service call functions:

l REST API

l Web services

l Using JPI

l Transfer services

l Synchronous communication services

l Catalog query services

The programming interfaces and programming language are related. The services can be called by programs in COBOL or in C language as described in this section.

About Transfer CFT servicesYou can query information related to correctly completed transfers. This information can be accessed in the communication structure.

A description of this structure sub-assembly is provided in the cftapi.h for the C language, and cftapi.cop for COBOL.

Restrictions l Visual Basic APIs are available on PCs only.

l The security APIs are not covered in this section.


../../../../../Content/apis/api_intro.htm

../../../../../Content/Prog/web_services/about_web_services.htm

../../../../../Content/Prog/API/java_api.htm

A About APIs

Catalog querying services This service provides access to the Transfer CFT catalog entries, for querying and modification, and enables you to sort the selected catalog entries. Additionally, you can sort the current selection in memory.

Note The communication structure in Transfer CFT enables you to recuperate catalog fields, such as an identifier, that exceed 8 to 32 characters.

Function Use

OPEN Open catalog fileThis function:

l Allocates the catalog file

l Opens the file

l Reserves an internal control block

l Initializes the internal block parameter

SELECT Specify the selection criteriaThis function:

l Checks the syntax used

l Stores the selection criteria in the internal control block

SELECT240 Specify the selection criteriaThis function:

l Is available in CFT v2.4 and higher

l Retrieves identifiers that are longer than 8 to 32 characters



NEXT Read next entry in the catalogThis function:

l Reads the next entry

l Sets the "catalog entry data" areaThe first call to this function must be preceded by a SELECT.


A About APIs

Function Use

NEXT240 Read next entry in the catalogThis function:




l Sets the "catalog entry data" area

MODIFY Modify the state of the current catalog entry or delete this entry from the catalogThis function:

l Retrieves the last entry read from the internal control block

l Checks the state of this entry

l Sends the modification request to Transfer CFT

SORT Sort the selected catalog entriesThis function:

l Close the catalog file

l De-allocates the file

l Frees the internal control block

l Resets the internal control block parameter

DO Execute the current selection and the requested sort in memory

CLOSE Close catalog file


A About APIs

Transfer servicesUse the transfer services to send transfer control commands to Transfer CFT, with or without a syntax analysis of these commands. The programming interface proposes a function integrating a syntax analysis of the command to detect any errors, at the source, and a function without syntax analysis, which provides a much smaller coding volume.

The transfer services functions:

l Check the validity of the command name

l Analyze the syntax of the command parameters, if the function using the syntax analyzer is used

l Place the command in the Transfer CFT communication medium

The processing performed by Transfer CFT is totally asynchronous.

The return code only provides an indication that the function has effectively been taken into account but does not necessarily mean that Transfer CFT has executed the command correctly. A return code indicating the success of the function only means that the command has been correctly placed in the communication medium.

Function Use

SEND Send transfer request: file, message or reply

RECV Receive transfer request

HALT Interrupt one or more send or receive transfers with a given partner.The interrupted transfers are set to the "H" state and can be restarted at the partner's request.

KEEP Suspend one or more send or receive transfers with a given partner.The interrupted transfers are set to the "K" state and can only be restarted by a START command.

START Start one or more send or receive transfers

DELETE Delete a catalog entry and any transfer in process associated with it

END Set a transfer status to executedThe transfer is set to the "X" state. This indicates that end-of-transfer procedure has been correctly executed.

SUBMIT Submit the end-of-transfer procedure

SHUT Shut down Transfer CFT


A About APIs

Function Use

SWITCH Switch monitoring files, LOG, STATS...

CLOSEAPI Free resources allocated at opening of communication medium: memory, network, file

COM Define communication medium

GETXINFO Retrieve information concerning the last transfer made from a synchronous request


A About APIs

Synchronous communication servicesThis topic describes Transfer CFT synchronous communication services.

Description of functionsFunction Use

COM Set the communication medium

GETXINFO Retrieve information concerning the last transfer made from a synchronous request after a request of the following types: SEND, RECV, HALT, KEEP, START, RESUME, DELETE, END, SUBMIT, SWITCH, PURGE.The information is stored in a cftApiInf-type structure:

l Transfer state

l Diagnostic

l Diagnostic protocol

l Value of the PART field of CFTPARM

l Transfer identifier (IDT)

l Local transfer identifier (IDTU)

l Transfer type (single, cyclical, diffusion list, collection, file group)

l Public reference of the transfer (only for a single transfer in Send)The GETXINFO action returns an error if the communication medium is not synchronous.

Note The public reference of the transfer is a character string of variable length. In the PESIT protocol, it contains 'pi13.pi3.pi4.pi11.pi12.pi61.pi62'.


A About APIs

About Web servicesThis documentation describes the Transfer CFT Web services interface option, and provides instructions for getting started with Web services, executing a SEND file transfer request, and retrieving the request details from the catalog.

Web services provide a way for applications to use software services over networks such as the Internet. Client applications use the Web Services Description Language (WSDL) to do this and exchange data using XML. Since you can use URLs, HTTP, and XML to access Web services, applications running on a variety of platforms and using various languages can access XML Web services.

You can use Web services to access all of the main functions for managing Transfer CFT such as:

l Configure Transfer CFT: create, modify, and view configuration objects

l Monitor Transfer CFT: consult the log, the catalog, and transfer statistics

l Create transfers: create a new file transfer, a message or transfer reply

License keyYou require a license key that includes the Web services option for the Transfer CFT product. To request a key, contact your Axway sales representative.

About the WSDL fileTo use Web services with Transfer CFT, you need a WSDL1 file. Your installed Transfer CFT product comes with a WSDL file that describes the operations, operation attributes, requests and response structure. You can access the WSDL file from your local installation at:

l On IBM i: <install_directory>/distrib/copilot/wsdl/copilotcft.wsdl

Using the WSDL file, you can automatically generate a Web services client. You can use an open source Web service Java toolkit, for example Axis from The Apache Software Foundation, to create this Web services client.

The Web services requests sent by the client are then processed on the Transfer CFT Copilot server listening port.

Additional resourcesFor more information on the following subjects, go to:

l WSDL: www.w3schools.com/wsdl/

l SOAP: www.w3schools.com/soap/

1Web Services Description Language


http://www.w3schools.com/wsdl/

http://www.w3schools.com/soap/

A About APIs

l Axis: axis.apache.org/axis/

You can find SOAP samples and documentation at:

l Transfer CFT Web services documentation: <cft_installation_directory>/distrib/copilot/wsdl/doc/index.html

l SOAP request samples:<cft_installation_directory>/distrib/copilot/wsdl/sample

Note For UNIX/Windows systems, for other platforms refer to the platform specific paths.

General restrictionsThe Web services process can receive any SOAP request that conforms to the W3C specifications and WS-I Recommendations.

The following restrictions apply to Transfer CFT Web services:

l The time zone offset is not supported for XSD types Time and DateTime.

l Element attributes are not supported, nor parsed. This means that if there are incorrect spaces in names for any operation attribute or message, they are skipped and no error is returned. Exceptions are made to support WS-I recommendations.

WS-I recommendationsVerify that the correct option is set if your client requests have to be checked to conform to WS-I recommendations. To do this, set the UCONF [copilot.webservices.wsicomplience] identifier to yes.

The following WS-I constraints are checked by the GUI server for the XML representation of SOAP messages. These constraints include:

l SOAP Header constraints:

o R1009: A MESSAGE MUST NOT contain processing instructions

o R1012: A MESSAGE MUST be serialized as either UTF-8 or UTF-16

l SOAP Body constraints:

o R1006: A MESSAGE MUST NOT contain soap:encoding

l Style attributes on any element that is a child of soap:Body

o R1007: A MESSAGE described in an rpc-literal binding MUST NOT contain soap:encodingStyle attribute on any elements that are grandchildren of soap:Body

o R1014: The children of the soap:Body element in a MESSAGE MUST be namespace qualified

For more information on WS-I recommendations, visit http://www.ws-i.org


https://axis.apache.org/axis/

http://www.ws-i.org/

A About APIs

Limit the number of failed login attemptsTransfer CFT provides brute force protection for logging on the Transfer CFT UI, REST API, Copilot, or Web Services when using either the system mode or xfbadm mode (UNIX) authentication. That is, it limits the number of login failure attempts, where both the user and the password are checked to avoid brute force attacks.

For other authentication methods, such as PassPort and LDAP, no check is made. You must manage that in the Password Policy of those external tools.

You can use the following UCONF parameters to manage this option:

l copilot.general.login_failures_fname: A file that stores data shared between Transfer CFT and Copilot.

l copilot.general.max_login_failures: An integer that sets the maximum number of login failures for a user (default is 3, and 0 disables this option).

Note In a multi-host environment, an attacker may have up to the copilot.general.max_login_failures * <number of host> tries before the user is locked if the file is not in a directory shared by all hosts.

When the maximum number of login failures is reached, the user account is locked for 30 seconds.

Platform specifics

l On IBM i systems, there is no action if the password is incorrect as the system offers methods that you can rely on to avoid brute force attacks (the system value is QMAXSIGN).

l On z/OS systems, only the inherent system protection is available (refer to the RACF suboperand REVOKE for the PASSWORD option).

l On OpenVMS systems, only existing system protection is available.


https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_74/rzarl/rzarlmaxsgn.htm

https://www.ibm.com/support/knowledgecenter/SSLTBW_2.3.0/com.ibm.zos.v2r3.icha700/setrpw.htm

A About APIs

Transfer CFT JPITransfer CFT delivers a java programming package in its installation folder. This package includes JPI requests, java configuration examples, and documentation necessary to perform local or remote monitoring via logs, transfer requests and control.

Note As of Transfer CFT 3.1.3 SP8, you can retrieve a transfer that is in the pre, post, or ack processing state. See the Transfer JPI documentation for details.

The JPI package is located at: <installation_directory>\home\distrib\jpi


A About APIs

About Transfer CFT services in CThis section begins with this topic which provides information about using the Transfer CFT services in C language. It also contains topics that describe how to use the following services in C language.

This page describes the Transfer CFT programming interface. The programming interface is implemented by the calling application module link, with the Transfer CFT interface function modules.

The library of object modules supplied provides everything the programmer can requires. This library also contains the file cftapi.h to be included in the application using the Transfer CFT programming interfaces.

Call syntaxSyntax rc = cftxx (verb,&ptr,param)

Element Definition

cftxx cftai: simple Transfer CFT catalog querying servicescftaix: extended Transfer CFT catalog querying servicescftau: transfer services with syntax analysiscftac: transfer services without syntax analysis

verb Service requested

ptr Address of the internal control block

param Parameters specific to the requested service

rc Return code

Return codesThe return codes are returned by the programming interfaces in the form of mnemonics.

Note It is strongly recommended that you test the return codes of services provided by the Transfer CFT programming interfaces through mnemonics. The corresponding values may change without notice.

The return codes are listed in the cftapi.h source file.


A About APIs

About Transfer CFT services in CThis section begins with this topic which provides information about using the Transfer CFT services in C language. It also contains topics that describe how to use the following services in C language.

This page describes the Transfer CFT programming interface. The programming interface is implemented by the calling application module link, with the Transfer CFT interface function modules.

The library of object modules supplied provides everything the programmer can requires. This library also contains the file cftapi.h to be included in the application using the Transfer CFT programming interfaces.

Call syntax

Syntax rc = cftxx (verb,&ptr,param)

Element Definition

cftxx cftai: simple Transfer CFT catalog querying servicescftaix: extended Transfer CFT catalog querying servicescftau: transfer services with syntax analysiscftac: transfer services without syntax analysis

verb Service requested

ptr Address of the internal control block

param Parameters specific to the requested service

rc Return code


Note It is strongly recommended that you test the return codes of services provided by the Transfer CFT programming interfaces through mnemonics. The corresponding values may change without notice.

The return codes are listed in the cftapi.h source file.


A About APIs

About cftapi2The catalog functions enable you to query and modify the catalog. These functions also include a method to recover information about the Transfer CFT that is using the catalog.

Additionally, the API catalog supports 32 character identifiers and 512 character file names.

Return code valuesThe return code values are available in the cftapi2.h header file, located in the Transfer_CFT/home/inc directory (for UNIX/Windows), in the section Error code fields.

Data structureThe data structures that are used by the API are as follows:

l Current session in progress: CftApi2Session

l Catalog: CftApi2Catalog

l Selection: CftApi2Selection

l Saved catalog record: CftApi2Record

The programmer can set pointers to these data structures. These are then allocated and initialized by the API.

API functions

Service CftApi2Session *ipcai2_initialize ()

Definition Initializes the API.

Parameter None.

Return value This function returns a pointer to the CFTApi2Session. If the returned value is NULL, the session cannot be initialized.

Service long ipcai2_get_errno(CftApi2Session * session)

Definition Recuperates the latest error code.

Parameter session: Pointer to the CftApi2Session is returned by the initialization function ipcai2_initialize()


A About APIs

Return value The last error code for the API for this session.

Remarks This function can be used after all calls to the API except for ipcai2_initialize() and ipcai2_finalize().

Service long ipcai2_get_errno_str(CftApi2Session * session, char *buffer, int bufflen)

Definition Recuperates the error message.

Parameter session: Pointer to the CftApi2Session structure is returned by the initialization function ipcai2_initialize()buffer: The buffer that will be informed of the error message. bufflen: Length of the buffer sent to the API.

Return value If the return code is positive, it contains the last error code for the API for this session. If the Return code is negative, the buffer is too short. If this happens, and the code is equal to –n where n is equal to the required length.

Remarks This function can be used after all calls to the API except for ipcai2_initialize() and ipcai2_finalize().

Service long ipcai2_finalize(CftApi2Session * session)

Definition Closes the API.

Parameter session: Pointer to the CftApi2Session structure returned by the initialization function ipcai2_initialize()

Return value None.

Remarks None.

Service CftApi2Catalog *ipcai2_catalog_open(CftApi2Session * session, char *catalog_fname)

Definition Opens the Transfer CFT catalog file.


A About APIs

Parameter session: Pointer to the CftApi2Session structure returned by the initialization ipcai2_initialize()catalog_fname: Name of the catalog file. If the file name is "" the API opens the catalog file by default, for example _CFTCATA for Transfer CFTUNIX.

Return value This function returns a pointer to the CftApi2Catalog structure. If the returned value is NULL, the catalog cannot be opened and the error code is returned by calling ipcai2_get_errno().

Remarks None

Service long ipcai2_catalog_reload_cache(CftApi2Catalog *catalog)

Definition Reloads the catalog cache.

Parameter catalog: Pointer to the catalog returned by ipcai2_catalog_open()

Return value None.

Remarks None.

Service long ipcai2_catalog_close(CftApi2Catalog * catalog

Definition Closes the catalog.

Parameter catalog: Pointer to the catalog returned by ipcai2_catalog_open()

Return value Calling ipcai2_get_errno() ou ipcai2_get_errno_str() enables you to recuperate the return code for this function.

Remarks None.

Service CftApi2Selection *ipcai2_catalog_selection_new(CftApi2Catalog *catalog)

Definition New selection in the catalog.

Parameter catalog: The pointer to the catalog returned by ipcai2_catalog_open()

Return value This function returns a pointer to a CftApi2Selection structure. If the returned value is NULL the selection cannot be initialized and an error code is returned by calling ipcai2_get_errno().

Remarks None.


A About APIs

Service long ipcai2_catalog_selection_ref(CftApi2Selection *selection)

Definition References a selection.

Parameter Selection: The pointer for the selected structure returned by calling ipcai2_catalog_selection_new()

Return value Negative or null: Error, recuperated the error code from ipcai2_get_errno() or ipcai2_get_errno_str().Positive: Total number of sessions referenced after this call.

Remarks A selection can be referenced several times, and must be referenced at least one time before it is used.

Service long ipcai2_catalog_selection_set(CftApi2Selection * selection, char *param, char *value)

Definition Initializes a parameter selection.

Parameter selection: Pointer for the selected structure referenced by ipcai2_catalog_selection_ref()param: Modify selection parameter. Selection parameter available in cftapi2.h under “Selection parameters” section: CFTAPI2_SELECTION_*value: Parameter value in a character string

Return value None.

Remarks None.

Service long ipcai2_catalog_selection_next(CftApi2Selection *selection)

Definition Executes a selection.

Parameter selection: Pointer for the selection is referenced by ipcai2_catalog_selection_ref()

Return value A call to ipcai2_get_errno() ou ipcai2_get_errno_str() enables you to recover the return code for this function.

Remarks None.


A About APIs

Service long ipcai2_catalog_record_get(CftApi2Selection * selection, char *param, char *buffer, int bufflen)

Definition Recovers a saved field from the selected catalog.

Parameter selection: Pointer for the selection structure is referenced by ipcai2_catalog_selection_ref().param: Parameter to be recovered. The parameter to be recovered is available in cftapi2.h in the “Catalog record fields” section: CFTAPI2_RECORD_*buffer: Buffer that will be informed with the parameter valuebufflen: Length of the buffer sent by the API

Return value If the Return code is positive it contains the last API error code for this session. If the return code is negative, the buffer is too short and the code is equal to –n where n is the required length for the buffer.

Remarks None.

Service long ipcai2_catalog_selection_unref(CftApi2Selection *selection)

Definition De-lists a selection.

Parameter selection: Pointer to a selection structure that references ipcai2_catalog_selection_ref()

Return value Negative: Error, recovered the error code by calling ipcai2_get_errno() or ipcai2_get_errno_str()Null: Okay, and no other referred sessions.Positive: Total number of referred sessions after this call.

Remarks None

Service long ipcai2_catalog_selection_delete(CftApi2Selection *selection)

Definition Deletes a selection.

Parameter selection: Pointer to a selection that is not referred by calling ipcai2_catalog_selection_unref()

Return value A call to ipcai2_get_errno() or ipcai2_get_errno_str() enables you to recover the Return code for this function.

Remarks None.


A About APIs

Service long ipcai2_transfert_change_state(CftApi2Selection * selection, char state)

Definition Modifies the transfer state for the selected catalog.

Parameter selection: Pointer to a selection carried out by ipcai2_catalog_selection_next()

Return value None.

Remarks The Transfer CFT API must have already opened the communication medium.

Service long ipcai2_catalog_info_get(CftApi2Catalog *catalog, char *param, char *buffer, int bufflen)

Definition Recovers catalog information.

Parameter catalog: Pointer to the catalog structure returned by ipcai2_catalog_open()param: Recover parameter is available in cftapi2.h under the “Catalog information parameters” section heading: CFTAPI2_CAT_INFO_*buffer: Buffer that will be informed of the parameter value. bufflen: Length of the buffer sent to the API.

Return value If the Return code is positive it contains the last API error code for this session. If the return code is negative, the buffer is too short. The code is equal to –n ,where the n is equal to the required length.

Remarks None.

Service long ipcai2_monitor_info_get(CftApi2Catalog *catalog, char *param, char *buffer, int bufflen)

Definition Recovers information about the Transfer CFT.

Parameter catalog: Pointer to the catalog returned by ipcai2_catalog_open()param: Parameter to recover. The parameter is available in cftapi2.h under “Monitor information parameters” topic : CFTAPI2_MON_INFO__*buffer: Buffer that was provided the parameter value .bufflen: Length of the buffer sent to the API.

Return value If the return code is positive, it contains the last API error code for the session. If the return code is negative, the buffer is too short. In this case, the code is equal to –n where n is the required length.

Remarks None.


A About APIs

Examples of API usage

The heading file cftapi2.h and the commented example source files are delivered with the product.


A About APIs

Transfer CFT catalog query servicesThis service provides access to the Transfer CFT catalog entries, for querying and modification, and enables you to sort the selected catalog entries. Additionally, you can sort the current selection in memory.


Function Use



l Opens the file















A About APIs

Function Use

















Call syntaxThese services enable you to query the catalog either with or without specific criteria.

rc = cftai (verb,&ptr,param)

rc = cftaix (verb,&ptr,param)

Where:

l rc is the return code (int)

l verb is the command that you want to process (char *)

l ptr contains the address of an internal control block (char *) completed on return of an OPEN service call. It must be provided and defined to call other functions

l param points to the parameters specific to each function

The available verbs are listed in the following table.


A About APIs

<verb> Service

OPEN Open catalogSELECT Define selection criteriaNEXT Read next entryMODIFY Modify catalog entry stateSORT cftaix only

Sort the selected catalog entriesDO cftaix only

Do the current selection and the requested sort in memoryCLOSE Close catalog

The available <param> are listed in the following table.

<verb> <param> ExplanationOPEN cat Path name or logical name of the catalog file. If the name is

blank, Transfer CFT uses a default name.


A About APIs

SELECTand SELECT240

&cftsel Selection criteria according to the format described in the "Selection data description" in the cftapi.h file.

l cftsel230T for SELECT service

l cftsel240T for SELECT240 serviceAll the fields must be defined by left-aligned character strings. If a field is equal to binary zeros, it is considered not selective.This structure can contain:

l The size of the selection criteria field (slength) and the size of the field supporting the catalog entry (clength) in order to avoid recompiling the application program if these two fields are extended.

l The transfer start and end date (BDATE and EDATE) to select transfers performed between these two dates.

l A field can be composed of a mask with the special characters "?" and *". The "?" character replaces any character. The "*" character replaces a character string of any length.

Examples: A*D replaces ABCD, ABCED or AID A??D replaces ABCD, AXYD or AQZD *CD replaces ABECD, YXZCDor TYUICD ?CD replaces ACD, XCD or ZCD ?B* replaces ABCDEF, XBZWEO or *KBWXCV ???? replaces ABCD, XYZW or HGFD

You should initialize the following:

l The param field to binary zero before defining it

l The slength and clength by "itoa()"cftaix onlyThe selection is only taken into account at the time the DO service is called.

NEXTandNEXT240

&cftcat Next catalog entry according to the format described in the "Selection data description" in the cftapi.h file.

l cftcatT for NEXT service

l cftcat240T for NEXT240 service


A About APIs

MODIFY &nstate New state of a transfer to be placed in the catalog entry previously read:

l ‘D’ at Disposal: only valid if the former state is H or K

l ‘H’ Hold: only valid if the former state is D, C or K

l ‘K’ Keep: only valid if the former state is D, C or H

l ‘X’ eXecuted: only valid if the former state is T

l ‘P’ Purge: deletes the catalog entry*. It is only valid if the current state is D, H, K, T or X

SORT param cftaix onlySort options as described in the "Sort structure of the selected catalog entries" in the cftapi.h file. The function is only taken into account at the time the DO service is called.

DO " " CLOSE " "

Return codesThe following return codes apply to all services.

Mnemonic DescriptionCAPI_NOERR No errorCAPI_FUNC_UNDEF Command not valid or service refused by the operating security

system CAPI_INT_PTR <ptr> parameter invalidOPEN code onlyCAPI_MEM_GET Memory allocation errorCAPI_CAT_ALLOC cftai only

Catalog file allocation errorCAPI_CAT_OPEN Catalog file opening problemSELECT code onlyCAPI_SEL_DIRECT DIRECTION criterion incorrectCAPI_SEL_TYPE TYPE criterion incorrectCAPI_SEL_STATE STATE criterion incorrectCAPI_CAT_EMPTY Catalog emptyCAPI_CAT_SELECT cftaix only

Selection incorrectCAPI_SEL_DATE EDATE value < BDATE valueCAPI_SEL_FDATE FDATE criterion incorrectCAPI_SEL_CDATE CDATE criterion incorrect


A About APIs

CAPI_SEL_BDATE BDATE criterion incorrectCAPI_SEL_DATE EDATE criterion incorrectNEXT code onlyCAPI_CAT_EOF End of catalog fileCAPI_CAT_READ Catalog file read errorMODIFY code onlyCAPI_CAT_MODIFY cftaix only

Modification errorCAPI_MOD_OSTATE State invalidCAPI_MOD_NSTATE Requested new state incorrectCAPI_INT_ERR2 Internal errorCAPIO_COM_OPEN Communication medium opening errorCAPI_COM_WRITE Communication medium write errorCAPI_COM_CLOSE Communication medium closing problemSORT code only (cftaix only)CAPI_CATSORT sort incorrectDO code only (cftaix only)CAPI_CAT_CLOSE Error on closing the catalogCAPI_CAT_OPEN Error on opening the catalogCAPI_CAT_EMPTY Catalog empty or no record selectedCAPI_ERREXEC Execution errorCLOSE code onlyCAPI_MEM_FREE Memory de-allocation errorCAPI_CAT_FREE Catalog file de-allocation errorCAPI_CAT_CLOSE Catalog file closing error


A About APIs


Description of functions

Function Use



l Transfer state

l Diagnostic








Call syntaxrc = cftau (verb,param)

rc = cftac (verb,param)

Where:

l cftau indicates that syntax analysis is requested cftac indicates that syntax analysis is not requested

l <verb> is the command that you want to process

l <param> is a character string of variable length that contains the command parameters. The end of the field is defined by a character initially set to low-value

l <rc> is the return code


A About APIs

The available <verbs> are listed in the following table.

<verb> Service

COM Communication mode

GETXINFO Retrieving information about a transfer made from a synchronous request


<verb> <param> Description

com

param

The COM command parameter structure is as follows: <medium type> = <Medium name>The medium type consists in an uppercase letter:

l 'F' for file

l 'T' for the TCP/IP synchronous medium

l 'C' for the configuration file (ConfigFileName)

The medium name is the:

l Filename, if the medium type is 'F'

l Name of the communication channel, if the medium type is 'T'

l Name of the configuration file containing the medium of communication characteristics, if the medium type is C.

getxinfo xinf Information about a transfer in the format described in the cftapi.h file.

Step procedureUse the COM command to define the synchronous medium.


A About APIs

1. Open the synchronous communication.

cftau ("COM",C=<configuration file>);

configuration file is a text file that contains the following lines :

# TCP/IP COMMUNICATION

TYPE = TCP

NAME = xhttp://localhost:<COM Synchron port value>

TIMEOUT = <timeout to reach>

2. Write the command. This is not specific to synchronous mediums.

cftau (verb,param)

3. Retrieve information using the GETXINFO service.

cftApiInfT cftinfo;

cftau("GETXINFO",(char*) &cftinfo);

To view the synchronous communication template containing details and an example, see tcftsyn.

Return codes

Mnemonic Description

CAPI_NOERR No error.

CAPI_FUNC_UNDEF Command not valid.

CAPI_COM_OPEN Communication medium opening error.

CAPI_COM_WRITE Communication medium write error.

CAPI_COM_CLOSE Communication medium closing problem.

CAPI_COM_ALLOC Communication medium allocation problem.

CAPI_COM_ERR Communication medium not available on this system.


A About APIs

Transfer services in CTransfer services allow actions to be taken on transfers with the security system performing an authorization check when the request is submitted, and not when the request is processed by the monitor, the behavior of unprotected IPC with an error message in the log file.

The application can detect commands that do not have permission for access. This lightens the workload, improving Transfer CFT performance, and reducing the cluttering of the communication medium by invalid requests.

Use the transfer services to send transfer control commands to Transfer CFT, with or without a syntax analysis of these commands. The programming interface proposes a function integrating a syntax analysis of the command to detect any errors, at the source, and a function without syntax analysis, which provides a much smaller coding volume.







Function Use








A About APIs

Function Use








Call syntax rc = cftau (verb,param)

rc = cftac (verb,param)

Where:

l cftau indicates that syntax analysis is requested

l cftac indicates that syntax analysis is not requested





<verb> Service

SEND Send

RECV Receive

HALT Interrupt

KEEP Suspend


A About APIs

<verb> Service

START Retry

DELETE Delete

END Proceed to "X" state

SUBMIT Re-submit end-of-transfer procedure

SHUT Stop monitor

SWITCH Switching monitoring files (log, statistics file)

COM

If <param> is not defined, CFTU will take a default name.

As these media are not available on all systems, the function performs an availability check.

The security check is performed on the user name, and the user group if applicable, depending on the command:

l IDF if present in parameter field: DELETE, END, HALT, KEEP, SEND, RECV, START

l Procedure name: SUBMIT

l Type: SWITCH LOG or ACCNT

Return codes


CAPI_NOERR No error

CAPI_FUNC_UNDEF Command not valid

CAPI_CMD_LENGTH cftau only Transfer CFT command string invalid, does not exist, or greater than 1024 characters long

CAPI_KEY_NAME cftau onlyCommand syntax incorrect: keyword name incorrect

CAPI_KEY_VALUE cftau onlyCommand syntax incorrect: keyword value incorrect

CAPI_MEM_GET Memory allocation error


A About APIs


CAPI_MEM_FREE Memory de-allocation error

CAPI_INT_ERR1 Internal error 1



Error messagesThe FIELD and MSG fields of the CFTAPI COPY CLAUSE contain:

l FIELD: name of the incorrect parameter detected by the Transfer CFT syntax analyzer

l MSG:

o Either a message relative to the error recognized by the syntax analyzer

o Or an error message describing an incident when the command is taken into account

If no error is detected, the FIELD and MSG fields are blank.


A About APIs

About Transfer CFT services in COBOLThis book begins with this topic which provides information about using the Transfer CFT services in COBOL.

The programming interface is implemented by the calling application module link, with the Transfer CFT interface function module or modules.

The library of modules supplied provides everything programmers can require.

This library also contains a programming example and the following COPY CLAUSE: CFTAPI to be included in the application which uses the Transfer CFT programming interfaces.

Call syntaxCALL CFTx USING <verb> <blk> <param> <rc>

Where:

l CFTx indicates:

l CFTI: Transfer CFT catalog querying services

l CFTU: transfer services with syntax analysis

l CFTC: transfer services without syntax analysis

l <verb> is the command you want to process

l <blk> is the internal control block

l < is a character string of variable length that contains the function parameters>param


The variables described in this documentation are defined in the cftapi.cop file supplied in the library of delivered modules. The programming example and the corresponding COPY files are shipped with the product.


Note It is strongly recommended that you test the return codes of services provided by the Transfer CFT programming interfaces through mnemonics, the corresponding values being able to change without notice.

The return codes are listed in the cftapi.cop source file.


A About APIs

About Transfer CFT services in COBOLThis book begins with this topic which provides information about using the Transfer CFT services in COBOL.

The programming interface is implemented by the calling application module link, with the Transfer CFT interface function module or modules.

The library of modules supplied provides everything programmers can require.

This library also contains a programming example and the following COPY CLAUSE: CFTAPI to be included in the application which uses the Transfer CFT programming interfaces.

Call syntax

CALL CFTx USING <verb> <blk> <param> <rc>

Where:

l CFTx indicates:

l CFTI: Transfer CFT catalog querying services

l CFTU: transfer services with syntax analysis

l CFTC: transfer services without syntax analysis

l <verb> is the command you want to process

l <blk> is the internal control block

l < is a character string of variable length that contains the function parameters>param


The variables described in this documentation are defined in the cftapi.cop file supplied in the library of delivered modules. The programming example and the corresponding COPY files are shipped with the product.


Note It is strongly recommended that you test the return codes of services provided by the Transfer CFT programming interfaces through mnemonics, the corresponding values being able to change without notice.

The return codes are listed in the cftapi.cop source file.


A About APIs

Transfer CFT catalog query servicesThis service provides access to the Transfer CFT catalog entries, for querying and modification, and enables you to sort the selected catalog entries. Additionally, you can sort the current selection in memory.


Function Use



l Opens the file















A About APIs

Function Use

















Call syntax

CALL "CFTI" USING <verb> <blk> <param> <rc>

Where:


l <blk> is a Transfer CFT specific field that must not be changed by the application





A About APIs

<verb> Value Service

F-OPEN OPEN Open catalogF-SELECT SELECT Define selection criteriaF-NEXT NEXT Read next entryF-MODIFY MODIFY Modify catalog entry stateF-CLOSE CLOSE Close catalog


<verb> <param> Explanation

F-OPEN D-CAT Path name or logical name of the catalog file. If the name is blank, Transfer CFTI uses a default name.

F-SELECT Z-SEL Selection criteria according to the format described in the "Selection data description" in the cft.apicop file. If a field is blank or equal to binary zeros, it is considered not selective.This field can contain:

l the size of the selection criteria field (SLENTGTH) and the size of the field supporting the catalog entry (CLENGTH) in order to avoid recompiling the application program if these two fields are extended.

l the transfer start and end date (BDATE and EDATE) to select transfers performed between these two dates.

l a mask with the special characters "?" and *". The "?" character replaces any character. The "*" character replaces a character string of any length.

Examples: A*D replaces ABCD, ABCED or AID A??D replaces ABCD, AXYD or AQZD *CD replaces ABECD, YXZCDor TYUICD ?CD replaces ACD, XCD or ZCD ?B* replaces ABCDEF, XBZWEO or *KBWXCV ???? replaces ABCD, XYZW or HGFD


A About APIs


F-NEXT Z-CAT Next catalog entry according to the format described in the "Selection data description" in the cft.apicop file.The length of this field is defined by the SELECT service. See the CLENGTH field in the Selection data description.

F-MODIFY M-STATE New state of a transfer to be placed in the catalog entry previously read:

l ‘D’ at Disposal: only valid if the former state is H or K

l ‘H’ Hold: only valid if the former state is D, C or K

l ‘K’ Keep: only valid if the former state is D, C or H

l ‘X’ eXecuted: only valid if the former state is T

l ‘P’ Purge: deletes the catalog entryF-CLOSE No <param> needed

Return codesThe return codes listed below apply to all services.


CAPI-NOERR No errorCAPI-FUNC-UNDEF Command not validCAPI-INT-BLK <blk> parameter invalidOPEN code onlyCAPI-MEM-GET Memory allocation errorCAPI-CAT-ALLOC Catalog file allocation errorCAPI-CAT-OPEN Catalog file opening problemSELECT code onlyCAPI-SEL-DIRECT DIRECTION criterion incorrectCAPI-SEL-TYPE TYPE criterion incorrectCAPI-SEL-STATE STATE criterion incorrectCAPI-CAT-EMPTY Catalog emptyCAPI-SEL-DATE EDATE value < BDATE valueCAPI-SEL-FDATE FDATE criterion incorrectCAPI-SEL-CDATE CDATE criterion incorrect


A About APIs


CAPI-SEL-BDATE BDATE criterion incorrectCAPI-SEL-DATE EDATE criterion incorrectNEXT code onlyCAPI-CAT-EOF End of catalog fileCAPI-CAT-READ Catalog file read errorMODIFY code onlyCAPI-MOD-OSTATE State invalidCAPI-MOD-NSTATE Requested new state incorrectCAPI-INT-ERR2 Internal errorCAPIO-COM-OPEN Communication medium opening errorCAPI-COM-WRITE Communication medium write errorCAPI-COM-CLOSE Communication medium closing problemCLOSE code onlyCAPI-MEM-FREE Memory de-allocation errorCAPI-CAT-FREE Catalog file de-allocation errorCAPI-CAT-CLOSE Catalog file closing error


A About APIs


Description of functions

Function Use



l Transfer state

l Diagnostic








Call syntax

CALL "CFTU" USING <verb> <param> <rc>

CALL "CFTC" USING <verb> <param> <rc>

Where:

l CFTU indicates that syntax analysis is requested CFTC indicates that syntax analysis is not requested


l <param> is a character string of variable length that contains the command parameters. The


A About APIs

end of the field is defined by a character initially set to low-value



<verb> Value ServiceF-COM COM Communication mode


<verb> <param> ExplanationF-COM D-COM The COM command parameter structure is as

follows: <medium type> = <Medium name>The medium type consists in an uppercase letter:

l 'F' for file


l 'C' for the configuration file (ConfigFileName)The medium name is the:




Return codes


CAPI-NOERR No errorCAPI-FUNC-UNDEF Command not validCAPI-COM-OPEN Communication medium opening errorCAPI-COM-WRITE Communication medium write errorCAPI-COM-CLOSE Communication medium closing problemCAPI-COM-ALLOC Communication medium allocation problemCAPI-COM-ERR Communication medium not available on this system



F-COM COM Communication modeF-GETINXFO GETINXFO Recovering information about a transfer made from

a synchronous request



A About APIs


F-COM D-COM The COM command parameter structure is as follows: <medium type> = <Medium name>The medium type consists in an uppercase letter:

l 'F' for file


l 'C' for the configuration file (ConfigFileName)

The medium name is the:




F-GETINXFO Z-XINF Information about a transfer in the format described in the OAPIINF file.


A About APIs

Transfer services in COBOLUse the transfer services to send transfer control commands to Transfer CFT, with or without a syntax analysis of these commands. The programming interface proposes a function integrating a syntax analysis of the command to detect any errors, at the source, and a function without syntax analysis, which provides a much smaller coding volume.







Function Use











A About APIs

Function Use





Call syntax

CALL "CFTU" USING <verb> <param> <rc>CALL "CFTC" USING <verb> <param> <rc>

Where:

l CFTU indicates that syntax analysis is requested CFTC indicates that syntax analysis is not requested






F-SEND SEND SendF-RECV RECV ReceiveF-HALT HALT InterruptF-KEEP KEEP SuspendF-START START RetryF-DELETE DELETE DeleteF-END END Proceed to "X" stateF-SUBMIT SUBMIT Re-submit end-of-transfer procedureF-SHUT SHUT Stop monitorF-SWITCH SWITCH Switching monitoring files

(log, statistics file)F-CLOSEAPI CLOSEAPI Freeing resources allocated at the opening of

the communication medium

If <param> is not defined, CFTU takes the default name.


A About APIs

As these media are not available on all systems, an availability check is performed by the function.

Return codes


CAPI-NOERR No errorCAPI-FUNC-UNDEF Command not validCAPI-CMD-LENGTH Transfer CFT command string invalid, does not exist, or greater

than 1024 characters long CAPI-KEY-NAME Command syntax incorrect: keyword name incorrectCAPI-KEY-VALUE Command syntax incorrect: keyword value incorrectCAPI-MEM-GET Memory allocation errorCAPI-MEM-FREE Memory de-allocation errorCAPI-INT-ERR1 Internal error 1CAPI-INT-ERR2 Internal error 2CAPI-INT-ERR3 Internal error 3

Error messagesThe FIELD and MSG fields of the CFTAPI COPY CLAUSE contain:

l FIELD: name of the incorrect parameter detected by the Transfer CFT syntax analyzer

l MSG:

l Either a message relative to the error recognized by the syntax analyzer

l Or an error message describing an incident when the command is taken into account

If no error is detected, the FIELD and MSG fields are blank.


B Appendix B: Menu mapping

Transfer CFT 2.7.11. Customization 1. CFT parameters 1. Source member modifications 2. Interpret selected member 3. Work with examples 2. Set up CFTUCONF configuration file 3. SSL security parameters 1. Modify SSL configuration file 2. Interpret SSL configuration file 3. Start PKIUTIL session 4. Authorization rights parameters 1. Modify Authorization rights configuration file 2. Interpret Authorization rights configuration file 3. Start SECUTIL session 2. Operation "CFTUTIL" 1. Display catalogue - LISTCAT TYPE=ALL 2. Display partners - LISTPART TYPE=ALL 3. Display parameters - LISTPARM TYPE=ALL 4. All CFT Commands 5. Interpret selected member 6. Start CFT monitor 7. Stop CFT monitor - SHUT 3. COPILOT Server commands 1. Start COPILOT Server 2. Stop COPILOT Server



Transfer CFT 3.0.1 1. Customization 1. CFT parameters 1. Source member modifications 2. Interpret selected member 2. Internal PKI database 1. Modify SSL configuration file 2. Interpret SSL configuration file 3. Internal Access Management 1. Modify Internal Access Management file 2. Interpret Internal Access Management file 3. Start SECUTIL session 2. CFT Operations 1. Display catalog - LISTCAT TYPE=ALL 2. Display partners - LISTPART TYPE=ALL 3. Display parameters - LISTPARM TYPE=ALL 4. CFTUTIL 5. PKIUTIL 6. Interpret selected member 7. Start UI Server 8. Stop UI server 9. Start CFT monitor 10. Stop CFT monitor - SHUT



Transfer CFT 3.1.3 SP41. Common Transfer CFT commands

1. Start Copilot 2. Stop Copilot 3. Start CFT 4. Stop CFT 5. CFTUTIL operations 6. Interpret source member 7. Manage configuration File





Note: A highlighted menu item indicates there is a sub-menu.



Transfer CFT 3.2.x and higher1. Common Transfer CFT commands

1. Start Copilot 2. Stop Copilot 3. Start Transfer CFT 4. Stop Transfer CFT 5. CFTUTIL operations 6. Manage configuration File





Note: A highlighted menu item indicates there is a sub menu.


Transfer CFT Installation Guide IBM i - Axway Documentation ...

Documents

Transcript of Transfer CFT Installation Guide IBM i - Axway Documentation ...