External Locations
The External Locations allows you to define reusable connection settings for securely transferring files to remote servers using SFTP or FTP(S) in Distribution. Each recipient of a distribution job receives their documents in a user-named folder, automatically created within a specified base directory.
You must be an administrator or have the Manage External Locations permission to configure External Locations.
Create an external location
- From the navigation panel, click the gear icon at the bottom. The Administration page opens.
- Select Distribution, then External Locations.
- In the Options panel, click Create a new External Location.
- In the Properties window, configure the settings using options Properties, as well as those for FTP(s) or SFTP, depending on your connection type.
Common Properties
| Field | Description |
|---|---|
| Description | Enter a meaningful label to identify the connection. |
| Type | Select the protocol: FTP or SFTP. |
| Host | Specify the server address (IP or domain) of the remote FTP/SFTP server. |
| Port | Specify the communication port. Defaults: 21 for FTP, 22 for SFTP, 990 for FTPS. |
| Username | Enter the username for authenticating with the server. |
| Password | Enter the password associated with the username. |
| Base Directory | Define the root directory for file transfers. Leave blank to use the user's root directory. |
| Trust Invalid Certificates | Allow connections to servers with self-signed or expired certificates. Use with caution. |
FTP(S) properties
These options are available only when FTP is selected as the protocol type.
| Option | Description |
|---|---|
| Use SSL/TLS | Enable encryption over FTP (also known as FTPS). Recommended for secure transfers. |
| Is Implicit | Enable implicit mode for FTPS. This setting is available only when SSL/TLS is enabled. |
| Passive | Enable passive mode so the file server selects the data channel port. |
These options are not visible when using SFTP, which already enforces encryption.
SFTP properties
When SFTP is selected, authentication can use a Username/Password and/or SSH key.
| Option | Description |
|---|---|
| Private Key | Enter the private key certificate used for authentication. |
| Pass Phrase | Enter the password for the private key. This is required if the key file is encrypted. |
Test your connection
After you fill in the connection details, click Save to verify that credentials and access permissions are correct.
Use the connection in report distribution
After you save the external location, it becomes available for use in Distribution Jobs. In the Job Properties window, select the action Export to External Location from the dropdown list in the General tab, then choose the appropriate external location.