This article is for Atlas versions 4.0 to 4.3. If you are using Atlas 5.0+ please refer to this version of the article: Configuration for In Focus web parts (Atlas 5.0+)
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.
A list of 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 Importing/Exporting In Focus web part configuration please see the following article: Export and Import Settings for In Focus web parts
If you need assistance with a specific requirement please get in touch with our support team or your CSM.
In this article
In this article we explain the configuration options for In Focus web parts in full detail. Please be aware that some of this is considered advanced configuration, while other parts are quite straightforward.
- Edit the web part
- Search section
- Paging section
- Layout section
- Quick Add It section
- Export/Import settings section
Edit the web part
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.
For the Atlas 4.0 release we have rearranged the options for In Focus web parts into sections which can expand and collapse to allow you to find things more easily:
Search section
In the first section you can set the following Search settings. Mainly this is where you will control the search query, behaviour and filtering.
|
If you add a specific word or phrase into the "query" boxes, results will need to contain that word or phrase somewhere in their content or metadata to appear. Usually, you should leave this as is and configure refiners using Managed Properties, explained later in this article.
If you need to connect a Search Box to allow users to search by text, please follow the steps in this article: Connect an In Focus Search Box to an In Focus web part
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.
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 Sorting settings you will need to refer to this list of Managed Properties for Atlas columns: Atlas Managed Properties for Search
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:
|
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.
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:
Be aware that synonyms only apply to the current In Focus web part being configured.
- Type the term you want users to be able to type in
- Type the synonyms of that term you want to automatically add to searches
- 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.
Paging section
If you collapse the Search settings or scroll down past them, you will see the Paging settings next. Generally they are quite self-explanatory:
|
Layout section
The next section after Paging is for the Layout.
|
Layout-specific options
Further down in the same section you can see the Layout-specific options. Different Results layouts may have different options and some layouts have no additional options. The options will change when you select a different layout above.
To see the full suite of options for all layouts please follow this link: Layout configuration options for In Focus web parts
Quick Add It section
In this section you can find the options for configuring Quick Add It:
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+)
Export/Import settings section
In this section 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 you're happy with the configuration. If you don't save the page then the changes to the web part will be lost.
Comments
0 comments
Please sign in to leave a comment.