BIX parameters and command-line arguments
When running Business Intelligence Exchange (BIX) from a Pega Platform Job Scheduler rule, or the command-line, you can input various parameters to filter what is extracted from your application.
| Parameter | Description |
| -a <username> | Rule resolve Rule-Admin-Extract instances based on the user access group. |
| -b <number of updates before a batch is issued> |
Specify the batch size (the number of extracted class instances) for commits to a relational database.
This option only applies to databases with JDBC drivers that support batch updates. |
| -B |
Specify how to format extracted Boolean values. The options are:
|
| -c | Include children classes. Use this parameter to extract the data for each sibling class of the class (class group/non-class group) for which the extract is defined. |
| -d <start date> |
Only extract instances with a
pxCreateDateTime
equal to or greater than <start date>.
<start date> must be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”. |
| -D <end date> |
Only extract instances with a
pxCreateDateTime
equal to or less than <end date>.
<end date> must be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”. |
| -f | Force the extract to stop at the first error that it encounters. This option
only works with a batch size greater than 1. See BIX logging and error handling for information on conditions where encountering an error does not force the extract to stop. |
| -g <start date> |
Only extract instances with a
pxCommitDateTime
equal to or greater than <start date>.
<start date> must be in the format "20110823T164017.000", following the Java pattern "yyyyMMddTHHmmss.SSS" and relative to the local time zone. |
| -G <end date> | Only extract instances with a pxCommitDateTime equal to or
less than <end date>. <end date> must be in the format "20110823T164017.000", following the Java pattern "yyyyMMddTHHmmss.SSS" and relative to the local time zone. |
| -i <InstanceName> | Specify the pxInsName of the Rule-Admin-Extract or a comma-delimited list of Rule-Admin-Extract instances. |
| -I <path and filename> | Use an Extract rule specified in an external file in XML format. See Using a stand-alone command-line BIX extract process. |
| -J |
Specify the time zone that you want to convert DateTime properties to when extracting to XML or CSV output. You can specify the time zone in the following formats:
If not specified, the default is GMT. |
| -k <Identifier> | Add a unique identifier for this run. Use alphanumeric characters or underscores only with no spaces. |
| -l <delimiter> | Specify a user-defined character as the delimiter separating extracted data.
BIX also does not support multi-line delimiters. If the delimiter length is greater than 1, then BIX reports an error. |
| -n | Retrieves class instances that satisfy the filter conditions with an Extract rule from the Pega Platform production database without sorting them by how recent they are. This improves performance, but makes it impossible to perform a partial re-extraction following any errors. |
| -o | Overrides the default setting that combines filter conditions specified on pxCreateDateTime and pxUpdateDateTime using the AND Boolean operator and instead combines them using the OR Boolean operator. |
| -p <password> | Rule resolve Rule-Admin-Extract instances based on the user access group. |
| -P | Overrides the output directories specified on the File Specification tab in the Extract rule form. When specified, all output files are directed to this location. |
| -s <number> | No longer supported. |
| -t <threads> | No longer supported. |
| -u <start date> | Only extract instances with a pxUpdateDateTime equal to or
greater than <start date>. <start date> must be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”. You can also optionally include the time zone, for example, "20110823T164017.000 GMT". If you do not include the time zone, the time zone is the locale that is set on the thread or the default locale of "en_US" and time zone of "EST". |
| -U <end date> | Only extract instances with a pxUpdateDateTime equal to or
less than <end date>. <end date> must be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”. You can also optionally include the time zone, for example, "20110823T164017.000 GMT". If you do not include the time zone, the time zone is the locale that is set on the thread or the default locale of "en_US" and time zone of "EST". |
| -x | Include header and footer information for XML or CSV output. |
| -X <Path><FileName> | Generate only a set schema file for the export. No data is exported. To use the -X parameter, the output format of the Rule-Admin-Extract rule that you specify must be Database schema. If the output format is XML or CSV, a PRRuntimeException is generated. |
| -z <start key> | Only extract instances with a pzInsKey equal to or greater than <start key>. |
| -Z <end key> | Only extract instances with a pzInsKey equal to or less than <end key>. |
The pzInsKey values of class instances whose extraction resulted in errors are logged automatically. You do not need to set a flag to enable this behavior.
Previous topic Running a BIX command-line extraction using ANT build files Next topic Troubleshooting BIX for on-premises environments