Configuration reference for file transfers to or from remote hosts

name

Name of the PGP template, up to 30 characters long

executableFullPath

Name and location of the executable file for the PGP application

exitCode

Code of a successful PGP operation

passphrase

The passphrase that is used to decrypt the file

recipient

Name of the recipient that is defined in the encrypt command

encryptionAttributes

PGP command line parameters for encryption

Within the command line, you include the following variables:

• $$PGP_RECIPIENT$$: Recipient name that is defined the Recipient field (optional)
• $$PGP_INPUT_FILE$$: Name of the file to encrypt (required)
• $$PGP_OUTPUT_FILE$$: Name and location of the encrypted file (required).
  Use the output option of your PGP application together with this variable.

The following command line is an example of a GnuPG encryption command:
-e -r $$PGP_RECIPIENT$$ -o $$PGP_OUTPUT_FILE$$ $$PGP_INPUT_FILE$$

decryptionAttributes

PGP command line parameters for decryption

Within the command line, you include the following variables:

• $$PGP_PASSPHRASE$$: The passphrase that is defined in the Passphrase field.
  This optional variable provides additional security, as you do not have to write the passphrase in the PGP command.
• $$PGP_INPUT_FILE$$: Name of the file to encrypt (required)
• $$PGP_OUTPUT_FILE$$: Name and location of the encrypted file (required).
  Use the output option of your PGP application together with this variable.

The following command line is an example of a GnuPG decryption command:
-d --batch --passphrase $$PGP_PASSPHRASE$$ -o $$PGP_OUTPUT_FILE$$ $$PGP_INPUT_FILE$$

name

Name of the z/OS template.

The first character cannot be an integer.

recordFormat

Value for the record format

logicalRecordLength

Logical record length, values between 0-32760

blockSize

Block size values between 0-32760

translationTable

The name of the table used by the FTP server during transfer for translation, up to 8 characters

transferMode

Mode of file transfer:

• Block: Transfers the file as a series of data blocks preceded by one or more header bytes.
• Stream: Transfers the file as a stream of bytes.

Transfer mode is valid only for transfer of files from z/OS to z/OS.

smsManagmentClass

The SMS Management Class assigned to a new data set

allocationUnits

Type of allocation unit used for the transfer

volume

Volume value, up to 6 characters

unit

Unit value, up to 8 characters

primaryAllocation

Primary allocation amount, between 1-16777215

secondaryAllocation

Secondary allocation amount, between 1-16777215

smsDataClass

The SMS Data Class provided by your organization for the FTP server

dbcsEncoding

The double-byte character set (DBCS) to use for the transfer

transferToUniqueFile

Whether to create a file with a unique name on the remote system instead of overwriting an existing file.

Values are either true of false

additionalOptionsHost1

Two optional properties for additional FTP Server SITE command sub-parameters and values

Allowed values for these properties are up to 214 characters.

additionalOptionsHost2

connectionTimeoutInSeconds

The number of seconds to allow for establishing a connection with an FTP server before timing out

Default: 30 seconds

connectionRetries

The number of times to try to connect after failing to connect with an FTP server

Note: If the remote FTP server runs on a z/OS system, this parameter has no effect.

Valid values: 0-99
Default: 5

connectionTimeBetweenRetriesInSeconds

The number of seconds between attempts to connect to an FTP server

Default: 6 seconds

debugLevel

Debug level of Control-M MFT

Valid values range from 0 to 4, where 0 indicates no diagnostic activity, and 4 indicates the highest level of diagnostic functionality.

Default: 0

Note: If the debug level of the Control-M/Agent is higher than Control-M MFT, then the debug level of Control-M MFT is based on the Control-M/Agent.

pgpTempDir

A temporary location where PGP files are stored

Users defined in the relevant connection profile must have read and write permissions for this temporary directory.

Default: <Control-M/Agent_Home_Dir>\cm\AFT\pgp_tmp

sslDebugTrace

Whether to run SSL diagnostics in Control-M MFT

Values are either true or false. The default is false.

pamAuthentication

Whether to authenticate the local host with PAM-based authentication (Solaris, HP-UX, and Linux computers only)

Values are either true or false. The default is false.

proxyIsInUse

Whether to transfer files through a Web Proxy server (available for FTP, FTPS, SFTP, and S3)

Values are either true or false. The default is false.

proxyHost

Host name of the proxy server

proxyPort

Port number of the proxy server

proxyUser

User name for the connection to the proxy server

proxyPassword

Password for the proxy server user

fileWatcherSearchInterval

The number of seconds between successive attempts to detect the existence of a file and between attempts to monitor the size of a detected file

Valid values: 1-9999
Default: 30 seconds

fileWatcherStaticIterations

Numbers of attempts to monitor the file size when it is static after it has reached its minimum detected size

Valid values: 1-999
Default: 3

fileWatcherCheckFileIsInUse

Whether to check that the file is not being used by another process or application on a local host

Values are either true or false. The default is false.

fileActionsRetriesIntervalInSeconds

Number of seconds to wait before attempting to perform a post action on the source or destination file after a successful transfer

Valid values: 1-9999
Default: 5 seconds

fileActionsRetriesNum

Number of times to retry a post action on the source or destination file after a successful transfer

Valid values: 0-999
Default: 3