Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

Data Mapper Component

Prev Next

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 one format to another without writing code.

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

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.

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

—

Initial publication.