- what is a custom word template?
- can I download a starting template?
- adding fields
- repeating sections
- header rows
- dynamic checkboxes
What is a custom word template?
A custom word template is a dynamic reporting option which allows you to export your captured form data and push it to a word template of your own design.
Can I download a starting template?
Yes you can! To download a starting template (which will contain all of your fieldkeys from your form) click on the "reporting" button from the builder and then click on the "custom" tab. Then just click on "Generate and Download" to generate a word report when you can then edit, stylize, and re-upload.
Adding fields to your custom word template is very easy. All you need to do is get your field's fieldkey and put it in your custom word template surrounded by dollar signs.
I have the below example where in the custom word template I have Inspector name, Inspector phone number and Client name. When the form is submitted, I want the data to be put in those spots.
I saved the custom word template, uploaded it to the custom tab in report settings, saved and published. Then I filled out a submission and submitted. Here is what the word report looks like after submitting
Stylizing: It is important to note, that fonts, colors, font size etc. will be mimicked in your reports. If you put your $fieldkey$ as Helvetica with a blue color, it will mimic those on the report. HOWEVER, it cannot use custom fonts. It is limited to generic word fonts.
For repeating sections you are going to use a table. You will only need to create the first row. Once you have added the table, right-click on it and select "table properties". In the alt text tab, you will want to in the title cell put the fieldkey of the section that is repeating. Save. Then for each cell, you will want to put the fieldkey if the field that you want to add, surrounded by dollar signs.(if you would like to create a header row that only repeats the data instances please see Header Rows section). Repeating Sections do not require a prefix
For subforms, you will need to use a table. It is setup the exact same was as a repeating section, except that your fieldkeys in the cell will need a prefix. Once you have added the table, right-click on it and select "table properties". In the alt text tab, you will want to in the title cell put the fieldkey of the subform. Save. The prefix will be the subform fieldkey. For example, if your subform fieldkey is "subform_1" and your field fieldkey is "date_2" you would put this in the cell "$subform_1_date_2$" notice the subform fieldkey is the prefix and it is separating the fieldkey by an underscore. (if you would like to create a header row that only repeats the subform instances please see Header Rows section below)
If you want to use a column format for your subforms, you can do that by setting it up like the picture below. I recommend using the first row as a blank space so there is some separation between the instances.
This is what it looks like on the report with 2 subform instances
If you want to have a header row in the same table as your data you can by specifying header_row in the description of the table properties.
After uploading and saving this to your form you will now be able to submit a form with a header row that only repeats the data.
For multiphotos, you will want to use a one-celled table. All photos will be put inside that cell. If you want multiple photos per row, make sure you specify the amount in the advanced report settings for that multiphoto field.
Advanced Report Setting: I set it to 4 photos per row (Screenshot below)
Custom Word Template: Single-Celled table with the field fieldkey surrounded by dollar ($) signs (Screenshot below)
Word report output: (Screenshot below)
Note: It is currently not possible to add checkboxes to fields inside subforms or repeating sections. We currently only support checkboxes that are in the main form.
It is possible to create dynamic checkbox in your custom word reports. Word does not allow the correct checkboxes by default so you will need to make sure you that you allow developer settings in Microsoft Word before you can add these to your word template.
This is how you can enable developer settings in Microsoft Word. (Not compatible with Google Docs)
1. Open Microsoft Word
2. Go to Word -> Preferences and click Ribbon & Toolbar (depending on your Microsoft Word version and whether you are using a mac or pc - you may have some differences in menu naming etc, but it should be fairly similar)
3. On the right panel there is menu item called "developer" that is unchecked by default - make sure "developer" is checked and click "save" to save your changes.
4. Once saved you will notice on your menu a new "developer" item, select it and you will notice that there is a checkbox button. This is what you will use for adding dynamic checkbox to your custom word templates
After you have enabled checkboxes on Microsoft Word you can now add them and configure them to work with FastField. I am going to use a simple list as an example and go through how I am going to set it all up.
Adding Checkboxes to your Custom Word Template
Note: It is currently not possible to add checkboxes to fields inside subforms. We currently only support checkboxes that are in the main form.
Note: you will need to have Developer settings turned on, if you haven't already done so, please follow the steps above to do this.
In my example I have a simple list that asks "What is your favorite color?" and that list has a fieldkey of "favoriteColor" and it has three list values - Blue, Green and Red. I have also enabled "Allow Multi-Selection" so that it will map to multiple list values at once.
In my word document I have added three checkboxes to my template, one for each list value.
Double click the "Blue" checkbox or right-click and select properties. In the Bookmark field, put the fieldkey of your list "favoriteColor" followed by an underscore "_" then the value of your list item. Because I am setting up the "Blue" checkbox I will put that after the underscore. NOTE: You need to make sure that your list values do not have any spaces or else they will not work with your custom word template.
(WINDOWS USERS - instead of Bookmark you will put those items in the "Title" in the same was as illustrated here.)
Then do the same thing for each of your checkboxes
After you are done mapping each of your checkboxes to your list values save your word document. Next upload it into the Custom Report Settings Tab of the builder.
Now save and publish your form. Next open up the app, login and submit your updated form. You will see that on your report the list items that you selected will be checked in your custom word report.
And here is what it will look like on the word report
Congratulations! You have now successfully setup dynamic checkboxes in your custom word report.
If you have any questions or issues please feel free to reach out to our support team at firstname.lastname@example.org