Field references in documents
Insert company data into wiki pages and page templates once, and every document shows the current value.
A field reference puts a piece of company data into a document instead of a copy of it. When the value changes in your company data, every document that refers to it shows the new value, and the document itself does not have to be edited. There are two kinds: an explicit reference names the field, for example {{field:company.payment_type}}, and an abstract reference names a concept, for example {{concept:payment_terms}}, which your company maps to a field.
In a wiki page a reference shows as a chip with the current value. A missing value shows as a warning chip with the name of the field in brackets, for example [Employees, previous year], and links to the place where the field is set.
Who can use this
- Inserting references: every member who may edit the page
- Reading the values: every member with a built in role, for the fields they may see
- Mapping a concept to another field: owners and administrators
Steps
1. Insert a field
In the page editor type {{ or choose "Insert field" in the / menu. The list shows concepts first, then fields, each with its current value. Type to filter by name, field or value, and choose an entry. The reference is inserted as a chip.
2. Read the chip
Hover over the chip to see the field and the source of its value; for a concept the card also says "Uses the field …". "Set value" opens the place where the field is entered, "Show origin" opens the field in the Company Brain knowledge graph, and for a concept "Show mapping" opens the concept in the "Concepts" card.
3. Fill a missing value
Click a warning chip, or "Set value" on its card. It opens the place where the field is entered, for example the company settings, the payment terms or the compliance profile on the Company Brain overview. Save the value and go back to the page: the chip shows the new value. The page itself is not changed.
4. Map a concept
Open the Company Brain overview. The "Concepts" card lists every concept with its placeholder, for example {{concept:payment_terms}}, the field it uses now and that field's current value. "Default" means the concept uses its standard field, for example the concept Payment terms uses the field Payment terms. "Company mapping" means your company chose another field; below it you see which field the default would be. As an owner or administrator, choose another field next to the concept and click "Save". Every document with this concept then shows the value of the new field. "Reset to default" removes the mapping, and the concept uses its standard field again. Without this right the card is read only. You can also ask Brain, for example "Map the concept payment terms to the field payment type", and confirm the proposal.
5. Follow the page under Templates
Company Brain, Templates lists every wiki page with references as "Wiki page", with the fields it already has and the ones still missing. "Set" next to a missing field opens the place where it is entered, and "Open page" opens the wiki page. A wiki page is never created from there, because it always shows its values live.
6. Reuse the page as a template
Choose "Save as template" in the page menu. The references stay in the template, so every page created from it shows current values too.
7. Export
Exports (PDF, Markdown, HTML and the space export) contain the values at the moment of the export, read with the permissions of the person who exports. A value that is missing is exported as [Label].
Fields and options
- Field
One piece of company data, for example Payment type or Company name.
- Concept
A general name such as Payment terms or Management that your company maps to a field. "Uses the field …" on the card shows which one.
- Warning chip
The field exists but has no value yet. It shows the name of the field in brackets and links to where the field is set.
- Not visible
You may not see this field; the value is hidden.
- no value yet
Shown in the list when a field or concept has no value yet. You can still insert it.
Good to know
- Values are always read with your own permissions.
- A chip loads its value when the page opens and again when you return to the browser window, at most every 30 seconds. If the current value cannot be loaded, the chip shows the value from the moment it was inserted.
- The list offers fields of the company and concepts. Fields that have one value per product, customer or employee are not offered.
- The "Concepts" card only offers matching fields: company fields for a company concept, and the fields of a product for the concept Product price.
Related
- Templates and readiness
See which templates your data can already fill, what is missing and create a document when one is ready.
- Documents: writing pages
The page editor, autosave, the page tree, mentions, links and favourites.
- Documents: templates and export
Start pages from templates, save your own templates and export pages.
- Brain at a glance
What Brain is, what it can do and the rules it always follows.