Query Expressions - techtalk/SpecLog-Resources GitHub Wiki
You can use specific search tags to search for a search term in particular areas of a requirement. These tags can be used in both the Requirements widget and in search lists.
Note: All search tags are case-sensitive!
| Tag | Returns |
|---|---|
actor: |
Requirements with a matching entry in the Actor field |
crit: |
Requirements with acceptance criteria (including Gherkin files) containing the search term |
displayId: |
Requirements with a matching ID |
estimate: |
Requirements with a specific estimate. Use estimate[X TO Y] to return requirements with estimates between two values |
goal: |
Requirements with a matching entry in the Goal field |
tags: |
Requirements with a matching tag |
test: |
Requirements with linked Gherkin scenarios with the specified test result. See below for a list of possible result values |
title: |
Requirements with a matching entry in the Title field |
value: |
Requirements with a matching entry in the Value field |
workspaces: |
Requirements on a matching workspace |
gherkin: |
Requirements containing the search term in a linked Gherkin file |
has: |
Returns requirements that have a specific property. See the table below for a list of options. |
Test Execution Result Values
test:AllPassing |
Requirements where all automated Gherkin scenarios are passing |
test:FewFailing |
Requirements where a few automated Gherkin scenarios are failing |
test:ManyFailing |
Requirements where many automated Gherkin scenarios are failing |
test:AllFailing |
Requirements where all automated Gherkin scenarios are failing |
test:NoInformation |
Requirements containing Gherkin scenarios with no test execution results |
Search Options for has: Tag
| Search Term | Behaviour |
|---|---|
| attachment | Returns requirements that have attachments |
| criteria | Returns requirements that have acceptance criteria |
| estimate | Returns requirements that have an estimate |
| file | Returns requirements that have file attachments |
| gherkin | Returns requirements that have linked gherkin files |
| image | Returns requirements that have an image attached |
| parent | Returns requirements linked to a parent requirement |
| refinement | Returns requirements that have a refinement (child) |
| testresult | Returns requirements with test results |
You can use the following wildcards in your searches:
| Wildcard | Behaviour |
|---|---|
| * | Matches any number of characters |
| ? | Matches a single character |
The following Boolean operators are available to combine search criteria:
| Operator | Shorthand |
|---|---|
| AND | + |
| NOT | - |
| OR | | |
Note: Multiple search terms must be linked with a Boolean operator.
To search for a particular phrase containing spaces, include the phrase in quotation marks, e.g. goal:"Increase sales".
| Search Query | Search Result |
|---|---|
displayId:US* |
All user stories (requirements pre-fixed with US) |
displayId:US5 |
User story US5 |
has:gherkin |
Returns all requirements linked to a Gherkin file |
workspaces:Sprint1 |
All requirements on the Sprint1 workspace |
tags:Ready |
All requirements with the tag Ready |
estimate:3 |
All requirements with an estimate of 3 |
estimate:- |
All requirements without an estimate |
estimate:[* TO 3] |
All requirements with an estimate of 3 or less |
estimate:[3 TO 5] |
All requirements with an estimate between 3 and 5 |
estimate:[5 TO *] |
All requirements with an estimate of 5 or more |
+estimate:[1 TO 3] +tags:Milestone1 -tags:Done -workspaces:Sprint10 |
All requirements with an estimate between 1 and 3, tagged with Milestone1, but not tagged as Done, and not on workspace Sprint10 |
Note: The search in SpecLog is based on the Lucene Search Engine, which supports complex search expressions. Learn more about the query syntax on the Lucene website.