Free cookie consent management tool by TermsFeed

Setting Up AI Smart Search Module

On This Page

Introduction

After installing the AI Smart Search module, you need to set it up before using it with the Case Management Studio Base application. This guide walks you through the setup steps, including:

Step 1: Add the AI Smart Search site page

To use AI Smart Search with your Case Management Studio Base application, you’ll need to integrate the AI Smart Search site page into the Workspace site. By following the steps in this section, you will enable users to access and utilize the AI Smart Search functionality directly from the Workspace, enhancing their ability to locate relevant information efficiently within the Appian application.

To add the AI Smart Search site page to the Workspace site:

  1. In Appian Designer, go to the CMGT Case Management Studio Base application.
  2. Search for and open the CMGT_WorkspaceSite site object.
    1. Click on ADD PAGE and enter the following details:
      1. Title: AI Smart Search
        1. Use the translation string in the CMGT_SMS_AI_Translations translation set
      2. Web Address Identifier: smart-search
      3. Type: Interface
      4. Content: CMGT_SMS_AI_SitePage_SmartSearch 1.Width: Wide
      5. Visibility:
        1. 1
          2
          3
          4
          
          `a!isUserMemberOfGroup(
          username: loggedInUser(),
          groups: cons!CMGT_GRP_INTERNAL_USERS
          )`
          
      6. Click DONE.
    2. Click SAVE.

Step 2: Enable AI Smart Search on record fields

To fully utilize the AI Smart Search functionality within the CMS AI Smart Search module, it's essential to enable AI Smart Search for specific record fields.

The steps in this section outline how to configure AI Smart Search on the necessary fields within Appian Designer, ensuring that relevant data from various record types is discoverable through the search feature.

To enable AI Smart Search on the necessary fields:

  1. In Appian Designer, go to the CMGT Case Management Studio Base application.
  2. Search for and open the CMGT_Case record type.
    1. Under DATA, navigate to the Smart Search tab.
    2. Select the Title and Description checkboxes.
    3. Click SAVE.
  3. Search for and open the CMGT_Comment record type.
    1. Under DATA, navigate to the Smart Search tab.
    2. Select the commentText checkbox.
    3. Click SAVE.
  4. Search for and open the CMGT_Milestone record type.
    1. Under DATA, navigate to the Smart Search tab.
    2. Select the label checkbox.
    3. Click SAVE.
  5. Search for and open the CMGT_Tag record type.
    1. Under DATA, navigate to the Smart Search tab.
    2. Select the Name checkbox.
    3. Click SAVE.
  6. Search for and open the CMGT_Task record type.
    1. Under DATA, navigate to the Smart Search tab.
    2. Select the Title and Description checkboxes.
    3. Click SAVE.

Step 3: Sort on similarity score in cases and tasks queries

To enhance the relevance of search results, the following steps ensure that cases and tasks are sorted by their similarity score. By prioritizing results with the highest similarity, users can quickly identify the most pertinent information, improving efficiency and accuracy in their search queries.

To sort cases in order of highest similarity to lowest similarity:

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_QR_GetSmartSearchResultsOnCases expression rule.
    1. Add allSearchFields to the fields parameter of the a!queryRecordType(), as shown:

      cms_smartSearchSetup_caseAllSearchFields

    2. Click SAVE.

To sort tasks in order of highest similarity to lowest similarity:

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_QR_GetSmartSearchResultsOnTasks expression rule.
    1. Add allSearchFields to the fields parameter of the a!queryRecordType(), as shown:

      cms_smartSearchSetup_taskAllSearchFields

    2. Click SAVE.

Step 4: Display matching field in search results

The steps in this section walk you through how to surface the matching field in the search results by updating the associated interface. This allows the user to understand why the result was returned.

To display the matching field in the search result for a case:

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_SmartSearchCaseCard interface.
    1. Below the in-line comment for the Matched On Field - Incorporation, insert the following rich text item as shown:

      cms_smartSearchSetup_taskMatchedOnSourceField

    2. Below the in-line comment for the Matched On Content - Incorporation, insert the following rich text item as shown:

      cms_smartSearchSetup_taskMatchedOnSourceContent

    3. Click SAVE.

To display the matching field in the search result for a task:

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_SmartSearchTaskCard interface.
    1. Below the in-line comment for the Matched On Field - Incorporation, insert the following rich text item as shown:

      cms_smartSearchSetup_caseMatchedOnSourceField

    2. Below the in-line comment for the Matched On Content - Incorporation, insert the following rich text item as shown:

      cms_smartSearchSetup_caseMatchedOnSourceContent

    3. Click SAVE.

Step 5: Include similarity score for top results

To sort on similarity score in the Top Results tab:

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_GetTopSmartSearchResults expression rule.
    1. Add the case similarity score key and value to the cases map, as shown:

      cms_smartSearchSetup_casesMapTopResults

    2. Add the task similarity score key and value to the tasks map, as shown:

      cms_smartSearchSetup_tasksMapTopResults

    3. Click SAVE.

Step 6: Sort on similarity score when paging

The following steps detail how to configure the CMGT Add-On - Smart Search Module application to ensure the most relevant items, as determined by the similarity score, remain at the top of the search results across all pages.

To ensure that the sort on similarity score is persisted while paging the results:

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_SitePage_SmartSearch interface.
    1. In the local!pagingInfoForCases variable definition, add the sortInfo as shown:

      cms_smartSearchSetup_casesPagingSort

    2. In the local!pagingInfoForTasks variable definition, add the sortInfo as shown:

      cms_smartSearchSetup_taskPagingSort

    3. Click SAVE.

Step 7: Optional: Enable AI Smart Search on custom case fields

You may have custom case fields that you would like to include in the AI Smart Search logic when searching for cases. For example, maybe you have a custom field for Grant Details that is specific to the Grant Application case type. Remember that free text fields with unstructured data are the best candidates for AI Smart Search. For optimal performance, we recommend that you do not enable fields from many-to-one case relationships.

To include custom case fields in the AI Smart Search logic to find cases, complete the steps in this section.

Enable AI Smart Search on record type fields

Now, let’s update the record types to enable AI Smart Search functionality on the fields within. This involves configuring specific fields within your record types, allowing users to efficiently search and retrieve relevant data. By activating AI Smart Search on these fields, you are essentially creating an intelligent indexing system that will significantly enhance the discoverability of your information, making it quicker and easier for users to find what they need.

To update the record types:

  1. In Appian Designer, go to the CMGT Case Management Studio Base application.
  2. Search for and open the CMGT_ControlPanel control panel object.
  3. Navigate to the page for the type or category that contains the field for which you wish to enable AI Smart Search.
  4. In the Configuration section, find and open the record type that stores the custom data fields for that type or category (i.e. CMGT Grant Application).
  5. In the record type, under DATA, navigate to the Smart Search tab.
  6. Select the checkboxes associated with the fields you want to include in AI Smart Search (i.e. “Grant Details”).
  7. Click SAVE.
  8. Repeat these steps for any additional custom fields you want to include in the AI Smart Search logic across other types and categories.

Add record relationships to the base case record type

The goal of this step is to add a one-to-one relationship from the base case record type to the custom record type that stores field(s) that need to be included in AI Smart Search. You may have already added some of these one-to-one relationships for Process HQ. If not, follow these steps in this section to add them.

To configure the one-to-one relationships:

  1. In Appian Designer, go to the CMGT Case Management Studio Base application.
  2. Search for and open the CMGT_Case record type.
    1. Click ADD RELATIONSHIP.
      1. For Related Record Type, select the record type where you just enabled AI Smart Search for custom field(s) (i.e. CMGT Grant Application) and click NEXT.
      2. For Relationship Name, enter a readable relationship name (i.e. “grantApplication”).
      3. For RelationshipType, select One to One.
      4. Select friendlyId as the common field for the relationship.
      5. Click ADD.
    2. Repeat the steps to add a one-to-one relationship to CMGT_Case for each record type where you just enabled AI Smart Search for custom field(s).
      • Note: A record type can have a maximum of 50 record relationships.
    3. Click SAVE.

Include the new fields in the AI Smart Search queries

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_QR_GetSmartSearchResultsOnCases expression rule.
    1. In the fields parameter of the a!queryRecordType(), add the new fields where AI Smart Search has been enabled to the list.
      • Note: Make sure each field is referenced from the CMGT_Case record via the new one-to-one relationship.
    2. Locate the list of filters that contains the filters for case description and case title.
      1. In that same list of filters, add a filter for each new field where AI Smart Search has been enabled, with search as the operator. Follow the case description filter as a model and ensure sure each field is referenced from the CMGT_Case record via the new one-to-one relationship.
    3. Click SAVE.

Step 8: Optional: Enable Smart Search on record type fields

You may have custom task fields that you would like to include in the AI Smart Search logic when searching for tasks. For example, maybe you have a custom task type called Perform Analysis, and you added a custom field to CMGT_Task to store the analysis findings. Remember that free text fields with unstructured data are the best candidates for AI Smart Search. For optimal performance, we recommend that you do not enable fields from many-to-one task relationships.

To include custom task fields in the AI Smart Search logic to find tasks, complete the following steps:

Enable AI Smart Search on fields in the record types

  1. In Appian Designer, go to the CMGT Case Management Studio Base application.
  2. Search for and open the CMGT_Task record type.
  3. Under DATA, navigate to the Smart Search tab.
  4. Select the checkboxes associated with the fields you want to include in AI Smart Search (i.e. “Analysis Findings”).
  5. Click SAVE.

Include new fields in the AI Smart Search queries

  1. In Appian Designer, go to the CMGT Add-On - Smart Search Module application.
  2. Search for and open the CMGT_SMS_AI_QR_GetSmartSearchResultsOnTasks expression rule.
    1. In the fields parameter of the a!queryRecordType(), add the task fields where AI Smart Search has been enabled to the list.
    2. Locate the list of filters that contains the filters for task description and task title.
    3. In that same list of filters, add a filter for each new task field where AI Smart Search has been enabled, with search as the operator. Follow the task description filter as a model.
    4. Click SAVE.

Next step

Now that you have set up the AI Smart Search module, your case workers can start semantically searching for relevant cases and tasks in a dedicated Workspace site tab.

Feedback