Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Comparing rules by system

Updated on November 18, 2021

You can use the Rulebase Compare wizard to identify differences in the rules present on two Pega Platform systems. For example, you can use the tool to confirm the success of a product migration between systems, or to identify the changes needed to synchronize two systems.

Starting the tool

Select ConfigureSystemRefactorRuleSetsRulebase Compare to start the wizard. For instructions on the form, see Using the Rulebase Compare tool.

You specify the target system and the RuleSet or a Rule-Admin-Product rule to compare. The same RuleSet or Rule-Admin-Product must be on both systems. The comparison processing is performed on the system on which you are running the Rulebase Compare wizard.

Using the Rulebase Compare wizard — Step 1: Enter System Info

Use this wizard form to specify the target system for the rule base comparison.

Complete the following fields to specify the system you want to compare to your current system.

Select a SystemIf you previously saved a target server definition, select it from the drop-down.
Host NameTarget server host name.
PortThe TCPI/IP port number for SOAP connections on the target server. Often this is port 80.
Context Root Target server context root name for the Pega Platform application.
HTTPS?Select if the port requires an HTTPS (Secure Socket Layer) connection.
SaveClick to save this system specification for future use. Saved specifications appear in the Select a System drop-down the next time you use this wizard.
UsernameEnter a valid operator ID for the target server.
PasswordEnter the user password for the operator ID you specified.
Next >>Click to continue to the next step of the wizard.
CancelClick to exit the wizard.

Using the Rulebase Compare wizard — Step 2: Select Instances

Use this wizard form to specify the ruleset or product that defines the set of rules you wish to compare.

Note: If you are comparing products, make sure both product rules you are comparing include all the rulesets that you want to compare.
Specify Collection Method Select the type of rule collection you want to compare: RuleSet or Rule-Admin-Product.
Select Rule Admin Product Parameters If you selected Rule-Admin-Product as the Collection Method, complete the following fields:
NameSelect the product rule on the current system that you want to compare with the target system.
Version Select the version of that Rule Admin Product that you want to compare.
Select RuleSet Parameters If you selected RuleSet as the Collection Method, complete the following fields:
Click the insert row icon to add a row of ruleset parameters. Add a row for each ruleset you want to include in the comparison.
RuleSet NameSelect the name of the ruleset on the current system that you want to compare to the target system. Choose a ruleset that is present in both systems.
Minimum Version, Maximum VersionSelect the minimum and maximum ruleset versions of the ruleset you have selected to compare with the target system. The version range must match ruleset versions on the target system. If you do not specify a range, all versions are assumed.

Using the Rulebase Compare wizard - Step 3: Display Summary

The Parameter Review form displays your target system specification and the rulesets or product rule you have chosen to compare.

Review this information to make sure you are performing the comparison you intend to.

Using the Rulebase Compare wizard — Step 4: Display Report

The Synchronization Report lists the rules, rulesets, and ruleset versions in which differences were found between the source and target systems. For each rule the wizard identifies the action to be performed on the target system to make it match the source system.


The wizard identifies the following types of actions:

  • Add – Rules that appear on the source system but that are missing on the target system. Add these rules to the target system to match the source system. The system determines additions and deletions by comparing values of pzInsKey, the permanent handle of a rule.

  • Delete – Rules that are not on the source system but that are found on the target system. Delete these rules from the target system to match the source system.
  • Update – Rules that have a different time stamp ( pxUpdateDateTime ) on the source system than on the target system. The wizard only identifies a difference in the update times between the systems for these rules; the report does not indicate which is more recent. Compare these rules on the two systems to determine whether you want to preserve the change in the most recently updated rule or use the older rule without the change.

Do not assume that rules with the most recent pxUpdateDateTime values correspond to the highest version. Rules in any version can be updated at any time.

Click Export to Excel to save this listing in a spreadsheet.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us