Skip to content

External Storage โ€‹

External Storage Clients let you connect your application to external (remote) file-storage systems (e.g. SFTP servers) so that features like reporting can export data outside of the FVV server.

URL: /hub/external-storage

Managing External Storage Clients โ€‹

On the External Storage page you can:

  • List all existing clients
  • Create a new client via an interactive form
  • Delete a client you no longer need

Browse Clients โ€‹

  1. Navigate to External Storage from the left-hand menu.
  2. Youโ€™ll see a table with the following columns:
    NameTypePathActions
    my-example-mainSFTP/๐Ÿ—‘๏ธ
    my-example-reportsSFTP/example-reports๐Ÿ—‘๏ธ

Create a New Client โ€‹

  1. On External Storage, click Configure New Client.

  2. In the Create External Storage Client dialog that appears:

    1. Name - Enter a unique, human-friendly identifier.

    2. Type - Select one of the available client types.

    3. Configuration Fields - Configure all required fields for the specific client type.

    4. Confirm - Click Confirm to validate your inputs and save the new client.

๐Ÿ’ก To see specific configuration for the currently supported client types, check out the Client Configuration section.

โš ๏ธ Once a client has been created, it cannot be updated. To change its settings, you must delete the client and recreate it from scratch.

Delete a Client โ€‹

  1. In the External Storage list, locate the client you wish to remove.
  2. Click the Trash icon under the Actions column.
  3. Confirm the deletion when prompted.

โš ๏ธ Deleting a Client cannot be undone. Any processes relying on that client will fail.

Update a Client โ€‹

Immutable Configuration - Once created, you cannot edit a clientโ€™s configuration. To change any field, you must delete the client and create a new one with the updated values.

Client Configuration โ€‹

SFTP Client Configuration Reference โ€‹

FieldDescription
NameUnique client identifier
TypeMust be SFTP
HostnameRemote server address (domain or IP)
UsernameSFTP account username
PasswordSFTP account password
PortTCP port for SFTP (default: 22)
Remote storage pathFull directory path on the server; *must already exist

โš ๏ธ *The Remote Storage Path must already exist on the remote server. If it does not, any service that attempts to use this client will fail.

Only password-based authentication is supported for the SFTP client.

Integration โ€‹

After creation, your External Storage Client is immediately available to other system features (e.g. Reporting Data Export):