Preprocess Options - Branch Capture Check Processor - English - Foundation 22.1 - OnBase - external

Branch Capture Check Processor

Branch Capture Check Processor
Foundation 22.1

If an import file is formatted in a way that cannot be processed by Branch Capture, a preprocessor can be used to reformat the data so it can be processed. A preprocessor is a separate program used to reformat existing import files using user-defined rules and descriptions to prepare them for processing.

While the options in this section are typically used to initiate a preprocessor, they can be used to execute any command.


Typically, when configuring a new process format or modifying an existing process format, the import file is processed with only the Preprocessor Options configured. This results in a clean Branch Capture data file that can then be viewed and used to configure the remaining Branch Capture check processor configuration parameters.

To enable the process format to use a preprocessor:

  1. Select the Preprocess check box.
  2. Click Preprocessor. The Preprocessor Configuration dialog box is displayed.
  3. Enter the path to the preprocessor executable in the Preprocessor Location field, or click Browse to browse to it.

    The Preprocessor Location field is limited to 255 characters.

  4. Enter any preprocessor parameter values in the Preprocessor Parameters field.

    Because each preprocessor is unique based on its function, the preprocessor parameters vary depending on your solution. You will be informed of the values for these parameters when your solution is installed.

    Two of the most common parameters are input file (%I) and output file (%O). For most preprocessors, the Preprocessor Parameters field will contain the input and output file variables and an application-specific command line.


    This field is limited to 128 characters.

    • The input file is specified by the %I variable. When the preprocessor is run, the %I is replaced with the name of the import file specified by the process format.

    • The output file is specified by the %O variable. It is replaced in a similar manner when the preprocessor is run.


    The parameters must be listed in the following order: %I %O. If the order of the parameters is reversed (%O %I), all data will be removed from the data file.

  5. Enter the expected number (or range of numbers, using < or >) that the preprocessor returns after a successful process in the Successful Return Value field. If the preprocessor does not return a successful value, the file is not processed.

    This value is dependent on the type of preprocessor used, and will vary depending on the installation. You will be informed of this value when your solution is installed.


    The Enable Skip Return Value option and Skip Return Value field are not supported for use with Branch Capture.

  6. Click Save.

    The Backup Path option is not available for Branch Capture.