Running a BIX extract in Designer Studio

To schedule an extract from within Designer Studio, create an agent that periodically invokes the pxExtractDataWithArgs activity to run a BIX Extract rule. This activity takes as arguments the class and name of the Extract rule to run and, as a single string, the list of BIX command-line parameters desired for each run.

Note: The agent must only be enabled on the dedicated node for BIX processing. This helps to avoid any negative performance impacts to production while the Extract rule is running.

See Setting optional command-line BIX parameters and About Agents rules for more information.

To run an extract from within a Pega 7 Platform application:

1. From the Records Explorer, select SysAdmin > Extract and select the Extract rule that you want to use.
2. On the rule form, click Run. The Run Rule form displays.
• For CSV and XML output:
  1. Provide the Number of Records to Update at a Time. To run the extract in non-batch mode for a single record at a time, set the number of records to update at a time to 1.
  2. Provide a Unique Identifier for the extract.
  3. Click Perform Extract to begin extracting data from your application. A progress bar informs you when the extract is complete.
• For an extract to a database:
  1. Provide the Number of Records to Update at a Time. To run the extract in non-batch mode, a single record at a time, set the number of records to update at a time to 1.
  2. Provide a Unique Identifier for the extract.
  3. The first time that you run the extract, select the Generate Schema DDL check box and provide a location and a name to be used when saving the DDL.
  4. Click Perform Extract to generate the DDL and save it in the specified location. Run the generated DDL manually in the required database to create the table.
  5. The next time you run the Extract, clear the Generate Schema DDL check box. Click Perform Extract to begin extracting data from your application into the created table. A progress bar informs you when the extract is complete.

After the extract is complete, you can access the output data at the location (or locations, for XML output) that you specified in the File Specifications tab of the rule.

Related terms

Related information

Open topic with navigation