The datamodel registry

Datamodels

A datamodel is a standard kind of data, like a task, a contact or an event, with fields every quill agrees on. A contact is a contact whichever quill made it, so one quill's data is the next one's.

Foundational

The standard ones, below, grouped into domains you can choose when you install. Versioned, and few: the bar for a new one is that two unrelated quills wanted it.

Extended

A quill that needs more adds fields under its own name, like fleet.odometer on a vehicle, rather than inventing a second kind of vehicle. It can also introduce a datamodel of its own, and from then on every other quill may ask for it.

The brand guide calls these elements; it is the same thing. These are read from Cloudmorrow/datamodels at v1.2.0, the release the Quill Catalog pins.

Indexed fields are kept plain, so your cloud can sort and filter by them. Encrypted fields are encrypted before they reach the disk.

Tasks

Boards and the tasks on them.

Board `board`

v1 · personal

A set of tasks, each in one of three lanes.

Title title text, one linerequired Encrypted

Used by Tasks

Task `task`

v1 · personal

One thing to do, on a board, in a lane. Its body is Markdown; subtasks are - [ ] lines.

Board board link to Boardrequired · deleted with its board Indexed
Title title text, one linerequired Encrypted
Body body Markdown Encrypted
Lane lane one of To Do, Doing, Done Indexed
Due due date Indexed
Done done_at date and timeset when lane becomes Done Indexed

Used by Tasks

Customers (CRM)

The people and organisations you deal with.

Contact `contact`

v1 · personal, shared

A person you know: how to reach them, and how you know them.

Name name text, one linerequired Encrypted
Email email email address Encrypted
Phone phone phone number Encrypted
Organisation organisation link to Organisation Indexed
Birthday birthday date Encrypted
Address address text Encrypted
Notes notes Markdown Encrypted

No quill in the catalog uses it yet.

Organisation `organisation`

v1 · personal, shared

A company, a club, an institution: somebody you deal with that is not one person.

Name name text, one linerequired Encrypted
Website website web address Encrypted
Email email email address Encrypted
Phone phone phone number Encrypted
Address address text Encrypted
Notes notes Markdown Encrypted

No quill in the catalog uses it yet.

Fleet

Cars, vans and bikes: what you drive and keep on the road.

Vehicle `vehicle`

v1 · personal, shared

A car, a van, a bike: something with a registration that is driven and serviced.

Name name text, one linerequired Encrypted
Registration registration text, one line Indexed
Make make text, one line Indexed
Model model text, one line Encrypted
Year year whole number Indexed
Vin vin text, one line Encrypted
Fuel fuel one of Petrol, Diesel, Electric, Hybrid, Other Indexed
Notes notes Markdown Encrypted

No quill in the catalog uses it yet.

Calendars

Calendars and the events on them.

Calendar `calendar`

v1 · personal, shared, public

Your own, one you share, or everybody's.

Name name text, one linerequired Encrypted
Colour colour text, one line Encrypted

Used by Calendar

Event `event`

v1 · personal, shared, public

A title and two moments, on a calendar. Times are wall-clock times.

Calendar calendar link to Calendarrequired · deleted with its calendar Indexed
Title title text, one linerequired Encrypted
Starts at starts_at date and timerequired Indexed
Ends at ends_at date and time Indexed
All day all_day yes or no Indexed
Location location text, one line Encrypted
Notes notes Markdown Encrypted

Used by Calendar

Messaging

Channels and the messages in them.

Channel `channel`

v1 · shared, public

A room people talk in: public, private, or between two people.

Name name text, one linerequired Encrypted
Kind kind one of Public, Private, Direct Indexed
Topic topic text Encrypted

Used by Chat

Message `message`

v1 · shared, public

What somebody said in a channel.

Channel channel link to Channelrequired · deleted with its channel Indexed
Body body textrequired Encrypted
Sent at sent_at date and time Indexed

Used by Chat

Notes

Markdown notes in folders, as files you own.

Note `note`

v1 · personal

Markdown in a folder, with pictures. A real file in your notes folder, sealed at rest.

Path path text, one linerequired Indexed
Folder folder text, one line Indexed
Title title text, one line Indexed
Body body Markdown Encrypted
Modified modified date and time Indexed

Used by Notes

Secrets

Keys and passwords in vaults and environments, sealed; never an assistant's.

Secret `secret`

v1 · personal

A key and its value, in a vault and an environment. Sealed under the server's key; never an assistant's.

Vault vault text, one linerequired Indexed
Environment environment text, one linerequired Indexed
Key key text, one linerequired Indexed
Value value text, one line Encrypted
Length length whole number Indexed

Used by Secrets

Files

Your own drive, your fileshares, and the files in them.

File `file`

v1 · personal

A file or a folder in a share or in My Files: a real file on disk, reached over WebDAV and the desktop app's mounts as well.

Share share link to Sharerequired Indexed
Path path text, one linerequired Indexed
Folder folder text, one line Indexed
Name name text, one linerequired Indexed
Kind kind one of File, Folder Indexed
Size size whole number Indexed
Modified modified date and time Indexed
Type mime text, one line Indexed

Used by Files