HomeGuidesAPI ReferenceChangelog
Guides

Export Builder

The Export Builder enables users to generate customized DOCX exports by mapping RegScale fields to placeholder tags in a Word template. This feature supports rich formatting, images, checkboxes, and dynamic tables—making it easy to produce polished, compliance-ready documents directly from form data.

1. Navigate to Export Builder

  • Go to Setup > Export Builder.
  • Select an existing export to edit or click New to create a new export.

2. Create a New Export

  • Click New to begin a new export configuration.
  • The Export Builder opens in the Setup tab.

3. Complete Basic Info

  • Export Title – Enter a name to display in the export options.
  • Status – Choose Active or Inactive.
    Inactive exports do not appear in the form UI.
  • Module – Auto-selected and cannot be changed.
  • Export Group – Select an existing group or click Add New Group.
    This controls where exports appear in the form export menu.
  • Export Type – Currently supports only DOCX.
  • Description – Optionally, provide context for the export.

Click Save to continue.

4. Upload a Template File

  • Switch to the Export Mappings tab and upload a DOCX file.
  • This file serves as your export template and contains placeholder tags (e.g. {{field_name}}).
  • Removing an uploaded file deletes all associated mappings.

For formatting guidance, see Creating an Export Builder Template.

5. Map Export Fields

After uploading a DOCX template:

  • Review the detected Tag Names in the left column.
  • Use the Export Field dropdown to map each tag to a RegScale field.
  • Select the appropriate Data Type.
  • Use Auto Map to attempt bulk field matching.
    Always verify and confirm auto-mapped values.
  • Child module and subform mappings must be inside tables in the DOCX template.
  • For best results, match tag names to database field names (e.g., {{SystemName}}).

Click Save to finalize the mappings.


Data Types

TypeDescription
TextReturns plain text with HTML removed.
ImageEmbeds an image file from the RegScale file store. Place the tag in a textbox. (.png, .jpeg, .jpg, .gif supported)
File NameDisplays the file name stored in a file field.
Date (MM/DD/YYYY)Outputs the date in UTC, formatted as MM/DD/YYYY.
Date (YYYY-MM-DD)Outputs the date in UTC, formatted as YYYY-MM-DD.
Checkbox (Yes/No)Renders Yes/No selections from list fields as checkboxes.
CheckboxRenders boolean field values as checkboxes.

DataObjects

Export Builder supports RegScale-published DataObjects for populating complex data structures or calculated outputs. This includes computed fields and nested objects used in advanced table generation and summaries.