Differences

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

--- rdms:webapp:search [2026/07/31 11:13] – burcu
+++ rdms:webapp:search [2026/08/14 09:05] (current) – old revision restored (2026/08/07 08:35) burcu
@@ Line 17: / Line 17: @@
   * **[[rdms:webapp:search#general_search|General Search]]:** You can use this option to find files and folders based on different criteria. The search uses both system-defined metadata and user-defined metadata.
-  * **[[rdms:webapp:search#search_using_metadata|Key-Value-Extra Search]]:** You can use this option to query **multiple metadata entries simultaneously**. Open this search option by clicking the {{:rdms:webapp:wiki_search_avu_1.png?nolink&30|}} button at the top of the search interface.
+  * **[[rdms:webapp:search#keyvalueextra_search|Key-Value-Extra Search]]:** You can use this option to query **multiple metadata entries simultaneously**. Open this search option by clicking the {{:rdms:webapp:wiki_search_avu_1.png?nolink&30|}} button at the top of the search interface.
 You can switch between the two options by selecting the corresponding tab at the top of the search interface. Later sections provide examples of both simple and advanced queries.
@@ Line 71: / Line 71: @@
 {{ :rdms:webapp:rdms_search_simple_1.png?direct&850 |}}
-This search looks for the specified term in file and folder names.
+This search looks for the specified term in file and folder names. To target a specific metadata entry, search for a metadata key, value, or extra value. You can also change the search path and choose whether to search for files, folders, or both. The screenshot below shows additional options.
-To target a specific metadata entry, search for a metadata key, value, or extra value. You can also change the search path and choose whether to search for files, folders, or both. The screenshot below shows additional options.
 {{ :rdms:webapp:rdms_search_simple_2.png?direct&850 |}}
@@ Line 80: / Line 78: @@
   * **Blue Box:** Specify the path to search. The default value is ''/rug/home/''. You can change it manually or by performing a sub-search. You can also select predefined values, such as "My home" or "All".
-  * **Red Box:** Configure additional search options. For example, you can choose whether to search for files or folders, restrict results to a specific creation period, or enable case-sensitive matching. If this menu is hidden, click the {{:rdms:webapp:search_reveal_button.png?direct&20|}} button. By default, an object must meet all specified criteria to appear in the results. The logical operator is ''AND'', as shown on the left side of the box. To find objects that meet any of the specified criteria, change the relevant operator to ''OR''.
+  * **Red Box:** Configure additional search options. For example, you can choose whether to search for files or folders, restrict results to a specific creation period, or enable case-sensitive matching. If this menu is hidden, click the {{:rdms:webapp:search_reveal_button.png?direct&20|}} button. By default, an object must meet all specified criteria to appear in the results. The logical operator is "AND", as shown on the left side of the box. To find objects that meet any of the specified criteria, change the relevant operator to "OR".
-  * **Green Box:** Refine how the search terms are interpreted. ''Any match (%<word>%)'' finds the term either as a standalone value or as part of another value. For example, a search for ''time'' also finds ''timecapsule'' and ''walltime''. ''Exact match'' returns only results that contain the exact search term. ''Right truncated (<word>%)'' matches values that start with the search term. ''Left truncated (%<word>)'' matches values that end with the search term.
+  * **Green Box:** Refine how the search terms are interpreted. "Any match (%<word>%)" finds the term either as a standalone value or as part of another value. For example, a search for ''time'' also finds ''timecapsule'' and ''walltime''. "Exact match" returns only results that contain the exact search term. "Right truncated (<word>%)" matches values that start with the search term. "Left truncated (%<word>)" matches values that end with the search term.
 **Note:** The ''%'' sign is the RDMS wildcard for any number of characters. Its position affects the results. For example, ''%cube'' finds both ''cube'' and values ending in ''cube'', regardless of the preceding characters.
+==== Key/Value/Extra Search ====
-==== Key/Value/Extra Search (Combined Metadata) ====
 Although General Search can use metadata, Key-Value-Extra Search is designed specifically for queries that combine multiple metadata entries.
@@ Line 93: / Line 90: @@
 {{ :rdms:webapp:rdms_search_kve_1.png?direct&850 |}}
-You can add multiple Key-Value-Extra rows by clicking the {{:rdms:webapp:rdms_search_kve_add.png?nolink&20|}} button. To remove a row, click the {{:rdms:webapp:search_kve_remove.png?direct&20|}} button.
+You can add multiple Key-Value-Extra rows by clicking the {{:rdms:webapp:rdms_search_kve_add.png?nolink&20|}} button. To remove a row, click the {{:rdms:webapp:search_kve_remove.png?direct&20|}} button. The following example demonstrates how to use this functionality.
-The following example demonstrates how to use this functionality.
 {{ :rdms:webapp:rdms_search_kve_2.png?direct&850 |}}
@@ Line 136: / Line 131: @@
 ==== Using Fast Search ====
-In addition 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.
+In addition to the search functions described above, the RDMS provides Fast Search for simple queries from any location.
-To access the fast search, simply click on the UG logo in the top-left corner of the web interface:
+To access Fast Search, click the UG logo in the top-left corner of the Web interface.
 {{ :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 opens with two search fields. The field on the left allows you to open a specific RDMS path directly in the Data Browser. The field on the right searches for a term using the default parameters and opens the results in the search window.
 {{ :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, 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.
+**Note:** Fast Search performs an ''Exact match'' query across all four fields in General Search. It is intended mainly for users with long file lists, for whom a standard search may take considerable time. Fast Search is therefore a streamlined search operation, not only a shortcut to the search interface. If standard searches complete quickly, use the full search interface to obtain more precise results.
-==== More Advanced Search Syntax ====
+==== Advanced Search Syntax ====
-In previous sections, we already anticipated some of the special characters that you can use in the input fields to signal to the RDMS that you want to perform a special operation during the search. 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 RDMS supports special characters for advanced search operations. You can use the following wildcard characters in any search field:
-  * ''_'': The underscore is the wildcard for **one character**. Searching for "Device_-Data" will find results for "DeviceA-Data", "DeviceB-Data", "DeviceC-Data", and so on, but not for "DeviceXXX-Data", as the characters after the term "Device" are three and not one.
+  * ''_'': Represents **exactly one character**. Searching for ''Device_-Data'' finds ''DeviceA-Data'', ''DeviceB-Data'', and ''DeviceC-Data'', but not ''DeviceXXX-Data''.
-  * ''%'': 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".
+  * ''%'': Represents **any number of characters**. Searching for ''Device%-Data'' finds the same results as ''Device_-Data'', but it also finds ''DeviceXXX-Data''.
-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:
+The following example starts with a search for ''Device''. The search returns six folders with similar names.
+\\
 {{ :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".
+Suppose that you want to find the configuration data for all three devices, but not the analytical data. The configuration-data folder names differ only by the device number. Because only one character differs, search for ''Device_ Configuration Data'' to return all three folders.
+For names that differ by more than one character, use the more general query ''Device% Configuration Data''.
+\\
 {{ :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", if they existed.
+Because this query uses the ''%'' wildcard, it also returns values such as ''Device312_Configuration_Data'' or ''DeviceBuilding4_Configuration_Data'', if they exist. To find both the analytical and configuration data folders for ''Device1'', while excluding other devices, use ''Device1_%_Data'' or the shorter query ''Device1%''.
-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.
+You can also use ''&'' and ''|'' as the "AND" and "OR" operators, respectively. To find results containing either ''Device1'' or ''Device2'' in their names, enter ''Device1 | Device2''.
-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:** Wildcards and operators allow you to refine search results further. Combined with the other search settings and metadata fields, these techniques support precise queries tailored to your requirements.
+==== Filtering Search Results ====
-==== 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. The figure below shows you that the RDMS Web interface also warns you when the number of results exceeds 10.000.
+Some searches may return too many results to review efficiently. The RDMS Web interface displays a warning when the number of results exceeds 10,000.
 {{ :rdms:search:sfilter_1.png?direct&850 |}}
-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. As an alternative, the RDMS allows you to filter the results you have already obtained by typing in an additional keyword in the bar highlighted by the red box in the figure below.
+You can refine the original search parameters, as suggested by the Web interface. However, rerunning the search may take considerable time. Alternatively, you can filter the existing results by entering an additional keyword in the field highlighted below.
 {{ :rdms:search:sfilter_2.png?direct&850 |}}
-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.
+The Web interface then displays only results containing that keyword. This reduces the displayed result set without rerunning the search.
 {{ :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:** This function filters the displayed results. It does not change the original search parameters. If you save and rerun the search, you must enter the filter again. For frequently used searches, update the original parameters after identifying an effective keyword combination.
+==== Exporting Search Results ====
-==== Exporting Search Results (Report Generation) ====
+The RDMS includes functions for exporting search results in report-compatible formats. First, run a search. Then select one of the following 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:** Creates JSON files containing the search results and parameters. You can use these files to generate a final report.
+  * **Export search results as...:** Directly exports the search results in an available format. The current format is ''*.csv''.
-  * **Create report**: This function creates a set of JSON files containing the search results. From these files, you can then create the final report.
-  * **Export search results as...**: This function directly exports the search results in a presentable format that you can choose (currently *.csv)
 {{ :rdms:webapp:rdms_report_1.png?direct&850 |}}
@@ Line 204: / Line 200: @@
 === 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.
+Click "Create report" to open a dialog window. Enter a report name and choose whether to encrypt the intermediate JSON file.
+You should use encryption when the search parameters or result metadata contain sensitive information. The JSON file contains both the search parameters and result metadata.
 {{ :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 confirming your choices, click the {{:rdms:webapp:rdms_report_button.png?direct&25|}} button in the menu bar on the left to open the report window.
-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).
+Depending on your screen resolution, this button may be hidden. If it is not visible, click the {{:rdms:webapp:more_menu_button.png?nolink&25|}} button to display the hidden menu items.
+In the report window, you can manage saved reports. You can:
+  * Generate a final CSV report
+  * View or Download the JSON files containing the results and parameters
+  * Delete reports
 {{ :rdms:webapp:rdms_report_new_2.png?direct&850 |}}
-If you select the option to create your final report for export, a new window will open. The first option in that window will ask you for the location to save your report file. This will be an RDMS location where you will be able to retrieve the final report by downloading it from the web interface (the file size should be small enough to allow this). The options below in the same window ask you to select which part of the results you want to include in the report (data, metadata, and/or permissions), in what format you want the report, and what metadata to include.
+When you choose to create the final report, a new window opens. First, specify the RDMS location in which to save the report. You can later navigate to this location and Download the report through the Web interface.
-{{ :rdms:webapp:rdms_report_new_3.png?direct&650 |}}
+Then select:
-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.
+  * The result information to include, such as data, metadata, and permissions
+  * The report format
+  * The metadata fields to export
-{{ :rdms:webapp:rdms_report_6.png?direct&850 |}}
+{{ :rdms:webapp:rdms_report_new_3.png?direct&650 |}}
-**Notes**:
+After confirmation, the RDMS saves the report in the specified location. You can then Download the CSV file through the Web interface.
-  * 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 the "Export Search Results as" Function ===
+**Notes:**
-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).
+  * Encryption is optional, but you should use it when the exported results contain sensitive information.
+  * The report includes the following system-defined metadata by default: "Data type", "Size", "Creator", and "Modified".
+\\
+=== Using the Export Search Results As Function ===
+The "Export search results as..." function creates an exportable CSV file directly from the search results. After selecting this option, specify where the CSV file should be saved in the RDMS. Then select the export type, such as data, metadata, and permissions, and enter a name for the export. The Web interface provides a default name.
 {{ :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.
+Click "Export report" to generate the CSV file in the specified location. Navigate to that RDMS location to Download the report through the Web interface.
-**Notes**:
+**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.
-  * 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.
-=== Importing Report Files in Spreadsheet Tools ===
-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.
+  * The "Export search results as..." function is a shortcut for generating a CSV file. Therefore, **you cannot select individual metadata fields** when metadata is included in the export. The RDMS exports all metadata by default.
+  * The function also creates an intermediate JSON file in the background. These files contain the search results and parameters.
+  * You can access the intermediate JSON files by clicking the {{:rdms:webapp:rdms_report_button.png?direct&25|}} button in the menu bar on the left. From there, you can generate additional reports and refine the export parameters, such as the metadata fields to include.
+  * The "Export search results as..." function automatically encrypts the intermediate JSON files.
+\\
+=== Importing Report Files into Spreadsheet Applications ===
-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).
+You can import RDMS CSV reports into spreadsheet applications, such as Microsoft Excel or LibreOffice Calc, for visualisation and further processing. RDMS CSV reports use a **tab character as the field delimiter**. Select the tab delimiter during import. Otherwise, the columns will not be parsed correctly. RDMS metadata fields can contain multiple lines. If multiline fields cause import problems, select a replacement character for line breaks when creating the report.
 {{ :rdms:webapp:report_linebreak.png?direct&500 |}}