Skip to main content

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

Data extraction

Updated on April 6, 2022

Create a broad view of your business by integrating Pega Platform data with data from other systems of record using Business Intelligence Exchange (BIX). BIX extracts transactional data from the Pega database into formats suitable for exporting to a reporting data warehouse, operational data store (ODS), or other downstream process. The BIX extraction process extracts data into .xml, .csv, and database schema formats.

Pega offers BIX as an optional add-on product. Contact your Pega Account Executive to ensure that your license includes BIX access.

​Business Intelligence Exchange (BIX) is a ruleset that can be run manually from the ruleform, automatically using a Job Scheduler, or from the command line (on-premises only). BIX provides the extract functions of an ETL (extract, transform, and load) utility by using the Pega-BIX ruleset, which supports the Rule-Admin-Extract rule type. Data is extracted and exported in a format suitable for use in popular business intelligence applications, such as data warehouses. BIX is a batch processing tool that extracts data from one class at a time. You can use it to do a full extract or an incremental extract based upon when a target property changes.

  • BIX extraction overview

    The Pega Business Intelligence Exchange™ (BIX) ruleset is included with Pega Platform, which eliminates the need for additional provisioning for Pega Cloud customers and for a separate BIX installation for on-premises clients. Even though the BIX ruleset is now included with Pega Platform it is licensed separately.

  • Extract rules overview

    After you enable the built-in Business Intelligence Exchange (BIX) rule set on Pega Platform, you can run the BIX extraction processes from the Extract rule to extract class data from your application. Create an Extract rule to define the class data to extract from your application using the Business Intelligence Exchange (BIX) ruleform.

  • Using the Job Scheduler rule to extract data with BIX

    After you enable the built-in Business Intelligence Exchange (BIX) ruleset on Pega Platform and create a Extract rule, you can schedule Business Intelligence Exchange (BIX) extractions using Pega Platform Job Scheduler rule.

  • Unique run identifier

    When using Business Intelligence Exchange (BIX), you can provide a unique run identifier for each BIX extraction process to mark additions to both parent and child tables in the database, and parent and child CSV files. This enables you to accomplish the following actions after BIX extraction process:

  • Overview of BIX extractions in Pega Cloud environments

    After enabling the built-in Business Intelligence Exchange (BIX) ruleset on Pega Platform, you can extract data from your Pega Platform application with an Extract or Job Scheduler rule in your Pega Cloud environment.

  • Overview of BIX extractions in on-premises systems

    Pega Business Intelligence Exchange (BIX) extracts application class data from your on-premises Pega Platform environment. For on-premises systems, BIX is available when you purchase and install the BIX application.

  • Running a BIX command-line extraction in on-premises systems

    After creating a Business Intelligence Exchange (BIX) Extract rule in Pega Platform, you can directly call the ExtractImpl Java class from the Pega Platform distribution directories to run an BIX extraction process from the command line. Running a BIX extraction process from the command line allows for running an extraction process without requiring the use of Pega Platform to run the process.

  • Troubleshooting BIX for on-premises environments

    When you run a Business Intelligence Exchange (BIX) extraction process from a Pega Platform Extract rule, a Pega Platform Job Scheduler rule, or the command-line, learn to recognize the most common errors in the extraction process in on-premises environments. Refer to the following tables to troubleshoot the root causes and resolve or prevent problems with extractions.

  • BIX logging

    The PegaBIX log file contains information about Business Intelligence Exchange (BIX) extractions that can be useful to determine what caused a problem during a BIX extraction process. BIX extracts class data then writes out a batch of records, one batch at a time. These events, including any error messages, are recorded in the PegaBIX log file.

  • Optimizing BIX data extraction performance

    Understanding performance enhancements of the Business Intelligence Exchange (BIX) configurations will help you to maximize the throughput of BIX extractions from your applications. Refer to the following table to incorporate enhancement considerations into your BIX extraction process as needed.

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