Upgrade considerations for existing messages
|
Newly created instances of Rule-Message now have two key parts and additional metadata. Use this topic to determine how these changes impact your existing messages and rules that rely on messages, after an upgrade, update, or migration.
When you upgrade, the system automatically adds an applies to key part of @baseclass to existing messages, unless the value of pyClassName is set to a valid class name. In this case, the message is not updated and the existing value of pyClassName is used during rule resolution.
Similarly, when you use the Import Wizard to add an archive of messages, the system automatically adds an applies to key part of @baseclass if pyClassName is not set.
New messages are categorized, as specified by the pyCategory property. Available options include: Alert, Error, Tip, and Warning. After you upgrade or import an older message, it has a blank pyCategory.
As a best practice, manually update your messages to use one of the standard category values. Otherwise, these message can unintentionally appear in SmartPrompt results and lead to confusion.
The following features prompt for instances of Rule-Message:
For guidance on how to select a category, see Completing the Definition tab of the Message form.
Activities that use Property-Set-Messages or Page-Set-Messages steps can pass a message name as a parameter. If you previously specified a Page value in these steps, the class of this page is now used to find the appropriate message name specified in the Message field. If you did not specify a Page value, the system uses the class of the step page, or primary page if no step page is provided, to find the message.
As a best practice, review activities in your application that add messages, to verify that you have specified Page values that lead to intended results. Additionally, review any Java activity steps that call the deprecated addWarning function. Use the pxAddGuardrailMessage function instead.
For guidance on how to use this function, see Working with messages.