Data Mapper Component

UDesigner

Classic Designer

Overview

The Data Mapper is a Centauri (v1.0) component that manipulates submission data captured from other components using Excel formulas and Lodash functions.

Data Mapper component configurations commonly use if statements. IF statements let you make logical decisions based on an input value using the following format: =IF(condition, valueIfTrue, valueIfFalse).

A few scenarios lend themselves particularly for using the Data Mapper component:

Organizing top-level fields into a key/value pair array and manipulating that data.
Iterating an existing array as defined in the Watch Field setting. For example, the output of an Advanced DataGrid component.

You can find the Data Mapper component in the Data & Event Processing group to the left of the Module Builder.

About the Configuration Window

To learn more about general component settings, view our General Component Settings article.

Data Settings

Data Storage

Setting	Description
Store Data in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to (OFF) when you don’t want to store the values from this field in the database. When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.
Restrict Search to Array	When set to (ON), the Data Mapper component only iterates through the array defined in the Watch Field setting. When set to (OFF), the Data Mapper component iterates through the defined array and any other fields in your module. By default, this setting is set to (OFF).
Include All Fields	When set to (ON), the Data Mapper component adds all columns defined by the Data Mapper table into the Data Mapper array. When enabled, this setting also includes fields that do not contain any data. For example, if a given row contains no data in the valueB column, the array will include "valueB":"" in that row's object. When set to (OFF), the Data Mapper component omits empty cells from the Data Mapper array. So, the valueB key/value pair does not appear in that row's object. By default, this is setting is set to (OFF).
Wrap in Table	When set to (ON), the Data Mapper array saves in the submission data as an HTML table. The table's column headers are represented as Data Element and Values. The table populates with the Data Mapper array's key/value pairs. When set to (OFF), the Data Mapper array saves in the submission data as an array. By default, this setting is set to (OFF).
Traverse Array Bottom to Top	When set to (ON), the Data Mapper component searches arrays from bottom to top. By default, this setting is set to (OFF).

Data Mapper

Setting	Description
Data Mapper Table	The Data Mapper table is where you'll enter the logic for the Data Mapper component. The first column (skipping cell A1) is where you add your inclusion logic for the row. As long as the logic equals TRUE, the row attaches. For example, `=TRUE`, or `=IF(age>18, TRUE, FALSE)`. The first row (skipping cell A1) is where you define your keys. Treat this row like column headers in an Excel spreadsheet.

Setting

Description

Data Mapper Table

The Data Mapper table is where you'll enter the logic for the Data Mapper component. The first column (skipping cell A1) is where you add your inclusion logic for the row. As long as the logic equals TRUE, the row attaches. For example, =TRUE, or =IF(age>18, TRUE, FALSE).

The first row (skipping cell A1) is where you define your keys. Treat this row like column headers in an Excel spreadsheet.

Actions Settings

Actions

Setting	Description
Trigger Type	This setting provides the following options: Manual: The component fires when triggered by another component. For example, when using a Button or Initializer component to trigger a Plug-In component. By default, this Trigger Type is selected. Watch: The component fires when there's any action taken on the input listed in the Inputs table. Actions include entering a new value, editing, or overwriting a saved value. If there are multiple inputs, use the Required setting to specify what inputs must be present before firing.
Watch Field	Enter the Property ID of the component you want the Data Mapper component to watch. The Data Mapper component refreshes on each new entry in the Watch Field. By default, the Data Mapper component watches all fields. Leave this field blank to continue with default settings.

Setting

Description

Trigger Type

This setting provides the following options:

Manual: The component fires when triggered by another component. For example, when using a Button or Initializer component to trigger a Plug-In component.
By default, this Trigger Type is selected.
Watch: The component fires when there's any action taken on the input listed in the Inputs table. Actions include entering a new value, editing, or overwriting a saved value. If there are multiple inputs, use the Required setting to specify what inputs must be present before firing.

Watch Field

Enter the Property ID of the component you want the Data Mapper component to watch. The Data Mapper component refreshes on each new entry in the Watch Field.

By default, the Data Mapper component watches all fields. Leave this field blank to continue with default settings.

Advanced Settings

Setting	Description
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).
Prevent Execution While Loading Data	When set to (ON), stops the end-user from saving data until the component fully loads. When set to (OFF), the end-user can save data before the component fully loads. By default, this setting is set to (OFF).

Setting

Description

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

Prevent Execution While Loading Data

When set to (ON), stops the end-user from saving data until the component fully loads. When set to (OFF), the end-user can save data before the component fully loads.

By default, this setting is set to (OFF).

Adding a Data Mapper Component

In this example, configure a Data Mapper component to create an array with a single row of data based on an end-user's name and salary. In the DevTools Console, you'll see an extra data point stored in the array. That data point, based on the salary input, determines if the end-user qualifies for a program.

Configure the First Text Field Component

Configure a Text Field component so your end-user can enter their first name.

In the Module Builder, drag and drop a Text Field component onto your canvas.
2.In the Property ID field, enter firstName.
In the Label Text field, enter First Name.
Navigate to the Validation settings.
Set Required to (ON).
Click Save Component.

Configure the Second Text Field Component

Configure a second Text Field component so your end-user can enter their last name.

Drag and drop a second Text Field component onto your canvas, placing it below the firstName Text Field component.
2.In the Property ID field, enter lastName.
In the Label Text field, enter Last Name.
Navigate to the Validation settings.
Set Required to (ON).
Click Save Component.

Configure the Number Component

The Number component is where your end-user enters their salary. Depending on the end-user's input, the system records them as qualified or not.

Drag and drop a Number component onto the canvas, placing it below the lastName Text Field component.
2.In the Property ID field, enter salary.
In the Label Text field, enter Your Salary.
In the Prefix field, enter $.
Navigate to the Validation settings.
Set Required to (ON).
Click Save Component.

Configure the Data Mapper Component

Lastly, configure the Data Mapper component to create the logic that maps data to the database.

Drag and drop a Data Mapper component onto the canvas, placing it below the salary Number component.
In the Property ID and Canvas Label Text fields, enter dmQualified.
In the Data Mapper configuration table, enter the following:
A
B
C
D
E
1
firstName
lastName
salary
qualified
2
=TRUE
firstName
lastName
salary
=IF(salary>50000, "yes", "no")
the salary value is over $50,000, the system records "qualified":"yes". If the salary value is less than $50,000, the system records "qualified":"no".
Navigate to the Actions settings.
From the Trigger Type drop-down, select Watch.
Click Save Component.
Save your module.

	A	B	C	D	E
1		firstName	lastName	salary	qualified
2	=TRUE	firstName	lastName	salary	=IF(salary>50000, "yes", "no")

Preview your module in Express View and enter values in the fields. Open the DevTools Console and use the Angular command to view the submission data. Expand the dmQualified key to view your Data Mapper array. In the image below, the salary is less than $50,000. So, the Data Mapper component records "qualified":"no".

Overview

The Data Mapper is a Centauri (v1.0) component that manipulates submission data captured from other components using Excel formulas and Lodash functions.

A few scenarios lend themselves particularly for using the Data Mapper component:

Organizing top-level fields into a key/value pair array and manipulating that data.
Iterating an existing array as defined in the Watch Field setting. For example, the output of an Advanced DataGrid component.

You can find the Data Mapper component in the Data & Event Processing group to the left of the Module Builder.

About the Configuration Window

To learn more about general component settings, view our General Component Settings article.

Display Panel

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.