Rolling back to a restore point

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
    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. Configure the scope for the rollback:
    Option Description
    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
    connPropFile The full path to the serviceConnection.properties file that includes information for multiple targets.
    poolSize The thread pool size. Default is 5.
    requestTimeOut How long the system waits for a response before failing with a time-out error. Default is 300 seconds.
    jobIdFile The path to the job IDs file that is generated by the asynchronous operation.
    propFile The full path to the properties file, to override the default prpcServiceUtils.properties.