Entity basics, types, and resource type

Set entityType and root resourceType on each Business Entity manifest so sync, storage, RBAC, and AI exposure follow the correct contract.

Prerequisites

Connected System type chosen (Basics and kind)
One JSON file per Business Entity under integration/<systemKey>/

Where it lives

<datasourceKey>.json → top-level entityType, resourceType, key, displayName, systemKey.

Manifest sections: datasource.basics, datasource.entityType, datasource.resourceType.

Builder MCP


Manifest sections	`datasource.basics`, `datasource.entityType`, `datasource.resourceType`
UI tab	Overview / Technical readiness
Help topics	`section`, `goldenExamples`, `goldenExample`
Repair hooks	`fieldMappings`, metadata schema alignment

Entity type recipes: Business Entities guides.

How to set

Entity type

Classify each Business Entity — what it primarily stores or represents.
Set entityType per schema enum:

entityType	Use when	Enterprise Knowledge role
recordStorage	CRM-style entities (customers, deals, cases)	Structured records with metadata
documentStorage	Files with metadata, no vector index	Document catalog and search
vectorStore	Embeddings and semantic search	Vector-backed retrieval
static	Reference data with infrequent change	Stable lookup tables
service	Callable capability without record storage	Governed operations

Align fieldMappings and sync — record types use business entities; document types emphasize file metadata.

Resource type

List catalog keys — reuse standard keys when possible:

aifabrix resource-type list
aifabrix resource-type get --key customer

Create missing keys before first upload:

aifabrix resource-type create --key customer --display-name "Customer" --category business

Set resourceType at the datasource root (not nested under fieldMappings):

{
  "key": "my-crm-companies",
  "systemKey": "my-crm",
  "entityType": "recordStorage",
  "resourceType": "customer"
}

Validate — aifabrix validate <systemKey> and entity-level validate if needed.
Continue in entity guides — record storage, document storage, or other guides overview for schema bands beyond identity.