Advanced Search - Early Access

NEW IN RELEASE 88

Advanced Search is an Early Access feature starting in IQ Server release 88.

This feature must be opted into to be used due to its Early Access nature, can be opted out at any time, and is liable to change in subsequent IQ Server releases.

In particular, the search item types, field names, and syntax may be altered.

This feature allows you to search for the following types on a variety of fields using a powerful search syntax.

  • Organizations
  • Applications
  • Application Categories
  • Component Labels
  • Policies
  • Security Vulnerabilities

Security vulnerabilities are only indexed for the latest application composition reports.

A search index is required in order to use this feature.

In the following, we describe how to create a search index and how to search, including what you can search on and the search syntax.

Creating a Search Index

Creating a search index is a resource intensive operation that can be demanding on IQ Server's database and which can take in the order of minutes to complete depending on IQ Server's database size.

We highly recommend only performing this operation at times when your IQ Server is under minimal usage.

A System Administrator can create a search index either via the Advanced Search REST API or through IQ Server's UI via the Advanced Search Early Access configuration page in the System Preferences menu. The latter requires the opt-in checkbox to first be ticked (but not necessarily saved) in order to click the "Re-Index" button.

After successfully creating a search index you will see the last index time shown on the configuration page.

Enabling Advanced Search

Advanced Search results are currently not restricted by permissions.

This means that an IQ Server user could see results for items that they would not normally be able to view.

However this does not mean they can access restricted items, merely that they can see their existence as well as any information included in the Advanced Search results themselves.

After a search index has been successfully created you are ready to enable the Advanced Search - Early Access experimental feature and make it available to all IQ Server users.

To do this a System Administrator must opt-in through IQ Server's UI via its configuration page.

Performing a Search

After enabling Advanced Search, IQ Server users will have the option of performing a search.