Field Order - Document Import Processor - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Document Import Processor
Platform
OnBase
Product
Document Import Processor
Release
Foundation 22.1
License
Standard
Essential
Premier

The field order configuration of the DIP format provides the ability for the system to identify the individual documents and associated Keyword Types in the Import Index file.

  1. In the Configuration module, select Import | Document Import Processor. The Document Import Configuration dialog box is displayed.
  2. Select the appropriate processing format.
  3. Click Field Order. The Import Processor Configuration dialog box displays a list of all the Document Types selected for the DIP process.
  4. Select a Document Type.
  5. Click Field Configuration. The Field Configuration dialog box is displayed.
    Note:

    If the Import Index file contains more than one Document Type, the field order for each Document Type must be configured.

  6. The initial Keyword Type list for new configurations is empty. Select a Keyword Type from the Keyword drop-down list and click Add to move the value to the Keyword Type list.
    If a Keyword Type might be associated with multiple Keyword Values:

    • The Keyword Type must listed in the Field Configuration dialog box as many times as the maximum number of Keyword Values that may be associated with a document.

      For example, if a document may have 3, 4, or 5 values for the Name Keyword Type, then the Name Keyword Type must be listed 5 times in the Field Configuration dialog box.

    • The DIP import index file must contain placeholders for empty Keyword Values so that values are not assigned to the wrong Keyword Types.

      For example, if a document is associated with three Keyword Values for the Name Keyword Type (John, Jim and Jane) but the Keyword Type is listed 5 times in the Field Configuration dialog box, then the import index file must contain two empty placeholders (John, Jim, Jane, , ,) to prevent the next value in the import index file from being assigned to the Name Keyword Type.

    Note:

    OnBase will not save these empty placeholders.

  7. Repeat for all remaining Keyword Types for the Document Type.
  8. If any of the Keyword Types to which are being mapped have a data type of Date or Currency, select the defined field tag and click Format to define the format. See Tagged DIP Field Order Configuration for details.
  9. Add mandatory and optional Default Keyword Types. Keep the following considerations in mind:

    • Depending on your Import Index file, you must add either the Default Keyword Type >>Full Path, >>File Path, or a combination of >>File Path and >>File Name.

      Note:

      When configuring a Normal DIP process that is not configured to use the FTP Download option, if you use the Default Keyword Type >>File Name without also using the >>File Path Default Keyword Type, the Document Import Processor will search for the file in the directory where the Import Index file is located. When configuring a Normal DIP process that is configured to use the FTP Download option, if you use the Default Keyword Type >>File Name without also using the >>File Path Default Keyword Type, the Document Import Processor will search for the file in the default FTP directory.

    • An absolute path must be supplied for a >>File Path Default Keyword Type.

    • The >>Full Path and >>File Path Default Keyword Types are not available when configuring an In-Place DIP process. The >>File Name Default Keyword Type may be used instead.

    • When using a DIP process to import E-Forms, only the >>Document Type or >>Document Type Number Keyword Type is needed. The >>Full Path, >>File Path, and >>File Name Keyword Types are not required.

    • If your Import Index file contains more than one Document Type, both the Import Index file and your Field Configuration must contain the Default Keyword Type >>Document Type or >>Document Type Number.

    • If you have any field values in the Import Index file that you do not want to map to Keyword Types, add the Default Keyword Type >>Dummy Key.

      Note:

      This does not apply to blank file names within an ordered Import Index file. Blank file names should be mapped as the >>FileName Keyword Type.

    • If you want to make a Keyword Value required, select the check box next to the field order number box. After the field is added to the configuration, an X will display in the Required column for that Keyword Type.

    • See Default Keyword Types Used in DIP Processes for additional descriptions of all Default Keyword Types.

    • If you have multiple >>FullPath or >>FileName locations, and you have any of the following Default Keyword Types in the order sequence of the Field Order Configuration, you must put them in the sequence before the >>FullPath or >>FileName Default Keyword Types , otherwise the process will use the default values of those Default Keyword Types. (E.g., Offset =0 and Disk Group Number = the Default Disk Group.) >>Disk Group Number >>File Type >>File Path >>Number of Pages >>Offset >>Size

    • If the File Type (file format) is not specified in the Import Index file, the DIP process will default to the file format configured for the Document Type.

    • For text files, the Default Keyword Type >>Number of Pages is used to designate the number of pages that are in one text file. If more than one text file is imported as part of one document, only the first page will be viewable, even though multiple pages will show in the Properties dialog box.