Developers / Reference
A vocabulary your data can share.
Use the business model to say what a record represents, which facts belong to it, and how it relates to other records.
- Object type
- A category such as Supplier or Order. It defines the properties and relationships shared by its records.
- Instance
- One record of a type: Supplier A or SO-1042. A type is not one of its instances.
- Identity
- A stable key that distinguishes an object across sources. A display name alone is usually not enough.
- Property
- A fact with a declared meaning, such as an order amount, currency or supplied date.
- Relationship
- A named connection between types, resolved between records through explicit source keys.
- Mapping
- The link from a source field to a modeled property or relationship. Preserve the source and any transformation.
- Business definition
- An agreed rule that selects or calculates data. “Confirmed tire defect” is narrower than “tire report.”
- Evidence
- The records or passages that support a particular answer. In the sample, these include feedback IDs and excerpts.
Follow a relationship through its keys.
| Source field | Resolves to | Meaning |
|---|---|---|
| products.batch | batches.id | Product uses a material batch |
| orders.product | products.id | Order contains a product |
| feedback.order | orders.id | Feedback refers to an order |
In this simplified dataset, each product points to one batch and each order to one product. A production model must represent its actual cardinality, including line items and multiple inputs.
Keep meaning separate from presentation.
01
The map shows types
Supplier, Product and Order use consistent node styling. Record IDs belong in the inspected data or answer.
02
The answer shows instances
A result should identify its matching orders and the evidence behind each one.
03
The definition explains the boundary
State which topic, status, date range and counting unit the answer uses.
Follow the question. Inspect the answer.
Start with the working example. No account needed.