You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The **FlowSynx Base64 Plugin** is a built-in, plug-and-play integration for the FlowSynx automation engine. It enables encoding, decoding, and validation of Base64-encoded data within workflows, with no custom coding required.
4
+
5
+
This plugin is automatically installed by the FlowSynx engine when selected in the workflow builder. It is not intended for standalone developer usage outside the FlowSynx platform.
6
+
7
+
---
8
+
9
+
## Purpose
10
+
11
+
The Base64 Plugin allows FlowSynx users to:
12
+
13
+
- Encode raw data (strings or byte arrays) into Base64 format.
14
+
- Decode Base64-encoded data back into its original form.
15
+
- Validate whether a given string is properly Base64-encoded.
16
+
17
+
It integrates seamlessly into FlowSynx no-code/low-code workflows for data transformation and validation tasks.
18
+
19
+
---
20
+
21
+
## Supported Operations
22
+
23
+
-**encode**: Encodes the `Data` parameter into a Base64 string.
24
+
-**decode**: Decodes a Base64 string in `Data` back into its original form.
25
+
-**valid**: Checks if the `Data` parameter is a valid Base64-encoded string and returns a boolean result.
26
+
27
+
---
28
+
29
+
## Input Parameters
30
+
31
+
The plugin accepts the following parameters:
32
+
33
+
-`Operation` (string): **Required.** The type of operation to perform. Supported values are `encode`, `decode`, and `valid`.
34
+
-`Data` (object): **Required.** The input data to process. For `encode`, this can be a string or byte array. For `decode` and `valid`, this must be a Base64-encoded string.
35
+
36
+
### Example input
37
+
38
+
```json
39
+
{
40
+
"Operation": "encode",
41
+
"Data": "Hello, FlowSynx!"
42
+
}
43
+
```
44
+
45
+
---
46
+
47
+
## Operation Examples
48
+
49
+
### encode Operation
50
+
51
+
**Input Parameters:**
52
+
53
+
```json
54
+
{
55
+
"Operation": "encode",
56
+
"Data": "Hello, FlowSynx!"
57
+
}
58
+
```
59
+
60
+
**Output:**
61
+
62
+
```json
63
+
"SGVsbG8sIEZsb3dTeW54IQ=="
64
+
```
65
+
66
+
---
67
+
68
+
### decode Operation
69
+
70
+
**Input Parameters:**
71
+
72
+
```json
73
+
{
74
+
"Operation": "decode",
75
+
"Data": "SGVsbG8sIEZsb3dTeW54IQ=="
76
+
}
77
+
```
78
+
79
+
**Output:**
80
+
81
+
```json
82
+
"Hello, FlowSynx!"
83
+
```
84
+
85
+
---
86
+
87
+
### valid Operation
88
+
89
+
**Input Parameters:**
90
+
91
+
```json
92
+
{
93
+
"Operation": "valid",
94
+
"Data": "SGVsbG8sIEZsb3dTeW54IQ=="
95
+
}
96
+
```
97
+
98
+
**Output:**
99
+
100
+
```json
101
+
true
102
+
```
103
+
104
+
**Example with invalid Base64 string:**
105
+
106
+
```json
107
+
{
108
+
"Operation": "valid",
109
+
"Data": "Not a valid Base64!!"
110
+
}
111
+
```
112
+
113
+
**Output:**
114
+
115
+
```json
116
+
false
117
+
```
118
+
119
+
---
120
+
121
+
## Example Use Case in FlowSynx
122
+
123
+
1. Add the Base64 plugin to your FlowSynx workflow.
124
+
2. Set `Operation` to one of: `encode`, `decode`, or `valid`.
125
+
3. Provide input data in `Data`.
126
+
4. Use the plugin output downstream in your workflow for further processing or decision-making.
127
+
128
+
---
129
+
130
+
## Debugging Tips
131
+
132
+
- If `decode` fails, ensure the `Data` parameter contains a valid Base64-encoded string.
133
+
- The `valid` operation can be used prior to `decode` to avoid runtime errors.
134
+
- For non-UTF8 encoded binary data, make sure your workflow handles byte arrays correctly.
135
+
136
+
---
137
+
138
+
## Security Notes
139
+
140
+
- No data is persisted unless explicitly configured.
141
+
- All operations run in a secure sandbox within FlowSynx.
142
+
- Only authorized platform users can view or modify configurations.
0 commit comments