BIX extraction overview
Extract data from your Pega Platform application using the Business Intelligence Exchange (BIX) Extract rule.
After enabling the built-in BIX ruleset to your application, BIX extractions are made available in Pega Platform. For details, see Enabling the BIX ruleset.
A BIX extraction, also referred to as an extraction or extraction process, extracts and exports Pega Platform class data in XML, CSV, or database schema format. The application accomplishes the BIX extraction process through an Extract or Job Scheduler rule. For details, see Extract rules overview.
Each Extract rule extracts data from a single class. BIX extractions may be run manually from the Extract rule or automatically through the Job Scheduler rule. All extractions must occur from the same database. A single extraction process cannot concurrently extract from multiple databases or different database instances on the same machine. Each extraction process can have only a single data source. You can run different extraction processes, extracting from multiple Pega Platform databases, concurrently.
BIX functionality for each deployment
| Functionality | Pega Cloud Services | On-premises and client-managed cloud |
|---|---|---|
| BIX extractions run through the Extract rule | ✔ | ✔ |
| BIX extractions run through Job Scheduler rule calling pxExtractDataWithArgs for multiple extraction processes | ✔ | ✔ |
| Command-line processes run from any server with privileges to the source database and destination database | ✔ | |
| BIX extractions pulled to Pega Cloud Services file repository using Pega SFTP Service | ✔ | |
| BIX extractions pushed to your enterprise SFTP service using an FTP listener | ✔ |
Extraction process variations for each deployment
| Extraction type | Pega Cloud Services | On-premises and client-managed cloud |
|---|---|---|
| CSV & XML extraction |
| Extractions default to local filepath. |
| Database Schema |
|
|
- The BIX ruleset version you enable in your application ruleset must reflect your Pega Platform version, including after you upgrade Pega Platform. For more information about enabling BIX with the correct ruleset version, see Enabling the BIX ruleset and Upgrading BIX.
- For database schema extract files: The BIX extraction destination database must be supported by your Pega Platform version.
- The destination database requires a Java Virtual Machine (JVM) running a Java version in parity with the Pega Platform Java version. For more information about external database connections, see Creating database instances for JDBC URLs.
If you are using ANT for on-premises command-line extractions, it must be version 1.5 or higher. Version 1.7.1 or higher is recommended.
Previous topic Data extraction Next topic Enabling the BIX ruleset