Using the BA Merge Manager Word Add-In

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 the desktop version is strongly recommended.

Downloading the Word Add-In

To download the add-in open a blank document in Word

1. Click Insert
2. Click Get Addin
3. Key in Brilliant and search
4. Brilliant Assessments will be top of the list (being the only brilliant add-in there :-)
5. Word will add the add-in to your home page menu.  

Once you have downloaded the Word app and invoked it you will be asked to log in.

1. The Site Code appears on your Site settings screen.  It is usually your subdomain from your URL.
2. The Username is the same as what you use to Login to Brilliant Assessments.
3. The Password is the same as what you use to Login to Brilliant Assessments.
4. Click Login 

Once you are Logged in the Addin 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.

If you are starting with a template or your own document you should 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 of the document so that the Merge Manager always know which report this template is linked to.  You can also download the report in the Assessment Feedback Report form or the Cohort Report Manager form, and then open the downloaded document in Word. 

1. Select the report Type, Feedback or Cohort
2. Select the Assessment Report you wish to download (if you chose Feedback in (1)) or the Cohort Report  (if you chose Cohort in (1)).
3. Click Download to Word.

The document will then open in a separate window and the Merge Manager will open the Merge Manager Tab.

Using the Merge Manager Tab you can.

• Review an existing merge string in the document. If you click anywhere in the merge string within the document, the Merge Manager will display all of the parameter options for the merge string. You can modify it if required.  Note: this behavior can be stopped by switching off the Auto-Select switch on the Merge Manager tab.
• Add a new merge string by positioning the cursor where it is required and then selecting the required merge string and parameters required.

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

Start by Selecting a Merge Type by Click on that list:

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

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

1.  The selected type for the merge string.  If you select a different merge string, all of the previously selected parameters will be reset.
2. If the merge type has this option, you can select the level that you want to show 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. As Subsections are being shown,  you are prompted to specify the Section (with all the sections in the assessment listed) or All Sections.
4. As Subsections are being shown,  you are prompted to specify the Subsection (with all the subsections in the assessment listed) or All Subsections.
5. Display Percentages or Average Score (for Likert style reporting)
6. In this example, an advanced option has been selected, Display Labels.  The advanced options are added as they are selected.  They can easily be removed using the X Icon.
7. The Select Advanced allows you to select all of the other parameters available for this merge string.  Refer to the Vertical Bar documentation to understand each parameter's function. 
8. The Merge string is built as the options are selected in the Merge Manager.

To complete the merge string and continue editing the Word document, just click out of the merge string and continuing editing the document.

Once the document is complete you can either:

• Return to the Document tab of the Merge Manager and Save the Report Template to Brilliant Assessments.
• Save the document in Word, then upload it using the Assessment Reports screen or the Cohort Report Manager screen