Data Workflow Component

Overview

The Data Workflow component processes and manipulates data in your Unqork applications. The Data Workflow component has broader functionality than any other component in Unqork. It's an ETL (Extract, Transform, Load) tool that lets you transform, manipulate, and move data.

Below are a few examples for using the Data Workflow component:

Display form submission data in a dashboard.
Convert an end-user's quiz answers into a grade.
Transfer data to other components.
Isolate an area code from a phone number.

You'll find the Data Workflow component under the Data & Event Processing group to the left of the Module Builder.

About the Configuration Window

To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.

Display Panel

Field Text

Setting	Description
Canvas Label Text	Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Setting

Description

Canvas Label Text

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Canvas

Setting	Description
Open Canvas	Opens the Data Workflow canvas.

Data Workflow Canvas

The Data Workflow canvas lets you add, arrange, and connect Data Workflow operators. Operators are the individual parts of your Data Workflow. They let you manipulate large and complex data structures from multiple sources, and you'll connect them to complete your operations.

Operator List and Canvas Settings

The Data Workflow canvas contains a list of operators on the left side, and the canvas on the right. To add an operator, drag and drop it onto the canvas.

Category	Description
Search	Lets you quickly search for an operator by name.
Frequently Used	A list of frequently-used operators in Unqork.
I/O	A list of Input/Output operators. These operators let you input data, create tables and values, and output data to components. They include the Input, Create Table, Output, and Console operators. To learn more about the I/O operators, view our Introduction to Data Workflow I/O Operators article.
Gateways	A list of Gateways operators. These operators let you introduce decision logic, control Data Workflow pathways, and merge and split branches. They include the Branch Split and Branch Merge, Decision, and Input Switch operators. To learn more about the Gateways operators, view our Introduction to Data Workflow Gateways Operators article.
Table	A list of Table operators. These operators let you append and merge tables, create a nested table, and output data as a string or an object. They include the Append, Create Field, Merge, Nest By, and Table2Object operators. To learn more about the Table operators, view our Introduction to Data Workflow Table Operators article.
Array	A list of Array operators. These operators let you retrieve data from a data set, add values to a data structure, and join an array of values. They include the Array2Col, Get, Join, and Set operators. To learn more about the Array operators, view our Introduction to Data Workflow Array Operators article.
Object	A list of Object operators. These operators let you remove null values, create a table into an object, and merge two objects into one. They include the Clean Object, Diff, Extend, and Has operators. To learn more about the Array operators, view our Introduction to Data Workflow Object Operators article.
Value/String	A list of Value/String operators. These operators let you convert Excel files into JSON, convert a JSON string to a JSON object, and find matching values in a table. They include the Convert Value, Formula, NLP, and Split String operators. To learn more about the Value/String operators, view our Introduction to Data Workflow Value/String Operators article.
Enable Manual Layout	Set to (ON) to place operators anywhere on the canvas without them organizing by default. By default, this toggle is set to (OFF).

Inputs

Setting	Description
Inputs Table	Displays every Property ID, Label, Requirement, and Source configured in the Data Workflow's Input operators. You can make changes to these values and they'll be reflected in the operator settings.

Outputs

Setting	Description
Outputs Table	Displays every Property ID, Label, and Action configured in the Data Workflow's Output operators. You can make changes to these values and they'll be reflected in the operator settings.

Data Workflow Configuration

Setting	Description
Data Workflow Configuration Table	Displays every other operation in the Data Workflow, in the order than they fire. You can see each operator's Label and Opt 1-5. Opt columns represent fields in each operator. For example, in the Clean Keys operator, Opt 1, Opt 2, and Opt 3 represent the Keys, Fill If, and Fill With fields, respectively.

Setting

Description

Data Workflow Configuration Table

Displays every other operation in the Data Workflow, in the order than they fire. You can see each operator's Label and Opt 1-5.

Opt columns represent fields in each operator. For example, in the Clean Keys operator, Opt 1, Opt 2, and Opt 3 represent the Keys, Fill If, and Fill With fields, respectively.

Setting	Description
Trigger Type	A drop-down menu that lets you decide how to trigger your Data Workflow. The options include: Manual: The component fires when triggered by another component, like a Button or Plug-In component. Watch: The component fires after waiting for an action to occur by another part in the module. Actions include entering a new value or editing or overwriting a saved value. By default, this drop-down is set to Manual.

Setting	Description
Debug Mode	Selecting this checkbox outputs the inputs and outputs from each operator. You can view every execution, operation, and data manipulation occurring in the Data Workflow. This setting lets you open the DevTools Console while in the Module Builder to troubleshoot, without having to preview the module in Express View. If an issue occurs in your Data Workflow, select this checkbox and open the DevTools Console. You'll see detailed error messages identifying the issue and the operator where the issue occurred.
Disable Execution	If Disable Execution is set to (ON), the logic tied to this component does not execute. Use this to keep the component's settings, but disable the operations it performs. By default, this setting is set to (OFF).
Error Trigger	Enter the Property ID of a component to trigger if the Data Workflow fails.

Adding a Data Workflow Component

This article will help you set up a simple Data Workflow that does the following:

Brings data from a Data Table component into your Data Workflow, using the Input operator.
Turns the table data structure into an object, using the Table2Object operator.
Pulls out a single value from the object, using the Get operator.
Outputs the value to a Hidden component, using the Output operator.

You'll also include Console operators at each step so you can visualize what the Data Workflow component does.

These instructions assume that you have an open module saved with a title.

Configure the Data Table Component

First, you'll configure a Data Table component with two columns of field and value with a simple annual income value.

In the Module Builder, drag and drop a Dropdown Component Icon

Data Table component onto your canvas.

In the Property ID and Canvas Label Text fields, enter dtData.

In the Inputs table, enter the following:

	A	B
1	field	value
2	incomeAnnual	68000

Click Save Component.

Configure the Hidden Component

Configure a Hidden component to store the Data Workflow component's output.

Drag and drop a icon

Hidden component onto your canvas, placing it below your Dropdown Component Icon

Data Table component.

In the Property ID and Canvas Label Text fields, enter income .

Click Save Component.

Configure the Data Workflow Component

Next, you'll configure the Data Workflow component's settings and operators.

Drag and drop a Data Workflow component onto your canvas, placing it above your icon

Hidden component.

In the Canvas Label Text and Property Name fields, enter dwfData.

Configure the Input Operator

You'll configure an Input operator to retrieve the Data Table component data and input it into the Data Workflow.

Drag and drop an Input operator onto your Data Workflow canvas.

Configure the Input operator's Info window as follows:

Setting	Value
Component	dtData
Required	Yes
Source	Default

Configure the Table2Object Operator

The Table2Object operator converts the table data structure into an object.

Drag and drop a Table2Object operator onto your Data Workflow canvas.

Configure the Table2Object operator's Info window as follows:

Setting	Value
Key Column Name	field
Value Column Name	value

Connect the output port (right) of the Input operator to the input port (left) of the Table2Object operator.

Configure the Get Operator

Use a Get operator to retrieve the incomeAnnual value from the object.

Drag and drop a Get operator onto your Data Workflow canvas.

Configure the Get operator's Info window as follows:

Setting	Value
Path	incomeAnnual

Connect the output port (right) of the Table2Object operator to the input port (left) of the Get operator.

Configure the Output Operator

Next, let's output the incomeAnnual value to the income icon Hidden component.

Drag and drop an Output operator onto your Data Workflow canvas.

Configure the Output operator's Info window as follows:

Setting	Value
Component	income
action	value

Connect the output port (right) of the Get operator to the input port (left) of the Output operator.

Configure the Console Operators

Add three Console operators at the end of each step of your Data Workflow. Console operators let you view how your data is manipulated in the DevTools Console.

Drag and drop three Console operators onto your Data Workflow canvas.

Complete the first Console operator's Info window as follows:

Setting	Value
Category	Console
Label	Before Table2Object

Connect the output port (right) of the Input operator to the input port (left) of the first Console operator.

Complete the second Console operator's Info window as follows:

Setting	Value
Category	Console
Label	After Table2Object

Connect the output port (right) of the Table2Object operator to the input port (left) of the second Console operator.

Complete the third Console operator's Info window as follows:

Setting	Value
Category	Console
Label	After Get

Connect the output port (right) of the Get operator to the input port (left) of the third Console operator.

Click Save Component.

Your completed Data Workflow looks like the following:

Configure the Button Component

Lastly, trigger the Data Workflow with a Button component.

Drag and drop a Button component Icon

Button component onto your canvas, placing it below your icon

Hidden component.

In the Property ID field, enter btnRunDWF.

In the Label Text field, enter Run DWF.

Navigate to the Actions settings.

From the Action Type drop-down, select Event.

From the On Click field, enter or select .

Click Save Component.

Save your module.

Preview your Data Workflow in Express View and click Run DWF. Open the DevTools Console to view each step of the Data Workflow's data manipulation. The Data Workflow converts the Data Table to an object, retrieves a single value, and sends the value to the income icon Hidden component.

Setting	Description
Canvas Label Text	A Data Workflow component's Canvas Label Text conveys what the component is and what information it displays. You can only see it in the Module Builder canvas. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.
Property Name	A Property Name (Property ID) is the unique field ID used by Unqork to track and link your module components. The Property Name is how the software identifies your component. Using Property Names lets you link components, creating logic-based configurations and API (application programming interface) calls. Property Names should use camel case (stylized as camelCase) without spaces or punctuation.
Permissions Tab	Select this tab to see the RBAC settings of the component.
Learn About Using Data Workflow	This link takes you to the Introduction to Data Workflowarticle on the Documentation Hub.
Cancel	Cancels any recent configuration changes and returns you to the Module Builder canvas.
Save	Saves all settings as configured and returns you to the Module Builder canvas.

Setting	Description
Close Unit Testing	Collapses the Unit Testing section. When collapsed, the button text changes to "Open Unit Testing." Clicking this button again expands the Unit Testing section.
Refresh Fields	Updates all Input fields to reflect changes on the canvas.
Run All Tests	Runs all added tests with the Input values entered.
Input Table	Use this table to enter the information you want to test. If you have multiple inputs and want to skip testing certain inputs, just leave the Value column blank. If you set an input as required, then you must enter its value. Only non-required inputs can have a blank Value column.
Input	Automatically populates all components in your Data Workflow synced with an Input operator.
Label	Automatically populates the label of your connected Input component.
Value	Enter example data in this column that you want to test. If you enter a JSON value with a syntax error (such as a missing bracket), the cell turns yellow indicating an error scenario.
JSON	Select this checkbox when you enter a Value that's written in JSON. This can be an object, array, number, or Boolean (true/false) value.
Output Table	This table displays the results of your test.
Output	Automatically populates all components listed in the Calculator's Outputs table.
Label	Automatically populates with the label of your connected Output component.
Expected	Enter the outcome you expect from the test you're running. You can use this to compare the result you expected with the actual result side-by-side. This column is optional. If you decide to leave it blank, the cell turns red when the unit test runs.
Actual	The result from the test you ran.
JSON	Select this checkbox when your result must display in JSON. This can be an array, string, or object.
Delete Test	Removes an existing test.
Duplicate	Makes a copy of an existing test.
Run Test	Runs the test with the Input values entered.

Data Workflow Component

Overview

About the Configuration Window