Using the context-aware search

Use the context-aware search to locate relevant information in your code, based on free text searches. You do not have to specify wildcard patterns to find what you want. The search is run on search engines configured by your administrator, and can cover any of the components you have configured for indexing. For best performance, you should only select the components that are likely to contain relevant files for your search. If your components contain common synonyms, and you have the user permission to do so, you can modify the search configuration to look for those synonyms and abbreviations; otherwise, contact your project area administrator to make those specifications to facilitate your search.
There are two types of searches, and you can initiate either in several ways:
  • Context-aware search

    There are different types of searches. By changing the Search For selection, you can specify the type of information to search for. If you are unsure which type of search to use, select the Perform quick search option. The quick search performs multiple searches and presents only the high ranking results.

    You can initiate the context-aware search from the following areas in the user interface:

    Search menu
    Click Search, then select Context-Aware Quick Search
    Tool bar
    Click either Context-Aware Quick Search icon, or Search > Context-Aware Quick Search.
    Either of these selections opens the Search dialog. On the Context-Aware Search tab, specify and select the following items for the search:
    • Query: Select search words from the menu or enter words in the Query field.
    • Quick Search: Select the Perform quick search box if you want to run a quick search. For quick searches, you can specify how many results to display. If you do not select the Perform quick search box, select the type of information you are searching for—class; information in a comment; a file; a function; or any relevant text—in the Search For group.
    • Components: Select whether you want to search all loaded components or selected components in the Component group. Click Choose to open the Component Selection dialog. You can select individual components or click Select all to search all components. You can also specify whether the components are searched in all streams and workspaces or only the streams and workspaces you select. Click OK to return to the Context-Aware Search tab.
    • Project Area: Either accept the selected project area or click the arrow next to the displayed project area to change it. Clicking Refresh ensures that your choices are synchronized with the latest configuration: for example, if your administrator adds or removes a component from the index, you might need to refresh to see the change in the Component Selection dialog. If you try to search for a component that is no longer included, you might receive a message telling you to synchronize or refresh. If you receive such a message, open the Search dialog, select the Context-Aware Search tab, click Refresh, and try repeating your search.
    The following messages could be listed on the Context-Aware Search tab:
    No searchable components are loaded
    You selected the All loaded components option, but none of the components loaded into the local workspace is configured to be indexed in the context-aware search.
    No searchable components are currently available
    Either none of the search engines supporting the context-aware search configuration of the selected project area are online or no components are set up for indexing in the context-aware search configuration of the selected project area. Clicking Refresh might fix this problem if search engines have come online or the administrator has added components to be indexed since the last time the displayed data was refreshed.
    You don't have the necessary Client Access License to use this functionality. Please contact your administrator.
    The user does not have the required Developer for IBM® Enterprise Platforms client access license (CAL) for the given project area repository.

    When you complete your selections, click Search. If you selected the Perform quick search option, the results are presented in the Context-Aware Quick Search view. This view displays the high ranking results for each of the searches you performed. You can use the component selection button to view the high ranking results from one or all of the searched components. If you did not select the Perform quick search option, the results are displayed in the standard Search view. Click List view to see a list of the results. Click Path view to display the results in a tree. You can open results in the tree by double-clicking them, or using Show Next Match and Show Previous Match. Click Navigate by Score to select whether the arrows move to the next or previous result according to the score of the results, or according to the path of the files.

  • You can initiate a context-aware search for work items, which helps you locate relevant information in work item source code, from the following areas in the user interface:
    The displayed list of work items
    Right-click a work item and, from the popup menu, select Open Context-Aware Search.
    The open display of a work item
    Click the arrow next to the work item number and, from the menu, select Open Context-Aware Search.
    You can select the following items when you perform a context-aware search for work items:
    • Components: Click Choose to open the Component Selection dialog. You can select individual components or click Select all to search all components. You can also specify whether the components are searched in all streams and workspaces or only the streams and workspaces you select. After you click OK, you can add or remove terms that are in the work item, as well as other terms that you specify, to be included in the search.
    • Work item terms: The terms in this field are used for the search. Based on the components you selected for the search, work item text is analyzed and the terms are ranked by relevance. The highest ranking five terms are automatically placed in the field. If one of the automatically placed terms isn't relevant, remove it from the Work Item Terms field. Click Add Next Terms to add the words into the list of terms following the Work Item Terms field . You can remove words from the list by highlighting them and then clicking Remove Selected. You can click Undo to remove an added term from the Work Item Terms field, or to add a removed term back to the Work Item Terms field.
      Note: For the most accurate results, keep the number of query terms as small as possible.
    • User terms: These are any terms that you want to include in the search.
    When you complete your selections, click Search. The results of the completed search are displayed in the standard Search view.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki