Skip to main content

SFTP Receiver Connector

SFTP Receiver Connector allows you to create and write files to a specific file path from the SFTP server. SFTP Receiver Connector connects to a specific SFTP server. This usually occurs by providing authentication information such as server address, port number, username and password or private key. The user specifies a specific file path as the target. This determines the location on the SFTP server where the file will be created or written. For example, it can specify a file path such as "/uploads" or "/incoming". It can write files received from the source system or another source to the file path specified on the SFTP server.

Required Connector Properties​

  • Authentication Method: Allows the selection of the authentication method to be used during the connection.

  • SFTP Credential: If Username is selected as the authentication method, this field must be filled. SFTP credentials refer to the authentication information used to perform file transfers using SFTP. The name of a previously defined credential is provided.

  • Private Key Alias: If Private Key is selected as the authentication method, this field must be filled. The private key is used to authenticate to the SFTP server and belongs only to the person who wants to connect. A private key for SFTP is a cryptographic key used to authenticate to the SFTP server.

  • SFTP Username: If Private Key is selected as the authentication method, this field must be filled. SFTP username is the identifying information of a user who has permission to access the SFTP server.

  • SFTP Host: SFTP host is the address of the computer or server to be used for file transfer via SFTP. An SFTP host represents an SFTP server. The SFTP host address is expressed as a URL or IP address. For example: SFTP URL: ftp://example.com, IP Address: 192.168.1.1

  • SFTP Port: When using SFTP, the standard port number commonly used is 22. Since SFTP operates over SSH, it uses the standard port number of SSH. However, depending on the configuration of a specific system or server, SFTP may use a different port number.

  • File Path: This field specifies the directory or folder where the created file will be located. It indicates the location of the file and defines the path within the file system.

  • File Name: This field is where the desired file name to be created is written.

  • Add Timestamp: This variable appends a Timestamp to the file name when writing the file. For example, it saves a file named "mipFile" as "mipFile_20231129134819022".

  • Add Message ID: This variable appends a MessageID variable to the file name when writing the file. For example, it saves a file named "mipFile" as "mipFile_'specifiedMessageId'".

  • File Encoding: It refers to the method used to represent characters and encode textual information in a file. It determines how characters are mapped to binary data so that computers can interpret and display text correctly.

  • Temp Enable: It first defines the file to be written in a different location, and after the definition and file writing process is completed, it moves the file to its original location. This process prevents the file from being read by another service before the writing process is completed.