Differences

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

--- rdms:webapp:search [2025/08/19 13:37] – [General vs. Key-Value-Extra Search] made button a little bit bigger jelte
+++ rdms:webapp:search [2025/09/23 14:31] (current) – [Key/Value/Extra Search (Combined Metdata)] adjusted search placeholder to the current one (file/folder name) jelte
@@ Line 19: / Line 19: @@
 The search functionality in the RDMS is available in two distinct options:
-  - **[[rdms:webapp:search#general_search|General search]]:** This option allows you to find a file or folder based on various criteria. It uses both file metadata and metadata added by the user to search the system for files and folders fitting the desired parameters. This option does allow you to search for files using metadata entries you created, but if you wish to combine multiple metadata entries into one search, then you need to use the next search option.
+  - **[[rdms:webapp:search#general_search|General search]]:** This option allows you to find data based on various criteria. It uses both, system-defined metadata and metadata added by the user, to search the system for files and folders fitting the desired parameters.
   - **[[rdms:webapp:search#search_using_metadata|Key-Value-Extra (KVE) search]]:** This search option is specifically designed for querying using **multiple metadata entries simultaneously**. You can access this search option via the {{:rdms:webapp:wiki_search_avu_1.png?nolink&30|}} button at the top of the search interface.
-You can switch between these search options by selecting the respective tab from the top of the search interface. Further below in this page you will find more examples demonstrating how to utilize these search options for both simple and more complex queries in the RDMS.
+You can switch between these search options by selecting the respective tab at the top of the search interface. Further below on this page, you will find more examples demonstrating how to utilize these search options for both simple and more complex queries in the RDMS.
 ==== Tabbed Searches ====
@@ Line 32: / Line 32: @@
 ==== Saved Searches ====
-Another function available to you is 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 your desired search terms.
+Another function available to you is 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 have specified your desired search terms.
 {{ :rdms:webapp:rdms_search_save.png?direct&850 |}}
@@ Line 61: / Line 61: @@
   - {{:rdms:webapp:search_open_new_browser.png?nolink&30|}} button: This button opens the result in a new data browser tab. This will keep the initial search active in the parent tab, should you want to go back to it.
-  - {{:rdms:webapp:search_open_current_browser.png?nolink&30|}} button: This button opens the result in the Data Browser. This replaces the search window with the Data Browser open in the location of the file you found. If you want to return to the search, you will have to navigate back to the search window from the left-side Menu and perform the search again.
+  - {{:rdms:webapp:search_open_current_browser.png?nolink&30|}} button: This button opens the result in the current tab. This replaces the search window with the Data Browser open in the location of the data you found. If you want to return to the search, you will have to navigate back to the search window from the left-side Menu and perform the search again.
 {{ :rdms:webapp:search_new_vs_current_tab.png?direct&850 |}}
@@ Line 69: / Line 69: @@
 ==== General Search ====
-To perform the most basic form of searching 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 {{:rdms:webapp:search_icon.png?nolink&25|}} icon (see screenshot).
+To perform the most basic form of searching for data, you can specify the search term in the top box in the search engine and then execute the search by clicking on the {{:rdms:webapp:search_icon.png?nolink&25|}} icon (see screenshot).
 {{ :rdms:webapp:rdms_search_simple_1.png?direct&850 |}}
-This method of searching makes the RDMS look for the specified term in any part of the metadata attached to your files and folders. In other words, it does not matter if the term is contained in the file name, the file path, or any of the metadata entries attached to the file. As long as the term is contained somewhere, the file will be shown as a result in the search.
+This simple method of searching looks for the specified term in the name of any files and folders.
-If you want to target a specific metadata entry in your search, you can adjust the search criteria by directly searching for a specific metadata value, key, or extra value. You can modify the path where the search needs to be performed, and you can also indicate whether you want to search for files and folders, or only for one of the two. Other options as to what you can adjust in the search are visible in the screenshot above and explained in the text below.
+If you want to target a specific metadata entry in your search, you can adjust the search criteria by searching for a specific metadata value, key, or extra value. You can modify the path where the search needs to be performed, and you can also indicate whether you want to search for files and folders, or only for one of the two. Other options as to what you can adjust in the search are visible in the screenshot above and explained in the text below.
 {{ :rdms:webapp:rdms_search_simple_2.png?direct&850 |}}
@@ Line 81: / Line 81: @@
 In the screenshot above, you can see the three different areas where you can specify the search criteria in the main search view:
-  - **Blue Box**: Here you can specify the path of the location you want to search in. The default value here is ''/rug/home/'', but you can adjust it either manually, or by performing a sub-search as described above. There are also several pre-defined values possible (e.g. "My home" or "All").
+  - **Blue Box**: Here you can specify the path of the location you want to search in. The default value here is ''/rug/home/'', but you can adjust it either manually or by performing a sub-search as described above. There are also several pre-defined values possible (e.g., "My home" or "All").
   - **Red Box**: Here you can specify more details about the search mode. For example, you can say if you want to see files or folders, if you want to find just data created in a certain time frame, or if your search should be case sensitive or not. If you do not see this menu, you can reveal it by clicking the {{:rdms:webapp:search_reveal_button.png?direct&20|}} button. By default, all parameters are considered to have to be valid at the same time for an object to be considered a valid search result (logical argument is ''AND'', look to the left inside the box). If you want to find objects that do not need to fulfill all the search criteria simultaneously, please change the relevant values to ''OR''.
-  - **Green Box**: This additional box allows to further fine-tune the search method. In this field, you select how the entered search term(s) should be interpreted. ''Any match (%<word>%)'' will find the search term either alone or contained in another term (e.g. searching for "time" would also be positive for "timecapsule" or "walltime"). ''Exact match'' on the other hand just gives a positive search result if the exact search term(s) where found. The two other selection criteria, ''Right truncated (<word>%)'' and ''Left truncated (%<word>)'', are positive if the search term was found either at the start or end of a value, respectively.
+  - **Green Box**: This additional box allows for further fine-tuning of the search method. In this field, you select how the entered search term(s) should be interpreted. ''Any match (%<word>%)'' will find the search term either alone or contained in another term (e.g., searching for "time" would also be positive for "timecapsule" or "walltime"). ''Exact match'', on the other hand, just gives a positive search result if the exact search term(s) were found. The two other selection criteria, ''Right truncated (<word>%)'' and ''Left truncated (%<word>)'', are positive if the search term was found either at the start or end of a value, respectively.
-**Note:** The ''%'' sign in the green box explanation is the wildcard sign for the RDMS search. Its meaning is that whatever is not contained by two ''%'' signs or does precede or follow it, does not matter. Example: "%cube" would find all entries that are either the exact word "cube", or that end in the word "cube", no matter with what other term they start. Please keep in mind that the position of the ''%'' sign matters when performing a search.
+**Note:** The ''%'' sign in the green box explanation is the wildcard sign for the RDMS search. Its meaning is that whatever is not contained by two ''%'' signs or does precede or follow it, does not matter. Example: "%cube" would find all entries that are either the exact word "cube" or that end in the word "cube", no matter with what other term they start. Please keep in mind that the position of the ''%'' sign matters when performing a search.
-==== Search Using Metadata ====
+==== Key/Value/Extra Search (Combined Metdata) ====
-While the general search window can also be used to search based on metadata, the separate Key-Value-Extra (KVE) search was specifically designed to facilitate queries that use multiple, combined metadata values as the search criteria.
+While the general search window can also be used to search based on metadata, the separate Key/Value/Extra (KVE) search was specifically designed to facilitate queries that use multiple, combined metadata values as the search criteria.
-To perform a KVE search, first access the KVE tab ({{:rdms:webapp:wiki_search_avu_1.png?nolink&25|}}) from the top of the search view. You will see that the KVE search contains search fields for metadata keys (K), metadata values (V), and metadata extra values (E) while the ''Enter a text to search for'' function that was available in the general search is not available here.
+To perform a KVE search, first access the KVE tab ({{:rdms:webapp:wiki_search_avu_1.png?nolink&25|}}) from the top of the search view. You will see that the KVE search contains search fields for metadata keys (K), metadata values (V), and metadata extra values (E), while the "File/folder name..." option that was available in the general search is not available here.
 {{ :rdms:webapp:rdms_search_kve_1.png?direct&850 |}}
-Instead of being able to search for only one term for each field, the KVE search allows to add new KVE lines by selecting the {{:rdms:webapp:rdms_search_kve_add.png?nolink&20|}} button. If you want to remove a KVE line that you added, you can use the {{:rdms:webapp:search_kve_remove.png?direct&20|}} button to do so.
+Instead of being able to search for only one term for each field, the KVE search allows you to add new KVE lines by selecting the {{:rdms:webapp:rdms_search_kve_add.png?nolink&20|}} button. If you want to remove a KVE line that you added, you can use the {{:rdms:webapp:search_kve_remove.png?direct&20|}} button to do so.
 We will use the example below to explain the correct usage of this functionality. Let us start with the search shown in the screenshot below:
@@ Line 101: / Line 101: @@
 {{ :rdms:webapp:rdms_search_kve_2.png?direct&850 |}}
-In this example, we used a single KVE line as search criteria (''Key: "Author", Value: "John Doe"'') which resulted in four files being found by the search. While four files are easy to sort through to find the correct file we want, let's consider that instead the search returned a number of files in the thousands. Because those would be too many files to sort through, we attempt to filter the results by adding a new KVE line. So we press the {{:rdms:webapp:rdms_search_kve_add.png?nolink&20|}} and add a new KVE line with the search terms: ''Key: "Date", Value: "today"''.
+In this example, we used a single KVE line as search criteria (''Key: "Author", Value: "John Doe"''), which resulted in four files being found by the search. While four files are easy to sort through to find the correct file we want, let's consider that instead the search returned a number of files in the thousands. Because those would be too many files to sort through, we attempt to filter the results by adding a new KVE line. So we press the {{:rdms:webapp:rdms_search_kve_add.png?nolink&20|}} and add a new KVE line with the search terms: ''Key: "Date", Value: "today"''.
 {{ :rdms:webapp:rdms_search_kve_3.png?direct&850 |}}
@@ Line 127: / Line 127: @@
 {{ :rdms:webapp:rdms_search_fast_1.png?direct&900 |}}
-A menu will reveal two fields where you can perform your search. The field on the left allows you to search for a specific RDMS path and open it directly in the browser, the field on the right will instead perform a search of a given term with all the default parameters and open the search window with the results.
+A menu will reveal two fields where you can perform your search. The field on the left allows you to search for a specific RDMS path and open it directly in the browser; the field on the right will instead perform a search of a given term with all the default parameters and open the search window with the results.
 {{ :rdms:webapp:rdms_search_fast_2.png?direct&900 |}}
-**Note:** Please consider that the fast search will perform an ''Exact Match'' search for a term and look for the term in all four fields of the general search window. This function has been developed mainly for users with a long file list to check, that would otherwise have to wait for an unreasonably long time for the search results to appear. The fast search is thus not a "fast access to the search function", but rather a "search performed fast". If you do not have long waiting times when performing searches, it is better to navigate to the search window and perform a search as described in the previous sections to obtain more meaningful results.
+**Note:** Please consider that the fast search will perform an "Exact Match" search for a term and look for the term in all four fields of the general search window. This function has been developed mainly for users with a long file list to check, who would otherwise have to wait for an unreasonably long time for the search results to appear. The fast search is thus not a "fast access to the search function", but rather a "search performed fast". If you do not have long waiting times when performing searches, it is better to navigate to the search window and perform a search as described in the previous sections to obtain more meaningful results.
 ==== More Advanced Search Syntax ====
@@ Line 140: / Line 140: @@
   * ''%'': The percentage sign is the wildcard for an **undefined** number of characters. Searching for "Device%-Data" will find the same results as described for "Device_-Data", but additionally also "DeviceXXX-Data", as it does not matter how many characters follow the term "Device".
-Note that these wildcard characters are recognized within the RDMS, no matter which field you use to search for a term. 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:
+Note that these wildcard characters are recognized within the RDMS, no matter which field you use to search for a term. 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 |}}
-Let us assume that we do not care about the analytical data, but want to find the configuration data for all 3 devices. We can see in our search results that all configuration data folders are called the same way, except for the number of the device. Since only one value differs, we could search for ''Device_ Configuration Data'' and get all three folders that we need. A more general option, especially if you have more than a single character changing between files or folders, is ''Device% Configuration Data''.
+Let us assume that we do not care about the analytical data, but want to find the configuration data for all 3 devices. We can see in our search results that all configuration data folders are called the same way, except for the number of the device. Since only one value differs, we could search for "Device_ Configuration Data" and get all three folders that we need. A more general option, especially if you have more than a single character changing between files or folders, is "Device% Configuration Data".
 {{ :rdms:webapp:rdms_search_syntax_2.png?direct&900 |}}
@@ Line 150: / Line 150: @@
 As we used the ''%'' wildcard character in this example, this would also find results like "Device312_Configuration_Data" or "DeviceBuilding4_Configuration_Data", if they existed.
-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. We can achieve this with a query of the form ''Device1_%_Data'' (or even more simply ''Device1%''), as seen here:
+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. We can achieve this with a query of the form "Device1_%_Data" (or even more simply "Device1%"), as seen here:
 {{ :rdms:webapp:rdms_search_syntax_3.png?direct&900 |}}
 In addition 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. You can create a search query for this "or" statement by writing ''Device1 | Device2'', which will yield:
+Let's assume that you want to find results that contain either "Device1" or "Device2" in their name. You can create a search query for this "or" statement by writing "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.
+**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 ====
@@ Line 171: / Line 171: @@
 {{ :rdms:search:sfilter_2.png?direct&850 |}}
-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.
+With the new keyword added, the RDMS Web interface will show you only the results that contain the keyword. Thus, you can reduce the number of displayed results without running a new search. The figure below shows what the filtering looks like.
 {{ :rdms:search:sfilter_3.png?direct&850 |}}
-**Note:** What we have shown here is used to filter the search results. You are not redefining the original search parameters. This means that should you save the search and run it again, you will need to type in the filter manually, again. And this will be true each time you run that specific search. We recommend that for frequently performed searches, instead of doing this, you redefine the parameters once you have identified the optimal keyword combination through filtering.
+**Note:** What we have shown here is used to filter the search results. You are not redefining the original search parameters. This means that should you save the search and run it again, you will need to type in the filter manually again. And this will be true each time you run that specific search. We recommend that, for frequently performed searches, instead of doing this, you redefine the parameters once you have identified the optimal keyword combination through filtering.
 ==== Exporting Search Results (Report Generation) ====
-The RDMS also comes with built-in functionality to export search results in formats suitable for report. To access this feature, first execute your search. Once the search results are displayed, you can select one of the available report functions:
+The RDMS also comes with built-in functionality to export search results in formats suitable for a report. To access this feature, first execute your search. Once the search results are displayed, you can select one of the available report functions:
   * **Create report**: This function creates a set of JSON files containing the search results. From these files, you can then create the final report.
@@ Line 189: / Line 189: @@
 === Using the Create Report Function ===
-If you select ''Create report'', a dialog window will open. Here you can specify a name for your report and select if you want to encrypt the JSON file created as an intermediate step. A reason to encrypt the JSON file would be, for example, if your search parameters or the metadata of your results contain sensitive information. Since the JSON file contains and displays both, you might want to choose to encrypt it to protect potentially sensitive information.
+If you select "Create report", a dialog window will open. Here, you can specify a name for your report and select if you want to encrypt the JSON file created as an intermediate step. A reason to encrypt the JSON file would be, for example, if your search parameters or the metadata of your results contain sensitive information. Since the JSON file contains and displays both, you might want to choose to encrypt it to protect potentially sensitive information.
 {{ :rdms:webapp:rdms_report_new_1.png?direct&400 |}}
-After you confirm your choices, your report will be visible if you click the report button ({{:rdms:webapp:rdms_report_button.png?direct&25|}}) in the left-hand Menu bar. Please keep in mind that depending on your screen resolution, this button might be hidden. If you do not see it, then press the {{:rdms:webapp:more_menu_button.png?nolink&25|}} button to reveal all hidden Menu items.
+After you confirm your choices, your report will be visible if you click the report button ({{:rdms:webapp:rdms_report_button.png?direct&25|}}) in the left-hand Menu bar. Please keep in mind that, depending on your screen resolution, this button might be hidden. If you do not see it, then press the {{:rdms:webapp:more_menu_button.png?nolink&25|}} button to reveal all hidden Menu items.
 From within the report window, you can now manage reports you have saved. You can choose to either create your final report in CSV format, view or download the JSON files containing your search results and parameters, or delete one or more reports (see screenshot below).
@@ Line 203: / Line 203: @@
 {{ :rdms:webapp:rdms_report_new_3.png?direct&650 |}}
-After you give confirmation, the RDMS will save the report in the specified location and you can download it in CSV format from the web interface.
+After you give confirmation, the RDMS will save the report in the specified location, and you can download it in CSV format from the web interface.
 {{ :rdms:webapp:rdms_report_6.png?direct&850 |}}
 **Notes**:
-  * While it is not mandatory to select encryption for the created JSON files with your search results and parameters, we advise you to do it if the exported results contain sensitive data. Having encryption selected is also recommended as simply good practice.
+  * While it is not mandatory to select encryption for the created JSON files with your search results and parameters, we advise you to do so if the exported results contain sensitive data. Having encryption selected is also recommended as simply good practice.
   * The report will contain system-defined metadata added by default ("Data type", "Size", "Creator", "Modified"), even if you did not add any user-defined metadata.
-=== Using Export Search Results As Function ===
+=== Using the "Export Search Results as" Function ===
-The ''Export search results as...'' function allows you to directly create an exportable CSV from your search results. If you select this option from the search view, you will be asked where your exportable CSV should be saved within the RDMS. Afterwards, you are asked to select the export type (data, metadata and/or permissions), and to specify a name for your export (a default value is automatically filled in).
+The "Export search results as..." function allows you to directly create an exportable CSV from your search results. If you select this option from the search view, you will be asked where your exportable CSV should be saved within the RDMS. Afterwards, you are asked to select the export type (data, metadata, and/or permissions), and to specify a name for your export (a default value is automatically filled in).
 {{ :rdms:webapp:rdms_report_new_4.png?direct&500 |}}
-Clicking on ''Export report'' will generate a CSV file in the specified location. You can retrieve the report by navigating to the specified RDMS location and downloading the report from the web interface.
+Clicking on "Export report" will generate a CSV file in the specified location. You can retrieve the report by navigating to the specified RDMS location and downloading the report from the web interface.
 **Notes**:
-  * The ''Export search results as...'' function is **a shortcut way** to generate an exportable CSV of your search results, and as such, **it does not allow you to directly select which metadata to extract**, if metadata is included in your report. Instead all metadata is exported by default.
+  * The "Export search results as..." function is **a shortcut way** to generate an exportable CSV of your search results, and as such, **it does not allow you to directly select which metadata to extract**, if metadata is included in your report. Instead, all metadata is exported by default.
-  * Choosing the ''Export search results as...'' function will still create a JSON file in the background. These files contain your search results and parameters. You can access them via the report button ({{:rdms:webapp:rdms_report_button.png?direct&25|}}) in the left Menu bar. By doing so, you can create further reports from these intermediate JSON files, and you can fine-tune the export parameters (e.g. which metadata to include in the CSV).
+  * Choosing the "Export search results as..." function will still create a JSON file in the background. These files contain your search results and parameters. You can access them via the report button ({{:rdms:webapp:rdms_report_button.png?direct&25|}}) in the left Menu bar. By doing so, you can create further reports from these intermediate JSON files, and you can fine-tune the export parameters (e.g., which metadata to include in the CSV).
-  * The ''Export search results as...'' will automatically use encryption for the intermediate JSON files that are created.
+  * The "Export search results as..." will automatically use encryption for the intermediate JSON files that are created.
 === Importing Report Files in Spreadsheet Tools ===
-The CSV reports you download from the RDMS can be imported in spreadsheet tools (e.g. MS Excel, LibreOffice) for visualization and further processing. It is important to note that the CSV reports in the RDMS use **tab as field delimiter**! Please be sure that you select this during import in your spreadsheet tool, as it will otherwise break the formatting of your import and the data will be hard to read.
+The CSV reports you download from the RDMS can be imported into spreadsheet tools (e.g., MS Excel, LibreOffice) for visualization and further processing. It is important to note that the CSV reports in the RDMS use **tab as field delimiter**! Please be sure that you select this during import in your spreadsheet tool, as it will otherwise break the formatting of your import, and the data will be hard to read.
 Another important aspect to consider is that the RDMS metadata fields can be multi-line fields. In cases where this causes problems when importing the CSV into another tool, you can choose to automatically replace newlines in the exported CSV by simply selecting a replacement character during report creation (see screenshot below).
 {{ :rdms:webapp:report_linebreak.png?direct&500 |}}