> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/...with-kafka/establish-a-new-connection.md).

# Establish a new connection

## Overview

<figure><img src="https://2013058394-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOqGnkz52o2zVUsEGEZGk%2Fuploads%2F7BUeBg8zuKM8Mw6wttLG%2FGroup%20573.png?alt=media&amp;token=02a5f6ae-ad73-4b38-9306-2f3d25d6c827" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2013058394-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOqGnkz52o2zVUsEGEZGk%2Fuploads%2FM5ql0zmfcGjcpYzcGgwi%2FGroup%20574.png?alt=media&amp;token=0c9f291d-6fde-4a78-ba3b-725f2f0b6b7e" alt=""><figcaption></figcaption></figure>

<table data-full-width="true"><thead><tr><th width="57.600006103515625">Symbol</th><th width="234.199951171875">Description</th><th>Details</th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Menu "Connections"</td><td>Click to open the "Connections" menu</td></tr><tr><td><strong>[B]</strong></td><td>Tab</td><td>Access to the respective interfaces</td></tr><tr><td><strong>[C]</strong></td><td>Workspace</td><td>Shows a list of the existing connections (if any)</td></tr><tr><td><strong>[D]</strong></td><td>Connections</td><td>Existing connections</td></tr><tr><td><strong>[E]</strong></td><td>Pause/resume connection</td><td>Click to pause or resume a connection</td></tr><tr><td><strong>[F]</strong></td><td>Status of the connection</td><td>Shows the current status of the connection</td></tr><tr><td><strong>[G]</strong></td><td>Name</td><td>Name of the connection</td></tr><tr><td><strong>[H]</strong></td><td>Client ID</td><td>Shows the client ID</td></tr><tr><td><strong>[I]</strong></td><td>Consumer Group</td><td>Shows the consumer group</td></tr><tr><td><strong>[J]</strong></td><td>Seeds</td><td>Shows the seed</td></tr><tr><td><strong>[K]</strong></td><td>Create new connection</td><td>Click to create a new connection</td></tr><tr><td><strong>[L]</strong></td><td>Delete connection</td><td>Deletes the respective connection. ⚠ Caution: If the connection is also used in other tenants, it will also be deleted there.</td></tr><tr><td><strong>[M]</strong></td><td>Connection details</td><td>Click to open the details of the connection</td></tr></tbody></table>

## Create a new connection

Proceed as follows to establish a new connection to a broker or to edit an already existing connection.

1. In the sidebar, click on **Connection \[A]**\
   ▷ The "Connections" window opens
2. Select the **Kafka \[B]** tab
3. In the workspace, a list of all already existing connections is displayed **\[C]**\
   ◈ If you do not see any entries, no connections have been created yet\
   ◈ Connections that have been created in other tenants are also displayed
4. Click on **\[K]** to establish a new connection\
   ▷ The [↗ "Connection Details"](/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-opc-ua/connection-details.md) open

## Edit connection

1. In the sidebar, click on **Connection \[A]**\
   ▷ The "Connections" window opens
2. Select the **MQTT \[B]** tab
3. In the workspace, a list of all already connected brokers is displayed **\[C]**\
   ◈ Connections that have been configured in other tenants are also displayed
4. Click on **\[M]** to open an existing connection\
   ▷ The [↗ "Connection Details"](/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/connect-devices-via-mqtt/configure-client.md) open


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/mandatory-base/platform-core/connect-hub/connectivity-as-a-service/...with-kafka/establish-a-new-connection.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
