"SFTP - Get File" node

You can use the SFTP - Get File node to transfer the files from your server to the workflow using SFTP protocol.

Node configuration


A blank form for the SFTP Get File node
A blank form for the SFTP Get File node
  1. In the Server field, enter the URL of the server.

  2. In the Port field, set the port. The default value is the most commonly used SFTP port.

  3. If your data are stored in a directory, in the Path to directory provide a path to a directory (for example: /home/file-directory/).

  4. In the File name pattern, type the full name of the file or a pattern. (for example, synerise.csv).

    Tip: In the case of frequent imports, you can devise a name pattern which will make your work easier. Synerise supports glob patterns to specify sets of filenames with wildcard characters, for example import*.csv.

    • To import all files from the directory that have a common word in the name, use the asterisk (for example, synerise*.csv). Then, all files with names that begin with synerise will be imported.
    • To import several files that have a specific number of characters after the common part of the file name, use a question mark for each character (for example, synerise???.csv). This way you import all the files whose names consist of a specific number or additional characters after the common part of the file name (in this case, it’s synerise).
  5. From the File format dropdown list, select the format of the file.

    • XML Feed
    • JSON
    • JSON Lines
    • CSV - Provide the details on how to format the imported file:
    1. From the Delimiter dropdown, select the character that marks the end of a column.

    2. From the Quotation mark dropdown list, select the characters that contain the text or data type.

    3. From the Escape character dropdown lists, select the character changes the default interpretation of a character or a string followed by the character.

    4. From the Line ending dropdown list, select:

      • Line feed - This option shifts the cursor to the next line vertically.
      • Carriage return and line feed - This option points the cursor to the beginning of the line horizontally and shifts the cursor to the next line vertically.
    5. Optionally, select the following checkboxes:

      • No Byte Order Mark - This option is currently unused.
      • Quoting style only if required - This option wraps the values with characters selected in the Quotation mark field when the delimiter occurs in the value. For example, for the following values:
        • one
        • two,three,four

      The output with the enabled Quoting style only if required option will be as follows: one,"two,three,four"

  6. In the Authentication section, select the authentication method.

    • Anonymous - No authorization is required.
    • Password - Authentication is based on a login and a password.
    • Public key - Authentication is based on a public SSH key which is issued for a selected integration (you can download such key from the pop-up and add it to the server configuration).
  7. Confirm by clicking Apply.

Example of use


In this example, you can launch a workflow that once a day uploads customers data from the SFTP server. Further on, the data is imported to Synerise as profiles.

Important: In this example, the transformation of data may be needed in order to comply with the structure of the data in the catalog.
Final workflow configuration
Final workflow configuration
  1. Add the Scheduled run node.
  2. In the configuration of the node:
    1. Select the time zone consistent with the time zone selected for your workspace.
    2. Leave the Everyday tab.
    3. In the Select time field, choose the time when the workflow will be triggered.
    4. Confirm by clicking Apply.
  3. Add the SFTP Get File node.
  4. In the configuration of the node:
    1. Enter the URL of the server.
    2. Select the path to the directory.
    3. Enter the name of the file you want to access (or file name pattern for larger amount of files to access).
    4. Select the format of the file or files.
    5. Define the authentication method.
    6. Confirm by clicking Apply.
  5. If required, add the Data Transformation node. In the configuration of the node, select the data transformation template.
  6. Add the Import profiles node.
  7. Add the End node.
πŸ˜•

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

πŸ˜‰

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker