Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

More about Extract rules

Updated on April 5, 2022


  1. Click Run.
  2. Enter a unique identifier and the maximum number of records to extract.
  3. Click Perform Extract.
  4. Review the resulting data and log files.

Scheduling Extract rule runs

For more efficient operation, you should schedule run of an Extract rule using a Pega Platform Job Scheduler (for Pega Cloud and on-premises) or from a Windows or UNIX/Linux command-line (for on-premises only). For details, see Using the Job Scheduler rule to extract data with BIX and Running the command-line extract process.

Exception handling

Executing BIX may result in errors or exceptions being reported. These exceptions may relate to syntax errors (in command-line execution), database constraint violations (when exporting to a database), or similar issues. For details, see BIX logging and error handling.

Rule operation

Extract rules can operate on the BLOB column of tables in the PegaRULES database or they can be used to extract data from tables with no BLOB column. However, when a class table includes a BLOB (pzPVStream column), extraction always is performed from that BLOB value, and not from other database columns. For details, see Storage Stream.

If the Extract rule class is a class group, the query on the source database extracts all WorkObject instances of all classes within the class group. If the extract rule class is not a class group, the query on the source database only gets instances of the particular class.

Forward and backward chaining during BIX extract (on-premises applications only)

For on-premises clients, in the prconfig file, a setting governs whether forward and backward chaining are enabled during a BIX extract. You should disable forward and backward chaining for better throughput when running BIX. For details, see Configuring optional prconfig.xml settings.

  • Previous topic Creating and running an Extract: Filter Criteria
  • Next topic Using the Job Scheduler rule to extract data with BIX

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