Academy · Reference
Connector catalog
This reference enumerates every field, kind, and toggle across the Connector surfaces: the Add-Connector wizard, the Add-Job wizard, the Upload modal, the Runs history, the Export dialog, and Input Form templates. The concepts — the Connector vs Job vs Run model and the shape of each screen — are taught in Ingestion & connectors; open this page when you need the full field list.
How to read this
- Fields marked (req) are required to advance. Everything else is optional.
- Test-before-save kinds cannot be saved until a live connection test passes; editing any field after a green test clears it (re-test). This is a platform invariant.
- Routes are project-scoped: real URLs are
/<sub>/<project>/studio/connector/<path>.
Add-Connector wizard
The wizard is 900px. Step count varies: SharePoint = 3 steps (kind → auth pattern → form); every other kind = 2 steps (kind → form; the auth-pattern step is skipped). Edit/Reconnect mode jumps straight to the form step, pre-filled — secrets are never pre-filled — and the stepper is hidden.
Step 1 — kind tiles (six kinds)
| Kind | Tile copy |
|---|---|
| SharePoint | “Pull docs from a SharePoint site” |
| Email (IMAP) | “Pull docs from a mailbox” |
| Botminds Drive | “Pull docs from this project’s internal drive. No setup needed” |
| Public Feed | “Pull from public gov data sources (SEC, CFPB, Federal Register)” |
| Datasheet | “Re-ingest rows from a datasheet in this project as documents” |
| Azure Blob Storage | “Ingest from an Azure Blob container” |
Step 2 — SharePoint auth pattern (SharePoint only)
Two tiles; the rest of the wizard differs per choice:
| Pattern | What it means | Best for |
|---|---|---|
| Quick | “Connect with Microsoft” — the platform handles app registration + consent | SMB / pilots |
| Enterprise | “Use my own Entra app” — you paste your own client ID/secret | Enterprise IT |
Step 3 forms — by kind
SharePoint · Quick
| Field | Notes |
|---|---|
| Display name (req) | |
| SharePoint site URL (req) | On blur, a URL preview chip shows host / site / folder hint |
| Connect with Microsoft button | Opens an OAuth popup. App-only token, Sites.Selected read-only consent. Popup closed → “Sign-in cancelled”; blocked popup → warning. There is no Save button — the connector completes through the popup callback. |
SharePoint · Enterprise
| Field | Notes |
|---|---|
| Display name | Optional — defaults to the site name |
| Site URL (req) | |
| Tenant ID (req) | GUID |
| Client ID (req) | GUID |
| Client secret (req) | Password field |
| Test connection | Enabled only when all four credential fields are present and Tenant/Client look like GUIDs. Returns pass/fail + latency + an amber hint on failure. Editing any field clears a green test. A duplicate site shows an amber banner: Cancel / Create anyway. |
| Save connector | Enabled only after a clean test with no edits since. |
Botminds Drive
| Field | Notes |
|---|---|
| Display name (req) | |
| (info box) | “No credentials — the folder is chosen per-Job.” |
| Test connection | Shows sub-folder count + last-modified date. |
| Save connector |
Public Feed
| Field | Notes |
|---|---|
| (feed registry) | Lazy-loaded; a search box filters; tiles grouped by category. Live tiles are selectable (primary border); coming-soon tiles are greyed/disabled with tooltip “Available in a future release”. Each tile shows icon, name, description, drip description, license + use-case chips. |
| Connector name | Defaults to the feed name |
| Test connection | Shows the feed’s last item date |
| Save connector | Identity is config-only ({feedId}) — no credentials |
Email (IMAP)
| Field | Notes |
|---|---|
| Display name (req) | |
| Email type (req) | Gmail / Outlook / Generic IMAP |
| Host (req) · Port (req) | |
| Username (req) · Password (req) | |
| Test connection → Create connector | Save gated on a clean test. |
Azure Blob Storage
| Field | Notes |
|---|---|
| Display name (req) | |
| Authentication mode (req) | Account key (→ Storage account name + Account key) · SAS token (→ Storage account name + SAS token) · Connection string (→ Connection string). Secret fields are password inputs. |
| Test connection | Pass/fail + latency. Save gated on a clean test; editing any field clears it. |
| (info) | Container, folder path + extensions are configured per-Job, not here. |
Datasheet
| Field | Notes |
|---|---|
| Datasheet (req) | Dropdown of this project’s datasheets. Empty state explains you must create a datasheet first. |
| Display name (req) | |
| (no test) | Internal — identity is {datasheetId} only; no credentials, no connection test. A Job on it re-ingests rows as documents; datasheet edits also auto-trigger re-ingestion. |
Wizard footer
← Back (disabled at step 1 / in edit) · Cancel · Next → / Save / Create (label per kind).
Add-Job wizard
3 steps (editing locks the connector → 2 steps).
Step 1 — pick connector
Radio list of the project’s active connectors: kind icon + test status + “used by N jobs”. Empty → “Cancel and create a Connector first.” Hidden in edit mode.
Step 2 — name + scope + target
- Job name (req) — required to advance.
- Target entity dropdown (req) — real project collections, id-valued (never free text; legacy name values auto-heal; “Default” always present).
- Secondary XFlows — comma-separated; each runs after an item is registered.
Kind-specific scope:
| Kind | Scope fields |
|---|---|
| SharePoint | Document library (name or driveId — Test Drive resolves a name to a stable driveId, with pass/warn + hint) · Folder path (relative to library root; / = whole library) · File extensions (space/comma) · Recursive · Max docs per run · “Pull metadata from SharePoint?” toggle → pick Taxonomy → mapping rows (Taxonomy label ↔ SharePoint column) with Discover columns (lists Display/Internal/Type; click an internal name to copy), Add all, + Add mapping, per-row remove |
| Folder (default INBOX) · Include attachments · Max docs per run | |
| Drive | Folder (read-only + Browse… picker) · Extensions filter (blank = all) · Recursive · “Explode structured rows” (Excel/CSV/JSON → one doc per row) → reveals Unique ID column (row business key; blank = content-hash) · Max docs per run |
| Public Feed | Fields rendered dynamically from the feed’s scopeShape (text / multicheckbox / number) |
| Azure Blob | Container · Folder path (optional blob prefix, e.g. invoices/2026) · Extensions filter (blank = all) · Recursive |
| Datasheet | Document granularity (One document per row / One document for the whole sheet) · Max rows per run (batch cap; continuation drains the rest). New + edited rows are picked up automatically each run. |
Step 3 — schedule
| Option | Detail |
|---|---|
| On-demand only | Runs only via Run now |
| Recurring (every N units) | Value + Seconds / Minutes / Hours / Days |
| Cron expression | m h dom mon dow + Timezone |
| Public-feed presets | Hourly / Every 6h / Daily 9am UTC / Weekly Mon 9am / On-demand chips |
| Next 5 runs | Live preview of the resolved schedule |
Create button: Create job / Save changes (edit).
Upload modal
720px, one-shot — no connector or job:
- Drag-drop or browse (multi-file). List shows each file + size + remove + Clear all.
- Multi-file grouping (when enabled): “grouped into one document set (first file primary)”.
- Target-entity dropdown (unless pre-filled by context).
- Submit → result panel: complete / partial / failed · “N of M registered, K failed” · run id · per-file docId or error rows. Done closes.
Runs and run detail
Runs table columns: When · Trigger (Upload / On-demand / Scheduled) · Status (completed = green / partial = amber / failed = red / else blue) · the funnel counters Enum / Fetch / New / Upd / Dup / Disp / Merge / Fail · chevron.
Run detail dialog (1000px): pipeline-summary chips (Enumerate → Fetch → New → Updated → Duplicate → Dispatch → Merge), status + failed count + last error, then a per-item event-log table (When · Stage · Item · Status · Message).
Export — Add Export dialog
Surface: Studio ▸ Connector ▸ Output (connector/output). List + details split. Empty → “Setup an export to see more details” + + Export. Details rows: Type · Taxonomy (chips) · Storage Type (Azure Blob / Botminds Drive) · Storage Details (Azure: account + container; Drive: drive URL). Row actions: edit / delete.
The Add Export dialog is heavily permission-gated; fields appear conditionally on Export Type.
Always present
| Field | Notes |
|---|---|
| Name | |
| Export Type | Drives the rest of the form |
| External Sources (destination) | 0 = Azure Blob → Storage Name / Key / Container · 1 = Botminds Drive → drive-url |
Conditional on Export Type
| Type | Extra fields |
|---|---|
| Type 0 | Custom Taxonomy multi-select + Custom Template URL (drive-url) |
| Type 2 | Views dropdown |
| Other types | Label selection + selected-label chips |
Type-1 (split / bookmark) toggles
Split Input Document · Split on Sequential Values · Split By Start Page · Grouped Bookmark · First Value As Bookmark · Group By Label · Order Date (dropdown) · Suffix for document name.
Common toggles (across types)
Export current-job docs only (type 2) · Add date-wise folders · Add document-wise folders · Export input document · Delete input document from project.
Save is disabled while the form is invalid.
Input Form — Add Form Template dialog
Surface: Studio ▸ Connector ▸ Input Form (connector/form_template; visible when the form-template surface is enabled for the project). List + details split. Empty → “No Form. Add new form to process” + + Add Form (permission connector/addTemplate).
| Field | Notes |
|---|---|
| Name · Description | |
| Type | Create Source or Publish Template |
Publish Template
| Field | Notes |
|---|---|
| Sub Type | Connector → pick an ingestion seed-page dropdown · Global Variables → multi-select variables |
Create Source — Columns builder
A Use Excel checkbox swaps the per-column rows for a single drive-url (ExcelDriveUrl). Otherwise, each column row:
| Field | Notes |
|---|---|
| Name | |
| Type | Text / Multiline / Checkbox / Dropdown / Radio |
| Label | Taxonomy-grouped optgroups |
| Value | Dropdown type only |
| Required · Is Title · Is Template | Flags |
| + rule | Nested Rules rows: Field + Value (add/remove) |
| add / remove column |
If a column is Is Template, a Templates section appears: Value + Export Template + Rendering Template (both drive-urls).
Submit: Create / Update.
Legacy ingestion (deep-link only)
Status. Route
connector/sourcesis no longer wired to the Ingestion rail entry — that always opens Sources v3; this route is deep-link only. It is the old single create-source wizard plus a source-details page. Theaddroute is guarded: if the project hasHideAddDataSource, it navigates back. New builds use v3.
Prefer learning inside the product? The same academy lives in the platform's Learn menu — every screen links to the chapter that explains it.
See the platform live