Drawing lines in message mapping

Last modified by Erik Bakker on 2024/08/18 22:10

In this microlearning, we'll explore the process of drawing lines between elements in message mapping and what it signifies. By drawing lines, we mean connecting specific elements from a source definition to corresponding elements in a target definition, ensuring that data flows correctly between systems. This step is crucial for accurate data transformation, making sure the information ends up exactly where it needs to be. We'll guide you through the process of drawing and adjusting these connections to achieve precise mappings in your integrations.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

  • Basic knowledge of the eMagiz platform

2. Key concepts

This microlearning centers around understanding how you can draw lines between elements of definitions and what it means when you draw such a line.

By drawing lines we mean: Connecting specific elements of a source definition to specific elements of a target definition

In other words, making sure that the data arrives in the place you want it to arrive.

3. Drawing lines in message mapping

3.1 Drawing lines

Let us return to where we stopped in the last microlearning by showing the message mapping overview

crashcourse-platform-design-what-is-a-message-mapping--message-mapping-overview.png

To change the message mapping you have to press Start Editing to enter the Start Editing Mode.
After you enter this mode you will see a subtle change in the background color of the overview

crashcourse-platform-design-drawing-lines-in-message-mapping--message-mapping-overview-start-editing.png

Now it is time to draw lines. To help you eMagiz identifies which mandatory elements still need to be mapped.
In this case, since we are at the beginning the mandatory element we start with is the root element.

crashcourse-platform-design-drawing-lines-in-message-mapping--message-mapping-overview-emagiz-feedback.png

You can draw lines from entity to entity (identifiable as the white rectangles) or from attribute to attribute (identifiable as the grey rectangles).
Note that when you do not draw a line to an entity but draw lines to the underlying attributes your output message will never have these attributes as part of the output.
A example of such a wrong mapping would be:

crashcourse-platform-design-drawing-lines-in-message-mapping--wrong-mapping.png

To draw the correct lines start at the top of your target definition (the definition on the right) and determine which element on the left should be the input for this element.
Continue this process until you are at the bottom of your target definition.

To draw a line you hover over the element in the source definition until you see a + icon, do a left mouse click, and hold your finger on the left mouse button.
Then start dragging your mouse to the target element.
The moment you see that the line that is being drawn turns green and you have linked the correct elements to one another you can lift your finger.

The result of connecting both root elements would be

crashcourse-platform-design-drawing-lines-in-message-mapping--result-first-drawing-of-line.png

Notice also that eMagiz now tells you that certain other mandatory elements within your target definition have not yet gotten a source input.
So let's finish drawing lines for this example.

crashcourse-platform-design-drawing-lines-in-message-mapping--result-finished-drawing.png

3.2 Removing lines

If you have made a mistake in your mapping you can access the context menu via a right-click on one of the lines and press Delete.

crashcourse-platform-design-drawing-lines-in-message-mapping--remove-lines-context-menu.png

Be aware that when you already transferred your integration to Create and you have customized the message mapping in any way deleting a line here means also deleting all that work in Create.
So think before you act.

4. Key takeaways

  • Drawing lines makes it possible to make sure that the data arrives in the place you want it to arrive.
  • To correct mistakes you can remove a line again. This removal can have an impact so think before you act.

5. Suggested Additional Readings