Configuring FTP Adapter Invoke Operations Properties

Enter the FTP Adapter operation properties

What You Can Do from the FTP Adapter Invoke Operations Parameters Page

You can configure the following parameters on the FTP Adapter invoke Operations page.

  • Choose one of the following operations to perform on files. Depending on which operation you choose, you are presented with different options and parameters that apply specifically to that operation.
    • Read a File

      Reads a file from the FTP/FTPS/sFTP location.

    • Write File

      Writes a file into the target FTP server.

    • List Files

      Lists the names of the files in the input directory.

    • Move a File

      Moves a file from one location to another in the target FTP server.

    • Delete a File

      Deletes a file

    • Download File

      Specify a directory to be used for staged activity. Use this directory to stage large files for processing.

What You See on the FTP Adapter Invoke Operations Properties Page

The following tables describe the key information on the FTP Adapter invoke Operations page. Depending on which operation you choose, you are presented with different options and parameters that apply specifically to that operation. Each table corresponds to a specific operation.

Read a File

Note:

Elements marked with “+” can be mapped in the mapper and can be passed dynamically at runtime.
Element Description

Select a Transfer Mode

Select the transfer mode:

  • ASCII: Transfers special control characters to format the data.

  • Binary: Transfers raw bytes of the file data.

+Input Directory

The name of the directory that contains the file to be read. For example, /tmp/Oracle/input.

+File Name

The name of the file to be read. The name can also be provided by the mapper.

Write File

Element Description

Select a Transfer Mode

Select the transfer mode:

  • ASCII: Transfers special control characters to format the data.

  • Binary: Transfers raw bytes of the file data.

+Output Directory

The directory path to which to write the file. For example, /tmp/Oracle/output.

+File Name Pattern

The pattern of file names to transfer to the output directory. Use the pattern inside %%. For example, Oracle%SEQ%ICS.txt creates files in sequence, such as Oracle1ICS.txt, Oracle2ICS.txt, and so on. For a list of supported file patterns, click the information icon.

Note: Use of these patterns leads to message loss if the messages are written to the file system at the same time or files are written to a separate node. To ensure that files are not overwritten, use the mapper to assign the file names explicitly. You can use XPath functions to ensure that file names are unique.

Append to Existing File

If selected, the file content is appended to the existing file content and is not overwritten.

Note: You may be performing successive appends by putting multiple write operations or using a write operation in a for-each loop. In this scenario, if the FTP server is running on multiple nodes or on a cloud service, it should synchronize the data immediately among all nodes. Otherwise, if the next request goes to a different node, there is inconsistency in the final output file. As an alternative, you can also place a wait activity before or after every append to give the data time to synchronize.

Enable PGP Security

Use PGP security while writing the file.

List Files

Element Description

+Input Directory

The name of the directory that contains the file to be read. For example, /tmp/Oracle/input.

+File Name Pattern

Specify a wildcard pattern to be used for listing files from the input directory. For example, order*.csv.

Max Files

The maximum number of file names that should be listed. The maximum value is 1000.

Note: The List File operation returns the file list in a sorted order according to the last modified time. If you selected 10 as the maximum number of files and the last modified time of the eleventh file is the same as the tenth file, then the eleventh file is also added. This continues until you get a file with a different timestamp.

For example, assume the directory has 15 files and you select 10 as the maximum number of files. If the tenth, eleventh, twelfth, and thirteenth files have the same time stamp, then the list file returns thirteen files.

Minimum Age

The minimum age in seconds for files to be displayed. For example, if the last time a file was modified is 02:28:45 AM and the minimum age is defined as 80 seconds, the file will not be listed at 02:29:00 AM and 02:30:00 AM. It will be listed after 02:30:05.

List Files Recursively

List files within directories recursively beneath the input directory.

Move a File

Element Description

+Enter Directory Path

The name of the directory that contains the file to be moved. For example, /tmp/Oracle/input.

+File Name

The name of the file to be moved. There is no limit to the size of the file to move.

+Target Directory Path

The name of the directory to which the file will be moved.

+Target File Name

The name of the file as it will be written in the target directory.

Delete a File

Element Description

+Directory Path

The directory path to the file you wish to delete.

+File Name

The name of the file to delete.

Download File

Note:

The Download File operation enables you to map the download directory dynamically. This works fine for new integrations. You can also edit an existing Download File operation in the Adapter Endpoint Configuration Wizard to add more file download operations, then click Done to regenerate the adapter artifacts. You can download files up to 1 GB in size.
Element Description

Select a Transfer Mode

Select the transfer mode:

  • ASCII: Transfers special control characters to format the data.

  • Binary: Transfers raw bytes of the file data.

+Input Directory

Specify the name of the directory that contains the file to be read. For example, /tmp/Oracle/input.

+File Name

The name of the file to download. This can be overridden using the mapper.

+Download Directory

The name of the directory to be used for stage file action. See Processing Files in Scheduled Integrations with a Stage File Action.

Do not enter the directory path in double quotes. The quotes are mistakenly included as part of the directory name.

+Unzip the File

Unzip the file during downloading.

Retain Zip Directory Structure

The adapter preserves the directory structure while unzipping in the download directory.

+Decrypt the File

Decrypt the file during downloading.