Skip to content

SFTP - DATA SINK

Description

The SFTP data sink is designed to distribute data by transferring it to a remote server using the Secure File Transfer Protocol (SFTP). This method is particularly useful for securely transferring files over a network, ensuring data integrity and confidentiality. The SFTP data sink supports various configuration options to customize the data distribution process, including specifying the SFTP server host, username, password, file path, and the MIME type of the data being transferred.

Config

REQUIRED

Config Parameters

Name Description
host The hostname of the SFTP server. This is a required parameter.
username The username for authentication with the SFTP server. This is a required parameter.
password The password for authentication with the SFTP server. This is a required parameter.
filePath The path on the SFTP server where the data will be stored. This is a required parameter.
mimeType The MIME type of the data being transferred. This is an optional parameter.

Config Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="UTF-8"?>
<apiroConf version="1" xmlns="http://apiro.com/apiro/v1/root">
    <loadOrder>10</loadOrder>
    <dataSinks>
        <dataSink definition="SFTP" execPriority="10" name="ESG_DATA_OPS_SFTP">
            <config>
                <![CDATA[
                    { 
                        "host":"mycompany.com.au",
                        "username":"my-username",
                        "password":"$SYS:MYESGOPS_SFTP_PWD",
                        "filePath":"my/file/path",
                        "mimeType":"application/octet-stream"

                    }
                ]]>
            </config>
        </dataSink>
    </dataSinks>
</apiroConf>

Common Mistakes

  • Incorrect Hostname or Credentials: Ensure that the host, username, and password parameters are correct and have the necessary permissions to write data to the specified SFTP server.
  • Invalid File Path: Verify that the filePath parameter is a valid path on the SFTP server and that the specified directory exists.
  • MIME Type Issues: If you encounter issues with data transfer, check the mimeType parameter to ensure it matches the format of the data being transferred.
  • Network Issues: If you encounter connectivity issues, check the network configuration and ensure that the SFTP server is accessible from the machine.