Search Syntax

This page describes the search syntax to find requirements in Confluence. Requirement Yogi provides a search screen in every space.

By default, only active requirements of the current space are displayed. Use the URL to display deleted requirements or to search across spaces.

Examples

Note: All those examples require Requirement Yogi 1.3.

Search on...	Query	Result
Key	key = 'IG-1'	The requirement with the exact key.
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) (Before RY 3.1, it would retrieve all current-or-baseline requirements on all versions of this page). (Before RY 2.5, quotes around the page ID were necessary)
Pages	page ~ 467382	Same as `links ~ `, except it is not intuitive. (Before RY 3.1, it would retrieve all current-or-baselined requirements on all versions of that page).
Properties	@Category = 'Functional'	All requirements where the property 'Category' = 'Functional'.
	ext@Category = 'Functional'	All requirements where the external 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 are "refined" by REQ-001.
Variants	variant = 1	All requirements with the variant id 1
	variant = 'Current'	All requirements with the variant name Current. Note: all spaces have a default variant called Current
	variant = ('Current' in space 'ANOTHER')	All requirements with the variant name Current in the space ANOTHER
Space	space = 'HOME'	All requirements in the space HOME. Note: cross space search is not yet available

Keyword	Function
AND, OR, NOT	Boolean operators
= '...' == '...'	Strict equality.
~ '...%...' like	Soft equality. Use % in the string as a wildcard.
@...	Reference to a property of the requirement (if you've defined requirements in columns).
IS NOT NULL	Can be used for the field 'baseline'

Field	Definition
key = ...	The key of the requirement. Keys are unique per space.
spaceKey = ...	The space key of the requirement (case sensitive).
status = ...	The status of the requirement (ACTIVE, DELETED, MOVED). Default: ACTIVE. There is generally no reason to use it, since those statuses are internal details about requirements. You would rather define your own property named "Status", and search them using @status = 'Approved' for example. Do not confuse "status" (our internal implementation detail) and "@status" (any user-defined property).
text = ...	The contents of the requirement (Does not include the properties).
page = ...	The ID of a page or a version where a requirement is defined.
links = ...	The ID of a page where a requirement is linked (or defined). "~" is undefined.
jira = ...	A JIRA issue linked to the requirement.
jira@relationship = ...	A JIRA issue linked with a specific relationship.
@aproperty = ...	A property with name "aproperty".
ext@aproperty = ...	An external property with name "aproperty".
to@arelationship = ... from@arelationship = ...	A dependency with the relationship "arelationship".