The File Storage component handles file operations against an external SFTP or FTP service—getting, listing, uploading, or deleting files. Configure it with a service, select the operation method, and define the file path and any additional inputs.
SFTP (SSH File Transfer Protocol) uses SSH encryption to secure data during transfer and is the recommended protocol for most use cases. FTP (File Transfer Protocol) transfers data without encryption and is less secure. Use it only when connecting to services that do not support SFTP.
How to read settings tables
The tables below describe each configurable option as it displays in the Unqork IDE. Values are formatted as follows:
inline code— a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked
General Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Property ID | key |
Text input | fs |
The unique identifier for this component instance. |
| Canvas Label Text | label |
Text input | — | Identifies the component on the Module Builder canvas. Does not display to end-users. |
Data Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| File Storage Type | fileStorageType |
Radio button | SFTP | Sets the protocol for the file storage service. Options include: SFTP or FTP. |
| Method | method |
Segmented control | Get | Sets the file operation to perform. |
| Service | service |
Service selector | — | The configured SFTP or FTP service to use, as set up in Services Administration. |
- Get (default): Retrieves a file from the service.
- List: Lists files available at the specified path.
- Put: Uploads a file to the service.
- Delete: Removes a file from the service.
Path
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Property ID | — | Drop-down | — | The module field that provides the file path for the operation. |
| Watch | — | Toggle | OFF | When set to ON, this setting watches the selected field for changes to re-execute the operation. |
Advanced Settings
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Disable Execution | disabled |
Toggle | OFF | When set to ON, this setting prevents the component from executing when triggered. |
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |