Search Application

Search Suggest

In order to search the wiki or the entire farm, go to any page, click the magnifying glass icon in the top menu bar which will load a text input to the left, type your keyword and hit "Enter". 

SearchWiki.png

The suggestion as you type feature for the search box will help you by grouping the results as follows:

  • Page name 
  • Page content
  • Attachment name
  • Attachment content
  • Users
  • Blog posts
  • Wikis
Starting with version 7.2, you can search in nested pages.

SuggestionBox.png

To see the complete list of results, click on "Go to search page..." in the top right corner of the suggestion box and you will be redirected to the page Main.Search. In case no result is found, the search box will display a message and a link to the search page.

SearchNoResults.png

The search suggest is using the Solr engine by default, due to the fact that we have created a search suggest service based on Solr. We have also added search suggest sources that mimic the behavior of the existing Lucene-based ones so that now the search suggest takes into account the configured search engine. More information is available in the Search Suggest configuration page.

Solr Search Application

The XWiki Enterprise default search engine is Solr, based on Apache Solr which has its own index, separate from the Lucene index. You may access the Solr search page by navigating to Main.SolrSearch.

The Solr search module automatically indexes the changes made on the wiki and at each startup a background job checks if the Solr index and the database are synchronized. If not, the job only applies the updates. Manual indexing is still available because it is more stable so, in case you need to perform it, follow the steps described in the "Search Configuration" documentation page. 

SearchSOLR.png

By default, results are sorted by relevance i.e. depending on the scoring of each page. You may also choose to filter the results by title, the last modification date or the last author. If the keyword is not found in the page title, the wiki name or the page name but in content of the wiki page, the search results will also display excerpts in which each occurrence will be highlighted.

SimpleSearchSOLRResults.png

The number of displayed results depend on the user rights on the pages. So, normally, an administrator user will get more matches than one with basic privileges.

Also, the display of the result location has been updated to in order to support nested pages.

Initially, only one match is displayed, but you can view all the matches by clicking on the "Highlight all matches" link.

HighlightAllMatches.png

To disable highlighting, click on "Highlighting" below the search input. When the functionality is disabled, the text switches from bold to normal.

DisableHighlighting.png

In order to receive RSS updates about the wiki pages containing the keyword you are searching for, click the "RSS feed for search on [keyword]" link at the bottom of the search results.

SolrSearchRSS.png

To the right, the "Refine Your Search" panel displays search facets that will help you analyze search results depending on the space and page name, the creation and last edit date, author and creator. The displayed facets are always relative to the current search results and they support multiple selection. Moreover, selecting a value doesn't hide the rest of the displayed values for that facet and you can still see the number of results matching that value. Finally, the facet selection is preserved when performing a new search.

SearchFacets.png

Categories can be expanded or collapsed by clicking on the corresponding "Expand all" or "Collapse all" link in the panel header. You can also clear the current facets by clicking on the "Reset all" link.

The "Results Type" facet defaults to "Document" type. The reason is to keep the consistency with the old "Result Type" filter from the "Advanced Search" options which was set to include by default only pages in the search results.

ResultsTypeFacet.png

Other possible values are:

  • Object
  • Object Property
  • Attachment

ResultsTypeFacetAll.png

Depending on the result type, the UI displays a dedicated icon which is retrieved from the Flamingo Icon Themes. Also, when searching in Objects and Objects Property, the displayed results contain the page title and a location breadcrumb.

ResultsObject.png

ResultsObjectProperty.png

If the wiki is multilingual, you can also select the language in which to perform the search. In case no option is selected, the "No Language" option will be taken into account, along with the default current wiki language, which in this case is "English". We have chose this approach in order to avoid confusion because some pages don't have a default language set (like the ones containing pieces of code) or they are part of the XWiki UI, therefore they are displayed in the current language.

SearchSOLRLanguage.png

Entities are indexed with the list of supported locales, which means that if your current locale is "fr_FR" you will find all entities that you would have seen when the current locale is "fr_FR".

The "Space" facet has been replaced with a "Location" facet that supports nested pages and allows to search in a specific location in the page hierarchy.

LocationFacet.png

The "Page" facet has been removed by default because it doesn't bring value in the context of nested pages as all non-terminal pages are named "WebHome". The "Wiki" facet is displayed by default only on the main wiki and only if there are multiple wikis created.

The "Last Modification Date", "Creation Date" and "Upload Date" facets provide time intervals for an easier navigation like:

  • Today
  • Last 7 Days
  • Last 30 Days
  • Older than 30 Days

DateFacets.png

but also allow you to specify a custom date and time interval using a Calendar Picker.

CustomDateTime.png

The File Type facet filters results based on the attachment file type. File types are grouped by category like image, text, Office file and you can select either an entire category or a specific file type. 

FileTypeFacet.png

The File Size facet allows you to filter results based on the attachment size. You can now choose between 4 ranges:

  • Tiny for less than 10Kb
  • Small for sizes between 10Kb and 500Kb
  • Medium for sizes between 500Kb and 5MB
  • Large for more than 5MB

FileSizeFacet.png

The "Creator", "Last Author" and "Uploaded By" facets display the full name, alias and user avatar.

CreatorFacet.png

In case the task is too slow, you may disable faceting by clicking on "Facets" below the search input. When the functionality is disabled, the text switches from bold to normal and the facets panel is hidden.

DisableFaceting.png

One important Solr search improvement is the fact that starting with cycle 7.x the UI is responsive on small screens. On mobile phones, the facets panel is collapsed between the search box and the search results and the user can easily expand it with a tap.

CollapsedFacetsPanelSmallUI.png

Database Search

The database search page performs HQL queries in the database and it is available by navigating to Main.DatabaseSearch.

SearchDatabase.png

Starting with version 7.4, the spaces drop-down was replaced with a "Location" input in order to add support for nested pages.

      

Search this space