Use keywords or full-text searches
Use keywords, full-text search, or a combination. Full-text searches are applied to entity names, file paths, issue comments, issue codes, issue messages, owner names and bug IDs from a bug tracking system integrated with Validate. Searching, whether by keyword or full text, is not case sensitive.
Tips:
- Do not insert a space after the colon that follows the keyword.
-
Search uses space between keyword terms. All terms with the same keyword are merged together.
For example: status:Analyze state:New will find issues with the status 'Analyze' AND have the state 'New'.
status:Analyze status:Fix state:New will find issues with the status 'Analyze' OR 'Fix' AND have the state 'New'.
- Multiple values for a keyword should be separated by commas.
For example: status:Analyze,Fix will find issues with the status 'Analyze' OR 'Fix'.
If you do not use commas to separate multiple values, for example,
status:Analyze Fix
, the search engine will look for issues with the status 'Analyze' and then do a full-text search for "Fix" in entity names, file paths, issue comments, issue codes, and owner names.
You can use the following keywords for:
- Searching issues
- Creating or updating views
- The query parameter for the search,
create_view
, andupdate_view
actions of the Klocwork Web API.
If you enter an unrecognized keyword when searching for issues or creating a view, you'll see a warning.
Keyword | Format | Example |
---|---|---|
bugId |
bugId:<ID_number> To use this keyword, you must integrate Validate with your bug tracker.
|
bugId:15 |
build (not supported for views) |
build:<build_name or build_id> You can only search by one build at a time. Other acceptable syntax:
We recommend that you do not give your builds fully numerical names and note that your searches are always exact matches. You can use the build:any keyword, along with specifying state:Fixed to find issues fixed in a previous build. For example, to find a 'FNH.MUST' issue fixed in a previous build, search for
build:any state:Fixed FNH.MUST . |
build:build_2 or build:beta |
category | category:<issue_category>,<issue_category>... | category:"buffer overflow" |
ci |
ci:<ci_build_name or ci_build_id> You can only search by one CI build at a time. Other acceptable syntax:
We recommend that you do not give your CI builds fully numerical names and note that your searches are always exact matches. |
|
cited |
cited:'<time1>'-'<time2>' Acceptable time formats are 'yyyy-mm-dd hh:mm:ss' or 'yyyy-mm-dd'. Other acceptable syntax:
|
cited:'2011-10-24 07:45:30'-'2011-11-24 21:30:00' cited:2011-11-24 cited:'2011-11-24'-'now' cited:today cited:week |
citedby | citedby:<user_name> | citedby:jsmith |
code | code:<issue_code>,<issue_code>... | code:NPD.GEN.MUST, npd.const.call |
comment |
comment:<"issue comment"> Use quotes for expressions that contain spaces or punctuation. |
comment:"check with bob on this issue" |
diff (not supported for views) |
diff<build_1>,<build_2> Use 'last' to represent the last build.
|
diff:build_abc,build_def or diff:build_abc,last |
entity | entity:<entity_name>,<entity_name>... | entity:get_file_type |
file | file:<filename>,<filename>... | file:htmlparser |
grouping (not supported for views) | grouping:<'on' or 'off'> | grouping:off |
id | id:<ID_number>,<ID_number>... | id:33,59,149-160 |
line | line:<line_number>,<line_number>... | line:1-50,233 |
message | message:<message_string> | message:my_var |
module | module:<module_name> | module:my_module |
owner |
owner:<name or group> Searches user accounts, group accounts and the |
owner:smith,lee,devteam |
recommended | recommended:<'on' or 'off'> recommended:<'true' or 'false'> The 'recommended' keyword is used to filter by SmartRank issues. 'On/True' returns SmartRank issues. 'Off/False" shows issues not meeting the SmartRank threshold. Omitting this keyword returns both. |
recommended:on |
reference |
reference:<ref_string>,<ref_string> If using only the reference keyword in a search, the list of issues is correct, however the meta-data for the listed issues is incorrect. If you add additional search keywords, the results are as expected. We recommend only using the reference keyword to further refine your search.
|
reference:20,cast.ptr |
severity | severity:<severity_name or severity_number> | severity:critical,4,error, 2-4 |
state (not supported for views) | state:<state_name>,<"state name">... | state:existing,fixed |
status | status:<status_name>,<"statusname"> | status:ignore,"fix in next release" |
supportlevel | supportlevel:<level_number> | supportlevel:1, 2-3 |
taxonomy | taxonomy:<taxonomy_name>,<"taxonomy name"> | taxonomy:"MISRA C","MISRA C++" |
unique |
unique:<'true' or 'false'> The negation of this keyword is not currently supported.
|
unique:false |