Optional Transfer Parameters

ASCII_to_EBCDIC (eb)

Defines the type of data translation that is required for the remote system.

The valid values are:

Binary | N | 0: the file is binary and does not require any translation.
ASCII | A | 1: the file is ASCII and does not require translation, but can require CR/LF (carriage return, line feed) insertion.
Text | Y | 2: the file is ASCII and the remote system requires EBCDIC, the data is translated by TIBCO MFT Platform Server for UNIX. This value is typically used for transfers to a z/OS system.

Note: This parameter is used when sending files from UNIX to z/OS.

CheckPointInterval (cpint)

Defines how often a checkpoint is taken.

The default value is N. If the transfer fails after taking a checkpoint, the transfer continues from that last checkpoint.

The valid values are:

N: no checkpoint.
Y | 1: the checkpoint is taken every minute.
2 to 90: the checkpoint is taken at this specified interval.

ClassOfService (cos)

Defines the class of service for transfer.

The valid values are class of service names defined in the cfcos.cfg file. These entries define the Send and Receive TCP Buffer sizes. Increasing these values can improve performance in a high latency environment.

Compression (cmp)

Defines the type of compression you want to use. We strongly suggest using ZLIB or RLE compression. LZ compression uses a lot of CPU and the compression results are not as good as with ZLIB.

The valid values are:

R | Y: Run Length Encoding (RLE) compression.
LZ: Limpel-Zev (LZ) compression.
ZLIB1 through ZLIB9: levels of zlib compression.
Level 1 is fast but provides the lowest ratio of compression. Level 7 to 9 produce the best quality of compression, but are much slower. ZLIB2 typically provides the best balance between compression and speed.
N: no default compression.
NEVER: never uses any compression.

CONVTBL(ct)

Defines the path of the conversion table.

This parameter is not used if the LocalCTFile parameter is specified.

For more information, see Conversion Tables/Custom Code Conversion.

CR_LF (crlf)

Defines the carriage return (CR) and line feed (LF) control for transfers using the cfsend or cfrecv command between UNIX and Windows.

Note: When you perform transfers to or from z/OS, you can use this parameter or the DELIM parameter.

The valid values are:

Y | CRLF: CR is deleted when you receive a file on UNIX. CR is added before the LF (line feed) when you send a file on UNIX.
L | LF: records are delimited by LF. This is typically used when you transfer text data to z/OS. Note that line conversion is performed on z/OS. No processing is performed by TIBCO MFT Platform Server for UNIX .
CRLFY: CR is not added to LF when you send a file on UNIX. Likewise, CR is not removed when you receive a file on UNIX. This applies to the rare case when a UNIX file contains CRLF, or if the application requires CRLF instead of LF.
N: no record delimiter is applied in the file. This typically applies for a binary transfer.

CreationOption (co)

Defines the remote file creation options.

The valid values are:

R: replaces an existing file. This only works when the remote file already exists.
A: appends to an existing file. This only works when the remote file already exists.
C: creates a new file at the remote location. This only works when the remote file does not exist.
CR | X: creates a new file or replaces an existing file. This is the default option.
CA | Y: creates a new file or appends to an existing file.
CRN | Z: creates a new file, and if necessary, creates the directory path to this file or replaces an existing file.

EmailFailure (emf)

Defines the email address or addresses to send an email when a transfer fails. You can specify multiple email addresses by delimiting the email addresses with a comma.

Note: In a directory transfer, when EmailFailure is specified, if any of those file transfers fails, an individual email is sent for that failed transfer and a summary email is sent when the directory transfer is completed. If all the files within the directory are transferred successfully, nothing is sent.

Ensure the SMTP email settings are configured in the config.txt file.

EmailSuccess (ems)

Defines the email address or addresses to send an email when a transfer is successful. You can specify multiple email addresses by delimiting the email addresses with a comma.

Note: In a directory transfer, when EmailSuccess is specified, if all the files within the directory are transferred successfully, only a summary email is sent. If any of those file transfers fails, nothing is sent.

Ensure the SMTP email settings are configured in the config.txt file.

EncryptionType (en)

Defines the type of encryption that is used for the transfer.

The valid values are:

N | 0: no encryption
DES | 1 : DES encryption
3DES | 2 : triple DES encryption
Blowfish | BF | 3: Blowfish encryption
BlowfishLong | BFL | 4: Blowfish Long (448-bit) encryption
AES | Rijndael | RIJN | RJ | 5: AES 256-bit encryption
AES128: AES 128 encryption

Note: When encryption is required, it is a good practice to use AES (256-bit) encryption.

ExitPrgm (ep)

Defines the path to the exit program on the local machine.

You can use the exit program to customize post processing.

For more information, see User Exits.

epop or ExecPostProc

Defines whether the postprocessing action executes after each file in a directory or a distribution list which is transferred. The valid values are Child, Parent, and Default. The default value is Child.

Child: postprocessing is performed after each transfer.

Parent: postprocessing is performed after all files have been transferred.

When this parameter is set to Parent, the following rules apply:

• StopOnFailure is automatically set to Yes. Transfers stop on the first failed transfer.

• Failure PPA runs on the first failed transfer.

• Successful PPA runs only on the last transfer (assuming it is successful).

For more information, see Client Configuration Parameters.

epep or ExecPreProc

Defines whether the preprocessing action executes before the start of the first transfer. The valid values are Child, Parent, and Default. The default value is Child.

Child: Preprocessing is performed before each transfer.

Parent: Preprocessing is performed once per directory transfer, before any individual file transfer is started.

For more information, see Client Configuration Parameters.

IpName/Address (ip)

Defines the host name or the IP address of the remote system. Do not use this parameter when the node parameter is defined.

LIST (l)

Defines the distribution list you want to use for the transfer request.

The maximum length of the defined value is 32 characters. This parameter is only supported on send transfers.

For more information, see Distribution Lists.

LocalCTFile (lct)

Defines the name of the local conversion table file.

Note: You must set the ASCII_to_EBCDIC parameter to Y to use this parameter.

For more information, see Conversion Tables/Custom Code Conversion.

MaintainFiletimeStamp

Defines the option to maintain file creation time stamps between servers. Valid values are Yes and No.

When the value is set to Yes,

if a file is sent, then the newly created file on the remote side will have the same date/time as the local one.
if a file is received, then the newly created file on the local side will have the same date/time as the remote one.

PermittedActions (pa)

Defines the permitted actions for the transferred files.

Note: The following values are Windows specific and are only valid when you transfer files to Windows.

The valid values are:

S | SYSTEM_FILE: a system file that can only be viewed by the operating system and not the user.
H | HIDDEN_FILE: a hidden file that cannot be seen by the user.
R | READ_ONLY: a file that can only be viewed by the user. Users cannot modify the file.
C | NTFS_COMPRES: a file that can be compressed in the remote system. This option is only valid on NTFS partitions. Otherwise, it is ignored.
Z | EOF_CRLF: with this option, a CR/LF (0x0d, 0x0a) is appended to the end of the file, followed by the DOS End of File character, Control Z (0x1a). If a trailing Control Z or CR/LF already exists, they are not added again. This option is only valid when CR/LF processing is enabled.
E | EOF: with this option, a DOS End of File character, Control Z (0x1a), is appended to the file.

Port

Defines the IP port on which TIBCO MFT Platform Server listens for incoming requests. You should not define this parameter when the node parameter is defined.

The valid values are from 1024 to65535.

Post_Action (ppa)

Post_Action1 (ppa1)

Post_Action2 (ppa2)

Post_Action3 (ppa3)

Post_Action4 (ppa4)

Defines preprocessing or postprocessing the command you want to use.

You can define this command up to four times with the following command:

ppa="P,L|R,COMMAND,command data"

ppa="S|F,L|R,COMMAND,command data"

Where:

P means preprocessing

S | F means postprocessing success or failure.

L | R means local or remote.

COMMAND refers to the command you want to execute. This is the only option currently supported by a UNIX responder.

command data refers to the absolute path and file name of the command and any parameters to be used. This is limited to 256 bytes.

You cannot use any spaces in the Post_Action command. If the remote system is a mainframe, then CALLJCL, CALLPGM, and SUBMIT parameters are also supported besides COMMAND.

If you transfer files to TIBCO MFT Platform Server for Windows:

You can append a # sign to the end of the entered data: TIBCO MFT Platform Server for Windows launches the PPA and waits for the return code of the action.
You can append a & sign to the end of the data entered: TIBCO MFT Platform Server for Windows launches the PPA and does not wait for the action to finish. This is the default behavior.

For more information, see Post Processing Actions.

ProcessName (pn)

Defines the process name used for the file transfer.

The maximum length of the defined value is 8 characters.

RemoteCommand (rcmd)

Defines the command you want to use in the remote system. This parameter is valid only when TransfeType is set to Command.

The default value is No. The valid values are N or the command you want to use.

RemoteCTFile (rct)

Defines the name of the remote conversion table file.

Note: Note: When defining this parameter, you have to set the LocalCTFile as NULL, if you want all conversion to take place on the remote machine.

For more information, see Conversion Tables/Custom Code Conversion.

RemotePrinterName (rp)

Defines the name of the remote printer to which you send the job.

RetryInterval (ri)

Defines the interval in minutes after which a retryable transaction can be retried.

Note: This parameter only applies when the value of the TryNumber parameter is greater than 1.

The valid values are:

N: the failed transaction is retried immediately.
Y | 1: the failed transaction is retried after one minute.
number_of_minutes (more than 1): the failed transaction is retried after this defined interval. The default is to retry after waiting one minute.

ScanSubDir (ssd)

Defines whether all subdirectories from the file path are scanned for files to transfer.

Note: This parameter only applies to directory transfers.

The valid values are Y or N.

SecurityAttribTemplate (sa)

Defines the file that the remote Windows platform uses as a template for Access Control List (ACL).

The ACL of this file is copied to the ACL of the destination file.

Note: For the access control feature to function properly on Windows, the file specified must be readable by the partner that receives the file to file transfer, and the created file must be located on an NTFS drive.

SilentMode (sm)

Defines whether the progress message (in bytes) is displayed on the output screen on the initiator side.

The valid values are:

Y: the progress message (in bytes) is not displayed on the output screen on the initiator side.
N: the progress message (in bytes) is displayed along with the typical output on the screen. This is the default value.

Note: You can best observe the transmission progress in bytes when the file you transfer is large. When a transfer is executed by DNI, you should set SilentMode to Y.

StopOnFailure (sonf)

Defines whether to stop transferring the rest of files in the directory when the current file transfer fails.

Note: This parameter applies to directory transfers and distribution list transfers.

The valid values are Y or N.

Template (t)

Defines the file name of the transfer template.

Note: This parameter cannot be set inside a transfer template.

For more information, see Transfers Using Templates.

Test

Defines whether to display the local and remote file names to verify if the file names are correct, instead of doing the actual transfers.

Note: This parameter applies to directory transfers and distribution list transfers.

The valid values are

or N.

Timeout (to)

Defines the amount of time in minutes a connection stays open when waiting for a response from the remote side. This parameter overrides the TIMEOUT value configured in the config.txt.

Once this amount of time is reached, the connection ends.

TLS/SSL

Defines whether you use TLS/SSL communication for transfers.

The valid values are:

N: does not use TLS/SSL communication
Y: uses TLS/SSL communication
T: uses TLS tunnel communication

For more information, see TLS/SSL Certificates Setup.

TraceLevelTransfer

Defines tracing to be set for a transfer on the initiator and on the responder. If the responder supports this parameter, it also turns on tracing for the transfer.

Y: tracing is turned on for a transfer
N: tracing is not turned on for a transfer. This is the default value.

TransferType (trtype)

Defines the type of transfer you want to perform.

The default value is File.

The valid values are:

F | File: you can send your local file to the remote file.
J | Job: you can send your local file to the remote system. The remote server runs it and sends you an error message if the running fails. You can receive the remote file and run it on your side, and get an error message if running fails.
C | Command: you can send the command to the remote system and receive a result. If you specify LocalFileName, the result of the command is saved there; otherwise, the result is printed out. If the remote command fails, you receive an error message with a return code describing the reason of the failure.
Note: The C | Command option only works with the cfsend command.
P | Print: you can send a local file to a remote system. The partner executes the file as a print job.

For more information, see Transfer Commands.

Truncate (trunc)

The valid values are:

YES: when a record longer than the z/OS LRECL is received, the record is truncated.
NO: when a record longer than the z/OS LRECL is received, the transfer is terminated with an error.
WRAP: when a record longer than the z/OS LRECL is received, the record is split into multiple records.

TryNumber (trynum)

Defines the number of times the transfer can be attempted.

The valid values are:

0 | U | Unlimited: the transfer can be attempted 9999 times or until it is successful. It restarts the transfer from the beginning unless the CheckPoint/Restart option is set.
N | 1: the transfer can be attempted only one time. The default value is 1.
2 to 9998: the transfer can be attempted for the specified number of times.

UNIXPermissions (uperm)

Defines the UNIX permissions for the file.

When a file is created in UNIX, TIBCO MFT Platform Server can set the UNIX permissions on the file. UNIX permissions are defined by a three digit number such as 777 (the same as the chmod command).

The default value for this parameter is the file permissions of the file transferred. This parameter works differently for a send transfer than a receive transfer.

If a send transfer is initiated and the UNIXPermissions parameter is defined, this value is passed to the remote system. If this parameter is not defined, operating system UMASK parameter is used to set the file permissions. If no values are passed in the control record, the responder uses the system default permissions.

Note: You can only set up the permissions for the file when the file is created. For example, UNIXPermissions works only with the Create, CreateReplace, and CreateReplaceNew options when the file is created.

UserData (ud)

Defines the description for the transfer in the local and remote system.

This is a 25-character field for user comments, and it can contain any alphabetic, numeric, or national characters.

UTF8BOM (bom)

When performing iconv conversion on Platform Server for z/OS, defines if BOM (Byte Order Marks) are added to, or removed from, the target file.

The default value is N.

The valid values are:

A: add BOM.
R: remove BOM.
B: add/remove BOM.
N: None.