Text Substitution

You can make the description and message text for glossary items more specific by using text substitution. Text-substitution messages enable variable text to be inserted into the glossary text at runtime. Text substitution provides a method to display the same basic message with some values that vary. For example, suppose a user enters an invalid search type in a field. The following error message appears: "Search type xx is not contained in the 00 ST table." The xx in the message will be replaced by the search type the user entered.

Text-substitution uses placeholders in the glossary text for values that will be substituted at runtime. The placeholders are indicated by an ampersand (&) and a number to mark the places where substitutions are to occur. For example, in the message "Batch &1 is out of balance by &2," the system replaces &1 with the actual batch number and replaces &2 with the amount that the batch is out of balance. The &1 and &2 placeholders indicate where the message text can vary each time that the message appears. Text-substituted values are defined by data dictionary items in a data structure. The data structure is associated with the glossary item using different methods, depending on the glossary type.

You can create text substitution glossary text for the following glossary types:

• Interactive error, warning, and information messages.

• PPAT Level messages (Batch messages and workflow messages).