Configure sync

Configure pull and ingestion behavior so Business Entity records or documents normalize into Enterprise Knowledge on a schedule or on demand.

Prerequisites

Connected System authentication configured and upload-ready
Configure metadata and identity on the entity
Configure business vocabulary for field projections

Where it lives

Layer	Location
Sync band	`<datasourceKey>.json` → `sync`
Document ingestion	`documentStorage` + `sync` together for `entityType: documentStorage`
UI	Business Entity Sync tab (`?tab=sync`)

Manifest section: datasource.sync.

Builder MCP


Manifest section	`datasource.sync`
UI tab	Sync (`?tab=sync`)
Help topics	`section`, `dependencyGraph`, `repairRules`
Repair hooks	`sync`

After sync edits, run aifabrix repair <systemKey> --sync when the dependency graph lists downstream sections. Validate before upload.

How to set

Enable sync with mode appropriate to the entity type:

{
  "sync": {
    "enabled": true,
    "mode": "incremental",
    "operations": {
      "pull": {
        "enabled": true,
        "operationId": "listRecords"
      }
    }
  }
}

Document storage — use document-specific pull/download operations; see Build a document storage entity.
Record storage — align pull operation with OpenAPI list/get bindings.
Repair and validate:

aifabrix repair <systemKey> --sync
aifabrix validate <systemKey>

Validate

Integration proof: CLI workflow — test-integration exercises sync against live credentials.

Enterprise sync bridge

Inbound sync (above) loads records into Enterprise Knowledge for one datasource. Sync bridge propagates normalized changes across datasources that share a resourceType — without point-to-point target lists.

Concern	Where to read
Business model	Enterprise Synchronization Fabrix
Manifest fields, CIP prerequisites, activation steps	Enterprise sync bridge — technical guide

Sync bridge requires CIP get, update, and when needed create, syncBridge on the datasource root, and optional webhook for change signals — configure on the manifest and publish via Builder CLI.

Common mistakes

Mistake	Fix
Sync enabled without CIP/list operation	Configure data flow
Record sync pattern on document entity	Use document ingestion band
Skipping repair after sync edits	`repair --sync`

Documentation Index