Skip to main content
Version: Next

Building Advanced Templates

Cogynt's Advanced Report Builder tool enables users to define custom .docx export templates for an event or 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 that contains your desired formatting and output in a word processing application, like Microsoft Word or Google Docs.
  2. Uploading the .docx template to Workstation and creating a Report Builder template row for it.

Creating a .DOCX template file​

This step occurs outside of Workstation. In a word prorcessing application (e.g., Microsoft Word), create a document and include any combination of the following:

  1. In an empty .docx file, set up your desired Word template. This can include elements like:
    • Images
    • Headers
    • Footers
    • Tables
    • Static text elements (headings, subheadings, etc.)
    • Hyperlinks
  2. Reference any information on the event or collection you wish to export data from using the syntax/references defined in the Advanced Mapping Guide.
  3. Save the .docx file.
  4. Proceed to Creating an Advanced DOC Template in the Report Builder screen of Workstation.
tip

Testing Templates

Users with Workstation: Report Builder: Edit and Workstation: Collections Export: Edit permissions can test it in Workstation before following Step 4 above.

Assuming you have a .docx file ready to test:

  1. Find the event or collection you wish to test the export on and ensure it is loaded onto an Object Details Viewer widget.
  2. Click the Export button on the event/collection.
  3. Select the Export to a DOCX template option.
  4. Attach the desired template and click Ok.

The collection exports and saves to .docx if successful. If there are syntax errors in your document, an error message appears.