Skip to content

Commit e521bac

Browse files
ziaghamziagham
committed
Update README file
#9
1 parent 5200f72 commit e521bac

File tree

2 files changed

+242
-40
lines changed

2 files changed

+242
-40
lines changed

‎README.md‎

Lines changed: 121 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,143 @@
1-
# Azure Files plugin for FlowSynx engine
1+
# FlowSynx Azure Files Plugin
22

3-
The **Azure Files Plugin** is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It enables secure and configurable access to Azure Files storage as part of FlowSynx no-code/low-code automation workflows.
3+
The Azure Files Plugin is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It enables interacting with Azure File Shares to manage directories and files, supporting a variety of operations such as uploading, downloading, listing, and purging file share data. Designed for FlowSynx’s no-code/low-code automation workflows, this plugin simplifies cloud file storage integration and file management.
44

5-
This plugin can be installed automatically by the FlowSynx engine when selected within the platform. It is not intended for manual installation or developer use outside the FlowSynx environment.
5+
This plugin is automatically installed by the FlowSynx engine when selected within the platform. It is not intended for manual installation or standalone developer use outside the FlowSynx environment.
66

77
---
88

99
## Purpose
1010

11-
This plugin allows FlowSynx users to interact with Azure Files for a variety of storage-related operations without writing code. Once installed, the plugin becomes available as a storage connector within the platform's workflow builder.
11+
The Azure Files Plugin allows FlowSynx users to:
12+
13+
- Upload and download files to and from Azure File Shares.
14+
- Manage files and directories with create, delete, and purge operations.
15+
- List contents of directories with filtering and metadata support.
16+
- Perform existence checks for files or folders in workflows without writing code.
1217

1318
---
1419

1520
## Supported Operations
1621

17-
The plugin supports the following operations, which can be selected and configured within the FlowSynx UI:
22+
- **create**: Creates a new file or directory in the specified path within the file share.
23+
- **delete**: Deletes a file or directory at the specified path in the share.
24+
- **exist**: Checks if a file or directory exists at the specified path.
25+
- **list**: Lists files and directories under a specified path, with filtering and optional metadata.
26+
- **purge**: Deletes all files and directories under the specified path, optionally forcing deletion.
27+
- **read**: Reads and returns the contents of a file at the specified path.
28+
- **write**: Writes data to a specified path in the file share, with support for overwrite.
29+
30+
---
31+
32+
## Plugin Specifications
33+
34+
The plugin requires the following configuration:
35+
36+
- `ShareName` (string): **Required.** The Azure File Share name.
37+
- `AccountName` (string): **Optional.** The Azure Storage account name.
38+
- `AccountKey` (string): **Optional.** The access key for the Azure Storage account.
39+
- `ConnectionString` (string): **Optional.** The full connection string for the Azure Storage account.
40+
41+
### Example Configuration
42+
43+
```json
44+
{
45+
"ShareName": "myfileshare",
46+
"AccountName": "myazureaccount",
47+
"AccountKey": "abc123xyz456==",
48+
"ConnectionString": ""
49+
}
50+
```
51+
52+
---
53+
54+
## Input Parameters
55+
56+
Each operation accepts specific parameters:
57+
58+
### Create
59+
| Parameter | Type | Required | Description |
60+
|---------------|---------|----------|----------------------------------------------|
61+
| `Path` | string | Yes | The path where the new file or directory is created.|
62+
63+
### Delete
64+
| Parameter | Type | Required | Description |
65+
|---------------|---------|----------|----------------------------------------------|
66+
| `Path` | string | Yes | The path of the file or directory to delete.|
67+
68+
### Exist
69+
| Parameter | Type | Required | Description |
70+
|---------------|---------|----------|----------------------------------------------|
71+
| `Path` | string | Yes | The path of the file or directory to check. |
72+
73+
### List
74+
| Parameter | Type | Required | Description |
75+
|--------------------|---------|----------|-----------------------------------------------------|
76+
| `Path` | string | Yes | The prefix path to list files and directories from. |
77+
| `Filter` | string | No | A filter pattern for file names. |
78+
| `Recurse` | bool | No | Whether to list recursively. Default: `false`. |
79+
| `CaseSensitive` | bool | No | Whether the filter is case-sensitive. Default: `false`. |
80+
| `IncludeMetadata` | bool | No | Whether to include file metadata. Default: `false`. |
81+
| `MaxResults` | int | No | Maximum number of results to list. Default: `2147483647`. |
82+
83+
### Purge
84+
| Parameter | Type | Required | Description |
85+
|---------------|---------|----------|-------------------------------------------------------|
86+
| `Path` | string | Yes | The path prefix to purge. |
87+
| `Force` | bool | No | Whether to force deletion without confirmation. |
88+
89+
### Read
90+
| Parameter | Type | Required | Description |
91+
|---------------|---------|----------|----------------------------------------------|
92+
| `Path` | string | Yes | The path of the file to read. |
93+
94+
### Write
95+
| Parameter | Type | Required | Description |
96+
|---------------|---------|----------|--------------------------------------------------------------------|
97+
| `Path` | string | Yes | The path where data should be written. |
98+
| `Data` | object | Yes | The data to write to the Azure File Share. |
99+
| `Overwrite` | bool | No | Whether to overwrite if the file already exists. Default: `false`. |
100+
101+
### Example input (Write)
102+
103+
```json
104+
{
105+
"Operation": "write",
106+
"Path": "documents/report.txt",
107+
"Data": "This is the report content.",
108+
"Overwrite": true
109+
}
110+
```
111+
112+
---
113+
114+
## Debugging Tips
115+
116+
- Verify the `ShareName`, `AccountName`, `AccountKey`, or `ConnectionString` values are correct and have sufficient permissions.
117+
- Ensure the `Path` is valid and does not conflict with existing files or directories (especially for create/write).
118+
- For write operations, confirm that `Data` is properly encoded or formatted for upload.
119+
- When using list, adjust filters carefully to match file names (wildcards like `*.txt` are supported).
120+
- Purge will fail on non-empty folders unless `Force` is set to `true`.
121+
122+
---
123+
124+
## Azure File Storage Considerations
18125

19-
| Operation| Description |
20-
|----------|-------------------------------------------|
21-
| `create` | Upload a new object to the blob container.|
22-
| `delete` | Remove an object from the container. |
23-
| `exist` | Check if an object exists. |
24-
| `list` | List all objects in the container. |
25-
| `purge` | Remove all contents in the container. |
26-
| `read` | Read and return the contents of an object.|
27-
| `write` | Overwrite or write new data to an object. |
126+
- Case Sensitivity: File paths are case-sensitive; use the `CaseSensitive` flag in list if needed.
127+
- Hierarchy Simulation: Azure File Shares support directories and files natively.
128+
- Large File Uploads: For large files, uploads are automatically chunked by the plugin.
129+
- Metadata: When using `IncludeMetadata` in list, additional API calls may increase latency.
28130

29131
---
30132

31-
## Notes
133+
## Security Notes
32134

33-
- This plugin is only supported on the FlowSynx platform.
34-
- It is installed automatically by the FlowSynx engine.
35-
- All operational logic is encapsulated and executed under FlowSynx control.
36-
- Credentials are configured through platform-managed settings.
135+
- The plugin uses Azure Storage SDK authentication with the provided credentials.
136+
- No credentials or file share data are persisted outside the execution scope unless explicitly configured.
137+
- Only authorized FlowSynx platform users can view or modify plugin configurations.
37138

38139
---
39140

40141
## License
41142

42-
Copyright FlowSynx. All rights reserved.
143+
© FlowSynx. All rights reserved.

‎src/README.md‎

Lines changed: 121 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,143 @@
1-
## Azure Files plugin for FlowSynx engine
1+
## FlowSynx Azure Files Plugin
22

3-
The **Azure Files Plugin** is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It enables secure and configurable access to Azure Files storage as part of FlowSynx no-code/low-code automation workflows.
3+
The Azure Files Plugin is a pre-packaged, plug-and-play integration component for the FlowSynx engine. It enables interacting with Azure File Shares to manage directories and files, supporting a variety of operations such as uploading, downloading, listing, and purging file share data. Designed for FlowSynx’s no-code/low-code automation workflows, this plugin simplifies cloud file storage integration and file management.
44

5-
This plugin can be installed automatically by the FlowSynx engine when selected within the platform. It is not intended for manual installation or developer use outside the FlowSynx environment.
5+
This plugin is automatically installed by the FlowSynx engine when selected within the platform. It is not intended for manual installation or standalone developer use outside the FlowSynx environment.
66

77
---
88

99
## Purpose
1010

11-
This plugin allows FlowSynx users to interact with Azure Files for a variety of storage-related operations without writing code. Once installed, the plugin becomes available as a storage connector within the platform's workflow builder.
11+
The Azure Files Plugin allows FlowSynx users to:
12+
13+
- Upload and download files to and from Azure File Shares.
14+
- Manage files and directories with create, delete, and purge operations.
15+
- List contents of directories with filtering and metadata support.
16+
- Perform existence checks for files or folders in workflows without writing code.
1217

1318
---
1419

1520
## Supported Operations
1621

17-
The plugin supports the following operations, which can be selected and configured within the FlowSynx UI:
22+
- **create**: Creates a new file or directory in the specified path within the file share.
23+
- **delete**: Deletes a file or directory at the specified path in the share.
24+
- **exist**: Checks if a file or directory exists at the specified path.
25+
- **list**: Lists files and directories under a specified path, with filtering and optional metadata.
26+
- **purge**: Deletes all files and directories under the specified path, optionally forcing deletion.
27+
- **read**: Reads and returns the contents of a file at the specified path.
28+
- **write**: Writes data to a specified path in the file share, with support for overwrite.
29+
30+
---
31+
32+
## Plugin Specifications
33+
34+
The plugin requires the following configuration:
35+
36+
- `ShareName` (string): **Required.** The Azure File Share name.
37+
- `AccountName` (string): **Optional.** The Azure Storage account name.
38+
- `AccountKey` (string): **Optional.** The access key for the Azure Storage account.
39+
- `ConnectionString` (string): **Optional.** The full connection string for the Azure Storage account.
40+
41+
### Example Configuration
42+
43+
```json
44+
{
45+
"ShareName": "myfileshare",
46+
"AccountName": "myazureaccount",
47+
"AccountKey": "abc123xyz456==",
48+
"ConnectionString": ""
49+
}
50+
```
51+
52+
---
53+
54+
## Input Parameters
55+
56+
Each operation accepts specific parameters:
57+
58+
### Create
59+
| Parameter | Type | Required | Description |
60+
|---------------|---------|----------|----------------------------------------------|
61+
| `Path` | string | Yes | The path where the new file or directory is created.|
62+
63+
### Delete
64+
| Parameter | Type | Required | Description |
65+
|---------------|---------|----------|----------------------------------------------|
66+
| `Path` | string | Yes | The path of the file or directory to delete.|
67+
68+
### Exist
69+
| Parameter | Type | Required | Description |
70+
|---------------|---------|----------|----------------------------------------------|
71+
| `Path` | string | Yes | The path of the file or directory to check. |
72+
73+
### List
74+
| Parameter | Type | Required | Description |
75+
|--------------------|---------|----------|-----------------------------------------------------|
76+
| `Path` | string | Yes | The prefix path to list files and directories from. |
77+
| `Filter` | string | No | A filter pattern for file names. |
78+
| `Recurse` | bool | No | Whether to list recursively. Default: `false`. |
79+
| `CaseSensitive` | bool | No | Whether the filter is case-sensitive. Default: `false`. |
80+
| `IncludeMetadata` | bool | No | Whether to include file metadata. Default: `false`. |
81+
| `MaxResults` | int | No | Maximum number of results to list. Default: `2147483647`. |
82+
83+
### Purge
84+
| Parameter | Type | Required | Description |
85+
|---------------|---------|----------|-------------------------------------------------------|
86+
| `Path` | string | Yes | The path prefix to purge. |
87+
| `Force` | bool | No | Whether to force deletion without confirmation. |
88+
89+
### Read
90+
| Parameter | Type | Required | Description |
91+
|---------------|---------|----------|----------------------------------------------|
92+
| `Path` | string | Yes | The path of the file to read. |
93+
94+
### Write
95+
| Parameter | Type | Required | Description |
96+
|---------------|---------|----------|--------------------------------------------------------------------|
97+
| `Path` | string | Yes | The path where data should be written. |
98+
| `Data` | object | Yes | The data to write to the Azure File Share. |
99+
| `Overwrite` | bool | No | Whether to overwrite if the file already exists. Default: `false`. |
100+
101+
### Example input (Write)
102+
103+
```json
104+
{
105+
"Operation": "write",
106+
"Path": "documents/report.txt",
107+
"Data": "This is the report content.",
108+
"Overwrite": true
109+
}
110+
```
111+
112+
---
113+
114+
## Debugging Tips
115+
116+
- Verify the `ShareName`, `AccountName`, `AccountKey`, or `ConnectionString` values are correct and have sufficient permissions.
117+
- Ensure the `Path` is valid and does not conflict with existing files or directories (especially for create/write).
118+
- For write operations, confirm that `Data` is properly encoded or formatted for upload.
119+
- When using list, adjust filters carefully to match file names (wildcards like `*.txt` are supported).
120+
- Purge will fail on non-empty folders unless `Force` is set to `true`.
121+
122+
---
123+
124+
## Azure File Storage Considerations
18125

19-
| Operation| Description |
20-
|----------|-------------------------------------------|
21-
| `create` | Upload a new object to the blob container.|
22-
| `delete` | Remove an object from the container. |
23-
| `exist` | Check if an object exists. |
24-
| `list` | List all objects in the container. |
25-
| `purge` | Remove all contents in the container. |
26-
| `read` | Read and return the contents of an object.|
27-
| `write` | Overwrite or write new data to an object. |
126+
- Case Sensitivity: File paths are case-sensitive; use the `CaseSensitive` flag in list if needed.
127+
- Hierarchy Simulation: Azure File Shares support directories and files natively.
128+
- Large File Uploads: For large files, uploads are automatically chunked by the plugin.
129+
- Metadata: When using `IncludeMetadata` in list, additional API calls may increase latency.
28130

29131
---
30132

31-
## Notes
133+
## Security Notes
32134

33-
- This plugin is only supported on the FlowSynx platform.
34-
- It is installed automatically by the FlowSynx engine.
35-
- All operational logic is encapsulated and executed under FlowSynx control.
36-
- Credentials are configured through platform-managed settings.
135+
- The plugin uses Azure Storage SDK authentication with the provided credentials.
136+
- No credentials or file share data are persisted outside the execution scope unless explicitly configured.
137+
- Only authorized FlowSynx platform users can view or modify plugin configurations.
37138

38139
---
39140

40141
## License
41142

42-
Copyright FlowSynx. All rights reserved.
143+
© FlowSynx. All rights reserved.

0 commit comments

Comments
 (0)