Skip to main content
Fields are the properties a document can carry beyond its title, type, tags, and description: a review date, a customer name, a renewal quarter. Each one is defined once, on the Fields page, with a name and a type. See extra properties for why they are worth having. The definitions are what keep fields consistent. Agents can fill in only the fields defined here. A write that uses any other field, or a value of the wrong type, is refused and sent back to the agent to fix. Open the page with Fields in the sidebar.

Defining a field

Choose Define field to open the New field form. Keys are lowercase: a letter first, then letters, digits, and underscores, up to 64 characters, such as renewal_date. If you type a key that breaks the rule, the form suggests a corrected one. Press Enter or click it to take it. Choose Save. New fields go to the end of the list.

The registry

The registry lists every defined field with its Type (and options, for a select) and Docs, the number of documents that use it.
  • The up and down arrows on each row reorder the list. The order here is the order fields appear on a document and the order agents see them in.
  • Edit opens the same form. The type can’t be changed once a field exists: delete it and define it again. Changing the key renames it on every document that uses it, after you confirm with Rename key.
  • Delete removes the definition after you confirm with Delete field. Values already on documents are kept. They become unregistered and show up in the list described below.

In use, unregistered

The In use, unregistered card at the top of the page lists fields that documents carry but the registry doesn’t define, with how many documents carry each. This is usually what documents brought with them when they arrived from somewhere else. Choose Define field beside one to open the form with its key already filled in. Once it is defined, those documents show it like any other field. When nothing is waiting, the card reads All fields defined.

Filling in fields

On a document, fields sit in the Custom card of the details rail. Choose Add field to pick one of the defined fields the document doesn’t have yet. Fields a document carries that are not defined are listed there too, read-only, behind a count of unregistered keys. You can also leave it to an agent:
“Add a renewal date field, then set it on every customer document from what their contracts say.”