Skip to main content

SFTP Sender Connector

The SFTP Sender connector runs on a specific schedule (a cron job). Based on this program, it allows reading files with the given filename from the specified file path on the SFTP server. SFTP Sender 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 on the SFTP server and the name of the file to read. This determines the location and name of the file to read. For example, a file like "sample.txt" in the "/downloads" directory. From the specified file path and name, SFTP Sender Connector reads the file. This process involves retrieving and reading the contents of the specified file on the SFTP server. The read file can be processed on the integration platform or on the specified target system. For example, the file can be written to the database, imported into another application, or used for another operation.

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 Directory: This field specifies the directory or folder where the files to be read are located. It indicates the location of the file and defines the path within the file system.

  • File Name: This field is where the names of the files to be read are written. For example, searches and filters such as "mip.txt," "mip.json," or, for multiple file selections, ".txt," "mip." can be performed.

  • Subdirectory Select: If there is a subdirectory in the file to be read, the name of this subdirectory can be provided to process the files within it. This field is not mandatory to fill.

  • Processing Sequence: Determines the order in which the read files will be processed. The processing order can be established based on Modified Date or File Name, and it can be set in alphabetical or reverse alphabetical order.

  • Processing Mode: Specifies what will happen after the files are read. There are three options:

    • Test: Indicates that the files are read for testing purposes, and no further action is taken after reading.
    • Delete: Enables the deletion of files once the reading and subsequent processing are complete.
    • Archive: Facilitates moving and archiving files to the address entered in the "Archive Directory" after reading. Files are not deleted; their locations are simply changed.

Advanced​

  • Skip Empty File: This variable determines whether empty files will be read during the file reading process. If the option is selected, empty files are skipped without being read. If not selected, all files at the specified address and with the specified names are read and processed.

  • Duplicate Check: This variable determines whether the same file can be read more than once during the file reading process. If the option is selected, the same file will not be read again. If not selected, the same file can be read and processed multiple times.

  • Max File Size: This variable allows checking the sizes of files during the file reading process. If a file is smaller than the value entered in KB, the reading process occurs. If it is larger, the file is skipped and not processed.

  • 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.

  • Additional Parameters: This variable allows the addition of a parameter other than the specified filters and parameters.

Scheduler​

  • Cron: This variable allows determining the working interval and frequency of the defined SFTP (Sender) service in Cron format. Cron is used to schedule tasks to run at specific intervals or on specific dates and times.