Configuring SFTP

Objective

After completing this lesson, you will be able to configure the SFTP settings for SFTP report distribution.

Overview of SFTP Configuration

SFTP Configuration

The goal for this section is to explain SFTP configuration for report delivery.

Why SFTP?

Automated report generation and delivery is a desired configuration for all clients. The report distributor allows for delivery of reports via e-mail and SFTP. As an administrator, to allow for SFTP delivery, you need to configure the instance to communicate with the SFTP Server.

Required Permissions

Screenshots of required permissions, accessing SFTP Configuration.

In order to complete the configuration, the user performing the configuration must belong to a role that has the SFTP Configuration Action permission. Permission configuration is covered in the WFA Permissions Unit.

SFTP Configuration Access

Accessing SFTP Configuration via Admin Menu

Screenshots of accessing SFTP Configuration via the Admin menu.

The SFTP setup can be accessed by navigating to the SFTP Configuration tool in Admin.

Accessing SFTP Configuration via Report Distributor

Screenshot of the Destination tab, to access SFTP Configuration via the Report Distributor.

Additionally, it can be accessed from the Report Distributor tool. On the Destination tab of a bundle, there is a link to access the SFTP configuration.

SFTP Configuration Screen

Screenshot of the SFTP Configuration screen.

To configure the SFTP server, configure the following settings:

  • Enable the SFTP Configuration. There should be a tick in the Use this config box.
  • You may ask your IT team to get the IP Address.
  • You need to provide the username and password to the SFTP server.
  • Directory is the folder where the files are going to be placed on the SFTP server. If you type in a folder name and the folder does not exist on the directory, the system will auto-create the directory folder. If you want to link it with an existing folder, you can type it here and if the names match, the files will be placed into that folder.

Select Save.

Note

Only one SFTP address per customer is currently supported for the Report Distributor. Jobs scheduled via Report Center’s scheduler can have independent SFTP configurations per schedule. The report distributor only sends data via the SFTP protocol. SFTP is more secure than using FTP.

How to Use SFTP with the Report Distributor?

After the SFTP configuration has been set, users can configure their reporting bundles to use SFTP for delivery. Bundles can be configured with different folder options, which help to differentiate the output of different bundles.

When setting a Report Distributor bundle to SFTP, the SFTP Folder Setup tab appears for the configuration of the bundle. You can configure four options:

  • Custom: Identify a custom folder name. If chosen and the input is left blank, it will be the same as setting No Folder.
  • Date: The folder name will be the system date in the form of YYYYMMDD.
  • Random: 36 letters digits and hyphens (for example: fb3cb185-0d2f-4675-8a47-669b6bd4fe1b).
  • No Folder: Placed in root of the folder set up in the SFTP Configuration.Screenshot ot the SFTP Folder Setup tab in Report Distributor.