Data Hub overview
What Data Hub is, how entities, fields and records fit together, and what you need before you start.
Beta
Data Hub is in Beta. It is off by default; an administrator turns it on per tenant.
Data Hub holds typed business records that automations and people share. A workspace holds entities, such as Invoice, Vendor or Claim. An entity has typed fields and records.
Everyone reaches the same data through one API with one error catalogue:
- People use the Data Hub product in the web app.
- Studio workflows use six activities in the Orchestrator activities pack.
- Python automations use
velophex.runtime. - Other clients call the HTTP API.
Concepts#
| Term | Meaning |
|---|---|
| Entity | A typed table in one workspace. It has an API name (for example Invoice, which cannot change), a display name you can edit, fields, a schema version and its records. |
| Field | A typed value of an entity: an API name (cannot change), a display name, a type and rules such as required, unique, indexed and a default. |
| Record | The field values (data) plus the system fields id, revision, createdAt, createdBy, updatedAt and updatedBy. |
| Choice set | A list of values that a choice field takes its values from. |
Automations address an entity by name. An automation therefore runs unchanged in another workspace that has an entity with the same name. The web app and the management API address an entity by its id.
Before you start#
| You need | What you see when it is missing | Fix |
|---|---|---|
| A plan that includes Data Hub | Data Hub cannot be turned on for the tenant | Cloud Enterprise or Unlimited. Community and Standard do not include it. |
| Data Hub on for the tenant | 403 service_disabled on every call |
An administrator turns it on under Admin ▸ Settings ▸ Services, or a platform administrator under Tenants ▸ Services. |
| A Data Hub role in the workspace | 403 naming the permission |
See Limits and permissions. |
An agent run cannot use Data Hub yet. It gets 403 dh_access_denied.
A first entity#
The examples in these pages use one entity. Create it in the web app, in the workspace you run in: Data Hub ▸ Entities ▸ New entity, name Invoice, with three fields:
| Field | Type | Rules |
|---|---|---|
invoiceNumber |
Text | Unique (so it is indexed) |
amount |
Decimal | |
status |
Text |
Next steps#
Concepts
Before you start
A first entity
Next steps