SFTP

The SFTP (SSH File Transfer Protocol) component allows you to perform various operations such as downloading, listing files, and uploading files on an SFTP server. This component facilitates seamless file management and transfer over a secure connection.

Steps to use SFTP Component

1. Add SFTP Component to Canvas:

   To add the SFTP components to the canvas, you have two options:

   1. Navigate through the components menu in the side panel, and drag the SFTP component onto the canvas of your workflow.

   2. Click the plus icon, which opens a window allowing you to search for various components and connectors. Search for the SFTP component and select it.

   Each component will be labeled with a unique identifier (e.g., sftp_1) for easy reference if multiple SFTP components are used.

2. Access SFTP Component Settings:

   Click on the SFTP Component to open its settings.

3. Select Credentials for SFTP Connection:

   • Choose an available SFTP credential stored in your CXFabric tenant from the dropdown list.

   • Click the ellipsis menu next to the credential selection dropdown to manage credentials (add, edit, view, delete). Click "Manage" to access the full list in the Credential Management page.

     

4. Select Operation:

   Within the SFTP component settings, choose the desired operation from the dropdown menu:

   • Download: Retrieve a file from the SFTP server.

   • List files: Obtain a list of files from a specified directory on the SFTP server.

   • Upload: Transfer a file from your local system to the SFTP server.

   

5. Download Operation:

   Based on the selected operation, enter the following information:

   • File Path (with File Name): Specify the exact path to the file on the SFTP server that you wish to download, including the file name.

     

6. List Files Operation:

   Based on the selected operation, enter the following information:

   • Path: Specify the directory path on the SFTP server for listing files operation.

     

7. Upload Operation:

   Based on the selected operation, enter the following information:

   • Choose File: Select a file(s) to upload on the SFTP server.

   • File path: Specify the exact path to the destination directory on the SFTP server where you want to upload the file including the filename of the file you selected on the previous step

     
8. Submit: After entering the operation details, click the "Submit" button to confirm your configuration.

9. Hover for Information: Hover over the SFTP component on the canvas to view a tooltip with additional information.

10. Execute the SFTP Component:

    Hover your mouse over the SFTP Component to display the action buttons then click the play button to execute the step. The execution result can be viewed in the logs panel.

NOTE:

• The SFTP component provides versatile functionality for interacting with remote SFTP servers, including downloading, listing files, and uploading files.

• Ensure that the provided credentials and file paths are accurate to ensure successful operations.

• Test each operation with sample data to verify functionality before integrating into production workflows.