Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Populating properties by submitting a request to an active instance

Updated on August 25, 2021

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

    Property name Value URL for the REST service, specified in the following format:

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

    For example: http://myhost:8080/prweb/PRRestService operator name on the target system with access to REST services. password of the specified operator.

    The host name of the REST proxy server. Do not use localhost as the host name.

    The port for the REST proxy server.

    The operator name on the REST proxy server with import and export access.

    The password of the REST proxy operator.

    The domain of the REST proxy server.

    The workstation ID for the REST proxy server. REST response type, either xml or json. The default value is json. Rollback, restore point, and update access group operations support only json.

    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 nameValue
    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. 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 nameValue
    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 ( and 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 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.
    To regenerate indexes, enter the REST user name and password ( and in the common properties section).
  6. Save and close the file.
  7. To populate the properties, run the prpcServiceUtils.bat or script with the expose option, for example: prpcServiceUtils.bat expose
    1. Optional: Pass one or more arguments.

    prpcServiceUtils script argument Value
    artifactsDirThe full path to the output file location, for those functions that generate output. The default is the /scripts/utils/logs directory.
    connPropFileThe full path to the file that includes information for multiple targets.
    poolSizeThe thread pool size. The default is 5.
    requestTimeOutThe number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds.
    jobIdFileThe path to the job IDs file that is generated by the asynchronous operation.
    propFileThe property file name, to override the default file.
    operationNameSpecify the operation that generated the job ID for getStatus: import, export, expose, hotfix, or rollback.
    Note: For asynchronous operations, the system response includes the job ID, which you can use to query the job status.
  • Previous topic Populating properties by using the Column Populator tool
  • Next topic Populating properties by using a direct connection to the database

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us