Skip to content

Update folder structure and image naming #9660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For an introduction to export mappings, refer to [Mapping Documents](/refguide/m

Figure 1 shows an example of an Export Mapping document in which two elements from a schema have been selected using the [Select Elements](/refguide/select--elements/) dialog. The entity Cheesecake (on the left) was dragged into the mapping to map to the Cheesecake element (on the right). The entity Topping was mapped to the Topping element.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/16843939.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/example-mapping-document.png" class="no-border" >}}

**Figure 1**

Expand All @@ -28,21 +28,21 @@ When the top element in the mapping is [optional](#optional), you can specify a

For child objects, it is possible to get the objects via an association with the parent object, as shown in Figure 1. In the example, the **Topping** objects that need to be exported will be fetched at runtime using the **Topping_Cheesecake** association. It is possible to edit the mapping element by double-clicking the **Topping** entity (left) or the **Topping** schema element (right). This window will be shown:

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/16843938.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/topping-object.png" class="no-border" >}}

**Figure 2**

### Getting Objects by Using a Microflow

In this window, you can choose to either get the object by association with the parent (Figure 3) or by microflow (for details, see [Mapping Attributes in Export Mappings](#mapping-attributes)). If you choose to get the object by microflow, you can pass any of the parent objects to that microflow as arguments to help determine what object you should return. This is the window in which this is configured:

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/16843937.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/object-by-microflow.png" class="no-border" >}}

**Figure 3**

When you choose to get an object by microflow, this is shown in the Export Mapping document:

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/16843936.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/object-by-microflow-example.png" class="no-border" >}}

**Figure 4**

Expand All @@ -52,7 +52,7 @@ The user can also define what should be done when the chosen method to get the M

For each value element that the complex schema element encompasses, an attribute needs to be mapped from the entity. These properties are not applicable for choice or inheritance elements because they do not contain value elements. Configuring how to map the attributes is done in the window depicted in Figure 5, which is shown after double-clicking a specific mapping element.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/16843935.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/mapping-attributes.png" class="no-border" >}}

**Figure 5**

Expand All @@ -77,7 +77,7 @@ For some selected schemas, elements defining an entity is optional. This is the

An example of this is shown in Figure 6.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/16843934.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/export-mappings/optional-mapping.png" class="no-border" >}}

**Figure 6**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Please refer to [Mapping Documents](/refguide/mapping-documents/) for an introdu

Figure 1 depicts an example of an Import Mapping document in which two elements from an XML Schema have been selected using the **Select elements...** dialog. Then, the ReceivedPartners and ReceivedClient entities were added and mapped to the Result and Client schema elements. Each time the Import Mapping is invoked, a new ReceivedPartners object is obtained.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/16843942.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/im-example.png" class="no-border" >}}

**Figure 1**

### Obtaining an Object

For each XML or JSON object, a Mendix object needs to be obtained. You can create one or find an existing object in the database. Alternatively, you can use a custom microflow that returns an object. You can define how a Mendix object is obtained in the window depicted in Figure 2, which is shown after double-clicking a specific mapping element.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/16843943.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/mapping-entity.png" class="no-border" >}}

**Figure 2**

Expand Down Expand Up @@ -66,13 +66,9 @@ Be aware that lists are not stored ordered in the Mendix database. The XML schem

Each schema value in a selected XML or JSON schema object needs to be mapped to an attribute of an entity to be used in your app. If you don't want to map certain values, uncheck them in the **Select elements...** dialog box. Configuring how to map the attributes is done in the screen depicted in Figure 3, which is shown after double-clicking a specific mapping element.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/16843943.png" class="no-border" >}}

**Figure 3**

Having defined the mappings for the attributes, these mappings are also shown in the mapping document. When a specific attribute is selected, the schema element is also selected. This works the other way around too. An example of this is shown in Figure 4, where the **dati** attribute is selected in both the entity and the schema element (in this case, dati is mapped to dati).

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/16843944.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/import-mappings/schema-example.png" class="no-border" >}}

**Figure 4**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ url: /refguide/map-automatically/

After you have selected a schema source for the mapping document, you need to connect it to entities, associations, and attributes. When you do not yet have suitable entities available in your domain model, creating new ones by hand can be difficult, especially in large mappings. The **Map automatically** button does the majority of the work for you. Based on the selected schema elements, it creates domain model entities and uses them in the mapping.

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/18579457.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/domain-model-mapping.png" class="no-border" >}}

In the above picture, no entities are connected to the schema elements and the domain model in the module is empty. After clicking **Map automatically**, the situation is as follows:

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/18579459.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/auto-map-example.png" class="no-border" >}}

The following actions will be applied:

Expand All @@ -21,13 +21,13 @@ The following actions will be applied:

A dialog is shown with the changes that have been applied to the domain model and mapping document (click **Details**"** to expand the dialog).

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/18579458.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/change-dialog.png" class="no-border" >}}

## Using Existing Entities, Attributes and Associations

If the domain model already contains entities that map to schema elements, they are reused in the mapping. By default, an entity with the same name of the schema type is used. New attributes may be added, or a generalization may be set if the entity did not already have one. New associations may be created as well if they do not yet exist. The result dialog reports if it reuses existing domain model elements:

{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/18579460.png" class="no-border" >}}
{{< figure src="/attachments/refguide/modeling/integration/mapping-documents/map-automatically/change-dialog-reuse.png" class="no-border" >}}

## Limitations

Expand Down