SearchForTransfers

The SearchForTransfers command action is used to search for all file definitions that match the defined selection criteria.

You should use the percent sign (%) as a wildcard character for SOAP web service and asterisk (*) as a wildcard character for REST web service in all parameters to select file definitions based on a partial key.

To use the SearchForTransfers action command, you must have UpdateTransferDefinitionRight. For more information on this right, see AddUserToRole.

Parameter Description Default Required
AuthGroupId Specifies the 1 to 64 character TIBCO MFT Command Center group ID that is authorized to transfer this file.

A transfer can be authorized to a user or a group. See also the UserId parameter.

All No
Department

Specifies the department associated with the file. The value is ignored for department admin.

None No
Description Specifies the 1 to 256 character description of this file. This description will be presented to the client user to describe the contents of the file.

If the description contains embedded spaces, the entire description must be enclosed in double quotation marks (").

None No
ExpiredTransfers

Specifies the valid values for this parameter are as follows: Y:yes, N:no

None No
FTPAlias Specifies the transfer virtual alias. None No
ServerFileName Specifies the 1 to 256 character file name or location of the server machine.

If the server name is *LOCAL, the server file name will be located on the TIBCO MFT Command Center server.

If the file name or location contains embedded spaces, the entire file name must be enclosed in double quotation marks (“).

None No
ServerName Specifies the 1 to 64 character name of the TIBCO MFT Command Center node within your network.

A TIBCO MFT Command Center node is a target destination that is running TIBCO MFT Platform Server that can send or receive files.

The server name might also be specified as *LOCAL, which refers to the TIBCO MFT Command Center server. The TIBCO MFT Command Center server does not have to be running TIBCO MFT Platform Server. 		None No
TransferId Specifies the 12 character transfer ID that was assigned when the file definition was added. None No
UserId Specifies the 1 to 64 character TIBCO MFT Command Center user ID of the user who is authorized to transfer this file.

A transfer can be authorized to a user or a group. See also the AuthGroupId parameter.

None No

Sample SearchForTransfers Command

This command searches for all file definitions that match the selection criteria.

Note that the ServerFileName parameter uses the wildcard character to match based on a partial key, while the ServerName parameter must exactly match the value in the file record.

java cfcc.CFAdmin a:SearchForTransfers ServerFileName:/tmp/% ServerName:NYNode1