Configuration

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. For more information, see FTP Connection .

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.

Use Process Data

Yes

Specifies to write contents of the file retrieved from the FTP server to the process data. The activity’s output includes an element that contains the remote file’s contents, and the data can be used by subsequent activities in the process definition.

Warning: Do not use this option if you are retrieving multiple files. You can only write the contents of one file to this activity’s output. An error is returned if you specify wildcards in the RemoteFilename input element when this field is checked.

Binary

Yes

Specifies whether to retrieve the file content in binary or ASCII mode (checked signifies binary).

When ASCII mode is used, differences in line endings between the FTP server and the machine executing the FTP command are automatically handled. Also, ASCII mode implies text data, and that data can be encoded in a character encoding other than ASCII (such as UTF-8 or Latin-1).

Overwrite Existing File

Yes

When this field is checked, and the Use Process Data field is unchecked, any existing local files are overwritten if the FTP command returns files with the same names.

If this field is unchecked, any attempt to write a file to disk with the same name as an existing file results in an exception.

Maintain 2.0 Compatibility

No

This field is present only for activities migrated from ActiveMatrix BusinessWorks 2.0. If checked, this field ensures the output schema retains the elements available in ActiveMatrix BusinessWorks 2.0.