Exporting rules to create an archive

Use the Export tab to export rules from a Pega Platform system into an archive file. An archive is useful for sharing rulesets between instances of the Pega Platform.

Caution: Do not create an archive when any rule designated for the archive is checked out. If a rule is checked out, the original version of the rule is included in the archive, but the checked-out version of the rule is not included. An error message lists the checked-out rules.

To create an archive, complete the following steps:

1. In Designer Studio, click Designer Studio > Application > Distribution > Export.
2. Select an export mode to determine the scope of the contents of the .zip file:
   • By Application — Create an archive file that contains all rules and data in an application.
     1. Select the application name.
     2. Select the application version.
   • By RuleSet/Version — Create an archive file that contains all rules in a ruleset and version (or all versions).
     1. Select a ruleset.
        Note: If you have one or more rulesets that use Application Validation (AV) mode, select only one application to associate with the AV ruleset.
     2. Select a version.
     3. Enter a file name.
        
        • Use a file name that is valid for both the destination server and the current server.
        • The ".zip" suffix is optional.
        • You cannot include spaces or an equal sign character (=) in the file name.
   • By Product — Create an archive file that contains rules and data that are defined by an existing product rule (Rule-Admin-Product rule type).
     1. Select a product.
     2. Select a version.
     3. Enter a file name.
        
        • Use a file name that is valid for both the destination server and the current server.
        • The ".zip" suffix is optional.
        • You cannot include spaces or an equal sign character (=) in the file name.
   • By Patch — Create an archive file that contains rules and data that are defined by an existing product page rule (Rule-Admin-Product-Patch rule type).
     1. Select a product.
     2. Select a version.
     3. Select a patch.
     4. Enter a file name.
        
        • Use a file name that is valid for both the destination server and the current server.
        • The ".zip" suffix is optional.
        • You cannot include spaces or an equal sign character (=) in the file name.
   • Archive On Server — Download a copy of any archive file that already exists in the ServiceExport directory of an application to your workstation or another directory on your local area network.
     Note: If you have direct access to the file system on your server, you can copy the .zip file using File Transfer Protocol (FTP) rather than using this option.
     
     1. Click a .zip file from the list to download.
     2. In some browsers, you might be prompted to specify a download location. If not, skip this step.
     3. The selected file is downloaded to your destination drive. Skip steps 3-5 in this process.
        
3. Click Perform export.
4. To save the archive locally, click the Archive created link.
5. To display error messages (if any), click the Total Errors link in the lower right corner of the display form.

Open topic with navigation