Configuration for In Focus webparts

The "In Focus" web part in Atlas is used as the basis for many other web parts that can be added to pages with specific configurations such as Latest Knowledge, Upcoming Events, Latest News etc.

Whichever type of web part you are using, as long as it is based on the In Focus web part, it can be configured quite extensively. The web parts that are based on In Focus can be found on the following page: In Focus web parts

If you just need a quick guide to adding Refinement Filters please see the following article: Refinement Filters configuration for In Focus web parts

If you just need a quick guide to adding Importing/Exporting In Focus web part configuration please see the following article: Export and Import Settings for In Focus web parts

Configuration options are briefly explained in the In Focus web parts article, but in this article we explain the options in detail. Please be aware that this is considered advanced configuration. If you need assistance with a specific requirement please get in touch with our support team or your CSM.

In this article

• Search query configuration (first panel)
• Search settings (second panel)
• Paging settings (second panel)
• Quick Add It settings (second panel)
• Web part settings (second panel)
• Styling options (third panel)
• Template options (third panel)

Start Configuring

When editing a Modern page, click the "pencil" icon to the left of the web part you want to configure and the configuration panel will appear on the right side of the page. In Focus web parts have three pages of options. Click next / previous at the bottom of the panel to move between the pages:

1. Search query configuration
2. Search settings, Paging settings
3. Styling options, Template options

Search query configuration (first panel)

On the first panel you can add search query keywords to filter your results:

   

If you add a specific word or phrase, results will need to contain that word or phrase somewhere in their content or metadata to appear. If you leave this as the wildcard (*) all results can be returned. Usually, you should leave this as just the wildcard, and configure refiners using Managed Properties in the second panel, explained below.

Also on the first panel, you can click the ellipsis (...) to Connect to source for advanced scenarios where advised by your CSM or support team.

Search settings (second panel)

On the second panel, the first group of settings shown is the Search settings.

   

The Query Template by default contains the text "{searchTerms}" as shown in the image above, which refers to any terms entered by the user in a Search Box connected to the In Focus web part. If you have not connected a Search Box to this web part this text can still be left here without causing issues. You can also use Managed Properties here in the format RefinableString123:"Value" to pre-filter the results by a specific metadata value, for example to show all documents with a specified Document Type.

The Result Source Id / Name refers to the type of results you want to return. The default Result Source is determined by the specific In Focus web part you add to your page - for example Knowledge In Focus will use the "Mixed Knowledge (Atlas)" Result Source which includes both Knowledge Pages and Knowledge Documents, but there is also a specific source "Knowledge Pages (Atlas)" (pictured above) which would not return the Documents.

If you want to change the Result Source for a specific In Focus configuration, you can find a description of the available Result Sources here: Result Sources for In Focus web parts (Atlas 2.X)

If you clear the value from the Result Source Id / Name this will mean you return all possible results whether or not the content is part of Atlas, so it is generally not recommended. If you do this you should ensure you apply some refiners to return the content you need.

   

To configure the next two sorting settings you will need to refer to this list of Managed Properties for Atlas columns: Atlas 2.X - Managed Properties for Search

• In Atlas 3.1 and above, you hve an additional toggle which can control whether the Sort Order dropdown is shown or not:
  
• Click the Edit sort order button to choose how the items are sorted by default in the web part. Choose one or more Managed Properties and the Sort direction for each then click Save:

• Click the Edit sortable fields button to determine the fields available for a user to change the sort order from the dropdown menu in the UI. This does not affect the default sort. Choose one or more Managed Properties, set the Name and Sort direction for each then click Add and save:

• Set Connect to a search refiners web part to Yes if you will use an In Focus Filters web part to provide refiners for this In Focus web part. Learn how to configure the In Focus Filters web part here: In Focus Filters web part
• Set Connect to search verticals to Yes if you will use an In Focus Verticals web part to provide verticals for this In Focus web part. Learn how to configure the In Focus Verticals web part here: In Focus Verticals web part
• Set Include personal OneDrive results to Yes if you want to allow users to see their OneDrive files in this web part, noting that they can only appear if they match the other search settings.

     

• The Selected Properties field shows the properties being retrieved from Search to display items. In order to add properties to be displayed in the Details List view for example, you need to make sure they are listed in this field. If they are not available to select, you can type them at the end of the current list.
  • For example, to display the Reference in the Details List view you need to ensure the property CPReferenceOWSTEXT is listed in the Selected Properties above.
• The Refinement Filters field allows you to define specific metadata tags to match against the results. This is explained in a separate article: Refinement Filters configuration for In Focus web parts
• Set Enable taxonomy values localization for refiners and results to Yes if you want to show users translated terms in their preferred language (if translations are configured for those terms).
• The Language of search request can be set if a page or site will be mostly used by users who prefer a language other than the current Interface Language.
• Click Edit synonyms to allow users to use different terms to refer to the same thing - for example you could set up a synonym so whenever a user searches for the term "mail" it would apply a synonym "post" and search for either term in the results:

• 1. Type the term you want users to be able to type in
  2. Type the synonyms of that term you want to automatically add to searches
  3. Check the box if you want this to work both ways - by default it enhances the Term with the Synonyms but not the other way around
• Click Save on the synonyms panel to save your changes. Be aware that synonyms only apply to the current In Focus web part being configured.

Paging settings (second panel)

If you collapse the Search settings or scroll down past them, you can see the Paging settings. Generally they are quite self-explanatory:

   

• Show paging - do you want to show the paging controls?
• Number of items per page
• Number of pages to display in range (if paging controls are shown)
• Hide navigation buttons - on or off
• Hide first/last buttons - allows paging but doesn't show the additional first/last links
• Hide navigation buttons if they are disabled - for example if there is only one page of results.

Quick Add It settings (second panel)

From Atlas 3.3 a new section can be found called Quick Add It settings:

By default Quick Add It is turned off. To understand how to turn it on and configure it please find more information here: Enable Quick Add It for an In Focus web part (Atlas 3.3+)

Web part settings (second panel)

With Atlas 3.1 and above, there is an additional section on the second panel which is the Web part settings section. From here you can import and export the settings for the entire In Focus web part so that you can reuse the configuration without having to rebuild it every time you need it.

At the top of the section you can choose the Global or This workspace storage option. This will determine the scope for your configuration file and therefore may affect which users can load specific configurations and which workspaces can see them. For example using the This workspace scope in the Finance workspace would only allow those configurations to be imported within the Finance workspace. If you need to reuse the configuration across more than one workspace you should choose Global storage for the files.

Export settings

At any point you can save the configuration of an In Focus component, but we recommend you complete the full configuration before exporting so that you don't have to repeat any steps after importing later.

To export your settings, make sure you have chosen the desired storage scope above, then type in the filename you'd like to use for these settings and click te Save settings button. Those settings will now be available from the Import settings button within the storage scope.

Import settings

Once you have some saved settings available, you can add a new In Focus component to a page, then return to this panel to import the settings. Start by clicking the Import settings button, which will load a file picker scoped to the storage scope chosen above - e.g. if you created a Global configuration make sure you choose Global above before clicking Import settings.

The file picker will show the Atlas Configuration workspace for Global settings or the current workspace for This workspace settings.

Choose the file which contains the desired configuration and click Apply in the bottom right of the picker to choose it and load the configuration into the In Focus web part.

Make sure you save or publish the page with the web part on it once yu're happy with the configuration. If you don't save the page then the changes to the web part will be lost.

Styling options (third panel)

On the third panel, the first group of settings shown is the Styling options:

   

• Web part title - you can change this to whatever you want, or delete the text if you don't want to show a title
• Show blank if no result - turn this off to completely hide the web part from the page if no results are returned
• Show results count - turn this off if you don't ant to show users how many total results are being returned
• Results Layout - you can pick from a few options but usually you will choose Details list, Carousel or Tiles. If you are displaying People you should choose the People layout.
• Edit Template - this shows the code block for the display template for the items. It is not recommended to change this unless instructed by support.
• Edit Result Types - click this button to specify specific display templates to be used by specific Content Types in the results. Generally you should not need to configure this, so if you need to do so please get in touch with support for assistance.

Template options (third panel)

If you collapse the Styling options or scroll down past them, you can see the Template options. Different Results layouts have different options. Some layouts have no additional options:

• Debug (not for general use)
• Tiles (the template can be edited but this requires some knowledge of the code)
• Custom (requires custom code to be written and is not for general use)

For tile-based layouts

If you have Atlas 3.2 you will have additional options on the configuration panel allowing you to set the background colour for the tiles:

Details List layout

For the Details List layout you have the following options:

   

• Click Manage columns to determine the column values to be returned for each item. Please note that fields used here must be added to the Selected Properties list in the Search settings on the previous configuration panel. This will open a panel over the page:

• • You can show as many columns as you want in this layout, but bear in mind the width of the page section where you want to show the web part. You can use the Handlebars expression option to combine multiple metadata properties into a single column for the item. For example, we can use the following expression to combine the Reference and Title properties into a single column:

{{CPReferenceOWSTEXT}} - {{Title}}

• • If you do not need to combine any fields, you can uncheck Use Handlebars expression and choose the appropriate Managed Property from the dropdown. To see the Managed Properties for Atlas properties please refer to the following article: Atlas 2.X - Managed Properties for Search
• Set the Show file icon behaviour to Yes or No
• Turn Compact Mode On or Off.

People layout

For the People layout you have the following options:

   

• Click Manage persona fields to determine the fields to be returned on each card. Please note that fields used here must be added to the Selected Properties list in the Search settings on the previous configuration panel. This will open a panel over the page:

• • You are limited to showing 5 fields on the cards, but you can use the Handlebars expression option to combine multiple Profile fields into a single field for the card. For example, in the default configuration the FirstName and LastName fields are combined using the following expression:

{{FirstName}} {{LastName}} 

• • If you do not need to combine any fields, you can uncheck Use Handlebars expression and choose the appropriate Managed Property from the dropdown. To see the Managed Properties for Atlas properties please refer to the following article: Atlas 2.X - Managed Properties for Search

• Choose the Picture size to be used.

Carousel layout

For the Carousel layout you have the following options:

   

• Set Infinite scrolling to On or Off - should the web part loop back to the first item after showing the last item?
• Set Auto play to On or Off
• Advance element every (seconds) - default 6 seconds
• Set Pause on hover to On or Off.