Configuring FTP Adapter Format Definition Properties

Enter the FTP Adapter format definition parameters.

What You Can Do from the FTP Adapter Format Definition Page

You can configure the following parameters on the FTP Adapter Format Definition page.

  • Create a new schema file from a comma-separated value (CSV) file.
  • Use an existing schema file.


The FTP Adapter can only be configured as an invoke connection in an orchestrated integrations.

What You See on the FTP Adapter Invoke Format Definition Page

The following tables describe the key information on the FTP Adapter Format Definition page.

The fields that display on the Format Definition page are determined by your selection on the Schema page:

  • Selected to create a new schema file

  • Selected to use an existing schema file

Creating a New Schema File

Element Description

Select the Delimited Data File

Select the delimited comma-separated value (CSV) file from which to create the schema file. The content of the file is then displayed at the bottom of the page. This field appears if you selected to create a new schema on the Schema page of the wizard.

  • Enter the Record Name

Enter the record name. This becomes the parent element in the created schema file for the record names selected as column headers from the CSV file.

  • Enter the Recordset Name

Enter the recordset name. This becomes the root element of the created schema file.

  • Select the Field Delimiter

Select one of the following supported file delimiter options:

  • Single space

  • Comma

  • Semicolon

  • Tab

  • Pipe (for example, Name|City|Country)

  • Character Set

Select a character set. The selected value will be used as the encoding format while reading the sample data file.

This field is used for character encoding during file transfer. If data sent to the FTP Adapter is in a specific encoding format, then select that same encoding format in the FTP Adapter. Otherwise, there may be some character loss in the final written file. This also corrupts the file. For example, if a REST Adapter is using UTF-8 encoding and the FTP Adapter is configured with the ASCII character set, this may corrupt the file. If you select the same UTF-8 encoding in the FTP Adapter, the problem is resolved.

  • Optionally Enclosed By

This value causes occurrences of the selected delimiter to be ignored during processing. For example, when processing the following record:

Fred,"2 Old Street, Old Town,Manchester",20-08-1954,0161-499-1718

If the selected Field Delimiter is “,” and the Optionally Enclosed By value is quot; (), then the value 2 Old Street, Old Town,Manchester is treated as a single record column.

  • Mark All As Optional

Select to mark elements as optional in the schema file. By default, all elements are mandatory. You can also select the data type (for example, string, byte, integer, and so on) to use for each column in the table and mark specific elements as optional. While this option enables you to select all elements as optional, you must have at least one mandatory element to validate this page. This checkbox provides a convenient method to select the majority of elements as optional.

Using an Existing Schema File

Element Description

Select File

Select the existing schema file to use. This field appears if you selected an existing schema from the file system on the Schema page of this wizard.