An XML interface enables Create, Modify or Delete actions for all entities managed by Lobster Data Platform / Orchestration via profiles.

In addition to these actions directly related to a specific entity, an import can also directly trigger an event (see Custom action event) and optionally provide data in XML format.

Regardless of the type of action to be performed, the overall process is referred to as an Import. Basically, there are two different import methods to choose from, which are closely related on a technical level:

A Single import allows an import referring to exactly one single entity.
A Batch import enables imports of multiple entities, either by a series of standalone 'single transactions' (similar to performing a Single import for each individual object) or a collective 'batch transaction' covering all entities.

►NOTE◄ Since the Batch import completely covers the functionality of the Single import and adds additional functionality on-top (e.g. for error handling), there is no disadvantage in always using a Batch import, even if only a single entity is imported.

The system provides XSD files for all relevant data structures via a sub-page "./system/schema/all" relative to the URL used for login.

For any XML structures defined there, compliant Orchestration templates for the corresponding data objects are available, which can be used to build source and target structures in profiles.

Orchestration templates are also available for the Import structures for Single import (core:Import) or Batch import (core:BatchImport).

The following sections describe the general interaction of Lobster Data Platform / Integration and Lobster Data Platform / Orchestration for import.

Further information about importing:

Configuring an Import-profile

The following list summarizes the typical process pattern of an import profile:

The Lobster_data-Profile processes the input data, which contains all necessary information for the import, in the following steps:

Phase 1: The Input Agent defines the input data to process by the profile.
Phase 2: The Parser transforms the format of the input data into the 'source structure' defined for the profile.
Phase 3: The parsed source data is transferred via Mapping to a target structure that corresponds to the XML import format of Lobster Data Platform / Orchestration. This Import structure contains header data for the import process as well as the necessary detailed data of the objects to be manipulated.
Phase 5: The Integration Unit (IU) formats the generated 'target data' for output. Typically, the the IU type XMLNoTemplateUnit is used for XML imports.
Phase 6: To transfer the XML data from the profile to the server, a Response (unit) must be set up that passes the output data of the 'IU' to the so-called ImportResponder (Responder) and must also provide authentication data for the import.

Phase 1 and Phase 2: Standard functionality of Lobster_data

The preparation of input data in phases 1 and 2, up to the definition of a source structure for the mapping in phase 3, is an individual process depending on the content and format of the input data. No specific aspects result from a subsequent import into Lobster Data Platform / Orchestration. The technical possibilities and suitable procedures for phases 1 and 2 are described in the documentation for Lobster Data Platform / Integration.

Phase 3: Mapping

Specific aspects for the configuration of an import profile, on the other hand, are described in the following paragraphs or other sections of the Lobster Data Platform / Orchestration manual referenced there:

Details about the Import structure and the use of Orchestration templates in Phase 3 (see the gray shaded area in the diagram above) are described on the pages for Single import, Batch import and Orchestration templates.
Typical settings for the Integration Unit (Phase 5) are described below, along with details on the configuration of the Response Route (Phase 6) and on the ImportResponder (Responder) page.

►NOTE◄ Phase 4 – the processing of the target data on a database level – is usually irrelevant for the import and is therefore skipped.

Phase 5: Integration Unit

The task of the Integration Unit is the conversion of the input data, which has been transformed to the Import structure by Mapping, into the predefined XML format for the import into Lobster Data Platform / Orchestration.

In the configuration of a profile in Lobster_data the tab for Phase 5 must be selected for this step.
The Integration Unit is defined there. To generate an XML from the data mapped to a target structure, the "XMLNoTemplateUnit" is usually suitable. It was already selected in the screenshot, so that the corresponding parameters appear below.
Details about these parameters are described in the context help in Lobster_data, which can be accessed via the ? symbol next to the Integration Unit combobox.
The Root node name parameter is highlighted in the screenshot. It must always refer to the name of the 'root node' of the import structure (here: Import).

images/download/attachments/201674898/image2020-9-25_20-8-45-version-1-modificationdate-1747120021588-api-v2.png

Phase 6: Response Route

Phase 6 defines the Response Route for the transfer of data generated by the previous phases to one or more recipients.

For an import profile it is crucial that a Response Route (often briefly referred to as a Response) is configured as described below:

A right click in the list of Responses opens a context menu with the entry New response. In the submenu for this menu item, numerous categories of response routes appear. The relevant type for an import profile, ImportResponder (Responder), belongs to the category Custom class.

After selecting a category for a new Response Route, a form appears immediately below the list where details can be set:

The Name can be freely chosen and appears in combination with the internal label for the selected category to identify the Response Route in the list of Responses.
In the Custom class-Settings detail tab, what type of Responders (for Orchestration) is to be used must be specified under Class. The ImportResponder (Responder) must be selected here.
For the authentication of an import into Lobster Data Platform / Orchestration, suitable login data must be provided as Additional parameters. Besides directly entering the XML structure of a LobsterDataLoginRequest object, corresponding content can also be provided via a variable. A click on the % symbol highlighted in the image opens a list in which a reference to a variable can be selected. The content for this variable can be conveniently prepared by using the function Create Login Request (Integration function) during Mapping (Phase 3).

images/download/attachments/201674898/image2020-9-25_20-13-49-version-1-modificationdate-1747120021583-api-v2.png

Example for 'Additional parameters' for authentication of an import:

Login Beispiel

 <base:LobsterDataLoginRequest xmlns:base='SCM.BASE' userName="admin" selectedRole="1" selectedCompany="1" />

For further details on authentication see Integration login or Create Login Request (Integration function).

A final important step to define the Response Route for an import profile is to assign the output data of the Integration Unit as Content for the Response Route:

In the Content settings detail tab, the option Output of IU must be selected for the required parameter Content, to assign the XML structure defined by the Integration Unit as content for the Response. Finally, the configuration for a new or changed Response must be confirmed by clicking on the Apply button (bottom right).