Report Design 5: Overlays and Text Replacements

Reports

Report designers with Overlord or higher permissions can set overlay options on one or more items, enabling report administrators without advanced report design experience or knowledge (those with Proctor, Data Proctor or Overseer permissions) to override and customize labels and text. 

 

For example, a report designer can make the visuals or report sections customizable so the report administrator can change “Grit” into “Toughness”. 

 

 

The Overlay Process 

 

Configuration … The report designer designates which items can be modified. 

  • When editing a report with one or more overlay options enabled, people with permission sets of Overlord and above will be prompted to select ‘Overlay Designer’ or ‘Advanced Designer’ mode. (See below for differences between these modes.)
  • If someone has made changes to override items within a survey, using the Advanced Designer may revert those properties. A warning message will be shown when editing an item with overrides modified.

Administration … The report administrator customizes the designated item(s), before making it available to people in the Instance. 

  • People with Proctor, Data Proctor or Overseer permission sets have access to survey design, but only Overlay Design mode. 

 

 

Overlay Designer vs. Advanced Designer modes

 

Overlay Designer mode displays the survey in a kind of preview mode. There are no pages, and page breaks are shown similar to the PDF Export. Other differences:

  • There is a fixed header at the top of the page with buttons to navigate up/down to each overlay item.
  • You can toggle ‘Show Only Items to Review’, to streamline this part of the process.
  • When done editing, there are buttons for Preview, Publish and return (or exit; this does NOT cancel or undo changes). When Publishing, you’ll be prompted to Preview it, and have the option to schedule the report, as well as set reminders.
  • Overlay changes are saved at the item level, though you can always revert each item to its original design. 
  • Sections have a header to describe who will be the target for the section (and an edit icon if it can be overridden).
  • Items that have no overlay settings are dimmed.
  • Icons indicate which items can be adjusted. If a question is hidden via overlay, an eye-slash icon will be displayed.

Advanced Designer mode has no restrictions, so all options are available to add, edit and design.

 

Text Replacements

 

Text replacements can be used by reports to allow report designers (Overlord or above) to create more generic reports that report administrators (Overseer, Proctors) can override. See Module Settings – Manage Text Replacements

 

 = = = = =

Version(s): GideonSoft 2024 Release 1 and later