---
title: "Data Mapper Component"
slug: "data-mapper-component"
status: "update"
updated: 2026-10-05T15:49:27Z
published: 2026-10-05T15:49:27Z
canonical: "docs.unqork.io/data-mapper-component"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Data Mapper Component

The Data Mapper component maps data between fields or data structures using a visual mapping table. Use it to restructure, combine, or re-key data from format to another without writing code.

> [!NOTE]
> The Build Agent does not create new instances of this component.

> **How to read settings tables**
> 
> 
> The tables below describe each configurable option as it displays in the UnqorkAI platform. 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 | `dm` | 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 Settings

### Data Storage

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Store Data in Database | `persistent` | Toggle | ON | When set to **ON**, this setting stores field values to the database when the module saves, end-users navigate between Panel components, or end-users navigate between workflow screens. Set to **OFF** to exclude this field from server-side submissions. |
| Restrict Search to Array | `restrictToArray` | Toggle | OFF | Limits field searching to the defined array. |
| Include All Fields | `includeAllFields` | Toggle | OFF | Automatically includes all module fields in the mapping table. |
| Wrap in Table | `wrapInTable` | Toggle | OFF | Wraps the mapped output in an HTML table structure. |
| Traverse Array Bottom to Top | `bottomsUp` | Toggle | OFF | Processes array items in reverse order, from last to first. |

> [!NOTE]
> Fields with **Store Data in Database** set to **OFF** are excluded from Plug-In component's API responses and Unqork's built-in tracker. When using a Plug-In component to remote-execute a module, any component whose value must be included in the API response requires **Store Data in Database** set to **ON**.

### Data Mapper Table

A visual table that maps source data fields to destination fields. Each row defines a source and a destination path. Columns are Creator-defined and configured directly in the table.

## Actions Settings

### Triggers

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Trigger Type | `triggerType` | Drop-down | **Manual** | Sets when the component executes. Options include: **Manual** or **Watch**. |
| Watch Field | `datamapperData.watchField` | Text input | — | The specific field to watch for changes. When left empty, watches all fields. |

## Advanced Settings

### Execution Options

| Setting | Field | Type | Default | Description |
| --- | --- | --- | --- | --- |
| Disable Execution | `disabled` | Toggle | OFF | Prevents the component from executing when triggered. |
| Prevent Execution While Loading Data | `preventExecuteOnLoad` | Toggle | OFF | Blocks execution while the module is still loading data. |

---

**Changelog**

| Date | Change |
| --- | --- |
| 2026-10-02 | Added Build Agent notice — the Build Agent does not create new instances of this component (EN-8141). |
| — | Initial publication. |

A data structure is the design used for organizing, using, and storing data.

A key-value pair is a fundamental data structure where a unique "key" is associated with a specific "value," used for organizing and retrieving data efficiently, like in dictionaries or databases.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the .

End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.

An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects.

HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages.

APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

Deteremines how the component triggers.