FileTransferTask

Introduction

The FileTransferTask uses the file component of Apache Camel to transfer files between systems with support for ftp, ftps, sftp, smb, file and the custom omn protocol.

Every execution of this task transfers up to one file. If you need to transfer multiple files you can run this task in a loop.

Almost every protocol supports a broad bandwidth of configuration options that are provided through their respective camel components. Since we are delegating the work via Camel Consumer- and ProducerTemplates internally we support most of those options inherently.

Limitations

Currently, only the transfer between ftp and omn protocol is officially supported and tested.
Other protocols will follow as the task gets more fleshed out in upcoming versions
Currently, the component can only create folders in OMN that are nested up to one level deep. This will be improved within a later version.

Usage

A file transfer always needs a source (consumer) and a target (producer) endpoint definition. With camel, you usually provide them in the form of a URI. We internally build this URI from various variables that can be set to the tasks input variables.

Implementation

Delegate Expression: $\{fileTransferTask}

Input Variables

From the following variables two camel endpoint URIs are constructed (from/to) in the form of
<protocol>:[<user>@]<host>/<path>[?param1=value1&param2=value2]

Name Description Type

fromProtocol

Source protocol
Allowed values: ftp, ftps, sftp, smb, file, omn

String

toProtocol

Target protocol
Allowed values: ftp, ftps, sftp, smb, file, omn

String

fromHost

Source host
NOTE: omn: API Host

String

toHost

Target host

String

fromUser

Source user
NOTE: omn: Mandator

String

toUser

Target user

String

fromAdditionalParameters

Additional camel source endpoint parameters

Map<String,String>

toAdditionalParameters

Additional camel target endpoint parameters

Map<String,String>

Output Variables

Name Description Type

assetId

tid for the involved omn asset in either source or target endpoint
NOTE: only for omn: protocol

String

Welcome to the AI Chat!

Write a prompt to get started...