Populating properties by submitting a request to an active instance
You can use the prpcServiceUtils tool to extract a property value from the Storage Stream or pzPvStream (BLOB) column into a newly added table column, using a web service to connect to an active instance of Pega Platform. This tool can also rebuild Index- instances that are defined by Declare Index rules.
To populate a newly exposed property, follow these steps:
- Configure the common properties in the
prpcServiceUtils.properties
file.Property name Value Required for Pega Cloud clients? pega.rest.server.url
The URL for the REST service, specified in the following format:
For example:http://
<hostname>:
<port>/
<context>/PRRestService/
http://myhost:8080/prweb/PRRestService
Yes pega.rest.username
The operator name on the target system with access to REST services. Yes pega.rest.password
The password of the specified operator. Yes pega.rest.proxy.host
The host name of the REST proxy server. Do not use localhost as the host name.
Required only when using a proxy for a URL. pega.rest.proxy.port
The port for the REST proxy server.
Required only when using a proxy for a URL. pega.rest.proxy.username
The operator name on the REST proxy server with import and export access.
Required only when using a proxy for the URL pega.rest.proxy.password
The password of the REST proxy operator.
Required only when using a proxy for the URL pega.rest.proxy.domain
The domain of the REST proxy server.
Required only when using a proxy for the URL pega.rest.proxy.workstation
The workstation ID for the REST proxy server.
Required only when using a proxy for the URL pega.rest.response.type
The REST response type, either xml
orjson
. The default value isjson
. Rollback, restore point, and update access group operations support onlyjson
.Not required user.temp.dir
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 .
Not required - Configure the classes.
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 (required)
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.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 tofalse
does not exclude descendants. - Configure the access group.
Property name Value Required for Pega Cloud clients? expose.accessgroup
The access group for the Rule-Declare-Index of the classes being exposed. No - Configure the keys or date ranges to expose.
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. - Configure the reindexing behavior.
To regenerate indexes, enter the REST user name and password (prpc.rest.username and prpc.rest.password in the common properties section).Property name Value expose.reindex
Specifies whether to regenerate the database. The default is true
.To expose property references, set
To regenerate indexes, enter the REST user name and password (prpc.rest.username and prpc.rest.password in the common properties section).expose.reindex=true
.expose.reindexType
Specify which rulesets to reindex: nonpega
: (Default) Process only customer rulesetsfull
: Process Pega Platform and customer rulesetspega
: Process only Pega Platform rulesets
To maximize performance, process Pega Platform rulesets only when instructed to do so by Pega 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
. - Save and close the
prpcServiceUtils.properties
file. - To populate the properties, run the
prpcServiceUtils.bat
orprpcServiceUtils.sh
script with the expose option, for example:prpcServiceUtils.bat expose
- Optional: Pass one or more arguments.
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
, orrollback
.
Previous topic Populating properties by using the Column Populator tool Next topic Populating properties by using a direct connection to the database