SFTP
Learn the required and optional properties of creating an SFTP Connection, Credential, Read Connector, and Write Connector.
Prerequisites
- SFTP server
- Access credentials
Connection Properties
The following table describes the fields available when creating a new SFTP Server Connection. Create a connection using the information below and these step-by-step instructions.
| Field | Required | Description |
|---|---|---|
| Access Type | Required | The type of connection: Read-Only, Write-Only or Read-Write. |
| Connection Name | Required | The name to identify this connection with, such as 'SFTP Server Connector'. |
| Host | Required | IP or the hostname of the SFTP server. |
| Port | Optional | Host server port number (default: 22). |
| Requires Credentials | Required | Choose from existing credentials or create new credentials for connecting to SFTP server if 'Required Credentials' checkbox is selected. |
Credential Properties
The following table describes the fields available when creating a new SFTP Server credential.
| Field | Required | Description |
|---|---|---|
| Credential Name | Required | The name to identify this credential with. |
| Credential Type | Required | This field will automatically populate with SFTP Server. |
| User | Required | SFTP Server username to connect with. |
| Password | Required | SFTP Server password to connect with. |
Read Connector Properties
The following table describes the fields available when creating a new SFTP Server Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.
| Field Name | Required | Description |
|---|---|---|
| Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
| Object Pattern Matching | Required | The pattern strategy used to identify eligible files: - Glob: Glob applies a simple pattern matching algorithm. - Match: Matches the pattern precisely character-for-character. - Prefix: Matches the pattern with the specified prefix. - Regex: Regex applies a pattern matching algorithm. |
| Object Pattern | Required | The pattern you'll use to match. |
| Parser | Required | We support several data formats. See Blob Storage Read Connector Parsers for more information about CSV, Excel, JSON, and Python parsers: - Avro - CSV - Excel - JSON - ORC - Parquet - Python - Text |
| Object Aggregation Strategy | Required | Currently available strategies are: - Adaptive - Leaf Directory - Prefix Regex Match |
Write Connector Properties
The following table describes the fields available when creating a new SFTP Server Write Connector. Create a new Write Connector using the information below and these step-by-step instructions.
| Field | Required | Description |
|---|---|---|
| Name | Required | The name of the component. |
| Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
| Upstream | Required | Pick upstream component from which data will be written. |
| Unique Output Directory | Optional | The name of the subdirectory into the SFTP folder where Ascend will place the incoming data. |
| Format | Required | We support several data formats. See Amazon S3 Read Connector Parsers for more information about CSV, Excel, JSON, and Python parsers: - Avro - CSV - Excel - JSON - ORC - Parquet - Python - Text |
Updated almost 2 years ago