Word Templates allow users to generate a standardized document from an individual record in akoyaGO. The generated Word Document will be automatically populated with data from akoyaGO. Word Templates can only be run on individual records, but can draw data from several related records simultaneously. Word Templates do NOT automatically save to the related record in akoyaGO.
Letter Templates are akoyaGO's best practice for generating letters through akoyaGO CRM in bulk. If you need to generate Word Documents/letters for a group of records, we recommend using akoyaGO Letter Templates instead of Word Templates. Letter templates offer additional functionality, such as auto-saving the individual letter to the related record, creating a PDF with all letters for bulk printing, and logging additional information, such as the user who initiated the Letter Template Session. For more information on Letter Templates, reference this related Knowledge Article: Generating Letters in CRM
Setup in microsoft word
In Microsoft Word, open Options, navigate to Customize Ribbon, and enable Developer.
word templates in akoyago
You can find existing Word Templates in Advanced Settings > Templates > Document Templates.
Create New word template
- Word Templates will be created in Microsoft Word and then uploaded to akoyaGO. You will have the opportunity to add "merge fields" within the Word Template from the table you are creating this Word Template within, as well as from related tables.
To begin the process, click on +New from the Templates table and choose "Download Word Template" - Select the Entity/table this Word Template will be based on. You also have the option of selecting additional, related entities that contain data you wish to use within your Word Template. For example, in the screenshot below, the Word Template will be built off of the Request table/entity. However, I also plan to include fields from the related Applicant - Constituent and Primary Contact - Contact records, so I have selected those Relationships as well.
Choose Download Template when complete. This will download a Word Document to insert fields from the entity/table selected, as well as any selected relationships.
- Open the Word Document that was downloaded. (This will appear wherever your downloads are found, depending on the browser you are using.)
- Enable Editing in Word, and open the XML Mapping Pane under the Developer tab.
add fields through xml mapping pane
- Select the document template option from the Custom XML Part drop-down.
- By expanding the entity/table (shown as its schema name), you will see a list of all fields from the table. At the bottom of the list are the additional entities previously selected.
- Right-click on a field name, choose Insert Control, and then Plain Text to insert a merge field.
- Tables of data containing data from related entities can be added by creating a table in Word, adding the merge fields, and selecting the row. And then, by right-clicking on the entity name in the XML Pane, inserting Content Control, and choosing Repeating.
5. Name and save your Word Document. You will need to upload this completed template to akoyaGO.
Upload Template
Navigate to Advanced Settings > Templates > Document Templates > Upload Template:
Choose Upload Word Template:
Choose the file you saved in the previous step and click Upload
This will be named as your saved document was named.
Run word template
- From a View or directly from a record, choose a single record, and choose Word Templates from the command bar. Select the Word Template.
*Reminder - Word Templates can only be ran for one record at a time! If you need to generate Word Documents for multiple records, please see Letter Templates KA linked at the top of this Knowledge Article. - This will download a Word Document based on the Word Template you created. Data will be dynamically inserted in the Word Template based on the fields that were inserted and the data within the selected record. When you open the downloaded Word Document, you may need to click "Enable Editing" within Microsoft Word.
UPDATE EXISTING word templateS
1. To make changes to existing Word Templates, start by navigating to Templates (see Location section above).
2. Depending on your Default System View, you may need to navigate to the All Document Templates View to access all Document Templates.
3. Choose the Word Template you would like to edit. Click "Download"
This will download the current version of the Word Template that has been uploaded to akoyaGO. Any changes you make to this Word Template will not be automatically updated in akoyaGO. You will need to upload the updated version after making changes.
4. Make any changes to your Template in Microsoft Word. Save your updated version.
5. Navigate back to Templates in akoyaGO. Select the template that is no longer the most recent version and deactivate it.
7. Choose Upload Template. Upload your updated Word Document.
