How to extend the Message form

You can customize the available categories and fields on the Message form. You can also enforce additional validation logic when the message is saved.

For example, you can create a Borrower category that includes in the message a loan applicant's details, such as Risk Level, Financial Status, or Credit Score.

To customize the Message form:

1. Create a field value with the name of your custom category.

   You must specify Rule-Message as the class key part and pyCategory as the field name.

2. Create a second field value with the name of your custom category.

   You must specify Rule-Message as the class key part and pyCaption as the field name.

3. Use the Specialization form to create a circumstanced version of the Rule-Message.pyCustomDetails section.

   You must specify pyCategory as the single value property and the name of your custom category as the corresponding value.

4. Add properties in the Rule-Message class to your circumstanced section, using applicable controls and labels.

5. Use the Specialization form to create a circumstanced version of Rule-Message.pyValidateFields edit validate rule.

   You must specify pyCategory as the single value property and the name of your custom category as the corresponding value.

6. Add criteria to your circumstanced edit validate rule that evaluates the property values provided by your circumstanced section.

At design time, your custom category name appears in the Category field on the Definition tab of the Message form. When you select the custom category, your circumstanced section appears next to the Category field, prompting for additional fields.

When you save the message, the validation logic in your circumstanced edit validate rule is processed. Any failures appear in the message rule form header.

You can use standard functions to retrieve the text of your message, along with the values of any properties used in your circumstanced section.

About the Message form Circumstances — Concepts and terms Completing the Specialization form Completing the Parameters tab of the Message form Completing the Definition tab of the Message form

Open topic with navigation