The Portal is the web application where you set up and monitor your connections. Use it to create a connection, define the pipeline rules that filter or rewrite each message, upload the artifacts a connection depends on, and take operator actions (enable, disable, reset a session) against a live connection. Everything you configure and everything you observe happens here.
You sign in through your organization's identity provider. See Authentication & Access for how sign-in works.
This guide is organized by what you are trying to do, not by what the screen is called. Pick the section that matches your goal; each page stands on its own.
Why use the Portal
| You need to | The Portal gives you |
|---|
| Define what a connection does without shipping code | A schema-driven wizard and Pipeline Designer that accept plain field names for filters and transforms. |
| Run the same connection with automatic failover | Two deployment modes (Single Writer and Scale Out) selected at creation time. |
| Know whether a connection is actually working | A live status for every adapter and a per-connection event log, with a volume-over-time view that makes a burst of errors or a drop in activity easy to spot. |
| Change a setting on a running connection | In-place edit with a clean session restart so the external system sees a proper disconnect, not a dropped link. |
| Take an operator action (enable, disable, pause, resume) | One-click controls on the adapter's page with the action recorded in the event log. |
| Understand what happened to a specific message | A pipeline model that explains when a message is filtered, transformed, delivered, or retried. |
Routing by goal
Find the row that matches what you are trying to do and go directly to the page that covers it. If you are new to the platform, read the Core Concepts pages first; every other section assumes the vocabulary they define.
| Goal | Go to |
|---|
| Understand what an adapter is, what each status means, and how redundancy works | Adapters Overview |
| Understand what happens to a message as it flows through a pipeline, including failure behavior | What Happens to Messages |
| Look up a term used anywhere in the product | Glossary |
I am building a connection (Day 1)
I am running connections in production (Day 2)
| Goal | Go to |
|---|
| Control who can sign in to the Portal, managed at your identity provider | Authentication & Access |
| Check which connector types and pipeline components are installed | Plugins |
I have a specific question
| Goal | Go to |
|---|
| Answer a common "why is my adapter doing X" question without reading a full page | FAQ |
| Find the meaning of a specific term or acronym | Glossary |
Where the Portal stops
The Portal is the interface for everything that defines a running connection and everything an operator does to one. It does not replace infrastructure:
- Certificates, private keys, and TLS termination are handled at the network edge by your infrastructure team, not in the Portal. See Security.
- Cluster-wide concerns (deploying the platform, sizing infrastructure, configuring the identity provider, CI/CD) live in the Operations section.
- Custom protocols or custom processing logic beyond what installed plugins provide are built by developers with the Plugin SDK, then loaded into the platform and exposed to the Portal as new connector types or pipeline components.