Export gadget

Basics

Complete this form on a source Pega system, the one that contains the rules to be extracted. You can copy all rules in a specific ruleset and version, all rules in a full ruleset, or all rules and data instances defined in a product rule or patch rule.

Preparation

Don't create a ZIP archive at a time when any of the rules designated for the archive are checked out. An error is reported identifying each checked-out rule. Neither the original version nor the checked-out version of the rule is included in the ZIP archive.

1. Select an export mode

Select to determine the scope of the contents of the ZIP file:

• By RuleSet/Version   — To create a ZIP archive containing all rules in a ruleset and version (or all versions).
• By Product   — To create a ZIP archive containing rules and data defined by an existing product rule (Rule-Admin-Product rule type).
• By Patch   — To create a ZIP archive containing rules and data defined by an existing product page rules (Rule-Admin-Product-Patch rule type).
• Archive on Server   — To copy a previously created archive file from the Pega server to a local directory.

2. Ruleset Version

If you selected By Ruleset/Version, select a ruleset from those on your ruleset list for the Rule Set field.

Complete the Rule Set Version field. Select a single version for that ruleset, or All Versions.

3. Application Context

If you selected By Rule Set/Version and have one or more rulesets that use Application-Based Validation (ABV) mode, then complete this field to select only one application to associate with the ABV ruleset.

4. Product or Patch

If you selected By Product, or By Patch, complete these two fields to identify the two key parts of an existing product or patch rule.

The second key part (Version) of product and patch rule types is not necessarily related to ruleset versions.

5. File Name

1. Enter a file name for your Zip file in the File Name field. 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 in the file name, but you can't include spaces or an equals sign character (=) in the file name.
2. Click Create ZIP File. The system displays the progress of the extraction, which may require one to several minutes. A progress bar shows the count of rules extracted.
3. When the export operation completes, the Zip file created link provides access to the new file, typically placed in the ServiceExport subdirectory of the server.
4. If errors are reported, click the Total Number of Errors link in the lower right corner of the display form to see the error messages. You can print this for later analysis.
5. To save the file now to a local directly, click the Zip file created link. Choose Save in the pop-up window. (You can download the file later using the ZIP File on Server option.)
6. Click  Close  .

Notes

If the ruleset versions you select contain any checked-out rules, neither the checked-out copy of the rule nor the checked-in rule is included in the ZIP file created. Each such rule is noted as an error.

Although Pega does not restrict the number of records or size of the ZIP file, some vendor ZIP utilities limit the file size to 2 gigabytes.

Application category — Import and Export page