FTP Quote

The FTP Quote activity sends an arbitrary FTP command to the FTP server. You can determine which FTP commands are supported by using the Available Commands button on the FTP Connection shared configuration resource. FTP commands vary by operating system and by FTP version and configuration, so you should determine which commands are available on the remote server before using this activity.

The Configuration tab has the following fields.

Field	Global Var?	Description
Name	No	The name to appear as the label for the activity in the process definition.
Description	No	Short description of the activity.
FTP Connection	No	Path to the shared configuration resource containing the user information such as host name, user name, and password. See FTP Connection for more information.
Quit (post-command)	No	When checked, this field specifies that the FTP connection should be closed after completing this command. If this field is not checked, the FTP connection remains open so that all FTP activities that specify the same FTP session (that is, the same host, port, username, and password) share the FTP session until the connection is closed.
Has Socket Data	No	If checked, indicates that data will be sent back by the FTP server as a result of executing the command.

The name to appear as the label for the activity in the process definition.

Description

Short description of the activity.

FTP Connection

Path to the shared configuration resource containing the user information such as host name, user name, and password. See FTP Connection for more information.

Quit (post-command)

When checked, this field specifies that the FTP connection should be closed after completing this command.

If this field is not checked, the FTP connection remains open so that all FTP activities that specify the same FTP session (that is, the same host, port, username, and password) share the FTP session until the connection is closed.

Has Socket Data

If checked, indicates that data will be sent back by the FTP server as a result of executing the command.

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
Host	string	The name of the FTP server. This overrides the value specified in the FTP Connection resource.
Port	integer	Port number for incoming FTP requests on the FTP server. This overrides the value specified in the FTP Connection resource.
UserName	string	Username for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
Password	string	Password for logging into the FTP server. This overrides the value specified in the FTP Connection resource.
RemoteSiteCommand	string	Optional, system-specific command to be executed before the specified command is executed.
ValidReturnCode	string	Optional list of valid return codes for validating the reply. Codes are three-digit numbers. To specify multiple codes, separate each code with a comma or a space. If the remote server returns a code not specified in this list, this activity raises an exception.
RemoteCommand	string	Command to be executed on the remote FTP server.
Timeout	integer	The amount of time to wait for the FTP server to respond. This timeout is used when the FTP server places the FTP connection used by this activity into a waiting state. This overrides the value specified in the FTP Connection resource. See FTP Connection for more information.

The name of the FTP server. This overrides the value specified in the FTP Connection resource.

Port

integer

Port number for incoming FTP requests on the FTP server. This overrides the value specified in the FTP Connection resource.

UserName

string

Username for logging into the FTP server. This overrides the value specified in the FTP Connection resource.

Password

string

Password for logging into the FTP server. This overrides the value specified in the FTP Connection resource.

RemoteSiteCommand

string

Optional, system-specific command to be executed before the specified command is executed.

ValidReturnCode

string

Optional list of valid return codes for validating the reply. Codes are three-digit numbers. To specify multiple codes, separate each code with a comma or a space.

If the remote server returns a code not specified in this list, this activity raises an exception.

RemoteCommand

string

Command to be executed on the remote FTP server.

Timeout

integer

The amount of time to wait for the FTP server to respond. This timeout is used when the FTP server places the FTP connection used by this activity into a waiting state.

This overrides the value specified in the FTP Connection resource. See FTP Connection for more information.

The output for the activity is the following.

Output Item	Datatype	Description
CommandItems	string	Each element in this repeating element is a returned value from the command executed on the remote server.

Each element in this repeating element is a returned value from the command executed on the remote server.

The Error Output tab lists the possible exceptions that can be thrown by this activity. See TIBCO ActiveMatrix BusinessWorks Error Codes for more information about error codes and corrective action to take.

Exception	Thrown When...
ConnectionErrorException	An error occurred when connecting to the FTP server.
CommandExecutionException	An error occurred when executing the FTP command.

Exception

Thrown When...

ConnectionErrorException

An error occurred when connecting to the FTP server.

CommandExecutionException

An error occurred when executing the FTP command.