VX Search Rule-Based File Search
VX Search Rule-Based File Search
Flexense Ltd.
VX Search
Rule-Based File Search
User Manual
Version 5.0
Mar 2013
Flexense Ltd.
1 2 3
Product Overview................................................................................................4 VX Search Product Versions ................................................................................5 Using Desktop Product Versions .........................................................................6 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 3.20 3.21 3.22 3.23 3.24 3.25 3.26 3.27 3.28 3.29 3.30 3.31 3.32 3.33 3.34 3.35 3.36 Product Installation Procedure .............................................................................6 Searching Files in Disks or Directories...................................................................7 Searching Files by Category.................................................................................8 Searching Files by Name .....................................................................................9 Searching Files by Size .......................................................................................9 Searching Files by Date..................................................................................... 10 Searching Files by Text Patterns......................................................................... 11 Searching Files by Binary Patterns...................................................................... 11 Searching Files by File Attributes........................................................................ 12 Searching Files by User ..................................................................................... 13 Searching JPEG images by EXIF tags .................................................................. 13 Searching Files Using Regular Expressions........................................................... 14 Using Multi-Level File Search Rules ..................................................................... 15 Showing Categories and Statistics Charts ............................................................ 16 Filtering Search Results by Category................................................................... 17 Performing File Management Operations ............................................................. 18 Saving File Search Reports ................................................................................ 19 Exporting PDF Reports ...................................................................................... 20 Exporting Search Results to an SQL Database ...................................................... 21 Multi-Threaded File Search ................................................................................ 22 Searching Network Shares Using UNC Path Names ............................................... 22 Searching Files in One or More Servers ............................................................... 23 Searching Files in All Servers on the Network....................................................... 24 Windows Shell Integration ................................................................................. 25 Using the System Tray Icon............................................................................... 26 Using VX Search Desktop Shortcuts .................................................................... 27 Advanced File Search Options ............................................................................ 27 Excluding Subdirectories from File Search ........................................................... 28 Excluding Specific Files from File Search.............................................................. 28 Automatic Report Generation ............................................................................. 29 Sending E-Mail Notifications............................................................................... 30 Sound Notifications........................................................................................... 31 Customizing VX Search GUI application............................................................... 32 Using VX Search Command Line Utility................................................................ 35 Product Update Procedure ................................................................................. 37 Product Registration Procedure .......................................................................... 38
Using Server Product Version............................................................................39 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10 4.11 4.12 4.13 4.14 4.15 4.16 4.17 4.18 4.19 4.20 VX Search Server Overview ............................................................................... 39 Product Installation Procedure ........................................................................... 40 Initial Product Configuration .............................................................................. 41 Quick File Search Operations ............................................................................. 42 Managing File Search Commands ....................................................................... 43 Searching Files by Category............................................................................... 44 Searching Files by Name ................................................................................... 45 Searching Files by Size ..................................................................................... 45 Searching Files by Date..................................................................................... 46 Searching Files by Text Strings .......................................................................... 47 Searching Files by Binary Patterns...................................................................... 47 Searching Files by File Attributes........................................................................ 48 Searching Files by User ..................................................................................... 49 Searching JPEG images by EXIF tags .................................................................. 49 Searching Files Using Regular Expressions........................................................... 50 Using Multi-Level File Search Rules ..................................................................... 51 Reviewing File Search Results ............................................................................ 52 File Search Reports........................................................................................... 54 Automatic File Search Actions ............................................................................ 56 Periodic File Search Operations .......................................................................... 57
Flexense Ltd.
4.21 4.22 4.23 4.24 4.25 4.26 4.27 4.28 5 5.1 5.2 5.3 5.4 5.5 5.6
Searching Files in Network Shares ...................................................................... 58 Configuring VX Search Server ............................................................................ 59 Configuring Custom User Name and Password ..................................................... 59 Configuring Custom Server Ports........................................................................ 60 Configuring E-Mail Notifications .......................................................................... 60 Configuring SQL Database Integration ................................................................ 61 Updating VX Search Server................................................................................ 62 Registering VX Search Server ............................................................................ 63
Appendix...........................................................................................................64 Installing MySQL Database ................................................................................ 64 Configuring MySQL Database ............................................................................. 69 Configuring MySQL ODBC Data Source................................................................ 70 Configuring VX Search Database Connection........................................................ 71 Supported Operating Systems............................................................................ 72 System Requirements ....................................................................................... 72
Flexense Ltd.
1 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.
Flexense Ltd.
All versions of VX Search may be freely downloaded from the http://www.vxsearch.com web site. The free product version does not contain any malware, spyware or any other harmful software components and it may be used for any personal or commercial purposes. Paid product versions are available for a free 30-days trial.
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.
3.2
VX Search provides multiple ways to search files ranging from simple file name wildcards to complex sets of multi-level file matching rules capable of searching files using multiple criteria combined with logical operators. In the simplest, case press the 'Search' button located on the main toolbar, enter a file name wildcard and one or more disks or directories to search in.
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.
3.3
One of the most powerful capabilities of VX Search is the ability to search files by the file type or category using an extensive set of file classification plugins capable of recognizing more than 2500 types of files. In order to search files related to a category, select the 'Search Files Categorized As' file matching rule and press the 'Select' button to select an appropriate file category.
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.
3.4
VX Search allows one to search files by the file name, location, extension, full file name including the full path, the name of the directory without the path and file name and the file name without extension. There are a number of positive and negative pattern matching operators providing the user with the ability to match text patterns located at different places of the file name and allowing one to define precise file matching rules.
3.5
The user is provided with the ability to search files by the file size using multiple comparison operators and size units. This file matching rule is very useful when combined with file categories to search files matching multiple different criteria.
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.
3.6
VX Search provides two sets of file matching rules allowing one to search files by the creation, modification and last access dates. The fist set of time-based file matching rules works with relative time periods and provides the ability to find files that were created, modified or last accessed during X days, weeks, months or years.
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.
10
Flexense Ltd.
3.7
VX Search provides a file matching rule capable of searching files containing or not containing a user-specified text pattern. In order to match files by a text pattern, select the 'Search Files Containing Text' file matching rule, select an appropriate text matching operator and enter a text pattern to search for.
3.8
Power computer users and IT administrators are provided with a binary pattern file matching rule, which is capable of searching files by binary patterns located at specific places inside of files. In order to add a binary file matching rule, select the 'Search Files Containing HEX Pattern' rule, select an appropriate pattern matching operator, enter the HEX pattern to search for and enter the position inside of the file where the binary pattern should be found at.
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.
11
Flexense Ltd.
3.9
Sometimes, it may be required to search files by file attributes. For these purposes, VX Search provides the file attributes file matching rule. Select the 'Search Files With the File Attributes' file matching rule, select an appropriate attribute matching operator and press the 'Select' button to select the attributes to be checked.
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.
12
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.
13
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.
14
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.
15
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.
16
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.
17
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.
18
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.
19
Flexense Ltd.
In order to export a PDF report, search files in one or more disks, directories or network shares and press the 'Save' button located on the main toolbar. On the save report dialog, select the PDF report format, enter a report title, enter the name of the file to save the report to. By default, VX Search exports the top 10,000 search results. In order to export a full report, which may result in a very long PDF document, just enter an appropriate number of search results to export.
20
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.
21
Flexense Ltd.
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.
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.
22
Flexense Ltd.
VX Search will scan the network and show a list of network shares detected in the specified servers and NAS storage devices allowing one to select one or more 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.
The network shares scanning operation may be performed multiple times for different servers and NAS storage devices and an unlimited number of network shares from different servers may be added to the file search operation. During runtime, VX Search will process all the specified network shares in parallel using all CPUs and/or CPU-cores available in the host computer VX Search is running on.
23
Flexense Ltd.
VX Search will scan the network and show a list of servers and NAS storage devices detected on the network. Select one or more servers to search in and press the 'Ok' button.
VX Search will scan the selected servers and show a list of network shares detected in the servers and NAS storage devices allowing one to select one or more network shares that should be processed. During runtime, VX Search will process the selected network shares in parallel using all CPUs available in the host computer VX Search is running on. In order to be able to use this feature, the user needs to have permissions to access network shares.
24
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.
25
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.
26
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.
27
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.
28
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.
29
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.
30
Flexense Ltd.
In order to open the 'Notification Sounds' dialog, select the 'Tools - Notification Sounds' menu item. The 'Notifications Sounds' dialog shows all the available sound notifications and allows one to enable or disable specific sound notifications.
In order to select a custom notification sound file, click on a notification sound item in the sounds list and select a custom WAV file. In order to play a notification sound, select the required notification sound in the sounds list and press the 'Play' button.
31
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.
32
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.
33
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.
34
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.
35
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_pdf_report [ File Name ] This option saves a PDF 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.
36
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.
37
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.
38
Flexense Ltd.
VX Search Server is a rule-based file search server, which runs in the background as a service and provides a web-based GUI interface allowing one to connect to the server using a regular web browser and search files in one or more directories, disks, network shares or NAS storage devices by the file name, regular expressions, size, file type, attributes, user name, creation, last modification or last access dates, text and binary patterns, JPEG EXIF tags, etc.
VX Search Server allows one to configure an unlimited number of files search operations, with each one capable of searching files using an extensive set of file matching rules combined with logical operators. Power users are provided with the ability to combine multiple types of rules into hierarchical file search queries capable of precisely searching required types or groups of files. For example, VX Search Server allows one to search for all types of documents with the file size more than X MB that were modified during the last Y months.
The user is provided with the ability to review file search results, generate HTML, PDF, text, CSV, XML reports or export reports from multiple servers to a centralized SQL database for future review and analysis. In addition, VX Search Server provides the ability to schedule periodic file search operations according to user-defined time intervals, automatically generate reports and/or send E-Mail notifications when a file search operation finds a user-specified number of search results.
39
Flexense Ltd.
4.2
VX Search Server is especially designed to be as simple as possible. The product does not require any third-party software applications and may be installed and configured within a couple of minutes. A fully functional 30-days trial version of VX Search Server may be downloaded from the following page: http://www.vxsearch.com/downloads.html.
The installation package is very small, 2MB - 3MB depending on the target operating system, and the product requires just 10MB of the free disk space on the target server. In order to install VX Search Server, start the setup program, select a destination directory and press the 'Next' button.
Optionally, enter custom server control and/or web access ports. The server control port is used by the VX Search command line utility and the web access port is the port for the webbased management interface allowing one to control VX Search Server using a standard web browser. If VX Search Server should be controlled remotely through the network, make sure one or both of these ports are open in the server's firewall.
40
Flexense Ltd.
4.3
After finishing the installation procedure, open a regular web browser and login to the VX Search Server web-based management interface using the default (admin/admin) user name and password. The VX Search Server home page allows one to configure file search operations review results, generate reports and schedule periodic file search jobs.
In order to add a new file search command, press the 'Add Command' button, specify a unique command name, enter one or more disks, directories or network shares to search files in and add one or more file search rules. Once finished configuring the file search command, press the 'Save' button.
In order to execute a file search command manually, just click on the command's 'Start' button located in the 'Tools' column. In order to schedule the file search command to be executed periodically at specific time intervals, press the 'Periodic Jobs' button located on the VX Search Server home page and setup a periodic search job.
41
Flexense Ltd.
4.4
VX Search Server provides the following two file search modes: the quick file search mode, which is an easy to use mode for simple search operations, and the search commands mode, which provides the ability to pre-configure a number of file search commands based on one or more file matching rules and allowing one to control an extensive set of file search options.
In order to simple search files using the quick file search mode, press the 'Search' button located on the VX Search Server home page, select a file search criteria and specify disks, directories or network shares to search in.
In the quick file search mode, VX Search Server will automatically create a file search command according to the selected file search criteria, search files in the specified disks and directories and display search results. Each quick file search command is saved in the product configuration file, displayed on the VX Search Server home page and may be later executed again or customized to display different sets of files.
42
Flexense Ltd.
4.5
VX Search Server allows one to configure multiple file search operations with each one capable of searching files in a number of disks, directories, network shares or NAS storage devices. In order to add a new command, press the 'Add Command' button located on the VX Search Server home page, specify a unique command name, enter one or more disks, directories or network shares to search in, add one or more file search rules and press the 'Save' button.
Each file search operation may be configured to search files using an extensive set of file search rules combined with logical operators. Advanced users are provided with the ability to define multi-level, hierarchical file search queries capable of precisely selecting required files by the file name, regular expressions, file type, file size, user name, attributes, creation, last modification or last access dates, text or binary patterns, JPEG EXIF tags, etc.
In addition, the user is provided with the ability to exclude one or more directories from the files search process, set a custom report title, control the maximum number of search results for each file search operation, set the number of history reports to save for each file search operation and configure file search operations to intentionally slow down the file search process in order to minimize the performance impact on running production servers.
43
Flexense Ltd.
4.6
One of the most powerful capabilities of VX Search Server is the ability to search file type or category using an extensive set of file classification plugins capable of more than 2500 types of files. In order to search files related to a category, select Files Categorized As' file matching rule and press the 'Select' button to select an file category.
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.
44
Flexense Ltd.
4.7
VX Search allows one to search files by the file name, location, extension, full file name including the full path, the name of the directory without the path and file name and the file name without extension. There are a number of positive and negative pattern matching operators providing the user with the ability to match text patterns located at different places of the file name and allowing one to define precise file matching rules.
4.8
The user is provided with the ability to search files by the file size using multiple comparison operators and size units. This file matching rule is very useful when combined with file categories to search files matching multiple different criteria.
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.
45
Flexense Ltd.
4.9
VX Search provides two sets of file matching rules allowing one to search files by the creation, modification and last access dates. The fist set of time-based file matching rules works with relative time periods and provides the ability to find files that were created, modified or last accessed during X days, weeks, months or years.
The relative time-based rules are useful when the user needs stable time periods not changing and keeping valid as the time passes on. For example, 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.
46
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 by the space character. The position should be specified as an absolute offset from the beginning of the file.
47
Flexense Ltd.
On the attributes select page, check all the attributes that should be tested and press the 'Save' button. When the operator is set to 'Having Attributes', VX Search Server will search files having all the selected file attributes. Otherwise, VX Search Server 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.
48
Flexense Ltd.
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.
49
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 Server 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.
50
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 search command page, press the 'Add Rule' button, add the time-based file matching rule to find files that were last accessed more than 3 years ago, add a rule to match files with the file size more than 10 MB 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 last accessed more than 3 years ago. VX Search Server 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.
51
Flexense Ltd.
One of the most powerful capabilities of VX Search Server is the ability to categorize file search results by the file extension, file type, size, user name, creation, last modification or last access dates and filter displayed file search results by one or more file categories.
52
Flexense Ltd.
In order to filter search results, select one or more file filters and press the 'Set Filter' button. When one or more file filters are selected, saved file search reports will include search results matching the selected file filters. In order to reset the selected file filters, press the 'Clear Filter' button.
In order to see extended information for a search result, click on the result name located on the left side of the results page. VX Search Server allows one to save HTML, PDF, text, Excel CSV or XML reports. In order to export a report, press the 'Save' button located in the topright corner of the results page and select an appropriate report format.
In addition, file search reports may be generated automatically using one or more file search actions allowing one to automatically save reports when a file search operation finds a userspecified number of search results. Finally, VX Search Server provides the ability to send HTML, text and PDF reports as E-Mail notifications when a file search operation finds a userspecified number of search results.
53
Flexense Ltd.
VX Search Server allows one to filter file search reports by the search command name, host name, date and input directories. In order to filter search reports, select an appropriate filter located on the bottom side of the reports page and then select a filter value.
54
Flexense Ltd.
When a report filter is active, VX Search Server displays the number of filtered reports in the reports page caption and shows reports matching the selected report filter in the reports view. In order to reset the currently selected report filter, select the 'Show All' filter value in the report filer located on the bottom side of the reports page.
By default, VX Search Server keeps a history of 10 last reports for each file search command. In order to open a file search report listed in the reports view, click on the required report ID link. Reports are saved in the reports directory, which may be configured on the 'Advanced Server Options' page.
In addition, the user is provided with the ability to control the number of history reports saved in the reports directory. Finally, if VX Search Server is configured to save reports to an SQL database, the user can set the number of history reports to keep in the SQL database.
55
Flexense Ltd.
In order to add a new action, press the 'Add Action' button, enter the number of search results to trigger the action, select an appropriate action type and press the 'Save' button. For E-Mail notification actions, the action value should be set to an E-Mail address to send the notification to. In addition, the user needs open the 'Settings' page and configure an SMTP server to use to send E-Mail notifications.
For report generation actions, the action value should be set to a file name or a directory name where to save file search reports. If the action value is set to an existing directory, VX Search Server will automatically generate file names with the report date and time added to each report file name. For the custom command action, the action value should be set to the command (including all command line arguments) to be executed.
56
Flexense Ltd.
On the periodic job page, enter a unique periodic job name, specify the time interval and select one or more file search commands to execute. In order to reduce the CPU load and memory usage on the host, VX Server performs selected file search operations sequentially, one after one while saving reports and executing automatic file search actions if required.
In addition, the user is provided with the ability to intentionally slow down file search operations, in order to completely eliminate performance impact on production servers. In order to slow down a file search command, open the command page, press the 'Options' button, select the 'Low Speed' performance mode and press the 'Save' button.
57
Flexense Ltd.
The configuration is very simple and may be performed within a couple of seconds using the following step-by-step guide: 1. 2. 3. 4. 5. Open the Windows control panel and click on the 'Administrative Tools' utility. Open the Services control center and find here the ' VX Search Server' service. Open the ' VX Search Server' service, select the 'General' tab and stop the service. Select the 'Log On' tab and specify a user account to use for the service. Select the 'General' tab and start the ' VX Search Server' service.
Now, the VX Search service will run under the specified user account and will have exactly the same permissions as the specified user account when accessing network shares and NAS storage devices.
58
Flexense Ltd.
In order to set a custom user name and password, click on the 'Configure Server Login' link located on the main settings page, enter a new user name and password and press the 'Save' button.
59
Flexense Ltd.
In order to set a custom server control port and/or web access port, click on the 'Setup Server Ports' link located on the main settings page, select the 'Use Custom Port' option and enter a custom port number to use. If the VX Search server should be controlled through the network, make sure the custom ports are open in the server's firewall.
60
Flexense Ltd.
VX Search Server exports SQL database reports through the ODBC database interface, which should be configured to operate properly. In order to configure the ODBC database interface, click on the 'Configure SQL Database' link located on the main settings page, enable the ODBC database interface, specify the ODBC data source, ODBC user name and password to use to save reports to the SQL database.
61
Flexense Ltd.
Due to the fact that the product is especially designed for servers running in production environments where stability is a major decision factor, VX Search Server updates should be manually installed by the user. In order to update an existing product installation, download the latest product version and just start the setup program.
The VX Search Server setup program update the product and restart the VX product configuration files, configured registration will remain valid and there
will properly shutdown the running VX Search service, Search service after finishing the update procedure. All file search commands, file search reports and product is nothing to reconfigure or manage after the update.
62
Flexense Ltd.
If the computer where VX Search Server is installed on is connected to the Internet, login to the VX Search server (default user name and password: admin/admin) using a standard web browser, click on the 'About' link located on the top menu bar, press the 'Register' button, enter your name or your company name, enter the received unlock key and press the 'Register' button.
If the computer is not connected to the Internet, press the 'Manual Registration' button, export the product ID file and send the product ID file to [email protected] as an attachment. Within a couple of hours, you will receive an unlock file, which should be imported in order to finish the registration procedure.
63
Flexense Ltd.
5 Appendix
5.1 Installing MySQL Database
VX Search Server is capable of saving reports in an SQL database. Reports may be saved manually or automatically using one or more file search actions and periodic file search jobs. In order to configure VX Search to use the MySQL database, the user needs to install the following two components: the MySQL Server and the MySQL ODBC connector. First of all, lets install the MySQL Server. Download the latest version of the MySQL server from the MySQL web site and execute the setup program to start the installation procedure. On the setup type page, select the Typical setup type and press the Next button. By default, the setup will install the MySQL server and a command line utility, which will be used to configure the MySQL server.
On the next setup page, select the Configure the MySQL Server now option and press the Finish button. The setup program will open a MySQL configuration wizard allowing one to configure basic server settings.
64
Flexense Ltd.
On the next setup page, select the Detailed Configuration option and press the Next button. The detailed configuration mode is required to configure the MySQL server for maximum database performance.
On the next page, select the Server Machine option, which is the most balanced configuration for typical VX Search Server workloads. If the server is intended to process large volumes of reports and is dedicated for VX Search, select the Dedicated Server configuration option.
65
Flexense Ltd.
On the next page, select the Non-Transactional Database option. VX Search does not perform concurrent insert or modify operations on the database and a transactional database is not required. Moreover, configuring the MySQL server as a non-transactional database will significantly improve the performance of database import operations.
On the next page, select the Manual Setting option and set the number of concurrent database connections to 5, which is the optimal number for typical VX Search installations.
66
Flexense Ltd.
On the next page, enable TCP/IP networking and if the server will be accessed from other computers on the network, add a firewall exception for the MySQL server port. In general, a single MySQL server may be used to collect reports from multiple VX Search installations using remote ODBC connections.
On the next page select an appropriate character set. By default, VX Search uses the UTF-8 character set to store names of files and directories, but if there is no need to process Unicode file names, this option may be set to the standard Latin1 character set.
67
Flexense Ltd.
On the next page, select the Install as Windows Service option and select the Include Bin Directory in Windows PATH option. The PATH option will enable execution of the MySQL command line utility from any location.
On the next page, select the Modify Security Settings option and specify a root password for the MySQL server, which later will be used to configure regular MySQL users.
Thats all. Press the Next button to finish the installation procedure.
68
Flexense Ltd.
5.2
The MySQL database provides the mysql command line utility, which may be used to configure the database and the user account to be used by VX Search.
In order to configure the MySQL database, open the command prompt window and type the following command: mysql u root p This command will start the mysql command line utility and login to the MySQL server with root permissions. The user will be asked to provide the root password, which was specified during the MySQL server installation procedure. Once logged in, the user needs to create a database that will be used by VX Search to store reports. In order to do that, type the following command:
Now, add a user account that will be used by VX Search to submit reports to the database. Single quotes are required and should be specified exactly as displayed.
Now, grant permissions to the user account using the following command:
flush privileges;
Thats all. Now the MySQL server is fully configured. In order to disconnect from the MySQL database, just type quit in the command window.
69
Flexense Ltd.
5.3
VX Search connects to the MySQL database through the ODBC interface. Download an appropriate version of the MySQL ODBC connector from the MySQL web site and execute the setup program. There are no critical configuration options in the MySQL ODBC connector installation procedure and the user can just press the Next button until the last page keeping the default configuration options.
After finished installing MySQL ODBC Connector, open the Windows control panel and select Administrative Tools Data Sources (ODBC). On the ODBC Administrator window, select the System DSN tab and press the Add button. On the next page, select the MySQL ODBC Driver and press the Finish button.
70
Flexense Ltd.
On the next page, enter a new data source name, which will be used by VX Search to connect to the database. Specify the name of the host where the MySQL server is running on and enter the MySQL user name and password that should be used by VX Search to connect to the database. Finally, select the name of the database that should be used to store reports. After finished specifying all the required information, press the Test button to check the database connection.
5.4
In order to configure VX Search to use the installed MySQL database, open the main settings page and click the 'Database' link. Enable the ODBC interface and enter the name of the ODBC data source, the database user name and password that were specified for the ODBC data source. Finally, press the Save button to check the VX Search database connection.
71
Flexense Ltd.
5.5
32-Bit Operating Systems Windows Windows Windows Windows Windows Windows Windows Windows 2000 XP Vista 7 8 Server 2003 Server 2008 Server 2012
64-Bit Operating Systems Windows Windows Windows Windows Windows Windows Windows XP 64-Bit Vista 64-Bit 7 64-Bit 8 64-Bit Server 2003 64-Bit Server 2008 64-Bit Server 2012 64-Bit
5.6
System Requirements
Minimal System Configuration Supported Operating System 1 GHz or better CPU 1 GB of system memory 25 MB of free disk space
Recommended System Configuration Supported Operating System 2+ GHz dual-core or quad-core CPU 2 GB of system memory 25 MB of free disk space
72