Overview
Use this article for guidance on configuring an SFTP server to securely integrate with the Workiva platform.
Note: Workiva does not create certificates for users or clients, and Workiva does not host SFTP servers. Clients are responsible for establishing and maintaining their own SFTP environments.
Background
An SFTP (Secure File Transfer Protocol) server enables secure file transfers between systems. When using an SFTP server for transferring files into the Workiva platform, the SFTP server must be client-managed. This guide provides instructions for setting up the server, configuring credentials, enabling connectors, and testing the connection.
Prerequisites
Before you begin, ensure the following:
- Access to IT resources capable of setting up and managing an SFTP server.
- Org Security Admin and Workspace Owner roles within the Workiva platform to enable connectors.
- Familiarity with Workiva Chains and Connections modules.
Step 1: Establish an SFTP Server
Setting up an SFTP server is a client-managed task.
Your IT team should:
- Set up the SFTP server.
- Implement a process to load data onto the server, either manually or through automated orchestration methods.
Step 2: Create Credentials
After setting up the SFTP server:
- Create a dedicated service user for Workiva platform access.
- Ensure the service user has permission to read (and write, if necessary) files on the SFTP server.
- Configure the user according to internal security standards.
If IP whitelisting is required, consult the Allow Hosts and Emails for Workiva article.
Step 3: Enable the SFTP Connector
The SFTP connector is a premium connector within the Workiva platform. To enable it:
- Ensure a user with the Org Security Admin & Workspace Owner roles completes the enablement.
- Follow the instructions in Manage Connectors for Chains.
- The Configuration panel will be located within the Wdata experience of your workspace.
Only members of the client organization can enable premium connectors. Workiva resources do not have access to client administrative controls.
Step 4: Configure the Connection
Once the SFTP connector is enabled:
- Navigate to the Chains module in your Workiva workspace.
- In the left-hand side panel, select Connections.
- Create a new SFTP connection using the service user's credentials.
Refer to the SFTP Connector article for detailed configuration instructions.
Step 5: Test the Connection
After configuring the connection:
- Use the List Directory command within the Chains workspace to verify the connection.
A comprehensive list of SFTP connector commands is available in the SFTP Commands article.
Troubleshooting and validation of the SFTP server setup is the responsibility of the client IT team. Workiva does not configure or host client SFTP environments.
Additional Information
- Directory Structure: Maintain a clear directory structure to facilitate data retrieval.
- Encryption: If file decryption is required, configure PGP keys within the Workiva platform. Encryption setup typically uses a separate Encryption connector. See Encryption Connector and Encryption Commands.
- SFTP PGP Access: If a PGP key is needed to access the SFTP server, follow the configuration instructions in the SFTP Connector documentation.