Optional command-line BIX parameters

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.

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.

Specify how to format extracted Boolean values. The options are:

• 01
• YN
• YesNo
• yesno
• TF
• TrueFalse
• truefalse
• YESNO
• TRUEFALSE

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.

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.

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.

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.

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.

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.

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.

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.”

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:

• Time zone with an ID: For example, to specify America/Los_Angeles. Specify this time zone as "-J""America/Los_Angeles"
• Three letter timezone: For example, to specify India Standard Time, use "-J" "IST"
• UTC+/-dd:dd: Specify UTC plus or minus hours and minutes. For example, "-J" "UTC+5:30"

If not specified, the default is GMT.

Add a unique identifier for this run. Use alphanumeric characters or underscores only with no spaces.

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:

• Double-quote (“)
• Asterisk (*)
• Hyphen (-)

BIX also does not support multi-line delimiters. If the delimiter length is greater than 1, then BIX reports an error.

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.

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.

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.

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.

No longer supported.

No longer supported.

Required option for using BIX in a multitenant environment.

Note: This option is not available when running an Extract rule with pxExtractDataWithArgs.

See PDN article Running BIX in a multitenant environment.

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.

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.

Include header and footer information for XML or CSV output.

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.

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.

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.