Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Exporting rules and data by submitting a request to an active instance

Updated on May 11, 2022

You can automate exporting rules and data to an archive by connecting to an active instance of Pega Platform from a web service. One request can export rules and data to one archive file from one system. You can export by product, application, or branch.

You must have a running Pega Platform instance to use the prpcServiceUtils tool.
  1. Configure the common properties in the file.

    Property name Value Required for Pega Cloud clients? URL for the REST service, specified in the following format:

    http:// <hostname> : <port> / <context> /PRRestService/

    For example: http://myhost:8080/prweb/PRRestService
    Yes operator name on the target system with access to REST services. Yes password of the specified operator. Yes

    The host name of the REST proxy server. Do not use localhost as the host name.

    Required only when using a proxy for a URL.

    The port for the REST proxy server.

    Required only when using a proxy for a URL.

    The operator name on the REST proxy server with import and export access.

    Required only when using a proxy for the URL

    The password of the REST proxy operator.

    Required only when using a proxy for the URL

    The domain of the REST proxy server.

    Required only when using a proxy for the URL

    The workstation ID for the REST proxy server.

    Required only when using a proxy for the URL REST response type, either xml or json. The default value is json. Rollback, restore point, and update access group operations support only json. Not required

    Enter the full path to the temporary directory. Leave this blank to use the default temporary directory. For more information about temporary directories, see Temporary files and temporary files directories .

    Not required
  2. Specify the archive file name or repository name, and whether to export in asynchronous mode:

    Property name Value
    export.exportToRepositoryIndicates whether to export to a repository. The default is false, which exports to a file system. To export to a repository, set this to true.
    export.archiveNameWhen exporting to a file system, the path of the archive file to be created.
    export.repositoryNameWhen exporting to a repository, the name of the repository.
    export.async Specifies whether to run the process in asynchronous mode or synchronous mode. The default, true, is asynchronous, which returns a job ID that you can use later to check the job status. When this value is false, the process starts immediately and waits until completion. The choice of synchronous or asynchronous depends on the type of script you are writing.
  3. To export by product, specify the product name and version:

    Property name Value
    export.productName The name of the product to export.
    export.productVersion The version of the product to export.
  4. To export by application, specify an application name and version:

    Property name Value
    export.applicationVersion The version of the application to export.
    export.applicationName The name of the application to export.
  5. To export by branch, specify a branch name and application context:

    Property name Value
    export.branchName The name of the branch to export.
    export.branchAppContext The application context of the branch ruleset to export, for example, PegaRULES:07.10
  6. Save and close the file.
  7. Run the prpcServiceUtils.bat script or the script with the export option.

    Optional: Pass one or more arguments.

    prpcServiceUtils script argument Value
    artifactsDirThe full path to the output file location, for those functions that generate output. The default is the /scripts/utils/logs directory.
    connPropFileThe full path to the file that includes information for multiple targets.
    poolSizeThe thread pool size. The default is 5.
    requestTimeOutThe number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds.
    jobIdFileThe path to the job IDs file that is generated by the asynchronous operation.
    propFileThe property file name, to override the default file.
    operationNameSpecify the operation that generated the job ID for getStatus: import, export, expose, hotfix, or rollback.
Result: Pega Platform downloads the exported archive file and saves the export log files to the logs directory.
  • Previous topic Exporting rules and data from the command line
  • Next topic Exporting rules and data by using a direct connection to the database

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us