You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

A connector describes a configuration for an adapter to access a backend system. Refer to Managing Connectors for more details on creating and managing connectors.

Creating a Connector

Connectors are managed within the Connectors folder.

Hover with your mouse over the Connectors tree node in the service panel. Click the icon to create a new connector.

Alternatively, you can open the context menu of the Connectors folder and click Add > Connector.


The Manage Connectors dialog is displayed.

Select a type of connector from the dropdown list.

Configure the connector in the Configuration section, e.g. OpenAPI connectors can be configured by simply importing a JSON or YAML description file.

Supported OpenAPI versions are 2.0, 3.0.0, 3.0.1, 3.0.2, and 3.0.3. The OpenApi version 3.1 is not supported at the moment.

Refer to Adapters for more information about adapters and their related connector configuration.

When you have selected an appropriate file, click Next.

The Next button is enabled only when you have selected a file.

If the selected file cannot be loaded, a corresponding error message is displayed in the dialog.

Additionally a (more detailed) toast message is displayed. The following error messages are possible:

Displayed Message Possible Reason Solution
The OpenAPI version 'x.y.z' is not supported. Versions 2.0.0, 3.0.0, 3.0.1, 3.0.2, and 3.0.3 are supported.
  • You have selected a file in a version that is not supported.
  • Select a file in a version that is supported.
The property 'swagger' or 'openapi' is missing.
  • The mentioned properties are missing from the file or are misspelled.
  • Check if the basic structure of the file is correct.
    For more detailed information about the basic structure of an OpenAPI file refer to OpenAPI Basic Structure.

The file cannot be loaded.



  • The selected file is corrupt.
  • Select a valid file.
  • The selected file has the wrong file type.
  • Select a file of a supported file type, e.g. a YAML description file.


After the selected file has been successfully imported, you can start the actual configuration of the connector.

When everything is configured to your needs, click Next to save the connector.

The connector, his types and interfaces, have been added to your service with the given configuration.

Connector Options

Right-click a form to open its context menu.

The context menu displays all options available for the connector:

  • No labels