The Data Workflow component executes a configurable pipeline of data operations, including API calls, data transformations, filtering, and sorting, in sequence. Configure inputs and outputs to map module data into and out of the Data Workflow.
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 | dwf |
The unique identifier for this component instance. |
| Canvas Label Text | label |
Text input | — | Identifies the component on the Module Builder canvas. Does not display. |
Data Workflow Canvas
The Data Workflow canvas is a visual editor where Creators build the data pipeline. Drag and drop operators onto the canvas and connect them to define the sequence of operations, including API calls, data transformations, filtering, and sorting. Input and Output operators define what data enters and exits the Data Workflow.
The Tables tab reflects the inputs, outputs, and operations configured on the canvas.
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Enable Manual Layout | manualLayout |
Toggle | OFF | When set to ON, this setting lets Creators manually position operators on the canvas. When set to OFF, the canvas auto-arranges operators. |
Tables Settings
Inputs and Outputs
Inputs
Displays every Input operator's property ID, label, requirement, and source as configured in the Data Workflow canvas.
| Column | Field | Type | Description |
|---|---|---|---|
| ID | id |
Property ID | The module field to pass as input to the Data Workflow. |
| Label | inputLabel |
Text input | A descriptive label for the input. |
| Required | inputRequired |
Drop-down | Sets whether this input is required for the Data Workflow to execute. |
| Source | source |
Drop-down | The source of the input data. |
Outputs
Displays every Output operator's property ID, label, and action as configured in the Data Workflow canvas.
| Column | Field | Type | Description |
|---|---|---|---|
| ID | id |
Property ID | The module field to populate with the Data Workflow output. |
| Label | outputLabel |
Text input | A descriptive label for the output. |
| Action | action |
Text input | The action applied to the output value. |
Data Workflow Configuration
Displays the operations from the Data Workflow canvas in the order they execute.
| Column | Field | Description |
|---|---|---|
| Operation | dataOperation |
The type of operation (for example, API call, filter, sort, transform). |
| Label | label |
A descriptive label for this operation. |
| Opt 1–5 | option1 – option5 |
Configuration options specific to the selected operation type. |
| Input 1–2 | input1, input2 |
Input values for the operation. |
| Output 1–2 | output1, output2 |
Output values from the operation. |
| Argument | argument |
An additional argument for the operation. |
Actions Settings
Triggers
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| Trigger Type | triggerType |
Radio button | Manual | Sets when the component executes. Manual waits to be triggered by another component. Watch executes when a defined input field changes, or when triggered by another component. |
Unit Testing
The Unit Testing panel lets you verify Data Workflow behavior by defining test input and expected output values.
Inputs
| Column | Field | Type | Description |
|---|---|---|---|
| Input | inputField |
Property ID | The input field passed into the Data Workflow for testing. |
| Label | inputLabel |
Text input | A descriptive label for the input. |
| Value | inputValue |
Text input | The test value to pass in for this input. |
| JSON | json |
Checkbox | When checked, the value is parsed as JSON. |
Outputs
| Column | Field | Type | Description |
|---|---|---|---|
| Output | outputField |
Property ID | The output field returned by the Data Workflow. |
| Label | outputLabel |
Text input | A descriptive label for the output. |
| Expected | expectedValue |
Text input | The expected value for this output. |
| Actual | actualValue |
Text input | The actual value returned after running the test. |
| JSON | json |
Checkbox | When checked, the value is parsed as JSON. |
Advanced Settings
Set Execution
| Setting | Field | Type | Default | Description |
|---|---|---|---|---|
| debug Mode | dataworkflowData.isDebugMode |
Toggle | OFF | Outputs inputs and outputs for each operation step to the browser console. |
| Disable Execution | disabled |
Toggle | OFF | Prevents the component from executing when triggered. |
| Error Trigger | errorHandler |
Drop-down | — | The Property ID of the component to trigger when the Data Workflow encounters an error. |
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |