Optional Transfer Parameters
You can supply the optional transfer parameters as you want when you run the cfsend or cfrecv command.
Parameter (Alternate Specification) | Description |
---|---|
UTF8BOM (bom) | Defines if files need to be encoded in UTF-8.
The default value is N. |
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. |
ClassOfService (cos) |
Defines the buffer size for the platform server in a transfer. The valid values are the different levels of SBUFSIZE and RBUFSIZE specified in the configuration file named cfcos.cfg. The transfer performance can be improved as server and client using different level of classes. |
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:
|
ConfigFileName (cf) | Defines the path of the configuration file on the local machine. |
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.
The valid values are:
|
CreationOption (co) | Defines the remote file creation options.
The valid values are:
|
EmailFailure (emf) | Defines the email address or addresses to which
TIBCO MFT Platform Server sends a message 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 your email settings are configured in the config.txt file. |
EmailSuccess (ems) | Defines the email address or addresses to which TIBCO MFT Platform Server sends a message when a transfer is successful. You can specify multiple email addresses by delimiting the email addresses with a comma. |
EncryptionType (en) | Defines the type of encryption that is used for the transfer. |
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. |
IpName/Address (ip) | Defines the host name or the IP address of the remote system. |
LIST (l) | Defines the distribution list you want to use for the transfer request.
The maximum length of the defined value is 32 characters. For more information, see Distribution Lists. |
LocalCTFile (lct) | Defines the name of the local conversion table file.
For more information, see
Conversion Tables/Custom Code Conversion.
|
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:
|
Port | Defines the IP port on which
TIBCO MFT Platform Server listens for incoming requests.
The valid values are from 1024 to 65535. |
Post_Action (ppa)
Post_Action1 (ppa1)
Post_Action2 (ppa2) Post_Action3 (ppa3) Post_Action4 (ppa4) |
Defines the command you want to use upon the completion of a transfer.
You can define this command up to four times with the following command: Post_Action="S|F,L|R,COMMAND,command data" Where: S | F means success or failure. L | R means local or remote. COMMAND refers to the command you want to use after the file transfer is completed. 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. For more information, see TIBCO Managed File Transfer Platform Server for z/OS User's Guide. If you transfer files to
TIBCO MFT Platform Server for Windows:
|
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.
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: When defining this parameter, you have to set the
LocalCTFile as
NULL, to ensure no translation takes place locally.
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 failed transaction can be retried. |
ScanSubDir (ssd) | Defines whether all subdirectories from the file path are scanned.
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. |
SilentMode (sm) | Defines whether the progress message (in bytes) is displayed on the output screen on the initiator side. |
TLS/SSL | Defines whether you use TLS/SSL communication for transfers.
The valid values are:
For more information, see
TLS/SSL Certificates Setup.
|
SSLPort (tport, sport, tlsport) |
Defines the port that MFT Platform Server uses to connect to the target system when TLS or tunnel requests are initiated. Valid values are from 1024 to 65535 and must match the port that the target server is listening on. This parameter should be used when the TLS parameter is set to Y (TLS Mode) or T (Tunnel Mode). If TLS=Y or TLS=T is defined and this parameter is not set, Platform Server will use the port defined by the port parameter. If TLS=Y is specified and port, sport and tport are not defined, port 56565 will be used. If TLS=t is specified and port, sport and tport are not defined, port 58585 will be used. For more information, see TLS/SSL Certificates Setup. |
StopOnFailure (sonf) | Defines whether to stop transferring the rest of files in the directory when the current file transfer fails. The valid values are Y or N. |
Template (t) | Defines the file name of the 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. The valid values are Y or N. |
Timeout (to) | Defines the amount of time in minutes a connection stays open when waiting for a response from the remote side.
Once this amount of time is reached, the connection ends. |
TransferType (trtype) | Defines the type of transfer you want to perform.
The default value is File. The valid values are:
For more information, see Transfer Commands. |
Truncate (trunc) | The valid values are: |
TryNumber (trynum) | Defines the number of times the transfer can be attempted.
The valid values are:
|
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, the permissions of the file can be in the control record. If no values are passed in the control record, the responder uses the system default permissions.
|
UserData (ud) | Defines the description for the transfer in the local and remote system.
This is 25 character field for user comments, and it can contain any alphabetic, numeric, or national characters. |