SFTP Interface

The SFTP interface type defines the connections between a secured FTP server (a remote server with an SSH connection) and a stream of file content.

An SFTP interface is used when creating an Interface Listener for a Broadway flow.

To create a new SFTP interface, do the following:

Go to Project Tree > Shared Objects, right click Interfaces, select New Interface and then select SFTP from the Interface Type dropdown menu to open the New Interface window.
Populate the connection's settings and click Save.

Parameter	Description
IP	Hostname or IP address of the FTP server.
User	Username.
Password	Password.
Remote Directory	Directory where the files are stored.
Files Filter	Regular expression.
Actions	Test Connection. Click to test the connection. Add an Interface Listener as a Broadway job. Click to create an Interface Listener job under the specified Logical Unit.

To create an Interface Listener Job that runs on an SFTP interface, do the following:

Create an interface using an SFTP interface type.
Click the Add interface listener as Broadway job link in the Interface window and select the Logical Unit from the list to open the Jobs window.
Create a Broadway flow either under Shared Objects or under the same Logical Unit. The flow reads data from a file using the predefined interface and populates it into the DB.
- Note that the interface and the path input arguments of the FileRead Actor are defined as External link type. Their values are passed from the defined interface by the Listener.
In the Jobs window, select the Broadway flow and Execution mode and then save the job.

images

The SFTP interface type defines the connections between a secured FTP server (a remote server with an SSH connection) and a stream of file content.

An SFTP interface is used when creating an Interface Listener for a Broadway flow.

To create a new SFTP interface, do the following:

Go to Project Tree > Shared Objects, right click Interfaces, select New Interface and then select SFTP from the Interface Type dropdown menu to open the New Interface window.
Populate the connection's settings and click Save.

Parameter	Description
IP	Hostname or IP address of the FTP server.
User	Username.
Password	Password.
Remote Directory	Directory where the files are stored.
Files Filter	Regular expression.
Actions	Test Connection. Click to test the connection. Add an Interface Listener as a Broadway job. Click to create an Interface Listener job under the specified Logical Unit.

To create an Interface Listener Job that runs on an SFTP interface, do the following:

Create an interface using an SFTP interface type.
Click the Add interface listener as Broadway job link in the Interface window and select the Logical Unit from the list to open the Jobs window.
Create a Broadway flow either under Shared Objects or under the same Logical Unit. The flow reads data from a file using the predefined interface and populates it into the DB.
- Note that the interface and the path input arguments of the FileRead Actor are defined as External link type. Their values are passed from the defined interface by the Listener.
In the Jobs window, select the Broadway flow and Execution mode and then save the job.

images