Back Forward Help: Import Archive wizard
Completing the Import Zip file option

zzz Show all 

Use this option on a target Process Commander system, the destination system of a migration operation.

This option lets you import into a Process Commander system the contents of an archive ZIP file produced by the Export Rules/Data tool, the Purge/Archive wizard, the Product Package wizard, or the Product or Product Patch rule forms.

zzz Basics

Rules contained in the ZIP file are added to the rules already present in this system, optionally overwriting some existing rules. Data instances (if any) in the Zip file are added to the data instances already present, optionally overwriting some existing ones.

To start the Import Archive tool, select File > Import Archive.

zzz 1. Select an Import mode

Complete the Select Import Mode field. Select:

zzz 2. Completing the Form — Local ZIP file

In the File Name field, type in the full path and name of the ZIP file to be uploaded, or click  Browse  .

Navigate to the local directory that contains the ZIP file, select it, and click  Upload file  .

NoteIf you attempt to upload a ZIP file when the ServiceExport directory already contains a file of that name, a prompt appears. Click to confirm that you want to overwrite the existing file.

Note Using this facility, by default, you can't upload a ZIP file using this facility that is larger than 25 MB. This is an intentional design restriction on the HTTP file copy facility, not a limit on the rule import processing. For larger files, use File Transfer Protocol (FTP) or another means to place the file into the ServiceExport directory. Alternatively, you can set a higher (or lower) upload limit on your system by changing the value for the Initialization/MaximumFileUploadSizeMB parameter in the prconfig.xml file. See Limits and maximums.

zzz 3. Completing the form — Zip File On Server

  1. Click to select one file in the boxed text area.
  2. Set options as desired:
Option Description
Compile Libraries

Select to force Java compilation of the libraries affected by the rules in the ZIP file following upload.

This option is meaningful when the ZIP archive contains a library rule (Rule-Utility-Library rule type) or function rule (Rule-Utility-Function rule type. You can also compile any library later from a button on the Library form. (This check box compiles the libraries on the current node during the import operation. On each other node of a multinode cluster, the Pega-RULES agent compiles these libraries later, ensuring consistency in compiled code across all nodes.)

Overwrite Existing Rules

Select this option to overwrite any rule instances with the same RuleSet name, RuleSet version and visible keys that are already present in the destination PegaRULES database with the rule from the archive ZIP file.

If not selected, when you click  Import , the tool scans the rules in the ZIP archive and compares them with existing rules in the system, noting any matches.

If matches are found, you cannot import the ZIP archive. You can:

  • Cancel the import operation
  • Restart the operation (return to the Tools menu) and check this box to force overwrites.
  • Update rules in the source system or destination system to eliminate the conflict and restart the operation.

Technically, a "match" means identical values for four properties:

  • pzInsKey — Internal key, includes creation date and time
  • pxUpdateDateTime — Date and time of last update
  • pyRuleSet — RuleSet
  • pyRuleSetVersion — Version

If this check box is selected, rules in the ZIP archive overwrite rules in the current system if they match on pzInsKey, pyRuleSet, and pyRuleSetVersion. (If the pxUpdateDateTime also matches, the rule is skipped; there is no need to overwrite, as the rule in the ZIP archive and the rule in the system are identical.)

NoteThis operation is not a merge; the rule from the ZIP archive overwrites the matching rule, regardless of which one was updated most recently.

CautionIf a RuleSet rule or RuleSet Version rule in the ZIP archive is not secured but a matching RuleSet or RuleSet Version rule in the current system is marked as secure, overwriting the existing rule effectively removes the security check mark. If this is not intended, secure the RuleSet or RuleSet Version again.

Overwrite Existing Data

Select this option to overwrite any existing data instances with the same key that are already present in this destination PegaRULES database the database with the data instance in the archive ZIP file.

If matches are found, you cannot import the ZIP file. You can:

  • Cancel the import operation
  • Restart the operation (from the Tools menu) and check this box to force overwrites.
  • Alter data instances in the source or destination system to eliminate the conflict, and restart the operation.

Technically, a "match" means identical values for two properties:

  • pzInsKey — Internal key, includes creation date and time
  • pxUpdateDateTime — Date and time of last update

If the check box is selected, data instances in the ZIP archive overwrite data instances in the current system if they match on pzInsKey. (If the pxUpdateDateTime matches, there data instance is skipped; there is no need to overwrite, as the data instance in the ZIP archive and the one in the system are identical.)

zzz 4. Optional. Select Specified Instances For Load

To import specific rules or data from the ZIP archive, rather than the entire contents, select the check box Show Contents. The Import Archive display expands to list all the rules in the archive by Key name and RuleSet Version.

Select the check box next to each rule you want to import. The Import Options you have selected are applied to each rule individually as they would be for the entire archive.

When you have completed your selection, continue with the Import.

Caution . All components required by the rule must be present in the target system or imported along with it. See Pega Developer Network article PDN PRKB-24183 Troubleshooting: "Class...does not exist" error when importing a ZIP archive for more information on these types of errors.

zzz 5. Begin Import

Click  Import  . The import operation starts. Importing may take several minutes or more.

The system attempts to upload the rules in an order that minimizes processing. After processing completes, adjust access groups or application rules to provide access to the new RuleSets, versions, and class groups as needed. Other users must log off and log in again to access the uploaded application RuleSets.

Click  Close   to close this form.

zzz Notes

CautionIf you upload rules in a RuleSet version that users already can access, they may begin executing them immediately, possibly before other rules in the same ZIP archive are present. This may be desirable and intended, or not desirable. Similarly, declarative rules begin executing for such users immediately. Declarative rules may fail if not all the elements or properties they reference are uploaded yet.

NoteIn a multinode system, the lookup list cache on nodes other than the node on which you run the Import Archive tool may be stale temporarily. The Pega-RULES agent on each other node clears the lookup list cache during the next pulse.

Note During the ZIP import operation, the system confirms, for each RuleSet version imported, that other RuleSet versions (or higher versions) identified as prerequisites are present. For example, you can't import a product ZIP archive exported from a Process Commander 05-03-01 system into a Process Commander 04-02-60 system. The converse — from 04-02-60 to 05-03-01 — is allowed, however. (This check is not performed for a ZIP archive that contains only RuleSets and was created directly in the Export Archive tool.)

Definitions library, lookup list
Related topics Troubleshooting Import Archive: Duplicate record found

UpAbout Archive tools