You are here: System management > Command-line system management tools > Service-enabled system management > prpcServiceUtils properties and arguments

prpcServiceUtils properties and arguments

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

prpcServiceUtils.properties file properties

The parameters in the prpcServiceUtils.properties file configure the actions of the prpcServiceUtils.bat or prpcServiceUtils.sh command-line script. Use the properties file to set property values for reuse to minimize errors in entering commands.

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

Export tool settings

None of these settings have a corresponding script argument.

General export properties (required)

Property name Action
export.archiveName Enter the name of the archive file to export.
export.async

Specify whether to run the process in asynchronous mode and queue the jobs. Set to true (default) to return a job ID for each operation that you can use later to check the status.

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

Exporting by product (optional)

Property name Action
export.productName If you are exporting a product, enter the name of the product to export.
export.productVersion If you are exporting a product, enter the version of the product to export.

Exporting by application (optional)

Property name Action
export.applicationVersion If you are exporting an application, enter the version of the application to export.
export.applicationName If you are exporting an application, enter the name of the application to export.

Exporting by branch (optional)

Property name Action
export.branchName

Enter the name of the branch to export.
export.branchAppContext Enter the application context of the branch ruleset to export. For example: PegaRULES:07.10

Expose tool settings

To specify the data to expose, Use the include and exclude classes. For example, if you include Rule- with descendants and exclude Rule-File- with descendants, the Pega Platform processes everything in Rule-, except rules in Rule-File-.

Classes to include (required)

Property name Action
expose.includedClasses Enter a comma-separated list of classes to include in the column. If you plan to specify a range of keys from pzInsKey, you must specify one class with no descendants.
expose.includeDescendents Optional: Set to true to exclude descendants of included classes.

Classes to exclude

Property name Action
expose.excludedClasses Enter a comma-separated list of classes to exclude from the column.
expose.excludeDescendents Optional: Set to true to exclude descendants of excluded classes.

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 Action
expose.startKey Enter the minimum value for pzInsKey. The system will export data equal to or greater than this value.
expose.endKey Enter the maximum value for pzInsKey. The system will export data equal to or less than this value.
expose.startDate Enter the minimum value for pxCreateDateTime. The system will export data equal to or greater than this value.
expose.endDate Enter the maximum value for pxCreateDateTime. The system will export data equal to or less than this value.

Reindexing exposed data

Property name Action
expose.reindex

Specify whether to regenerate the database. The default is true.

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

To regenerate indexes, enter an access group or the REST user name and password (prpc.rest.proxy.username and prpc.rest.proxy.password in the common properties section). If you enter both an access group and a user name, the user name takes precedence over the access group.

expose.reindexType

To maximize performance, process Pega Platform rulesets only when instructed to do so by Pegasystems Global Customer Support. Specify which rulesets to re-index:

  • 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 Pegasystems Global Customer Support.
expose.commitRate

Specify 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 Specify whether to run the expose operation in asynchronous mode and queue the request. Default is true.

Import tool settings

Property name Action
import.archive.path Enter the relative path to the archive from the \utils\ folder or the full path to the archive. If the path is a folder, the tool processes all archive files in that folder.
import.mode Enter the import mode:
  • install: Import new instances. Do not import or update existing instances. The log file includes an exception message for each instance that already exists.
  • import: (Default) Update existing instances and remove duplicates. Use the import.existingInstances property to override this setting.
  • hotfix Update existing instances and remove duplicates. If the archive time stamp is older than the existing instance, either skip updating the instance or inserting the duplicate.
import.existingInstances Specify how the import action handles existing instances:
  • override: Replace instances that already exist in different rulesets or versions.
  • skip: (Default) Skip instances that already exist in different rulesets or versions.
import.nofailonerror

Set to true to skip instances that fail to import and continue after an import failure. Set to false to stop the import if any import action fails.
import.commitRate Specify 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.
import.compileLibraries Specify whether to compile libraries after import. Default is true.
import.allowImportWithMissingDependencies Specify whether to allow the import to continue even if the archive is dependent on missing products. Default is false.
import.enable.defaultcontext Specify whether to allow triggers for the Pega Platform to run while performing command-line imports. Default is false. To allow triggers to run during imports, uncomment this property and set to true.
import.codesetName Optional: Enter the name of the code set to receive the Java .class files.
import.codesetVersion Optional: Enter the code set version.
import.async

Specify whether to run the process in asynchronous mode and queue the jobs. Set to true (default) to return a job ID for each operation that you can use later to check the status.
import.trackData Specify whether to import only data, that is, anything that is not in PegaRULES. When set to true, data, including DDL changes, is imported and tracked. Use the manage tracked data tool to commit or roll back tracked data.

Tracked data tool settings

Property name Action
manageTrackedData.operation Specify whether to roll back or commit tracked data. Tracked data is data that has been imported using the import tool with the import.trackData property set to true. The valid values are:
  • rollback - rolls back tracked data.
  • commit - commits tracked data.

Hotfix Manager settings

Property name Action
hotfix.operation

Specify the operation to perform. Valid operations are: scan, install, rollback, commit, and generateDDL.

hotfix.dlFilePath For generateDDL or install operations, specify comma-delimited list of hotfix package DL file names and paths.
hotfix.catalogPath Specify the full path to the hotfix catalog.zip file.
hotfix.bypassSchema Specify whether to bypass schema changes when installing a hotfix. The default is false.
hotfix.force Specify whether to import a hotfix even if it requires additional configuration. The default is false.
hotfix.async

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. Default is true. Use the Get Status tool to retrieve the job status.

Hotfix Manager operation 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>

Get status settings

Property name Action
getstatus.jobID For asynchronous mode, enter the job ID.
getstatus.operationName Enter the operation name associated with the job ID: import, export, expose, hotfix, or rollback.

Manage restore points settings

Property name Action
manageRestorePoints.action

Specify 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 the following properties:

    • manageRestorePoints.restorePointName

    • manageRestorePoints.restorePointLabel
manageRestorePoints.restorePointName

Specify the name of the restore point to manage.

manageRestorePoints.restorePointLabel

When creating a restore point, specify a meaningful label that will appear in the restore point lists and information logs.

Rollback settings

Property name Action
rollback.restorePointName Specify the restore point name. Use manageRestorePoints.action=list to generate a list of available restore points.
rollback.action The only valid option is SystemRollback.
rollback.async Set to true (default) to run in asynchronous mode. When run in asynchronous mode, the rollback tool queues the request and returns a JobID that can be used to retrieve the job status of the request.
rollback.downloadLogToFile Set to true to attach the log to the rollback results.

Update access group settings

Property name Action
updateAccessGroup.applicationName Specify the application that includes the access group.
updateAccessGroup.applicationVersion Specify the version of the application to update.
updateAccessGroup.groupList Optional. Enter 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 script arguments to augment or override certain values in the property file, for example to customize one script action.

prpcServiceUtils script argument Action
artifactDir Enter the full path to the output file location. The default is the /scripts/utils/logs directory.
connPropFile Enter the full path to the serviceConnection.properties file that includes information for multiple targets.
poolSize Enter the thread pool size. Default is 5.
requestTimeOut Specify how long the system waits for a response before failing with a timeout error. Default is 300 seconds.
jobIdFile Enter the path to the job IDs file that is generated by the asynchronous operation.
--operationName Specify the operation that generated the job ID for getStatus: import, export, or expose.
Related information

Open topic with navigation