Add a dictionary

Use the procedure in this topic to add a new dictionary to your project.

If a dictionary does contain more than one value per line, The import file contains auto replacement values setting on the Dictionary Options window needs to be selected. The correct Field delimiter also needs to be specified. If there are two settings per line, the second setting is Replacement Text.

If these options are not selected, then the multiple options per line are considered as a single setting.

One million lines with two columns takes about 1 minute to import.

Before you begin

Before you can add a dictionary to your project, verify that the required content is in a .txt or .csv file that is available to the project during design-time and production.

Procedure
  1. On the Project tab, in the Configuration group, select Project Settings icon Project Settings.
  2. Select the Dictionaries tab to view the dictionary settings.
  3. Select Add icon Add.
  4. Enter a descriptive dictionary name and click OK.

    The Dictionary Options window is displayed.

  5. Configure the following settings:

    Setting

    Description

    Referenced import file (text or csv file)

    Select one of the following reference file locations:

    File system:

    Browse to the desired location of a dictionary.

    Web:

    Enter the URL for your local fuzzy database file.

    The only valid URL prefixes are http://, https://, and ftp://.

    Alternatively, select Country Settings icon Browse URL.

    The Web Resource window is displayed. Configure the following settings:

    URL:

    Enter the URL location of the resource file.

    For example, http://www.webpage.com/file.txt.

    The file provided here should be the same format as the file system setting.

    Test:

    Tests the connection to the supplied URL.

    A successful connection has a green check and a failed connection has a red exclamation mark.

    Use Windows authentication:

    Select Yes if the specified URL requires authentication. (Default: No)

    User Name:

    Enter a value for the user needed to access the source file.

    Available only when Use Windows Authentication is set to No.

    Password:

    Enter a value for the password needed to access the source file.

    Available only when Use Windows Authentication is set to No.

    Passwords are stored as encrypted strings within the project file.

    Automatic update from import file

    When content is processed through Tungsten TotalAgility - Transformation Server, it is possible to check the source database to see if any changes are made and copy them to your project. (Default: Selected)

    Automatically updates the imported dictionary the next time the Transformation Server runs if the source file changes.

    This is especially useful when using a dictionary that is updated regularly and is located on a network. Because of this, only those dictionary changes are available at the time the Transformation Server was last run.

    To use the project file on another computer, you need to make certain the dictionary remains accessible via the same path. For example, you can copy the dictionary file to the same path on the other computer. Alternatively, you can copy the dictionary file to the other computer and then re-select it.

    Synchronizes your imported dictionary file with its source dictionary whenever content is updated during runtime.

    These automatic updates are then available for processing during those modules.

    It is recommended to enable this setting only if your source dictionary is updated regularly. Otherwise, the unnecessary update checks may hinder performance. (Default: Cleared)

    This automatic update feature works slightly different for the Thin Clients. To ensure that combo boxes populated by dictionaries are regularly synchronized, an additional Thin Clients web.config setting is required to replicate the above behavior. Without this setting, a combo box is filled once and used as long as that project is cashed. This means that combo boxes are updated once for multiple batches using the same project. For more information on the new ForceDictionaryUpdate web.config setting, see the Thin Client Server Installation Guide.

    Dictionaries referenced by validation rules are successfully updated, regardless of the web.config setting.

    Word

    The word list contains the entries of the imported csv or text file. When a field delimiter is available and The import file contains auto replacement values is selected, an additional Replacement Text column is displayed. The contents of the file are then displayed as a list of dictionary words and replacement text items.

    Ignore Case

    Converts all search and lookup strings to lower case, effectively ignoring case. (Default: Selected)

    Additional delimiter

    Use this setting if fields in the database contain compound words like "Diagon-Alley," but the search should consider the single words, additional delimiters can be specified. The search string is split to single terms based on the delimiters. In this example, if a hyphen is used as the delimiter, then "Diagon" and "Alley" are searched and evaluated separately.

    The delimiters should correspond to the delimiters that are defined for recognition, otherwise recognition may not separate the words correctly and then the separately searched words are not found or, if found, the confidence is lower. (Default: -, (SPACE, HYPHEN, and COMMA))

    The SPACE delimiter is mandatory as this is how words are typically separated. If you remove this, the dictionary may no longer work when used in format locators.

    Characters to delete

    Use this setting if you want to filter unwanted characters from the input record. (Default: empty)

    The import file contains auto replacement values

    Select if imported files contain text that can be used to replace extracted text items. For example, if January is found in the document, the dictionary can be used to replace it with the numeral 1. This makes it possible to take all possible variations of January and convert them to the same replacement value (1). (Default: Cleared)

    Field delimiter

    Enter the character that separates the dictionary values from the auto replacement values. (;)

  6. Select OK to create the dictionary.

    The dictionary is added to the list of dictionaries in your project.

  7. Optional. Select OK to close the Project Settings window.
  8. Save the changes to your project.