Set up and manage templates from the Company Settings.

To create a template, upload a DOCX file, choose a model, and provide a name.

Templates are initially in Draft state. Click “Validate" to validate them, after which they can be used to generate DOCX documents.

When the “Validate Template” button is clicked, the system checks the uploaded DOCX file for validity, including file format, field correctness based on the selected model, and file integrity. If all checks pass, the template is marked as Validated and becomes available for DOCX generation.

Once a template is validated, it cannot be modified. To make changes, reset it to Draft, update the template, and validate it again.

The “Generate DOCX” option will be shown in the Action menu on records.

After clicking “Generate DOCX”, a popup opens with two options: “Existing Template” or “New Template”. If “Existing Template” is selected, only validated templates related to the current model are available for selection.

When “New Template” is selected, additional options are shown: upload a DOCX file for one-time use or save it as a template

After selecting “Save Template”, the Template Name field becomes visible. Enter a name, and the template will be saved in the company’s DOCX templates.

After clicking “Print”, the DOCX file is generated and downloaded immediately. A sample DOCX output is shown below.

DOCX Template Formatting Guidelines

Please refer to the sample DOCX files for the correct field and line formatting. Use the same structure when creating new templates. A sample template is already included in the application, and its file path is provided for reference.

Guidelines for Template Design

• Field Syntax:
  • Always use double curly brackets for fields:
  • {{field_name}}
  • Every field must be enclosed within {{ }}.
• Layout & Formatting:
  • Fields can be placed in paragraphs, tables, or headings.
  • Ensure the layout is clean and readable within the DOCX page.
• Many2one Fields:
  • Use dot notation for relational fields:
  • {{many2one_field.sub_field}}
  • Example: {{partner_id.name}}
• Allowed Fields:
  • Only use fields from the model selected in the DOCX template configuration.
  • Using fields outside the configured model is not supported.
• Field Reference:
  • All usable fields are listed in the instruction section.
  • Always refer to that list before adding fields.
• Validation Check:
  • All the above points are validated during template processing.
  • Incorrect formatting or invalid fields may cause errors.

Instruction for One2many / Many2many Fields

Follow the guidelines below to correctly format One2many or Many2many fields in DOCX templates:

• Use Table Only:
  • Always use a table to display One2many or Many2many data.
  • Do not use paragraphs or headings for these fields.
• Use table_lines Tag:
  • The table_lines tag must be used inside the table.
  • This is required to correctly fetch and display line data.
• Format Example:
  • Use the following structure:
  • table_lines{'table_field': 'order_line', 'table_columns': {'Name': 'product_id.name', 'Qty': 'product_uom_qty', 'Price Unit': 'price_unit'}}
• Dictionary Structure:
  • The format uses a dictionary with two main keys:
  • 1. table_field:
    • Value should be the One2many / Many2many field of the main model.
    • Example: order_line in Sale Order.
  • 2. table_columns:
    • This contains another dictionary.
    • Defines table column headers and corresponding fields.
    • Example: {'Name': 'product_id.name', 'Qty': 'product_uom_qty', 'Price Unit': 'price_unit'}
    • Key: Column name (displayed as table header)
    • Value: Field name from the line model
• Validation:
  • The system will validate this format during processing.
  • Ensure the structure is correct to avoid errors.