Configuration for In Focus web parts (Atlas 5.0+)

If you have Atlas version 4.0 to 4.3 please refer to this article instead: Configuration for In Focus web parts (Atlas 4.0 - 4.3)

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.

Getting started

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.

The settings are split into eight sections. Use the table of contents at the top of this page to jump to a specific section.

Web Part Title

To change the Title of the new web parts, you should just click into the title on the web part itself and start typing. The Title is not set through the config panels.

Data source

First you need to choose the data source for the web part. If you are familiar with In Focus web parts prior to Atlas 5.0 you most likely want to choose "SharePoint Search" for a similar experience.

Microsoft Search and SmartHub are available for custom scenarios but are not covered in this article. If you need to use one of these data sources please speak to your CSA or raise a support ticket.

Please note that when changing data source any other changes to the web part will be lost.

SharePoint Search

Please note that this section will be completely different if you choose a different Data Source but for standard Atlas scenarios you should be using SharePoint Search so that is what we will cover here.

The first section contains the Query Template:

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. You can add refiners using Managed Properties too.

The text "{searchTerms}" as shown in the image above 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 specific value in the Department, Subject or any other Atlas column.
Next is the Result Source. If you are using a pre-configured web part such as Documents (Atlas) the result source will already be set to the appropriate value.

To learn about the available Result Sources please see this article: Atlas Result Sources for Search
Next we have some options to limit the scope of the search by workspace, user preferences or audience:
- - You can apply a user's preferences to the in focus configuration to show a customised view of content based on the user's own tagging selection. You can read more about this feature here - Personalisation Features

Next we have some Sorting options; a toggle to show or hide the sort order dropdown, and a button to configure the fields available for sorting:

Behind the Edit sort settings button you can determine the fields available for sorting, and which is the default order. Choose one or more Managed Properties in the "Field name" column, set the Name and Sort direction for each then click Add and save:

You may need to refer to this list of Managed Properties for Atlas columns: Atlas Managed Properties for Search

Finally, we have the Refinement filters box. This is populated by connecting the web part to an In Focus Filters web part, setting the filters in edit mode, then clicking the apply selected filters button:

Connections

Set Connect to a search box or other input query to Yes if you want to connect a Search box to let the user filter the results, or filter using URL Query Strings.
- Use a Static Value if you just want to set some specific query text:
- Use a Dynamic value to connect to a search box or Query String. For a search box just choose the option and then the specific Search box:
- Use a default value if you want to apply a filter before the user applies their own using the search box.
- To configure this for a Query String please read this article: Create dynamic pages using In Focus and Query Strings
Set Connect to a filters 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 a verticals Web Part 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

Layout

Under the "Layout" section are a number of options related to how the results are shown:

Show blank if no result - should the web part appear with a message that there are no results, or should it simply not appear at all when there are no results?
Open link in modal window - if left off the link will open in the current tab, navigating you away from the current page. If turned on, the link will load in a "lightbox" or modal window on top of the current pag without navigating you away. You can close the modal to get back to the page immediately.
Show results count - do you want the number of results displayed at the top of the web part?
Layout Slots allow you to modify which fields are shown in which parts of the results. You can modify the behaviour by setting the Slot field to the Managed Property mapped to the data you want to show:

Finally you have the option of three layouts; Carousel (horizontal only), Grid (both horizontal and vertical) and Vertical Stack (vertical only).

Paging

Generally the settings in the "Paging" sub-section 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.

There is one new option here for Atlas 5.0:

This allows you to have a link attached to the web part for which you can set the text and link, for example to link to an "All Items" view of the content, in a Document Library or a Listing Page.

Item Styles

Layouts and Item Styles are now separated to provide more flexibility. The Item Styles for one layout therefore may not be available for another. For the "Grid" layout you have the following options:

Different styles will come with different configuration options so we will not attempt to list them all here. Generally they are quite self-explanatory, such as item size, image filtering, showing/hiding certain elements.

If you use the Visual Cards style you have access to display Engagement fields. See the following article to learn more: Engagement Fields on In Focus Visual Cards item style

At the bottom of the section you have the ability to modify the data being pulled in, and to reset any changes you made to this previously:

This is considered quite an advanced configuration option so we would advise you to speak to our support team to discuss your requirement before going ahead with any changes to this section.

Quick Add It

Quick Add It can be enabled to let users add content directly from your In Focus web part without going to the full Add It experience. Quick Add It opens in a panel on the right of the current page without navigating you away.

By default Quick Add It is turned off. To turn it on and configure it please review this article: Enable Quick Add It for an In Focus web part

Advanced configurations

Set the Hit-highlighted properties to determine the properties that can be matched to user search terms in order to be shown in bold text in the results.
Turn Multilingual capabilities on or off with the toggle setting.
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.
Click the Edit synonyms button 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
4. 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.
In the Edit results template you can provide code to render a custom template, however this code would need to be written by your own developers - ClearPeople's templates can be selected through the normal UI.
Finally in the Edit result types you can override the default behaviour for matching Content Types to the Result Templates.

Import/Export settings

The final section is the Import/Export settings section. From here you can import or export the settings for the entire In Focus web part so that you can reuse the configuration in many web parts without having to rebuild the same configuration from scratch 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 you're happy with the configuration. If you don't save the page then the changes to the web part will be lost.

In this article