What is the proper text we need add in Documentation -Description - Usage
What exactly we need to add in Documentation tab for any rules. Any standards or guidelines while writing Description - Usage.
Accepted Solution
Pegasystems Inc.
US
Hi Pravin,
Please check the following pdn link:
https://community.pega.com/sites/default/files/help_v718/procomhelpmain.htm
===== Using the History tab of a rule form :
Use the History tab of a rule form to define custom fields, review or restore history snapshots, and maintain usage details. History snapshots are instances of the History-Rule class.
Documentation
Hi Pravin,
Please check the following pdn link:
https://community.pega.com/sites/default/files/help_v718/procomhelpmain.htm
===== Using the History tab of a rule form :
Use the History tab of a rule form to define custom fields, review or restore history snapshots, and maintain usage details. History snapshots are instances of the History-Rule class.
Documentation
Complete the fields in this section to indicate how this record is used by other application users:
◾Description — Enter text describing the purpose of this record. For class rules, you cannot leave this field blank. Special syntax is supported by list view and summary view rules.
◾Usage — Enter guidance to users of this rule, for example, design-time instructions or special run time considerations. For deprecated rules, this field populates warning messages to other users. As a best practice, describe why the rule is deprecated and provide at least one migration path or alternative.
Thanks,
Susan
J.P. Morgan Services India PVT Ltd
IN
Hi,
Couldn't found a proper document for it.
But, As the name indicates it, description includes a small summary of the rule and the usage can be defined as the operations perform by it. Check some default pega rules for more understanding.
Below link can provide some help:(check the other links in left navigation menu)
Accepted Solution
Pegasystems Inc.
US
Hi Pravin,
Please check the following pdn link:
https://community.pega.com/sites/default/files/help_v718/procomhelpmain.htm
===== Using the History tab of a rule form :
Use the History tab of a rule form to define custom fields, review or restore history snapshots, and maintain usage details. History snapshots are instances of the History-Rule class.
Documentation
Hi Pravin,
Please check the following pdn link:
https://community.pega.com/sites/default/files/help_v718/procomhelpmain.htm
===== Using the History tab of a rule form :
Use the History tab of a rule form to define custom fields, review or restore history snapshots, and maintain usage details. History snapshots are instances of the History-Rule class.
Documentation
Complete the fields in this section to indicate how this record is used by other application users:
◾Description — Enter text describing the purpose of this record. For class rules, you cannot leave this field blank. Special syntax is supported by list view and summary view rules.
◾Usage — Enter guidance to users of this rule, for example, design-time instructions or special run time considerations. For deprecated rules, this field populates warning messages to other users. As a best practice, describe why the rule is deprecated and provide at least one migration path or alternative.
Thanks,
Susan