Skip to main content
Version: Current

Schema Mapper

Overview​

The Schema Mapper provides a visual interface for mapping and aligning fields between two data schemas. It is typically used to define how data flows between activities, where one schema acts as the source (data provider) and the other as the target (data consumer).

The mapper displays the schemas as two hierarchical trees:

  • Source schema (left)
  • Target schema (right)

Mappings define how data moves between these schemas and in which direction it flows.

Mapping Directions​

Each connection has a direction that represents the data flow:

  • IN   Data flows from the source schema to the target schema.

  • OUT   Data flows from the target schema to the source schema.

  • IN/OUT   Data flows bidirectionally between source and target.

These directions are critical when activities support bidirectional data exchange.

Creating Mappings​

Mappings can be created using either of the following interaction methods:

  • Click to Connect
  • Drag and Drop

Click to Connect​

This method allows precise mapping through selection.

Steps:

  • Click a node in either the source or target schema tree.
  • The selected node is highlighted.
  • Click the corresponding node in the opposite schema tree.
  • A connection is created between the selected nodes.
  • The connection color reflects the field datatype or group type.

Drag and Drop​

This method enables faster, gesture-based mapping.

Steps:

  • Click and hold a node in either schema tree.
  • Drag the cursor toward the corresponding node in the opposite tree.
  • The tree scrolls automatically when dragging near the bottom.
  • Release the cursor on the desired node to create the mapping.
  • The connection color is determined by the datatype (for fields) or type (for groups).

Hover Interactions​

The mapper provides contextual information through hover actions.

  • Hovering over a connection displays:     Source Node → Direction → Target Node

  • Hovering over a node displays:   - Node name   - Node type   - Datatype (for fields)

note

Automatic Group Mapping​

When a group node is mapped to another group node:

  • If all child node names match, child nodes are automatically mapped using the parent’s mapping direction.
  • If a child node already has a mapping in the opposite direction (for example, parent = IN, child = OUT), the child’s direction is updated to IN/OUT.
  • If a child node already has an IN/OUT mapping, it remains unchanged.

Connection Color Coding​

Connection colors provide visual feedback about data compatibility and flow.

ColorDescription
GreenMapping is compatible and does not result in data loss.
RedMapping may result in data loss due to incompatible or narrowing type conversion.

Changing Connection Direction​

The direction of an existing mapping can be modified using one of the following methods.

1. Direction Dropdown​

  • Select an existing connection.
  • A direction selector appears at the bottom of the dialog.
  • Choose one of the following options:   - IN – Data flows from source to target.   - OUT – Data flows from target to source.   - IN/OUT – Data flows in both directions.

2. Drag to Reverse Direction​

  • If a connection is IN, dragging from the target node back to the source node:   - Changes the direction to IN/OUT if the activity supports bidirectional mapping.   - Otherwise, switches the direction to OUT.
  • The same logic applies symmetrically when reversing an OUT connection.

Tree Toolbar​

The tree toolbar provides quick-access controls for navigating and filtering schema trees.

OptionDescription
Collapse AllCollapses all nodes in the schema tree.
Expand AllExpands all nodes in the schema tree.
ViewFilters nodes based on mapping status.
SearchOpens a search bar to locate nodes by name.

View Options​

View options control node visibility based on the mapping state.

OptionDescription
Show AllDisplays all nodes in the schema tree.
Show MappedDisplays only nodes that have mappings.
Show UnmappedDisplays only nodes without mappings.

Right Toolbar Panel​

The right toolbar provides utilities for bulk operations.

OptionDescription
Auto MapAutomatically maps nodes with matching names across schemas. The default direction is IN.
ResetRemoves all mappings and restores the mapper to its initial state.

Dialog Control Buttons​

Dialog-level controls for managing the Schema Mapper window.

OptionDescription
Minimize / MaximizeCollapses or expands the Schema Mapper dialog.
Close (X)Closes the dialog.