Human integrators and AI agents follow the same manifest development loop when editing Connected Systems and Business Entities through Builder API or CLI.
Why it matters
Agents must not patch manifests blindly. The governed loop — read, resolve missing inputs, patch with intent, repair derived sections, validate, test — matches what experienced integrators already do locally with repair and validate.
Prerequisites
- Builder CLI or Builder API access with authentication
- Local workspace under
integration/<systemKey>/or online manifest via Builder API
Normative loop
- Read a governed manifest section before any write (section read token when using Builder API).
- Ask when required inputs are missing — do not invent primary keys, entity types, or similar values.
- Patch with intent — every write records why the change was made.
- Repair explicitly — pass named repair hooks after patches that affect derived sections.
- Validate and test — schema and integration tests before upload.
- Upload separately — upload and certification are not automatic side effects of patch.
Typical sequence
Start with Business Entity metadata for a new entity. Patch with intent describing the vendor payload mapping. Repair fieldMappings, expose, and rbac hooks. Patch openapiOperations when adding write capabilities. Repair again, validate, then test. Upload when ready.
Post-upload authentication (enterprise handoff)
Validate, test, test-integration, and upload must not depend on resolved integration secrets in Builder API scope. Upload publishes configuration including non-secret authentication variables. The user adds live secrets in the dataplane Connected Systems → Authentication UI afterward.
After upload succeeds:
- Read
authentication.authTypeand credential method from the published system manifest. - Confirm non-secret variables (baseUrl, headerName, tokenUrl, and similar) were set — they pre-fill in the UI.
- Ask the user for their dataplane public UI base (origin including
/data). - Direct the user to add only required secrets in Authentication — not vendor tokens in Builder API or workspace env files when UI authentication is the intended path.
- Re-run E2E or live verification after secrets are saved.
Builder help topics (reference)
See the full topic registry and manifest section keys on Build reference.