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.

Configure sync bridge

Prev Next

Set root syncBridge so a Business Entity participates in Enterprise Synchronization Fabrix — cross-datasource propagation by shared resourceType, not point-to-point target lists.

Do not confuse this with sync.mode (pull / push / bidirectional), which only sets direction with the Connected System. See Configure sync.

Sync bridge reuses the same CIP get, update, and create capabilities you certify for Role Assistants — it does not add a second sync engine or a peer-target list on the manifest.

Prerequisites

  • entityType: recordStorage with resourceType, primaryKey, labelKey, indexed externalId
  • Configure data flow — CIP get required; update (and create when needed) for writable participation
  • Connected System auth slot usage: syncExecution (or a service-capable api slot where policy allows)
  • Optional lower latency: Configure webhook change signals

Where it lives

Layer Location
Sync bridge mode <datasourceKey>.json → root syncBridge
Direction with vendor Same file → sync.mode (separate concern)
Sync worker auth <systemKey>-system.jsonauthentications[] usage: syncExecution
UI Business Entity Sync tab — sync bridge mode

Builder MCP

Manifest keys Root syncBridge; section help for sync / entity basics
Repair hooks aifabrix repair <systemKey> --auth-sync ensures a syncExecution slot; always validate

How to set

  1. Prove CIP prerequisitesget (+ update/create as mode requires) validate green on Configure data flow.
  2. Add sync-capable auth for background workers (not end-user OAuth alone):
aifabrix repair <systemKey> --auth-sync
aifabrix validate <systemKey>
  1. Set participation mode on the datasource root:
{
  "syncBridge": "master"
}

Allowed values: disabled (default), master, bidirectional.

  1. Publish other datasources that share the same resourceType with syncBridge other than disabled — the platform discovers participants; you do not list target keys.
  2. Optional: enable webhook for push triggers — still CIP get for data (Configure webhook change signals).
  3. Validate and upload:
aifabrix validate <systemKey>
aifabrix upload <systemKey>

After upload, confirm online drift with aifabrix show <systemKey> --online when diagnosing participant mismatches.

Defaults and examples

Value Meaning
disabled Default — no enterprise propagation
master Sync-bridge write role for this datasource’s resourceType (not COM root authority)
bidirectional Publish and receive enterprise changes for this resourceType

Preferred write and list ownership across Connected Systems is not sync bridge — see Write and list authority across systems. Configure the flag: Configure write and list authority.

Master + webhook trigger (illustrative fragments together):

{
  "syncBridge": "master",
  "webhook": {
    "enabled": true,
    "endpointMode": "datasource",
    "events": ["record.updated"],
    "idPath": "$.objectId",
    "eventTypePath": "$.subscriptionType",
    "vendorDeliveryIdPath": "$.deliveryId"
  }
}

Prefer one master per resourceType unless enterprise policy explicitly allows multiple authorities.

Validate

aifabrix validate <systemKey>
aifabrix test-integration <systemKey>
aifabrix datasource test-e2e <datasourceKey> --app <systemKey>

Validation fails fast when sync bridge is enabled without recordStorage identity, CIP get, or sync-capable auth. Deep prerequisites: Enterprise sync bridge — technical guide.

Common mistakes

Mistake Fix
Confusing sync.mode with syncBridge Mode = vendor direction; syncBridge = enterprise participation
Listing peer datasource keys Participation is by resourceType only
Master without update Add CIP update for writable authority
Webhook without get Always configure CIP get
User OAuth for sync workers Use syncExecution service credentials

Limits

This page is the Track B How to set for syncBridge. Architecture, propagation rules, conflict policy, and UI surfaces are in the technical guide and Synchronization Fabrix concept page. Inbound bulk sync jobs remain on Configure sync. Sync bridge does not replace certification — re-run trust and operations proof after vendor API or mapping changes.