Configuring an Ordered Keyword Mapping for a Directory - Directory Import Processor - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/Directory-Import-Processor/Foundation-24.1/Directory-Import-Processor/Configuration/Configuration/Mapping-Document-Types-and-Keyword-Types-to-Documents/Configuring-Ordered-Keyword-Mappings/Configuring-an-Ordered-Keyword-Mapping-for-a-Directory - 2024-08-01

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

Ordered Keyword Mappings for directories are configured to pull Keyword Values from a folder name. When files from this folder are imported, OnBase will assign the Keyword Values from the folder name to all files within the folder.

For example, City Bank has a folder in their directory named London::01-01-2018 containing deposit slip files. If City Bank sets up an Ordered Keyword Mapping for the directory where London is assigned to the City Keyword Type, 01-01-2018 is assigned to the Date Keyword Type, and the separator is entered as :: in the Separator field, all the deposit slip files imported into OnBase from the London::01-01-2018 folder are assigned the London and 01-01-2018 Keyword Values.

To configure an Ordered Keyword Mapping for a directory:

  1. From the Configuration module, select Import | Directory Import Processor. The Directory Import Processor Configuration dialog box is displayed.
  2. From a configured process, right-click on a Subfolder or a Default Mapping and select Add Ordered Mapping | Directory Source. An Ordered - Directory node is displayed below the Subfolder or Directory Mapping node.
  3. Select the Ordered - Directory node. The Ordered tab is displayed.
  4. Configure the following options for all required Keyword Mappings:

    Option

    Description

    Order

    Enter the order in which the Keyword Value is displayed in the folder name. For example, the first Keyword Value present will be assigned to the Keyword Type with an order of 1.

    Required

    Select Yes to mark the Keyword Type as required, or select No to not mark it required. If a required Keyword Value is empty (blank) in the folder name, the process will encounter an error and fail to import the document.

    Keyword Type

    Select the Keyword Type in which the Keyword Value should be stored.

    Note:

    The Date & Time Data Type is not supported for use with the Directory Import Processor.

    Use Autofill

    Select Yes from the drop-down list to populate documents with Keyword Values associated with the Primary Keyword Type of the Autofill Keyword Set. The Keyword Type must be a Primary Keyword Type in an Autofill Keyword Set to use this option.

    Select No to not use an AutoFill Keyword Set with the Keyword Type.

    Validate

    Select Yes from the Validate drop-down list to perform mask validation for this Keyword Value, or select No to not perform mask validation. See the System Administration module reference guide for information on Masked Keyword Types.

    Note:

    When Yes is selected, imported Keyword Values that do not match the configured mask are not added to the imported document.
  5. For any Keyword Type that is a Currency or Date Data Type, click Format to format the value. For more information on the available format options, see Currency Formatting Options or Date Formatting.
  6. To remove unwanted characters from the folder name before applying those characters to Keyword Values, select the mapped Keyword Type from the Keywords list and click Process. The Process Field dialog box is displayed.
  7. Select a processing option:

    Option

    Description

    Keep All Characters

    Retain all characters of the folder name as Keyword Values on the document. This option is selected by default.

    Strip Spaces

    Remove all spaces from the folder name before applying folder name characters as Keyword Values.

    Note:

    This option is not supported for use with the following Default Keyword Types: > >Document Type, >>Document Type Number, and >>Dummy Key.

    Strip Character

    Remove a specified character from the folder name before applying folder name characters as Keyword Values. Enter the character in the text field.

    Note:

    This option is not supported for use with the following Default Keyword Types: > >Document Type, >>Document Type Number, and >>Dummy Key.

    Strip _ Chars from Beginning

    Remove characters from the beginning of the folder name before applying those characters to Keyword Values. Enter the number of characters you want to strip in the text field.

    Note:

    This option is not supported for use with the following Default Keyword Types: > >Document Type, >>Document Type Number, and >>Dummy Key.

    Strip _ Chars from End

    Remove characters from the end of the folder name before applying those characters to Keyword Values. Enter the number of characters you want to strip in the text field.

    Note:

    This option is not supported for use with the following Default Keyword Types: > >Document Type, >>Document Type Number, and >>Dummy Key.
  8. Click Save.
  9. Type the characters used to separate the values in the folder name into the Separator field.
    Note:

    Separators cannot be longer than 5 characters.

    When the specified characters are encountered within a folder name, Keyword Values are assigned based on the characters found between the separators.
    For example, a process is configured to map the first encountered Keyword Value to Name and the second Keyword Value to State. A hyphen character (-) is configured as the Separator. The following directories are processed:

    • John-Ohio: When this directory is processed, John is assigned to Name and Ohio is assigned to State.

    • James--Nevada: When this directory is processed, James is assigned to Name and State is left blank. Nevada is not assigned to any Keyword Type.

    • -Abraham-Michigan: When this directory is processed, Name is left blank and Abraham is assigned to State. Michigan is not assigned to any Keyword Type.

  10. Click Apply to save your changes.
    Note:

    You can only add one Ordered Keyword Mapping for a directory per folder.