This guide explains how to use global search features and filters, and how to understand the search results.
Global Search: Settings
In order to provide the search functionality, Data Services ingests the metadata of files and directories from host filers on a predefined and periodic schedule (Global Search is not a real time service) and indexes them into a searchable database.
However, users have the ability to change the metadata ingesting schedules, at the individual filer level, through the Manage Plugins section of Data Services, accessible from the Data Services menu.
In order to make such a change, users need to select filers in the Manage Plugins page, then navigate to the Configure page through the Actions drop-down menu, and change the Meta Interval field. When the Meta Interval is set to Never, Data Services stops ingesting and indexing user metadata.
Global Search: Search
Global Search searches all connected file systems to deliver best-match results for your search query.
Using the Search Bar
The Search Bar accepts alphanumeric characters and requires a query length of at least three, including spaces. A warning message will advise when your search query is too short.
Global Search is not case sensitive.
Saving Search Queries
Users can save their search queries for future use, by clicking the Save Search link, below the Search Bar on the left side. The saved search queries are available for use through the ribbon sign button, at the rightmost corner inside the Search Bar. Through the same button, the saved search queries can be deleted.
Listing All Files
The empty Search Bar can be used to list all the files, directories and snapshots of all connected file systems for which metadata has been indexed. To activate this list, users can place their cursor within the Search Bar and press RETURN, or click the search icon.
The below picture shows the Global Search page, with the Search Bar, Save Search link, Save Search button, and the Guidance for Search link, all at the top.
Improving Search Precision
Global Search service is a flexible search that operates based on the similarities between the search queries and the indexed data. The more similar the indexed records are to the search query, the higher the item placed on the search results list.
Such a similarity based search makes it an ideal tool for both precise and imprecise searches.
However, in order to help users to have more precise and targeted searches, Global Search service provides two directives, through which users could guide the search process by providing the extra information, to achieve closer matches.
These search directives are explained in the Guidance for Search popup link, at the right side of the Search Bar.
Guidance For Search
The Global Search service’s search directives are based on the targets’ names and targets’ paths, as follow:
- path = “/<full path>/” through which users can limit the search for files and folders in exact paths.
- path ~= “/<full path or partial path>/*” through which users can limit their search to files and folders within inexact paths. Asterisks “*” can be used as wildcard masks at the beginning, middle, and end of paths. Asterisks can only be used, with “~=”
- path != “/<full path>/” through which users can negates the path directive and exclude the path results from the search results
- file = “full name” through which users can specify the exact name of the file or directory they are looking for
- file ~= “full or partial name*” through which users can look for files with similar names to the filename specified. Asterisks “*” can be used as wildcard masks at the beginning, middle, and end of paths. Asterisks can only be used, with “~=”
- file != “full name” through which users can negates the file directive and exclude the name results from the search results
- AND is the operator through which users can combine other directives with each other. It is a logical & operation, where its result resolves to True only when both of its input operands are True
Global Search: Search Filters
Global Search service provides several filters through which users can narrow down their search results based on additional filtering information. These filters are accessible through the left side panel of the Global Search page, as follows:
- Search In: through which users can select only their desired Target Filers. The target filers are the filers that own the paths in which the searches take place. By default, all filers of all clusters are selected to be included in the search
- File Age Range: through which users can filter the search results based on the age of the search targets, meaning the timestamps for their last modifications.The File Age Range has the following three options, which by default none of them is selected.
- Hot: less than seven days
- Warm: less than thirty days, but more than seven days
- Cold: more than thirty days
- Date Range: through which users can filter the search results for a specific data range. The dates are based on the timestamps for the targets’ last modifications. The Date Range is unspecified by default
- Document Type: through which users can filter the search results based on files or directories. The file type is the default value for this filter
- Snapshot Inclusion: through which users can direct the search results to include or exclude snapshots. The Snapshot Inclusion filter is set to OFF by default, meaning that if not turned on, the Global Search service does not search for, or include snapshots in the search results
- Tokenized Search: through which users can accelerate search speed. This setting trades off search speed against precision, and will deliver more search results, with the best matches ranking highest in the resulting list. By default, Tokenized Search is set to ON.
- File Size: through which users can filter the search results based on the specified size range for the search targets
- Advanced Filter: through which users have access to some of the above mentioned filters all at one place in editable test format. Additionally, in the Advanced Filter, users can specify the Page Size and Wildcard for the search results
Where selectable options are available within these filters, users can use All and Clear options to select or deselect all the filter options. All filters have Apply options, which apply and run the search for the filtered results.
Global Search: Search Results
Search results are presented in a tabular format and include the following information:
- Number: the number of the found items for the search, including files, directories and snapshots
- Name: the names of the found items, i.e. files or directories names
- File Path: the paths of the found files or directories inside the file system
- DFS Path: the paths inside the Distributed File System, i.e. Target + File Path
- Folder: which indicates whether the found items are directories or not
- Target: which is the filer on which the directories that contain the found items are created
- Size: the sizes of the found items
- Last Modified: the timestamp on which the found items are last modified
- Created: the timestamp on which the found items are created
- Snapshots: the available snapshots that contain the found items
The search results table can be configured to display or hide columns through the Columns button on top of the results table. That includes all of its columns, except for the Name and Snapshot.
Audit, Recover and CloneFor any item in the search results, users can access the Actions dropdown menu for Recover & Clone file and Audit, as follows
- Audit: selecting the Audit options, takes users to the File Audit service, and presents the entire audit history of that target
- Recover & Clone file: selecting the Recover & Clone file option for a target initiates a recovery process based on the most recent snapshot of the target, and in case of unavailability of snapshot for the target, it initiates a cloning process for it
- When there are snapshots available for an item in the search results, users are able to click on the snapshot link, provided under the Snapshots column in the search results table, and see the information for the available snapshots in a popup window. From that window, users can select the snapshot they like, for Recover or Audit
- The search results could be Exported into downloadable files in CSV or Excel file formats for external use. The exports are scheduled tasks and exported files could be downloaded in the Data Service Scheduled Tasks page
- When there are more items in the search results than could fit into the search results page, users can request for more results by pressing Load More button below the search results table
The following picture shows the Snapshots windows, as the result of clicking on a snapshot link.