Skip to main content

Creating Templates

Build document templates for automatic data population.

Template Creation Form​

To create a template, go to Documents → Documents Templates and click Create Document Template. The form is organized into six expandable sections:

1. Base Information​

FieldRequiredDescription
NameYesTemplate name (e.g., "Monthly Status Report").
Related ModuleYesThe module this template belongs to (Projects, Project Notes, Tasks, Trips, Invoices, or Budgets).
CategoryYesSelect an existing category or create a new one inline. Categories can also be edited and deleted from the dropdown.
info

When you change the Related Module, any previously configured Visibility Rules are automatically reset.

2. Document Template​

This section contains:

  • Tutorial Link — An "Open Tutorial" button that navigates to the Document Template Tutorial page.
  • Template File — Upload a .docx or .odt file containing Carbone tags. A link to the Carbone documentation is provided for reference.
  • Output Format — Choose the format for generated documents:
    • PDF — Best for finished reports and contracts.
    • DOCX — Best if further manual editing is needed.
    • XLSX — Best for spreadsheet-based outputs.

3. Download Location​

Choose where the download button appears. Currently only Single View is supported (the button appears on individual record pages).

4. Roles with Access​

Select which user roles can see and use this template. Use the multi-select dropdown to add roles.

5. Visibility Rules​

Control when the download button appears on records:

  • Show Button for all records — Toggle ON (default) to make the template available on every record of the related module.
  • Condition Builder — Toggle OFF to define conditions. Choose whether All or Any conditions must match, then add conditions using the Add Condition button.

6. File Name​

Define a custom file name pattern for generated documents. Use the Add Data button to insert dynamic field values (e.g., project name, date) into the file name.

Preparing Your Template File​

Compass uses the Carbone engine. Before uploading:

  1. Create a document in Microsoft Word or LibreOffice.
  2. Add placeholders (tags) in the format {d.fieldname}.
  3. Format the document as desired (fonts, colors, company logos).
  4. Save as a .docx or .odt file.
tip

Use the in-app Document Template Tutorial (accessible from the Documents module) to learn Carbone syntax and browse available placeholder fields for each module.

Template Categories​

Categories are user-created and help organize templates. You can create, edit, and delete categories directly from the Category dropdown in the template form. Use names that match your organization's needs.

Editing Templates​

  1. Go to Documents → Documents Templates.
  2. Click on a template row to open it.
  3. Modify any fields or upload a new template file.
  4. Save your changes.

Related: