Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
rdms:webapp:search [2024/04/04 13:10]
jelte Headings adjusted 		rdms:webapp:search [2024/05/10 12:06] (current)
burcu [Filtering Your Search Results]
Line 2: Line 2:
 ====== Search ====== ====== Search ======
  
-The RDMS web interface comes with and extensive and flexible search functionality. Compared to other storage solutions, this search engine has the advantage that it can use metadata to query data in an exact manner. The integrated search engine also allows to make more elaborated queries/searches, for example by combining multiple metadata entries.+The RDMS web interface comes with and extensive and flexible search functionality. Unlike other storage solutions, this search engine offers the advantage of utilizing metadata for exact data queries. Additionally, the integrated search engine also allows to make more elaborated queries/searches, such as combining multiple metadata entries.
  
-This section will explain the basis functions of integrated search function as well as providing some more elaborated search/query examples. +This section will explain the basic functions of the integrated search and provide some more elaborated search/query examples using metadata. 
  
-===== Access RDMS Search =====+===== Accessing RDMS Search =====
  
-The access to the search engine is possible via the left-sided menu in the web interface. After login to the interface, click the {{:rdms:webapp:search.png?nolink&30|}} button on the left side of the menu to open the main view of the search. +Accessing the search engine is possible via the left-sided menu in the web interface.  
 + 
 +After logging in to the interface, simply click the {{:rdms:webapp:search.png?nolink&30|}} button on the left side of the menu to open the search function in the current window.
  
 {{ :rdms:webapp:rdms_search_general_1.png?direct&800 |}} {{ :rdms:webapp:rdms_search_general_1.png?direct&800 |}}
Line 15: Line 17:
 ==== General vs. Key/Value/Extra Search ==== ==== General vs. Key/Value/Extra Search ====
  
-The search functionality in the RDMS is available in two different flavors: +The search functionality in the RDMS is available in two distinct options: 
-  - **General search:** The general search which can be used to search based on different search criteria. +  - **General search:** The general search allows you to find results based on various criteria. 
-  - **Key/Value/Extra (KVE) search:** These search is specifically designed for querying/searching using multiple metadata entries at the same time. This search can be accessed via the {{:rdms:webapp:wiki_search_avu_1.png?nolink&30|}} button at the top of the search.+  - **Key/Value/Extra (KVE) search:** These search options is specifically designed for querying using multiple metadata entries simultaneously. You can access these search options via the {{:rdms:webapp:wiki_search_avu_1.png?nolink&20|}} button at the top of the search interface.
  
-You can change between both searches by selecting the respective tab from the top of the search. Below you will find more examples on how to use these searches to make simple and more elaborated searches in the RDMS.+You can change between these searche options by selecting the respective tab from the top of the search interface. Below you will find more examples demonstrating how to utilize these searches for both simple and more complex quearies in the RDMS.
  
 ==== Tabbed Searches ==== ==== Tabbed Searches ====
-The top menu in the search allows you to add new search tabs via the {{:rdms:webapp:search_new_tab.png?nolink&25|}} button which will create a new search tab. +The top menu in the search interface allows you to add new search tabs via the {{:rdms:webapp:search_new_tab.png?nolink&20|}} button which will create a new search tab. The tabbed search functionality enables you to manage multiple search queries simultaneously.
  
 {{ :rdms:webapp:rdms_search_tabs.png?direct&800 |}} {{ :rdms:webapp:rdms_search_tabs.png?direct&800 |}}
  
 ==== Saved Searches ==== ==== Saved Searches ====
-Additionally, it is possible to save searches for later re-use. To save a search, click the {{:rdms:webapp:rdms_save_search.png?nolink&20|}} button in the search view after you specified the desired search terms (see below for examples on how to use the search). +Additionally, it is possible to save searches for future use. To save a search, click the {{:rdms:webapp:rdms_save_search.png?nolink&20|}} button in the search view after you specified the desired search terms (see below for examples on how to use the search). 
  
 {{ :rdms:webapp:rdms_search_save.png?direct&800 |}} {{ :rdms:webapp:rdms_search_save.png?direct&800 |}}
  
-You will be asked to name the saved search. Specify a clear description of you search and then save it.+You will be asked to name your saved search. Give a clear description and name for your search and then save it.
  
 {{ :rdms:webapp:rdms_save_search_2.png?nolink&400 |}} {{ :rdms:webapp:rdms_save_search_2.png?nolink&400 |}}
Line 40: Line 42:
  
 ==== Sub-Searches ==== ==== Sub-Searches ====
-Whenever a search result is found, the RDMS search allows to execute a subsequent search inside the desired location. This is especially helpful if the first search found a respective folder and then a consecutive search inside this folder should be executed. +Whenever a search result is found, the RDMS search allows to execute subsequent searches inside the desired location. This feature is especially helpful when the first search finds a respective folder and a consecutive search inside this folder needs to be executed. Here's how to utilize sub-searches:
  
-To open the sub-search, first find the folder in which you want to search via the initial search, then click the magnifying glass button next to the folder name.+First find the folder in which you want to search via the initial search, then click the magnifying glass button next to the folder name.
  
 {{ :rdms:webapp:rdms_search_sub_1.png?direct&800 |}} {{ :rdms:webapp:rdms_search_sub_1.png?direct&800 |}}
  
- This will open a sub-search in a new tab where the folder location is already set as the search path. Inside the sub-search, you can then use either the general search or the KVE search (see below). +This will open a sub-search in a new tab where the folder location is already set as the search path. Inside the sub-search, you can then use either the general search or the KVE search (see below). 
  
 **Note:** You can of course also do sub-searches of sub-searches if this is needed. The process is the same as described here.  **Note:** You can of course also do sub-searches of sub-searches if this is needed. The process is the same as described here. 
Line 60: Line 62:
 ===== Using RDMS Search ===== ===== Using RDMS Search =====
 ==== General Search ==== ==== General Search ====
-To execute a basic search for data, you can specify the search term in the top-right box in the search engine and then execute the search by hitting the magnifying glass symbol:+To perform a basic search for data, you can specify the search term in the top-right box in the search engine and then execute the search by clicking on the magnifying glass symbol:
  
 {{ :rdms:webapp:rdms_search_simple_1.jpg?direct&900 |}} {{ :rdms:webapp:rdms_search_simple_1.jpg?direct&900 |}}
Line 66: Line 68:
 This will search for the specified search term using the standard search parameters.  This will search for the specified search term using the standard search parameters. 
  
-To make the search results more precise, you can adjust the search criteria. For example, you can specify that just data created in a certain time frame should be shown, that you want to see files only, that just a certain RDMS path should be search, and much more.+To make the search results more precise, you can adjust the search criteria. For example, you can specify if you want only data created within a certain time frame to be shown, to see files only, to search only certain RDMS paths, and much more.
  
 {{ :rdms:webapp:rdms_search_simple_2.png?direct&900 |}} {{ :rdms:webapp:rdms_search_simple_2.png?direct&900 |}}
Line 77: Line 79:
  
 **Note:** **Note:**
-  * This simple search will display results where the search term is found at various places. For example, it will find results where the search term is in the file name, but also where it is found in the metadata. +  * This simple search will display results where the search term is found at various locations. For example, it will find results where the search term appears in the file name, as well as where it is found in the metadata. 
  
-==== Search using Metadata ====+==== Search Using Metadata ====
  
 While the general search view can be also used to search based on metadata, the separate key/value/extra search was specifically designed to facilitate searches/queries that use multiple, combined metadata values as the search criteria.  While the general search view can be also used to search based on metadata, the separate key/value/extra search was specifically designed to facilitate searches/queries that use multiple, combined metadata values as the search criteria. 
Line 109: Line 111:
  
 **Note:** The function of combining multiple KVE entries to narrow down search results makes the metadata-based search of the RDMS web interface very powerful. This function is especially helpful for cases where there is a lot of data with distinct, but similar metadata entries.  **Note:** The function of combining multiple KVE entries to narrow down search results makes the metadata-based search of the RDMS web interface very powerful. This function is especially helpful for cases where there is a lot of data with distinct, but similar metadata entries. 
 +
 +===== Further Tips =====
 +==== Using Fast Search ====
 +
 +Next to the search function explained so far, the RDMS also has a fast search that can be used to make simple searches from any location in the RDMS. 
 +
 +To access the fast search, simply click on the UG logo in the top-left corner of the web interface:
 +
 +{{ :rdms:webapp:rdms_search_fast_1.png?direct&900 |}}
 +
 +A menu will be revealed where you can either specify a RDMS path to directly open it (left field) or do a fast search (right fields):
 +
 +{{ :rdms:webapp:rdms_search_fast_2.png?direct&900 |}}
 +==== More Advanced Search Syntax ====
 +
 +While it was shown above how files and folders can be found based on different parameters (name, metadata, etc.), and it was also shown that search criteria can be adjusted via the available menu to fine-tune search results, we will elaborate here advanced search syntax for further customization.
 +
 +When you specify a search term in the field, it is important to know that you can also use additional wildcard characters in your query. These wildcard characters are:
 +
 +  * ''_'': The underscore is the wildcard for **one character**. So searching for "Device_-Data" will find results for "DeviceA-Data", "DeviceB-Data", and so on, but not for "DeviceXXX-Data".
 +  * ''%'': The percentage sign is the wildcard for an **undefined** number of characters. So searching for "Device%-Data" will find the same results as described for "Device_-Data", but additionally also "DeviceXXX-Data".
 +
 +It is important to note that these wildcard characters can also be used for the search based on metadata. 
 +
 +To see how you can use these wildcards for further filtering of your query, take a look at this example where we first searched for "Device". This search yielded six similarly named folders, each with slight variations:
 +
 +{{ :rdms:webapp:rdms_search_syntax_1.jpg?direct&900 |}}
 +
 +Assuming that we now just want to find the configuration data for all devices 1-3, we could use a search term like "Device%_Configuration_Data" which will yield:
 +
 +{{ :rdms:webapp:rdms_search_syntax_2.png?direct&900 |}}
 +
 +As we used the ''%'' wildcard character in this example, this would also find results like "Device312_Configuration_Data" or "DeviceBuilding4_Configuration_Data".
 +
 +In another example, suppose we want to find both the analytical and configuration data folders for "Device1", but we do not want results for the other devices. This could be achieved with a query of the form "Device1_%_Data" as seen here:
 +
 +{{ :rdms:webapp:rdms_search_syntax_3.png?direct&900 |}}
 +
 +In ddition to the wildcard characters, it is also possible to use ''&'' and ''|'' in the search, which act as "and" and "or" operators, respectively. 
 +Let's assume that you want to find results that contain either "Device1" or "Device2" in their name. A search query for this can use the "or" statement to connect both terms like "Device1 | Device2" which will yield:
 +
 +{{ :rdms:webapp:rdms_search_syntax_4.png?direct&900 |}}
 +
 +**Note:**\\
 +As seen above, you can use wildcards to further fine-tune your search results. With other settings that are available in the search interface together with the possibility to use metadata, these advanced search techniques offer a lot of capability to obtain precise results tailored to your specific requirements.
 +
 +==== Filtering Your Search Results ====
 +
 +In some cases, your search parameters might return a pool of results that is too large to find what you are looking for. As shown in the figure below, the RDMS Web interface also warns you when the number of results exceeds 10.000:
 +
 +{{ :rdms:search:sfilter_1.png?direct&800 |}}
 +
 +To fix this, you might want to redefine your search parameters, as the Web interface suggests. However, this can sometimes result in having to wait a long time for a search to run again. Alternatively, you might want to filter the results you have already obtained. To do so, type an additional keyword in the bar highlighted by the red box in the figure below.
 +
 +{{ :rdms:search:sfilter_2.png?direct&800 |}}
 +
 +With the new keyword added, the RDMS Web interface will show you only the results which contain the keyword. Thus you can reduce the amount of displayed results without running a new search. The figure below shows what the filtering looks like.
 +
 +{{ :rdms:search:sfilter_3.png?direct&800 |}}
 +
 +**Note:** You are filtering the results rather than redefining the search parameters. This means that should you save the search and run it again, you will again encounter too many results. Each time you run that specific search, you will need to manually filter the results. We recommend that for frequently performed searches, you redefine the parameters once you have identified the optimal keyword combination through filtering.