Documentation Index

Fetch the complete documentation index at: https://docs.aifabrix.ai/llms.txt

Use this file to discover all available pages before exploring further.

UI terminology map

Prev Next

Author-facing map between public doc bands, dataplane UI labels, and Builder manifest section keys.

Use with Build reference — help topics and Edit Connected Systems with Builder API.

When you open a Connected System or Business Entity in the dataplane UI, each tab corresponds to a manifest section key used by Builder repair, validate, and Builder MCP help topics. This page is the Rosetta stone — not a duplicate of every configure guide.

Prerequisites

Where it lives

Layer What you see
Dataplane UI tabs Connected Systems and Business Entity detail views
Manifest section keys Builder registry keys (system.authentication, datasource.fieldMappings, …)
Configure doc pages Track B how-to articles linked from each row below
Builder help topics connectedSystemUi, goldenExamples, section — fetched via Builder API

The registry SSOT is Builder manifest-section-registry-data.js. Golden example fixtures illustrate full snapshots — fetch via help topic goldenExample rather than copying stale JSON into tickets.

How to set

Use this map when configuring — not as a standalone install step.

  1. Identify your target — Connected System (systemKey) or Business Entity (datasourceKey) in the portal.
  2. Open the matching UI tab — use the tables below to find the configure doc and manifest section key for that tab.
  3. Edit local manifests — change <systemKey>-system.json or <datasourceKey>.json (or Builder MCP equivalents) for the section you need.
  4. Repair drift — when tab labels and JSON disagree after manual edits:
aifabrix repair <systemKey> --expose --rbac
aifabrix validate <systemKey>
  1. Upload and verify in UI — confirm the tab reflects your changes; re-run repair if validate reports section gaps.

For automation handoffs (Builder MCP, golden examples), request help topic connectedSystemUi to list live tab aliases for your CLI version.

Connected System (manifest target: system)

UI tab Doc configure page Manifest section key
Overview Basics and kind system.basics, system.kind
Business Entities Business Entities list system.businessEntities
Authentication Configure authentication system.authentication
Configuration Configure system configuration system.configuration
Roles & permissions Configure roles and permissions system.rolesPermissions
Subscriptions Configure subscriptions system.subscriptions
AI Interfaces Configure AI interfaces system.aiInterfaces
Lifecycle Lifecycle, download, repair system.lifecycle

Business Entity (manifest target: datasource)

UI tab Doc configure page Manifest section key
Overview / Technical readiness Entity basics datasource.basics, datasource.entityType, datasource.resourceType
Business Vocabulary Configure business vocabulary datasource.fieldMappings
Metadata / identity Configure metadata and identity datasource.metadata, datasource.identity
Data Flow Configure data flow · CIP step catalog datasource.execution
AI Contract Configure AI contract datasource.capabilities, datasource.exposedAttributes
Operations Configure OpenAPI and MCP operations datasource.openapiOperations, datasource.mcpOperations
Configuration Configure entity configuration datasource.configuration
Sync Configure sync datasource.sync
Business Policies Configure business policies datasource.dimensions, datasource.abac, datasource.foreignKeys, datasource.protection
Quality Configure data quality datasource.dataQuality
Validation / test Configure validation and test payload datasource.validation, datasource.testPayload

Product modules outside manifest sections

UI module Route Doc
Content Review /content-review Configure Content Review
Enterprise MCP (runtime) Published after upload Configure Enterprise MCP

Defaults and examples

Illustrative UI label → manifest section key excerpt (Connected System tabs — not a full manifest):

connectedSystemUi:
  target: system
  tabs:
    - uiLabel: Overview
      sectionKeys: [system.basics, system.kind]
    - uiLabel: Authentication
      sectionKeys: [system.authentication]
    - uiLabel: Roles & permissions
      sectionKeys: [system.rolesPermissions]
    - uiLabel: AI Interfaces
      sectionKeys: [system.aiInterfaces]

Business Entity tab mapping follows the same pattern with target: datasource. Repair and validate use sectionKeys to know which JSON bands to check — when a tab looks empty, confirm the matching key exists in your local file before blaming UI cache.

JSON fragment — registry-style row integrators grep for in help output:

{
  "sectionKey": "datasource.capabilities",
  "uiTab": "AI Contract",
  "configureDoc": "build-ai-ready-systems-business-entities-configure-ai-contract",
  "repairFlags": ["--expose"]
}

Golden examples (Builder help SSOT)

Use Builder API help topic goldenExamples to list fixtures and goldenExample with key for the full manifest snapshot. Do not copy JSON into public docs — the authoritative files live in Builder golden-example fixtures.

Help key Title Typical resource type Use when configuring
crm-company CRM company record crm Metadata, field mappings, OpenAPI/MCP exposure
crm-deal CRM deal pipeline crm Pipeline entities, FK to company
document-storage Document storage entity document Document storage Business Entity guides
meeting-transcript Meeting transcript capture transcript Transcript / content capture patterns
repository-template Repository template workspace repository Template workspace entities
service-ticket Service ticket entity ticket Ticket / case management patterns

When a configure page cites goldenExample, match the row above to the entity type you are building. Drift between this table and live Builder fixtures is a builder release gate — re-run goldenExamples after Builder publishes help changes.

Validate

aifabrix validate <systemKey>
aifabrix repair <systemKey> --dry-run

Compare validate section warnings to the manifest keys in the tables above. If validate cites a missing section, open the linked configure doc — not an unrelated tab.

Common mistakes

Mistake Fix
Editing UI-only fields expecting persistence Change manifest JSON; upload
Wrong tab for capability exposure Use AI Contract → datasource.capabilities
Confusing system OpenAPI with entity contract Entity operations tab + externalSpec
Stale golden example copy in tickets Fetch live goldenExample via Builder API

Limits

Tab query aliases and optional modules (for example policy management) vary by tenant configuration. Confirm live UI with help topic connectedSystemUi when automating handoff.