Updating legacy messages and related rules

You can update your legacy messages so that they are compatible with the latest definition of the Rule-Message class. By providing values for the new properties that all messages must support, you can ensure that your legacy messages and the rules that rely on them continue to function as expected.

Note: The following steps apply only to messages that were created in Pega Platform version 7.1.6 or earlier.

  1. Find the messages that are in your application.

  2. In the Instances of Message list, click the Category column to sort the results.

  3. Ensure that all messages are assigned a category, because blank values in user prompts can lead to confusion or unexpected results.

    Repeat the following steps for all messages that do not have a category defined:

    1. Click a message in the list to open the Message form.

    2. In the Category list, select an option based on the type of information in the message and the expected response from the user.

      For more information about the supported categories for messages, see Standard categories of messages.

    3. Click Save.

    4. Close the Message form to return to the list of results.

  4. Click the Class Name column to sort the results.

  5. Review the messages in the @baseclass class and decide whether they can stay in this class or require a different scope.

    You can change the scope of a message by creating a new version in a different class. For more information about creating rules, see Creating a specialized or circumstance rule.

  6. Update the activities that are affected by the latest definition of the Rule-Message class.

    1. In the search tool, select the All Content and Contains options to find and open activities that use the addWarning function, Property-Set-Messages method, or Page-Set-Messages method.

    2. On the Steps tab of the Activity form, replace references to addWarning with pxAddGuardrailMessage, because this function is deprecated.

    3. Expand the steps that set a message.

    4. For each step, verify that the class of the page in the Page field is the same class as the message the activity sets, because your application uses this class to find the correct version of the message at run time.

      If there is no value in the Page field, you can provide one or leave it blank to instruct your application to use the step page at run time.

    5. Click Save.