Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This module is a way to let users search different kinds of content connected to your site.

From version 3.0 onwards users can search for

  • Jira Issues (Not JSM customer requests)
  • Issue Types
  • Knowledge Base articles
  • Recommended Links
  • Request Types
  • Navigation Pages.

The Search Module is setup to search the context of your choice, and displays results as you type your search.

Image Removed

Adding the Search Highlight module to a site, category or project

...

Ui step

Click the edit pen in the top right corner of the page, to open up the layout editor on the pages.

Ui step

Click to Add module to the section where you want to add the module. You can easily drag and drop the module to a different position later. 

...

Edit the settings accordingly.

...

Save the module, then publish the layout - or click preview to review before going public. 

Recommended Links

Add Promoted Search Results to guide users further. These are links added by the Jira Admin, Refined admins or agents to any resource available online.

Recommended Links will automatically be included in the search results once they are configured.

...

Use the Search Highlight module to add a search bar to a page. The search results vary depending on the page the module is placed on:

  • If the module is placed on a parent page in the Site Builder hierarchy, it gives search results from any child content or item.

  • If the module is placed on a Jira project’s home, it also gives results from these projects or spaces.

Furthermore, it’s possible to set up Promoted Search Results to guide users further.

You can add this module to your site home, category homes, and Jira projects/JSM portals.

...

Knowledge base settings 

Refined supports all Confluence Server/Data Center knowledge bases. Additionally, we support Confluence Cloud knowledge bases for search highlight modules that have default settings applied.

Please note though that users may not be able to view knowledge base articles when their browser prevents cross-site tracking, which is the default option in Safari and Firefox. This issue is present in JSM too and not caused by Refined.

There are two ways to configure the Knowledge Base Search (KB):

...

default

...

and custom

...

.  

Default Search Settings

...

Use the settings as configured in your service project.

Custom Search Settings

Ui text box
typeinfo

This functionality works through Application links. Due to technical limitations it will not work with Confluence Cloud knowledge base. 

...

Custom search settings let you specify what spaces within your Confluence instance to search, or to search the entire Confluence

...

This setting also allows you to show the results in different ways - popup, same window, new window - and if you have licensed users (not using the unlicensed feature of Confluence) you can even display the search tree of the space in the article popup. 

Learn more about Knowledge Base settings

...

instance.

Setting

Description

Search for

...

Include Confluence pages and/or Confluence Questions in the search

...

results.

Confluence

...

Specify the exact Applink that should be used to search, including the port.

...

URL

Please note there needs to be an AppLink set up for your Confluence instance. The URL needs to be exactly the same as the one configured in the Application Link.

Space

Enter a space key here to only include pages from that Confluence space. Add a dash ( - ) in front of a space key to exclude its pages. Separate multiple pages with commas. Leave empty for a global Confluence search.

Include space name

Include the space name in the search results.

Open link in

  • New window

  • Same window

  • Pop up, articles only