Skip to main content
Version: 2.15.X

Building Advanced Templates

Cogynt's Advanced Report Builder tool enables users to define custom .docx export templates for a collection. The user builds the desired template as a .docx file and uploads the template to Report Builder.

This guide covers the functionality tested and implemented in Cogynt. For more information regarding additional advanced features of the mapping library, refer to guigrpa's docx-template repository.

Building an Advanced (DOC) Report consists of two high level steps:

  1. Creating a .docx template file containing your desired formatting and output.
  2. Uploading the .docx template to Workstation and creating an Advanced (DOC) Report.

Creating DOCX Templates​

  1. In an empty .docx file, set up your desired Word export template. This can include elements like:

    • Images
    • Headers
    • Footers
    • Tables
    • Static text elements (headings, subheadings, etc.)

  2. Refer to any data in a collection that you wish to include in the export. This includes (but is not limited to):

    • Collection information (name, description, tags, priority)
    • Users on a collection
    • Custom Fields on a collection
    • Events on a collection
    • Timestamps
note

For information about the specific syntax and options available to that you can output from a collection, refer to the Advanced Collection Mapping Guide.

  1. Save the .docx file.
  2. Proceed to upload the docx template to Workstation and create an Advanced (DOC) Report.

Testing Templates​

Users with Workstation: Report Builder: Edit and Workstation: Collections Export: Edit permissions are able to test the Advanced Collection Builder.

The process of creating Advanced Collection reports can take multiple iterations to get right. For convenience, you can test a .docx template in Workstation without needing to create a saved template in Report Builder.

Assuming you have a .docx file ready to test:

  1. Find the collection you wish to test the export on and ensure it is loaded onto an Object Details Viewer widget.
  2. Click the Export Data button on the collection.
  3. Select the Export to a DOCX template option.
  4. Attach the desired template and click Ok.
  5. The collection exports and saves to .docx if successful. If there is syntax error in your document, an error message appears.