Connections

Set up and manage source connections in the Import Tool so you can import data from external systems.

A connection links the Import Tool to an external source system. You must create a connection before you can configure and run a stream. Within the Connections view, you add the connections, their credentials, configure source-specific catalog or location settings when available, and test that the source is reachable.

Connections page with configured sources, credential status, and Test, Edit, and Delete actions

Complete the Prerequisites before you set up a connection. Source systems also need their own permissions before you import data. For examples, see Importing from Celonis and Importing Using HTTP.

Create a connection

1

Open the Import Tool

In Management Dashboard, open the Import Tool perspective.

2

Open Connections

In the sidebar, choose Connections.

3

Start a new connection

Choose + New connection.

4

Enter connection details

Provide a Name for the connection, then choose the Source type. Supported source types include Celonis and HTTP / REST API.

Enter the credentials and other settings required for the selected source. The fields depend on the source type. The following sections explain the HTTP / REST API and Celonis settings.

5

Save and test the connection

Choose Save, then choose Test connection. Test connection is unavailable until the connection is stored.

The connection appears in the list. When credentials are saved successfully, the Credential column shows Stored.

After the connection is stored and tested, open Imports and create a stream that uses this connection as its source.

Use a clear connection name that identifies the source system and environment. You have to select this connection later when you create a stream.

HTTP / REST API

Use HTTP / REST API when the source exposes records over HTTP.

HTTP / REST API connection with base URL, test endpoint, bearer token, and field discovery from an OpenAPI specification

On New Connection, set:

• Name – a label for the connection
• Source type – HTTP / REST API
• Base URL – the API root, for example https://api.example.com/v1
• Test endpoint – optional path appended to the Base URL for Test connection. Pick an endpoint that needs the stored credential. Leave it empty to test the Base URL itself.
• Authentication – the authentication method, for example Bearer token

When Authentication is Bearer token, enter the token in Bearer token. After you save, the field shows Saved — not shown. Leave it empty to keep the stored token, or enter a new value to replace it.

Choose Save before Test connection. You can test only after the connection is stored.

Field discovery

Field discovery tells the mapping editor how to find the fields of this API:

• None — each stream samples its own endpoint – the connection is the API root. Each stream finds fields by sampling its own endpoint, or when you choose Refresh fields in field mapping.
• To use an API specification, choose the matching format, for example OpenAPI / Swagger (JSON or YAML), WSDL, XSD, OData EDMX, or GraphQL. Then set Provide the spec by, for example URL, enter the spec location, and choose Discover fields.

Save the connection before you discover fields from a specification.

After you save the HTTP connection, configure the request on the stream HTTP endpoint tab. See HTTP endpoint. For a full walkthrough, see Importing Using HTTP.

Celonis

Use Celonis when the source is a Celonis Knowledge Model.

New Celonis connection with key type, API token, and catalog fields that stay disabled until you save credentials

On New Connection, set:

• Name – a label for the connection
• Source type – Celonis
• Celonis team URL – the team URL for your environment, for example https://team.eu-1.celonis.cloud
• Key type – API token or OAuth2 (client credentials)

For API token, enter the token in API token.

For OAuth2 (client credentials), enter:

• Client ID
• Token URL
• Scope
• Client secret

The OAuth client must include the following scopes for catalog access:

integration.data-models:read integration.data-pools:read knowledge-models:query knowledge-models:read studio

Select Save after you provide the connection details. Otherwise, you cannot configure the catalog.

Celonis connection with OAuth2 client credentials, token URL, and required scopes

Catalog

After you save the connection and its credentials, the catalog fields become available. Select the catalog details from top to bottom because each selection makes the next field available. For example, select a Data pool before you can select a Data model.

1. Data pool
2. Data model
3. Studio space
4. Studio package
5. Knowledge model

When the catalog selection is complete, select Save.

Catalog configuration for a Celonis connection, with data pool, data model, Studio space, package, and knowledge model selected

For Celonis Studio and data-pool permissions, see Importing from Celonis.

Managing connections

From the Connections list you can:

• Test connection – verify that the connection still works with the stored credentials.
• Edit – update the name, credentials, or source-specific settings.
• Delete – remove a connection that you no longer need.

Before you delete a connection, check that no streams still use it as their source. Update or remove those streams first.