As an end user, searching for information in a web application can be complicated. In Compass product, it would be great if we could search all attributes of records at once. This can be made possible through search configurations.

1. Why Compass Search?

Searching various record types using ID is difficult. Search functionality allows the user to search for various Record types based on “Search Scope” for example Customer, Product, Iteration. Project etc. Suppose if user is interested to fetch all defects matching a project name, it will be possible to obtain all records matching the project name. User can also apply filters by combining multiple criteria like different Record Types and different attributes.

2. Advantages of Search functionality

Text search is divided into two tasks: indexing and searching. The indexing stage will scan the text of all the records and build a list of search terms often called an index. In the search stage, only the index is referenced, rather than the text of the original records. Full-text search also supports advanced search options with operators using “AND” “OR” “NOT”. It also supports wild cards such as?*.

3. How to configure Full-text search in Compass web in old UI?

Configuring and enabling the full-text search feature for HCL Compass Web consists of the following tasks:

Configuration Steps:

1. Run the command, with the initSearch and -solrHome options, in a command prompt window:

cqperl initSearch -username admin -password “” -dbset TextSearch -userdb SAMPL -searchHome C:\CPSearch\CPSearch.Home -solrHome C:\CPSearch\CPSearch.Solr -solrPort 8984

When this command completes, configuration data corresponding to your schema is placed in the following directory: C:\CPSearch\CPSearch.Home\TextSearch_SAMPL\

Below is the output user should get if there are no errors:

2. Edit the entity file associated with the deployment: C:\CQ.Search\TextSearch_SAMPL\Entity-TextSearch-SAMPL.txt. For each record type, select a display field to appear in the full-text search results by prepending an ampersand (&).

It should look like below:

3. Run the command again with the deploySearch option to complete your deployment:

cqperl deploySearch -username admin -password “” -dbset TextSearch -userdb SAMPL -searchHome C:\CPSearch\CPSearch.Home

Below is the output user should get if there are no errors:

4. To start Search services:

cqperl startSearchServer -dbset TextSearch -userdb SAMPL -searchHome C:\CPSearch\CPSearch.Home -startas continues

In some cases, you may need to make changed to default setting for Compass Search such as specify the JVM memory to name some. If so, this is done by edit the file “compass_search_<dbSet>-<userDb>.properties” file. The only parameter you may need to modify in this file are the JVM settings as follows:

· CPSolr.MaxHeapSize – This specifies the maximum heap size for Apache Solr.

· CPTool.IncrIndexMaxHeapSize – This specifies the maximum heap size for the incremental indexer.

· CPTool.FullIndexMaxHeapSize – This specifies the maximum heap size for the full indexer.

All of the other settings should not be modified unless if instructed by HCL Support.

After successful configuration of Full-Text search Radio button will be enabled and looks like below.

4. How to use Full-text search in Compass?

Case1: Retrieve all defects and projects which belong to project Compass for example.

1.Login to to Compass web as Compass user and click on radio button “Full Text”.

2. From Search Scope check the boxes “Defect” and “Users”

3. In Search box enter “lead”

4.User will be provided with all defects matching users name on the right side panel.

Case 2 : Using “AND” operator user can combine different attributes and retrieve all record Types which are in Closed state and with Priority.

1.Check “Defects” and “users” from search scope.

2.In Search box enter “Resolution :Fixed AND Priority:3-Normal Queue”

3.This helps the user to further filter the search results by combining different attributes.

Case 3: Using “OR” operator user can retrieve different record types like defect, customer with “Resolution :Fixed OR Name :Jane” condition.

1.In Search box enter “Resolution :Fixed OR Name :Jane”.

2.In Search scope check Defect,Customer

3.Hit Enter

4.User will get results of multiple record types i.e Defect and Customers with matching Name and Resolution status.

Case 4: To retrieve all the records excluding the condition like Customer Name “Jane” use condition “Resolution :Fixed NOT Name :Jane”

1.Uncheck “Defects” and “Customer” from search scope.

2.In search box enter “Resolution :Fixed NOT Name :Jane”

3.Hit Enter

4.User will get all record types like defects which does not belong to Customer “Jane”.

Search functionality is now successfully configured in HCL Compass and users can continue to search various Record Types at ease.

Comment wrap
Further Reading
Secure DevOps | May 25, 2022
Ensure HCL Compass is installed in your machine and have valid credentials to login into repository.
Secure DevOps | May 19, 2022
This article helps to install and setup HCL Compass in your machine which runs on rest server (without WAS)
Secure DevOps | February 25, 2022
HCL Compass Webhooks in Action
This article talks about Webhooks in HCL Compass. Webhooks are nothing but automated data sent from an app when something is triggered. In our case, HCL Compass is the app which sends the Webhook data, which is also called as Payload.
Filters result by