Skip to content
Documentation
Using the cockpit
Connections

Connections and data sources

FACE reads your data only through the connections you configure. This page covers the cockpit side. For each connector’s settings, see Data sources.

Connections & Runners

To open Connections & Runners (/connections), go to Fetch and select the ACTIVE CONNECTIONS heading. The page has three tabs:

  • Active Connections: the connections themselves.
  • The estate map.
  • Compute Runners: the runners that execute reads.

Other source types, in the title bar, opens FACE’s own connect wizard. Use it for video streams, documents and web pages.

The connection list

Each row shows:

  • the connection’s name, type and id;
  • where it runs: Runink managed or runs on {runner};
  • a credential chip: credential stored, no credential needed, no credential, credential unreadable or credential state not reported;
  • the result of the last test, if there was one.

A stored credential is never shown. Its chip only says that a credential is held. It doesn’t say that the source will accept it.

The row buttons are:

  • Edit
  • Rotate credentials
  • Test
  • Listener
  • Delete

Test asks first. It opens a connection with the stored credential on the connection’s runner. The test is read-only and time-limited, nothing is read from the source, and the attempt is audited. Delete also asks first, because it deletes the credential bundle as well, and a deleted bundle cannot be recovered. If other connections share the bundle, the confirmation names them.

You seeMeaning
The connections were not readThe request failed. This is not an empty list.
The connection registry could not be readThe server answered but could not read its registry.
No connections yetThe registry was read and holds no connections. Use New connection to add the first one.
Tested: the source answered…The source is reachable. It does not mean data has been read.
Nothing was tested: this connector has no reachability check.Reachability is unknown, not confirmed.

Add a connection from this page

New connection opens a three-step wizard: Source, Runner, Review.

  1. Pick a source card from the server’s catalog and fill in its fields.
  2. Choose the runner.
  3. Review, then select Test & save, or Save if you turned off Test after saving.

For database sources, you also choose the encryption in transit. The strictest option is Encrypt, verify the chain and the hostname. Use it unless the source cannot support it.

Connect a data source

CONNECT DATA SOURCE (/connect_data_source) is FACE’s own three-step wizard. To open it, select New connection on Fetch, or Other source types on Connections. When you return to Fetch, the new source is already selected.

### Step 1/3: pick the source and enter its details Select a source card. Each card is announced as **Select {name} source**. The cards are: - Databases and warehouses: Snowflake, Databricks, PostgreSQL, MySQL, BigQuery. - Files and object storage: Excel, Object Store. - Business applications: Salesforce, SAP, ServiceNow, Guidewire, Hubspot. - Documents, video and the web: PDF, Google Docs, Video Stream, Webpage. - Logistics systems: Inventory, OMS, TMS, IMS, YMS, ERP, CRM, WHS. - Devices and telemetry: MQTT Bus, RFID Reader, GPS Telematics, Sensor Gateway. The form below the cards depends on the source. Many sources use the general fields: **CONNECTION NAME**, **USER**, **PASSWORD** and **HOST / ENDPOINT**. PostgreSQL and MySQL add **DATABASE** and **ENCRYPTION IN TRANSIT**. Snowflake and Databricks can also take a whole connection string: turn on **PASTE A CONNECTION STRING** and paste it into **CONNECTION STRING**. The string is write-only. ### Step 2/3: choose the compute runner Under **TARGET COMPUTE RUNNER**, choose between two options: - **Runink Managed** is the recommended default. Runink runs the reads on the platform's own fetch runner, which is reached over mutual TLS, and the credential is sealed to it for each fetch. - **Self-Hosted Runner** means your own Kubernetes cluster or VM, which needs manual setup. Select **NEXT STEP →**. **← Back to Credentials** returns you to step 1. ### Step 3/3: review and save Check the summary, which is marked **Read-only Access**. A pasted connection string shows as held, not shown. Then select **Save & Finalize →**.

After you save, the cockpit creates the connection and tests it:

You seeMeaning
Connection SuccessfulThe source answered and accepted the credentials. It does not mean data has been read.
Configuration savedThe connection is saved, but no live check exists for this source type, so nothing here says the source is reachable.
The connection was NOT saved: {reason}Nothing was stored.
Connection test failed: {message}The connection was saved, and the test failed.

On success the wizard closes by itself.

Web scraper

Add Web Scraper, beside ACTIVE CONNECTIONS on Fetch, opens Web Scraper Setup (/crawler_connection). Enter a Target URL and select Test Scrape to see the first part of the page’s content as FACE’s crawler reads it. The page has no bottom navigation. Use the back button to leave it.

RPCs behind these pages

  • runink.ui.datasources.v1.ConnectionsService: ListConnectionTypes, ListConnections, CreateConnection, UpdateConnection, RotateCredentials, DeleteConnection, TestConnection.
  • ListenersService and RunnersService.
  • semantics.v1.ConfigService.CreateConnection and TestConnection, for the FACE wizard.
  • CrawlerService.Scrape.

See the API reference.

OrchestratorProfile and billing