Connecting to a Server Using SFTP

Prev Next

Syniti Knowledge Platform (SKP) allows you to connect to a server using Secure File Transfer Protocol (SFTP).

Configuration Summary

The following table provides a high-level summary of the configurations you need to perform if you want to maintain a separate folder to integrate with the SKP.

S.No

Configuration Steps

Reference Materials

1

Set up an SFTP server or identify your existing SFTP server

  • Note your server hostname, port (typically 22), and the root directory path

* SFTP Protocol Overview

* SSH/SFTP Security Best Practices

* OpenSSH SFTP Configuration

* SSH Public Key Authentication

* SSH Key Generation Guide

* SFTP Server Configuration

* File Permissions

2

Create or identify SFTP user credentials

  • Note the username and authentication method (password or SSH key)

3

Configure SFTP server access permissions

  • Ensure the user account has appropriate read/write permissions for the designated folder

4

Create a system datastore connection in the SKP using the SharePoint Online connection properties listed below

* Datastores

* Create a Connection

Connection Properties

When you are in the Create Connection page,

  1. Select SFTP from the Type list and enter the following details:

    Field Name

    Description

    Host

    required

    The SFTP server hostname or IP address (e.g., sftp.example.com)

    Port

    required

    The SFTP server port number (default is 22)

    Username

    required

    The username to authenticate with the SFTP server

    Authentication Type

    required

    The authentication method. Password uses a username/password pair. PrivateKey uses a PEM-encoded private key file.

    Password

    required for Password authentication type

    The password associated with the username for password-based authentication.

    Private Key

    required for PrivateKey authentication type

    The SSH private key used for key-based authentication. Paste the full contents of the key file.

    Private Key Passphrase

    (optional for PrivateKey authentication type)

    The passphrase protecting the SSH private key, if applicable. Leave blank if the key is not password protected.

    Host Fingerprint

    The server’s host key fingerprint to verify on connection. If left blank, any host key is accepted.

    Root Path

    The optional root path on the server (e.g., /data/inbound ). Leave as / for the user’s home directory.

    Extended Properties

    Use the + Add Property button to add any additional connection properties.

  2. From the Usage list, select the required usage to define how this connection is used.

  3. From the SKP Connector list, select the required SKP Connector component to communicate with the SFTP server.

  4. Click Save.

Troubleshoot

Scenario: Partial Files Left in SFTP Directory After Upload Failure

Partial files accumulate in the SFTP server directory after upload operations. The system attempts a best-path upload strategy (uploading as a partial file, then renaming on success), but when rename operations fail due to insufficient permissions, the partial file is left behind.

Solution

Grant the SFTP connection user the following required permissions on the target directory:

  • Write permission (to create the partial file)

  • Rename permission (to finalize the upload)

  • Delete permission (for cleanup if operations fail)

Configure the directory permissions appropriately for your SFTP server, then test with a small file upload to verify the partial file is properly renamed and no orphaned files remain.