Structured records
Records keep the same fields for every customer (Network, Wi-Fi, Application, Vendor, Licence, Backup, Email, or types you add), point at passwords in the vault, and link to devices, contacts and sites.
Updated
A record is structured documentation: the same fields, in the same order, for every customer. Where a page is good for "how it works", a record answers "what is it": the subnet, the Wi-Fi name and its password, the backup product and when it was last tested.
Record types
Every workspace starts with seven types: Network, Wi-Fi, Application, Vendor, Licence, Backup and Email. Owners and admins change them, or add their own, in Settings → Record types.
A field has a label, a type and whether it's required:
| Type | Holds |
|---|---|
| Text, Number, Date, Yes or no | What it says |
| Dropdown | One of the options you list |
| Web address | A link starting with https:// |
| Credential (vault) | A credential from the vault: shown masked, revealed from the record |
| Device, Contact, Site | One of the customer's own |
Removing a field hides what records stored in it; changing a field's type shows old values as they were until someone edits the record. A type with records can't be deleted.
Add a record
- Open Documentation → Records and choose New record.
- Pick the customer (inside a customer's workspace it's that one) and the type, give it a name and fill in the fields.
- For a credential field, pick one from the vault or choose + to add a new credential right there.
Records also have notes, in Markdown.
Credentials in records
The record stores which credential it points at, never the password. People who can reveal passwords see a Reveal button next to the field, with the same rules as the vault (a reason and a recent two-factor confirmation). Deleting a record leaves its credentials in the vault.
Links
Device, contact and site fields link the record to what they name: the device's Documentation tab lists it. Also linked to → Link adds links beyond the record's fields.