Configure a Preprocessor - XML Index Document Import Processor - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

XML Index Document Import Processor
Platform
OnBase
Product
XML Index Document Import Processor
Release
Foundation 23.1
License
Essential
Standard
Premier

If an import file is formatted in a way that cannot be processed by the processor, 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.

Note:

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

To enable the process format to use a preprocessor:

  1. Select the Preprocess option.
  2. Click the Preprocessor button. The Preprocessor Configuration dialog box is displayed.
  3. Enter the path to the preprocessor executable in the Preprocessor Location field, or click Browse to navigate to it. This field is limited to 255 characters.
  4. Enter any preprocessor parameter values in the Preprocessor Parameters field. This field is limited to 128 characters.
    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.

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

    CAUTION:

    The parameters must be listed in the following order: %I %O with a space between them. 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. This field is limited to nine characters.
    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.
  6. Select Enable Skip Return Value to specify a number or range of numbers that are returned if the preprocessor needs to skip processing the index file. Selecting this option enables the Skip Return Value field. In some cases it may be desirable to have the processor skip processing an import index file. For example, you may want to skip processing if it references documents that were not yet added to the processing directory.
  7. If you selected Enable Skip Return Value, in the Skip Return Value field, enter the expected number or range of numbers (for example, a range can be entered as >10 or <-5) that the preprocessor returns when an index file is skipped for processing. This field is limited to a maximum of 19 characters. The following types of values and operators are acceptable to enter:

    • >, <, and -

    • Numeric

    • Whole number

    • Non-overlapping with Successful Return Value

    Note:

    For example, if the Successful Return Value is 10, the Skip Return Value cannot be 10 or greater than 10 (for example, >10).

    If the preprocessor returns a skip value for a file, that file remains in the directory and is not processed. The file is not moved to the ERROR_FILES directory unless an error is detected in another import index file within the same batch.
  8. Click Save.