Rule Naming Requirements and Conventions
When creating rules, ensure that assigned names meet the minimum requirements, and consider implementing additional conventions to help users peruse, locate, and understand rules.
Rule Name Requirements
- Each rule within a ruleset must have a unique name.
- A rule should not have the same name as a function.
- User-Defined Variables (UDV) names cannot contain spaces.
- Rule names cannot contain spaces.
- Rule names cannot contain double or single quotes.
- Rule names can only contain alphanumeric characters and underscores.
- Rule names cannot start with a number.
Rule Name Conventions
- Consider creating a set of standards for your rule writing team to adhere to when naming rules. This will help your organization maintain rule naming consistency.
- Make rule names as descriptive as possible while keeping the names concise for ease of view on the page. Attempt to keep the rule names to 15-20 characters. The maximum number of characters allowed is 256.
- Avoid renaming rules as this may cause confusion to other rule writers.
- Use the rule description area assigned to each rule to enter additional comments about the rule. Also, when you check in a rule in a versioned repository, you can add information about the changes that were made to the rule syntax.
- Consider using underscores or mixed case to distinguish parts of the rule name.