Skip to main content
Feedback

Boomi Managed File Transfer operation

The Boomi Managed File Transfer operation targets an MFT flow endpoint, by numeric ID, to list, download from, or upload to your MFT instance.

Import

By using the Import Wizard, you browse your object definitions in real time, based on the action you specified, to get any fields you have defined.

For the List operation, you can import the following object types:

  • File Metadata
  • File (with content)

List

List is an inbound action to return a list of available files for the configured flow endpoint. List performs the FileList operation in the Content API.

  • Tracking Direction - Displays the document tracking direction for write and Execute operations, either Input Documents or Output Documents. This read-only setting is determined by a configuration change, affecting which document appears in Process Reporting.

  • Error Behavior - When Return Application Error Responses is selected and one file in a batch fails, the other files are still delivered and each failed file gets its own document with its file ID. When it is cleared, one failed file stops the whole batch.

  • Flow Endpoint ID - The numeric ID of the flow endpoint from which to list files. You can get this ID from Flow Studio after adding the endpoint. The numeric ID is appended before the endpoint name.

    a list of flow endpoints in the targets section

  • Max Files - The maximum number of files to return each time the operation runs, from 1 to 1000. The default is 100.

  • File Status - Select which files to list by their status. Staged (the default) lists only files that are ready for pickup, so files that were already delivered are not listed again. Completed lists delivered files. Error lists failed transfers. All statuses lists every file and is useful for recovery.

  • Short-Read Retry Count - Applies only to the File (with content) object type. The number of times the connector resumes an interrupted download before the file fails, from 0 to 10. The default is 3.

The List operation supports two query filters: File ID (Equals; repeat the filter for multiple values, up to 100 per call) and Created Date (After, On or After, Before, or On or Before).

Get

Get is an inbound action to retrieve file content and can download multiple files in a single execution. Get performs the Download operation in the Content API.

Get downloads the file whose file ID is supplied as the document ID. The file ID is not read from the document contents. To download files found by a List operation, split the List results, then set the Get step's ID parameter to the fileId element of the List document.

If the operation runs without a file ID, for example from a Start step, the connector downloads the next available file from the flow endpoint. When no files are available, the operation succeeds with an empty result and status code 204.

caution

If an upstream step does not set the ID parameter, the Get operation does not fail. It downloads the next available file from the flow endpoint instead. When you use Get in the middle of a process, confirm the ID parameter is set before you deploy.

  • Tracking Direction - Displays the document tracking direction for write and Execute operations, either Input Documents or Output Documents. This read-only setting is determined by a configuration change, affecting which document appears in Process Reporting.

  • Error Behavior - When Return Application Error Responses is selected and one file in a batch fails, the other files are still delivered and each failed file gets its own document with its file ID. When it is cleared, one failed file stops the whole batch.

  • Flow Endpoint ID - The numeric ID of the flow endpoint from which to list files. You can get this ID from Flow Studio after adding the endpoint. The numeric ID is appended before the endpoint name.

    a list of flow endpoints in the targets section

  • Short-Read Retry Count - The number of times the connector resumes an interrupted download before the file fails, from 0 to 10. Enter 0 to have an interrupted download fail immediately. The default is 3.

As soon as a download finishes, the file's status changes to Completed. Completed files no longer appear in List results, which return Staged files by default. If the process fails after the download finished, the file stays Completed and scheduled runs do not pick it up again. To download it again, use Replay on the file's document in Process Reporting.

Completed files are eligible for purge. If the flow endpoint is set to purge immediately, a file can be removed before you can replay it.

This timing is specific to the Boomi MFT Connector endpoint type.

Create

Create is an outbound action to upload file content to the flow endpoint. Files are uploaded in a chunked upload session. Create performs the Upload operation in the Content API.

  • Tracking Direction - Displays the document tracking direction for write and Execute operations, either Input Documents or Output Documents. This read-only setting is determined by a configuration change, affecting which document appears in Process Reporting.

  • Error Behavior - When Return Application Error Responses is selected and one file in a batch fails, the other files are still delivered and each failed file gets its own document with its file ID. When it is cleared, one failed file stops the whole batch.

  • Flow Endpoint ID - The numeric ID of the flow endpoint from which to list files. You can get this ID from Flow Studio after adding the endpoint. The numeric ID is appended before the endpoint name.

    a list of flow endpoints in the sources section

  • Subfolder Path - A subfolder under the flow endpoint's root folder for uploaded files; blank places them in the root. To vary it per document, have an upstream step set a Dynamic Document Property, then bind this field's override to that property on the connector step.

  • File Name - The name of the file to be uploaded to the flow endpoint. To vary it per document, have an upstream step set a Dynamic Document Property, then bind this field's override to that property on the connector step.

    note

    This field is required. The connector will not automatically assign a name to files.

Archiving tab

Refer to the topic Connector operation’s Archiving tab for more information.

Tracking tab

Refer to the topic Connector operation’s Tracking tab for more information.

Caching tab

Refer to the topic Connector operation’s Caching tab for more information.

On this Page