User-Defined Best Practices
Table of Contents
Create your own best practices to analyze your packages:
You can now create your own rules to run through the rules engine of the Best Practice Analyzer. The rules you create here will be available in the Best Practice Analyzer, and can be run alongside the pre-installed rules.
1. Open the Best Practices feature from Pragmatic Workbench.
2. You will be greeted with the Best Practices Dashboard. From here select Create / Modify Best Practices.
3.This will take you to the User Defined Best Practices, from here you can manage existing rules.
4.To add a new rule you will click the blue plus sign from the tool menu on the top left.
5.After clicking the add rule button, you will be given several fields to populate
6. Enter a Rule Name.
By default, when you save your custom rule for the first time, it will be used as a suggestion for the file name. If there are characters that would be invalid for a file name, you will have the opportunity to name the file something different. The Rule Name is important to identify the rule within the creator, as seen below.
7. Enter the Author's name or team designation.
8. Enter a Reference URL.
This field should provide the user with a link to an external or internal website that includes detailed instructions for resolving the best practice violation.
The current date is automatically populated.
10. Choose the severity of the rule.
You may choose from Error, Warning, Informational, or Performance. This dictates what category the rule will display in the Best Practice Analyzer.
11. Enter a message.
This field will be displayed in the Best Practice Analyzer's rule selection page.
12. Enter a Recommendation.
This field describes how to correct the violation, and is shown as a tool-tip on the Best Practice Analyzer's rule selection page, and as a column in the Results.
13. Object Type Filters.
The filters set will appear after building a path evaluator.
14. Path Evaluator.
To create a path you can use the path builder button located on the right of the field.
15.Once completed, click the save button from the toolbar.
Managing Your Rules:
Once you have rules created you will be able to manage them from the same page. You can delete existing rules but keep in mind that if you delete your rule from this list, it will be deleted from the file system as well. However, if you have saved the rule to your "Shared Rule set" at any point, it will be persisted on the database. You may also choose to save your rules as a new file, this is convenient for creating copies of a rule to edit.