VX Search Rule-Based File Search
VX Search Rule-Based File Search
Flexense Ltd.
VX Search
Rule-Based File Search
User Manual
Version 3.4
Oct 2011
Flexense Ltd.
Product Overview
VX Search is an automated, rule-based file search solution capable of searching files by the file type, category, extension, file name, regular expressions, location, size, creation, modification and last access dates, user, file attributes, JPEG EXIF tags, etc. In addition, the user is provided with the ability to categorize and filter file search results, copy, move or delete search results, generate various types of pie and bars charts and save reports to a number of standard formats such as HTML, text, Excel CSV and XML.
Power computer users and IT administrators are provided with advanced search capabilities such as the ability to search files in multiple servers and/or NAS storage devices simultaneously, automatic report generation, SQL database integration and conditional notifications allowing one to send E-Mail notifications when a search operation finds a userspecified number of files.
Frequently used file search operations may be pre-configured, saved as user-defined search profiles and performed fully automatically using the VX Search GUI application or direct desktop shortcuts allowing one to execute search commands in a single mouse click. Finally, VX Search Ultimate provides a command line utility capable of executing user-defined search commands periodically using the Windows built-in task scheduler and enabling periodic generation of search reports and automatic E-Mail notifications.
Flexense Ltd.
The product installation procedure is very simple and does not require any third party software components. Just run the setup program, accept the end-user license, select the destination directory and wait about 10 seconds for the installation procedure to complete.
Product updates are released almost every month and if the computer where the product is installed on is connected to the Internet, select the 'Help - Check For Updates' menu item to update the installed product version. If the computer is not connected to the Internet, download the regular setup program for a new product version and just install it on the top of the currently installed product version and it will perform a proper update procedure.
Flexense Ltd.
For more advanced search capabilities, press the 'Advanced Search' button, add one or more file matching rules and select an appropriate logical operator. VX Search provides a large number of file matching rules capable of searching files by the file type, category, file name, extension, location, size, creation, modification and last access dates, user name, file attributes, JPEG EXIF tags, etc.
Once finished adding file matching rules, press the 'Search' button to start the search operation. The main VX Search GUI application shows file search results and allows one to categorize and filter results, export reports, generate pie and bars charts and much more.
Flexense Ltd.
All file categories are organized into a logical hierarchy with multiple subcategories, groups and file classes. Select a file classification plugin and browse the hierarchy of file categories to select an appropriate file type. For example, select the 'Images, Pictures and Graphic Files' category to find all types of images and picture files. This is especially useful when the user needs to find multiple types of files, but does not know all the required file extensions.
If the selected file category contains a number of subcategories, files related to any of the selected subcategories will be displayed in the search results. A number of file categories may be added using multiple file matching rules combined with a logical (AND, OR) operator. Finally, power computer users and IT administrators may design custom file classification plugins with user-specific file categories and hierarchies using a simple XML-based format and use these custom file categories in file search operations.
Flexense Ltd.
For example, VX Search allows one to find all pictures and images with the file size greater than X MB. The size-based file matching rule may be combined with other types of file matching rules allowing one to find files exactly matching user needs and requirements.
Flexense Ltd.
The relative time-based rules are useful when the user needs stable time periods not changing and keeping valid as the time passes on. A file matching rule searching files that were modified during the last 7 days is always valid disregarding of the current date.
Sometimes, when the user needs to find files that were created, modified or last accessed during very specific dates, relative time periods are not good. For these cases, VX Search provides absolute date-based file matching rules, which are allowing one to define exact dates or date ranges to search for.
Flexense Ltd.
The binary pattern file matching rule is very useful when the user needs to detect specific file formats containing format-specific signature patterns at designated positions. Multiple binary pattern rules may be combined with logical operators to detect files containing multiple patterns at different positions. The pattern should be specified as a string of HEX characters with two characters per byte delimited with the space character. The position should be specified as an absolute offset from the beginning of the file.
Flexense Ltd.
On the attributes select dialog, check all the attributes that should be tested and press the 'Ok' button. When the operator is set to 'Having Attributes', VX Search will search files having all the selected file attributes. Otherwise, VX Search will search files having none of the selected file attributes.
The negative operator is especially useful when the user needs to find all files related to a specific file category, but skip all protected system and hidden files. The attributes file matching rule may be combined with other types of file matching rules allowing one to precisely select the required files.
Flexense Ltd.
The entered text pattern is case insensitive and it may be matched exactly or at different places inside of the user name using different types of the text matching operator.
In order to search JPEG images by EXIF tags, select the 'Search JPEG Images With EXIF Tag' file matching rule, select the tag to be checked, select an appropriate text matching operator and enter a text or numeric value to search for.
10
Flexense Ltd.
In order to search files using a regular expression, select the 'File Name' file matching rule, select the 'RegEx' pattern matching operator and enter a regular expression that should be matched. For example, the '\.(JPG|BMP|PNG)$' regular expression will match all JPG, BMP and PNG image files.
Regular expressions may be combined with other types of file matching rules allowing one to match a very specific set of files. In addition to the ability to match files using regular expressions, VX Search allows one to exclude files using regular expressions. For example, in order to search all programs and executable files while excluding files located in the Windows directory, use the regular expression '^(?!C:\\WINDOWS)' applied to the 'Full Path' file matching rule.
11
Flexense Ltd.
On the nested rules dialog, add all the required file categories, select the 'OR' logical operator and press the 'OK' button. On the advanced search dialog, press the 'Add' button, add the time-based file matching rule to find files that were modified today and select the 'AND' logical operator.
The nested rule list will match all the required file categories, while the time-based top level file matching rule will select files that were modified today. VX Search provides a fully scalable rule-based model with an unlimited number of nested levels allowing one to define sophisticated multi-level file matching rules capable of precisely searching the required files. In addition, power computer users and IT administrators are provided with an XML-Based format allowing one to define custom file classifications plugins and complex search queries, which may executed using the VX Search command line utility. Finally, the command line utility may be used to execute automated periodic file search operations, generate reports, submit search results to an SQL database or issue E-Mail notifications when a search operation finds a user-specified number of files.
12
Flexense Ltd.
In addition to the statistics displayed in the file categories pane, VX Search allows one to generate various types of pie and bars charts. In order to show a chart for the currently displayed file categories, press the 'Charts' button located on the main toolbar.
The charts dialog shows the currently selected file categories and allows one to change the chart's title and footer, copy the chart's image to the clipboard or print the chart making it very simple to integrate VX Search charts into user's custom reports and documents.
13
Flexense Ltd.
Select one or more file categories in the bottom pane, press the right mouse button and select the 'Apply Filters' menu item. VX Search will filter the search results and show files matching the selected file categories.
Now, the user can export reports and/or perform file management operations, such as file copy, move or delete, on files matching the selected file categories. In order to clear the selected file categories press the 'Clear' button located on the right side of the categories progress bar.
14
Flexense Ltd.
On the file copy dialog, enter a destination directory and press the 'Start' button. The destination directory should be specified as an absolute location with a full path. The UNC notation for network shares is also supported.
In order to delete one or more files, select the required files in the search results view, press the right mouse button and select the 'Delete Files' menu item. For advanced delete options, such as data wiping capabilities, press the 'Advanced Options' button.
15
Flexense Ltd.
The amount of information exported per file depends on the selected file format. HTML, Text and Excel CSV reports provide basic information about each file, while the XML format and the VX Search native format export full information about all search results including the full file name, size, user name, creation, modification and last access times.
In addition, the VX Search native report format allows one to save search results for future analysis, load report files into the VX Search GUI application on another computer or export search results to a centralized SQL database.
16
Flexense Ltd.
Before exporting search results to an SQL database, the user needs to open the options dialog and configure an ODBC data source to use to connect to the database.
Once the database connection is configured and tested, press the 'Save' button located on the main toolbar, enter a report title, select the 'SQL Database' report format and press the 'Save' button. For each report in the database, VX Search shows the date and time of the search operation, the host name, the directories that were searched, the number of files and disk space and the report title. To load a previously saved report, just click on the report item.
17
Flexense Ltd.
VX Search will discover network shares available in the specified servers and show a network share list dialog allowing one to select the network shares that should be processed. In order to be able to use this feature, the user needs to have permissions to access network shares.
18
Flexense Ltd.
In order to be able to search files in network shares, the user needs to have directory access permissions. In addition, in order to perform file management operations, such as file copy, move or delete, on search results found in network shares, the user needs to have file write permissions.
In addition, if the search operation is performed on a multi-core/multi-CPU system, set the number of processing threads to the number of physical CPUs or CPU cores available in the computer system. The performance improvement may be especially significant when searching files in multiple physical disks or network shares using complex search queries.
19
Flexense Ltd.
On the search dialog, enter a file search wildcard and press the 'Search' button to start the search operation. Alternatively, press the 'Advanced Search' button and specify one or more file matching rules on the advanced search options dialog.
The last 10 file search operations performed through the Windows Explorer application are remembered in the locations and file wildcards history and the user is provided with the ability to select one of the previously entered locations or file wildcards using the history selection buttons located on the right side of the search dialog.
20
Flexense Ltd.
In order to enable the system tray icon, open the 'Options' dialog, select the 'General' tab and check the 'Minimize To System Tray' option. When this option is enabled, the VX Search main GUI application will be minimized to the system tray icon. To open the VX Search system tray menu, click the right mouse button over the system tray icon.
When a search operation is launched from the system tray menu, the VX Search GUI application will be restored from the system tray area and shown as the top level window displaying search results that were found.
21
Flexense Ltd.
In order to create a desktop shortcut for a user-defined search profile, select the required search profile, press the right mouse button and select the 'Create Desktop Shortcut' menu item. VX Search will create a desktop shortcut, which will be displayed on the Windows desktop with the VX Search icon and the selected search profile name. Click on a VX Search desktop shortcut to execute the associated search operation and display search results.
In addition, VX Search Ultimate and VX Search Server provide the user with the ability to automatically generate reports, export results to an SQL database or send E-Mail notifications when the search operation finds a user-specified number of files.
22
Flexense Ltd.
Directories added to the exclude list will be excluded recursively including all files and subdirectories. In order to remove a directory from the exclude list, select the required directory and press the 'Delete' button.
For example, let's assume that the user needs to exclude all pictures and image files from a search operation. In this case, the user needs to add the category file matching rule, set the rule to match all types of pictures and images and set the operator to 'Not Categorized As'. In this case all images and picture files will be excluded from search results. Similarly, by using other types of negative file matching rules the user can exclude files by the file name, size, location, file attributes, etc.
23
Flexense Ltd.
If the report file name is empty, VX Search will save report to the user's home directory with automatically generated file names containing the date and time of each report. If the specified action value is an existing directory, VX Search will save reports to the directory. Otherwise, the specified value will be used as the name of the report file and all reports will be saved to the same file overwriting the file with each new report.
24
Flexense Ltd.
In order to enable E-Mail notifications for a search operation, open the search profile dialog, select the 'Advanced' tab, enable conditional actions, set the number of file search results to trigger the action, select the 'E-Mail Notification' action type and enter an e-mail address to send notifications to.
E-Mail notifications will be send using the SMTP e-mail account configured in the options dialog. In order to configure the SMTP account, open the options dialog, select the 'E-Mail' tab, enter the host name or the IP address of the SMTP server, enter the TCP/IP port number, enter the name of the user account, password and the source E-Mail address that should be used by VX Search in E-Mail notifications.
25
Flexense Ltd.
Show Main Toolbar - Use this option to enable/disable the toolbar in the main VX Search GUI application. Automatically Check For Product Updates - Use this option to enable automatic check for product updates. If this option is enabled, VX Search will check for new product updates on each start and display the 'Update' link in the bottom-right corner of the status bar when a new product version will be available. Disable Failed Periodic Commands - This option applicable to VX Search Server only and it may be used to disable failed periodic search operations. Show Error Messages in System Tray - Use this option to enable/disable display of error messages in the system tray status area when the VX Search GUI application is minimized to the system tray icon. Show Scanning Access Denied Errors - Use this option to enable/disable display of access denied errors issued when VX Search is unable to search files in a disk or directory due to insufficient permissions. Abort Operation On Critical Errors - By default, VX Search tries to process as many disks and directories as possible while logging errors in the process log. Select this option to abort search and file management operations on the first critical error. Enable Manual Product Registration - Use this option to enable/disable manual product registration. Process System Files - Use this option to enable/disable processing of protected system files and directories. Process Directory Links and Junctions - Use this option to enable/disable processing of directory links and junctions. Minimize To System Tray - Enable this option to minimize the VX Search GUI application to the system tray icon. Start Minimized - Enable this option to start the VX Search GUI application minimized to the system tray icon.
26
Flexense Ltd.
The 'Shortcuts' tab allows one to customize keyboard shortcuts. In order to change a keyboard shortcut, click on the shortcut item in the list to open the keyboard shortcut dialog and press a new key sequence.
The 'Proxy' tab provides the ability to configure Internet access through an HTTP proxy. VX Search checks for product updates through the Internet and if the computer where the product is installed on is connected to the Internet through an HTTP proxy, the user may configure a custom HTTP proxy configuration.
By default, VX Search uses the host's default proxy configuration and the user needs to change these settings only if VX Search is unable to receive product updates.
27
Flexense Ltd.
The 'E-Mail' tab allows one to configure an SMTP account to use to send user-defined E-Mail notifications. These features are available in VX Search Ultimate and VX Search Server only. The SMTP account settings configured on this tab are applicable to both the VX Search GUI application and the VX Search command line utility.
The 'Database' tab provides the user with the ability to configure the ODBC database interface, which may be used to save file search reports to an SQL database. In order to configure the ODBC database interface, enter the ODBC data source name, user name and password to use to connect to the database.
The ODBC database interface configured on this tab is applicable to both the VX Search GUI application and the VX Search command line utility. SQL database export capabilities are available in VX Search Ultimate and VX Search Server only.
28
Flexense Ltd.
vxsearch -search <FileFilter> -dir <Directory 1> [ ... Directory X ] This command searches files in the specified directories, disks or network shares.
vxsearch -search -regex <Regular Expression> -dir <Directory 1> [ ... Directory X ] This command searches files using a regular expression.
vxsearch -search <FileFilter> -server <hostname1;hostname2;hostnameX> This command searches files in all network shares of the specified servers and/or NAS devices.
vxsearch -search <FileFilter> -network This command searches files in all detected servers and/or NAS devices on the network.
vxsearch -search <XML Search Rules File> -dir <Directory 1> [ ... Directory X ] This command searches files in the specified directories, disks or network shares.
vxsearch -execute <Profile Name> This command executes the specified file search profile.
vxsearch -execute <XML Command File Name> This command executes the specified XML search command file.
Parameters:
-dir <Directory> This parameter specifies an input directory, disk or a network share for the file search operation. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted.
-server <hostname1;hostname2;hostnameX> This parameters specifies one or more servers or NAS storage devices to search files in. The list of servers may be specified as a list of host name or IP addresses delimited by the semicolon (;) character.
29
Flexense Ltd.
Command Line Options: -save_html_report [ File Name ] This option saves an HTML file search report to the specified file. -save_text_report [ File Name ] This option saves a plain text file search report to the specified file. -save_csv_report [ File Name ] This option saves an Excel CSV file search report to the specified file. -save_xml_report [ File Name ] This option saves an XML file search report to the specified file. -save_report [ File Name ] This option saves a report in the VX Search native report format. -save_to_database This option saves file search results to an SQL database. -title <Report Title> This option sets the report title. -compress This option instructs to export a compressed report. -perf <FULL | MEDIUM | LOW> This parameter controls the speed of the file search operation. FULL - Full-speed file search MEDIUM - Medium-speed file search LOW - Low-speed file search -v Shows the product major version, minor version, revision and build date. -help This command shows the command line usage information.
30
Flexense Ltd.
In order to manually check that the currently installed product version is up-to-date, select menu 'Help - Check For Updates' on the main menu bar. The update manager will connect to the update server and check if there is a newer version of the product available for download. If there is a new product version available, the update dialog will show the version of the new product update and two buttons: the 'Release Notes' button and the 'Install' button. Press the 'Release Notes' button to see more information about what new features and bug-fixes contains this specific product version. Press the 'Install' button to download and install the new product version.
After pressing the 'Install' button, please wait while the update manager will download the new product version to the local disk. The update package will be downloaded to a temporary directory on the system drive and automatically deleted after the update manager will finish updating the product.
After download is completed, close all open VX Search applications and press the 'Ok' button when ready. If one or more VX Search applications will be open during the update, the operation will fail and the whole update process will need to be restarted from the beginning. After finishing the update process, VX Search will show a message box informing about the successfully completed operation.
31
Flexense Ltd.
After finishing the purchase process, wait for the following two e-mail messages: the first one with a receipt for your payment and the second one with an unlock key. If you will not receive your unlock key within 24 hours, please check your spam box for e-mail messages originating from [email protected] and if it is nor here contact our support team. After you will receive your unlock key, start the VX Search GUI application and press the 'Register' button located in the top-right corner of the window. On the register dialog, enter your name and the received unlock key and press the 'Register' button to finish the registration procedure.
Minimal System Configuration Supported Operating System 500 MHz or better CPU 256 MB of system memory 25 MB of free disk space
Recommended System Configuration Supported Operating System 2 GHz or better CPU 512 MB of system memory 25 MB of free disk space
32
Flexense Ltd.
33