Text & Media element type
The Text & Media element type is used to add a heading or free text to a survey report. You can also add tables, images, and videos. The element auto-grows to any height so you can add as much text and images as required.
To add a Text & Media element, complete the following steps:
- Edit an existing report or create a new report.
- Add an element or select the Text & Media element that you want to edit.
The properties pane will open on the right side of the page.
Text
- Title — The heading or title of the element. You can optionally hide it.
- Short name — By default, the title of an element is used in the element list (table of contents) on the left side of the report. If the title is long, it will get cut off in the list. In that case, enter a short name here and it will be used in the element list instead. The short name is also shown at the top of the properties pane.
- Comment — The body text of your element. The area provided to type is not large in the properties pane. Click the expand icon to get a larger work area. You will also see a lot more options on the toolbar including tables and the Variables dropdown. You can also use scripting language to add calculations or show different texts depending on values in the element and report.
Style
- Width — Set the width of the element to the full report width (100%), only half of the report screen, one third, etc.
- Title — Show or hide the title at the top of the element.
- Comment — Show or hide the comment in the report. Hiding the comment from the report lets you use it for internal information that's not shown in the report itself.
- Custom CSS class — Use this in combination with the Report style options to further customize the look of this element
- Custom text style — Change the font, size, and alignment for the different parts of this specific element. If you want to apply a different font, size, or alignment for the entire report, use the Global Style settings for the report by clicking the cogwheel icon.
- Custom element style — Select this box if you want to use a background color and/or border color that's different from the report style. If you want to apply this style to the entire report, use the Global Style settings for the report instead.
Differentiated content
Sometimes in a report, you want to show different content depending on the results of the survey. This is often the case if you will be creating shares for different groups in your organization using share filters.
Consider an employee satisfaction score on a scale of 1 to 10 as an example. You will produce a department-level report that you will then share with each department with the data filtered to only show their department and a benchmark of the whole company.
Given the above situation, you would like to include a section in your report with tips for departments with a score that is lower than the benchmark. We call this a Gap analysis, the gap being the difference between the benchmark and the score of the department. We do not want to show the tip to departments with a higher score than the benchmark.
To do this, we will need to use the CheckMarket Scripting Language (CSL).
A good trick is to write down what you want to do in words before you translate it into CSL. For instance:
"If score is less than benchmark then show tip."
In CSL, this would look as follows:
{{#if (lt report.elements.id-1.statistics.1.avg report.elements.id-1.statistics.2.avg)}}
Tip text goes here!
{{/if}}Some translations:
- lt — 'less than'. We want to check if the first value is lower than the second value.
- report.elements.id-1.statistics.1.avg — This is sort of a cascade from the top so read this as, Report > Elements > Element with id '1' > Statistics > First Data Source > Average.
- report.elements.id-1.statistics.2.avg — Only difference with the first item is the '2' which means the second data source, in this case the benchmark.
