Product rules
Completing the Contents tab

Field

Description

Identify an application name, the first key part of an application rule.

Optional. Select if you want to include the Custom/Production rulesets listed in this application rule in the product archive.

Optional. Select if you want to include the Shared/Component rulesets listed in this application rule in the product archive.

Optional. Select if you want to include only the patch version of the rulesets that comprise the application rule, in the ZIP archive. For example, if you select this field when your application references OrderEntry:02-03-05, the ZIP archive file produced from the product rule will only include the rules in OrderEntry:02-03-05.

Note: If you select this field, the system may exclude some of the ruleset versions (instances of the Rule-Ruleset-Version rule type) 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 Pega log. In the above example, the system will exclude all the ruleset versions from OrderEntry:02-03-01 through OrderEntry:02-03-04.

Field

Description

Identify a ruleset.

Optional. Enter a version number at any level — major( NN), minor (NN-NN), or patch (NN-NN-NN).

If you do not enter a value in the Maximum RuleSet Version field, the ranges include from and including the minimum up to and including the highest version. For example, entering a minimum of 01-01-01 includes all instances from this version through the highest version 01-02-10.

Optional. Enter a version number at any level — major( NN), minor (NN-NN), or patch (NN-NN-NN).

If you do not enter a value in the Minimum RuleSet Version field, the ranges include from and including the maximum down to and including the lowest version. For example, entering a maximum of 01-02-10 includes all rules from this version through the lowest version 01-01-01.

Some rule types are associated with a ruleset but not with a version. By default, these rule instances are included in the ZIP archive file when any version of that ruleset appears on the RuleSets to include array. Select this box to exclude these rule types. These include:

• 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: Rules not associated with a ruleset version are not included in the ZIP archive when you specify minimum and maximum RuleSet versions to include, as explained above.

Selecting this check box overrides the Global exclusions.

Some rulesets are Data instances such as access groups, class groups, and integration resources may be marked as part of the application through the Associated RuleSet field.

Some rulesets use Application-Based Validation (ABV) mode, which can reference all rules in rulesets defined in the same application and rulesets belonging to any built-on application. This field displays the name of the application used by the Import wizard as the context for validating the contents of the specified ruleset.

Field

Description

• Access
• Organization
• Services and connectors
• Database mapping

Consider carefully any dependencies among data instances or between data instances and your rules. During upload, data instances already present are by default not overwritten. These data instances may require adjustment after they are uploaded into the destination PRPC system. For more information, see the PDN article How to ensure that a product rule includes all parts of an application.

Caution: Don't include Agent Schedule data instances. The second key part of an Agent Schedule data instance identifies the node ID, a hash value that is based in part on the server name. Don't attempt to move an Agent Schedule data instance from one system to another by referencing it in a ZIP file; the node IDs of the other system will not match the node IDs on the source system.

You can include an Agent Schedule data instance in a ZIP archive that serves as a backup or snapshot, to be restored if necessary to the same system.

Notes:

You can enter System-User-MyRules to include links to delegated rules. Use a list view rule filter to determine which access group or operator delegations are included in the product archive. Make sure that access groups or Operator IDs referenced in these delegated rules links are present on the destination system.

If one Product rule is used repeatedly to create multiple ZIP archives, the data instances selected by the ListView Filter or When Filter values (see below) may vary, depending on how the rule is defined. In contrast, the data instances selected by internal key (listed in the Individual instances to include array) are always included.

Identify a class that contains instances to be included as part of your application or product. In addition to concrete classes, you can enter an abstract class that has concrete subclasses. For an abstract class, include the final dash (-) in the name.

Optional. If the Class is concrete and your filter criteria depends only on Single Value properties that are exposed as database table columns, complete this field.

Create and reference here a list view rule defined in the class specified in the Class field. In the Content tab of the list view rule, specify the instances of that class that are to be included as part of the ZIP file archive. Select the Read Only check box on that tab. Also ensure that the Report Source Activity is defined as GetContent and that the pzInsKey property is specified in the GET THESE FIELDS list.

You cannot use both a list view rule and when condition rule in one row of this array.

Leave the ListView Filter and When Filter fields blank to include all instances of the class.

Optional. If the Class is concrete and your filter criteria involves calculations or properties that are not exposed as database columns, complete this field and leave the ListView Filter field blank.

Select a when condition rule defined in the class identified in the Class field. In that rule, define the criteria that select the instances you want to include in the ZIP archive.

Note: For performance reasons, it is preferable to use the ListView Filter option when possible and leave this field blank.

You cannot use both a list rule and when condition rule in one row of this array.

Leave the ListView Filter and When Filter fields blank to include all instances of the class.

Optional. Select if you want to include instances in classes that descend from (are subclasses of) from the parent class entered in the class field. For example, if you enter Data-Address, instances of children classes Data-Address-Phone, Data-Address-Fax, and so on are included in the product.

Note: If you select this option, the ListView Filter and When Filter are ignored.

Caution: Select this box if you have entered an abstract class.

Optional. By default, all descendent classes are included when you select the Include Descendants? box. Use this field to enter the names of descendant classes you do not want to include. For instance, enter Data-Address-Email to exclude it as a descendant of Data-Address. You can enter more than one class using a comma (,) to delimit the names.

Field

Description

Optional. Identify a class that contains instances to be included as part of your application or product.

Click  Query   to see, in a new window, a list of up to 500 instances of the selected class. Select the instances you want to include and click OK.

Contains the short description of the instance selected from the query. This information is for others who review this rule and is not copied into the ZIP file.

Contains the internal key of an instance selected from the query. Do not alter these internal keys.

Field

Description

Enter text and click to search for JAR files with names that match the text.

Identify a CodeSet for the JAR file.

Identify a CodeSet Version.

Enter the JAR file name.

Field

Description

Optional. Enter a date in the format YYYYMMDD to include in the ZIP file and display on the destination system before the ZIP file is imported. The date value you enter persists even when the file is copied or renamed, which in some cases changes the Windows or UNIX file date. The value you enter is not edited.

Optional. Enter a text description of the contents of this file, to appear on the destination PRPC system before the ZIP archive is uploaded.

Note: Leave unselected in most situations. Select if you want to create an archive that can be imported into a v5.4 system or earlier-than-V5.4 system.

Caution: This setting is affects only the format of the output file; it does not assure backward compatibility of the contents of the file. While V6.2 is designed to successfully import ZIP archives that are created in lower releases, the reverse direction (V6.2 to lower releases) is not supported in general. Typically, rules or other objects created in a V6.2 system do not operate correctly in a V5.4 or earlier system, even if they can be imported.

If checked, the archives produced from this rule do not contain any schema change information, and use a V5.4 format.

If not checked, the archive uses a format that is not supported for import into pre-v5.5 systems.

Select to allow the archive to include ruleset versions that are not locked.

Click to review the contents of the product definition before exporting or migrating it.

The content displays in a separate window in the following sections:

• Rules
  Displays each ruleset in the import. Within each ruleset you can drill down to expand each ruleset version and then each class. For each class you can click the number in the Instances column to display a list of the individual instances in the import.

Similarly, in each of the following sections you can expand the hierarchy of components and see the number of instances of each type. At the lowest level you can click the Instances number to see a list of the individual instances.

• Application/Framework Data
  Custom Data classes associated with the application, for example, PegaAES-Data-.
• System Data
  Data- or Link- classes included in the archive.
• Schema
  Database Schema Changes

  Tables and columns that are added to the PRPC by DDL packaged in the archive.

• Code Items
  JAR files packaged with the archive.

  The files are listed by CodeSet, CodeSet Version and filename.

After you save this rule form, click to create a ZIP archive in the ServiceExport directory on the current application server node.

Use a file name that is valid for both the destination server and the current server; they may be hosted on different Windows or UNIX platforms. The .ZIP suffix is optional. Many special characters are allowed, but you can't include spaces or an equals sign character (=) in the file name.

You can also create the ZIP file later from this product rule, using the Export gadget. Select Designer Studio> Application > Import & Export > Export.