Mapping Document Types and Keyword Types to Documents - Directory Import Processor - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Directory Import Processor

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

Once a process is configured, a structure of the directory you are importing can be created in OnBase. You can create the directory structure by using a combination of the following types of mappings:

Default Mapping

Default Mappings import files from folders within the root directory and apply the configured Document Type to all imported files within that directory. Use a Default Mapping if your directory contains files organized into folders that need to be imported into a single Document Type. A Default Mapping must have an assigned Keyword Mapping for either the directory or file names. See Configuring Default Mappings for more information on Default Mappings.

Note:

Loose files in the root directory cannot be imported with a Directory Import Processor process. All files in the root directory must be organized into a folder.

Subfolder

Subfolders import files from specific folders within the root directory and can apply a configured Document Type to all files only within the specified folder. All other files in the root directory are ignored. Subfolders can be used when a root directory contains files that belong to different Document Types. When naming a Subfolder, you must exactly match the name of the specified folder in the root directory. Subfolders are case sensitive. A Subfolder must have an assigned Keyword Mapping for either the directory or file names. See Configuring Subfolders for more information on Subfolders.

Fixed Mapping

A Fixed Mapping is a type of Keyword Mapping. Fixed Mappings assign Keyword Values to Keyword Types based on the position and length of the text in the directory name or the file name. Fixed Mappings have two available options: Fixed - Directory and Fixed - Filename. A Fixed Mapping is not required in a Directory Import Processor configuration. However, a type of Keyword Mapping must be used for each configured Subfolder or Default Mapping. See Configuring Fixed Keyword Mappings for more information on Fixed Mappings.

Ordered Mapping

An Ordered Mapping is a type of Keyword Mapping. Ordered Mappings assign Keyword Values to Keyword Types based on the order in which the text appears in the directory name or file name. Multiple Keyword Values must be separated by a character such as a comma (,), period (.), or dash (-). Ordered Mappings have two available options: Ordered - Directory and Ordered - Filename. An Ordered Mapping is not required in a Directory Import Processor configuration. However, a type of Keyword Mapping must be used for each configured Subfolder or Default Mapping. See Configuring Ordered Keyword Mappings for more information on Ordered Mappings.

Before you start configuring a Directory Import Processor process, examine the directory you want to import and determine its structure. Determine if you need to configure:

  • A Default Mapping to import all the files in folders under the root directory into the same Document Type.

  • A Subfolder structure to import files from folders into different Document Types.

Once you determine the structure of your directory, you must choose which type of Keyword Mapping to use. First, determine if you are configuring:

  • A file name for a Keyword Mapping

  • A folder name for a Keyword Mapping

Next, determine the type of Keyword Mapping depending on the following characteristics:

  • If the text in the file name or folder name is in a consistent position and of a consistent length, then use a Fixed Keyword Mapping.

  • If the text in the file name or folder name is in a specific order separated by a character, then use an Ordered Keyword Mapping.

Tip:

For examples of specific directory mapping scenarios, see Process Mapping Examples.