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:

1. Configure the common properties in the prpcServiceUtils.properties file.

   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.

2. 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 to false does not exclude descendants.

3. Optional: Configure the access group.

   Property name	Value
   expose.accessGroup	The access group for the Rule-Declare-Index of the classes being exposed.

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

5. Configure the reindexing behavior.

   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.

   To regenerate indexes, enter the REST user name and password (prpc.rest.username and prpc.rest.password in the common properties section).

6. Save and close the prpcServiceUtils.properties file.

7. To populate the properties, run the prpcServiceUtils.bat or prpcServiceUtils.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.

   For asynchronous operations, the system response includes the job ID, which you can use to query the job status.

Open topic with navigation