Data Workflow Component

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.

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 Operator 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

Lets you place operators anywhere on the canvas without them organizing by default. By default, this toggle is set to (OFF).

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 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 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.

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 (for example, 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.

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).

Debug

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.

Error Trigger

Enter the Property ID of a component to trigger if the Data Workflow fails.

Field Tags

Assign components one-word labels to help organize, identify, and group the components in your application.

Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panel components. The Field Tags identify the data type of parameters included in the API request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag.

Field Tags act as a type of Property ID group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component.

For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag.

Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.

Comment

Add comments in your Data Workflow to help team member's understand its functionality.

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.