Overview of the SFTP Out Node

This node distributes output files to an SFTP server. To configure the SFTP Out node, add a node for SFTP Out to the workflow canvas and double-click on it.

The SFTP Out Node is very suitable for transmitting sensitive files as it supports algorithms that help address the following concerns:

1. Your data stays confidential throughout the transmission - You wouldn’t want valuable or sensitive information such as Personally Identifiable Information (PII), trade secrets, customer lists, key employee salaries, marketing strategies, source codes, etc. falling into the wrong hands.
2. Data integrity is upheld - Your data remains unchanged and if it ever undergoes even the slightest accidental or intentional change, you have a way of knowing.
3. You are able to verify the authenticity of its source - You will want to make sure it really came from the party who you were expecting to be the sender (and not from an impostor).

The SFTP Out node securely delivers files to a connected SFTP server.

To open the SFTP Out node properties window, add an output node for SFTP Out to your workflow and double-click on it.

• Enabled - To enable this node in the current workflow, ensure the Enabled toggle is to the right. By default, nodes are enabled upon creation. If you disable the node, the workflow will ignore it. While the workflow will still validate, documents will not be output from this node and may be lost. Note that a disabled node does not check for logic or error conditions.

• Node Name - The node name defaults to this field. This name appears in the workflow below the node icon. Use this field to specify a meaningful name for the node that indicates its use in the workflow.

• Node Description - Enter an optional description for this node. A description can help you remember the purpose of the node in the workflow or distinguish nodes from each other.

Buttons

• Metadata - To access the Metadata Browser window, click this button. All fields that allow drag-and-drop support metadata.
• Help - To access Online Help, click this button.
• Cancel - To exit the window without saving any changes, click this button.
• Save - To preserve your node configuration and exit the window, click this button.

Connecting to the SFTP Server

There are two methods for connecting to an SFTP server: Basic Authentication (using a username and password) and Public Key (generating a public key).

Connecting to the SFTP Server with Basic Authentication

To begin, you must first connect to the SFTP server. In the Connection area, do the following:

1. In the Connection area, enter the system information for the SFTP server:

   • Host/IP Address - Enter the identifying host name for this server or its IP address.

   • Port - Enter the port used by the server for SFTP communication (default is 22).

   • Username - Enter the user name needed to connect to the SFTP server.

   • Password - Enter the password needed to successfully login to the SFTP server.

2. If necessary, deselect the Auto-accept unknown host keys option.

3. Select the Login button to test the connection with the SFTP server.

Connecting to the SFTP Server with a Public Key

To begin, you must first connect to the SFTP server. In the Connection area, do the following:

1. In the Connection area, enter the system information for the SFTP server:

   • Host/IP Address - Enter the identifying host name for this server or its IP address.

   • Port - Enter the port used by the server for SFTP communication (default is 22).

2. Using the Authentication Type dropdown, select Public Key.

3. Enter the Username needed to connect to the SFTP server.

4. Using the dropdown, select the Key Type of the public key you would like to use. Options include:

   • ed25519
   • ecdsa
   • rsa

   A public key is automatically generated when a Key Type is selected. By default, an ed25519 key is generated when you selected the Public Key Authentication Type in Step 2. A private key is also generated and automatically associated with the node in the Dispatcher Phoenix server.

   You can use the Copy button to copy the public key. You can use the Refresh button to regenerate a public key.

5. If necessary, deselect the Auto-accept unknown host keys option. By default, this option is selected and will automatically bypass a host key check. Once a key is accepted or auto-accepted, the host’s public key is connected to the workflow so that future connections are automatically trusted.

6. Select the Login button to test the connection with the SFTP server.

Note: All SFTP Out nodes will generate unique keys unless the node is copied and pasted.

Advanced Settings

There are several Advanced Settings that modify how files are distributed to the SFTP server. The settings include:

• Enable Compression - Check this box to enable data compression in the SSH connection. By enabling compression, data sent by the server will be compressed before sending and decompressed once received.

In the Duplicate File Action area, choose one of the following actions:

• Overwrite file - Save the new document over the previous document.

• Do not overwrite file - Do not overwrite the file and take no other action.

• Append a unique ID - To keep both versions of a processed file.

Customizing the SFTP Out Node

Once connected to the SFTP server, the SFTP Explorer area populates with a tree-view of your Box folders, sub-folders, and files. Browse through your folder structure and choose a folder in which to store your documents.

The Folder Path field automatically updates with the selected folder path. This field also supports metadata. While the workflow is running, the node will automatically create a new folder if there is not folder that matches the path specified in the node configuration.

The Connection Properties area displays the algorithms and other specifications applicable to your SFTP transmission.

Select the Save button to save the node configuration and close the window.

Configuring the SFTP Server

The SFTP Out node supports the following Ciphers, Key Exchange, Message Authentication Code (MAC) and Public Keys for SFTP transmissions:

Creating an SFTP Out Index Form with Basic Authentication

You can create an index form that allows you to log into your SFTP Out server automatically at the MFP using a username and password. Do the following:

1. Add a node that is capable of attaching an Index Form (e.g. MFP Panel) to your workflow by dragging and dropping it into the Workflow Builder area, and connect it to the SFTP Out node.

2. Configure the SFTP Out node according to the Connecting to the SFTP Server with Basic Authentication section above.

3. Open the node associated with the Index Form.

4. Click the checkbox next to Attach Index Form and then the + icon to open the Index Form Builder. Then, select the Blank Index Form option in the pop-up, as in the following illustration:

   

5. Drag the SFTP Basic Authentication icon to the Index Form Builder working area. Several fields will populate, as in the following illustration:

   

6. If you haven’t already configured theHost and Port fields in the node (Step 3), configure them here in the Index Form.

7. If necessary, configure the Username, Password, and Folder Path fields.

8. Validate, Save, and close the Index Form Builder.

Creating an SFTP Out Index Form with a Public Key

You can create an index form that allows you to log into your SFTP Out server automatically at the MFP using a public key. Do the following:

1. Add a node that is capable of attaching an Index Form (e.g. MFP Panel) to your workflow by dragging and dropping it into the Workflow Builder area, and connect it to the SFTP Out node.

2. Configure the SFTP Out node according to the Connecting to the SFTP Server with a Public Key section above.

3. Open the node associated with the Index Form.

4. Click the checkbox next to Attach Index Form and then the + icon to open the Index Form Builder. Then, select the Blank Index Form option in the pop-up, as in the following illustration:

   

5. Drag the SFTP Public Key icon to the Index Form Builder working area. Several fields will populate, as in the following illustration:

   

   Note: You cannot configure the public key from the Index Form. It must have already been configured in the node.

6. If necessary, configure the Username, Password, and Folder Path fields.

7. Validate, Save, and close the Index Form Builder.

Note: You must use the pre-built SFTP Out Index Form when connecting with a public key.

SFTP Index Form on MFP

At the MFP, the SFTP Index Form will appear based on the connection type.

Basic Authentication:

Public Key:

Database Browsing

You can also manually configure a query to retrieve data (e.g., list of folders, validation, etc.) from your SFTP Server.

Using the Index Form Builder, do the following:

1. Add a new field, such as a drop-down list.

2. Define an On Load event for the field; then add a Query.

3. Add an SFTP Data Source from the Query list. The options are:

   • Browse SFTP Folders to view a listing of the folders and files available at the specific location on your SFTP server.
   • Connect to SFTP to connect directly to the SFTP server (does not require a folder path).

Creating a Browse SFTP Folder Query

After selecting the Browse SFTP Folders from the query drop down, the SFTP Data Source Configuration window appears, which allows you to perform specific actions in order to retrieve data from your SFTP Server.

Do the following:

1. In the Host / IP Address field, enter in the host or IP Address for the SFTP server.

2. In the Port field, enter the port number used by the server for SFTP communication (default is 22).

3. In the Username field, enter in the user name needed to connect to the SFTP server.

4. In the Password field, enter the password needed to successfully login to the SFTP server.

5. In the SFTP Explorer area, enter in the Folder Path of the SFTP root folder that you want displayed at the MFP panel.

   • Show new folder option – Check this option to allow the user to create a new folder at the MFP.
   • Show files - Check this option to display files in Dropbox folders at the MFP.
   • Enable folder search - Check this option to enable folder search at the MFP.

6. Select the Save button to keep your Browse SFTP Folders query settings. You can also select the Help button to access online help and select the Cancel button to exit the window without saving any changes.

Creating a Connect to SFTP Query

After selecting the Connect to SFTP from the query drop down, the SFTP Data Source Configuration window appears, which allows you to perform specific actions in order to retrieve data from SFTP.

Do the following:

1. In the Host / IP Address field, enter in the host or IP Address for the SFTP server.

2. In the Port field, enter the port number used by the server for SFTP communication (default is 22).

3. In the Username field, enter the user name needed to connect to the SFTP server.

4. In the Password field, enter the password needed to successfully login to the SFTP server.

5. Select the Save button to keep your Connect to SFTP query settings. You can also select the Help button to access online help and select the Cancel button to exit the window without saving any changes.