Skip to content

Quickstarts

The test-estate safety rule: stand the test estate up only beside a test instance, never a production deployment. Its systems are throwaway test services with published credentials: change-me is every test credential. They are still encrypted and still ask for a login, because FACE refuses a connection that is not (see Connector security). Use a scratch machine or a scratch cluster.

FACE by Runink (Fulfilment Autonomous Claims Engine) connects to the systems a logistics team already runs. These quickstarts give 32 of the catalogue’s 36 connection types the quickstart estate, a real dataset you can download, load and fetch: one company, Quillmere Freight Lines, written out in each system’s native shape, with the model FACE should find in it. The other four types have no quickstart dataset: bimcad (BIM / CAD site-plan drawings under a bucket or SharePoint folder, read through the files connector), flipper (see Flipper edge reader), pineapple (a WiFi Pineapple agent, with the same https rule as Flipper) and webpage (see Web and crawler).

Start with See all connectors at once: it is the walkthrough across every source, and it shows where the evidence for each of the six planted anomalies lives.

What every quickstart page gives you

  • what the connection is, and its grade;
  • the setting and credential names from the catalogue, and the test connection’s values;
  • how to stand the test system up;
  • what FACE finds: the datasets, keys and row counts of the expected model;
  • how the source joins the shared Quillmere universe, and which planted anomalies it holds evidence for;
  • a download. Streams link to their replay recordings, never to a file bundle.

Where a quickstart connection goes in FACE

  1. Add it in Settings › Integrations › Systems: select New connection, pick the source, fill in the settings and credentials, choose the runner, then Test & save.
  2. Use it on Ask. Every connection shows as a card among Ask’s sources, marked Included in fetch or Not included. An admin can switch a connection Active or Inactive; an inactive one is not read.
  3. Use it in a brief. In the brief’s editor on Briefs, tick the connections it reads. With all ticked, it reads every connection, including ones added later. A brief that reads nothing cannot be saved.
  4. Watch a live source. A camera opens Surveillance; an MQTT, IoT, sensor-gateway, GPS or RFID connection opens Live sensors and Devices; a field reader opens Field reader and Devices. Each opens from that connection’s card on Ask, already narrowed to it.

Connector security

FACE refuses a connection that would send data, or the login that reads it, unencrypted. It refuses it when you save it, and it refuses again on every read of a stored connection that does not meet the rule. The error names each setting to fix and says to open the connection in Settings › Integrations and upgrade its security. The rule holds for the test estate too, so every test connection on these pages is the secured form.

For every type:

  • insecure_skip_verify must be off: the server’s certificate is always checked.
  • No address may use a cleartext scheme: http, ws, tcp, mqtt, rtsp, ftp, amqp or plaintext. Use https, wss, tls, mqtts, rtsps, ftps or amqps.
  • ssl_mode may not be disable, allow or prefer, and a Kafka security_protocol may not be plaintext or sasl_plaintext.

What each type needs on top of that:

TypeNeeds
Kafkasecurity_protocol sasl_ssl; sasl_mechanism scram-sha-512 or scram-sha-256; a username and the password credential. A Schema Registry, when named, is https:// with its own schema_registry_username and schema_registry_password. ssl_ca_pem is optional.
PostgreSQL, Redshift, MySQLssl_mode stated as require, verify-ca or verify-full (unset is refused); a username and the password credential.
MQTT, IoTA tls://, ssl://, mqtts:// or wss:// broker, use_tls on, a username and the password credential.
RFIDLLRP over TLS (use_tls on, or llrps). A reader read over HTTP must use https://.
GPSAn https:// endpoint. Provider nmea is a raw TCP stream with no encryption and is refused.
Sensor gatewayModbus/TCP over TLS (use_tls on, port 802), or an https:// endpoint.
Object store, filesAn https:// endpoint, or use_tls on for a bare S3 host.
CCTVAn rtsps:// or https:// feed. rtsp:// and http:// are refused.
Logistics systems, SAP, Guidewire, field readershttps:// addresses. A bare host is refused, because FACE would dial it unencrypted.
Salesforce, ServiceNow, Dynamics 365, SharePoint, web pageshttps:// addresses. A bare host is read as https.
BigQuery, Snowflake, Databricks, HubSpot, GitHubNothing more: their APIs are https by construction.
Excel, DocumentNothing more: nothing is dialled. An Excel file_path that is a URL must be https://.

A type FACE has no security rule for cannot be used.

Grades

Grade each type honestly before you pick one to try.

GradeMeaning
AOpen source. It stands up locally from the download, with the model and its rows, end to end.
BThe download holds the model. The platform itself needs a vendor account or trial.
CModel only. There is no freely available local edition of the platform.
DDataset and model: the quickstart dataset and its expected model ship. There is no vendor system to stand up for this type; load the dataset and fetch it.

Every one of the 32 has a quickstart dataset and an expected model, whatever its grade.

ConnectionGroupGradeDatasetDownload
postgresDatabases & warehousesAsqlpostgres.zip
mysqlDatabases & warehousesAsqlmysql.zip
snowflakeDatabases & warehousesBsqlsnowflake.zip
databricksDatabases & warehousesBsqldatabricks.zip
redshiftDatabases & warehousesDsqlredshift.zip
bigqueryDatabases & warehousesDsqlbigquery.zip
salesforceBusiness appsBapisalesforce.zip
sapBusiness appsCapisap.zip
guidewireBusiness appsCapiguidewire.zip
servicenowBusiness appsDapiservicenow.zip
hubspotBusiness appsDapihubspot.zip
d365Business appsDapid365.zip
sharepointBusiness appsDapisharepoint.zip
githubBusiness appsDapigithub.zip
omsLogistics systemsDapioms.zip
tmsLogistics systemsDapitms.zip
whsLogistics systemsDapiwhs.zip
ymsLogistics systemsDapiyms.zip
imsLogistics systemsDapiims.zip
inventoryLogistics systemsDapiinventory.zip
logisticsapiLogistics systemsDapilogisticsapi.zip
filesFilesDfilesfiles.zip
excelFilesDfilesexcel.zip
documentFilesDfilesdocument.zip
objectstoreFilesDfilesobjectstore.zip
kafkaStreamsAstreamreplay recording
kafka, live estateStreamsAlive producerthe compose file on the page
mqttStreamsDstreamreplay recording
iotStreamsDstreamreplay recording
rfidStreamsDstreamreplay recording
gpsStreamsDstreamreplay recording
sensorgatewayStreamsDstreamreplay recording
cctvStreamsDstreamreplay recording

Groups

Downloads

There are 25 zips for 32 connection types, and none is missing. The 7 streaming connectors (cctv, gps, iot, kafka, mqtt, rfid and sensorgateway) are dialled and held open, so they ship as replayable stream recordings under streams/<type>/, not as zips. The other 25 types each have one zip.

The downloads live at https://docs.runink.org/downloads/connections/, keyed by connection type, so every Runink product’s docs link to the same files. Every download is generated at publish time, from a fixed seed, and scanned before it is published: hosts end in .invalid, addresses are in the documentation ranges, and the only credential value is change-me.

  • universe.json: the reconciliation graph. Every shared entity, every link between sources, and the six planted anomalies with their evidence.
  • manifest.json: every download with its size and SHA-256.
  • SHA256SUMS: the same list, for sha256sum -c.

What these quickstarts are not

  • Not product data. Nothing in the downloads is read by the FACE backend at runtime, and the product image carries none of it.
  • Not a deployment. The test estate is made of throwaway test services whose credentials are published. Keep it on a scratch machine.
  • Not a measurement of every connector. A test compares FACE’s discovery with the expected model for PostgreSQL and MySQL. For every other type, the expected model is the shape the source holds, and each page says what FACE reads for that type.