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

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.workstatio Optional: The workstation ID for the REST proxy server.
n
pega.rest.response.type The REST response type, either xml or json. The default value is json. Rollback, restore poi
only json.
user.temp.dir Optional: Enter the full path to the temporary directory. Leave this blank to use the default te
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.exportToRepositor Indicates whether to export to a repository. The default is false, which exports to a file system
y

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
that you can use later to check the job status. When this value is false, the process starts imm
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, PegaRUL

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 
Property name Value

expose.includeDescendents Optional: Set to false to exclude descendants of included classes. The default value, true

Classes to exclude

Property name Value

expose.excludedClasses Comma-separated list of classes to exclude from the column.

expose.excludeDescendents Optional: Set to true to exclude descendants of excluded classes. Setting the value to 

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 th

expose.endDate The maximum value for pxCreateDateTime. The tool exports data equal to or less than this v

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

To regenerate indexes, enter the REST user name and password (prpc.rest.username and prpc.res

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 Cus

expose.commitRate The number of data instances processed with each database commit to balance memory usage and pe
most environments.

expose.async Specifies whether to run the expose operation in asynchronous mode and queue the request. Default

Import tool settings

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

active instance.

Property name Value

import.importFromRepository Indicates whether to import from a repository. The default is false, which
repository, set this to true.

import.archive.path When importing from a file system, the relative path to the archive from th
the path is a folder, the tool processes all archive files in that folder.

import.repositoryName When importing from a repository, the name of the repository. The reposit

import.artifactType When importing from a repository, the artifact type you are importing. The
branch, component, rulesetversion.

import.archivePath When importing from a repository, the full path to the archive file. The arch
example: MyApp_01.01.01/ExportWizard/myFile.zip

import.mode The import mode:

 import : (Default) Update existing instances and remove duplicates. Us
override this setting.
 install : Import new instances. Do not import or update existing insta
for each instance that already exists.
 hotfix : Update existing instances and remove duplicates. If the archiv
skip updating the instance or inserting the duplicate.

import.existingInstances How the import action handles existing instances:

 skip : (Default) Skip instances that already exist in different rulesets or
Property name Value

 override : Replace instances that already exist in different rulesets or

import.nofailonerror true skips instances that fail to import and continues after an import failu
fails.

import.commitRate The number of data instances processed with each database commit to ba
default of 100 is sufficient for most environments.
import.compileLibraries true or false, specifying whether to compile libraries after import. The de
import.allowImportWithMissingDependencie true or false, specifying whether to allow the import to continue even if t
s
default is false.
import.codesetName Optional: The name of the code set to receive the Java .class files.
import.codesetVersion Optional: The code set version.
import.bypassSchema Optional: Specify whether to apply database schema changes during the im
applied the schema changes manually, set this to true.
import.async Specifies whether to run the process in asynchronous mode or synchronou
which returns a job ID that you can use later to check the job status. When
immediately and waits until completion. The choice of synchronous or asyn
writing.

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.catalogPat The full path to the Catalog.zip file.

h

hotfix.async true or false. The default value, true, executes the hotfix operation asynchronously. The system que
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.dlFilePat Comma-delimited list of hotfix package download (DL) file names and paths.
h

hotfix.async true or false. The default value, true, executes the hotfix operation asynchronously. The system queu
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.bypassSchem The default value, false, applies any schema changes automatically. A value of true indicates that you
a
changes.

hotfix.force Set only at the request of Global Customer Support to skip hotfix validations and force the hotfix data i

hotfix.async true or false. The default value, true, executes the hotfix operation asynchronously. The system qu
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.operatio commit
Property name Value

hotfix.async true or false. The default value, true, executes the hotfix operation asynchronously. The system queue
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.operatio rollback
n

hotfix.async true or false. The default value, true, executes the hotfix operation asynchronously. The system queue
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,

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 mana
 delete: Delete a single restore point. Also set manageRestorePoints.rest
 create: Create a new restore point. Also
set manageRestorePoints.restorePointName and manageRestorePoint

manageRestorePoints.restorePointName The name of the restore point to manage.

manageRestorePoints.restorePointLabe A meaningful label that will appear in the restore point lists and information log
l

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 avail

rollback.action SystemRollback

rollback.async Specifies whether to run the process in asynchronous mode or synchronous mode. The defau
that you can use later to check the job status. When this value is false, the process starts imm
of synchronous or asynchronous depends on the type of script you are writing.

rollback.downloadLogToFil true or false. Set to true to attach the log to the rollback results.
e

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.applicationVersio The version of the application to update.

n
 Property name Value

updateAccessGroup.groupList Optional: A comma-delimited list of access groups to update. If you do not enter a
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.

connPropFile The full path to the serviceConnection.properties file that includes information

poolSize The thread pool size. The default is 5.

requestTimeOut The number of seconds the system waits for a response before failing with a tim

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 ro

Related information

 Service-enabled system management log files

 Retrieving service-enabled job status

 Tools for migrating rules and data