Import with Mapping

Last update: Edit

1 Introduction

The Import with mapping activity allows you to import the data stored in an XML or JSON document into domain model entities.

2 Properties

An example of import with mapping properties is represented in the image below:

import with mapping properties

There are two sets of properties for this activity, those in the dialog box on the left, and those in the properties pane on the right.

The import with mapping properties pane consists of the following sections:

3 Action Section

The Action section of the properties pane shows the action associated with this activity.

You can open a dialog box to configure this action by clicking the ellipsis () next to the action.

You can also open the dialog box by double-clicking the activity in the microflow or right-clicking the activity and selecting Properties.

3.1 Variable

The input variable can be the name of a string variable, a file document, an HttpRequest, or an HttpRequest. The content of the file document, HttpRequest, or HttpResponse should be XML or JSON.

3.2 Mapping

The import mapping defines how to transform the XML or JSON into objects.

3.3 Input Content Type

If the import mapping is based on a message definitions, it can import both XML and JSON. Select whether the input object contains XML or JSON.

3.4 The Input Contains

If the import mapping is based on a message definitions, it can import both single objects and lists. Select whether the input is a single object or a list of objects.

3.5 If No Object Was Found

You can indicate what should happen if no object was found when the import mapping has checked the box decide this at the place where the mapping gets used.

3.6 Parameter

If the selected mapping requires a parameter, you can choose it here.

3.7 Range

If the mapping returns a list, you can select a range to determine how many objects are mapped and returned.

Range Meaning
All Map and return all objects.
First Map and return only the first object. The result of the action will be a single object instead of a list.
Custom Map and return a given number of objects (limit). The limit is a microflow expression that should result in a number.

3.8 Commit

Indicates whether the resulting objects should be committed to the database, and whether event handlers should be triggered.

Option Description
Yes The objects are saved in the database and the event handlers are triggered.
Yes without events The objects are saved in the database, but the event handlers are not triggered (default).
No The objects are created without being saved in the database. You will need a commit action to save them.

3.9 Validate Against Schema

Determines whether the import action should validate the incoming XML against the XML schema.

Setting this to yes can impact performance!

Default: No

3.10 Store in Variable

Choose whether to store the result of the import.

3.11 Type

The type of the result.

3.12 Name

The name of the result of the import.

4 Common Section

For more information on properties in this section, see Common Properties.