Optional command-line BIX parameters
When running BIX from the command line or from a Pega Platform agent, 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.
Note: This option is not available when running an Extract rule with pxExtractDataWithArgs.
|
| -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. Note: This option is not available when running an Extract rule in the Pega Cloud.
|
| -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”. Note:
Clear the
Use Last Updated Time as Start
check box on the
Filter Criteria
tab of the Extract form when you use this parameter, because it does not override the check box setting.
|
| -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”. Note:
Clear the
Use Last Updated Time as Start
check box on the
Filter Criteria
tab of the Extract form when you use this parameter, because it does not override the check box setting.
|
| -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. Note: This option is not available when running an Extract rule in the Pega Cloud.
|
| -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. Note:
Clear the
Use Last Update Time as Start
check box on the
Filter Criteria
tab of the Extract form when you use this parameter, because it does not override the check box setting.
|
| -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. Note:
Clear the
Use Last Update Time as Start
check box on the
Filter Criteria
tab of the Extract form when you use this parameter, because it does not override the check box setting.
|
| -i <InstanceName> |
Specify the
pxInsName
of the
Rule-Admin-Extract
or a comma-delimited list of
Rule-Admin-Extract
instances.
Note: This option is not available when running an Extract rule with pxExtractDataWithArgs.
|
| -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.
Note: If an extract has any filter that uses unexposed property references that are passed in by the external file, then extraction fails with the following exception: “Please enter or select a property that is exposed as a column in the database.”
|
| -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.
Note: The following characters are not available for use as delimiters, as they signify other things to BIX:
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.
Note: This option is not available when running an Extract rule with pxExtractDataWithArgs.
|
| -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. Note: This option is not available when running an Extract rule with pxExtractDataWithArgs.
|
| -s <number> | No longer supported. |
| -t <threads> | No longer supported. |
| -T <tenantID> |
Required option for using BIX in a multitenant environment.
Note: This option is not available when running an Extract rule with pxExtractDataWithArgs.
|
| -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”. Note:
Clear the
Use Last Updated Time as Start
check box on the
Filter Criteria
tab of the Extract form when you use this parameter because it does not override the check box setting.
|
| -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”. Note:
Clear the
Use Last Updated Time as Start
check box on the
Filter Criteria
tab of the Extract form when you use this parameter because it does not override the check box setting.
|
| -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. Note: This option is not available when running an Extract rule in the Pega Cloud.
|
| -z <start key> |
Only extract instances with a
pzInsKey
equal to or greater than <start key>.
Note:
The comparison is character by character with the
pzInsKey
and is not an integer comparison with the work object's ID.
|
| -Z <end key> |
Only extract instances with a
pzInsKey
equal to or less than <end key>.
Note:
The comparison is character by character with the
pzInsKey
and is not an integer comparison with the work object's ID.
|
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.
-
When running a BIX extract from command-line on UNIX using the -u, -U, -d, or -D parameters, you need to set the timezone using a JVM argument, such as:
-Duser.timezone="America/New York". For more information, see PDN article Formatting time in BIX. - This functionality is available when you purchase and install the BIX application.