Client Configuration Parameters

The following table lists parameters (in alphabetical order) that are used by TIBCO MFT Platform Server to configure cfsend and cfrecv client (i.e. Initiator) transfers.

Parameter Description
ACCHost

Defines the IP address or host name of the Remote Accelerator server.

ACCPort

Defines the port number on which the Remote Accelerator server listens for transfers using the Accelerator technology.

The default number is 9099.

ClassOfService

Defines the default class of service entry name for initiator transfers.

ConnectAdapterIP Defines the IP address through which the initiator sends or receives data for outgoing connections.

The default value for this parameter is ALL which means connections can bind to any IP address.

If a machine has more than one IP address, it is possible to bind the connection to a particular one. It guarantees that all the transfers only go through this particular IP address.

ConnectAdapterIPv6 Defines the IPv6 address through which the initiator sends or receives data for outgoing connections.

The default value for this parameter is ALL which means connections can bind to any IPv6 address.

If a machine has more than one IPv6 address, it is possible to bind the connection to a particular one. It guarantees that all the transfers go only through this particular IPv6 address.

ExecPostProc

Defines whether to have the postprocessing action executes after each file in a directory is transferred or after the entire directory is transferred.

Note: If ExecPreProc or ExecPostProc is set to Parent, then %TRN for Dir Transfer is resolved as the transaction ID of the parent transfer. If ExecPreProc or ExecPostProc is set to Child, then %TRN for Dir Transfer is resolved as the transaction ID of the individual transfer.

The valid values are Child or Parent. 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:

  • StopsOnFailure is automatically set to Yes. Transfer stops 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).

Note: Since this is a global parameter, it affects all transfers. This parameter can be overriden on the cfsend or cfrecv command line by the epop parameter.

ExecPreProc

Defines whether to have the preprocessing action executes before each file in a directory or only once before any file transfer starts.

The valid values are Child or Parent. The default value is Child.

Child: Preprocessing is performed before each file transfer.

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

Note: Since this is a global parameter, it affects all transfers. This parameter can be overriden on the cfsend or cfrecv command line by the epep parameter.

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.

RequiredNodeDefinition Defines whether a node definition is required for TIBCO MFT Platform Server when initiating transfers to a remote system.

Value Y means that the cfsend or cfrecv requires a defined node. If the node parameter is not defined, the initiator rejects the transfer and displays an error message.

StopOnFailure Defines the default value for StopOnFailure when this parameter is not specified by the cfsend or crfrecv commands. StopOnFailuredefines whether a directory transfer or distribution list transfer should stop on the first failure (Y) or continue if a transfer fails.
Timeout Defines the amount of time in minutes that a connection stays open when waiting for a response from the remote side.

The default value is 10 minutes. Once the timeout value is reached, the transfer terminates with a retry-able error.

TraceLevelClient Defines the level of tracing that occurs.

The valid values are:

  • N|No: no tracing takes place. This is the default value.
  • L|Low: provides minimal information about the transfer, including local and remote transaction numbers, file names, the number of bytes transferred, fail or success status indicator, general message string, and the start and finish times of the transfer.
  • M|Medium: includes all internal state messages.
  • H|High : includes all networking data in addition to the information provided by the medium level trace.

Usually tracing has only to be turned on at the request of TIBCO Support for troubleshooting purpose.

Note:
  • This parameter cannot be used within a transfer template.
  • When the TraceLevelClient is used, the TraceSizeClient must be defined.

TracePathClient Defines the name of the path that holds the client trace file.

A unique trace file is created for each file transfer. A file name contains the local transaction number and Process ID (PID).

Note: This parameter cannot be used within a transfer template.
TraceSizeClient Defines the size limit of the trace file in kilobytes.

The file name is the trace file name (local transaction number and PID) with a t1 extension. When the specified size limit is reached, a second file with a t2 extension is created. When the second file is full, all data contained in the t1 file is deleted and it begins again from size 0. This process then repeats on the t2 file. This trace file swapping continues for the duration of the file transfer.

Note:
  • This parameter cannot be used within a transfer template.
  • When TraceSizeClient is used, TraceLevelClient in the client part must be defined.

Umask_User

Defines whether to apply the user's umask to the incoming files (cfrecv only).

Note: This parameter only applies to the initiator that is doing a receive transfer.

  • If Umask_User is set to N, the user's umask is ignored on incoming files.
  • If Umask_User is set to Y, the user's umask is applied to incoming files.