File Access
uniflow.plugin.fileaccess •
Category: Storage •
Version: v1.0.34
File Access Plugin Reference Manual
1. Overview
Plugin Name: File Access
Type: Storage
Identifier: uniflow.plugin.fileaccess
Description
A source plugin that monitors observable folders and allows reading/writing byte arrays and text files dynamically.
2. Configuration Parameters
The following configuration fields are available in the User Interface for this plugin:
| Configuration Setting | Description |
|---|---|
| Friendly Name | Specifies the friendly name. |
| Description / Notes | Specifies the description / notes. |
3. Exposed Routes & Data Types
The following routes are available in the Uniflow catalog for this plugin:
| Display Name | Route ID | Kind | Category | Access | Data Type |
|---|---|---|---|---|---|
| string.IsNullOrWhiteSpace(folder.Path) ? $Folder {i+1} : folder.Path | folder_{i} | Value | Storage | Read | Json |
| Write File | file:write | Value | Storage | Write | Json |
| Delete File | file:delete | Value | Storage | Write | Json |
| File added | event:fileadded | Event | Storage | Listen | Event Object |
| File deleted | event:filedeleted | Event | Storage | Listen | Event Object |
| File change | event:filechange | Event | Storage | Listen | Event Object |
Route Parameters: Write File
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|---|---|---|
path | File Path | String | true |
format | Data Type | String | true |
operation | Operation | String | true |
content | Value | String | true |
Route Parameters: Delete File
This route requires the following parameters when executing commands or writes.
| Parameter Name | Display Name | Type | Required |
|---|---|---|---|
path | File Path | String | true |
4. Usage Examples
Scenario A: Reading/Monitoring Data
To monitor data from File Access, add the corresponding Input Node in the Rule Editor and select the desired property from the catalog. Link its output to any logical comparison or directly to an Action Node.
Scenario B: Triggering Actions
If the plugin supports writable properties or actions, use an Action Node in the Rule Editor. Configure the Target property to point to the File Access action, and supply any required parameters mapping from your rule's logic.