scp egress connector

SCP Egress Connector

Version: 17.07

Supported Since: 17.01

What is SCP Egress Connector?

SCP (Secure Copy) protocol allows the files in the local file system or a remote file system to be copied to the local files system or a remote file system. This uses SSH for data transfer and provides the same authentication and same level of security as SSH. Authentication between two hosts can be done using the private and public key pair or username and password. This Egress Connector will scan for the files which matches the given pattern in a given directory and executes according the parameters set by the user.

The remote file system can be a local file system as well. If you configure localhost system as the remote system files will be copied from local system to local system.

We use JSch library which is a pure Java implementation of SSH2. JSch allows you to connect to an sshd server and use port forwarding, X11 forwarding, file transfer, etc., and you can integrate its functionality into your own Java programs. JSch is licensed under BSD style license.

In order to use the SCP Egress Connector, you must first select the SCP Connector dependency from the connector list when you are creating an empty Ultra project. If you have already created a project, you can add the SCP Connector dependency via Component Registry. From Tools menu, select Ultra Studio → Component Registry and from the Connectors list, select the SCP Connector dependency.
scp egress connector 3

Out Ports

On Exception

The message will be emitted from this out port if the processing element failed to send the message to destination location

Side Ports

Connector Operation

This port is used to connect operational elements to the Egress Connector. By-default, user does not have to connect any operational element and the default connector operation will be used.


* marked fields are mandatory

SCP Host *


Host name/IP of the remote machine that you are going to send files using SCP

SCP Remote Port


Port of the remote machine that you are going to connect to copy the files using SCP. By default value of this will be set to 22

File Path *


Path of the remote machine that you are going to copy files to. This path should be relative to the home directory of the above given user

File Name


File name for the payload to be saved when sending to remote location (if there is an original name to the file, it will be preserved if this property is not provided). In-order to construct the file name, you can use message headers, message properties, additional variables set, message ID, message context ID, and message context properties in following formats respectively. @{message.headers.<name>} @{<name>} @{variable.<name>} @{} @{} @{<name>}

Further, if the file name is not set and the message contains a transport header with key, the value of the header will be used as the file name. Apart from that if the message contains both, and ultra.file.move_timestamp_format transport headers, the file name will contain the value of the header with the current timestamp prepended.



Username that you are going to use to connect to the remote machine



Password for above user name if you are going to connect via password based authentication to the remote machine

Key File Path

Key Authentication

Path of the private key of the user which will be used to communicate with remote machine via key based authentication.

Key Password

Key Authentication

Password of the private key if it’s password protected.

Host Key Check

Key Authentication

Set to enable the host key checking while creating the communication channel with remote machine. If this is not enabled, host key checking will be skipped while SCP processing. By default, this will be false.

Max Connections


Maximum number of connections which will be cached within the SCP Egress Connector for the configured remote machine. By default, this value is 1.



Timeout in millis, to be used while connecting to the remote machine. If it couldn’t establish a connection with the remote machine within this time period, it will be considered as a connection failure and notify to the user. By default, this value is 60000.



Weight for the Egress Connector if this Egress Connector is used with weighted Egress Load Balancer

Sample Use Case

In this use case scenario, there is a system which scans and copy files from a remote server and copy files to another remote server using SCP. This use both SCP Ingress Connector and SCP Egress Connector. The overall integration flow would be as shown below.

scp ingress connector 2

The configuration for the SCP Egress connector is as shown below.

scp egress connector 1

Then we should add the SCP Ingress Connector which will copy the files from remote file system to a local file system. See the configurations of SCP Ingress Connector.

Now if you run the flow, and put any file which matches the file pattern you configured into the directory you specified that will be copied to your local file system and then it will be copied to your remote file system mentioned at the egress connector.

In this topic
In this topic
Contact Us