Glossary
The words of the domain, defined once
Every vendor has its own vocabulary, and the same words do not mean the same things. Here are the ones we use, with their exact definition — it is also the vocabulary of our API and our documentation.
15 days • 10 users • no card required
The form
What gets filled in
A form is not a document: it is a definition that produces documents.
- Form
- The definition of the questions, their rules and their order. A form holds no data.
- Form version
- A published state of the definition, frozen forever. A submission belongs to a version, which is what makes it readable exactly as it was entered.
- Submission
- What a person filled in, at a moment, with a version. It is the unit the API, the exports and the workflows manipulate.
- Field key
- The stable identifier of a question. It appears as an export column and as a template tag, and it never changes.
The field
What happens away from the office
The vocabulary of syncing, which is what the technician sees on screen.
- Assignment
- A form handed to someone, possibly prefilled, with a deadline. It is what appears in the day's list.
- Queue
- Finished submissions waiting for the network. It empties only on a successful upload or an explicit user action.
- Conflict
- The same submission changed on the device and at the office. The app shows it and asks; it does not choose for you.
- Round
- A series of assignments organised over time — a maintenance tour, an inspection circuit.
After the submission
What comes out
The words of documents, automation and integrations.
- Document template
- A Word or Excel file carrying tags. A submission fills it to produce the final document.
- Workflow
- A sequence of steps triggered by an event — usually a submission being sent — with a condition on each step.
- Webhook
- A signed call sent to your server when something happens here. The reverse of an API: we do the calling.
- Saved view
- A set of filters and columns, named and shared across the team, to find the same list again without rebuilding it.
The vocabulary is the API's too
That is not a coincidence: the words of the trade, the tables and the routes carry the same names, so that a conversation and an API call are about the same thing.