Skip to main content

Creating a restore point

Suggest edit Updated on May 11, 2022

Use the prpcServiceUtils tool to create a restore point to mark a significant point in time for your system so that you can later roll back changes made after that point. For example, you can create a restore point before you import an application.

Before you begin:

When you roll back to a restore point, Pega Platform uses history records to return most of the system to the restore point state. Not every change creates a history record. Review the information in Using restore points to enable error recovery to ensure that you understand the limitations of restore points.

You must have a running Pega Platform instance to use the prpcServiceUtils tool.

Follow these steps to create a restore point:

  1. Configure the common properties of the prpcServiceUtils.properties file.

    Property name Value Required for Pega Cloud clients?
    pega.rest.server.urlThe URL for the REST service, specified in the following format:

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

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

    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.
    pega.rest.proxy.port

    The port for the REST proxy server.

    Required only when using a proxy for a URL.
    pega.rest.proxy.username

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

    Required only when using a proxy for the URL
    pega.rest.proxy.password

    The password of the REST proxy operator.

    Required only when using a proxy for the URL
    pega.rest.proxy.domain

    The domain of the REST proxy server.

    Required only when using a proxy for the URL
    pega.rest.proxy.workstation

    The workstation ID for the REST proxy server.

    Required only when using a proxy for the URL
    pega.rest.response.typeThe 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
    user.temp.dir

    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. Configure the restore point action:
    manageRestorePoints.action=create

    The system automatically creates the restore point name.

  3. Enter a descriptive restore point label of no more than 64 characters:
    manageRestorePoints.restorePointLabel=label
  4. Save and close the prpcServiceUtils.properties file.
  5. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script with the manageRestorePoints option, for example:
    prpcServiceUtils.bat manageRestorePoints

    Optional: Pass one or more arguments.

    prpcServiceUtils script argument Value
    connPropFileThe full path to the serviceConnection.properties file that includes information for multiple targets.
    poolSizeThe thread pool size. Default is 5.
    requestTimeOutHow long the system waits for a response before failing with a time-out error. Default is 300 seconds.
    jobIdFileThe path to the job IDs file that is generated by the asynchronous operation.
    propFileThe full path to the properties file, to override the default prpcServiceUtils.properties.

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us