How to Create a Word Document Output

How to Create a Word Document Output

This guide will help you create Word document templates that are compatible with our Form Builder. These templates allow you to automatically populate documents with data submitted through your forms.

To create a template, use the following syntax in your Word document:
  1. For basic fields: {field_key}
  2. For image-centric fields: {@field_key | render_picture}
Supported Fields

Field types and their template key syntax:
  1. Text: {field_key}
  2. Number: {field_key}
  3. Dropdown: {field_key}
  4. Toggle: {field_key}
  5. Checkbox: {field_key}
  6. Textarea: {field_key}
  7. Radio: {field_key}
  8. Signature Pad: {@signature_field_key | render_picture}
  9. Sketch Pad: {@sketch_field_key | render_picture}
  10. Date-Time: {field_key}
  11. Multi Select: {field_key}
  12. Address: {field_key}
  13. Lookup: {field_key}
  14. Image: {@image_field_key | render_picture}
To Create the output document:

  1. Open a new Word document.
  2. Type your document content as normal.
  3. Where you want to insert form data, use the field syntax:
    Example: "Submitter's Name: {submitters_name}"
  4. For image-centric fields, use the following syntax:
    {@image_field | render_picture} - This will insert the uploaded image at that location in the document.
  5. Save your document as a .docx file.
  6. Upload the Word file to the form builder.

For Layouts (Sections and Lists)
  1. Section: {section_key.field_key}
    Here to create the template key for the fields that are in the section in curly braces you need to first write the section key then the dot and then the field key.
    If we have an image-centric field in the Section then the template will be like following.
    {@section_key.image_field_key | render_picture}

  2. List: {#list_key}{field1_key}{field2_key}{/}
The list layout will be used only if we have a table in the Word document.

Here {#list_key} denotes the start of the List and this will come in the first column of the table with the first field key. So basically the column of the table will have {#list_key}{field1_key}.
{/} denotes the end of the list. So this will come to the last column of the table with the last field key {field2_key}{/}

Example 1:
User name
Email
{#list_key}{field1_key}
{field2_key}{/}

Example 2:
Username
First Name
Last Name
Date of Birth
{#users}{user_name}
{first_name}
{last_name}
{date_of_birth}{/}

Important Notes:
  1. Ensure that the field keys in your template exactly match the field keys in your form builder.
  2. The Form Builder will automatically handle the formatting and sizing of inserted images.
  3. You can use standard Word formatting (fonts, colors, tables, etc.) around your template fields.
Uploading Your Template:
Once you've created your template, upload it to your form builder application. The Form builder will use this template when generating documents from form submissions.

Testing Your Template:
After creating and uploading your template:
  1. Submit a test form with sample data.
  2. Use the Form builder to generate a document.
  3. Open the generated document and verify that all fields are populated correctly.
Note: If you encounter any issues, double-check that your field names match exactly between your form and template.

Examples


Example 2: Image field in the List layout:
Here the list key is “photo” and the image field key is image_field_4


    • Related Articles

    • How to Create Supplier Quotes

      Follow the Process to Create Supplier Quotes Navigate to the Web Portal and login On the left-hand main menu, select Purchasing and Bills> Supplier Quotes Click on "Add a New Record" or use the "+" sign to initiate the creation of a new Supplier ...

    • How to Create Activities

      This article will help you to setup Activities for the Project Project activities are the individual actions, and processes that need to be carried out to complete a specific project. Navigate to the Web Portal and login On the left-hand main menu, ...

    • How to create Locations

      Follow the steps below to create a new Depot Location Watch this interactive video to see how it's done Navigate to the Web Portal and login On the left-hand main menu, select Admin>Company Locations tab Click on the at the top right Give you ...

    • How to Create Bills

      Follow the below steps to Create Bills Navigate to the Web Portal and login On the left-hand main menu, select Purchasing and Bills> Bills Click on either "Add New Record" or the "+" sign to initiate the creation of a new Bill. Choose the Supplier ...

    • How to create Accounts

      You will learn how to set up and customize accounts used for financial transactions, tax calculations, and other accounting-related functions. Here's a breakdown of the key elements you might find in the Accounts tab: Chart of Accounts: This is a ...