Import gadget – Select a File from the Server to Import

Use this option on a target Pega Platform system, the destination system of a migration operation.

This option lets you import 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.

1. Select File from Server

Click the name of the file you want to import..

Review the File Information details that display to confirm that this is the file you want and that it is appropriate for your system.

The File Information available for a specific archive may vary, but can include the following:

Label Description
Type Indicates whether the ZIP archive contains only RuleSets, is derived from a product rule, or contains Java classes.
Operator Full name of the user who exporting this ZIP on the source system, from the General tab of the Operator ID data instance.
PRPC Engine Version of the source system.
Pega-Build-Date For an application bundle, the date the bundle was created.
Pega-CodeSet-Name For an application bundle, the name of the CodeSet from which any Java JAR files were extracted.
Pega-CodeSet-Version For an application bundle, the version number of the CodeSet from which any Java JAR files were extracted.
Manifest-Version If available, a version number extracted from the application bundle manifest file.
Pega-CodeSet-Patch Not used.
Name If the Type is Product, the Product Name key part of the product rule in the source system.
Version If the Type is Product, the Product Version key part of the product rule in the source system.
Instance Count Count of all records in the ZIP archive.
Label If the Type is Product, the Short Description of the product rule in the source system.
Creation Date Date and time the ZIP archive was exported from the source system.
Archive Type One of: PegaArchive for a product rule or RuleSet export, JAR for a Java Archive, or Application Bundle, for a collection of multiple ZIP archives with a manifest.
Synchronizable Not used.
RuleSet Name If the archive contains only some or all versions of a single RuleSet, the name of the RuleSet.

2. Optional. Show Content Details

To review the content of the archive, click Show Content Details.

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.
  • Application/Framework Data – Custom Data classes associated with the application, for example. PegaAES-Data-
  • System Data – Data- classes included in the archive.
  • Schema

    Database Schema Changes

    Class — Table

  • Code Items

    CodeSet — Version — Jar File

3. Optional. Enable advanced mode

Check Enable advanced mode to see all the import wizard pages. By default, only import screens that require your input are shown, for example, when there is a conflict between the content in the import archive and the content in the target system.

In advanced mode, the wizard displays a page for each type of content in the archive allowing you to review each step and modify the content before submitting the import.

4. Begin Import

Click Next to begin the import. The import operation starts immediately. Importing may take several minutes or more.

If you do not want to complete the import, select << Back to return to Select a local file or << Cancel to exit from the wizard.

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.

If you import rules in a RuleSet version that some 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 intended. 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.

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

By default, you can't upload a ZIP file larger than 1GB to the server from your desktop with the Import Archive tool. This is a limitation on the upload operation, not on the import itself. Use FTP or another means to place the ZIP archive into the ServiceExport directory on the server, or change the limit through a prconfig.xml file setting. See Limits and maximums.

The property @baseclass.pxMoveImportDateTime records the date and time that a rule (or other instance) was imported from a ZIP archive. You can report on this property (for one rule type such as properties or flows) on when the rules moved into a system.

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 Pega Platform 05-03-01 system into a Pega Platform 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.)

About Archive tools