The Column Populator is a command-line utility that allows you to update rows in PegaRULES database tables after schema changes have been made that expose a property as a database table column.
The utility can populate values for a newly exposed column and expose values that were previously stored only in the Storage Stream (BLOB) column. In addition, you can rebuild database indexes and Index- instances defined by Declare Index rules for the newly populated column as part of the same operation.
Typically, run the Column Populator immediately after making changes to the database table, whether the changes were made with the Modify Database Schema tool or by a database administrator. Until the Column Populator finishes, data values in the table are "out of sync" because some properties might have null values when you look at the column values, but might have non-null saved values if the BLOB column (pzPVStream) is expanded into a clipboard page.
Version usage information
Users of PRPC 5.1 - 5.5 can populate newly exposed database columns by using the Database Column Populator, which is part of the PRDBUTIL servlet.
Users of PRPC 4.1 - 4.2 can populate newly exposed database columns by using the Resaver servlet. For more information, see:
- Troubleshooting: Report output shows no values for a newly exposed column
- Working with the PegaRULES database — Using the Database Column Populator utility.
In this example, a new data table (AlphaCorp-ItemList) has been created, and to support reporting needs, the scalar properties must be exposed as columns in the database.
To use the Column Populator utility:
- Identify the classes (tables) to be processed by the utility. The Column Populator utility can process specifically defined concrete classes and any child classes that are related by pattern inheritance.
- Extract the contents of the Process Commander software distribution file, PRPC_DistributionImage.zip, into a directory. In this example, the directory is
- Edit the
<PEGA_HOME>/scripts/utils/prpcUtils.propertiesfile to provide database connection details. Enter the following properties in the COMMON PROPERTIES - DB CONNECTION (REQUIRED) section:
- In the SETTINGS FOR EXPOSE TOOL section, complete the expose.classes.included line by listing the class for which columns will be exposed. Save the file.
For information about the other properties, see the prpcUtils.properties file or the PRPC Developer Help.
- pega.jdbc.driver.jar —The full path to the JDBC driver JAR file.
- pega.jdbc.driver.class —The Java class name of the JDBC driver.
- pega.database.type — Select the database vendor from the list of supported vendors.
- pega.jdbc.url — The connection URL for your database. Refer to the examples in the prpcUtils.properties file.
- pega.jdbc.username and pega.jdbc.password —The user name and password to use when connecting to your database
- pega.user.username and pega.user.password — The PRPC user name and password to use for the run-time context of the operation. This user's Access Group will be used instead of the App Requestor's access group.
- At the command prompt, change the directory to
<PEGA_HOME>/scripts/utils. Run the prpcUtils.bat file with the
As the utility runs, you will see output that ends with the following text:
[echo] PegaRULES Process Commander Expose Columns complete.
Total time: 1 minute 31 seconds
Exiting with NO Error