Skip to main content

Rolling back to a restore point

Suggest edit Updated on May 11, 2022

Use the prpcServiceUtils tool to roll back your system to a restore point. For example, if you created a restore point before doing a major system update, and the system update causes a serious problem, you can roll back to the restore point so that your system behaves as it did before the update.

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

You can specify which rule and data instances are returned to the previous state:

  • System: Roll back every rule and data instance with a history record. This is the default setting.
  • User: Roll back rule and data instances modified by a specific user.Note: If any rule was changed by more than one user, you will see an error message and must use the system rollback.
  • Application: Roll back rule and data instances in a specific application.

Follow these steps to roll back to a restore point:

  1. Configure the common properties of the prpcServiceUtils.properties file. The pega.response.type must be JSON.

    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 scope for the rollback:
    SystemRollback Set rollback.action=SystemRollback
    UserRollback Set:
    • rollback.action=UserRollback
    • rollback.userName= <Operator ID>
    ApplicationRollback Set:
    • rollback.action=ApplicationRollback
    • rollback.applicationName=<application name>
    • rollback.applicationVersion=<application version>
    For example:
    rollback.action=UserRollback
     rollback.userName= MyUserID
  3. By default, the rollback process runs in asynchronous mode. In asynchronous mode, the system queues the job and returns a job ID for each operation. You can later use this job ID to check the status of the rollback operation.
    rollback.async=true
  4. As a best practice, leave the downloadLogToFile parameter with the default value of true to write the log to a file.
    rollback.downloadLogToFile=true
  5. Save and close the prpcServiceUtils.properties file.
  6. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script with the rollback option, for example:
    prpcServiceUtils.bat rollback

    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