Managing hotfixes (service-enabled)

Manage hotfixes simultaneously on multiple Pega Platform clusters by using the prpcServiceUtils tool to reduce your maintenance window.

You can manage the following hotfix operations:

• Scan - compare your system to the hotfixes listed in a hotfix catalog and generate a zip file with the results of the scan. You can share this file with Pegasystems Global Customer Support.
• Generate DDL - create a zip file containing the SQL schema changes for a hotfix archive so that a database administrator can review the changes. If you do not manually apply these SQL changes, the hotfix installation process applies them.
• Install - install a hotfix on your system.
• Rollback - roll back all uncommitted hotfixes and remove them from the system.
• Commit - commit all hotfixes and make them permanent on the system.

To run Hotfix Manager:

1. Open the command-line console for your platform and navigate to the scripts/utils directory.
2. Open the prpcServiceUtils.properties file. The comments in the file include information about valid values for each property.
3. Configure the database properties:

Property name	Action
pega.rest.server.url	Enter the URL for the REST service in the following format: http://<hostname>:<port>/context/PRRestService/tenanthash Include the tenant hash only for multitenant systems.
pega.rest.username	Enter the operator name on the target system with access to REST services.
pega.rest.password	Enter the password of the specified operator.
pega.rest.proxy.host	Optional. Enter the host name of the REST proxy server. Do not use localhost as the host name.
pega.rest.proxy.port	Optional. Enter the port for the REST proxy server.
pega.rest.proxy.username	Optional. Enter the operator name on the REST proxy server with import and export access.
pega.rest.proxy.password	Optional. Enter the password of the REST proxy operator.
pega.rest.proxy.domain	Optional. Enter the domain of the REST proxy server.
pega.rest.proxy.workstation	Optional. Enter the workstation ID for the REST proxy server.
pega.rest.response.type	Enter the REST response type, either xml or json. The default value is json.
user.temp.dir	Optional: Enter the full path to the temporary directory. Leave this blank to use the default temporary directory.

4. Configure the hotfix operation:

   hotfix.operation=<action>
   Valid values are scan, install, rollback, commit, and GenerateDDL.

5. Configure the required hotfix parameters:

Hotfix operation	Required parameters
scan	hotfix.CatalogPath= <full path to the Catalog.zip file> hotfix.scan.downloadPath= <full path and .zip file name> where you plan to save the scan results
install	hotfix.dlFilePath=<comma-delimited list of hotfix package DL file names and paths> hotfix.bypass.Schema=<true/false> Set to true to bypass schema modifications made by the hotfix. The default is false. hotfix.force=<true/false> Set only at the request of Pegasystems Global Customer Support to skip hotfix validations and force the hotfix data into the system.
rollback	There are no additional parameters. If you run the rollback operation, all uncommitted hotfixes uninstall.
commit	There are no additional parameters. If you run commit, all uncommitted hotfixes become a permanent part of the system. You cannot roll back committed hotfixes.
generateDDL	hotfix.dlFilePath=<comma-delimited list of hotfix package DL file names and paths>

6. Configure the hotfix operation mode:

hotfix.async=<true/false>

Set to true to run in asynchronous mode. When run in asynchronous mode, the Hotfix Manager queues the request and returns a JobID that can be used to retrieve the job status of the request.

7. Save the file.
8. Run the prpcServiceUtils.bat or prpcServiceUtils.sh utilities script with the manageHotfixes option. For example:
   run prpcServiceUtils.sh manageHotfixes
9. Review the log file. Command-line actions may succeed but still result in partially-installed hotfixes. If the log file lists any additional required actions, complete the action and then repeat step 8.

Open topic with navigation