Reference checklists, schema indexes, and Builder help topics for integrators and agents finishing the build path.
In this section
- UI terminology map — UI tabs ↔ manifest section keys ↔ configure pages
- Minimum viable external system checklist — phased checklist for one recordStorage integration
Use with Quickstart and the build phase guides when you need a compact index of mandatory manifest fields and CLI gates.
CLI vs Builder API
| Need | Prefer |
|---|---|
| Local file edits, repair hooks, upload, certification | Builder CLI (aifabrix validate, repair, upload, verify-*) |
| Agent-driven section reads, dependency graph, golden examples | Builder API help topics (read-only envelopes) |
| Post-upload secrets and tenant-specific values | Dataplane UI (Connected Systems → Authentication, Configuration) |
Agents should follow the normative loop on Build with Builder MCP: read section → patch with intent → repair → validate → test → upload (separate step).
Builder help topic registry
These topic keys are served by Builder API help (plan 154.5). Use them instead of memorizing manifest paths or duplicating CLI ladders in agent prompts.
| Topic key | Use when |
|---|---|
overview |
Orientation to manifest editing and help layout |
workflow |
Normative read → patch → repair → validate loop |
sections |
List all manifest section keys |
section |
Read one section definition + schema fragment (requires sectionKey) |
dependencyGraph |
Downstream sections affected by a patch |
repairRules |
Named repair hooks and when to invoke them |
schemaCatalog |
Schema version and fragment index |
subscriptionGuide |
system.subscriptions patterns |
cipOverview |
CIP execution structure on Business Entities |
goldenExamples |
List golden example fixtures |
goldenExample |
One fixture by key (e.g. CRM company, document storage) — see golden examples index |
evidencePatterns |
Certification evidence pattern index |
evidencePattern |
One evidence pattern by key |
connectedSystemUi |
Dataplane UI tab URLs and post-upload auth handoff |
Manifest section keys (154.4 registry)
Connected System sections include system.basics, system.kind, system.authentication, system.configuration, system.rolesPermissions, system.subscriptions, system.aiInterfaces, and system.lifecycle.
Business Entity sections include datasource.basics, datasource.entityType, datasource.resourceType, datasource.metadata, datasource.fieldMappings, datasource.capabilities, datasource.execution, datasource.exposedAttributes, datasource.sync, datasource.foreignKeys, datasource.protection, datasource.dimensions, and datasource.testPayload.
Public configure articles map section keys to UI tabs — see Connected Systems and Business Entities.
Related CLI entry points
| Task | Command |
|---|---|
| Schema validation | aifabrix validate <systemKey> |
| Derived section repair | aifabrix repair <systemKey> [--expose] [--rbac] [--sync] |
| Integration test | aifabrix test-integration <systemKey> |
| E2E with testPayload | aifabrix datasource test-e2e <datasourceKey> --app <systemKey> |
| Certification ladder | aifabrix verify-operations, verify-trust, verify-governance |
Full CLI index: CLI reference.