About SFTP

Upland AccuRoute supports several file transfer protocols which include FTP FTP is a network protocol for transferring files between computers over a TCP/IP-based network., FTPS FTPS is an extension to the FTP protocol that adds SSL/TLS (Secure Socket Layer/Transport Layer Security) capabilities on a standard FTP connection. , and SFTP The Secure File Transfer Protocol is a network protocol that provides file access, file transfer, and file management over any reliable data stream. It was designed as an extension of the Secure Shell protocol (SSH) to provide secure file transfer capabilities.. These protocols can be set up to work with Upland AccuRoute Server virtual folders. In addition, each protocol has a series of properties that can be used in control files and rulesets as an alternative method for FTP, FTPS, and SFTP delivery.

See FTP and FTPS Support Requirements for information about FTP and FTPS protocols, if necessary.

Before you begin

Virtual folders SFTP delivery

Administrators must complete the following tasks.

• Configure your SFTP server.

• Make note of the server parameters, for example, server address, username, password, and port. These and other parameters, if used, are needed when you create your folders.

• Set up SFTP folder.

Note: File transfer protocols (FTP, FTPS, SFTP) may experience problems with servers that use case-sensitive file naming.

Setting up SFTP folder

You can set up a SFTP folder by using Server Administrator > Configuration > Folders.

To set up a SFTP folder

1. Start the Server Administrator, if necessary.

2. Expand Configuration.

3. Right-click Folders. The Folders shortcut menu appears.

4. Select New > FTP. The Folder Properties > General dialog box appears.

5. Type a folder name in the Name box.

6. Choose any of the following Folder properties.

   • Allow users to navigate to sub-folders.

   • Allow users to create sub-folders.

   • Allow printing from folder.

7. Specify the Folder Key value in the box if different from the default value.

8. Select the Settings tab.

See the Folder Properties > Settings dialog box example below.

9. Select SFTP on the Type drop-down list.

10. Specify the server address in the Address box.

11. Specify the port value in the Port box if different from the default value.

12. Specify any of the following credentials.

    • Username (required)

    • Password (optional)

    • Use user supplied credentials if available (optional)

Note: The SFTP server/folder configuration will use the user supplied credentials as an override if it is different from the username and/or password specified when the Use user supplied credentials if available option is selected. If the option is not selected, it will ignore any user supplied credentials.

13. Specify the PuTTy Private Key file A PPK file serves as storage for private keys generated by the PuTTy program. The PPK file is used to enable communication with another party that has the corresponding public key information. in the PPK File box. (optional) or use the Ellipsis (…) button to find and select the file, if necessary.

14. Specify the passphrase The Passphrase is used to encrypt and protect the private key. in the Passphrase box. (optional)

15. Click OK.

Note: The AccuRoute Server attempts to make a connection based on the parameters you set up. A Failed to connect error message will appear if a connection cannot be made. Review and edit your parameters, if necessary.

Advanced SFTP delivery (Alternative methods)

There are other alternative methods; for example, Filescan Connector, RuleSets and more that can be used for SFTP delivery.

The Filescan connector and default folder will be used as an example in the next series of steps for illustrative purposes only.

Before you begin

• Configure your SFTP server.

• Set up the Filescan connector default folder with a control file.

Note: This is an example and not the only method that can be used for advanced SFTP delivery.

Setting up the Filescan connector default folder with a SFTP control file

You can set up the Filescan connector default folder for SFTP delivery by creating a control file. The control file is attached to a message and saved to the default folder. The server reviews the parameters in the control file to successfully deliver the message.

Note: The Filescan connector and default folder are set up as defaults when you install the AccuRoute Server.

To create the SFTP control file

• Use a text editor, third-party or custom control file generating solution to create the following SFTP control file. This is an example control file with specific properties that must be edited with your values. Some values are optional as noted in the example.

Example: SFTP Control File Properties

#DESTINATION UNC ftps://server/folder

#prFinalFormCode PDF

#prGroupFolderType 1

#prUserName username

#prPassword password (optional)

#prPPKFileData base64 encoded ppk file text (optional)

#prPPKPassphrase (optional)

#prPort 22

Note: This is just a basic example that includes properties for SFTP delivery. There are other properties that can be used and organized in the control file based on your workflow needs.

Updating the Destination UNC property

To find and update the default Filescan folder location in the control file

1. Start the Server Administrator, if necessary.

2. Select Connectors and Filescan on the Server. The Properties dialog box appears.

3. Select the Folders tab.

4. Ensure the Filescan default folder is selected.

5. Select the Properties button.

6. Add a description in the Description box. (optional)

7. View the Folder to scan box and make a note of the path; for example, \Servername\Upland\Share\Filescan.

8. Click OK.

See also

About Control Files

About Filescan Connector

Creating Folders

Managing Filescan Folders

About RuleSets