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 cpsearch.pl command, with the initSearch and -solrHome options, in a command prompt window:

cqperl cpsearch.pl 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 cpsearch.pl command again with the deploySearch option to complete your deployment:

cqperl cpsearch.pl 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 cpsearch.pl 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
article-img
HCL Software, Secure DevOps | April 13, 2021
Compass Import Assistant
The Compass Import Assistant is a straightforward Perl application that will parse a whole CSV document that imports into Compass.
article-img
Secure DevOps | February 5, 2021
Protecting HCL Compass from Brute-force attacks
HCL Compass allows the administrator to protect Compass database repositories from brute-force attacks, here is the official documentation.  It limits the number of invalid login attempts of an attacker, who pretends as a user, before the lock out and also limits the login attempts from a certain host connecting to HCL Compass.  If an attacker is trying to hack and determine the password of a particular user, they might try many login attempts with different username and password combinations until they find one that works. As a defence against such attacks, HCL Compass can lock out the account or host used by the attacker when a certain number of failed attempts have occurred. When an account or a host is locked out, the login error message is the same as if the attacker entered an incorrect username and password. This prevents the attacker from knowing that the account has been locked out, causing them to waste resources on a continued fruitless attack. This severely limits the attacker to succeed in guessing the password.  Steps to protect the credential  HCL Compass enables the credential protection in just two simple steps.  First step to enable security is by creating a “.config” file with the below data. In this example we will create the config file with the name “SecureCredential.config”. This file can be created in any location; hence we have created the file in the HCL Compass default installation location, which is, “C:\Program Files\HCL\CCM\Compass”  # Comments are preceded by '#' and are ignored. # This enables lockouts lockout_enable 1 # Host lockout configuration # This sets the HOST lockout threshold to 10 tries lockout_threshold HOST 10  # This sets the HOST reset period to 60 seconds. lockout_reset HOST 60 # User lockout configuration # This sets the USER lockout threshold to 10 tries lockout_threshold USER 10  # This sets the USER reset period to 60 seconds. lockout_reset USER 60 # Whitelist / blacklists lockout_whitelist HOST whitelisthost lockout_whitelist USER whitelistuser1, whitelistuser lockout_blacklist HOST blacklisthost3 lockout_blacklist USER bl_user1 lockout_blacklist USER bl_user2,bl_user3 # Login attempt table cleanup # This says to cleanup any failed login attempts older # than one day (60s/m * 60m/hr * 24hr/day), and only # in...
article-img
Secure DevOps | January 26, 2021
Introducing Work Items in HCL Compass EssentialSAFe
Starting with HCL Compass 2.0.1, we now ship a new schema and package called EssentialSAFe. You can use this schema to help your team follow Essential SAFe ® practices. More information about SAFe can be found on the Scaled Agile Framework® website. SAFe and Scaled Agile Framework are registered trademarks of Scaled Agile, Inc. In our last blog, Introducing an Essential SAFe® Schema and Package for HCL Compass 2.0.1, we introduced the release train and its supporting records, such as the Solution, Team, ProgramIncrement and Iteration records. In this blog we will introduce  you to the SAFe work items available in the EssentialSAFe schema. Introduction In the EssentialSAFe schema, there are three work items available to scope, plan and implement wonderful experiences in your solutions. They are the Feature, Story, and Task. These make up part of the SAFe Requirements Model, which is shown below: Among the work items shown here, only the Feature and Story are available in Essential SAFe. In addition, the Task work item (optional in SAFe) can be used. Below we describe each of these, including how they get created. Features Feature work items are completed within a Program Increment (PI), which generally lasts 8-12 weeks. There are two types of features, a business feature and an enabler feature. Business features are created by Product Managers with assistance from Product Owners. Enabler features are created by System Architects and System Engineers and provide an Architectural Runway. To create a feature, use the New… menu in the upper left. Note – the menu will say New Query if you are using the sample EssentialSAFe database, because no default record type has been specified yet. Work items in HCL Compass EssentialSAFe are stateful records. That means they follow a state model. The following diagram shows the states and...
Close