Skip to main content

Adding usage information to a rule

Suggest edit
Updated on November 29, 2021

Add usage information to a rule to help developers decide whether they can reuse the rule in their features or applications.

As a best practice, provide usage information when you create a rule.
  1. Open a rule by searching for it or by using the Application Explorer.
  2. Click the History tab.
  3. In the Documentation section, enter text in the Description field that describes the purpose of your rule.
  4. In the Usage field, enter text that helps developers understand how to use this rule.

    For example, you can describe the expected inputs and outputs.

  5. Click Save.
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us