Skip to content

Commit

Permalink
Update Generic_SFTP_Client.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MariekeGO committed Dec 16, 2024
1 parent ef1b24f commit b65db78
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions connector/doc/Generic_SFTP_Client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ uid: Connector_help_Generic_SFTP_Client

# Generic SFTP Client

This connector access files from an SFTP server and copies them over to a local directory to be accessed by the Dataminer system. This is to prevent multiple drivers needing SFTP access logic and keep that logic centralized.
This connector can be used to access files from an SFTP server and copy them over to a local directory to be accessed by the DataMiner System. This way, you can prevent multiple connectors needing SFTP access logic, and you can keep that logic centralized.

## About

### Version Info

| Range | Description | DCF Integration | Cassandra Compliant |
|------------------|-----------------|---------------------|-------------------------|
| 1.0.0.x | Initial version | No | Yes |
| Range | Description | DCF Integration | Cassandra Compliant |
|---------|-----------------|-----------------|---------------------|
| 1.0.0.x | Initial version | No | Yes |

## Configuration

Expand All @@ -24,16 +24,21 @@ This connector uses a virtual connection and does not require any input during e

### Initialization

Once element is created, fill in parameters in the **SFTP Configuration** section which contains the **Host** and **Port** of the SFTP server and the Username to authenticate access. The driver supports *Credentials* and *Key Pairs* authentication. If *Credentials* is selected, fill in the **Password** associated to the **Username**. If *Key Pairs* is selected, put the path with the key information file in the **Key Pairs Path**.
Once the element has been created, in the **SFTP Configuration** section, fill in the **Host** and **Port** of the SFTP server and the **Username** for authentication.

In the **File Handling Overview** section, put the **Source Directory Path** that will contain the files in the SFTP server that you wish to copy over to the local directory. You can put a root folder and the driver will search through all the children folders for files and copy those over. Put the local directory that will store the copied files in the **Destination Directory Path**. If using a remote file directory, provide the **System Username** and **System Password** to a user that has access to the remote directory.
The connector supports **Credentials** and **Key Pairs** authentication:

To validate the connection and copy all files, hit the **Apply** button in the **SFTP Configuration** section. The **Connection Status** will update *Connection Valid* on the General page.
- If **Credentials** is selected, fill in the **Password** associated with the **Username**.
- If **Key Pairs** is selected, fill in the path to the key information file in the **Key Pairs Path** parameter.

In the **File Handling Overview** section, specify the **Source Directory Path** that will contain the files on the SFTP server that you want to copy over to the local directory. You can specify a root folder, and the connector will search through all the children folders for files and copy those over. Specify the local directory that will store the copied files in the **Destination Directory Path**. If a remote file directory is used, provide the **System Username** and **System Password** of a user that has access to the remote directory.

To validate the connection and copy all files, use the **Apply** button in the **SFTP Configuration** section. The **Connection Status** on the General page will update to *Connection Valid*.

### How to Use

To automatically copy all files from the SFTP server to the local directory, put the time interval desired in the **Automatic SFTP File Sync** parameter in the **Configuration** page. If the interval is set to *N/A*, then you may hit the **Apply** button to manually copy over the files. The driver also has Interapp capabilites, where an external driver may request files from the SFTP server using a File name filter and/or a file time filter. Once the SFTP client copies all files matching the requested Interapp message filters, it will reply with all the file names copied over to the requested element.
To automatically copy all files from the SFTP server to the local directory, go to the **Configuration** page and specify the desired time interval in the **Automatic SFTP File Sync** parameter.

### Redundancy
If the interval is set to *N/A*, you can use the **Apply** button to manually copy over the files.

There is no redundancy defined.
The connector also has InterApp capabilities: an external connector can request files from the SFTP server using a file name filter and/or a file time filter. Once the SFTP client has copied all files matching the requested InterApp message filters, it will reply to the requested element with all the copied file names.

0 comments on commit b65db78

Please sign in to comment.