Searches for artifacts in requirements projects

You can find artifacts using quick search, full text search, and filters. Search can be done with the artifact ID or with text within the artifact.

Quick Search

To see recently viewed artifacts, click the Recently Viewed Artifacts icon Recently viewed artifacts icon.

Use the Quick Search feature to quickly search for artifacts in projects or components. You can search in the current project or component, another project or component, or all projects or components. In a configuration-enabled project, the Quick Search feature is only supported in a global configuration context.

  1. Click the project or component icon to set the scope of the Quick Search. By default, the scope is the Current Project.
  2. In the Search Artifacts field, enter an ID or text string to search for. If you enter an ID, the search returns the artifact with that ID. If you enter a string, a full text search is performed. For more details on full-text search, see the Full-text search section below.
  3. Optional: Specify more options to further limit the search, such as modification details, the artifact type, and whether to search in modules, folders, or both.

The Quick Search options are saved across browser sessions.

Filters

Use the Type to filter by text or by ID field to filter and search for artifacts. To filter based on ID, enter an ID and the search returns the artifact with that ID.
Note: To search for an artifact by ID, in the Type to filter by text or by ID field, enter the complete ID. When you search by ID, the search operation performs a full-text search and uses whole-word matching to find the exact match for the ID. The search eliminates partial matches from the results and displays the artifact with that exact ID.
To filter artifacts based on text in the artifact, enter a single search string or multiple strings. A full-text search looks for the specified word or phrase within the content of the artifact and in attributes that are String data type. If you enter multiple search terms, the search returns artifacts that match all the terms. See the following section on full text search for more details.

You can narrow the search results further by adding filters such as the artifact type, modification date, and tag criteria. You can also sort and group the results and add or suppress artifact details from the results. See Filters and views for artifacts in requirements projects for details on filtering, page settings, and column display.

Full-text search

A full-text search looks for the specified word or phrase within the content of the artifact and in attributes that are String data type. For example, Name and Description. The search returns artifacts that contains a word that starts with the search string. If you enter multiple search strings, an AND type of search is done and artifacts that contain phrases that match the search strings are returned.
Note: Searches are not case-sensitive.

You can preface each search term with an asterisk (*) to do a contains search instead of a starts with search.

Use double quotation marks to search for an exact phrase. The search will return artifacts that contain all the words and in the exact order that you have entered them.

The following table shows some example artifacts with some textual content. The next table has some search entries and their resulting search returns.
Table 1. Example artifact content
Artifact Number Artifact Name Artifact content
1 Automatic Meter Reader A system to automatically collect data on consumption, pressure or other diagnostic, and status from a meter.
2 Meter Reading The ability to walk by the locations where the meters are installed and the meter is automatically registered by a handheld computer carried by the meter reader.
3 Usage Scenario The Meter Reader is unable to collect usage data from the Water Meter due to lack of connection or a fault.
4 Fault Scenario The Meter Reader sends a command to retrieve the fault status.
Table 2. Example search entries and their results
Search entry Search results
read Artifacts 1, 2, 3, and 4. These artifacts have the words reader and reading, which start with the search string read.
held No artifacts. None of the artifacts have words that start with the search string held.
*held Artifact 2. This artifact has the word handheld, which contains the search string held.
"collect data" Artifact 1. This artifact has the exact phrase collect data.
auto Artifacts 1 and 2. These artifacts have the words automatic and automatically, which start with the search string auto.
scenario Artifacts 3 and 4. These artifacts have the word scenario, which start with the search string scenario.
press coll Artifact 1. This artifact has the words pressure and collect, which start with both of the search strings press and coll.
Restriction: The full-text search does not support special characters. If any of these characters ( ) { }[ ] < > / \ : ; * ? ! _ - | & . , ' " « » ~ ^ are included in the search string, the results will be inconsistent. Also, since these characters are not indexed, they do not affect search results. For example, if your search entry is test, you will get matches for <test>, {test} even though the search is a starts with search.

For more information on this limitation, please review the workarounds and limitations article on jazz.net.

Setting a limit to the full-text search results

If the full-text search results exceed the limit specified in Advanced properties, a warning message is displayed. warning message.
Note: When you add filters to the full text search query, the specified limit is first applied to the full-text search results. These results are then filtered by the additional conditions.

To specify the number of artifacts that are returned when doing a full text search, on the Administration menu, click Manage Server Administration > Advanced Properties. You can set the limit for modules in Text search maximum results – Module and for other requirement artifacts in Text search maximum results – General. When a text search scope is not set to a module, the general maximum limit is applied. When a text search scope is set to a module, the module maximum limit is applied.

If you perform a search and the query does not return any result, a message appears to indicate that no results were found.


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