Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Packaging your application in a product rule

Updated on April 5, 2022

Use product rules to migrate or deliver an application to another Pega Platform systems. Product rules identify the rulesets and versions, rules and data objects, and other parts of an application. Define a product rule to specify what to include in the archive. Then use one of the other tools to create the product rule.

After you define the contents of a product rule, you can generate a .zip file that contains the following items:

  • Rules in rulesets and versions for a specific application
  • Rules in selected rulesets and versions
  • Instances within any class
  • A post-deployment action that displays Read Me information

Using a product rule is the best practice for packaging applications. You can do any of the following with a product rule:

  • Export multiple applications
  • Export dependent rulesets that are outside of your application
  • Include sample data
  • Specify whether to include history, snapshots and memos

The following tools work with product rules or .zip files:

Use the Records Explorer to list all the product rules that are available to you.

Product rules are instances of the Rule-Admin-Product class. They belong to the SysAdmin category. Product rules are sometimes informally called RAP rules.

Product rules are rarely referenced by other rules. When searching for a Product rule, the system does the following:

  • Filters candidate rules based on a requestor's ruleset list of rulesets and versions.
  • Finds circumstance-qualified rules that override base rules with the same key.

Class-based inheritance does not apply. Time-qualified resolution features are not available for Product rules.

By default, the product rule contains instances of the following data classes, which are part of the application you are packaging:

User Database
  • Product rules

    Use the Application Packaging wizard to package an application in a product rule for export to a .zip file or migration to another server.

  • Creating a product rule of test case data by using the Package Work wizard

    To migrate small amounts of case data, use the Package Work wizard to create a product rule that contains case data generated when the application executes. This case data can include work items, assignments, history, bugs, documents, and attachments. After you create the product rule, you can transfer the application to multiple systems.

  • Creating a product rule that includes associated data by using the Create menu

    To include associated data in your product rule, use the Create menu to individually specify the contents of a product rule for an application or for work. When you use the Create menu, you can specify one or more applications, one or more rulesets, or individual rule instances to include in the product rule.

  • Editing a product rule

    Customize the product rule to specify contents, dependencies, deployment options, and history entries.

  • Previewing and creating the archive file for a product rule

    After you configure and save your product rule, preview the contents of the archive and generate the archive file.

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