Skip to content

Configure MappingΒΆ

The mapping step is the visual canvas where you define how fields extracted from API operations are assigned to components in the target Telemetry Frame. This is where the Business Event gets its observability power β€” translating raw API payload data into structured, business-meaningful telemetry.


πŸ—ΊοΈ Canvas LayoutΒΆ

The mapping canvas is split into three panels:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚   SOURCE FIELDS         β”‚   CANVAS         β”‚   TARGET FRAME COMPONENTS  β”‚
β”‚                         β”‚                  β”‚                            β”‚
β”‚  β–Ύ getOrder (GET)       β”‚  ●─────────────▢ β”‚  β–Ύ Order (Resource)        β”‚
β”‚    REQUEST              β”‚                  β”‚    order_id                β”‚
β”‚      path: order_id     β”‚  ●─────────────▢ β”‚    total_amount            β”‚
β”‚    RESPONSE             β”‚                  β”‚    currency                β”‚
β”‚      body: total        β”‚                  β”‚    status                  β”‚
β”‚      body: currency     β”‚  [Ζ’]───────────▢ β”‚    processing_latency      β”‚
β”‚      body: status       β”‚                  β”‚                            β”‚
β”‚                         β”‚                  β”‚  β–Ύ AI Model (Resource)     β”‚
β”‚  β–Ύ placeOrder (POST)    β”‚                  β”‚    model_name              β”‚
β”‚    REQUEST              β”‚                  β”‚    tokens_used             β”‚
β”‚      ...                β”‚                  β”‚    cost_usd                β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
  • Left panel β€” Source Fields: Organized by operation, then by section (REQUEST / RESPONSE) and further by payload path.
  • Center β€” Connector canvas: The visual area where mapping lines are drawn.
  • Right panel β€” Target Frame Components: The resources and their attributes defined in the selected Frame Type.

Screenshot pending

Capture required: Full mapping canvas with several connector lines drawn, one BMEL connector (Ζ’ icon) visible, IntelliSense button in the toolbar.


πŸ”— Simple Field Mapping (Drag & Drop)ΒΆ

To create a direct 1-to-1 mapping between a source field and a frame component:

  1. Hover over a source field in the left panel β€” a connection dot (●) appears.
  2. Click and drag from the dot to the target component in the right panel.
  3. Release to create the connector line.

The connector appears as a colored line across the canvas. The source field value will be directly assigned to the target component attribute at capture time.

Screenshot pending

Capture required: Drag being performed from a source field dot to a target component, showing the connector line in-progress.

Removing a mappingΒΆ

Click the connector line to select it, then press Delete or click the trash icon that appears on the selected connector.


Ζ’ BMEL Expression MappingΒΆ

For cases where a target component requires a computed value β€” combining multiple source fields, applying transformations, or implementing conditional logic β€” click the Ζ’ icon on an existing connector (or right-click a target component and select "Edit Expression").

This opens the BMEL Expression Editor. See BMEL Expression Language for full reference.

Screenshot pending

Capture required: Ζ’ icon appearing on a connector line, and the BMEL editor dialog open alongside showing an expression.

A connector that uses a BMEL expression is visually distinguished from simple connectors by the Ζ’ badge on the line.


⚑ IntelliSense Auto-Mapping¢

The IntelliSense button in the mapper toolbar triggers BizMetry's AI-assisted auto-mapping engine.

IntelliSense analyzes the semantic similarity between source field names and target component names β€” using sentence-transformers to cluster and suggest the most likely mappings β€” and populates the canvas automatically.

See IntelliSense Auto-Mapping for how it works and how to review suggestions.

Screenshot pending

Capture required: IntelliSense button in toolbar, and the canvas after auto-mapping has run showing auto-populated connectors.


πŸ“‹ Source Field ReferenceΒΆ

Each source field is identified by a canonical reference in the format:

{operationName:Section Label}.$.fieldPath

For example:

Canonical Reference Description
{getOrder:Response Payload}.$.order_id The order_id field from the response body of the getOrder operation.
{placeOrder:Request Payload}.$.customer.email The nested email field from the request body of placeOrder.
{getOrder:URI Parameters}.$.orderId A path parameter from the getOrder operation.
{getOrder:Request Headers}.$.Authorization The Authorization header from getOrder.

This format is used when writing BMEL expressions to reference specific fields.

Section labels by field locationΒΆ

Location Section Label
Request body / payload Request Payload
Response body / payload Response Payload
Path parameters URI Parameters
Query parameters Query Parameters
Request headers Request Headers

⚠️ Mapping Validation¢

BizMetry validates mappings before allowing you to save:

  • Type compatibility β€” a numeric source field mapped to a string component will generate a warning (not a blocker, as BMEL can handle coercion).
  • Unmapped required components β€” if a Frame component is marked as required but has no mapping, a validation error blocks saving.
  • Invalid BMEL expressions β€” the BMEL editor runs inline validation; malformed expressions block saving.
  • Duplicate targets β€” a single target component cannot receive more than one simple mapping (use a BMEL expression to combine multiple sources instead).

Screenshot pending

Capture required: Validation error panel at the bottom of the mapping step showing an unmapped required component warning.


πŸ’Ύ SavingΒΆ

Once all required components are mapped and validations pass, click "Save" to store the Business Event as a DRAFT.

The event is saved with: - The selected operations - All connector mappings (simple and BMEL) - The target Frame Type reference - Version 1.0 in DRAFT state

To activate telemetry capture, you must Publish the DRAFT. See Managing Versions.