SEARCH PROCESS

Several types of search process are available from the catalog:

• Search for products in the catalog or in a specific product collection based on keywords (Catalog Search)
  • Either by using a Standard and Advanced Catalog search process which allows the end-user to look for products based on their name, description, RMOText and additional business properties.
  • Or by activating Full-text search capabilities to benefit from a faster search and ranked results that can be added to the quote from a suggest popup.
• Search for products in a product link structure (Linked Product Search).
  • The user will be able to search a specific product/part/sub-assembly in a finished good.

Catalog Search

This search process allows the end-user to look for products based on their name, description, RMOText and additional business properties.

The search process is launched from a SEARCH action that can be included in a searchSticker or a searchBox. The SEARCH process is based on the SearchPolicy parameters and includes standard or full text search modes.

The products returned by the search process are displayed in a productResultBox in the searchPage.

>

Standard and Advanced catalog search process

The products resulting from the standard search are returned as a flat list or classified according to their parent collection (groupByCollection=’on’ on the productResultBox):

E.g. Computers

Computers > Laptop

Computers > Laptop > ACER

• SI003
  1. When launched from a searchSticker, the end-user can specify a part of the Name, Descr, RMOText of the product he is looking for and the scope of the research.

Examples:

The end-user search products containing the string « TV plasma » in their Name/Descr/RMOText

1. When launched from a searchBox, in addition to the Name/Descr/RMOText search, the enduser can specify search criteria based on the searchBusiness properties (attached to the collection on model side) and the price of the resulting products.
   
   

Depending on the ‘From’ combobox that defines the search collection (scope of the search), the search business properties are listed in the advanced Search collapsible section of the searchBox.

For Simple BPs:

For List BPs:

Search process:

All conditions of the search expression are linked with an AND operator. The search on Descr and RMOText can be an exact match or an approximate match and can be case sensitive or not (depending on the type of search defined in the searchPolicy)

Example of advanced search expression:

resultingProduct IN subTree(High-Tech) AND

[

resultingProduct.Descr LIKE "%TV plasma%" OR

resultingProduct.Name LIKE "%TV plasma%" OR

resultingProduct.RMOText(UT=myUserType) LIKE "%TV plasma%"

]

AND

[

resultingProduct.BP_num LIKE "%toto%"

AND resultingProduct.BP3_simpleType EQUALS (value2)

AND resultingProduct.price between (100€;200€)]

AND resultingProduct.BP_Numeric between (10;200)]

]

Full text search

The full text search – when activated - is a runtime capability. It allows user to search for text in various product fields (name, description, RMO, ...). Full-text search applies to Standard Items, Sales Products and Configuration Products. Upon typing text to be searched for, a list of ranked products is returned in a suggest popup from which user can add or configure products. If results in the popup are not enough, user can refine his search or perform an actual search to display all results, ranked, in a productResultBox. This process is based on the pre-indexation of all these objects in the catalogs.

For more details on the full text indexation process, please read about generating the index. Ranking of products is based on criteria priority defined in the searchPolicy. Criteria can be on:

• Object name
• Object description
• RMO texts and RMO file titles associated with the object (if activated)
• Business properties and Business Property Sets characteristics (if activated)
• Content of the RMO PDF files associated with the object (if activated)
• Characteristics of the Product Links associated with the object (if activated)
  Note: The maximum number of elements displayed as full text search results is set to 1000. To expand or reduce this limit, the engines.limit.search attribute has to be set in the cameleon.properties file.

  Note on ordering and PL:

  When PL is activated, upon finding a match on a child, the parent is returned as well.

  In terms of ordering, the parent will appear above the child in the results if PL is placed as a

  higher priority.

  Let us take a few examples where PL is activated and the child is a match for all criteria

  • Criteria: “name, PL, descr”: order => child first, then parent
  • Criteria: “name, descr, PL”: order => child first, then parent
  • Criteria: “PL, name, descr”: order => parent first, then child

When typing multiple words separated by space character, several search modes are possible depending on whether you would like to search on a single field or on many. Search may be case sensitive or insensitive. Both options are to be set in the search index policy (searchIndexPolicy.xml). For more details on the full text indexation process, please refer to the CPQ Designer guide.

Full text suggest popup

A “suggest popup” feature is associated with the full text search: refer to suggestAndAddBox in this guide.

It is important to understand that full-text search is configurable in two completely separate area:

• In one hand you define what fields will be searched upon and how matching results will be ranked - in search policy.
• In the other hand you define what fields and prices should be visible in the suggest popup - in the suggestAndAddBox. Visible fields do not need to have been indexed and can be different from fields used in the search.

Linked Product Search

This type of search allows the end-user to search for products (called ‘Matched Products’) belonging to the structure defined by a ‘Root Product’ and its product links.

The following example gives an example of the way to parameterize the layout file and the search policies.

A product Catalog contains SIA, SIB and SIC defined as follows:

The user wants to retrieve SI 1.2.1 in SIA which is a root product (i.e. a product without a parent linked product). This ‘SIA’ will define the scope of the search.

The search process is launched from a <searchLinkedProductsBox>.

The user searches products with keyword ‘SI1’ within the root Product by using the keyword ‘SI’.

When clicking on the ‘Search’ button, the engine first searches for the root product in the Catalog by using the searchPolicy which is referenced in the rootProductSearchPolicy parameter of

the searchLinkedProductsBox.

If several products correspond to the ‘SI’ keyword (which is the case in this example), the user is asked to refine his search by selecting a single root product. Indeed, the scope of the search for ‘SI1’ has to be a unique product.

Once a single ‘root’ product has been selected, the ‘SI1’ keyword will be searched to retrieve the

‘matched’ products. This keyword has to match the name or description or RMOText of a product belonging to the productLink structure of the root product.

The productLink structure is defined by a list of link types in the linkedProductsSearchPolicy:

<linkedProductsSearchPolicy rmoUserType="*" value="1" maxAddedProducts="5"

autoRedirect="on" linkType="breakdown,spareParts,replacement"

hiddenLinks="" name="SP1"/>`

The ‘SI1’ keyword will then be searched in SI1, SI2, SI1.1, SI1.2, SI1.1a, SI1.1b, SI1.2.1 codes, names and RMO text

The resulting products are displayed in a productResultBox on the SearchPage. For each product being returned by the search, all the paths/breadcrumbs made of the products links are displayed in the productPathBox.

E.g. of the case above:

SIA > SI1 > SI1.1 > SI1.1a > SI1.1b > SI1.2.1 becomes

SIA > SI1 > SI1.1b > SI1.2.1 if the replacement type of link is ‘hidden’.

SEARCHSTICKER

Overview

A searchSticker (included in a stickerBar) is a button allowing to open a drop down menu to let the end-user fill a search criteria and then launch the search.

When the user launches the search process (click on Search button) or when the user clicks on the advanced Search button, he is redirected to the searchPage.

Attributes details

SUB-ELTS	ATTRIBUTES	VALUE
.	heightPercent: percentage of occupancy in the total height of the page (for the expanded mode)	#IMPLIED
.	autoSize	vertical Autosize
.	titleTranslationName: identifier of the translation	#IMPLIED
.	searchDepth: gives the depth from the root collection to be displayed in the combobox.	#IMPLIED (1 to 5 max.)
.	cpeContext: the CPE of a specific collection on which the search is performed, except if the enduser has selected a different scope in the combo box. If a search context is defined by the end user in the combo box, it overrides the cpeContext. If no search scope has been defined through the cpeContext attribute – empty value – or by the end user in the combo box, the search scope is set by default to the current collection.	#IMPLIED (e.g. "CPE.wksHighTech/CL/High TechCollection") e.g. rootCL
actionBox	Identifies the static links or actions to be included in the linkBox. The actionBox can contain the search button : i.e. SEARCH action (executes the search process + redirect to the searchPage) The actionBox can also contain the advancedSearch button: i.e. OPEN_PAGE( pageName=searchPage) to redirect to the searchPage and expand the searchBox with currentCollection pre-selected.

XML Sample

<searchSticker mode="on" cssName="searchSticker" hzAlignment="right"

heightPercent="100" widthPercent="20" autosize="on"

titleTranslationName="searchSticker.title" searchDepth="5" >

<actionBox mode="on" cssName="searchStickerActionBox"

hzAlignment="center" vtAlignment="down" widthPercent="100"

heightPercent="100" autosize="on">

<action actionName="OPEN_PAGE(pageName=searchPage)"

alignment="right" resourceName="btnOpenSearchPage"

translationName="tooltip.openSearchPage" url="" />

<action actionName="SEARCH" alignment="right"

resourceName="btnSearch" translationName="tooltip.searh" url="" />

</actionBox>

</searchSticker>

Visual identity

The following translations are associated to the component:

<translation name="searchSticker.title">Search</translation>

<translation name="searchSticker.search.label">Search</translation>

<translation name="searchSticker.keywords.tooltip">Keyword or

item</translation>

<translation name="searchSticker.category.label">Category</translation>

<translation name="searchSticker.category.root">whole

catalog</translation>

<translation name="searchSticker.advanced.search.label">advanced

search</translation>.

It is possible to define in the CSS a background image for the searchSticker button and a different one for the onMouseOver state.

SEARCHBOX

Overview

A searchBox can be added into the searchPage. By default, the search textfield and collection of the box are pre-filled with the criteria of the current Search process.

For example, the end-user has launched a SEARCH action from the searchSticker, he is redirected to the search page and the search criteria are initialized with the criteria of the originating searchSticker.

Attributes details

SUB -ELTS	ATTRIBUTES	VALUE
.	range: range of the displayed price	#IMPLIED
actionBox	Identifies the actions to be included in the searchBox. The actionBox can contain the ClearAll button : i.e. RESET action (Resets the search criteria) The actionBox can contain the search button : i.e. SEARCH action (execute the search process)

XML Sample

<searchBox mode="on" cssName="searchBox" heightPercent="100"

widthPercent="100" autosize="on" titleTranslationName="searchBox.title"

columnCount="2" searchDepth="5" framedBox="on">

<pricing

method="CPE.GET(CPE.Settings.Session.PricingMethod[1])" range="1" />

<actionBox mode="on" cssName="myCssClass"

hzAlignment="center" vtAlignment="down" widthPercent="100"

heightPercent="8" autosize="off">

<action actionName="RESET" alignment="left"

resourceName="btnReset" translationName="tooltip.reset" url=""/>

<action actionName="SEARCH" alignment="right"

resourceName="btnSearch" translationName="tooltip.search" url=""/>

</actionBox>

</searchBox>

Visual identity

The following translations are associated to the component:

<translation name="searchBox.title">Search</translation>

<translation name="searchBox.price.label">Price:</translation>

<translation name="searchBox.search.label">Search keyword</translation>

<translation name="searchBox.keywords.tooltip">Keyword or

item</translation>

<translation name="searchBox.category.label">From</translation>

<translation name="searchBox.category.root">whole catalog</translation>

<translation name="searchBox.advanced.search.label">Refine using

additional search criteria</translation>

<translation name="searchBox.criteria.from">From:</translation>

<translation name="searchBox.criteria.to">To:</translation>

<translation

name="searchBox.criteria.valueSelector.none">(none)</translation>

SUGGESTANDADDBOX

Overview

The suggestAndAddBox provides a way to search products, view best ranked suggestions, and either add some to the quote, or perform a full search to see all results, ranked, in a productListBox. It requires searching in full-text mode. For this search mode, products must have been indexed at the time of generating a version. Please refer to indexing of products in the CPQ Selling Designer for more on this topic.

The suggestAndAddBox does not define how products should be searched for - that is done in the search policy defition. The suggestAndAddBox dictates which search policy to use, and lists what elements should be visible in the suggest popup:

• Name
• Description
• RMOs (Image, Text)
• Up to two BP values
• Up to two price tags
• What actions are available for matching results:
  • Add to quote
  • Configure Now
  • Configure
    
    

The suggest popup will always appear right underneath the suggest search bar. It hightlights text searched for when it is found in fields being displayed in the popup. Suggest popup truncates texts too long to fit in the popup. In the case where it truncates a longer text containing the text being searched for, it truncates right before the first occurence of matching text, which will appear highlighted.

Attributes details

SUB -ELTS	ATTRIBUTES	VALUE
.	translationName: a translatable title associated to the price	#IMPLIED
.	translationAlignment: position of the title	left / right
actionBox	A first action box with the search action to be used. You need to specify the name of the search policy if more than one full-text search policy is defined
actionBox	A second action box listing possible actions for matching results in the popup: ADD_TO_QUOTE, CONIGURE, CONFIGURE_NOW

XML Sample

<suggestAndAddBox mode="on" cssName="suggestAndAddBox" widthPercent="20" heightPercent="100" hzAlignment="left" autosize="on" displayType="name, description" showText="on" showImage="on" businessProperty1="CPE.wksCSA/BPS/bps_901.BP/bp_901-text" businessProperty2="CPE.wksCSA/BPS/bps_901.BP/bp_901-integer" titleTranslationName="searchBox.title" framedBox="off">

<pricing method="CPE.GET(CPE.Settings.Session.PricingMethod[1])" range="1" resourceName="" resourceAlignment="left" translationName="suggest.price1" translationAlignment="left"/>

<pricing method="CPE.GET(CPE.Settings.Session.PricingMethod[1])" range="2" resourceName="" resourceAlignment="left" translationName="suggest.price2"

translationAlignment="left"/>

<actionBox mode="on" cssName="actionBox" hzAlignment="left" vtAlignment="up" widthPercent="100" heightPercent="100" autosize="on">

<action actionName="SEARCH" alignment="right" resourceName="btnMagnifying" translationName="tooltip.search" url=""/>

</actionBox>

<actionBox mode="on" cssName="actionBoxTransparent" hzAlignment="left" vtAlignment="down" widthPercent="100" heightPercent="100" autosize="on">

<action cssName="actionBoxHover" actionName="ADD_TO_CART(qty=on, goTo=cartPage)" alignment="right" resourceName="" resourceOffName="" translationName="action.addToCart" url=""/>

<action cssName="actionBoxHover" actionName="CONFIGURE" alignment="right" resourceName="" translationName="action.configureNow" url=""/>

</actionBox>

</suggestAndAddBox>

Visual identity

Some CSS changes are possible on the suggestAndAddBox, but keep in mind that a truncating of longer text is not done in CSS, so making boxes larger or smaller may not render as well.

SEARCHLINKEDPRODUCTSBOX

Overview

A searchLinkedProductsBox can be added into any page or the catalog. It uses 2 search policies:

• A standard search policy to search for the main product in the catalog that define the scope of the search process (rootProductSearchPolicy)
• A linked products search policy to look for the final product within a product link structure
  
  

Attributes details

XML Sample

<searchLinkedProductsBox mode="on" cssName="searchLinkedProductsBox"

heightPercent="100" widthPercent="100" autosize="on"

titleTranslationName="title" rootProductSearchPolicy=""

linkedProductsSearchPolicy="SP1" />

Visual identity

The following translations are associated to the component:

<translation name="searchLinkedProductsBox.search.label"> Search

keyword</translation>

<translation name="searchLinkedProductsBox.keywords.tooltip"> Keyword or

item</translation>

<translation name="searchLinkedProductsBox.from.label">

From</translation>

<translation name="searchLinkedProductsBox.root.tooltip">Keyword or

item</translation>

<translation name="searchLinkedProductsBox.searchAction">

Search</translation>

<translation name=" searchLinkedProductsBox.resetAction">

Reset</translation>

PRODUCTRESULTBOX

Overview

This box is mandatory in the search and needAnalysisPage.

At run-time, the productResultbox contains as many instances of productListBox as collections results from the search or guided selling process.

It is possible to collapse each section independently.

If the search process is not classified by collection (groupByCollection=”off”) only 1 productListBox is generated and it contains the whole list of products.

If no result match the search criteria, the productResultBox only displays an information message.

Attributes details

SUB -ELTS	ATTRIBUTES	VALUE
.	groupByCollection The products resulting from the search or the needAnalysis are classified by collection.	on / off
.	expandSections: defines the initial state of the sections in the productResultBox when the groupByCollection feature is activated.	on / off / first
productListBox	Describes the productList box used to display the list of products per section.

XML Sample

<productResultBox cssName="productResultBox" mode="on"

widthPercent="100" heightPercent="10" autosize="on"

collapsibleSections="on" titleTranslationName="productResultBox.title"

framedBox="off">

</productResultBox>

Visual identity

The following translations are associated to the component:

<translation name="productResultBox.viewAll.label">View all products in this category</translation>

The following translation allows to display the number of products per collection when the resulting products are groupedByCollection. ({0} corresponds to the number of resulting products, {1} corresponds to the description of the collection, {2} corresponds to complete collection path, including the root collection, {3} corresponds to the name of the first level collection)

<translation name="productResultBox.title">{0} Products in

{1}</translation>

or

<translation name="productResultBox.title"> {0} Products in

{2}</translation>