LinkedIn
Copied!

Table of Contents

Understanding BIX command-line extractions

Version:

Only available versions of this content are shown in the dropdown

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.

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 prbootstrap.properties file.
  2. BIX prbootstrap.properties 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.
  • Configuring the source database for BIX command-line extractions

    Configure the source database by editing the prbootstrap.properties and prconfig.xml files in the configuration directory of your BIX distribution to add database connection settings that specify Pega Platform database from which you extract data. Configuring the source database permits command line extractions

  • Configuring the target database for BIX command-line extractions

    The BIX Database Schema output format writes the extracted data directly to a target database. If you want to use the Database Schema output format for the BIX command-line extraction process, add a second set of database connection settings in the prconfig.xml file that specify the target database into which you extract data.

  • Configuring optional prconfig.xml settings

    You can add parameters to the prconfig.xml file that filter the data by any property, including date ranges, enable or disable chaining, and specify whether records added to the database while the extract is running are included in the extract.

  • Configuring BIX logs for command-line extractions

    You can configure Business Intelligence Exchange (BIX) logs for command-line extractions by editing the prlog4j2.xml file. BIX logs capture timestamped progress each table batch extracted, interruptions in the extraction process, source and target database connectivity errors. You can locate the prlog4j2.xml file in the config folder of your Pega Platform distribution.

  • Viewing and configuring BIX logs

    Business Intelligence Exchange (BIX) logs are visible in System Operations and can be downloaded.

  • Enabling password encryption for BIX command-line extractions

    Enable security for the database username and password by implementing a Java Cryptography Extension (JCE) keyring encryption. To do so, create a pegarules.keyring file and append the encryption information to your command-line extraction Java method.

  • Running a BIX command-line extraction

    After you configure your source database environment, you can run the Business Intelligence Exchange (BIX) command-line extraction process.

  • Running a BIX command-line extraction using ANT build files

    The Apache Another Neat Tool (ANT) build file acts as a script to run the Business Intelligence Exchange (BIX) command-line extraction process. Call the ANT build file to achieve the same Java functionality of a command-line extraction process without entering the entirety of the extraction Java method in the command line. The BIX ANT file, bix.xml, uses the same Java methods as the task Running the BIX command-line extraction process.

Related Content

Article

Configuring environments for command-line extractions

Article

Manually running an Extract rule in your application

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.