The SearchConfiguration Settings file has the required settings to allow the Search Results page to function. If a change is needed - such as for a new facet - you may edit this file with the updates. Below are the current settings as of July 2020. The SearchConfiguration Settings file is specific to each locale and every Settings file must be updated if you want the change to appear in all locales.
Each tab in the search results which come from CoreMedia (Documents, Videos, Pages) require settings to build the facets on each tab. This allows each tab to have individualized facets that fit best with that content. The facets for Products are controlled by HCL Commerce. Due to the complexity of combining two Solr indexes to paint the results for the All Results Zoned Search tab, there is no faceting associated with that tab. As the Serial Number Search is pulled from a third-party index, there is no faceting for this tab either.
These settings are primary examples from emerson.com. The settings on other sites will differ depending on the business requirements. This list should include examples for use cases across sites.
Property | Value | Type | Comments |
search.documenttype-tags | Documents & Drawings | Link to Tag | This is in the Local Settings on emerson.com but can be included in the SearchConfiguration Settings file instead. |
featuredsearch | -- | Struct | This struct defines the pages that contain Featured Search results for each content type in the Search Results - webpage, video, and document. These pages are children in the Navigation of the FeaturedResultsHiddenPage on the Homepage Navigation. |
video | Featured Search Videos | Link to Page | This tells the Featured Search where to looks for featured video results. |
webpage | Featured Search Web Pages | Link to Page | This tells the Featured Search where to looks for featured webpage and external link results. |
document | Featured Search Documents | Link to Page | This tells the Featured Search where to looks for featured download results. |
search.languagetag | Languages | Link to Tag | This tells search which tag to look at to determine the language of an item in the Shared Asset Site. The locale is also used to determine the language for the given locale in combination with this tag. There can be multiple tags on an item such as a download (document). |
search.facets.filter | -- | Link List | This was the original facet definition when the site went live in 2016. This may be used on some OAS that do not have the tabbed results. This is not used on emerson.com |
#1 | Documents & Drawings | Link to Tag | Example: enter as many Links in the list as you wish to create filters. There is one link (tag) per row and the rows are numbered #1, #2, #3, etc. Each entry creates a facet that allows you to filter by the tag values defined in that facet (parent tag) |
video.search.facets.filter | -- | Link List | This entry defines the facets used for the video tab on the search results. |
#1 | Brands | Link to Tag | Example: enter as many Links in the list as you wish to create filters. There is one link (tag) per row and the rows are numbered #1, #2, #3, etc. Tag examples: Brands, Languages. Each entry creates a facet that allows you to filter by the tag values defined in that facet (parent tag) |
webpage.search.facets.filter | -- | Link List | This entry defines the facets used for the Web Page tab on the search results. This includes both CoreMedia Pages and External Links. This is defined in the search code and not editable by an author. Note, Date is also a facet, but is controlled programatically and is not editable by an author. |
#1 | Language | Allow filtering by Language | |
#2 | Brands | Allow filtering by Product Brand | |
#3 | Industry | Allow filtering by Industry Segment | |
document.search.facets.filter | -- | Link List | This entry defines the facets used for the Web Page tab on the search results. This includes both CoreMedia Pages and External Links. This is defined in the search code and not editable by an author. Note, Date is also a facet, but is controlled programatically and is not editable by an author. |
#1 | Documents & Drawings | Allow filtering by Document Type | |
#2 | Industry Segment | Allow filtering by Industry Segment | |
#3 | Brands | Allow filtering by Product Brands | |
#4 | Categories | Allow filtering by Product Categories | |
#5 | Language | Allow filtering by Language | |
search.businessunits.filter | Business Platform | Link to Tag | This defines the primary filter at the top of the Documents, Webpage, and Video Tabs in the search results. For your search results to have the opportunity to appear in these tabs, your business platform tag value (filter value) must be added to the Metadata tab of your CoreMedia Document (Page, Download, Video, External Link) |
searchChannel | SearchResultPage | Link to All | ***Not sure if this is a valid entry. May be deprecated or unused. |
searchAction | SearchAction | Link to Action | This Action links to the "wcsextendedsearch" which is used in the Main Nav to call the search bar |
SearchAction Docs & Drawings | SearchAction Docs & Drawings | Link to Action | This Action links to the "wcsextendedsearch". This was used on the original "Documents & Drawings" Page from launch of emerson.com in 2016. This may be used on OAS |
search.result.hitsPerPage | 20 | Integer | This controls the number of results shown on a tab for Videos, Webpages, and Documents in the Search Results |
search.doctypeselect | -- | String List | This list includes the variables for the specific CoreMedia document types that are used in the Search Results. Other types include CMAudio, CMCategory, CMProduct, CMGallery |
#1 | CMArticle | String | CM Document type Article. Note, we do not use Articles although they were configured originally |
#2 | CMChannel | String | CM Document type Page. (Not 100% certain that is what this defines.) |
#3 | CMDownload | String | CM Document type Download which we generally refer to as "documents" such as PDFs |
#4 | CMVideo | String | CM Document type Video |
#5 | CMExternalLink | String | CM Document type External Link. This allows External Links to be used in the Webpage results |
SearchAllHitsPerPage | 4 | Integer | ***Unknown |
SearchAllVideoHitsPerPage | 4 | Integer | ***Unknown |
search.result.languageBoostFactor | 30 | Integer | Used to give greater weight to search results with the language of the current locale. Can be set from 0 to 99 |
search.result.localeBoostFactor | 99 | Integer | Used to give greater weight to search results for the content of the current locale. Can be set from 0 to 99. Not currently used on emerson.com |
caefeederSiteConfiguration | emerson | String |
The Bundle file Emerson_enAsResourceBundle is where you enter all properties and values that need to be used in the Search Results. These are mainly the labels that appear in the facets and filter values, but also include a variety of text that is needed to display messages on the Search Results page. They are in the bundle because they are referenced as a variable by CoreMedia and they must have a corresponding value to display. If that value is not in the bundle, the system will display the property variable which may not be easily readable. The values in the bundle also allow for the text to be translated to local language as needed in some locales. If a change is needed - such as a new tag for a facet - you may edit this file with the updates. Below are the current properties and values as of July 2020. The Emerson_enAsResourceBundle file is specific to each locale and every Bundle file must be updated if you want the change to appear in all locales.
While most of the labels are in the Emerson_enAsResourceBundle, some of the labels are in the bundle file Bundle_enAsResource. It is possible that other labels may be in yet another bundle file. This has not been consistently applied or documented due to differences in timing of development of various features.
The required bundle entry labels are shown below. Selected examples for the filter tags are also shown for illustration. Any new tags added for one of the defined facets must be added to the bundle for all locales. The Values will be translated for each locale that needs local language as the bundle file is unique to each locale.
Many of teh labels in Search results are controlled by HCL Commerce and are not available for editing or translating in CoreMedia. Primarily the labels associated with the Documents, Web Pages, and Videos are in the CoreMedia bundle file. Labels associated with Products and Serial Number are retrieved from Commerce or through the third-party call for Serial Numbers. (Note, there may be a few CoreMedia entries that are missing from this list. If any are noted, please update or contact your platform lead to add them.)
Property | Value | Type | Comments |
searchResults_filter_EXAMPLE | Example | String | Where "EXAMPLE" represents a tag in one of the facets such as Brands, Industry, Documents & Drawings, etc. |
| searchResults_filter_Appleton | Appleton | String | Brand Tag Example |
| searchResults_filter_Refrigeration (ComRes) | Refrigeration | String | Platform Specific Categories Tag |
searchResults_filter_Chinese | 中国 | String | Language Tag |
searchResults_filter_Languages | Languages | String | Facet Label for the Language facet |
searchResults_headline_business_segment | All Business Units | String | Label for the primary filter box at the top of the Search results |
searchResults_all_nothing_found | No results were found in | Shown in the zoned search tile on the All results tab for Web Page, Video and Documents | |
| searchResults_nothing_found | No results were found containing "{0}". | Displayed at the top of the search results for the Web Page, Documents and Videos Tabs when no results are found containing the search string "{0}" | |
| searchResults_results_label_in_document | Documents | The variable text shown in "1-20 of 634 results in Videos" at the top of the search results for Documents and as the label for the Zoned Search Tile | |
| searchResults_results_label_in_webpage | Web Pages | The variable text shown in "1-20 of 634 results in Videos" at the top of the search results for Web Pages and as the label for the Zoned Search Tile | |
| searchResults_results_label_in_video | Videos | The variable text shown in "1-20 of 634 results in Videos" at the top of the search results Videos and as the label for the Zoned Search Tile | |
| searchResults_results_label_lowercase_in_document | documents | **Not sure where this is used | |
| searchResults_results_label_lowercase_in_webpage | web pages | **Not sure where this is used | |
| searchResults_results_label_lowercase_in_video | videos | **Not sure where this is used | |
| searchResults_in_label | in | text that appears on the search results page that needs to be translated | |
| noSearchResults_synonyms | Try using synonyms. | Shown in the Zoned Search for Web Page, Documents or Videos when no results found | |
noSearchResults_synonyms_desc | Maybe the document you're looking for uses slightly different words, like "film" instead of "movie". | Shown in the Zoned Search for Web Page, Documents or Videos when no results found | |
noSearchResults_check_spelling_desc | Are the words in your query spelled correctly? | Shown in the Zoned Search for Web Page, Documents or Videos when no results found | |
noSearchResults_check_spelling | Check the Spelling. | Shown in the Zoned Search for Web Page, Documents or Videos when no results found | |
| noSearchResults_more_general | Make your search more general. | Shown in the Zoned Search for Web Page, Documents or Videos when no results found | |
| noSearchResults_more_general_desc | For example, instead of using specific product names, try using the generic product category. | Shown in the Zoned Search for Web Page, Documents or Videos when no results found |
A number of functional items are attached to the Homepage. As noted above, the Settings files (System Tab) and Bundle Files (Localization Tab) can be found attached to the Homepage. In addition several pages required for search functionality are listed under the Homepage Navigation Tab and noted below. Additionally, there are Local Settings on the System Tab that are also required for Search functionality.
There are several Pages and Items that are part of the Homepage Navigation Tab which are used to allow the Search Results to function.
CoreMedia Document | Description |
SearchDisplay | This Augmented Page is the Document that controls the Search Results page display. It contains the "Search Results Fragment" Placeholder Document which uses the Function Variant "search-results" |
HandcraftedSearchHiddenPage | This page controls what is available for Handcrafted Search results in a given locale. See the Handcrafted and Featured Search Page for further details. |
FeaturedSearchHiddenPage | This page controls what is available for Featured Search results in a given locale. See the Handcrafted and Featured Search Page for further details. |
| ROOT | This Augmented Category is the connection to the product catalog. For emerson.com this includes Automation Solutions and Commercial & Residential Solutions catalogs. While not directly linked to Search this is the connection to the catalog for category and PDP display. |
As noted above, the Bundle files are easily located on the Localization tab of the Homepage
Bundle Name | Description |
Emerson_enAsResource | This bundle contains the majority of the available/required entries for facets and filter values. It also includes many of the labels that are shown on the search results page. |
Bundle_enAsResource | This bundle contains a few of the message labels that are shown on the search results page such as "Search results for" although most entries in this bundle are default CoreMedia and not actually used. |
As noted above, the Settings File "SearchConfiguration" is located in the Linked Settings section of the System Tab. Additionally there are Local Settings on the Homepage for each locale that control additional functionality
Property | Value | Type | Comments |
livecontext.assets.search.sites | -- | Link To Site Indicator | This Link List allows the addition of a property to allow searching of the Shared Asset Site |
#1 | Emerson Electric Shared Product Assets | Site Indicator | The Property for the Link List above that allows searching of the Shared Assets. Other entries could be made in this list to allow for other locales to be searched. |
livecontext.assets.default.picture | Picture of Emerson Logo | Picture | This Link allows for a default image to be displayed when no image is defined. |
search.documenttype-tags | Documents & Drawings | Tag | Unknown |
