Search Test Repository Actions

Search Test Repository actions search the specified Test Repository to find test assets that match a supplied set of tokens. for example, a set of SAP transaction codes. In the case of Tosca Test Repositories, both SapEngine and API modules are searched to find matching test assets. In the case of Tosca Test Repositories, the TBox and Classic SAP automation engines are searched for matching test assets, and reusable test blocks are included in the search. In the case of qTest Test Repositories, both standard and custom test case fields are searched to find matching test assets.

The action returns the set of matched test assets, along with IDs that may be used by the Create Test Execution action.

Action Property	Description
Confidence Threshold	An Integer parameter or dataset, used for ALM Test Repositories only, if the UseExperimentalALMSearchMethod field is set to X in the Configuration - Test Repository screen. This property is used to filter the contents of the Result dataset according to the following rules: For each NAME in the Results table, include rows with CONFIDENCE values that are equal to or greater than the Confidence Threshold. If a NAME has no results that are equal or greater than the Confidence Threshold, find all the rows for NAME and include the first one with the highest CONFIDENCE value. If the Confidence Threshold is equal to 0, do not apply any filtering to the Result dataset. Note that the Confidence Threshold is not used if the Search Test Repository action’s Use Cache parameter is set to True. In this case, any existing CONFIDENCE and SEARCH_TERM values are retrieved from the cache.
Result	A Table dataset containing details of the matching test assets.
Search Paths	If this String List parameter or dataset is set, the search for test assets is limited to the specified workspace or project folders. For example, if you have a test plan hierarchy like this… Subject\Release 1 A B Test1 C D Test2 Subject\Release 2 E F Test3 G H Test4 … and you wish to search only the ‘Subject/Release 2’ portion of the hierarchy, set the Search Paths parameter to ‘Subject/Release 2’. The string 'Subject/' is added if it is missing from the beginning of the search path, and any trailing backslash characters are removed. Setting the Search Paths parameter appropriately can significantly reduce the time it takes to search for relevant test assets. If Search Paths are specified for Tosca Test Repositories, at least one of the Search Paths must be at the start of the node path in order for matches to be found. Suppose you have the following hierarchy... Test Cases Sales VA01 - Create Sales Order ... and another test case that references VA01 in a different folder path. Setting Search Paths to /Test Cases/Sales will match only the first instance of VA01, because its node path (/Test Cases/Sales/VA01 - Create Sales Order) starts with the value in Search Paths. For qTest and Tosca Test Repositories, each Search Path must begin with a leading ‘/’. For Tosca Test Repositories, if the Use Cache property is set to ‘false’, each Search Path must begin with a leading ‘/’. ‘Subject/’ is added to the beginning of each Search Path if the Use Cache property is set to ‘true’. For Excel Test Repositories, the Search Paths property is not used.
Source	A Table parameter or dataset used to specify the search terms to be searched for in test assets. The table should have a NAME column which stores object names, and a SEARCH_TERM column which stores search terms associated with the objects. The Result dataset returned by the Convert SAP Objects Test Search action may be used as the Source table for this action.
Test Repository	A Test Repository parameter or dataset referring to the Test Repository to be searched for test assets.
Use Cache	If this Boolean parameter is set to ‘true’, the Search Test Repository action uses any cache associated with the specified Test Repository when searching for test assets. If the property is set to ‘false’, the Test Repository cache is not used. If this parameter is not set, ‘true’ is used as the default value. A cache may be created for a Test Repository using the Write Test Repository Cache action.

The Search Paths property is not used in some cases, as described below:

Test Repository Type	Is Search Paths Used When Use Cache = true?	Is Search Paths Used When Use Cache = false?
Tosca	Yes	Yes
qTest	Yes	Yes
ALM	Yes	Yes
Azure DevOps	Yes	No
Certify	Yes	No
Excel	No	No
SAP Solution Manager	Yes	No

The Result dataset has the following columns:

Column	Description
TEST_REPOSITORY	The name of the Test Repository that was searched.
TEST_REPOSITORY_TYPE	The type of the Test Repository that was searched.
NAME	The matching token from the Source table’s NAME column. Tokens that match within word boundaries are not included in the results.
TEST_ID	The ID of a matching test asset.
CONFIDENCE	For each NAME in the Source table, this column stores the percentage of SEARCH_TERM values for which a matching test asset was found. If a technical name is matched in a test, the NAME’s CONFIDENCE value is set to 100. Note that the Result dataset may be filtered by setting a value for the Confidence Threshold property. This column is shown for ALM Test Repositories only, if the UseExperimentalALMSearchMethod field is set to X in the Configuration - Test Repository screen.
COMMON_TERMS	A list of the all the SEARCH_TERMS matched in the test asset. This column is shown for ALM Test Repositories only, if the UseExperimentalALMSearchMethod field is set to X in the Configuration - Test Repository screen.
TEST_NAME	The name of the test asset.
TEST_PATH	The test asset’s path. Note that if a matched token contains path separators, these will be escaped and stored as \/ in the test path.
TEST_URL	The test asset’s URL.
WORKSTATE	For Tosca Test Repositories, this column is set to the workstate associated with the test asset.
RANK	The test’s rank, either H (High), M (Medium) or L (Low), based on how recently it was last run, its passes and fails, the number of runs per day, and the number of test steps. More highly-ranked tests should be prioritized over tests with a lower rank.

If the RetrieveRankData field in the Configuration - Test Repository screen is set to Y, the Result dataset includes the additional fields which are used to calculate the RANK value. This applies to live Tosca Test Repository searches only.

By default, the Search Test Repository action does not search disabled Tosca test steps or values to find matching test assets. To allow disabled Tosca test steps and values to be searched, carry out the following steps:

Use the Define Action Parameters Wizard to add a new Boolean input parameter named SearchDisabledSteps to the Search Test Repository action.
Set the parameter’s value to true.

Tosca Test Repositories

If you have LiveCompare Administrator privileges, the Configuration - Test Repository screen may be used to control the behavior of the Search Test Repository action when searching Tosca Test Repositories.

Option	Description	Default Value
FindAPIModules	Set this field to 'Y' or leave blank to have LiveCompare find Tosca test cases that use API modules. Set to 'N' and LiveCompare will not find API modules. The default is to find API modules.	Y
FindClassicModules	Set this field 'Y' to have LiveCompare find Tosca test cases that use classic modules. This will increase the search time. Set to 'N' or leave blank and LiveCompare will not find classic modules. The default is to not find classic modules.	N
FindSAPModules	Set this field to 'Y' or leave blank to have LiveCompare find Tosca test cases that use SAP engine modules. Set to 'N' and LiveCompare will not find SAP engine modules. The default is to find SAP modules.	Y
FindUI5Modules	Set this field to 'Y' or leave blank to have LiveCompare find Tosca test cases that use SAP UI5 modules. Set to 'N' and LiveCompare will not find SAP UI5 modules. The default is to find SAP UI5 modules.	Y
RetrieveRankData	Set to 'Y' to have LiveCompare retrieve all the Tosca test case data it uses to calculate the 'Rank' when searching a live test repository. This data would be accessible using the Search Test Repository action. Leave blank to use the default setting. Default is to not retrieve all the data.	N
ScanTestCases	Set this field to 'Y' to have LiveCompare search for manual test cases in Tosca test repositories. A manual test case is one that does not use a module of type: Classic, SAP Engine, API or SAP UI5. This will increase the search time, sometimes by a lot. Set to 'N' or leave blank and LiveCompare will not search for manual test cases. The default is to not search for manual test cases.	N

For Tosca Test Repositories, LiveCompare uses the following algorithm when searching for token matches:

It finds all modules that match any of the supplied tokens.
For each matched module:
- It finds test cases that use the module directly via an enabled test step.
- It finds test cases that use the module indirectly via a reusable test step block.

Reusable test step blocks may be nested. In this case, LiveCompare traverses the hierarchy of blocks look for test cases.

Once the module/test case phase is complete, LiveCompare will optionally search for manual test cases. This search is switched off by default. If To enable the search for manual test cases, carry out the following steps:

Log in to LiveCompare as a user with Administrator privileges.
In the Administration hierarchy, navigate to the Configuration - Test Repository screen, and set the ScanTestCases field to X (use uppercase).

For live Tosca Test Repository searches (where the Use Cache property is set to ‘false’), the Search Test Repository action checks the specified Search Paths to verify that:

All parts of each Search Path are valid.
Each Search Path is synchronized in the Tosca workspace.

If either test fails, the action returns a suitable error message.

For Tosca Test Repositories, the Search Test Repository action returns test cases that match one of the workstates specified in the associated repository definition. If no workstates are listed in the Test Repository’s Workstates field, the action returns all matching test cases, regardless of their workstate.

ALM Test Repositories

Option	Description	Default Value
Scan Attachments	Set to 'X' to have LiveCompare scan all ALM Word document attachments (.docx) when searching for most-at-risk to test.	<blank>. Do not scan attachments.
Scan TestScripts	Set to 'X' to have LiveCompare scan ALM test scripts when searching for most-at-risk to test. Do not scan test scripts.	<blank>. Do not scan attachments.
UseExperimentalALMSearchMethod	Set to 'X' to have LiveCompare use an experimental method to search for ALM test hits. The method can be much faster than the standard method.	<blank>. Do not use the experimental search method.

Example:

Search Test Repository action example.

Read Test Repository Cache Actions

Write Test Repository Cache Actions

Test Repository Integrations