Exporting rules to create an archive

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

Do not create an archive when any rule that you want to export 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.

  1. Click Configure > 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.
    3. Click Perform export. A progress bar and status message are displayed.

    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.
    4. Click Perform export. A progress bar and status message are displayed.

    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.
    4. Click Perform export. A progress bar and status message are displayed.

    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.
    5. Click Perform export. A progress bar and status message are displayed.

    Archive On Server

    Download a copy of any archive file that is already in the ServiceExport directory of an application to your workstation or another directory on your local area network. Click a .zip file from the list to download.
    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.
  3. Save the archive to your file system or export it to a repository.
    • To save the archive to your local file system, click the Download link.
    • To export the archive to a repository, enter the Repository name and click Export.
  4. To display error messages (if any), click the Total Errors link in the lower right corner of the display form.