Skip to main content

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

Running BIX command-line extractions in on-premises systems

Updated on April 6, 2022

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.

This content only applies to on-premises systems and is not supported in Pega Cloud environments.

During command-line BIX extraction, a stand-alone instance of the PegaEngine is started without requiring opening Pega Platform to run the extract process without activating the Extract rule. The database user that runs the command-line BIX extraction must have all privileges that are needed to start the engine.

You can add other optional parameters that filter the data by any property, including date ranges, and specify other processing options. For more information, see Setting optional command-line BIX parameters.

Running an Extract rule from the command line works in the following way:

BIX extraction process from the command line
  1. BIX accesses the Pega Platform (source) database by using the information that is defined in the BIX prconfig.xml and file.
  2. BIX file starts up the PegaEngine with the Pega Platform source database details, and then gets the ExtractImpl.class code.
  3. With the information that is configured in the Java method, bix.xml file, and specified in the Extract rule, BIX extracts the specified data from the Pega Platform source database.
  4. The extracted data is output in the format that is specified in the Extract rule.
  • Previous topic Overview of BIX extractions in on-premises environments
  • Next topic Configuring the source database for BIX command-line extractions in on-premises systems.

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