Installing hotfixes by submitting a request to an active instance

To automate hotfix installation, use the command-line tools. If you have an active instance of Pega Platform, you can install hotfixes by submitting a request to the active instance via a web service.

  1. Configure the common properties of 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. Configure the install properties of the prpcServiceUtils.properties file.

    Property name Value
    hotfix.operation install
    hotfix.dlFilePath The full path to the hotfix package file.
    hotfix.bypassSchema The default value, false, applies any schema changes automatically. A value of true indicates that you have already manually applied the schema changes.
    hotfix.force Set only at the request of Global Customer Support to skip hotfix validations and force the hotfix data into the system.
    hotfix.async true or false. The default value, true, executes the hotfix operation asynchronously. The system queues the job and returns a JobID to use to get the job status. A value of false executes the operation synchronously.
  3. Save and close the prpcServiceUtils.properties file.

  4. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script with the hotfix option, for example:

    prpcServiceUtils.bat hotfix

    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 timeout 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.