Back Forward How to set optional command-line BIX parameters

For general information on how BIX (Business Intelligence Exchange) works, see Extracting data with BIX.

When running the BIX from the command line, you can input various parameters to filter what will be extracted from your application.

Parameter Description

-a <username>

To rule resolve Rule-Admin-Extract instances based on the user access group.

-b <number of updates before a batch is issued>

Specify the number of PRPC records to batch together before the batch is sent to the export database (this only applies to database with JDBC driver that supports batch updates).

-c

Include children classes Use this parameter if an abstract class was specified in the Rule-Admin-Extract rule.

-d <start date>

Only extract instances with a pxCreateDateTime equal to or greater than <start date>. <start date> should 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> should be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”.

-f

Use this option to force the extract to stop at the first error it encounters.

-i <InstanceName>

You may specify the pzInsName of the Rule-Admin-Extract, or a comma-delimited list of Rule-Admin-Extract instances.

-I <path and filename>

You may specify the .xml file of the local version of the Rule-Admin-Extract.

-k <Identifier>

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

-l

Specify a user-defined character as the delimiter separating extracted data.
   Note, though, that the following characters are not available for use as delimiters, as they signify other things to BIX:

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

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

-p <password>

To rule resolve Rule-Admin-Extract instances based on the user access group.

-s <number>

No longer supported.

-t <threads>

Obsolete. No longer supported.

-T <tenantID>

Required option for using BIX in a multi-tenant environment.

-u <start date>

Only extract instances with a pxUpdateDateTime equal to or greater than <start date>. <start date> should be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”.

-U <end date>

Only extract instances with a pxUpdateDateTime equal to or less than <end date>. <end date> should be in the format “20110823T164017.000”, following the Java pattern “yyyyMMddTHHmmss.SSS”.

-x

Use this option to 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.

Note: To use the -X parameter, the output format of the Rule-Admin-Extract rule 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>.

Note: the comparison is character by character with the pzInsKey, 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, 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.

Definitions Business Intelligence Exchange (BIX)
Related topics Extracting data with BIX
About Extract rules