Skip to main content

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

Specifying the content of a product rule

Updated on July 8, 2022

Specify the applications, rulesets, instances, and .jar files to include in the product rule.

You can include an entire application in a product rule, or you can individually select the rules and data to include.
  1. On the Product rule form, click the Contents tab.
  2. Optional: To include an entire application in a product rule, under Applications to include, enter the application Name and Version. You can specify more than one application. Use the check boxes to modify the application contents.
    1. To include application data, select the Include associated data check box.
    2. To include production rulesets, select the Custom/Production rulesets check box.
    3. To include shared rulesets, select the Shared/Component rulesets check box.
    4. To include all versions of the application in the product rule, select the Delta mode check box. To include only the current version of the application, clear the Delta mode check box.
      Note: If you select Delta mode, some of the ruleset versions (instances of the Rule-Ruleset-Version rule type) might be excluded from the archive. During the application import process, if these rules are missing both from the system and the archive, the system adds a warning to the log file. If a required rule is excluded, correct and reimport the product rule.
    5. To include comments that are included during rule check-in, select the Include rule history check box.
    6. To include the instances of the custom data types (classes) that are associated with this application, select the Include data types check box.
      If you select this check box, data types are exported regardless of whether they are associated with a ruleset in the application.
    7. To update dependent applications so that they are built on the latest version of the application, select the Update dependent applications check box for each built-on application.
      When you import the generated archive, you can automatically update dependent applications that are built on an earlier version of the application to use the latest application version. For more information, see Updating dependent applications with the latest versions of built-on applications.
  3. Optional: To include only a specific ruleset in the product rule, under RuleSets to include, enter the ruleset Name. You can specify more than one ruleset. You do not need to specify any rulesets that are part of the applications that you specified in the step above.
    1. To filter the ruleset by version number, enter a Minimum version and Maximum version; otherwise, the ruleset includes all versions.
      To create a product patch, which is a .zip file containing a single version, enter the same patch version (NN-NN-NN) in both fields.
    2. If you do not filter the rulesets by version number, and you want to exclude rule types that are associated with a ruleset but not with a version, select the Exclude non-versioned rules check box. By default, non-versioned rules are included.
      These non-versioned rules include the following:
      • Access Deny rules ( Rule-Access-Deny-Obj rule type)
      • Access of Role to Object rules ( Rule-Access-Role-Obj rule type)
      • Application rules ( Rule-Application rule type)
      • Connect rules (for example, Rule-Connect-SOAP rule type)
      • Class rules ( Rule-Obj-Class rule type)
      • Ruleset name rules ( Rule-RuleSet-Name rule type)
      • Rulesetversion rules ( Rule-RuleSet-Version rule type)
      • Service rules (for example, Rule-Service-SOAP rule type)
      Note: Exclude non-versioned rules overrides the settings in the Global exclusions section.
    3. To include data instances, such as access groups, class groups, and integration resources, select Include Associated Data.
    Result: The Application Context field displays the name of the application that the Import wizard uses to validate the contents of the specified ruleset.
  4. Optional: To exclude classes of rules from the rules specified in the Applications to include and RuleSets to include sections, complete the Global exclusions section.
    Note: During the application import process, if required rules are missing from both the system and the archive, the system adds a warning to the Pega log.
  5. Optional: In the Class instances to include section, identify class instances to include in the archive.
    1. In the Name field, enter the class that you want to include in the archive. You can include instances from any class, but typically this is used for data classes such as access groups, organizations, and so forth. For abstract classes, include the final hyphen in the name.
    2. Select to include instances from descendant classes or to include only class instances that meet specific criteria.
    • To include instances from descendant classes, select the Include descendants? check box. You can exclude particular descendants by entering their names in the Exclude classes field. You can specify more than one class name by separating each name with a comma.
    • To filter the class instances to include only those instances that meet criteria defined in a report definition rule, enter the report definition rule in the Report Definition Filter field.
    • The report definition that you use as a filter requires to include the pzInsKey property.
    • Product rules created in Pega Platform versions 8.3 or earlier, use ListView rules or When rules instead of Report Definition rules to filter class instances. It is best practice to use the Report Definition rule filter instead of the ListView and When rules. Using a When rule filter significantly degrades export performance and ListView rules are deprecated.
    • Carefully consider any dependencies among data instances or between data instances and your rules. These data instances might require adjustment after they are uploaded into the destination Pega Platform system.
    • Agent schedule instances include node IDs which are system-specific; do not include agent schedule instances in a product rule if you plan to export the product rule to another system.

    For more information, see Report definitions.

  6. Optional: To include an individual instance that is not in the applications, rulesets, and class instances that you have already listed, select the instances in the Individual instances to include section.
    Note: The system imports the instances in the order in which you list them. The order is important if your application includes views that reference each other. Listing the view instances in the wrong order can create dependency tree errors.

    Additionally, you cannot list instances of data objects in this section. To list instances of data objects, use the Class instances to include section.

  7. Optional: To include a .jar file in the product rule, enter information in the Jar files to include section.
  8. Edit the File details to update the creation date and short description of the product rule.
    1. To include unlocked rulesets, select the Allow unlocked ruleset versions? check box.
      By default, the product includes only locked rulesets.
  9. Click Save.

    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