Connections
A connector configured against a real system. Credentials are encrypted on the way in and never come back out — only the last four characters are ever shown.
Where to find it
- Module: Platform
- Group: Connectivity
- Section: Integration
- Screen: Connections
Address in the console: /platform/connections
List · 10 columns · 8 fields on its form · 3 of them required · 2 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Connection | Code | code |
| Name | Text | name |
| Connector | Text | connector_name |
| Category | Status | category |
| Environment | Status | environment |
| Endpoint | Text | base_url |
| Secret | Code | secret_last4 |
| Status | Status | status |
| Tested | Date and time | last_tested_at |
| Health | Status | health |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Connection code required | Text | ||
| Name required | Text | ||
| Connector required | Choice | Looked up from existing records | |
| Environment | Choice | Configuration list | |
| Endpoint URL | Text | A production endpoint must use HTTPS. | |
| Username | Text | Basic authentication only. | |
| Configuration | Text | ||
| Owner | Choice | Looked up from existing records |
What you can do here
Test primary
Test this connection
Set credential
Store the credential
Asks for: API key / password / token*
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.