Back Forward Product rules
Completing the Contents tab
  1. About
  2. New
  3. Contents
  4. Installation
  5. History
  6. More...

  Show all 

Complete this tab to identify the applications, RuleSets, data instances and other objects that make up the product or application.XXXXXXXXXXXXXXXX REVISE FOR JAR FILE SUPPORT 6,2 XXXXXXXXXXXXXX

 Applications to include

Optional. Select an application rule, which identifies the RuleSets and versions that comprise it. The rule instances in those RuleSets and versions are included in the ZIP archive file. Using this option eliminates the need to specify the individual RuleSets and versions in the RuleSets to Include section. The order of the applications in the array is not important. 5.5 GRP-920

By default, all versions up to and including the version in the application are included. For example, if your application references OrderEntry:02-03-05, the ZIP archive file produced from the product rule will include all the rules from OrderEntry:02-01-01 through OrderEntry:02-03-05.

During the import process, RuleSets specified in this section are loaded first. Therefore, specifying a maximum version of OrderEntry:02-03-05 in the next (RuleSets to Include) section has no effect; that version has already been loaded by way of the application rule import. 

NoteThis product rule itself is exported only if the RuleSet and version to which the product rule belongs is in the RuleSets to Include array, is included with a listed application in the Applications to Include array, or is explicitly included as a RuleSet or as a class instance (assuming the it passes the ListView filter configuration).v5.5

NoteInstances of data classes that may be part of your application are not automatically included. Use the Classes to Include section to specify the data instances required in your application.

If an application is built on another application, make sure its RuleSets are in the destination system. Otherwise, import the parent application first.

Field

Description
Applications to Include

Name

SmartPromptIdentify an application name, the first key part of an application rule.
Version SmartPromptIdentify the application version, the second key part of an application rule.
Custom/Production
RuleSets

SmartPromptOptional. Select if you want to include the Custom/Production RuleSets listed in this application rule in the product archive.
Shared/Component
RuleSets

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

 RuleSets to Include

Optional. Specify RuleSets and versions that are used in an application or product. Removed per PETEJO, GRP-920 v5.5 - You can choose only RuleSet versions that are direct or indirect prerequisites of the RuleSet and version of this rule (however, SmartPrompt lists may show other choices).

Enter RuleSets in any order. During import processing of the ZIP file, the system determines a valid order in which to load the rules.

Use the Minimum RuleSet Version and Maximum RuleSet Version fields to define a range (within a major version) that contains the rule instances you want to include in your product. Leave both fields blank to include all versions.

NoteThe use of the value ALL is deprecated. If you created a product rule prior to v5.5 and had entered ALL in the RuleSet Version field, the value appears in the Maximum RuleSet Version field. All versions are included as before.

NoteAs of v5.5, you can use a product rule to create a product patch — a zip file containing a single version. Enter the same patch version ( NN-NN-NN) in both fields.

(OldIn releases before V5.3, order was significant. During import processing, RuleSets in a ZIP were loaded in the reverse order that they appeared in this array.)

Field

Description
RuleSets to Include

RuleSet

SmartPrompt Identify a RuleSet.
Minimum RuleSet Version

SmartPromptOptional. 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.
Maximum RuleSet Version

SmartPrompt 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.
Exclude Non Rule Resolved Rules

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: SR-4848list updated for v5.5,pashm

  • 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-BPEL rule type)
  • Class rules (Rule-Obj-Class rule type)
  • RuleSet name rules (Rule-RuleSet-Name rule type)
  • RuleSet version rules (Rule-RuleSet-Version rule type)
  • Service rules (for example, Rule-Service-BPEL rule type)

 Class instances to include

Optional. Identify class instances that you want to include in the archive. By default, all instances within a listed class are included. Optionally, you can filter the instances using either a list view rule or a when rule.

Field

Description
Class Instances to Include You can include instances from any class. Many products depend on data classes (derived from the Data- base class) in order for the application to run correctly on the destination system. These class categories include:
  • 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 Process Commander system. For more information, see the Pega Developer Network article PDNPRKB-24111 How to ensure that a product rule includes all parts of an application.

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.

NoteYou 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. B-19799 PRKB-18160 (needs revision)

TipIf 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.
Class

SmartPrompt 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.
ListView Filter

SmartPromptOptional. 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 checkbox 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.
When Filter

SmartPromptOptional. 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.

NoteFor 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.
Include Descendants?

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.

Select this box if you have entered an abstract class.
Exclude Classes

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.

 Individual Instances to include

Complete this optional array by selecting from a list the specific class instances which you want to include in the product ZIP file. For selecting large numbers of instances, it is recommended that you use a filter in the Class Instances to Include section.

For example, if your application includes instances of the Data-Report-Shortcut and Data-Report-Category classes (which define the appearance of V5 reports in the Report Browser), you can identify them here. See How to make V5 reports available in a Report Browser.

Field

Description
Individual Instances to Include

Select a class and press 'Query'

SmartPromptOptional. Identify a class that contains instances to be included as part of your application or product. C-1118

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.
Label

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.
Key

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

 Select Jar Files to include in application

Complete this optional array yxxxxxxxxxxxx XXXXXXXXXXXXXXXX REVISE FOR JAR FILE SUPPORT 6,2 XXXXXXXXXXXXXX

Field

Description
Query Jars

xxxxxxxxxxxxx
 

CodeSet

xxxxxxxxxxxxxx
Version

xxxxxxxxxxxxxxxx
Jar File

xxxxxxxxxxxxxx

 File Details

Two optional fields can help developers who upload a product ZIP file confirm that a ZIP file is the one they want.

Field

Description
File Details  
Creation Date

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. PICARD 8/16/04
Short Description

C-1246 04-02 Optional. Enter a text description of the contents of this file, to appear on the destination Process Commander system before the ZIP archive is uploaded.
5.4 Compatibility?

Optional. Select if you want to create an archive that can be imported into a v5.4 system or earlier V5.X system. The V5.4 and earlier ZIP files contained .jar files, whereas v5.5 ZIP files contain .bin files. BUG-2966

If not checked, the archive cannot be imported into pre-v5.5 systems. v5.5 J. Peterson
Create Zip File

B-4600 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 B-15737 or an equals sign character (=) in the file name. B-12720 B-18823 OLSOK 42SP6 2/21/06

You can also create the ZIP file later from this product rule, using the Export gadget. Select > Application > Import & Export > Export. REMOVED v5.5 per J. Peterson Although Process Commander does not restrict the number of records or size of the ZIP file, some vendor ZIP utilities limit the file size to 2 gigabytes. SR-801 KARAF 3/28/06 WERDA

Up About Product rules