Appearance
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 โ
- Navigate to External Storage from the left-hand menu.
- Youโll see a table with the following columns:
Name Type Path Actions my-example-mainSFTP /๐๏ธ my-example-reportsSFTP /example-reports๐๏ธ
Create a New Client โ
On External Storage, click Configure New Client.
In the Create External Storage Client dialog that appears:
Name - Enter a unique, human-friendly identifier.
Type - Select one of the available client types.
Configuration Fields - Configure all required fields for the specific client type.
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 โ
- In the External Storage list, locate the client you wish to remove.
- Click the Trash icon under the Actions column.
- 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 โ
| Field | Description |
|---|---|
| Name | Unique client identifier |
| Type | Must be SFTP |
| Hostname | Remote server address (domain or IP) |
| Username | SFTP account username |
| Password | SFTP account password |
| Port | TCP port for SFTP (default: 22) |
| Remote storage path | Full 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):
- See Reporting Documentation for instructions on using your new client in report export.