Show me| Auth method | Summary |
|---|---|
| User pass | The instance is authenticated by providing a username and password for the SFTP server. |
| Key pass | The instance is authenticated by providing a private key (RSA .pem format) for the SFTP server. |
| Option | Summary |
|---|---|
| FTP command | A valid FTP command is expected at the start of this field (e.g. get, put, rename, etc.). If required, qualifying path/filename information can follow a given command. |
| Root | This field is only needed if you are specifying a regular expression in the subsequent path field. If you are NOT defining the path field as a regular expression, the root field isn't important - you can leave it set to /.If you are ARE defining the path field as a regular expression, enter a root path that reflects the expected file location as closely as possible - this will optimise performance for expression matching.For example, suppose the files that we want to process are in the following SFTP folder: /orders/store/year/pending and that our specified path contains a regular expression to retrieve all files for store 1 for the current day in 2023. In this case our root would be defined as: orders/store1/2023/pendingIn this way, any regular expression to match for the path will start in the relevant (2023 )folder - rather than checking folders and subfolders for all stores and all years. |
| Path | If the name of the file that you want to target is static and known, enter the full path to it here - for example:
|
| Original filename | This field is not currently used. For information about working with original filenames please see the Using an {{original_filename}} variable section below. |
| Original path | This field is not currently used. For information about working with original paths please see the Using an {{original_path}} variable section below. |
Example
\
\
If we look at settings for the **first** SFTP connection, we can see that it's configured to `get` files matching a regular expression, in a `pending` folder:\
\
\
\
The regular expression is explained below:
* the `/` at the start of the string denotes the start of the regular expression
* the `^` means that the first part of the line (i.e. filename) must start with the literal string `orders`
* `[0-9]*` matches any sequence of digits
* `\.` is an escaped full stop, so a literal full stop is used instead of the special meaning that a full stop has in regular expressions
* `json` is a literal string to be matched
* the `/` at the end of the string denotes the end of the regular expression
It will match the following files:
These are:
* orders20230717.json
* orders20230718.json
* orders20230719.json
Now if we check settings for the **second** SFTP connection, we can see that it's configured to `put` files into a `ready` folder. By specifying `{{original_filename}}` in the `path` field, we are referencing filenames from the **first** SFTP connection.
So, the three files retrieved from the **first** SFTP connection step (from the `pending` folder) are copied to the `ready` folder in the **second** SFTP connection step.
Example
\
\
Our aim is to copy files retrieved from an FTP location in the first connection step, to a second FTP location, using the same folder structure as the source.
If we look at settings for the **first** SFTP connection, we can see that it's configured to `get` files matching a regular expression, in a `store1` folder:\
\
\
\
The path is added as a regular expression, explained below:
* the `/` at the start of the string denotes the start of the regular expression
* `orders\/2023\/pending\/` is a literal string for the folder structure, with escaped forward slashes
* `orders` is a literal string
* `[0-9]*` matches any sequence of digits
* `\.` is an escaped full stop, so a literal full stop is used instead of the special meaning that a full stop has in regular expressions
* `json` is a literal string to be matched
* the `/` at the end of the string denotes the end of the regular expression
It will match the following files:
These are:
* orders20230717.json
* orders20230718.json
* orders20230719.json
Now if we check settings for the **second** SFTP connection, we can see that it's configured to `put` files into a `path` specified as `{{original_path}}`:
So, the three files retrieved from the **first** SFTP connection step are copied to the `ready` folder in the **second** SFTP connection step and the source folder structure is replicated:
When specifying a path to a given folder in this way, you don't need a