Preprocess Options - XML Tag Import Processor - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

XML Tag Import Processor

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

If an import file is formatted in a way that cannot be processed by TIP, 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 Preprocessor Options configured. This results in a "clean" TIP data file that can then be viewed and used to configure the remaining TIP 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.
    Note:

    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.
    Note:

    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.

    CAUTION:

    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.
    Note:

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

    Note:

    This field is limited to nine characters.

  6. Click Save.
    You can backup the import file prior to it being processed to ensure that the process format and its preprocessor were configured correctly and no data is lost or damaged in the import file.
    If a file already exists in the backup location with the same name as the import file you are trying to backup, the import file will not be processed unless the Create Unique Subdirectories option is selected.
    Tip:

    It is considered a best practice to always select the Backup Path check box.

  7. To enable the backup-prior-to-processing option:
    1. Select the Backup Path check box.
    2. Click Backup Path. The Backup Path dialog box is displayed.
    3. Enter the path to the backup location (i.e., the location where the import file is to be copied to) in the Backup Location field, or click Browse to browse to the folder.
      Note:

      If you enter a path that does not exist (i.e., a folder not already created), it will automatically be created when the process is run.

    4. Select Create Unique Subdirectories if multiple import files have the same file name and each of them need to be backed up.

      By default, if a process format uses an import file that has the same name as (but different content than) an existing backup file, the file is not processed. Select Create Unique Subdirectories to allow import files with the same name to be processed and backed up to unique subdirectories. When this option is selected, a unique subdirectory is created within the specified backup directory for each import file. The directory is created in the following format, based on the date and time the process is run: Month_Date_Year_Hour_Minute_Second(i.e., mm_dd_yyyy_hh_mm_ss).

      Alternatively, select Allow Overwrite of Backup to have import files with the same name as an existing backup file overwrite the old backup. This can be useful if you frequently use import files with the same name and don't want a high volume of unique subdirectories.

      These options also function with FTP backups, if applicable.

    5. Click Save.
      Note:

      Typically, the TIP processor is run against the TIP data file, with only the Preprocessor Options configured. This results in a "clean" TIP data file that can then be viewed and used to configure the remaining TIP processor configuration parameters.