| Note | ||
|---|---|---|
| ||
It is difficult to provide the same support for every database vendor (MySQL, Oracle, Microsoft SQL Server, ...). If any search fails, please contact us using the internal "request support", we'll gladly investigate and it will help everyone! |
This page describes the search syntax to find requirements in Confluence. Requirement Yogi provides a search screen in every space.
...
Note: All those examples require Requirement Yogi 1.3.
| Search on... | Query | Result |
|---|---|---|
| Key | key = 'IG-1' | The requirement with the exact key. |
| key ~ 'IG-%' | All requirements starting with 'IG-'. | |
| Contents | text ~ '% something' | All requirements whose text ends with 'something'. |
| Pages | page = '467382' | All requirements defined on the page with ID 467382 (Does not include dependencies) |
| page ~ '467382' | All requirements defined or linked on the page. | |
| Issues | jira = 'JRA-21' | All requirements linked from the issue JRA-21. |
| jira@implements = 'JRA-21' | All requirements linked from the issue JRA-21 with the relationship "Implements" (since version 1.5) | |
| NOT (jira ~ '%') | Requirements which are not linked to any JIRA issue. | |
| Properties | @Category = 'Functional' | All requirements where the property 'Category' = 'Functional'. |
| Dependencies | TO = 'REQ-001' | Requirements which reference REQ-001. |
| FROM = 'REQ-001' | Requirements which are referenced by REQ-001. | |
| FROM ~ 'REQ-%' | Requirements which are referenced by any requirement starting with "REQ-". | |
| FROM@refines = 'REQ-001' | Requirements which "refine" REQ-001. | |
| Special | isModified('7') | Requirements which have been modified since the baseline '7' of the current space. It works both with the baseline number and with the baseline name. |
| Attachments | document = '48496653' | All requirements imported from the attachment with ID 48496653 (since version 1.14) |
Keywords
| Keyword | Function |
|---|---|
| AND, OR, NOT | Boolean operators |
| = '...' | Strict equality. |
| ~ '...%...' | Soft equality. Use % in the string as a wildcard. |
| @... | Reference to a property of the requirement (if you've defined requirements in columns). |
Fields
| Field | Definition |
|---|---|
| key = ... | The key of the requirement. Keys are unique per space. |
| spaceKey = ... | The space key of the requirement (case sensitive). |
| baseline = ... | The baseline name or number, between quotes. All statuses are implicitly included. |
| status = ... | The status of the requirement (ACTIVE, DELETED, MOVED). Default: ACTIVE. |
| text = ... | The contents of the requirement (Does not include the properties). |
| page = ... | The ID of a page linked to the requirement. |
| jira = ... | A JIRA issue linked to the requirement. |
| jira@relationship = ... | A JIRA issue linked with a specific relationship |
| @aproperty = ... | A property with name "aproperty" |
to@arelationship = ... from@arelationship = ... | A dependency with the relationship "arelationship". |