ListFile

The ListFile command action is used to list the files that match the defined selection criteria.

The CFInternet client communicates with the TIBCO MFT Internet Server defined by the Global.xml file. It extracts a list of all files that the user can transfer and compares it against the filters that are defined. If multiple filters are defined, all filters must match for the file to be displayed.

Parameter Description Default Required
ClientFileName Specifies the 1 to 256 byte client file name to be used as a filter.

The ClientFileName is compared against the ClientFileName of the TIBCO MFT Internet Server file definitions returned to CFInternet. If they match, then the file is compared against any other filters defined.

This field is case sensitive. The asterisk (*) may be used as a wildcard character.

For example: ClientFileName:/prod/acct/file1.txt

None No
Description Specifies the 1 to 256 byte description to be used as a filter.

The Description is compared against the Description of the TIBCO MFT Internet Server file definitions returned to CFInternet. If they match, then the file is compared against any other filters defined.

This field is case sensitive. The asterisk (*) may be used as a wildcard character.

For example: Description:Prod_ACCT_Y2005

None No
FileId Specifies the ID of the transfer file definition. None No
FileName This parameter is used only on directory download requests.

It allows the user to define a single server file name to download. It is allowed only on ListFile and ProcessFile calls. The asterisk (*) may be used as a wildcard character.

None No
LocalFileName Specifies the local file or directory name used for upload or download. If no value is provided, the client file name is used. None No
SubDir For directory uploads, if required, specifies TIBCO MFT Internet Server to scan subdirectories for files to transfer.

For directory downloads, if required, specifies TIBCO MFT Internet Server process data in TIBCO MFT Internet Server subdirectories.

When No is specified, TIBCO MFT Internet Server processes files only in the defined directory.

When Yes is defined, TIBCO MFT Internet Server processes files in subdirectories as well as in the defined directory.

This parameter is valid only for TIBCO MFT Internet Server file definitions defined with the directory flag. It is ignored for all other requests.

This parameter is supported on all List and Process calls.

None No

Sample ListFile Command

The sample command below shows how to list the file that matches the defined selection criteria from the command line.

java cfcc.CFInternet a:ListFile Description:Prod_ACCT_Y2005