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

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 prpcServiceUtils.properties file.
    Property name Value
    pega.rest.server.url The URL for the REST service, specified in the following format:

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

    For example:

    http://myhost:8080/prweb/PRRestService

    pega.rest.username The operator name on the target system with access to REST services.
    pega.rest.password The password of the specified operator.
    pega.rest.proxy.host Optional: The host name of the REST proxy server. Do not use localhost as the host name.
    pega.rest.proxy.port Optional: The port for the REST proxy server.
    pega.rest.proxy.username Optional: The operator name on the REST proxy server with import and export access.
    pega.rest.proxy.password Optional: The password of the REST proxy operator.
    pega.rest.proxy.domain Optional: The domain of the REST proxy server.
    pega.rest.proxy.workstation Optional: The workstation ID for the REST proxy server.
    pega.rest.response.type The REST response type, either xml or json. The default value is json. Rollback, restore point, and update access group operations support only json.
    user.temp.dir Optional: 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 .
  2. Specify the archive file name or repository name, and whether to export in asynchronous mode:
    Property name Value
    export.exportToRepository Indicates 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.archiveName When exporting to a file system, the path of the archive file to be created.
    export.repositoryName When 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 prpcServiceUtils.properties file.

  7. Run the prpcServiceUtils.bat script or the prpcServiceUtils.sh script with the export option, for example:

    prpcServiceUtils.bat export

    Optional: Pass one or more arguments.

    prpcServiceUtils script argument Value
    artifactsDir The full path to the output file location, for those functions that generate output. The default is the /scripts/utils/logs directory.
    connPropFile The full path to the serviceConnection.properties file that includes information for multiple targets.
    poolSize The thread pool size. The default is 5.
    requestTimeOut The number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds.
    jobIdFile The path to the job IDs file that is generated by the asynchronous operation.
    propFile The property file name, to override the default prpcServiceUtils.properties file.
    operationName Specify the operation that generated the job ID for getStatus: import, export, expose, hotfix, or rollback.

Pega Platform downloads the exported archive file and saves the export log files to the logs directory. For more information about logs, see the Pega Community article Pega Platform logging using Log4j 2.