Module Settings – Manage Text Replacements

Performance Module Administration, Persistent Module Administration

Text replacements can be used by reports to allow report designers (Overlord or above) to create more generic reports that report administrators (Overseer, Proctor) can then override to customize as needed. They don’t function like a find/replace tool, so much as a dynamic variable that can be re-used throughout reports. A text replacement item can be defined at the Organization level, the Module level, or even when designing a report (i.e. only for use in that report).

 

After creating a text replacement, you can reference it by name using the format @d_[Name] in any report element that supports free text, such as column labels, Text element, chart labels, etc. Currently in Detail Data Grids and Detail Data Charts, these replacements are only supported in headers (not the results).

 

For example, you (as report designer) can create a text replacement named “Attribute1” with a default value of “Grit”. Then, a report administrator can reference the “@g_Attribute1” item but choose to display the word “Toughness” using the overlay designer.

 

Existing Text Replacement items

  • Any existing Organization or Module replacements will be displayed, grouped accordingly. 
  • You can easily see any reports using the text replacement item (References), and Revert an override value, Edit or Delete an item from here. 
  • Once a text replacement has been referenced by a report, it cannot be deleted or renamed. However, the label (what the administrator sees) can be changed. 
  • The default value will be used when there is no override from a report administrator.

 

New Text Replacement

Click the green ‘New Text Replacement’ button to create a new item.

  • Label … This is an internal label for your reference. It is displayed in the report designer (when adding from a dropdown list).
  • Type … Decide if you want the text replacement to be made available Organization-Wide (any Module) or just for reports in this Module. 
  • Name … As you type, the Parameter displays what the end result will look like. Names must be unique within the organization and cannot contain special characters or spaces.
  • Default Value … This is the text you wish to display wherever you insert the Parameter Name in a report.
  • Overridden Text … If a report administrator sets up a report to override a text replacement value, the override value will be displayed here.

 

See Report Design 5: Overlays and Text Replacements

 

= = = = =

Version(s): GideonSoft 2024 Release 1 and later