prpcServiceUtils properties and arguments

The properties in the prpcServiceUtils.properties file and the arguments to the prpcServiceUtils.bat script or prpcServiceUtils.sh script control service-enabled application distribution. The following tables define each property and argument.

If you need to perform these operations by using a direct connection to the database, use the prpcUtils tool. For more information about the prpcUtils tool, see prpcUtils properties and arguments.

Properties files and command-line arguments

Configure the prpcServiceUtils.bat or prpcServiceUtils.sh script actions in the prpcServiceUtils.properties file.

You can also pass arguments to the script to override settings in the prpcServiceUtils.properties file.

  • Use the properties file to set property values for reuse to minimize errors in entering commands.

  • Use the command-line arguments to augment or override values in the property file, for example, to customize one script action. The use of these arguments is optional. Each argument should be preceded with two hyphens (--).

prpcServiceUtils.properties file properties

Common properties

Property name Value
pega.rest.server.url The URL for the REST service, specified in the following format:

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

For example:

http://myhost:8080/prweb/PRRestService

Include the tenant hash only for multitenant systems.

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 .

Export tool settings

For more information, see Exporting rules and data by submitting a request to an active instance.

General export properties

Property name Value
export.exportToRepository Indicates whether to export to a repository. The default is false, which exports to a file system. To export to a repository, set this to true.
export.archiveName When exporting to a file system, the path of the archive file to be created.
export.repositoryName When exporting to a repository, the name of the repository.
export.async Specifies whether to run the process in asynchronous mode or synchronous mode. The default, true, is asynchronous, which returns a job ID that you can use later to check the job status. When this value is false, the process starts immediately and waits until completion. The choice of synchronous or asynchronous depends on the type of script you are writing.

In addition to the general properties, you must also configure properties for exporting by product, application, or branch.

Export product

Property name Value
export.productName The name of the product to export.
export.productVersion The version of the product to export.

Export application

Property name Value
export.applicationVersion The version of the application to export.
export.applicationName The name of the application to export.

Export branch

Property name Value
export.branchName The name of the branch to export.
export.branchAppContext The application context of the branch ruleset to export, for example, PegaRULES:07.10

Column population tool settings

For more information, see Populating properties by submitting a request to an active instance.

To specify the data for populating the new column, use the include and exclude classes properties. For example, if you include Rule- with descendants and exclude Rule-File- with descendants, Pega Platform processes all descendant classes of Rule-, except rules in Rule-File-.

Classes to include

Property name Value
expose.includedClasses Comma-separated list of classes to include in the column. To specify a range of keys from pzInsKey, specify one class with no descendants.
expose.includeDescendents Optional: Set to false to exclude descendants of included classes. The default value, true, includes them.

Classes to exclude

Property name Value
expose.classes.excluded Optional: If you entered one or more classes in the expose.classes.included property, you can exclude specific subclasses by listing them here. Only instances of the exact class listed are excluded. For example, if you included Rule- classes with descendants you can use this property to filter specific classes.
expose.excluded.descendent Optional: True (default) or False. If true and a class listed to be excluded has concrete subclasses (based on pattern inheritance), the subclasses are automatically added to the list of classes to be excluded.

Keys and date ranges

Specify the range of pzInsKey or pxCreateDateTime values to expose. If you specify both, the pzInsKey values override the pxCreateDateTime values.

Property name Value
expose.startKey The minimum value for pzInsKey. The tool exports data equal to or greater than this value.
expose.endKey The maximum value for pzInsKey. The tool exports data equal to or less than this value.
expose.startDate The minimum value for pxCreateDateTime. The tool exports data equal to or greater than this value.
expose.endDate The maximum value for pxCreateDateTime. The tool exports data equal to or less than this value.

Reindex exposed data

Property name Value
expose.reindex Specifies whether to regenerate the database. The default is true.

To expose property references, set expose.reindex=true.

To regenerate indexes, enter the REST user name and password (prpc.rest.username and prpc.rest.password in the common properties section).
expose.reindexType Specify which rulesets to reindex:
  • nonpega : (Default) Process only customer rulesets
  • full : Process Pega Platform and customer rulesets
  • pega : Process only Pega Platform rulesets

To maximize performance, process Pega Platform rulesets only when instructed to do so by Global Customer Support.

expose.commitRate The number of data instances processed with each database commit to balance memory usage and performance. The default of 100 is sufficient for most environments.
expose.async Specifies whether to run the expose operation in asynchronous mode and queue the request. Default is true.

Import tool settings

For more information, see Importing rules and data by submitting a request to an active instance.

Hotfix manager settings

Hotfix scan

For more information, see Scanning the system by submitting a request to an active instance.

Property name Value
hotfix.operation scan
hotfix.catalogPath The full path to the Catalog.zip file.
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.

Hotfix generate DDL

For more information, see Creating an SQL script by submitting a request to an active instance.

Property name Value
hotfix.operation generateDDL
hotfix.dlFilePath Comma-delimited list of hotfix package download (DL) file names and paths.
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.

Hotfix install

For more information, see Installing hotfixes by submitting a request to an active instance.

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.

Hotfix commit

For more information, see Committing hotfixes by submitting a request to an active instance.

Property name Value
hotfix.operation commit
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.

Hotfix rollback

For more information, see Rolling back hotfixes by submitting a request to an active instance.

Property name Value
hotfix.operation rollback
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.

Get status settings

For more information, see Retrieving service-enabled job status.

Property name Value
getstatus.jobID The job ID for an asynchronous process.
getstatus.operationName The operation name associated with the job ID: import, export, expose, hotfix, or rollback.

Manage restore points settings

For more information, see Restore points.

Property name Value
manageRestorePoints.action The action to perform:
  • list : Display a list of all available restore points.
  • get : Display detailed information about a single restore point. Also set manageRestorePoints.restorePointName .
  • delete : Delete a single restore point. Also set manageRestorePoints.restorePointName .
  • create : Create a new restore point. Also set manageRestorePoints.restorePointName and manageRestorePoints.restorePointLabel .
manageRestorePoints.restorePointName The name of the restore point to manage.
manageRestorePoints.restorePointLabel A meaningful label that will appear in the restore point lists and information logs.

Rollback settings

For more information, see Rolling back to a restore point.

Property name Value
rollback.restorePointName The restore point name. Use manageRestorePoints.action=list to generate a list of available restore points.
rollback.action SystemRollback
rollback.async Specifies whether to run the process in asynchronous mode or synchronous mode. The default, true, is asynchronous, which returns a job ID that you can use later to check the job status. When this value is false, the process starts immediately and waits until completion. The choice of synchronous or asynchronous depends on the type of script you are writing.
rollback.downloadLogToFile true or false. Set to true to attach the log to the rollback results.

Update access group settings

For more information, see Updating access groups by submitting a request to an active instance.

Property name Value
updateAccessGroup.applicationName The application that includes the access group.
updateAccessGroup.applicationVersion The version of the application to update.
updateAccessGroup.groupList Optional: A comma-delimited list of access groups to update. If you do not enter a list of access groups, the system updates all access groups that access the application.

prpcServiceUtils.bat and prpcServiceUtils.sh script arguments

Use the command-line arguments to augment or override values in the property file, for example, to customize one script action. The use of these arguments is optional. Each argument should be preceded with two hyphens (--).

prpcServiceUtils script argument Value
artifactsDir The full path to the output file location, for those functions that generate output. The default is the /scripts/utils/logs directory.
connPropFile The full path to the serviceConnection.properties file that includes information for multiple targets.
poolSize The thread pool size. The default is 5.
requestTimeOut The number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds.
jobIdFile The path to the job IDs file that is generated by the asynchronous operation.
propFile The property file name, to override the default prpcServiceUtils.properties file.
operationName Specify the operation that generated the job ID for getStatus: import, export, expose, hotfix, or rollback.