Articles in this section

Using the Merge Manager Word Add-In

Avatar
Support
  • Updated
Follow

This article explains how to download, install, and use the Brilliant Assessments Merge Manager Word Add-in to create and modify merge strings in your Feedback or Cohort report templates.

The Brilliant Assessments Merge Manager Word Add-in helps you create and modify merge strings in your Feedback or Cohort report templates. It is available for Word 2016 and later, and for the desktop version only (the web version is not supported).

On this page

Downloading the Word Add-In

To download the Add-in, open a blank document in Word.

Addin_Download.png

  1. Click Insert.
  2. Click Get Add-in.
  3. Type Brilliant in the search bar and press Enter.
  4. Select Brilliant Assessments from the results and click Add.
  5. Word will add the Add-in to your Home tab menu.

Once you have downloaded and installed the Word Add-in, you will be asked to log in.

Addin_Logon.png

  1. Site Code: This appears in your Site Settings under the General tab > Site Code. It is usually your subdomain from your URL.
  2. Username: This is the same username you use to log in to Brilliant Assessments.
  3. Password: This is the same password you use to log in to Brilliant Assessments.
  4. Click Login.

Once you are logged in, the Add-in will take you to the Document tab where you can select the report (Feedback or Cohort) that you want to modify and download it to Word.

Tip: If you are starting with a starter template or your own document, upload it to Brilliant Assessments and download it to Word again the first time you use it. This allows the system to place a document ID inside the metadata so that the Merge Manager always knows which report the template is linked to.

You can also download the report from the Assessment Feedback Report screen or the Cohort Report Manager screen, and then open the downloaded document in Word.

Document Tab

Word Template Merge Manager.png

  1. Report Type: Select the report type - Feedback or Cohort.
  2. Assessment: Select the Assessment Report you wish to download (if you chose Feedback in step 1) or the Cohort Report (if you chose Cohort in step 1).
  3. Download to Word: Click this button to download the selected report template.
  4. Upload to Brilliant Assessments: Once your updates have been made to your Word template, click this option to upload those changes directly to your Brilliant Assessments report template.

Tip: If you open your Word template directly from the Reports tab in your Assessment Settings each time you work on it, the Assessment field will populate automatically.

Merge Manager Tab

The document will open in a separate window and the Merge Manager will display the Merge Manager tab.

Addin_MM1.png

Using the Merge Manager tab, you can:

  • Review an existing merge string in the document. Click anywhere in a merge string within the document and the Merge Manager will display all of the parameter options for that merge string. You can modify it if required.
  • Add a new merge string by positioning the cursor where it is required and then selecting the merge string and parameters you need.

Note: 

  • The auto-select behavior (clicking a merge string to display its parameters) can be turned off using the Auto-Select switch on the Merge Manager tab.

  • All of the merge strings available, and the parameters for each one, are documented here.

Start by selecting a Merge Type from the list:

Addin_MM2.png

Once you have selected the Merge Type, the parameters relevant to that type are displayed:

Addin_MM3.png

  1. Merge Type: The selected option for the merge string. If you select a different merge string, all previously selected parameters will be reset.
  2. Show: If the merge type has this option, you can select the level you want to display the data (such as a bar chart). The Show options are Assessment, Section, SubSection, Question, and Segmentation. Depending on what you select, the Merge Manager will prompt for more detail. For example, if you select SubSection, you will be prompted to specify the Section (with all sections in the assessment listed) or All Sections, and the SubSection (with all subsections listed) or All SubSections.
  3. Display: Percentages or Average Score (for Likert-style reporting).
  4. Select Options: Allows you to select other parameters available for this merge string.

Addin_MM4.png

  1. Merge Type: The selected type for the merge string. If you select a different merge string, all previously selected parameters will be reset.
  2. Show: Select the level to display the data - in this example, a bar chart. The Show options are Assessment, Section, SubSection, Question, and Segmentation (if the assessment uses Segmentations). SubSections has been selected.
  3. Section: As SubSections are being shown, you are prompted to specify the Section (with all sections in the assessment listed) or All Sections.
  4. SubSection: You are prompted to specify the SubSection (with all subsections in the assessment listed) or All SubSections.
  5. Display: Percentages or Average Score (for Likert-style reporting).
  6. Selected Options: In this example, Display Labels has been selected. Options are added as they are selected and can easily be removed using the X icon.
  7. Select Options: Allows you to select all other parameters available for this merge string. Refer to the Vertical Bar documentation to understand each parameter's function.
  8. Merge String Preview: The merge string is built as options are selected in the Merge Manager.

To complete the merge string and continue editing the Word document, click outside the merge string and continue editing the document.

Once the document is complete, you can test and preview your report template (see Testing PDF Reports Easily).

FAQs & Troubleshooting

Use the questions below to troubleshoot common issues with the Merge Manager Word Add-in.

+ I'm getting an "Error loading Add-in" message. What should I do?

This is usually resolved by restarting Word. Try the following steps:

  1. Close Microsoft Word completely.
  2. Reopen Word and open your document again.
  3. Try loading the Merge Manager Add-in from the Home tab.

If the error persists, log out of your Microsoft account, log back in, and try loading the Add-in again.

+ I installed the Add-in but it does not appear in Word. Where is it?

After installing the Add-in for the first time, it is recommended to close Word completely and reopen it. The Add-in should then appear on your Home tab. If it still does not appear:

  1. Go to Insert > My Add-ins.
  2. Check that Brilliant Assessments is listed under your add-ins.
  3. Click on it to activate it.
+ I'm getting a login error. How do I check my Site Code?

Login errors are often caused by an incorrect Site Code. To verify your Site Code:

  1. Log in to the Brilliant Assessments portal.
  2. Go to Site Settings > General tab > Site Code.
  3. Copy the exact Site Code from this field and paste it into the Merge Manager login screen.

Important: The Site Code must not contain any extra spaces before, after, or within the code. Copy and paste it directly from the portal to avoid errors.

+ Is the Add-in available for Word Online or Mac?

The Merge Manager Word Add-in is available for the desktop version of Word 2016 and later on Windows and Mac. The web version of Word (Word Online) is not supported.

+ My merge strings are not updating in the document. What should I check?

If merge strings are not updating when you click on them:

  1. Check that the Auto-Select switch is turned on in the Merge Manager tab.
  2. Make sure you are clicking directly inside the merge string text in the document.
  3. If the issue persists, close the Merge Manager panel, reopen it from the Home tab, and try again.

Links to Training Videos on Report Building:

Related articles

Comments

0 comments

Please sign in to leave a comment.