X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Adapter


Adapter.png

Adapter: Provides basic or additional functions, such as character set conversions, or access to an SAP system. Since the X4 Designer mainly works with XML data, adapters are usually used to create or modify XML documents. As output, adapters primarily generate XML data, which is further processed in a next process step.


To select the adapter type and set parameters, double-click the adapter icon in the drawing area. The specific meaning of the adapter properties listed below is described in the respective adapter reference.

Properties

Adapter type

Name of the adapter

Component Parameters

Set component parameters, see Using Component Parameters

Document

Path to the linked adapter in the repository

Label

Designation of the adapter in the technical process (free text)

Operation

Determines which operation will be executed by the adapter. The values and functions vary depending on the adapter.


Creating and using adapters

Adapters can be created within an ESB project in the Adapters folder. There are two options available for this purpose:

  • via the Project > Add Adapter menu

  • via New > Adapter in the context menu

To create and parameterize an adapter, proceed as follows:

  1. In an ESB project, right-click the Adapters folder to display the context menu.

  2. In the context menu, select New > Adapter.
    The File Creation Wizard for creating adapters opens.
    New-Adapter.png

  3. Select the desired adapter from the list.

    The search box allows you to search for adapter names and descriptions, and to filter the displayed adapters. You can also sort the adapters by category by clicking the Category column title.


  4. In File name, enter the adapter name.

  5. Click Finish to create the adapter in the Projects view.
    The adapter opens in the Adapter Editor to configure the parameters.

    Note:

    If you right-click (or press Ctrl + C) on the name of the parameter, you can copy it and use it in, for example, as a parameter in mappings, as a component parameter, or as a dynamic parameter.

    For more information on using parameters, see:


    Adapter-Editor.png

  6. In the Adapter Editor, define the desired parameter values, but at least the mandatory parameters.
    Mandatory fields are marked with the symbol_pflicht-parameter.png symbol.

    • Always set all adapter parameters that contain confidential information dynamically using XSL mappings, for example, the DynamicParameter processing instruction.
      For more information, see Using Component Parameters .
      This means that the access data is not set in the adapter until the technical process runs, and the corresponding parameters do not have to be specified in the adapter and are therefore not viewable.

    • For a description of the parameters for individual adapters, see Overview of the X4 Adapters.


  7. Save the adapter.

  8. Insert the adapter into the technical process using drag and drop from the Projects view.

  9. In the Properties view, select an adapter operation for the selected adapter in the Operation property.
    The adapter is now ready for use.

  10. Save the Technical Process.