The Ruleset Maintenance wizard helps you copy rulesets and ruleset versions into new versions, merge several ruleset versions into one version, move rules out of one ruleset into another, or change a ruleset version's number. Select the Designer Studio> System >Refactor > RuleSets menu item, then click Copy/Merge RuleSet to start the wizard.
Operations of this wizard depend on the Pega-RuleRefactoring agents. If you use this wizard, confirm that the Pega-RuleRefactoring agents are enabled on at least one node of your system.
To move a ruleset, select an existing ruleset and specify a target name and, optionally, a version. The wizard processes the source rules in each ruleset version in the ruleset and any non-versioned rules associated with the ruleset. The RuleSet and RuleSet Version fields of each rule are updated to the values specified as the target. The result is that the rule appears to have been deleted from its source ruleset and copied into the target ruleset. The value of the rule's pzInsKey does not change.
The handling of multiple ruleset versions in the ruleset depends on whether you specify a target version:
For example, if you move a ruleset containing rules with ruleset versions 01-01-01, 01-01-02 and 01-01-03 into a new target ruleset and specify a version of 01-02-01, the target ruleset version will contain the highest version of all the source rules contained in versions 01-01-01, 01-01-02 and 01-01-03 with lower-versioned duplicates dropped. In this example, if a rule is duplicated in both 01-01-01 and 01-01-02, the rule will be moved from 01-01-02 to the new ruleset name with ruleset version 01-02-01, and the duplicate rule in 01-01-01 will be dropped.
When you move a ruleset, the wizard also updates the references to affected ruleset versions in the following rules or data instances anywhere in the system, so they reference correctly the versions that exist after the move:
|
|
You cannot copy a ruleset.
Copying a ruleset version performs the same function as the Save As toolbar action. The original source ruleset version does not change. Each target rule that is created is identical to the original source rule with the following exceptions:
As with moving a ruleset, moving a ruleset version changes the source rules. The wizard updates the RuleSet Version fields of each rule to the values specified as the target. The result is that the rule appears to have been deleted from its source ruleset version, and copied into the target ruleset version. In a move, the value of the rule's pzInsKey does not change.
You can merge multiple source ruleset versions belonging to the same or different rulesets. For example, you can "skim" the ruleset by collecting only the highest version of every rule in the ruleset versions into the target, or you can compress the rulesets down to a lower level (01-01-01) or another designated level. You control the merge by specifying the target version and the order in which the ruleset versions will be processed.
When you select the ruleset versions, you establish the order of precedence by the order in which you list them in the wizard interface. The wizard processes the rules in the order listed, top-to-bottom, collects the first version of every rule it finds, and drops other duplicate rules:
Note: Compress rulesets with prerequisites beginning with the ruleset of least dependency. For example, if ruleset A requires ruleset B as a prerequisite, and ruleset B requires ruleset C as a prerequisite, then you should compress the ruleset A first, then B, and finally C. If you compress the rulesets in the order C, B, and A, you risk losing some rules that you expected to retain.
When you merge rulesets or ruleset versions, you have the option of deleting the sources once the merge is complete. However, if you merge ruleset versions and opt to delete the sources, the source versions are deleted, but not their ruleset(s).
When you merge ruleset versions, you have the option of excluding categories of non-versioned rules. The categories are listd at the bottom of the form. Clear the check box to exclude a category.
Note: When you select Libraries and Functions from the list of non-versioned rules, all functions are merged when the ruleset name has changed. When the ruleset name is the same and only the version has changed, functions are treated like versioned rules and only patch functions are merged.
For an example of the merge operation, see PDN article How to merge RuleSets using the RuleSet Maintenance wizard.
You can change the version number for a particular ruleset version, whether or not the version which you designate as the new number already exists. The target version belongs to the same ruleset as the source version. All rules, including non-resolved rules, from the source ruleset version become part of the target version. All rules retain their original pzInsKey values, and therefore retain their History.
When the change is complete, the wizard deletes all rules in the source version.
For move, copy, and change operations, you can specify how to handle conflicts if the same rules are found in both the source and the target. You can choose to overwrite the target rules with the source rules, or to not move or copy the source rules that conflict, leaving the target rules unchanged. If you choose not to overwrite the rules, the Summary page of the wizard lists the rules in the source that were skipped because they were in conflict with the target.
The wizard does not change rules that belong to locked ruleset versions. If a ruleset version that will be changed by the wizard operation is locked, you are prompted for the password to unlock the version before proceeding. To copy a ruleset version the target rules cannot be locked. The source rules can be locked, since they are not changed by the copy operation. To move a ruleset or ruleset version, both the source and target rules must be unlocked.
As a best practice, make sure that all rules are checked in before you move or copy a ruleset or ruleset version. Select Designer Studio> Application > Development > Checked Out Rules. Complete the parameters and click Run. Review the resulting report to confirm that no rules from that ruleset version are checked out.
If the wizard encounters rules to be modified that are checked out, it displays a warning page and provides a report of the checked-out rules. From the report window you can open the rules and check in the ones for which you have permission, or save a list of the rules in a spreadsheet.
You must check in any rules you have checked out or arrange for any rules in the report that are checked out by other users to be checked in before you can complete the wizard. If you exit the wizard to arrange for rules to be checked in, you must restart the wizard from the beginning.
The wizard automatically adjusts any references to ruleset versions in the following rules or data instances, system wide, to match the versions that exist after a merge or move:
Before running the RuleSet Maintenance wizard, consider the following guidelines:
When you are working with ruleset versions, the Copy missing RuleSet Prerequisites check box appears at the bottom of the first form of the wizard. Check this check box to have the wizard copy any prerequisite rulesets that the ruleset version that results from your process will require.
Select the Designer Studio >System > Refactor >RuleSets menu item, then click Copy/Merge RuleSet to start the wizard. Then select the operation you wish to execute.
For help in completing the first form, see RuleSet Maintenance wizard.
This wizard does not modify references to rulesets that are deleted or modified. Repair any references to rules that have been moved by the wizard by replacing references to the source ruleset with the target or another ruleset. In particular,
- Application RuleSets section on the General tab
- Component and Shared RuleSets section on the General tab
- Production RuleSets section on the General tab
Before merging the rulesets, the tool creates a backup of each rule named Bkup_SourceRuleSet.zip and Bkup_TargetRuleSet.zip. If needed, you can use the Import .zip facilities to recover the original rulesets.
Each execution of this wizard creates an instance of the Log-Merge-RuleSet class, including error messages or other results. The key to this instance is the date and time the wizard was started.
Notes:
Class rules do not have a version. Do not delete Class rules (or other rules that have no version) if any version of the ruleset remains in use.
In some organizations, audit or compliance policies might prohibit deleting old rules, even if they are not in use.