Skip to main content
Skip table of contents

Category Code Text Search Utility

The Category Code Text Search must be set up by your administrator before you use this functionality.

to administrators: If the Emplifi Agent account that connects to the database has privileges that allow dropping and creating of indexes, the full text index is dropped and recreated to increase the utility’s processing speed, otherwise the index will stay in use during processing.

It is best practice to schedule the utility to create the data on off hours as it will (if permitted) drop the index while the utility is creating the appropriate text. While the index is dropped any other categories that already have their text search defined will return an error to the agent when trying to use text search. Once the utility has finished updating the text, the index is recreated, and all categories defined to text search will function properly.

The Category Code Text Search Utility is used to automatically build word lists (stored in the category_code.text_search column). These word lists are used by the Category Code Text Search to find category codes using related category information when a case is entered.

The Category Code Text Search allows a user an additional search option when entering a category code. An Emplifi Agent category may have many codes, and occasionally users have difficulty finding the exact code they need to enter. Before tabbing from the Category Code field, the user can enter:

  • all or part of the code (including wildcards)

  • all or part of the code’s description (including wildcards)

  • a keyword associated with the code

The Category Code Text Search allows an additional search option where the user enters one or more words related to the code. Similar to the keyword search, the benefit of this search is that the word lists are built by the system.

For example: if you need to enter a Product Code and you could not find the desired code using the other search options, and you know that the product you need to enter is a floor lamp with a blue shade, you can type “floor lamp blue shade” into the issue’s Product Code field. When you tab from the field, a browse list displays with all products that include those words. You click the correct item and the category code populates the Product Code field.

Searchable words may be added to a code manually in Category Definitions on the Text Search tab or by exporting the category using the Category Code Import/Export Utility, manually editing as desired, and then importing using the same utility. Automated addition to the list is possible by using this utility.

Requirements to use category code text search

  • The database must be Microsoft SQL Server 2012 to 2017.

  • Category Code Text Search must be setup in Emplifi System Manager in the Setup section.

  • Each category to use this feature must have these items in Category maintenance:

    • The Text Search Defined check box selected.

    • Text Search selected in one of the drop-down Code Search Order list boxes.

    • A list of searchable words for each code that is to be found.

    • Optionally, Confirm Unique Match check box checked.

Optional configuration settings

  • Maximum Codes Returned From Search, defaults to 100 if empty.

  • Popup Browse Height (pixels), defaults to 200 if empty.

  • Popup Browse Width (pixels), defaults to 150 if empty.

To access the Category Code Text Search Utility:

  • From the Application Function Bar, select Utilities > Configuration Utilities > Category Code Text Search.

Utility Options

The following options are available for this utility:

Field

Description

Category

Select the category for which you want to build a word list.

Time Frame

Optional: If specified, the Time Frame, From Date, and Thru fields specify the range of "last modified" records to be updated by the utility.

From Date

Optional: If a Time Frame is specified, select the start date for the range of "last modified" records to be updated by the utility.

Thru

Optional: If a Time Frame is specified, select the end date for the range of "last modified" records to be updated by the utility.

Process only if empty

Select this check box to only update the text_search column for codes where the column is empty. Existing text_search values are not updated.

Columns

The Columns view allows you to select the information to use in the utility. You can add a column for every category that you want to include in the utility.

  • To add a column, browse the Categories panel for the information to add. Click and drag it into the Column page.

  • To delete a column, click and drag it back to the Categories panel.

  • To re-sequence a column, click and drag it to the correct place.

After you place the category columns on the page, use the following fields to specify columns to include in the utility:

Field

Description

Category Code

Select the category that is the source of items being added to the searchable word list. If the category on the Options page is not Product or is not an address related category like Store, this category must be the same as the category on the Options page. Different rules apply when the Options page category is Product or is address related.

When the category on the Options page is Product (C01), either Product or product attribute categories (E-codes) may be selected, and the Code Item column may contain Value, Description-1, Description-2, Description-3, Category Specific, or Keywords.

When the category on the Options page is address related (for example, Store), you may select store attributes such as Description-1, Description-2, Description-3, Category Specific, as well as address attributes related to Store, such as address1, city, state, Extended Address P-codes, and landmarks.

Category ID

This is the Category ID of the category selected in the previous field. It automatically displays and cannot be changed except by changing the category.

Code Item

This is the data item that is added to the word list. The options include:

  • Value specifies the value of the code.

  • Description 1 is the category’s Description 1 definition.

  • Description 2 is the category's Description 2 definition.

  • Description 3 is the category's Description 3 definition.

  • Category Specific is the category's specific definition.

  • Keywords may be selected for all categories.

  • Landmarks are only available for address-related categories.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.