DiskBoss User Manual

Flexense Ltd.

DiskBoss
File & Disk Manager

User Manual

Version 1.6
Sep 2011

Flexense Ltd. www.flexense.com info@flexense.com

1

DiskBoss User Manual

Flexense Ltd.

1

Product Overview................................................................................................5 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 1.10 1.11 1.12 1.13 1.14 1.15 Disk Space Utilization Analysis .............................................................................6 File Classification and Categorization ....................................................................7 Duplicate Files Finder..........................................................................................8 Rule-Based File Organizing ..................................................................................9 Rule-Based File Search...................................................................................... 10 Real-Time Disk Change Monitor.......................................................................... 11 High-Speed File Synchronization ........................................................................ 12 Fault-Tolerant File Copy and Data Migration......................................................... 13 User-Defined Commands................................................................................... 14 SQL Database Integration ................................................................................. 15 Advanced Disk Space Analysis Capabilities .......................................................... 16 DiskBoss Server ............................................................................................... 18 Command Line Tools ........................................................................................ 18 DiskBoss Server SDK and Programming API ........................................................ 19 Product Versions .............................................................................................. 20

2 2.1 2.2 2.3 3

Product Installation ..........................................................................................21 Downloading DiskBoss ...................................................................................... 21 Product Installation Procedure ........................................................................... 21 Product Update Procedure ................................................................................. 22 Disk Space Utilization Analysis .........................................................................23 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 Analyzing One or More Disks or Directories.......................................................... 23 Using File Filters and Categories......................................................................... 24 Using Disk Space Usage Pie Charts ..................................................................... 25 Using File Management Commands..................................................................... 26 Saving Disk Space Analysis Reports.................................................................... 27 Exporting Reports to an SQL Database................................................................ 28 Analyzing Specific File Types or Categories .......................................................... 31 Multi-Level Disk Space Utilization Analysis ........................................................... 32 Using Disk Space Analysis Conditions and Actions ................................................ 33 Advanced Disk Space Analysis Options................................................................ 34 User-Defined Disk Space Analysis Commands ...................................................... 34 Analyzing Disk Space Using the DiskBoss Command Line Utility ............................. 35

4

File Classification ..............................................................................................36 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 4.10 4.11 4.12 Classifying One or More Disks or Directories ........................................................ 36 Using File Filters and File Categories ................................................................... 37 Using File Classification Pie Charts ...................................................................... 38 Saving File Classification Reports........................................................................ 39 Submitting Reports to an SQL Database.............................................................. 40 Classifying Specific File Types and Categories ...................................................... 43 Multi-Level File Classification and Analysis ........................................................... 44 Automatic File Organizing Operations.................................................................. 45 File Classification Plugins ................................................................................... 46 Advanced File Classification Options.................................................................... 47 User-Defined File Classification Commands .......................................................... 47 Classifying Files Using the DiskBoss Command Line Utility ..................................... 48

5

Duplicate Files Finder........................................................................................49 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12 Detecting Duplicates in a Disk or Directory .......................................................... 49 Selecting Duplicate Files Removal Actions............................................................ 50 Executing Duplicate Files Removal Actions........................................................... 50 Using File Filters and Categories......................................................................... 51 Showing Duplicate Files Pie Charts ..................................................................... 52 Saving Duplicate Files Reports ........................................................................... 53 Exporting Reports to an SQL Database................................................................ 54 Detecting Duplicates in Specific File Types........................................................... 57 Advanced Duplicate Files Detection Options ......................................................... 57 Using Automatic Duplicate Files Removal Actions.................................................. 58 User-Defined Duplicate Files Detection Commands ............................................... 59 Detecting Duplicate Files Using the DiskBoss Command Line Utility ........................ 60

2

DiskBoss User Manual

Flexense Ltd.

6

Rule-Based File Organizing ...............................................................................61 6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 6.11 6.12 Organizing Files in a Disk or Directory................................................................. 61 Defining File Organizing Commands.................................................................... 62 Using File Matching Rules .................................................................................. 63 Selecting File Organizing Actions ........................................................................ 64 Organizing Files with Preview............................................................................. 64 Organizing Files without Preview ........................................................................ 65 User-Defined File Organizing Commands ............................................................. 65 Drag-and-Drop Files into a File Organizing Command ........................................... 66 Periodic Execution of File Organizing Commands .................................................. 66 Automatic Execution of File Organizing Commands ............................................... 67 Organizing Files Using the DiskBoss Command Line Utility..................................... 67 Automatic, Rule-Based File Organizing Using DiskBoss Server................................ 68

7

Rule-Based File Search......................................................................................69 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 7.9 7.10 7.11 7.12 7.13 7.14 7.15 7.16 7.17 7.18 7.19 Searching Files Using File Matching Rules ............................................................ 69 Searching Files by Category............................................................................... 70 Searching Files by File Name ............................................................................. 71 Searching Files by File Extension ........................................................................ 71 Searching Files by File Path ............................................................................... 72 Searching Files by Access, Modification and Creation Dates ................................... 72 Searching Files by Relative Time Periods ............................................................. 72 Searching Files by Text Patterns......................................................................... 73 Searching Files by Binary Patterns...................................................................... 73 Searching Files by File Size................................................................................ 74 Searching Files by File Attributes........................................................................ 74 Searching Files by User Name ............................................................................ 75 Searching JPEG Images by EXIF Tags ................................................................. 75 Searching Files by Name and Path Length ........................................................... 76 Using Hierarchical File Matching Rules................................................................. 76 Conditional File Search Actions, Commands and Notifications................................. 77 Advanced File Search Options ............................................................................ 78 User-Defined File Search Commands .................................................................. 78 Searching Files Using the DiskBoss Command Line Utility ...................................... 79

8

Real-Time Disk Change Monitor ........................................................................80 8.1 8.2 8.3 8.4 8.5 8.6 8.7 8.8 8.9 8.10 8.11 8.12 Monitoring Changes in a Disk or Directory ........................................................... 80 Using Change Filters and Categories ................................................................... 81 Saving Disk Change Monitoring Reports .............................................................. 82 Exporting Reports to an SQL Database................................................................ 83 Monitoring Specific File Types or Categories......................................................... 84 Disk Change Monitoring Actions and E-Mail Notifications ....................................... 84 Selecting File System Events to Monitor .............................................................. 85 Customizing Disk Change Monitor View ............................................................... 85 Triggering Custom File Management Operations ................................................... 86 User-Defined Disk Change Monitoring Commands................................................. 86 Monitoring Disks Using the DiskBoss Command Line Utility.................................... 87 DiskPulse – Dedicated Disk Change Monitoring Solution ........................................ 88

9

High-Speed File Synchronization.......................................................................89 9.1 9.2 9.3 9.4 9.5 9.6 9.7 9.8 9.9 9.10 9.11 9.12 Synchronizing a Pair of Directories ..................................................................... 89 Selecting File Synchronization Mode ................................................................... 90 Synchronizing Files with Preview ........................................................................ 91 Synchronizing Files without Preview.................................................................... 91 Synchronizing Specific File Types or Categories.................................................... 92 Excluding One or More Subdirectories ................................................................. 92 File Synchronization Performance Tuning Options ................................................. 93 User-Defined File Synchronization Commands...................................................... 93 Periodic File Synchronization.............................................................................. 94 Real-Time File Synchronization .......................................................................... 94 Synchronizing Files Using the DiskBoss Command Line Utility ................................ 95 SyncBreeze – Dedicated File Synchronization Solution .......................................... 97

3

DiskBoss User Manual

Flexense Ltd.

10

Fault-Tolerant File Copy and Data Migration .....................................................98 Copying Files Using DiskBoss GUI Application ...................................................... 98 Copying Specific File Types or Categories ............................................................ 99 Advanced File Copy and Data Migration Options ................................................. 100 Copying Files Using the DiskBoss Command Line Utility....................................... 101

10.1 10.2 10.3 10.4 11

File Delete and Data Wiping Operations ..........................................................103 Deleting Files Using DiskBoss GUI application .................................................... 103 Advanced File Delete and Data Wiping Options................................................... 104 Deleting Specific File Types or Categories.......................................................... 104 Deleting Files Using the DiskBoss Command Line Utility ...................................... 105

11.1 11.2 11.3 11.4 12

DiskBoss GUI Application ................................................................................106 File Management and Navigation ...................................................................... 106 DiskBoss GUI Layouts ..................................................................................... 107 User-Defined Commands................................................................................. 108 Task Management .......................................................................................... 111 Built-In Disk Cleaner....................................................................................... 112 User-Selectable Tool Panes.............................................................................. 112 DiskBoss Options............................................................................................ 114 Registering Product ........................................................................................ 118

12.1 12.2 12.3 12.4 12.5 12.6 12.7 12.8 13

XML-Based Format ..........................................................................................119 Overview....................................................................................................... 119 Rules List ...................................................................................................... 119 Nested Rules ................................................................................................. 119 File Matching Rules......................................................................................... 120
File Extension ....................................................................................................... 120 File Name and Path ............................................................................................... 121 File Size ............................................................................................................... 122 File Time .............................................................................................................. 123 File Date .............................................................................................................. 124 Text Patterns........................................................................................................ 125 Binary Patterns ..................................................................................................... 126 File Category ........................................................................................................ 127 JPEG EXIF Tags..................................................................................................... 128 Windows File Attributes ..................................................................................... 129 UNIX File Permissions........................................................................................ 130 User Name ....................................................................................................... 131 Overview ............................................................................................................. 132 Structure ............................................................................................................. 132 Plugin Info ........................................................................................................... 133 Class List ............................................................................................................. 133 Class Definition ..................................................................................................... 134 Nested Rules ........................................................................................................ 134 Class Groups ........................................................................................................ 135 Nested Groups ...................................................................................................... 135 Example File Classification Plugin ............................................................................ 136 File Search ........................................................................................................... 138 File Classification................................................................................................... 141 Storage Utilization Analysis .................................................................................... 143 Duplicate Files Search............................................................................................ 146 File Synchronization .............................................................................................. 149 File Organizing...................................................................................................... 151 File Copy.............................................................................................................. 154 File Delete............................................................................................................ 156 Disk Monitoring..................................................................................................... 158

13.1 13.2 13.3 13.4

13.4.1 13.4.2 13.4.3 13.4.4 13.4.5 13.4.6 13.4.7 13.4.8 13.4.9 13.4.10 13.4.11 13.4.12 13.5.1 13.5.2 13.5.3 13.5.4 13.5.5 13.5.6 13.5.7 13.5.8 13.5.9 13.6.1 13.6.2 13.6.3 13.6.4 13.6.5 13.6.6 13.6.7 13.6.8 13.6.9

13.5 File Classification Plugins ................................................................................. 132

13.6 User-Defined Commands................................................................................. 137

14

Appendix.........................................................................................................160

14.1 Supported Operating Systems.......................................................................... 160 14.2 System Requirements ..................................................................................... 160 14.3 Default Keyboard Shortcuts ............................................................................. 161

4

DiskBoss User Manual

Flexense Ltd.

1 Product Overview
DiskBoss is an automated, rule-based file and disk manager allowing one to search and classify files, perform disk space utilization analysis, detect and remove duplicate files, organize files according to user-defined rules and policies, copy large amounts of files in a fault-tolerant way, synchronize disks and directories, cleanup wasted disk space, etc.

All file management operations are integrated in a centralized and easy-to-use GUI application with a built-in file navigator allowing one to execute any required operation in a single mouse click. Frequently used file management operations may be pre-configured as user-defined commands and executed using the GUI application or direct desktop shortcuts. DiskBoss is a highly extendable and customizable data management solution allowing one to design custom file classification plugins and purpose-built file management operations using an open and easy-to-use XML-Based format. Custom disk space analysis and file management operations may be integrated into the product, executed periodically at specific time intervals, performed as conditional actions in other operations or automatically triggered by one or more changes in a disk or directory. In addition, IT administrators are provided with extensive database integration capabilities allowing one to submit disk space analysis, file classification, duplicate files detection and file search reports into an SQL database. Reports from multiple servers and desktop computers may be submitted to a centralized SQL database allowing one to display charts showing the used disk space, file categories and duplicate files per user or per host and providing an indepth visibility into how disk space is used, what types of files are stored and how much space is wasted on duplicate files across the entire enterprise. Finally, IT professionals and enterprises are provided with DiskBoss Server – a server-based product version, which runs in the background as a service and is capable of executing all disk space analysis and file management operations in a fully automatic and unattended mode. DiskBoss Server can be managed and configured locally or through the network using a free network client GUI application or the DiskBoss command line utility, which provides the user with the ability to integrate DiskBoss’ features and capabilities into other products and solutions.

5

DiskBoss User Manual

Flexense Ltd.

1.1

Disk Space Utilization Analysis

DiskBoss provides advanced disk space utilization analysis capabilities allowing one to analyze one or more local disks, network shares or NAS storage devices and easily identify directories and files holding significant amounts of the disk space.

The user is provided with the ability to browse files and directories sorted by the used disk space, filter analysis results by the file extension, category, file size, last access time, user name, etc. and easily identify disk space usage hotspots. In addition, DiskBoss allows one to perform file management operations on analysis results, generate various types of disk space analysis charts and export reports into a number of standard formats such as HTML, XML, Excel CSV and ASCII text.

Finally, power computer users and IT professionals are provided with extensive SQL database integration capabilities and the ability to define one or more conditional actions or notifications to be executed when the specified conditions are met for one or more disks or directories.

6

DiskBoss User Manual

Flexense Ltd.

1.2

File Classification and Categorization

DiskBoss is capable of scanning disks, network shares and NAS storage devices and classifying files into a categorized file hierarchy. DiskBoss automatically recognizes more than 2500 file types and allows one to browse the categorized file hierarchy, perform various file management operations on specific files or file categories and physically reorganize files according to user-defined rules and policies.

The user is provided with the ability to apply second-level file categories and filters to file classification results allowing one to precisely focus on specific files or file groups. In addition, DiskBoss allows one to generate various types of charts and export file classification reports into a number of standard formats such as HTML, XML, text and Excel CSV.

DiskBoss provides a number of file classification plugins allowing one to classify files by the category, extension, user name, file size, last access, modification and creation times, etc. In addition, power computer users and IT professionals are provided with the ability to design custom file classification plugins using an open and easy-to-use XML-based format. Finally, DiskBoss provides the ability to submit file classification reports from multiple servers and desktop computers to a centralized SQL database allowing one to store a long term history of file classification reports and gain an in-depth visibility into disk space usage trends.

7

DiskBoss User Manual

Flexense Ltd.

1.3

Duplicate Files Finder
number of advanced features and files on desktops, servers and NAS duplicates and allows one to delete or delete duplicates.

DiskBoss' built-in duplicate files finder provides a large capabilities allowing one to identify and cleanup duplicate storage devices. The duplicate files finder shows detected duplicate files, replace duplicate files with links to originals

The user is provided with the ability to categorize and filter detected duplicate files by the file extension, category, file size, user name, last access time, etc. Moreover, DiskBoss allows one to generate various types of charts and export reports to the HTML, XML, text and CSV formats.

Power users and IT professionals are provided with policy-based duplicate files detection and removal capabilities allowing one to define custom duplicate files detection and cleanup commands and execute them in a fully automatic mode using the DiskBoss' GUI application or the command line utility. Finally, corporations and enterprises are provided with the ability to submit reports from multiple servers and desktop computers to a centralized SQL database allowing one to analyze the disk space wasted on duplicate files across the entire enterprise.

8

DiskBoss User Manual

Flexense Ltd.

1.4

Rule-Based File Organizing

DiskBoss provides a rich and powerful set of automated, rule-based file management capabilities allowing one to copy, move, delete, compress, link, etc. files or file categories matching user-specified rules and policies based on the file name, extension, location, category, last access date, modification date, creation date, binary and text patterns, file size, attributes, JPEG EXIF tags, etc.

The user is provided with the ability to define one or more file management actions to be executed and specify file matching rules defining files or file categories the actions should be performed on. During runtime, DiskBoss will scan input disks and directories, apply file matching rules and execute the specified file management actions on matching files.

In order to ensure proper operation of file organizing actions, DiskBoss provides easy-to-use preview capabilities allowing one to review and manually confirm each specific file management action. Once tested and validated in the preview mode, file organizing operations may be configured to run in a fully-automatic and unattended mode, executed periodically at specific time intervals, triggered by changes in a disk or directory or executed from a shell script or a batch file using the DiskBoss command line utility.

9

DiskBoss User Manual

Flexense Ltd.

1.5

Rule-Based File Search

DiskBoss provides powerful and flexible file search capabilities allowing one to search files using multiple search criteria including the file name, extension, file type, file size, last access, modification, and creation dates, text or binary patterns, JPEG EXIF tags, etc. The user is provided with the ability to define composite search queries using multiple search rules and apply the AND/OR logical operators.

One of the most powerful capabilities of DiskBoss is the integration of the rule-based search features in almost all types of analysis and file management operations. For example, disk space analysis, duplicate files detection, file classification, file copy and file delete operations may be performed on files matching one or more user-specified rules and policies.

Users are provided with the ability to display search results, save HTML, XML, text and Excel CSV reports and perform file management operations on search results. In addition, DiskBoss allows one to send e-mail notifications and/or execute custom actions when a search operation reaches a user-specified number of search results. Finally, corporations and enterprises are provided with advanced database integration capabilities allowing one to submit search reports into a centralized SQL database.

10

DiskBoss User Manual

Flexense Ltd.

1.6

Real-Time Disk Change Monitor

DiskBoss Ultimate includes a built-in disk change monitor capable of detecting file creations, modifications, attribute changes and deletions in real-time. The real-time disk change monitor provides the user with the ability to monitor one or more disks, directories or network shares, detect changes made in the monitored file systems, send notifications and execute actions.

The disk change monitor allows one to send e-mail notifications, save reports and/or execute custom commands when a disk change monitoring command reaches a user-specified number of changes. The ability to execute DiskBoss' user-defined commands as actions in the disk change monitor enables highly powerful and flexible integrations between different types of file management operations. For example, a user-defined file synchronization command executed after each X changes in a disk or directory provides easy-to-use and effective realtime file synchronization capabilities.

The DiskBoss' disk change monitor provides second-level file categories and filters allowing one to filter detected file system changes by the file extension, file type, change type, file owner, file size, etc. Finally, power computer users and IT professionals are provided with the ability to submit disk change monitoring reports into a centralized SQL database.

11

DiskBoss User Manual

Flexense Ltd.

1.7

High-Speed File Synchronization

DiskBoss provides advanced file synchronization capabilities allowing one to synchronize files between directories, local disks and network shares. The DiskBoss' built-in file synchronization engine offers numerous one-way and two-way file synchronization modes, the ability to sync specific file types, file compression capabilities and advanced performance tuning options.

Frequently used file synchronization operations may be pre-configured for custom hardware and storage configurations, saved as user-defined commands and executed in a single mouse click. Moreover, DiskBoss allows one to create direct desktop shortcuts for user-defined file synchronization commands and execute them directly from the Windows desktop without starting the main DiskBoss GUI application. Finally, power computer users and IT professionals are provided with a command line utility, which is capable of executing file synchronization commands from shell scripts and batch files.

By default, file synchronization commands are executed in the preview mode, which provides the user with the ability to review and manually confirm each specific file synchronization action. Once a sync command is tested and verified, the user can configure the command to run in a fully automatic, unattended stream file synchronization mode. The stream file synchronization mode performs all file synchronization actions on-the-fly, without showing the preview dialog and therefore it is much faster and uses significantly less system memory when executed on large file systems.

12

DiskBoss User Manual

Flexense Ltd.

1.8

Fault-Tolerant File Copy and Data Migration

DiskBoss provides a large number of advanced fault-tolerant file copy and rule-based data migration capabilities allowing one to copy vast amounts of files fast, efficiently and reliably. DiskBoss allows one to copy files including access control lists (ACLs), security attributes, ownership information, timestamps and file attributes.

The user is provided with a large number of flexible copy performance tuning and fault tolerance options allowing one to copy data at various speeds, recover failed copy operations and minimize the potential impact on running production systems. The data migration engine is especially optimized for modern hardware platforms and is capable of effectively utilizing powerful RAID controllers, multi-CPU/multi-core servers and Gigabit Ethernet networks.

One of the most powerful capabilities of the DiskBoss' file copy engine is the integration with rule-based search features, which is allowing one to copy or move files matching one or more user-defined rules. For example, the user is provided with the ability to copy a category of files with the file size larger that a specific value that were modified during a specific time period or any other combination of rules specifying files that should be copied. Moreover, DiskBoss provides the user with the ability to perform file copy operations periodically at specific time intervals or trigger pre-defined file copy commands when a userspecified number of changes are detected in a disk or directory making it possible to easily implement real-time file backup solutions. Finally, power computer users and IT professionals are provided with a command line utility capable of executing user-defined file copy commands from shell scripts and batch files enabling integration of DiskBoss' file copy and data migration capabilities with other products and solutions.

13

DiskBoss User Manual

Flexense Ltd.

1.9

User-Defined Commands

DiskBoss is a powerful and flexible product providing a large number of features, capabilities and configuration options allowing one to perform many types of different disk space analysis and file management operations. In order to simplify management and execution of frequently used operations, DiskBoss provides the user with the ability to add user-defined disk space analysis and file management commands pre-configured for user-specific hardware and storage configurations.

All types of disk analysis and file management operations such as disk space analysis, file classification, duplicate files detection, file organizing, file search, file synchronization, copy, move, delete and disk change monitoring may be saved as user-defined commands, preconfigured for user-specific needs and custom hardware configurations and executed in a single click using the main GUI application or the DiskBoss command line utility. The user is provided with the ability to create direct desktop shortcuts for user-defined file management commands and execute any command directly from the Windows desktop without starting the DiskBoss main GUI application. Moreover, DiskBoss allows one to design user-defined disk analysis and file management commands using an open and easy-to-use XML-Based format, which may be imported into the DiskBoss GUI application or executed by the command line utility. Pre-configured and tested disk analysis and file management commands may be easily and safely executed on multiple servers and desktop computers minimizing risks or potential operator-related errors. One of the most powerful capabilities of DiskBoss is the integration of different types of userdefined disk space analysis and file management commands, which provides the user with the ability to combine multiple operations in order to fully automate frequently performed and time consuming operations. For example, a disk space analysis operation configured to detect large amounts of old, unused files may automatically trigger a rule-based file management operation, which will archive, move or delete these specific files.

14

DiskBoss User Manual

Flexense Ltd.

1.10

SQL Database Integration

DiskBoss Ultimate and DiskBoss Server provide the ability to submit disk space analysis, file classification, duplicate files, disk change monitoring and file search results into a centralized SQL database through the ODBC interface.

In order to connect DiskBoss to an SQL database, open the options dialog, select the 'Database' tab and specify an ODBC data source, user name and password. Once finished specifying the required information, press the 'Verify' button to check the database connection.

Disk space analysis, file classification, duplicate files detection, disk change monitoring and file search results may be saved into an SQL database in a very similar way. Just press the 'Save' button on the results dialog and select the 'SQL Database' report format.

15

DiskBoss User Manual

Flexense Ltd.

1.11

Advanced Disk Space Analysis Capabilities

IT and storage administrators are provided with the ability to submit disk space analysis, file classification and duplicate files reports from multiple servers and desktop computers to a centralized SQL database, display charts showing the used disk space, file categories and duplicate files per user or per host and gain an in-depth visibility into what types of files are consuming the most of the disk space, who owns these files, where these files are located, how much disk space is wasted on duplicates, etc. across the entire enterprise.

The users analysis dialog provides the ability to display the used disk space, file categories and duplicate files per user. The dialog allows one to select types of operations, file categories and file system locations to analyze, customize users’ display names, edit the chart’s title and footer and finally copy the chart image to the clipboard allowing one to easily integrate DiskBoss' charts into user-custom reports and presentations.

The hosts analysis dialog allows one to display charts showing the disk space usage, file categories and duplicate files per host. The user is provided with the ability to select types of disk analysis operations, file categories and file system locations to analyze, customize hosts’ display names, edit chart’s title and footer and finally copy the chart image to the clipboard.

16

DiskBoss User Manual

Flexense Ltd.

DiskBoss Ultimate and DiskBoss Server provide the user with the ability to display history charts showing how the total disk space usage, a user-selected file category or the number of duplicate files are changing over time in one or more servers or desktop computers.

In order to display a history chart, save a series of reports to an SQL database, open the SQL reports dialog and press the 'History' button. A series of reports may be exported to an SQL database manually using the DiskBoss GUI application or automatically using the DiskBoss Server or the command line utility.

diskboss -analyze -dir <Local Directory> -save_to_database

The DiskBoss command line utility allows one to analyze, classify and categorize files in one or more disks or directories and save a report to an SQL database. In order to generate reports for multiple servers or desktop computers through the network, the user needs to specify one or more network shares that should be processed using the UNC notation and set an appropriate host name for each report saved to the database.

diskboss -analyze -dir \\server\share -host <Host Name> -save_to_database

Finally, DiskBoss Server may to configured to periodically analyze disk space utilization, classify files or detect duplicate files in one or more servers or desktop computers, save reports to a centralized SQL database and generate history charts showing how the used disk space and the number of files in a user-selected file category are changing over time. The history charts dialog displays the list of available charts, the list of host computers where the charts were generated on and extended statistical information for each chart. The user is provided with the ability to filter charts by the host name, location, report label, etc. allowing one to select an appropriate history chart. In addition, the charts dialog allows one to change the chart's title and footer, export the chart's image to the clipboard making it very easy to integrate DiskBoss history charts in user's custom reports and presentations.

17

DiskBoss User Manual

Flexense Ltd.

1.12

DiskBoss Server

DiskBoss Server is a server-based product version, which runs in the background as a service and is capable of executing all types of disk space analysis and file management operations in a fully automatic and unattended mode. DiskBoss Server may be managed and configured locally or through the network using a freeware network client GUI application, the DiskBoss command line utility or the DiskBoss Server programming API, which may be used to integrate DiskBoss' disk analysis and file management capabilities into other products and solutions.

1.13

Command Line Tools

DiskBoss provides a command line utility, which is capable of executing DiskBoss' user-defined disk analysis and file management commands from shell scripts and batch files. In addition, all types of disk analysis and file management commands may be designed using an open, easyto-use XML-based format and executed by the DiskBoss command line utility.

The XML-Based format provides full control over all types of disk analysis and file management operations and covers all available parameters from input disks and directories to automatic reports generation capabilities and performance tuning options. In conjunction with the XMLBased format, the command line utility may be used to integrate DiskBoss' disk analysis and file management capabilities into other products and solutions.

18

DiskBoss User Manual

Flexense Ltd.

1.14

DiskBoss Server SDK and Programming API

DiskBoss Server provides a software development kit (SDK) and a C/C++ programming API library allowing one to control a single DiskBoss Server on the same host where the client application is running on or multiple DiskBoss servers running on a number of hosts connected to the same local network.

In a single-host setup, the DiskBoss API library connects locally to the DiskBoss server, which runs in the background as a service. The DiskBoss API library provides the user with the ability to configure the server, setup user-defined file management commands, control file management operations and save results to file reports or an SQL database.

In a multi-host configuration, the DiskBoss API library connects to one or more DiskBoss Servers through the network allowing one to configure, manage and control multiple DiskBoss servers using a single client application. For more information about the DiskBoss Server software development kit (SDK) and programming API refer to: http://www.diskboss.com/diskboss_server_api.pdf

19

DiskBoss User Manual

Flexense Ltd.

1.15

Product Versions
Express 250K 1 TB 3 3 Yes Yes Yes Yes No No No No No No No No No No No No No No No No No No Freeware Pro 2.5M 10 TB 10 10 Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No No No No No No No No No $25
Free Trial

Feature Maximum Number of Files Maximum Storage Capacity Maximum Predefined Commands Maximum Number of Parallel Tasks Disk Space Analysis Operations File Classification Operations Duplicate Files Finder Support for Unicode File Names Support for Long File Names Advanced Data Migration Features Copy ACLs and Security Attributes Recoverable Copy Operations Advanced Classification Plugins Dynamic Speed Control Periodic File Management Jobs Real-Time Disk Change Monitor Continuous Data Protection Capabilities Advanced Storage Utilization Analysis Advanced Duplicate Files Detection Rule-Based File Copy and Data Migration Command Line Tools SQL Database Integration Disk Space Usage History Charts Runs in the Background as a Service Manageable Through the Network Free Network Client GUI Application License

Ultimate 25M 100 TB 100 100 Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No $125
Free Trial

Server 250M 1000 TB 1000 1000 Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes $175
Free Trial

* Product features, prices and license terms are subject to change without notice.

** A product license allows one to use the product on a single physical or virtual host computer, includes all product updates released during 36 months from the purchase date and provides E-Mail-based customer support.

20

DiskBoss User Manual

Flexense Ltd.

2 Product Installation
2.1 Downloading DiskBoss

DiskBoss is available as a free download on our web site (www.diskboss.com) and from a large number of software directories from around the world. To be sure you are getting the latest product version, check here: http://www.diskboss.com/downloads.html

2.2

Product Installation Procedure

DiskBoss is especially designed to be as simple as possible. The installation procedure is very simple, requires no special knowledge and may be completed in less than 10 seconds. There is no need for any additional software. Just download the DiskBoss installation package, run the setup program and you are done.

On the ‘Welcome’ screen press the ‘Next’ button. Read the end-user license agreement and press the ‘I Agree’ button if you accept the license terms or the ‘Cancel’ button to stop the installation process. Select the destination directory, press the ‘Install’ button and wait for the installation process to complete. That’s all you need to install DiskBoss on your computer.

21

DiskBoss User Manual

Flexense Ltd.

2.3

Product Update Procedure

Almost every month, Flexense releases a new version of DiskBoss, which typically includes new features and bug-fixes. These product updates are uploaded to our web site and may be applied to any installed product version. Each time DiskBoss is started, the DiskBoss update manager checks if there is a new product update available. If there is a new product update available, an ‘Update’ link will be displayed in the bottom-right corner of the status bar.

Click on the link to open the update dialog and see more information about the available product update. The update dialog shows the version of the new product update and the following two buttons: the ‘Release Notes’ button and the ‘Install’ button.

Press the ‘Release Notes’ button to see more information about the new product version. Press the ‘Install’ button to download and install the new product version. After pressing the ‘Install’ button, please wait while the Flexense 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 Flexense update manager will finish updating the product.

After download is completed, close all DiskBoss application windows and press the ‘Ok’ button when ready. If one or more DiskBoss application windows 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, DiskBoss will show a message box informing about the successfully completed operation. In order to manually verify that the currently installed product version is up-to-date, select menu ‘Help – Check For Updates …’ on the menu bar.

22

DiskBoss User Manual

Flexense Ltd.

3 Disk Space Utilization Analysis
3.1 Analyzing One or More Disks or Directories

In order to analyze one or more disks or directories, select the directories in the DiskBoss file navigator and press the ‘Analyze’ button located on the main toolbar. DiskBoss will scan the selected disks and directories and display the analysis results dialog showing disks, directories and files sorted by the amount of the used disk space.

The analysis results dialog allows one to browse analysis results, perform file management operations, categorize and filter results, generate various types of charts, save analysis reports into the HTML, XML, text and CSV formats, submit reports to an SQL database, etc.

In order to perform an operation on one or more files or directories, select the required files and press an appropriate button on the dialog’s toolbar. Alternatively, use the dialog’s context menu, which provides access to additional options and features.

23

DiskBoss User Manual

Flexense Ltd.

3.2

Using File Filters and Categories

The top view of the analysis results dialog shows directories and files sorted by the amount of the used disk space and the bottom view shows the currently selected file categories, which are allowing one to categorize and filter files and directories displayed in the top view.

In order to apply one or more file categories as a filter, select the required file categories in the bottom view, press the right mouse button and select the ‘Apply Selected Filters’ menu item. DiskBoss will filter the disk space analysis results and display in the top view files matching the selected file filters and directories containing these files.

With an active file filter, all operations such as browsing, file copy, move and delete, reports generation, charts, etc. will be performed on filtered results only. In order to reset the currently active file filter, press the right mouse button over the filters view and select the ‘Clear Selected Filters’ menu item.

24

DiskBoss User Manual

Flexense Ltd.

3.3

Using Disk Space Usage Pie Charts

DiskBoss provides numerous types of charts capable of displaying the used disk space per directory, file category, extension, file size, last access, modification and creation times, etc. In order to open the charts dialog, just press the ‘Charts’ button located on the results dialog’s toolbar.

By default, the charts dialog shows the amount of the used disk space per directory for the currently displayed file system location. In addition, the chart mode selector allows one to show the number of files per directory, the used disk space per category and the number of files per category.

In general, the charts dialog shows information about the directory view and the categories view. In order to display a different type of categories, just select the required category in the categories view and then open the charts dialog. In addition, the charts dialog allows one to edit chart options displayed in the chart’s status string and copy the chart’s image to the clipboard making it very easy to integrate DiskBoss' charts in user’s documents and reports.

25

DiskBoss User Manual

Flexense Ltd.

3.4

Using File Management Commands

DiskBoss allows one to copy, move and delete files and directories displayed in the disk space analysis results dialog. In order to perform a file operation on one or more files or directories, select the required items in the directory view, press the right mouse button and select an appropriate file operation.

For copy and move operations, enter the destination directory and optionally press the ‘Advanced Options’ button to open the copy options dialog.

The copy options dialog allows one to control the file overwrite mode, file copy rules, performance tuning options and error handling options. When copying files with an active file filter, DiskBoss automatically adds one or more file matching rules to the ‘Rules’ tab ensuring that only filtered files are copied to the destination directory.

26

DiskBoss User Manual

Flexense Ltd.

3.5

Saving Disk Space Analysis Reports

DiskBoss allows one to save disk space analysis results into a number of standard formats such as HTML, XML, text and Excel CSV. In addition, the user is provided with the ability to save results to the DiskBoss' native report format, which is capable of preserving all information related to each specific disk space analysis operation and may be loaded at any time just by clicking on a report file in the DiskBoss' file navigator.

In order to save a report file, press the ‘Save’ button located on the results dialog’s toolbar. On the save report dialog, select an appropriate report format, enter a report title, a file name and press the ‘Save’ button. Each report begins with the top 10 file categories followed by a hierarchy of directories and files sorted by the amount of the used disk space. If one or more file filters are active, DiskBoss will export files matching the selected file filters and directories containing these files.

By default, DiskBoss saves a short report, which includes up to 3 file system levels beginning from the current location. In order to change the amount of information saved to a report file, press the ‘More Options’ button and select the number of file system levels and the number of items per level that should be exported.

27

DiskBoss User Manual

Flexense Ltd.

3.6

Exporting Reports to an SQL Database

DiskBoss Ultimate allows one to save disk space analysis reports into an SQL database. A long-term history of disk space analysis reports from multiple servers and desktop computers may be submitted to a centralized SQL database and used to analyze disk usage trends across the entire enterprise.

Before exporting reports to an SQL database, open the ‘Options’ dialog, enable the ODBC interface and specify the name of the data source, database user name and password to use to connect to the database.

In order to export a disk space analysis to an SQL database, press the ‘Save’ button located on the results dialog’s toolbar and select the ‘SQL Database’ report format. Optionally, press the ‘More Options’ button and specify the number of file system levels and the number of items per file system level to be exported to the database.

For each report in the database, DiskBoss displays the report date and time, the host name, the input directories, the total number of files and disk space and the report title. To open a previously saved report, just click on the report item in the database reports dialog.

28

DiskBoss User Manual

Flexense Ltd.

Analyzing Disk Space Usage Per User
DiskBoss Ultimate and DiskBoss Server provide the ability to analyze disk space usage reports from one or more servers or desktop computers and display charts showing the amount of used disk space and the number of files per user.

Important: By default, processing and display of user names is disabled. In order to be able to see user names, open the options dialog, select the 'General' tab and enable this option.

In order to analyze disk space usage per user, connect DiskBoss to an SQL Database and submit disk space usage reports containing files owned by multiple users to the SQL database using the DiskBoss GUI application or the DiskBoss command line utility. Once reports are in the database, open the ‘Database’ dialog and press the ‘Users’ button to open the ‘Users Statistics’ dialog.

diskboss -analyze -dir \\server\share -host <Host Name> -save_to_database The simplest way to submit reports from multiple servers or desktop computers is to use the DiskBoss command line utility to analyze all the required hosts through the network. In order to simplify submission of reports to the SQL database, the command line utility may be executed on the same host where the SQL database is installed on. In this case, the user needs to specify one or more network shares to be processed and the host name to be set for each report.

diskboss -analyze -dir <Local Directory> -save_report <File Name>

Another option is to execute the command line utility on each specific host, save disk space analysis reports and later submit reports from all hosts to the SQL database using the DiskBoss GUI application. In this case, there is no need to set the host name, which will be set automatically to the name of the host the command line utility is executed on.

29

DiskBoss User Manual

Flexense Ltd.

Analyzing Disk Space Usage Per Host
DiskBoss Ultimate and DiskBoss Server provide the ability to submit disk space usage reports from multiple servers and desktop computers into a centralized SQL database, analyze disk space usage reports and display various types of charts showing disk space usage per host allowing one to gain an in-depth visibility into disk space usage patterns across the entire enterprise.

In order to perform advanced disk space usage analysis, the user needs to connect DiskBoss to an SQL Database, perform disk space analysis on multiple hosts using the DiskBoss GUI application or the DiskBoss command line utility and submit reports from all hosts to the SQL database. Once reports from all hosts are in the database, open the ‘Database’ dialog and press the ‘Hosts’ button to open the ‘Hosts Statistics’ dialog.

diskboss -analyze -dir \\server\share -host <Host Name> -save_to_database

The simplest way to submit reports from multiple servers or desktop computers is to use the DiskBoss command line utility to analyze all the required hosts through the network. In order to simplify submission of reports to the SQL database, the command line utility may be executed on the same host where the SQL database is installed on. In this case, the user needs to specify one or more network shares to be processed and the host name to be set for each report.

diskboss -analyze -dir <Local Directory> -save_report <File Name>

Another option is to execute the command line utility on each specific host, save disk space analysis reports and later submit reports from all hosts to the SQL database using the DiskBoss GUI application. In this case, there is no need to set the host name, which will be set automatically to the name of the host the command line utility is executed on.

30

DiskBoss User Manual

Flexense Ltd.

3.7

Analyzing Specific File Types or Categories

One of the most powerful analysis capabilities provided by DiskBoss is the integration between disk space analysis and file search features allowing one to perform disk space analysis on files matching one or more user-specified rules. For example, the user is provided with the ability to analyze files related to a specific file category, with a specific file size that were modified or created during a specific time period or any other combination of user-specific rules.

In order to add one or more file matching rules to a disk space analysis operation, press the ‘Advanced Options’ button on the analyze disk space dialog, select the ‘Rules’ tab and press the ‘Add’ button. Once finished to add file matching rules, select an appropriate rules logic mode (AND/OR) and press the ‘Save’ button.

For a rule-based disk space analysis operation, the results dialog will show files matching the specified rules and directories containing these files. All types of charts and reports will include information about filtered files only making it very easy to focus on specific file groups and categories. Moreover, the second-level file categories and filters located on the bottom side of the results dialog, provide the user with the ability to further categorize and filter files using additional categories such the file extension, file type, last access, creation and modification time, file size, file owner, etc.

31

DiskBoss User Manual

Flexense Ltd.

3.8

Multi-Level Disk Space Utilization Analysis

The DiskBoss' disk space analyzer provides the ability to combine disk space analysis operations with file classification capabilities allowing one to precisely understand what types of files are stored in directories holding most of the disk space.

In order to classify files in one or more directories displayed in the disk space analysis results dialog, select the required directories in the directory view, press the right mouse button and select the ‘Classify Files’ menu item. On the ‘Classification Plugins’ dialog selected an appropriate file classification plugin and press the ‘Classify’ button.

The file classification results dialog shows file categories and classes according to the selected file classification plugin and provides the user with the ability to export charts, save reports, submit results to an SQL database, perform file management operations on specific file types and physically reorganize files on the disk. Moreover, the user is provided with the ability to apply second-level file categories and filters by the file size, extension, last access, creation and modification dates, etc. to further focus on specific files or file groups.

32

DiskBoss User Manual

Flexense Ltd.

3.9

Using Disk Space Analysis Conditions and Actions

Power computer users and IT professionals are provided with the ability to automatically detect specific disk space utilization patterns, send E-Mail notification and/or execute DiskBoss' user-defined commands or custom actions. The user is provided with the ability to define one or more disk space analysis conditions, evaluate these conditions on disk space analysis results and send E-Mail notifications and/or execute actions if one or more of the specified conditions are met.

In order to add one or more disk space analysis conditions and actions, open the disk space analysis options dialog, select the ‘Actions’ tab and press the ‘Add’ button. On the action dialog, select the directory mode, enter the directory to evaluate the condition for, select the condition type, enter the condition value, select the action type and enter the action value.

During runtime, DiskBoss will perform disk space analysis and evaluate the specified conditions for one or more directories depending on the selected directory mode. Execution of disk space analysis actions depends on the selected actions mode. In the ‘Preview’ mode, DiskBoss will mark directories matching the specified conditions in the results dialog and show the actions preview dialog allowing one to verify and manually confirm the specified disk space analysis conditions, E-Mail notifications and actions. In the ‘Execute’ mode, instead of showing the disk space analysis results dialog, DiskBoss will automatically send E-Mail notifications and execute actions for each directory matching the user-specified conditions. The ‘Execute’ mode is especially useful for automatic disk space analysis and file management operations performed periodically using the DiskBoss' command line utility allowing one to trigger user-defined disk cleanup and file management operations based on disk space analysis results.

33

DiskBoss User Manual

Flexense Ltd.

3.10

Advanced Disk Space Analysis Options

DiskBoss provides a large number of advanced disk space analysis options allowing one to customize and configure disk space analysis operations for user-specific needs and custom hardware and storage configurations.

The disk space analysis options dialog allows one to control the file scanning mode, the default report title, advanced reporting options, the default file scanning filter and enable/disable automatic report generation. In addition, the user is provided with the ability to analyze specific file types, control performance tuning options, exclude specific directories from the disk space analysis process and specify one or more conditional analysis actions.

3.11

User-Defined Disk Space Analysis Commands

One of the most powerful and flexible capabilities of DiskBoss is the ability to pre-configure custom disk space analysis operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – Disk Space Analysis Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the Windows desktop.

34

DiskBoss User Manual

Flexense Ltd.

3.12

Analyzing Disk Space Using the DiskBoss Command Line Utility

In addition to the GUI application, DiskBoss Ultimate provides a command line utility capable of performing disk space utilization analysis operations and executing user-defined disk space analysis commands from shell scripts and batch files. The DiskBoss command line tool is located in the ‘<ProductDir>/bin’ directory. Command Line Syntax: diskboss –analyze -dir <Input Directory 1> [ ... <Input Directory X> <Options> ] diskboss –execute <User-Defined Disk Space Analysis Command> Parameters: -dir <Input Directory 1> [ ... <Input Directory X> ] This parameter specifies the list of input disks or directories to analyze. In order to ensure proper parsing of input disk and directories, directories containing space characters should be double quoted. Options: -save_html_report [ ReportFileName ] This parameter instructs to save a disk space analysis report and the list of all file categories to an HTML file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].html -save_csv_report [ ReportFileName ] This parameter instructs to save a disk space analysis report and the list of all file categories to an Excel CSV file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].csv -save_text_report [ ReportFileName ] This parameter instructs to save a disk space analysis report and the list of all file categories to a text report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].txt -save_report [ ReportFileName ] This parameter instructs to save a disk space analysis report and the list of all file categories to a native DiskBoss report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].flr -exclude_dir <Exclude Directory 1> [ ... <Exclude Directory X> ] This parameter specifies the list of directories that should be excluded from disk space analysis operation. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted. -v This parameter instructs to show the product’s major and minor versions. -help This parameter instructs DiskBoss to show the command line usage information.

35

DiskBoss User Manual

Flexense Ltd.

4 File Classification
4.1 Classifying One or More Disks or Directories

DiskBoss recognizes more than 2500 types of files and is capable of classifying files and showing a categorized hierarchy of files sorted by the amount of the disk space used by each file category. DiskBoss includes a number of file classification plugins capable of classifying files by the file type, extension, user name, last access, modification and creation dates, etc. In order to classify files in one or more disks or directories, select the required directories in the DiskBoss' file navigator and press the ‘Classify’ button.

On the ‘Plugins’ dialog, select an appropriate file classification plugin and press the ‘Classify’ button. DiskBoss will classify all the selected disks and directories and show the file classification results dialog displaying a categorized hierarchy of files sorted by the amount of the disk space used by each file category.

The file classification results dialog allows one to browse the file hierarchy, perform file management operations on files and file categories, generate various types of charts, export HTML, XML, text and Excel CSV reports and submit file classification results to an SQL database. In addition, the user is provided with the ability to physically reorganize files on the disk according to the used file classification plugin. Finally, power computer users are provided with the ability to design custom plugins using an open and easy-to-use XML-Based format.

36

DiskBoss User Manual

Flexense Ltd.

4.2

Using File Filters and File Categories

The top view of the file classification results dialog shows the file categories and classes sorted by the amount of the used disk space and the bottom view shows the second-level file categories and filters, which may be used to filter files and categories displayed in the top view making it very easy to focus on specific types of files or file groups.

In order to apply a second-level file filter, select one or more file categories in the filters view, press the right mouse button and select the ‘Apply Selected Filters’ menu item. DiskBoss will filter file classification results and display in the top view files matching the selected file filters and file categories containing these files.

When a file filter is active, the file classification results dialog generates charts and exports HTML, XML, text and Excel CSV reports for filtered files only. The user is provided with the ability to browse the filtered file hierarchy and perform file management operations in the usual way. In order to reset the file filter, press the right mouse button over the filters view and select the ‘Clear Selected Filters’ menu item.

37

DiskBoss User Manual

Flexense Ltd.

4.3

Using File Classification Pie Charts

DiskBoss provides a number of different types of charts capable of showing the amount of the disk space and the number of files per file category, extension, user name, file size, last access, modification and creation dates, etc. In order to open the charts dialog press the ‘Charts’ button located on the file classification results dialog’s toolbar.

By default, the charts dialog shows the currently displayed file categories and the selected second-level file categories. In order to change the displayed chart type, use the chart mode selector. In order to generate a chart for a different type of second-level file categories, select the required categories on the file classification results dialog and then open the charts dialog.

The charts dialog provides the user with the ability to customize the chart’s status line and allows one to copy the chart’s image to the clipboard making it very easy to integrate DiskBoss' file classification charts into user’s documents and presentations.

38

DiskBoss User Manual

Flexense Ltd.

4.4

Saving File Classification Reports

DiskBoss provides advanced reporting capabilities allowing one to save file classification results to HTML, XML, text and Excel CSV reports. In addition, the user is provided with the ability to save DiskBoss' native reports from multiple servers and desktop computers allowing one to submit a long term history of file classification reports to an SQL database and enabling advanced disk usage trends analysis across the entire enterprise. In order to save a report file, press the ‘Save’ button located on the file classification results dialog’s toolbar.

On the save report dialog, select an appropriate report format, enter a report title, specify a file name and press the ‘Save’ button. By default, DiskBoss exports a short file classification reports containing up to 3 levels of file categories with up to 20 files per file class. In order to change the amount of exported information, press the ‘More Options’ button and specify the number of levels and the number of files per class that should be exported.

Reports generated by the DiskBoss GUI application are beginning with the currently selected second-level file categories and followed by a list of all file categories and file classes sorted by the amount of the used disk space. Reports exported with an active file filter, include files matching the selected file filter and file categories containing these files.

39

DiskBoss User Manual

Flexense Ltd.

4.5

Submitting Reports to an SQL Database

Corporations and enterprises are provided with the ability to submit file classification reports from multiple servers and desktop computer to a centralized SQL database. A long-term history of file classification reports allows one to gain an in-depth visibility into disk usage trends across the entire enterprise. In order to submit a file classification report to an SQL database, select the ‘SQL Database’ report format and press the ‘Save’ button.

Before exporting reports to an SQL database, open the ‘Options’ dialog, enable the ODBC interface and specify the name of the data source, database user name and password to use to connect to the database.

For each report in the database, DiskBoss displays the report date and time, the host name, the input directories, the total number of files and disk space and the report title. To open a previously saved report, just click on the report item in the database reports dialog.

40

DiskBoss User Manual

Flexense Ltd.

Analyzing File Categories Per User
DiskBoss Ultimate and DiskBoss Server allow one to submit file classification reports from one or more servers and desktop computers into a centralized SQL database, analyze file classification reports and display various types of charts showing file categories and disk space usage per user.

Important: By default, processing and display of user names is disabled. In order to be able to see user names, open the options dialog, select the 'General' tab and enable this option.

In order to analyze file categories per user, connect DiskBoss to an SQL Database, perform file classification on one or more hosts using the DiskBoss GUI application or the DiskBoss command line utility and submit reports from all hosts to the SQL database. Once reports from all hosts are in the database, open the ‘Database’ dialog and press the ‘Users’ button to open the ‘Users Statistics’ dialog. diskboss -classify -dir \\server\share -host <Host Name> -save_to_database The simplest way to submit reports from multiple servers or desktop computers is to use the DiskBoss command line utility to classify files on all the required hosts through the network. In order to simplify submission of reports to the SQL database, the command line utility may be executed on the same host where the SQL database is installed on. In this case, the user needs to specify one or more network shares to be processed and the host name to be set for each report.

diskboss -classify -dir <Local Directory> -save_report <File Name>

Another option is to execute the command line utility on each specific host, save file classification reports and later submit report files from all hosts to the SQL database using the DiskBoss GUI application. In this case, there is no need to set the host name, which will be set automatically to the name of the host the command line utility is executed on.

41

DiskBoss User Manual

Flexense Ltd.

Analyzing File Categories Per Host
DiskBoss Ultimate and DiskBoss Server provide the ability to submit file classification reports from multiple servers and desktop computers into a centralized SQL database, analyze file classification reports and display various types of charts showing file categories and disk space usage per host allowing one to gain an in-depth visibility into disk space usage patterns across the entire enterprise.

In order to analyze reports from multiple hosts, the user needs to connect DiskBoss to an SQL Database, perform file classification on multiple hosts using the DiskBoss GUI application or the DiskBoss command line utility and submit reports from all hosts to the SQL database. Once reports from all hosts are in the database, open the ‘Database’ dialog and press the ‘Hosts’ button to open the ‘Hosts Statistics’ dialog.

diskboss -classify -dir \\server\share -host <Host Name> -save_to_database

The simplest way to submit reports from multiple servers or desktop computers is to use the DiskBoss command line utility to classify files on all the required hosts through the network. In order to simplify submission of reports to the SQL database, the command line utility may be executed on the same host where the SQL database is installed on. In this case, the user needs to specify one or more network shares to be processed and the host name to be set for each report.

diskboss -classify -dir <Local Directory> -save_report <File Name>

Another option is to execute the command line utility on each specific host, save file classification reports and later submit report files from all hosts to the SQL database using the DiskBoss GUI application. In this case, there is no need to set the host name, which will be set automatically to the name of the host the command line utility is executed on.

42

DiskBoss User Manual

Flexense Ltd.

4.6

Classifying Specific File Types and Categories

On of the most powerful capabilities of DiskBoss is the integration between file search and file classification capabilities allowing one to classify files matching one or more user-specified rules. For example, the user is provided with the ability to classify files with the file size greater than X MB that were last modified more than Y months ago or any other combination of user-specific file matching rules.

In order to add one or more file matching rules to a file classification operation, open the file classification options dialog, select the ‘Rules’ tab and press the ‘Add’ button. Once finished adding file matching rules, select an appropriate rules logic mode (AND/OR) and press the ‘Ok’ button.

During the file classification process, DiskBoss will first evaluate all existing files using the specified file matching rules and classify matching files only. Files not matching the specified rules will be just skipped from the file classification process and not displayed in the file classification results dialog making it very easy to focus on files the user is looking for. Different combinations of file classification plugins with various types of file matching rules defined in a file classification operation provide the user with the ability to visualize disk space utilization from different perspectives. For example, in order to display a hierarchy of MP3 files per user, select the ‘User-Based’ file classification plugin and add a file matching rule limiting the file classification operation to MP3 files only.

43

DiskBoss User Manual

Flexense Ltd.

4.7

Multi-Level File Classification and Analysis

DiskBoss provides multi-level file classification and disk space analysis capabilities allowing one to analyze file classification results and visualize physical locations of all files related to one or more specific file categories or file classes. These capabilities are especially useful when used in conjunction with second-level file categories and filters providing the user with the ability to analyze categorized and filtered file classification results and making it very easy to reveal locations of very specific files the user is looking for.

In order to analyze file classifications results, select one or more file classes or categories in the file classification results dialog, press the right mouse button and select the ‘Analyze’ menu item. DiskBoss will process the selected file categories and classes and display a file system hierarchy showing files related to the selected file categories or classes and the directories containing these files.

Analysis results are displayed in the standard disk space usage analysis dialog, which provides the user with the ability to generate charts, export HTML, XML, text and Excel CSV report, perform file management operations, etc.

44

DiskBoss User Manual

Flexense Ltd.

4.8

Automatic File Organizing Operations

One of the most powerful capabilities of the DiskBoss' file classification engine is the ability to physically organize files on the disk according to the selected file classification plugin. File organizing may be performed manually on file classification results displayed in the file classification results dialog or automatically by selecting an automatic file organizing mode in the file classification options dialog.

DiskBoss provides the user with the following advanced file organizing operations that may be performed on file classification results: • • • • Build Hierarchy of Links – in this mode DiskBoss will construct an organized hierarchy of directories and populate it with links to original files according to the selected file classification plugin. Copy File Hierarchy – in this mode DiskBoss will construct an organized hierarchy of directories and populate it with copies of original files according to the selected file classification plugin. Move File Hierarchy – in this mode DiskBoss will construct an organized hierarchy of directories and move all files into that hierarchy according to the selected file classification plugin. Move Files and Link Originals – in this mode DiskBoss will construct an organized hierarchy of directories, move all files to that hierarchy according to the selected file classification plugin and create links instead of original files pointing to files located in the organized file hierarchy. Execute Custom Command – in this mode DiskBoss will execute a custom command for each file passing the name of the file and the full file category as command line arguments allowing one to implement custom file organizing solutions.

By default, file classification results are displayed in the results dialog and the user is provided with the ability to perform these operations manually by selecting one or more file categories or classes in the file classification results dialog. In addition, power computer users and IT professionals are provided with the ability to physically reorganize files on the disk by using one of the mentioned automatic file organizing modes. In an automatic file classification mode, DiskBoss will physically reorganize files on the disk according to the selected file classification plugin without showing the file classification results dialog. Automatic file classification modes are especially useful in conjunction with the DiskBoss command line utility allowing one to perform automatic file classification operations from shell scripts and batch files and integrate file classification capabilities in other products and solutions. Finally, DiskBoss provides the user with the ability to design custom file classification plugins using an open and easy-to-use XML-Based format making it possible to reorganize files into custom directory structures designed according to user-specific needs.

45

DiskBoss User Manual

Flexense Ltd.

4.9

File Classification Plugins

DiskBoss provides a number of file classification plugins allowing one to classify files by the file category, extension, user name, file size, last access, modification and creation dates, etc. In addition, there are a number of purpose-built file classification plugins, which are capable of detecting hidden video, music and image files.

Each specific file classification plugins classifies files into a different hierarchy of file categories and classes. The ‘Default File Classification Plugin’ is the most commonly used plugin, which automatically recognizes more than 2500 types of files and organizes files into a general purpose hierarchy of file categories and classes. In addition to the file classification operations, file classification plugins are used in file search operations to search files related to one or more file categories by selecting file categories from a file classification plugin and in second-level file categories and filters in file classification and disk space analysis operations. Finally, DiskBoss allows one to design custom file classification plugins using an open and easy-to-use XML-Based format. The XML-Based format allows one to define a hierarchy of file categories and file classes and specify a list of file matching rules defining how to classify files for each specific file class. Custom file classification plugins may be imported to the product configuration using the DiskBoss GUI application.

The plugins management dialog provides the ability to import/export custom file classification plugins from/to XML and FLX formats. In order to open the plugins management dialog, select the ‘Tools – Manage Plugins’ menu item.

46

DiskBoss User Manual

Flexense Ltd.

4.10

Advanced File Classification Options

DiskBoss provides a large number of advanced file classification options allowing one to customize and configure file classification operations for user-specific needs and custom hardware and storage configurations.

The file classification options dialog allows one to control the file scanning mode, the default report title, advanced reporting options, the default file scanning filter and enable/disable automatic report generation. In addition, the user is provided with the ability to classify specific file types, control performance tuning options, exclude specific directories from the file classification process and physically reorganize files on the disk.

4.11

User-Defined File Classification Commands

One of the most powerful and flexible capabilities of DiskBoss is the ability to pre-configure custom file classification operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – File Classification Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the Windows desktop.

47

DiskBoss User Manual

Flexense Ltd.

4.12

Classifying Files Using the DiskBoss Command Line Utility

In addition to the GUI application, DiskBoss Ultimate provides a command line utility capable of performing file classification operations and executing user-defined file classification commands from shell scripts and batch files. The DiskBoss command line tool is located in the ‘<ProductDir>/bin’ directory. Command Line Syntax: diskboss -classify -dir <Input Directory 1> [ ... <Input Directory X> <Options> ] diskboss -execute <User-Defined File Classification Command>

Parameters: -dir <Input Directory 1> [ ... <Input Directory X> ] This parameter specifies the list of input disks or directories to classify. In order to ensure proper parsing of input directories, directories containing space characters should be double quoted.

Options: -save_html_report [ ReportFileName ] This parameter instructs DiskBoss to save file classification results to an HTML file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].html -save_csv_report [ ReportFileName ] This parameter instructs DiskBoss to save file classification results to an Excel CSV file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].csv -save_text_report [ ReportFileName ] This parameter instructs DiskBoss to save file classification results to a text file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_[date]_[time].txt -exclude_dir <Exclude Directory 1> [ ... <Exclude Directory X> ] This parameter specifies the list of directories that should be excluded from file classification. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted. -workers <Number of Processing Threads> This parameter sets the number of working threads to process files. DiskBoss is optimized for Multi-Core and Multi-CPU computers and capable of distributing the workload to an unlimited number of CPUs. By default, DiskBoss processes files with one working thread. -v This command shows the product’s major version, minor version, revision and build date. -help This command shows the command line usage information.

48

DiskBoss User Manual

Flexense Ltd.

5 Duplicate Files Finder
5.1 Detecting Duplicates in a Disk or Directory

In order to detect duplicate files in one or more disks or directories, select the required directories in the DiskBoss' file navigator and press the ‘Duplicates’ button located on the main toolbar. DiskBoss will scan the selected files and directories and display a dialog showing the list of detected duplicate file sets.

For each duplicate file set, DiskBoss shows the name of the original file, the number of duplicate files in the set, the size of each file in the set, the amount of wasted disk space and the currently selected duplicates removal action. In order to see all duplicate files related to a set, click on the set item in the set list.

The duplicate set dialog shows all duplicate files related to the set and allows one to select the original file, the duplicate files and the duplicates removal action. In order to select a file as the original, select the file item, press the right mouse button and select the ‘Set as Original File’ menu item. In order to see more information about a file, just click on the file item in the file list. Once finished selecting the duplicate files, use the removal actions combo box located in the bottom-left corner of the dialog to select an appropriate duplicates removal action.

49

DiskBoss User Manual

Flexense Ltd.

5.2

Selecting Duplicate Files Removal Actions

The DiskBoss' duplicate files finder allows one to delete duplicate files, move duplicates to another directory or replace duplicates with links pointing to the original file in each specific set of duplicate files. In order to select a specific duplicates removal action for one or more sets of duplicate files, select the sets in the set list, press the right mouse button and select an appropriate duplicate files removal action. Warning: There are many duplicate files in the Windows system directory, which are important for proper operation of the operating system. Removal of duplicate files located in the Windows system directory may permanently damage the operating system and render the computer completely non-functional.

By default, DiskBoss selects the oldest file in each set as the original file and all other files in the set as duplicates. In order to change that, select one or more sets, press the right mouse button and select the ‘Select Oldest Files as Duplicates’ menu item. Alternatively, open the set dialog, select any arbitrary file in the set as the original file, select an appropriate duplicates removal action that should be executed for this specific set and select one or more duplicate files in the set that the removal action should be applied to.

5.3

Executing Duplicate Files Removal Actions

Once finished selecting duplicates and removal actions, press the ‘Preview’ button to see the duplicate files removal actions preview dialog. The duplicates removal actions preview dialog shows the selected duplicate files and removal actions that will be executed and allows one to review and manually confirm each specific action before execution. The operating system and other system applications may have a large number of duplicate files located in various system directories. These duplicate files may be very important for proper operation of the operating system and other system applications and it is highly dangerous to remove these duplicate files. To be on the safe side, use the duplicates removal actions only for your own documents, music files, videos, etc.

In order to execute the selected duplicates removal actions, press the ‘Execute’ button located in the bottom-right corner of the ‘Preview’ dialog. DiskBoss will process the selected duplicate files and execute the specified duplicates removal actions.

50

DiskBoss User Manual

Flexense Ltd.

5.4

Using File Filters and Categories

The DiskBoss' duplicate files finder allows one to categorize and filter duplicate files by the file extension, category, size, user name, etc. The user is provided with the ability to apply multiple file filters, display specific types of duplicate files and apply duplicate files removal actions to or export reports showing filtered files only.

In order to set one or more file filters, select an appropriate type of file categories in the categories combo box, select one or more file filters in the filters view, press the right mouse button and select the ‘Apply Selected Filters’ menu item.

With active file filters, DiskBoss shows duplicate files matching the selected filters, exports reports showing matching files only and significantly simplifies selection of duplicates removal actions for specific file types or file categories. In order to clear the selected file filters, just press the ‘Clear’ button located on the right side of the categories selector.

51

DiskBoss User Manual

Flexense Ltd.

5.5

Showing Duplicate Files Pie Charts

The duplicate files finder allows one to display charts showing the amount of wasted disk space and the number of duplicate files per extension, file type, file size, user name, etc. In order to open the charts dialog, press the ‘Charts’ button located on the dialog’s toolbar.

The charts dialog displays information for the displayed duplicate files and the currently selected categories of duplicate files. In order to display a chart for another category of duplicates, select an appropriate category in the categories combo box and then open the charts dialog.

The charts dialog allows one copy the displayed chart image to the clipboard making it very easy to integrate DiskBoss charts into user’s reports and presentations. Finally, the user is provided with the ability to customize the information displayed on the chart’s status bar.

52

DiskBoss User Manual

Flexense Ltd.

5.6

Saving Duplicate Files Reports

DiskBoss allows one to save lists of detected duplicate files to HTML, XML, text and Excel CSV reports. In addition, the user is provided with the ability to save DiskBoss' native reports, which preserve all information about each specific duplicate files detection operation and may be imported to an SQL database using DiskBoss Ultimate.

In order to save a report file, press the ‘Save’ button located on the dialog’s toolbar, select an appropriate report format, enter the report file name and press the ‘Save’ button. Optionally, limit the report to a specific number of duplicate file sets and/or select the ‘Save Compressed Report’ option to save a compressed report file.

A typical report file includes information about the date and time of the duplicate files detection operation, the name of the host computer the operation was performed on, a list of top 10 file categories according to the currently selected categories mode followed by the list of duplicate file sets detected in the processed disks and directories. For each set of duplicate files, DiskBoss shows the name of the original file, the number of duplicate files in the set and the amount of wasted disk space.

53

DiskBoss User Manual

Flexense Ltd.

5.7

Exporting Reports to an SQL Database

IT professionals and enterprises are provided with the ability to submit reports listing duplicate files detected on multiple storage systems, servers and desktop computers to a centralized SQL database enabling system and storage administrators to gain an in-depth visibility into amounts of duplicate files and wasted disk space across the entire enterprise.

In order to submit a report to an SQL database, press the ‘Save’ button located on the dialog’s toolbar, select the ‘SQL Database’ report format and press the ‘Save’ button. Before exporting a report to an SQL database, the user needs to open the options dialog, enable the ODBC interface and specify the name of the ODBC data source, the database user name and password to use for database export operations.

For each report in the database, DiskBoss shows the report date and time, the name of the host computer the operation was performed on, disks and directories that were processed, the total amount of disk space and the number of files that were processed and the report title. In order to open a report, just click on the report item in the report list.

54

DiskBoss User Manual

Flexense Ltd.

Analyzing Duplicate Files Per User
DiskBoss Ultimate and DiskBoss Server provide the ability to analyze duplicate files owned by multiple users and detected on one or more servers or desktop computers and display charts showing the amount of wasted disk space and the number of duplicate files per user.

Important: By default, processing and display of user names is disabled. In order to enable this capability, open the options dialog and enable this option.

In order to analyze duplicate files per user, connect DiskBoss Ultimate to an SQL Database and submit reports containing duplicates owned by multiple users to the SQL database using the DiskBoss GUI application or the DiskBoss command line utility. Once reports are in the database, open the ‘Database’ dialog and press the ‘Users’ button to open the ‘Users Statistics’ dialog.

diskboss -duplicates -dir \\server\share -host <Host Name> -save_to_database

The simplest way to submit reports from multiple servers or desktop computers is to use the DiskBoss command line utility to detect duplicate files on all required hosts through the network. In order to simplify submission of reports to the SQL database, the command line utility may be executed on the same host where the SQL database is installed on. In this case, the user needs to specify one or more network shares to be processed and the host name to be set for each report.

diskboss -duplicates -dir <Local Directory> -save_report <File Name>

Another option is to execute the command line utility on each specific host, save duplicate files reports and later submit report files from all hosts to the SQL database using the DiskBoss GUI application. In this case, there is no need to set the host name, which will be set automatically to the name of the host the command line utility is executed on.

55

DiskBoss User Manual

Flexense Ltd.

Analyzing Duplicate Files Per Host
DiskBoss Ultimate and DiskBoss Server provide the ability to submit duplicate files reports from multiple servers and desktop computers into a centralized SQL database, analyze reports and display various types of charts showing the amount of duplicate disk space and the number of duplicates per host allowing one to gain an in-depth visibility into amounts of duplicate files across the entire enterprise.

In order to analyze reports from multiple hosts, the user needs to connect DiskBoss to an SQL Database, perform duplicate files search on multiple hosts using the DiskBoss GUI application or the DiskBoss command line utility and submit reports from all hosts to the SQL database. Once reports from all hosts are in the database, open the ‘Database’ dialog and press the ‘Hosts’ button to open the ‘Hosts Statistics’ dialog.

diskboss -duplicates -dir \\server\share -host <Host Name> -save_to_database

The simplest way to submit reports from multiple servers or desktop computers is to use the DiskBoss command line utility to detect duplicate files on all required hosts through the network. In order to simplify submission of reports to the SQL database, the command line utility may be executed on the same host where the SQL database is installed on. In this case, the user needs to specify one or more network shares to be processed and the host name to be set for each report.

diskboss -duplicates -dir <Local Directory> -save_report <File Name>

Another option is to execute the command line utility on each specific host, save duplicate files reports and later submit report files from all hosts to the SQL database using the DiskBoss GUI application. In this case, there is no need to set the host name, which will be set automatically to the name of the host the command line utility is executed on.

56

DiskBoss User Manual

Flexense Ltd.

5.8

Detecting Duplicates in Specific File Types

One of the most powerful capabilities of DiskBoss is the ability to perform disk analysis and file management operations on files matching user-specified criteria. In order to be able focus of specific types of duplicate files, the user is provided with the ability to define one or more file matching rules specifying files that should be processed by the DiskBoss' duplicate file finder. Files not matching the specified rules, will be just skipped from the duplicate files detection process.

In order to add one or more file matching rules to a duplicate files detection operation, open the operation dialog, select the rules tab and press the ‘Add’ button located on the right side of the dialog. Once finished adding file matching rules, select an appropriate rules logic and press the ‘Save’ button.

5.9

Advanced Duplicate Files Detection Options

The DiskBoss' duplicate files finder provides a large number of advanced options allowing one to customize duplicate files detection operations for user-specific hardware and storage configurations. The ‘General’ tab allows one to control the file signature type, the file scanning mode, the maximum number of duplicate file sets to display in the results dialog and the file filter, which may be used to limit the operation to specific files using a file name pattern.

The ‘Performance’ tab provides the ability to intentionally slow down the duplicate files detection process in order to minimize the potential performance impact on running production systems. The ‘Exclude’ tab allows one to define one or more subdirectories to be excluded from the duplicate files detection process.

57

DiskBoss User Manual

Flexense Ltd.

5.10

Using Automatic Duplicate Files Removal Actions

DiskBoss Ultimate and DiskBoss Server provide the user with the ability to automatically execute one or more duplicate files removal actions for files matching user-specified rules. In order to define one or more automatic duplicates removal actions, open the operation dialog, select the ‘Actions’ tab and press the ‘Add’ button.

On the ‘Action’ dialog select the original file detection mode, an appropriate duplicates removal action and specify one or more file matching rules defining files the action should be applied to. During runtime, DiskBoss will process detected duplicate files, apply the specified file matching rules, detect the original file and execute the duplicates removal actions for files matching the specified rules and policies.

By default, DiskBoss executes automatic duplicates removal actions in the ‘Auto-Select’ mode, which selects the specified actions and displays the duplicates removal actions preview dialog allowing one to review and manually confirm each specific action. After testing the duplicate file detection operation in the preview mode, change the actions mode to ‘Execute’ to automatically execute the specified duplicates removal actions without showing the actions preview dialog.

58

DiskBoss User Manual

Flexense Ltd.

Finally, IT administrators are provided with the DiskBoss command line utility allowing one to execute automatic duplicate files detection and removal operations from batch files and shell scripts, periodically remove duplicates from servers and enterprise storage system and integrate DiskBoss' duplicate files detection capabilities with other products and solutions.

The DiskBoss command line utility is available in DiskBoss Ultimate and DiskBoss Server and it is capable of executing user-defined duplicate files detection and removal commands defined in the DiskBoss GUI application and/or written in the DiskBoss' XML format.

5.11

User-Defined Duplicate Files Detection Commands

One of the most powerful and flexible capabilities of DiskBoss is the ability to pre-configure custom duplicate files detection and removal operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – Duplicate Files Search Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the Windows desktop.

59

DiskBoss User Manual

Flexense Ltd.

5.12

Detecting Duplicate Files Using the DiskBoss Command Line Utility

In addition to the DiskBoss GUI application, DiskBoss Ultimate provides a command line utility allowing one to execute duplicate files detection and removal operations from batch files and shell scripts. The command line tool is located in the ‘<ProductDir>\bin’ directory. Command Line Syntax: diskboss -duplicates -dir <Input Directory 1> [ ... <Input Directory X> <Options> ] Parameters: -dir < Directory 1> [ ... < Directory X> -file <File 1> … <File 2> ] This parameter specifies the list of input directories or files to process. In order to ensure proper parsing of command line arguments, directories and file names containing space characters should be double quoted. Options: -signature_type <MD5 | SHA1 | SHA256> This parameter sets the type of algorithm used to calculate signatures of files. By default, DiskBoss uses the SHA256 algorithm. -exclude_dir <Exclude Directory 1> [ ... <Exclude Directory X> ] This parameter specifies the list of directories that should be excluded from processing. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted. -filter <FileFilter> This parameter sets the directory search filter (default *.*). -workers <WorkingThreadCount> This parameter sets the number of working threads to process files. DiskBoss is optimized for Multi-Core and Multi-CPU computers and is capable of distributing the workload to an unlimited number of CPUs. By default, DiskBoss processes files with one working thread. -max_dup_set <MaxNumberOfDuplicateSets> This parameter sets the maximum number of duplicate file sets to report about. By default, DiskBoss will report about up to 1000 duplicate file sets sorted by the amount of wasted storage space. -min_wasted_space <MinWastedStorageSpace> This parameter sets the minimum amount of wasted storage space to report about. By default, DiskBoss will report about duplicate file sets wasting at least 1 MBytes of storage space. -save_html_report | save_csv_report | save_text_report [ ReportFileName ] This parameter saves a report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_duplicates_[date]_[time].html -v -help - This command shows the product’s version, revision and build date. - This command shows the command line usage information.

60

DiskBoss User Manual

Flexense Ltd.

6 Rule-Based File Organizing
6.1 Organizing Files in a Disk or Directory

DiskBoss is capable of automatically organizing files according to user-defined rules and policies. The user is provided with the ability to define one or more conditional file management operations such as file copy, move, delete, link, compress or a user-custom command and execute these file management operations on files matching user-specified rules based on the file name, extension, category, size, user name, creation, last access or last modification time, text or binary patterns, etc.

In order to organize files in a disk or directory, select the required directories and files in the DiskBoss' file navigator and press the ‘Organize’ button located on the main toolbar. Press the ‘Add’ button to add one or more file organizing commands and press the ‘Preview’ button to see the file organizing preview dialog.

By default, DiskBoss organizes files with preview allowing one to review and manually confirm each file organizing action before execution. After reviewing file organizing actions, press the ‘Organize’ button to execute all selected file organizing actions. Tested and verified file organizing operations may be executed without showing the preview dialog using the DiskBoss GUI application, direct desktop shortcuts or the DiskBoss command line utility.

61

DiskBoss User Manual

Flexense Ltd.

6.2

Defining File Organizing Commands

DiskBoss allows one to add an unlimited number of conditional file organizing actions into a single file organizing operation. During runtime, DiskBoss will scan the selected files and directories, evaluate the specified file matching rules and execute required file management actions.

In order to add a new file organizing command, press the ‘Add’ button, select an appropriate file organizing action and specify one or more file matching rules. Select a previously defined command and press the ‘Edit’ button to edit the selected file organizing command. Or press the ‘Delete’ button to delete the selected command. Use the preview mode combo box to enable or disable the preview dialog.

The organizing command dialog provides the ability to select an appropriate file organizing action, specify one or more file matching rules and configure additional action-specific advanced options. During runtime, all the specified file organizing actions will be evaluated in the same order as displayed in the file organizing commands view. The first matching action will be executed and the remaining actions will be just skipped from the organizing process.

62

DiskBoss User Manual

Flexense Ltd.

6.3

Using File Matching Rules

DiskBoss provides a large number of different types of file matching rules allowing one to match files by the file name, extension, category, size, attributes, text or binary patterns, JPEG EXIF tags, creation, last access and modification dates, etc.

The user is provided with the ability to combine multiple file matching rules and apply logical AND/OR operators. Moreover, power computer users and IT administrators can define hierarchical file matching rules capable of precisely selecting the exact file type or groups of files according to user-specific needs.

In order to add a nested list of rules, press the right mouse button over the top level list of file matching rules and select the ‘Add Nested Rule List’ menu item. On the nested rules dialog add one or more file matching rules and press the ‘Ok’ button.

63

DiskBoss User Manual

Flexense Ltd.

6.4

Selecting File Organizing Actions

The DiskBoss' file organizer allows one to copy, move, delete, link and compress files matching user-defined rules. In addition, the user is provided with the ability to execute a custom command for files matching the specified rules passing the file name as an argument.

Use the file organizing action combo box to select one of the following file organizing actions: • • • • • • • • Copy Files To – copies matching files to the specified destination directory Move Files To – moves matching files to the specified destination directory Delete Files – deletes matching files, optionally wipes data from the disk Execute Command – executes the specified custom command for matching files Move and Link To – moves files and places links instead of original files Compress – compresses matching files in-place Compress and Copy To – copies compressed files to the destination directory Compress and Move To – moves compressed files to the destination directory

6.5

Organizing Files with Preview

The DiskBoss' file organizing engine is capable of organizing files in two modes: with preview and without preview. When the preview mode is enabled, DiskBoss scans the selected files and directories, evaluates the specified file matching rules and displays a preview dialog showing file organizing actions that should be executed allowing one to review and manually confirm each specific file organizing action.

64

DiskBoss User Manual

Flexense Ltd.

6.6

Organizing Files without Preview

The preview mode is very useful for testing and verification purposes, but sometimes it may be required to execute file organizing operations fully automatically without showing the preview dialog. For example, automatically executed periodic file organizing operations may be silently performed in the background using the DiskBoss command line utility or DiskBoss Server, which runs in the background as a service and can execute file organizing operations in a fully-automatic, unattended mode.

In order to disable the preview dialog for a file organizing operation, open the operation dialog, change the preview mode to ‘Organize Without Preview’ and press the ‘Save’ button. Without preview, file matching rules and evaluated and actions executed on-the-fly, which significantly reduces memory consumption when processing large file systems containing millions of files.

6.7

User-Defined File Organizing Commands

One of the most powerful and flexible capabilities of DiskBoss is the ability to pre-configure custom file organizing operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – File Organizing Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the Windows desktop.

65

DiskBoss User Manual

Flexense Ltd.

6.8

Drag-and-Drop Files into a File Organizing Command

Another option to execute file organizing commands is to drag-and-drop files and/or directories into a file organizing command item in the user-defined commands tool pane. In order to configure a file organizing command to accept drag-and-drops, open the command dialog and select the ‘Use External Inputs’ input mode.

Now, select any files and/or directories in the DiskBoss' file navigator and drag-and-drop the selected files and directories into the file organizing command in the user-defined commands tool pane. DiskBoss will process the selected files and directories and execute the specified file organizing actions for matching files.

6.9

Periodic Execution of File Organizing Commands

Sometimes, it may be required to execute a file organizing operation periodically at specific time intervals. The first option to do that is to configure a periodic job in the DiskBoss GUI application and select the required file organizing command to be executed periodically. Another option is to use DiskBoss Server, which runs as a service in the background and may be used to periodically execute file organizing operations in a fully automatic, unattended mode.

66

DiskBoss User Manual

Flexense Ltd.

6.10

Automatic Execution of File Organizing Commands

DiskBoss provides the ability to monitor one or more disks or directories and automatically execute a file organizing operation after a user-specified number of changes is detected.

In order to execute a file organizing command using the DiskBoss' disk change monitor, create a new disk change monitoring command, specify one or more disks or directories that should be monitored, select the ‘Actions’ tab, specify the number of disk changes that should trigger the file organizing command and selected the name of the file organizing command that should be executed once the disk change monitor reaches the specified number of changes.

6.11

Organizing Files Using the DiskBoss Command Line Utility

In addition to the DiskBoss GUI application, power computer users and IT administrators are provided with the ability to execute user-defined file organizing operations from batch files and shell scripts using the DiskBoss command line utility, which is located in the ‘ProductDir\bin’ directory.

In order to execute a user-defined file organizing command using the DiskBoss command line utility, open the command prompt window in the ‘ProductDir\bin’ directory and type the following command: ‘diskboss –execute <Command Name>’. DiskBoss will execute the specified file organizing command and display the total number of files and disk space in the specified disks and directories and the number of files that were actually processed.

67

DiskBoss User Manual

Flexense Ltd.

6.12

Automatic, Rule-Based File Organizing Using DiskBoss Server

DiskBoss Server is a server-based version of DiskBoss, which runs in the background as a service and is capable of executing file organizing commands periodically at user-specified time intervals or automatically, triggered by real-time disk activities in one or more userdesignated disks or directories. DiskBoss Server may be managed and configured locally or remotely through the network using a freeware network client GUI application or the DiskBoss command line utility.

The GUI interface is very similar to the standard DiskBoss GUI application providing standard dialogs for all types of files management operations supported by DiskBoss. In addition, DiskBoss allows one to export file organizing commands defined and tested in the regular DiskBoss GUI application to the XML format and import these commands to DiskBoss Server for automatic execution in the background. In order to create a file organizing command in DiskBoss Server, connect to the server using the network client GUI application, press the ‘Add’ button located on the main toolbar and select the ‘Add New – File Organizing Command’ menu item. On the command dialog, specify disks and directories that should be processed and add one or more file organizing actions that should be executed.

In the simplest case, create a new periodic job, configure the time internal the job should be executed at and set the periodic job to trigger the newly created file organizing command. In order to be able to execute the command fully automatically, set the command to execute without the preview dialog. Alternatively, create a disk change monitoring command and configure the command to execute the file organizing command every X file system changes.

68

DiskBoss User Manual

Flexense Ltd.

7 Rule-Based File Search
7.1 Searching Files Using File Matching Rules

DiskBoss provides extensive file search capabilities allowing one to search files by the file name, extension, type, location, size, attributes, text and binary patterns, creation, last access and modification dates, user name, JPEG EXIF tags, etc. Users are provided with the ability to use different types of file matching rules combined with logical operators to compose file search queries capable of finding files matching multiple criteria.

The DiskBoss' file search capabilities are fully integrated with other product features allowing one to perform disk space analysis, file classification, duplicate files detection, file copy, delete and disk change monitoring operations on files matching one or more user-defined rules. In order to start a file search operation, just press the ‘Search’ button located on the main toolbar, enter a file name pattern and press the ‘Search’ button. If nothing is selected in the DiskBoss' file navigator, the search operation will be performed in the current location. Alternatively, DiskBoss will search the selected disks and directories and display search results.

The search results dialog displays files matching the specified rules and allows one to export HTML, XML, text and Excel CSV reports and perform a number of file management operations such as file copy, move or delete. For each search result, the results dialog displays the file name, directory, the file size and the last modification date. In order to see more information about a file, select the file in the result list, press the right mouse button and select the ‘File Properties’ menu item.

69

DiskBoss User Manual

Flexense Ltd.

7.2

Searching Files by Category

DiskBoss is capable of automatically recognizing more that 2500 file types and categories organized into a logical hierarchy of file classes and class groups, making it very easy to search for broad categories of files such as documents, music files, videos, images, etc. In order to search for files by the file type select the ‘Search Files Categorized As’ file matching rule and press the ‘Select’ button to select a file category.

File categories and file classes are organized into a logical hierarchy representing specific file types grouped into a number of broad file categories. DiskBoss includes a number of file classification plugins, which provide different types of file categories allowing one to categorize files by the file type, size, creation, last access and modification dates, etc. In order to select a different file classification plugin, use the plugin combo box located on the top side of the file categories dialog.

In order to open a file category, just click on the category item in the list. Select the required file category or file class and press the ‘Select’ button to select the file category for the file matching rule. During runtime, DiskBoss will match files related to any file class in the selected file category or the exact file class if the file matching rule was set to match an individual file type.

70

DiskBoss User Manual

Flexense Ltd.

7.3

Searching Files by File Name

In order to search files by the file name, open the search operation dialog, press the ‘Add’ button, select the ‘Search Files with the File Name’ rule, select an appropriate file name comparison operator and enter a file name pattern string to compare file names with.

The file name comparison operator allows one to find files matching, beginning with, ending with or containing the specified string pattern. In addition, negative comparison operators are provided as well. File name searches are case insensitive and the entered file name pattern string will match both low case and upper case letters.

7.4

Searching Files by File Extension

In order to search files by the file extension, open the search operation dialog, press the ‘Add’ button, select the ‘Search Files with the File Extension’ rule, select an appropriate file extension comparison operator and enter a file extension pattern string to compare file extensions with.

The file extension comparison operator allows one to find files matching, beginning with, ending with or containing the specified string pattern. In addition, negative comparison operators are provided as well. File extension searches are case insensitive and the entered file extension pattern string will match both low case and upper case letters.

71

DiskBoss User Manual

Flexense Ltd.

7.5

Searching Files by File Path

In order to search files by the directory name, open the search operation dialog, press the ‘Add’ button, select the ‘Search Files with the Directory Name’ rule, select an appropriate directory name comparison operator and enter a directory name pattern string to compare directories with. The directory name comparison operator allows one to find directories matching, beginning with, ending with or containing the specified string pattern. In addition, negative comparison operators are provided as well. Directory name searches are case insensitive and the entered directory name pattern string will match both low case and upper case letters.

7.6

Searching Files by Access, Modification and Creation Dates

DiskBoss provides two sets of file matching rules allowing one to search files by the creation, last modification and last access dates. The first set of rules matches files using absolute dates and the second set of file matching rules matches files using relative time periods. Absolute dates are preferable when the user needs to find all files that were created or modified during a specific calendar month or year, while relative time periods are more useful when someone needs to find files that were created or modified during the last X days or Y months always giving correct results as the time goes on.

7.7

Searching Files by Relative Time Periods

Searching files by relative access, modification or creation times may be very useful when the user does not know the exact period of time he or she is looking for. Another advantage using relative time periods is the constant validity of search queries, which are keeping up to date while the time is going on. For example, a search query configured to find all files that were modified during the last month is always valid independent of the current month.

72

DiskBoss User Manual

Flexense Ltd.

7.8

Searching Files by Text Patterns

In order to search files by a text string inside of files, open the search operation dialog, press the ‘Add’ button, select the ‘Search Files Containing Text’ rule, select an appropriate text comparison operator and enter a text pattern string to search inside of files.

The text pattern comparison operator allows one to find files containing or not containing the specified text pattern. Text searches are case insensitive and the entered text pattern string will match both low case and upper case letters.

7.9

Searching Files by Binary Patterns

DiskBoss is capable of searching files by binary patterns located or not located at specific positions inside of files. In order to add a binary pattern search rule, press the ‘Add’ button, select the ‘Search Files Containing HEX Pattern’ rule, select an appropriate comparison operator, enter the HEX pattern to search for and specify an absolute position inside of files the pattern should be located on.

The HEX pattern should be specified as a string of upper case HEX numbers delimited by the space character with each number representing a single byte of the pattern. Users needed to match multiple binary patterns located at different places in each file may use multiple binary file matching rules with each one configured to match a single pattern. Moreover, multiple hierarchical binary file matching rules may be combined with logical operators allowing one to compose sophisticated, multi-level file search queries capable of finding the exact files the user is looking for.

73

DiskBoss User Manual

Flexense Ltd.

7.10

Searching Files by File Size

DiskBoss provides the ability to search files by the file size. In order to add a file search rule capable of matching files by the file size, press the ‘Add’ button, select the ‘Search Files with File Size’ rule, select an appropriate size comparison operator and enter the file size value.

7.11

Searching Files by File Attributes

Sometimes, it may be required to find files by file attributes such as read-only, hidden, system, etc. In order to add a file search rule capable of matching files by file attributes, press the ‘Add’ button, select the ‘Search Files with File Attributes’ rule, select an appropriate comparison operator and press the ‘Select’ button to select the file attributes to look for.

On the select dialog, check the required file attributes and press the ‘Ok’ button. When the rule is set to find files having the selected attributes, DiskBoss will match files having any of the selected file attributes. Otherwise, when the rule is set to find files hot having the selected attributes, DiskBoss will match files having none of the selected attributes

74

DiskBoss User Manual

Flexense Ltd.

7.12

Searching Files by User Name

DiskBoss is capable of searching files by the user name. In order to add the user name file matching rule, press the ‘Add’ button, select the ‘Search Files with the User Name’ rule, select an appropriate user name comparison operator and enter the user name pattern string.

The user name comparison operator allows one to find user names matching, beginning with, ending with or containing the specified string pattern. In addition, negative comparison operators are provided as well. User name searches are case insensitive and the entered user name pattern string will match both low case and upper case letters.

7.13

Searching JPEG Images by EXIF Tags

DiskBoss provides a JPEG EXIF tags file matching rule allowing one to search JPEG images by standard and/or custom JPEG EXIF tags. In order to add a JPEG EXIF tags matching rule, press the ‘Add’ button, select the ‘Search JPEG Images with EXIF Tag’ rule, select the JPEG EXIF tag to match, select an appropriate comparison operator and enter the string value to search for.

In addition to the ability to search for standard EXIF tags, users can customize the list of supported EXIF tags adding user-specific custom tags to the product configuration. In order to customize supported EXIF tags, select a JPEG image in the DiskBoss' file navigator, press the right mouse button and select the ‘EXIF Viewer’ menu item. On the EXIF viewer dialog, press the ‘Customize’ button and use the ‘Add’, ‘Edit’, ‘Delete’ buttons to customize the supported JPEG EXIF tags.

75

DiskBoss User Manual

Flexense Ltd.

7.14

Searching Files by Name and Path Length

Not all software products are supporting long file names and sometimes it may be required to find files having long file names. In order to add such a file matching rule, press the ‘Add’ button, select the ‘Search Files with Full Name Length’, select an appropriate comparison operator and enter the length of file name in characters to search for.

7.15

Using Hierarchical File Matching Rules

Nested, hierarchical file matching rules may be very useful when the user needs to find files related to multiple file categories and one or more additional criteria such as a specific file size or modification date.

In order to create a nested rule list, press the right mouse button over the top level rule list and select the ‘Add Nested Rule List’ menu item. On the nested rules dialog, add all the required file matching rules, select an appropriate logical operator and press the ‘Ok’ button. There are no limits on the number of nested levels and the user can create as many nested levels as required.

76

DiskBoss User Manual

Flexense Ltd.

7.16

Conditional File Search Actions, Commands and Notifications
to execute user-defined commands, custom programs, batch files and/or e-mail notifications when a user-specified number of files found in a file order to enable file search actions, open the search operation, select the actions and specify the number of search results that should trigger the

DiskBoss allows one shell scripts or send search operation. In ‘Actions’ tab, enable selected actions.

In order to specify a user-defined file management command to be executed, check the ‘Execute User-Defined Command’ check box and select the required user-defined file management command.

In addition, the user is provided with the ability to execute a custom command, batch file or shell script when the file search operation founds a user-specified number of files. Finally, DiskBoss allows one to send E-Mail notifications with a list of files that were found by the file search operation. Before enabling E-Mail notifications, the user needs to open the options dialog, enable E-Mail notifications and specify an SMTP server name, user name and password to send E-Mail notifications through.

77

DiskBoss User Manual

Flexense Ltd.

7.17

Advanced File Search Options

DiskBoss provides a large number of advanced file search options allowing one to customize and tune file search operations for user-specific needs. The ‘Performance’ tab allows one to intentionally slow-down file search operations in order to minimize the potential impact on running production systems. The ‘Exclude’ tab allows one to exclude one or more subdirectories from the search process.

The ‘Advanced’ tab provides the ability to control the maximum number of search results to display, the file scanning mode, the default report title and enables automatic generation of HTML, XML, text or Excel CSV reports.

7.18

User-Defined File Search Commands

One of the most powerful and flexible capabilities of DiskBoss is the ability to pre-configure custom file search operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – File Search Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the Windows desktop.

78

DiskBoss User Manual

Flexense Ltd.

7.19

Searching Files Using the DiskBoss Command Line Utility

In addition to the DiskBoss GUI application, DiskBoss Ultimate and DiskBoss Server provide power computer users and IT administrators with the ability to execute user-defined file search operations from batch files and shell scripts using the DiskBoss command line utility, which is located in the ‘ProductDir\bin’ directory. Command Line Syntax:

diskboss –execute <Search Command Name> This command executes a user-defined file search operation pre-configured using the DiskBoss GUI application or imported from an XML file.

diskboss -search –rules <XML File Name> -dir <Dir 1> ... [ <Dir X> ] [ <Options> ] This command executes XML search queries defined according to the DiskBoss XML-Based format using input directories and files specified in the command line. For detailed information about the XML format refer to the DiskBoss XML format specification.

Parameters: -dir <Input Directory 1> [ ... <Input Directory X> -file <File 1> … <File X> ] This parameter specifies the list of input directories to process. Options: -save_html_report [ ReportFileName ] This optional parameter instructs DiskBoss to save a summary report and the list of all search results to an external HTML file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_search_[date]_[time].html where [date] and [time] will be substituted by current date and time accordingly. -save_csv_report [ ReportFileName ] This optional parameter instructs DiskBoss to save a summary report and the list of all search results to an Excel CSV file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_search_[date]_[time].csv – just like with the HTML-formatted file. -save_text_report [ ReportFileName ] This optional parameter instructs DiskBoss to save a summary report and the list of all search results to a text report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_search_[date]_[time].txt -file_scanner <sequential or parallel> Specifies the file scanning mode: sequential or parallel. Use the parallel scanning mode when processing multiple input directories. -v This command shows DiskBoss' major version, minor version and revision. -help This command shows the command line usage information.

79

DiskBoss User Manual

Flexense Ltd.

8 Real-Time Disk Change Monitor
8.1 Monitoring Changes in a Disk or Directory

DiskBoss Ultimate and DiskBoss Server include a real-time disk change monitor capable of monitoring one or more disks and directories and detecting file creations, modifications, deletes and attribute changes. The disk change monitor allows one to save HTML, XML, text and Excel CSV reports, send E-Mail notifications and/or execute user-defined file management commands or custom commands when a user-specified number of changes is detected in a disk or directory.

In order to monitor one or more disks or directories, select the required disks or directories in the DiskBoss' file navigator, press the right mouse button and select the ‘Disk Change Monitor’ menu item. On the monitor operation dialog, select the types of file system changes to monitor and press the ‘Start’ button.

The disk change monitoring results dialog shows the detected file system changes and allows one to pause, resume or stop the disk change monitoring operation. In addition, the disk change monitor allows one to categorize and filter changes by the file type, extension, change type, user name, etc. Finally, power computer users and IT administrators are provided with the ability to export HTML, XML, text, CSV reports and submit reports to an SQL database.

80

DiskBoss User Manual

Flexense Ltd.

8.2

Using Change Filters and Categories

The DiskBoss' disk change monitor allows one to categorize and filter detected file system changes by the change type, file type, extension, file size, user name, etc. Use the categories combo box located on the left side of the categories control bar to select an appropriate change categorization mode.

In order to filter changes using one or more change filters, select the required change filters, press the right mouse button and select the ‘Apply Selected Filters’ menu item. The disk change monitor will update the change list and show file system changes matching the selected change filters.

Change filters may be enabled when the disk change monitor is active filtering and displaying matching file system changes in real-time. In order to reset active file filters, just press the ‘Clear’ button located on the right side of the categories control bar.

81

DiskBoss User Manual

Flexense Ltd.

8.3

Saving Disk Change Monitoring Reports

The DiskBoss' disk change monitor allows one to export HTML, XML, text and Excel CSV reports. In order to export a report file press the ‘Save’ button located on the disk monitor results dialog, enter a report title, select an appropriate report format, enter the maximum number of changes to export, enter the report file name and press the ‘Save’ button.

A typical report file includes a summary table showing the report date and time, the total number of file system changes that were detected, the number of changes exported to the report, the change rate, the process time and the status of the change filter. The change categories table shows up to 10 top change categories according to the change categorization mode selected in the disk monitor results dialog. If one or more change filters were selected in the disk monitor results dialog, the selected filters will be highlighted in the categories table and the change list will show changes matching the selected change filters.

The change list displays the detected file system changes. For each change in the list, DiskBoss shows the date and time of the change, the change type and the name of the changed file or directory including the full path.

82

DiskBoss User Manual

Flexense Ltd.

8.4

Exporting Reports to an SQL Database

The DiskBoss' disk change monitor provides IT administrators with the ability to submit disk change monitoring reports from multiple servers and desktop computers to a centralized SQL database allowing one to keep critical files and directories under a strict supervision. In order to submit a disk change monitoring report into an SQL database, press the ‘Save’ button located on the disk monitor results dialog, select the ‘SQL Database’ report format and press the ‘Save’ button.

Before exporting reports to a database, the user needs to open the options dialog, enable the ODBC database interface and specify the ODBC data source name, the database user name and password to use to connect to the database.

The DiskBoss report database dialog displays reports submitted to the database and shows the report date and time, the host name, the input directories that were processed, the total number of files and disk space and the report title. In order to open a report, just click on the report item in the report list.

83

DiskBoss User Manual

Flexense Ltd.

8.5

Monitoring Specific File Types or Categories

Active production systems may have a very high rate of changing files resulting in very long disk change monitoring reports significantly complicating identification of critical file system changes and resulting in additional overhead on running, production systems.

In order to minimize the amount of unimportant file system changes in disk change monitoring reports, open the disk monitor operation dialog and add one or more file matching rules specifying files that should be monitored. During runtime, the disk change monitor will evaluate detected file system changes and just skip all files not matching the specified rules.

8.6

Disk Change Monitoring Actions and E-Mail Notifications

Power computer users and IT administrators are provided with the ability to send E-Mail notifications, save reports, execute user-defined file management commands and/or execute custom commands when a disk change monitoring operation reaches a user-specified number of changes.

In order to enable E-Mail notifications, open the disk monitor operation dialog, specify the number of changes that should trigger the E-Mail notifications and specify an e-mail address to send notifications to. Before enabling E-Mail notifications, the user needs to open the options dialog, select the ‘E-Mail’ tab and specify the SMTP server name, the user name and password to use to send notifications.

84

DiskBoss User Manual

Flexense Ltd.

8.7

Selecting File System Events to Monitor

The DiskBoss' disk change monitor is capable of detecting file creations, modifications, deletes, attribute changes, etc. In order to customize the list of monitored file system events, open the monitor operation dialog, select the ‘General’ tab and select the file system change events that should be monitored.

In addition, the user is provided with the ability to enable/disable monitoring of subdirectories. If the disk change monitor is configured to detect changes in subdirectories, the list of detected file system changes will include all changes starting from the monitored disks and directories and ending in the deepest subdirectories in the monitored file system.

8.8

Customizing Disk Change Monitor View

The disk change monitoring dialog allows one to customize the change list and in addition to the standard columns display the size and owner of created and changed files. In order to customize the change view, press the ‘View’ button located on the dialog’s toolbar and select additional columns that should be displayed.

The file size and the owner may be displayed for changed and modified files, but not for deleted files because file system notifications about deleted files are issued by the operating system after a file was actually deleted and there is no way receive this information about not existing files.

85

DiskBoss User Manual

Flexense Ltd.

8.9

Triggering Custom File Management Operations

One of the most powerful capabilities of DiskBoss is the ability to trigger custom file management operations after a user-specified number of file system changes is detected in one or more disks or directories. This capability may be very effectively used to trigger file synchronization and rule-based file organizing operations on actively used disks and directories automatically keeping files synchronized and/or organized.

In order to trigger a file synchronization or file organizing command from the disk change monitor, create a new disk change monitoring operation, open the operation dialog, select the ‘Actions’ tab, enable disk change monitoring actions, specify the number of file system changes that should trigger the command and select a user-defined file management command to be executed.

8.10

User-Defined Disk Change Monitoring Commands

DiskBoss provides the user with the ability to pre-configure custom disk change monitoring operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – Disk Change Monitoring Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the desktop.

86

DiskBoss User Manual

Flexense Ltd.

8.11

Monitoring Disks Using the DiskBoss Command Line Utility

In addition to the GUI application, DiskBoss Ultimate and DiskBoss Server provide a command line utility allowing one to monitor one or more disks or directories from batch files and shell scripts. The DiskBoss command line utility is located in the ‘<ProductDir>/bin’ directory. Command Line Syntax: diskboss -monitor -dir <Directory 1> [ ... <Directory X> <Options> ] This command monitors the specified disks or directories and displays detected file system changes on the standard output. In addition, the user is provided with the ability to export detected file system changes to HTML, XML, text and Excel CSV reports. diskboss -execute <User-Defined Disk Monitoring Command> This command executes a user-defined disk change monitoring command pre-configured using the DiskBoss GUI application or imported from an XML file. Parameters: -dir <Directory 1> [ ... <Directory X> ] This parameter specifies the list of input directories to process. In order to ensure proper parsing of command line arguments, directories and file names containing space characters should be double quoted. Options: -exclude_dir <Exclude Directory 1> [ ... <Exclude Directory X> ] This parameter specifies the list of directories that should be excluded from the disk change monitoring process. In order to ensure proper parsing of command line arguments, directories containing space characters should be double quoted. -save_html_report [ ReportFileName ] This optional parameter saves an HTML report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_monitor_[date]_[time].html -save_csv_report [ ReportFileName ] This optional parameter saves an Excel CSV report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_monitor_[date]_[time].csv -save_text_report [ ReportFileName ] This optional parameter saves a text report file. If no file name is specified, DiskBoss will automatically generate a file name according to the following template: diskboss_monitor_[date]_[time].txt -v This parameter shows the product’s major version, minor version, revision and build date. -help This parameter shows the command line usage information.

87

DiskBoss User Manual

Flexense Ltd.

8.12

DiskPulse – Dedicated Disk Change Monitoring Solution

In addition to the disk change monitor available in DiskBoss, Flexense provides a much more powerful, dedicated disk change monitoring solution, named DiskPulse, which includes a server-based product version and a database server capable of collecting disk change monitoring reports from multiple servers and desktop computers.

The DiskPulse disk change monitoring solution consists of the following two components: DiskPulse Server and DiskPulse DB Server. In a typical configuration, DiskPulse Server runs in the background as a service on production servers, monitors one or more disks and directories and submits disk change monitoring reports to DiskPulse DB Server through the network.

DiskPulse DB Server receives disk change monitoring reports from multiple production servers and desktop computers, submits all incoming reports to an SQL database, applies report analysis rules and sends E-Mail notifications when critical issues are detected. For more information about DiskPulse refer to: http://www.diskpulse.com

88

DiskBoss User Manual

Flexense Ltd.

9 High-Speed File Synchronization
9.1 Synchronizing a Pair of Directories

DiskBoss provides advanced file synchronization capabilities allowing one to synchronize files between local disks, directories, network shares, NAS storage devices and enterprise storage systems. The DiskBoss' file synchronization engine is capable of synchronizing files using multiple one-way and two-way file synchronization modes, provides performance tuning options, periodic and real-time file synchronization capabilities and allows one to synchronize specific file types and categories.

In order to synchronize a pair of directories, press the ‘Sync’ button located on the main toolbar, enter the source and destination directories and press the ‘Preview’ button. DiskBoss will scan the specified source and destination directories, compare files between the source and destination directories and show a list of file synchronization actions that should be performed.

On the file synchronization preview dialog, review sync actions, select/unselect actions that should be performed and press the ‘Sync’ button to execute the selected file synchronization actions. Optionally, press the ‘Options’ button to control advanced file synchronization options or press the ‘Export’ button to save file synchronization actions to an HTML, XML, text or Excel CSV report. The DiskBoss' file synchronization engine is especially optimized for modern hardware and storage devices and is capable of effectively utilizing RAID storage devices, multi-core/multi-CPU systems and Gigabit networks delivering maximum possible performance.

89

DiskBoss User Manual

Flexense Ltd.

9.2

Selecting File Synchronization Mode

Depending on specific needs, it may be required to perform different types of file synchronization operations. For example, sometimes users may be interested in keeping all files in the destination directory even when some of them were deleted from the source directory. Another option is to perform two-way accumulation and update keeping both directories completely identical. DiskBoss provides eight different one-way and two-way file synchronization modes allowing one to perform different types of file synchronization operations according to user-specific needs and requirements.

In order to change the file synchronization mode for a file synchronization command, open the file synchronization command dialog, select the 'General' tab and select one of the following file synchronization modes: • Synchronize Destination Directory (one-way) - All changes made in the source directory will be propagated to the destination directory. Files deleted from the source directory will be deleted from the destination directory. All files changed or deleted in the destination directory will be restored using files from the source directory. No changes will be made in the source directory. After the file synchronization process is complete both locations will be identical. Update Destination Directory (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No changes will be made in the source directory. Accumulate and Update Files in Destination (one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No files will be deleted from the destination directory. No changes will be made in the source directory. Two-Way File Synchronization - Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored from the source directory. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. Two-Way Accumulation and Update - Newly created and modified files will be updated in both directions. Files deleted from one location will be restored from the second location. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical.

The last three file synchronization modes are identical to the first three modes, but the last three modes are saving compressed files in the destination directory.

90

DiskBoss User Manual

Flexense Ltd.

9.3

Synchronizing Files with Preview

File synchronization with preview is very useful providing the user with a clear picture about what files will be synchronized. By default, DiskBoss synchronizes directories with preview, but the user is provided with the ability to disable the preview mode and synchronize all the required files on-the-fly without showing the preview dialog.

9.4

Synchronizing Files without Preview

Sometimes, when the user needs to synchronize large directories or disks containing many thousands of files, file synchronization with preview may be ineffective or completely inappropriate especially due to the fact that none will have the time to review lists of file synchronization actions containing huge amounts of items. Moreover, unattended file synchronization operations performed periodically at specific time intervals or triggered by a disk change monitor, should be performed fully automatically without requiring any user intervention.

In order to disable the preview dialog for a file synchronization operation, open the operation dialog and set the process mode combo box to ‘Sync Without Preview’. The stream file synchronization more is especially designed for file systems containing huge amounts of files and is capable of synchronizing large directories, disks and NAS storage devices very fast and effectively. In addition, the stream file synchronization mode is ideal for automated, periodic file synchronization operations performed in the background without any user intervention.

91

DiskBoss User Manual

Flexense Ltd.

9.5

Synchronizing Specific File Types or Categories

DiskBoss Ultimate and DiskBoss Server provide power computer users and IT administrators with the ability to synchronize specific file types or file categories using one or more flexible file matching rules. For example, the user may specify to synchronize documents and digital images with the file size more than 2 MB.

In order to add one or more file matching rules, open the file synchronization command dialog, select the 'Rules' tab and press the 'Add' button. On the 'Rules' dialog select an appropriate rule type and specify all the required parameters. During file synchronization, DiskBoss will scan the entered source and destination directories and apply the specified file matching rules to all the existing files. Files not matching the specified rules will be just skipped from the file synchronization process.

9.6

Excluding One or More Subdirectories

Sometimes, it may be required to exclude one or more subdirectories from the file synchronization process. For example, if you need to synchronize two directories excluding one or two special subdirectories, you may specify the top level directories as the source and destination directories and add the subdirectories that should be skipped to the exclude list.

In order to add one or more directories to the exclude list, open the file synchronization command dialog, select the 'Exclude' tab and press the 'Add' button. Keep in mind that exclude directories are case sensitive and should be specified with the same case as stored on the disk. All files and subdirectories located in the specified exclude directories will be excluded from the file synchronization process. Select an exclude directory and press the 'Delete' button, to remove the selected directory from the exclude list.

92

DiskBoss User Manual

Flexense Ltd.

9.7

File Synchronization Performance Tuning Options

In order to increase file synchronization performance, DiskBoss provides advanced computer users and IT professionals with the ability to synchronize files using multiple file synchronization streams. Multi-Stream file synchronization significantly improves file synchronization performance when synchronizing large amounts of files between multiple disks, NAS storage devices or enterprise storage systems.

In order to enable multi-stream file synchronization for a sync command, open the command dialog, select the 'Performance' tab and set an appropriate number of file synchronization streams. Take into account that multi-stream file synchronization is optimized for multi-disk, RAID and networked configurations and it is not recommended to use it when synchronizing directories located on the same physical disk. In addition, users required to synchronize files on running, production systems are provided with the ability to execute file synchronization commands slowly thus minimizing the performance impact on running applications. In order to change the speed of a file synchronization command, select an appropriate performance mode in the 'Performance Mode' combo box.

9.8

User-Defined File Synchronization Commands

DiskBoss provides the user with the ability to pre-configure custom file synchronization operations as user-defined commands and execute such commands in a single mouse click using the DiskBoss GUI application or direct desktop shortcuts.

User-defined commands may be managed and executed through the commands dialog or the commands tool pane. In order to add a new command through the commands pane, press the right mouse button over the pane and select the ‘Add New – File Synchronization Command’ menu item. In order to execute a previously saved command, just click on the command item in the commands tool pane or create a direct desktop shortcut on the desktop.

93

DiskBoss User Manual

Flexense Ltd.

9.9

Periodic File Synchronization

Sometimes, it may be required to execute a file synchronization operation periodically at specific time intervals. The first option to do that is to configure a periodic job in the DiskBoss GUI application and select the required file synchronization command to be executed periodically. Another option is to use DiskBoss Server, which runs as a service in the background and may be used to periodically execute file synchronization operations in a fully automatic, unattended mode.

In order to add a new periodic job, select the ‘Tools – Manage Periodic Jobs’ menu item and press the ‘Add’ button. On the periodic job dialog, select the file synchronization command that should be executed and specify the time period.

9.10

Real-Time File Synchronization

DiskBoss Ultimate and DiskBoss Server provide the ability to monitor one or more disks or directories and automatically execute a file synchronization operation after a user-specified number of changes is detected.

In order to execute a file synchronization command using the DiskBoss' disk change monitor, create a new disk change monitoring command, specify one or more disks or directories that should be monitored, select the ‘Actions’ tab, specify the number of disk changes that should trigger the file synchronization command and selected the name of the file synchronization command that should be executed once the disk change monitor reaches the specified number of changes.

94

DiskBoss User Manual

Flexense Ltd.

9.11

Synchronizing Files Using the DiskBoss Command Line Utility

In addition to the GUI application, DiskBoss Ultimate and DiskBoss Server provide a command line utility allowing one to execute file synchronization commands form batch files and shell scripts. The command line utility is located in the ‘<ProductDir>/bin’ directory.

Command Line Syntax:

diskboss -sync -source <Source Directory> -dest <Dest Directory> This command synchronizes files between directories, local disks or network shares. diskboss –execute <File Synchronization Command> This command executes the specified user-defined file synchronization command preconfigured using the DiskBoss GUI application or imported from an XML file.

Parameters: -source <Source Directory> This parameter specifies the source directory for file synchronization. In order to ensure proper parsing of command line arguments, directories and file names containing space characters should be double quoted. -dest <Destination Directory> This parameter specifies the destination directory for file synchronization. In order to ensure proper parsing of command line arguments, directories and file names containing space characters should be double quoted.

Options: -sync_mode <SD | SUD | SAD | STW | STA> SD - Sets the sync-destination file synchronization mode (Default) All changes made in the source directory will be propagated to destination. Files deleted from the source directory will be deleted from destination. All files changed or deleted in destination will be restored from source. SUD - Sets the update-destination file synchronization mode Newly created and modified source files will be copied to destination. Files deleted from the source directory will be deleted from destination. Files deleted from the destination directory will be restored from source. SAD - Sets the accumulate-destination file synchronization mode Newly created and modified source files will be copied to destination. Files deleted from the destination directory will be restored from source. Newly created and modified destination files will be kept in place. STW - Sets the two-way file synchronization mode Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from destination. Files deleted from the destination directory will be restored from source.

95

DiskBoss User Manual

Flexense Ltd.

STA - Sets the two-way accumulate file synchronization mode Newly created and modified files will be updated in both directions. Files deleted in one location will be restored from the second location. After finishing the synchronization process both locations will be identical. -streams <StreamCount> This parameter specifies the number of simultaneous file synchronization streams. -file_delay <delay in milliseconds> This parameter sets the file delay to the specified value in milliseconds. Use this option when you need to slowly synchronize files to or from a busy production system in order to minimize the potential performance degradation. -block_delay <delay in milliseconds> This parameter sets the block delay to the specified value in milliseconds. Use this option when you need to slowly synchronize files to or from a busy production system in order to minimize the potential performance degradation. -copy_dacl This parameter instructs to copy files' access control lists (DACL). -copy_sacl This parameter instructs to copy files' security control lists (SACL). -copy_owner This parameter instructs to copy files' user/group information. -v This command shows the product’s major version, minor version, revision and build date. -help This command shows the command line usage information.

96

DiskBoss User Manual

Flexense Ltd.

9.12

SyncBreeze – Dedicated File Synchronization Solution

In addition to the file synchronization capabilities available in DiskBoss, Flexense develops a dedicated file synchronization solution, named SyncBreeze, which provides multiple, advanced file synchronization features including periodic synchronization, multi-way file synchronization, real-time file synchronization, tertiary destination directories and much more.

Users are provided with multiple product versions ranging from an easy-to-use, free version to an advanced server-based product version, which runs in the background as a service and is capable of synchronizing a number of disks, network shares or NAS storage devices in a fully automatic and unattended mode.

A number of SyncBreeze servers may be managed through the network using a free, network client GUI application capable of configuring and controlling file synchronization operations across the entire network. In addition, IT administrators are provided with a command line utility allowing one to control file synchronization operations from batch files and shell scripts enabling integrations of file synchronization capabilities into other products and solutions. For more information about SyncBreeze refer to: http://www.syncbreeze.com

97

DiskBoss User Manual

Flexense Ltd.

10 Fault-Tolerant File Copy and Data Migration
10.1 Copying Files Using DiskBoss GUI Application

DiskBoss provides a large number of advanced multi-stream file copy and rule-based data migration capabilities allowing one to copy vast amounts of files fast, efficiently and reliably. DiskBoss allows one to copy files including access control lists (ACLs), security attributes, ownership information, timestamps and file attributes. In addition, the user is provided with a large number of flexible copy performance tuning and fault tolerance options allowing one to copy data at various speeds, recover failed copy operations and minimize the potential impact on running production systems.

In order to start a simple file copy operation, select one or more files or directories, press the standard ‘Ctrl-C’ keyboard sequence, navigate to the destination location and press the ‘Ctrl-V’ keyboard sequence. If you wish to perform a regular copy operation using default parameters, just press the ‘Copy’ button and wait for the operation to complete. During the copy process, DiskBoss will display the copy progress dialog showing the total number of copied files, the total amount of copied storage space and the copy performance.

Copying vast amounts of data may require significant amounts of time. Sometimes, in order to perform an urgent operation, one may need to temporary pause a long-running data migration operation. Press the ‘Pause’ button to temporary suspend an ongoing file copy operation and press the ‘Continue’ button to resume the operation. Press the ‘Stop’ button to cancel an ongoing file copy operation.

98

DiskBoss User Manual

Flexense Ltd.

When copying files from/to protected operating system directories or running production systems, some copy operations may fail due to one or more files locked by the operating system or other running applications. By default, DiskBoss logs non-critical errors in the operation log, which is accessible by pressing the ‘Errors’ button, and continues the file copy operation. In addition, DiskBoss Professional and DiskBoss Ultimate provide the user with advanced fault-tolerance and recovery options allowing one to retry failed copy operations after a designated period of time.

Frequently used file copy or data migration operations may be customized for user-specific needs, pre-configured as user-defined commands and executed in a single mouse click using DiskBoss' main GUI application or direct desktop shortcuts. In addition, DiskBoss Ultimate and DiskBoss Server provide a command line tool allowing one to execute user-defined file copy commands from batch files and shell scripts or schedule periodic file copy operations using a general purpose command scheduler.

10.2

Copying Specific File Types or Categories

Sometimes, it may be required to copy or move files matching one or more user-specific criteria. For example, for backup purposes, the user may with to copy documents that were modified during the last month or any other user-specific criteria.

DiskBoss Ultimate and DiskBoss Server provide the user with the ability to copy files matching one or more user-defined criteria. In order to add one or more file matching rules, open the copy command dialog, select the ‘Rules’ tab and press the 'Add' button. Select an existing file matching rule and press the 'Delete' button to remove the selected file matching rule. If no rules are specified, DiskBoss will copy all files in the specified source disks and directories.

99

DiskBoss User Manual

Flexense Ltd.

10.3

Advanced File Copy and Data Migration Options

In order to open the advanced copy and data migration options dialog, press the ‘Advanced Options’ button located on the copy dialog. The options dialog consists of the ‘General’ tab, the ‘Rules’ tab, the ‘Performance’ tab and the ‘Error Handling’ tab.

The ‘General’ tab allows one to control the following parameters: • • Overwrite Mode – the overwrite mode may be set to one of the following values: overwrite and continue, overwrite if the source file is newer, skip, and generate a unique file name. Copy DACL – this parameter instructs DiskBoss to copy discrete access control lists (DACL) from source files to destination files. Take into account that this option requires administrative privileges. This specific option is not available in DiskBoss Express. Copy SACL – this parameter instructs DiskBoss to copy security control lists (SACL) from source files to destination files. Take into account that this option requires administrative privileges. This specific option is not available in DiskBoss Express. Copy User/Group – this parameter instructs DiskBoss to copy file ownership information from source files to destination files. Take into account that this option requires administrative privileges. This specific option is not available in DiskBoss Express. Copy Timestamp – this parameter instructs DiskBoss to copy file access, creation and modification times from source files to destination files. Copy Attributes – this parameter instructs DiskBoss to copy file attributes from source files to destination files. If this parameter is not set, all files will be created with default attributes. Show Progress – this parameter allows one to enable/disable the progress bar on the copy process dialog. Disabling the progress bar when copying large amounts of files will result in better performance and significantly shorter copy times. Verify After Copy – this parameter instructs DiskBoss to verify each file after completing the copy operation. When this parameter is set, DiskBoss will reread each copied file and verify that the destination file is identical to the source file. Take into account that this option will significantly decrease the copy performance and increase the overall copy time.

• •

• • • •

The ‘Performance’ tab provides the user with the ability to optimize file copy and data migration operations for user-specific storage configurations and performance requirements. DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of copying files using multiple, simultaneous data streams. During runtime, DiskBoss analyzes copied files and applies different scheduling policies for different types of files thus maximizing the copy performance and minimizing the copy time. In order to speed up the file copy process, use multiple copy streams when copying files located on multiple physical hard disks or a RAID disk array.

100

DiskBoss User Manual

Flexense Ltd.

10.4

Copying Files Using the DiskBoss Command Line Utility

In addition to the GUI application, DiskBoss Ultimate and DiskBoss Server provide a command line tool allowing one to perform file copy and move operations from batch files and shell scripts. The DiskBoss command line tool is located in the ‘<ProductDir>/bin’ directory. Command Line Syntax:

diskboss -copy –dir <Source 1> [ ... <Source X> ] –dest <Destination> [ <Options> ] diskboss -move –dir <Source 1> [ ... <Source X> ] –dest <Destination> [ <Options> ]

Parameters: –dir <Source> -dest <Destination Directory> At least one source file or directory and a destination directory should be specified. In order to ensure proper parsing of command line arguments, directories and file names containing space characters should be double quoted.

Options:

-verify This parameter instructs DiskBoss to verify each file after copy. -streams <StreamCount> This parameter specifies the number of simultaneous file copy streams. -file_scanner <sequential or parallel> This parameter specifies the file scanning mode: sequential or parallel. Use the parallel scanning mode when copying multiple input directories located on a RAID array or multiple disk drives. -file_delay <delay in milliseconds> This parameter instructs the DiskBoss' copy engine to insert a delay of X ms. after each copied file. Use this option when you need to slowly copy data to or from a busy production system in order to minimize the potential performance degradation. -block_delay <delay in milliseconds> This parameter instructs the DiskBoss' copy engine to insert a delay of X ms. after each data block. Use this option when you need to slowly copy data to or from a busy production system in order to minimize the potential performance degradation. -retry_count <RetryCount> This parameter instructs the DiskBoss' copy engine to retry failed copy operations. Use this option when copying data over an unreliable network connection or when some source files may be locked during the copy operation. -retry_delay <retry delay in seconds> This parameter specifies the time delay between copy retry operations.

101

DiskBoss User Manual

Flexense Ltd.

-max_pending_task <MaxPendingTask> This parameter specifies the maximum number of pending retry operations. -overwrite_mode <OverwriteMode> This parameter specifies the file overwrite mode: overwrite, overwrite_if_newer or skip. -copy_dacl This parameter instructs to copy files' access control lists (DACL). -copy_sacl This parameter instructs to copy files' security control lists (SACL). -copy_owner This parameter instructs to copy files' user/group information. -copy_time This parameter instructs to copy files' last access/write/creation times. -copy_attr This parameter instructs to copy files' read-only/system/hidden attributes. -copy_all This parameter instructs to copy files' ACL, ownership, times and attributes. -v This command shows the product’s major version, minor version, revision and build date. -help This command shows the command line usage information.

102

DiskBoss User Manual

Flexense Ltd.

11 File Delete and Data Wiping Operations
11.1 Deleting Files Using DiskBoss GUI application

DiskBoss provides the user with a large number of flexible file delete capabilities allowing one to delete huge amounts of files very fast and effectively. In addition, power computer users and IT professionals are provided with the ability to optimize performance of delete operations for user-specific storage configurations and performance requirements. Finally, users required to physically destroy confidential or classified information are provided with numerous multipass data wiping capabilities ranging from a simple single-pass wipe to a powerful, 7-Pass DOD 5220.22-M compliant data wiping algorithm.

In order to start a simple file delete operation, select one or more files or directories and press the ‘Delete’ key. If you wish to perform a regular delete operation using default parameters, just press the ‘Delete’ button and wait for the operation to complete. During the delete process, DiskBoss will display the delete progress dialog showing the total number of deleted files, the total amount of deleted storage space and the performance of the delete operation.

Deleting vast amounts of files may require a significant amount of time. Sometimes, in order to perform an urgent operation, one may need to temporary pause a long-running delete operation. Press the ‘Pause’ button to temporary suspend an ongoing operation and press the ‘Continue’ button to resume the operation. Press the ‘Stop’ button to cancel an ongoing file delete operation. When deleting files from protected operating system directories or running production systems, some delete operations may fail due to one or more files locked by the operating system or other running applications. By default, DiskBoss logs non-critical errors in the operation log and continues the file delete operation. Press the ‘Errors’ button to see all failed delete operations.

103

DiskBoss User Manual

Flexense Ltd.

11.2

Advanced File Delete and Data Wiping Options

In order to open the advanced delete and data wiping options dialog, press the ‘Advanced Options’ button located on the delete dialog. The options dialog consists of the ‘General’ tab, the ‘Rules’ tab and the ‘Performance’ tab.

• •

Show Delete Progress – this parameter allows one to enable/disable the progress bar on the delete process dialog. Disabling the progress bar when deleting large amounts of files will result in better performance and significantly shorter delete times. Wipe Data From Disk – check this option and select an appropriate data wiping algorithm to physically wipe data from the disk. Complex, multi-pass data wiping algorithms are overwriting files multiple times using specially designed data patterns. Take into account that deleting files with data wiping, especially using complex, multipass algorithms, will result in a significantly lower performance and will require significant amounts of time. File Scanning Mode – DiskBoss is capable of deleting files located in multiple directories/disks in parallel thus improving the speed of the delete process on multiCPU/multi-core systems. Select the 'Parallel' file scanning mode if you wish to delete files in all input directories simultaneously. File Scanning Filter – Sometimes, users need to delete a subset of files meeting one or more user-specific requirements. For example, one may need to delete documents only. In this case, set the file scanning filter to '*.doc' (MS Word Documents) and DiskBoss will delete document files only

11.3

Deleting Specific File Types or Categories

The 'Rules' tab provides the user with the ability to delete files matching one or more userdefined criteria. For example, one may wish to delete all types of documents that were not accessed during the last year. In order to add one or more file matching rules, select the ‘Rules’ tab and press the 'Add' button.

104

DiskBoss User Manual

Flexense Ltd.

11.4

Deleting Files Using the DiskBoss Command Line Utility

In addition to the GUI application, DiskBoss Ultimate and DiskBoss Server provide a command line tool allowing one to perform file delete operations from batch files and shell scripts. The DiskBoss command line tool is located in the ‘<ProductDir>/bin’ directory. Command Line Syntax:

diskboss -delete <Input 1> [ ... <Input X> <Options> ] This command deletes the specified files and directories.

diskboss –execute <User-Defined File Delete Command> This command executes the specified user-defined file delete command.

Parameters: -delete <File or Directory> At least one file or directory should be specified. In order to ensure proper parsing of command line arguments, directories and file names containing space characters should be double quoted. Options: -wipe This parameter instructs to wipe data from the disk. -confirm Explicitly confirms delete operation. -workers <ThreadCount> This parameter specifies the number of working threads. -v This parameter shows the product’s major version, minor version, revision and build date. -help This parameter shows the command line usage information.

105

DiskBoss User Manual

Flexense Ltd.

12 DiskBoss GUI Application
12.1 File Management and Navigation

DiskBoss is integrated around a unique file navigator providing file type coloring, a customizable detailed view, a thumbnail view, user-selectable tool panes, file system location bookmarks and advanced file filters. The DiskBoss' built-in file navigator allows one to execute any required operation in a single mouse click. Just select one or more files, directories or disks and press a command button on the main toolbar to start the file classification, storage utilization analysis, data migration or duplicate files identification process.

The DiskBoss' built-in file navigator provides the following file view modes: the list view mode, the icon view mode, the detailed view mode and the thumbnail view mode. In the thumbnail view mode, DiskBoss supports the following image formats: JPEG, GIF, PNG, BMP, TIFF, PBM, PGM, PPM, XBM, and XPM. In the detailed view mode, DiskBoss allows one to customize columns, define user-specific file types and edit the display style for each of them. For example, files having the extension 'EXE' may be displayed as 'Programs' using a bold font on the yellow background. All customizations are saved in the user configuration file and may be exported for backup purposes or transferred to another computer by using the DiskBoss' configuration export/import capabilities. In addition, the detailed view mode provides the user with the ability to sort files by the file name, type, size, creation time, last modification time or last access time. In order to sort files, just click on an appropriate column header. When the user clicks on a column header for the first time, all the files are sorted in the ascending order. To sort files in the descending order, click on the same column header for the second time.

106

DiskBoss User Manual

Flexense Ltd.

12.2

DiskBoss GUI Layouts

In order to improve GUI usability and facilitate specific file management tasks, the DiskBoss main GUI application provides four user-selectable GUI layouts. Press the ‘Layouts’ button to switch the GUI application to the next GUI layout. The first GUI layout places tool panes on the bottom side of the file view.

The second GUI layout places tool panes on the left side of the file view. The third GUI layout places tool panes on the right side of the file view. Finally, the fourth GUI layout places the first tool pane on the right side of the file view and the second tool pane on the bottom side of the file view.

107

DiskBoss User Manual

Flexense Ltd.

12.3

User-Defined Commands

DiskBoss is a powerful and flexible product providing a large number of features, capabilities and configuration options allowing one to perform many different file and storage management operations. In order to simplify management and execution of frequently used operations, DiskBoss provides the user with the ability to add user-defined commands. All major product features such as file search, classification, organizing, synchronization, copy, move, delete, storage utilization analysis, duplicate files search and disk monitoring may be added as user-defined commands and pre-configured for user-specific needs and custom hardware configurations.

In order to add and a new command, select the ‘user-defined commands’ tool pane, click the right mouse button, select the ‘Add’ menu and select the required command type. All command types require the user to specify one or more directories or files to be processed. In addition, depending on the command type, command-specific dialog will be displayed and the user will be provided with the ability to control all the command-specific options. Once added, a user-defined command will be saved in the DiskBoss user’s configuration and displayed in the user-defined commands tool pane. In order to manage user-defined commands, select the ‘User-Defined Commands’ tool pane, select the required command, click the right mouse button and select one of the following operations: • • • Edit Command – use this feature to edit a previously created user-defined command. Depending on the command type, DiskBoss will show all the required dialog and the user will be provided with the ability to control all the command-specific options. Execute Command – use this feature to execute the selected user-defined command. Alternatively, just click on a command in the user-defined commands list. Create Desktop Shortcut – use this feature to create direct desktop shortcuts for frequently used commands. Commands started using desktop shortcuts are executed without the DiskBoss GUI application. For example, after clicking on a desktop shortcut pointing to a user-defined search command, the user will see the search dialog only and not the full DiskBoss GUI application. Rename Command – use this feature to rename an existing user-defined command. DiskBoss will show an entry dialog and the user will be provided with the ability to specify a new command name. Move Command Up – use this feature to move frequently used commands to the beginning on the command list. Move Command Down – use this feature to move less frequently user commands to the end of the command list. Delete Command – use this feature to delete unused commands.

• • • •

108

DiskBoss User Manual

Flexense Ltd.

In addition, DiskBoss allows one to write user-defined commands using an open XML-Based format. The XML-Based format provides support for all features and capabilities available in the DiskBoss GUI application and allows one to import custom user-defined commands to the product configuration. Finally, DiskBoss Ultimate allows one to execute XML-Based userdefined command on-the-fly using the DiskBoss command line tool. Any user-defined command may be executed in three different ways: in DiskBoss' main GUI application, as a standalone GUI tool and using DiskBoss' command line tools. In order to execute a user-defined command in DiskBoss' main GUI application, select the user-defined commands tool pane and click on the command item in the commands list. DiskBoss will load the user-defined command and execute it in the main GUI application showing all the required GUI windows and dialogs according to the information saved in the user-defined command.

A more effective way to execute frequently used commands is to add command shortcuts to the Windows desktop. In order to do that, select the user-defined commands tool pane, press the right mouse button over the required command and select the ‘Add Desktop Shortcut’ menu item. DiskBoss will create a desktop shortcut with the same file name as the command’s name. In order to execute such a command, just click on the command shortcut on the Windows desktop. When executing user-defined commands using desktop shortcuts, DiskBoss will open a command-specific process dialog that will perform all the required operations and terminate after the user will press the ‘Close’ button.

Advanced Commands Management DiskBoss provides the user with an advanced user-defined commands GUI management interface allowing one to manage and execute user-defined commands more effectively. To open advanced user-defined commands management dialog, select the menu “Tools – Manage Commands”. In addition to the features available in the user-defined commands tool pane, the commands management dialog provides commands search and filters, user-defined command copy, command import/export capabilities and user-defined command shortcuts. For each user-defined command, the commands management dialog displays the command name, a user-selected command shortcut and the command type. In order to find a specific user-defined command, enter all or a part of the command name in the search entry and press the ‘Search’ button. Alternatively, select a specific command type in the command filter to show commands of a specific type only. For example, select the ‘View Search Commands’ filter to see search commands only. The command type filter may be user in conjunction with the command search capability. In order to reset search results and the command type filter, press the ‘Clear’ button and the command management dialog will show all the defined commands.

109

DiskBoss User Manual

Flexense Ltd.

In order to add a new user-defined command, press the ‘Add’ button and select an appropriate command type. On the command inputs dialog add one or more directories or files that should be processed and press the ‘Next’ button. A typical command dialog shows command specific features and options depending on the selected command type. For detailed information about how to use a specific command refer to an appropriate section in the DiskBoss product manual. Select a user-defined command and press the ‘Edit’ button to edit the selected user-defined command. Select one or more user-defined commands and press the ‘Delete’ button to delete all the selected commands. Select a user-defined command and press the ‘Up’ or ‘Down’ buttons to change the position of a command in the command list. Use this feature to move more frequently used commands to the beginning of the command list. All changes made in user-defined commands will take effect in both command management interfaces - the userdefined commands management dialog and the user-defined commands tool pane. Sometimes, when you have a working user-defined command and need to create a slightly modified or customized version of the command, it will be very helpful to copy the existing command and make all the required changes in the command’s copy. In order to copy a userdefined command, select the command item, press the ‘Copy’ button and enter a new command name. DiskBoss will create a new command, copy all the setting and options from the original command and save the new command to the user’s configuration file. Another useful feature is the ability to import/export user-defined commands to/from different DiskBoss installations. In order to export one or more user-defined commands, select all the required command items, press the right mouse button, select the ‘Export Commands’ menu item and select a destination directory where all the selected commands should be exported to. In order to import previously exported commands, press the right mouse button, select the ‘Import Commands’ menu item and select all the command files that should be imported. Take into account that these features are available in DiskBoss Ultimate only and there is no ability to import/export commands to/from DiskBoss Express or DiskBoss Professional. In order to execute a user-defined command directly from the commands management dialog, select the command item and press the ‘Execute’ button. DiskBoss will load the user-defined command and execute it in the main GUI application showing all the requiring GUI windows and dialogs according to the information saved in the user-defined command. In order to create a desktop shortcut for a command, select the command item, press the right mouse button and select the ‘Create Desktop Shortcut’ menu item. DiskBoss will create a desktop shortcut with the same file name as the command’s name. In order to execute such a command, just click on the command shortcut on the Windows desktop. Finally, DiskBoss Ultimate allows one to associate custom keyboard shortcuts with userdefined commands. In order to set a keyboard shortcut for a user-defined command, select the command item in the command list, press the right mouse button and select the ‘Set Keyboard Shortcut’ menu item. On the ‘Customize Keyboard Shortcut’ dialog select an available keyboard sequence and press the ‘Ok’ button. Now, you can execute the userdefined command by pressing the selected keyboard shortcut. In addition to the GUI application, the DiskBoss Ultimate edition provides a command line tool allowing one to use all features of DiskBoss from an OS shell window. The DiskBoss command line tool provides power users and system administrators with the ability to automate the file management operations and to integrate DiskBoss features into batch files and shell scripts. The DiskBoss command line tool is located in <ProductDir>/bin directory.

diskboss.exe -execute <Command Name> or <XML File Name>

This command executes user-defined commands using input directories, files and all configuration options saved in the specified user-defined command. In addition, DiskBoss Ultimate allows one to directly execute user-defined commands written according to the DiskBoss XML-Based format. For detailed information about the XML format refer to the section 13 in this document.

110

DiskBoss User Manual

Flexense Ltd.

12.4

Task Management

DiskBoss allows one to execute multiple file management operations simultaneously. Multiple simultaneous file management operations may be started, stopped, paused or resumed according to user’s specific needs. For example, the user is provided with the ability to suspend a long running operation, execute an urgent task and after that resume the previously paused long running operation. When starting multiple file management operations, DiskBoss allows one to submit all tasks to the tasks queue or execute all tasks simultaneously.

Press, the ‘Submit’ button to add the new operation to the task queue. In this case all started operations will be executed sequentially, one after one without interfering with each other. If you wish to execute multiple operations on numerous disks or storage devices simultaneously, press the ‘Start Now’ button. The ‘Tasks’ button (located on the main toolbar) allows one to access the task management dialog, which provides a number of task management capabilities. Select one or more running tasks and press the ‘Pause’ button to pause all the selected tasks. Select one or more previously paused tasks and press the ‘Continue’ button to resume all the selected tasks. Select one or more running (or paused) tasks and press the ‘Stop’ button to cancel all the selected tasks. Click on a task item in the tasks view to open the task’s status dialog. If the task has been completed, DiskBoss will open the results dialog.

In addition to the ability to start/stop multiple tasks, DiskBoss Ultimate provides the user with the ability to dynamically control the speed of any running operation thus allowing one to slow down or speed-up long running operations according to specific needs. Select a running task, press the right mouse button and select the ‘Performance’ menu item to set a custom performance mode for the selected task. The same may be achieved using the ‘Speed’ button located on all types of process dialogs.

111

DiskBoss User Manual

Flexense Ltd.

12.5

Built-In Disk Cleaner

All web browsers and many popular online applications are using the local hard disk to cache web pages, images and video files. Information from visited web sites is stored in your Web browser’s cache, wasting your storage space and compromising your privacy. In general, it is a good practice to cleanup your disk once a month. DiskBoss includes a built-in disk cleaner allowing one to cleanup the disk and reclaim the wasted storage space.

Press the ‘Cleanup’ button to launch the DiskBoss' built-in disk cleaner. DiskBoss will scan the system hard drive and show the user all detected cache, history and temporary files. During the initial scanning process, DiskBoss just scans the disk and discovers what files may be safely deleted. After finishing the scanning process, DiskBoss indicates all detected file categories and provides the user with the ability to select the file categories that should be cleaned-up. By default, DiskBoss' built-in disk cleaner selects Internet cache files, Interned history and temporary files to be deleted. The user is provided with the ability to select one of the following automatic cleanup modes: ‘Safe’, ‘Normal’ and ‘All’. In the safe mode, DiskBoss will cleanup Internet cache and Internet history files only. In the normal mode, DiskBoss will delete Internet cache files, Internet history file, temporary files and deleted files. In the ‘All’ cleanup mode, DiskBoss will delete files related to all categories including Internet cookies. Alternatively, the user is provided with the ability to select specific file categories manually. Select any number of file categories and press the ‘Cleanup’ button. DiskBoss will delete all the selected file categories and free-up the wasted storage space.

12.6

User-Selectable Tool Panes

The bottom part of the DiskBoss main GUI application includes two user-selectable tool panes. Each of them may be selected to display bookmarks, file filters, user-defined commands, the local disks status view or the system status view. File Filters - More and more files are stored in modern computers. A simple Windows-based computer with a number of software products may include 50,000 - 100,000 files. More advanced computer users and professionals may have as much as 100,000 - 200,000 files in their personal computers. Almost everyone has tried to find a file in a directory that contains a couple of thousand files. Although it is possible to search for a file by pressing on the key representing the first letter in the file name, sometimes it is still difficult to find the required file in a file-crowded directory.

112

DiskBoss User Manual

Flexense Ltd.

Another issue that bothers advanced computer users is how to perform various file management operations on a number of files in a directory selected according to a specific criteria. Using the current version of the Windows Explorer the user will need to select all the required files manually, which may be a really tedious task if you need to deal with hundreds of files.

To help users to deal with large amounts of files in directories, DiskBoss introduces advanced files filtering capabilities. For each opened directory, DiskBoss analyzes existing files and automatically builds a list of filters allowing one to select a specific file type to be displayed. The filters view is located in the bottom-right corner of the DiskBoss main GUI application. For each file type in the current directory, DiskBoss displays the number of files and the total storage space consumed by all files related to the file type. In order to see files related to a specific file type, just select the required filter in the filter view. To reset the current view and to see all files in the current directory, select the 'Show All' item in the filter view. Bookmarks - Overtime disks are getting larger and larger and we are storing more and more files, documents, songs and movies. Some computers are equipped with multiple hard drives and many regular computer users are beginning to use network drives to share files between computers on the home network. Business needs are much more demanding requiring computer professionals to design complex file hierarchies and directory structures for specific business needs. We have are now in a situation where we need to remember much information about the location of various programs, documents, reports, songs, videos, etc. The DiskBoss' built-in file navigator includes a simple and flexible solution allowing one to save an unlimited number of file system locations in a dedicated bookmarks view and to switch between them in a single mouse click.

To add a new file system bookmark, browse to the required directory and press the 'Bookmark' button on the main GUI toolbar. On the add bookmark dialog specify a unique bookmark name and press the 'Ok' button. The bookmarks view is located in the bottom-left corner of the DiskBoss main GUI application. During installation, DiskBoss automatically adds bookmarks for 'Computer Home', 'My Documents' and all local hard drives installed in the computer. To jump to a previously bookmarked directory, just select a bookmark name in the bookmark view. Disk List - The local disks status view lists all the local disks as defined in the OS configuration. For each disk DiskBoss displays the drive letter, the total disk size and the amount of free storage space. Click on a disk item to see more detailed information about the disk. System Status - The system status view shows a summary system status including the current CPU usage, the system memory status and the system disk status.

113

DiskBoss User Manual

Flexense Ltd.

12.7

DiskBoss Options

Select the ‘Tools – DiskBoss Options’ menu item to open the options dialog.

The ‘General’ tab allows one to control the following options: • • • • • • • • • Show Main Toolbar – Enables/Disables the main toolbar Show Navigation Bar – Enables/Disables the navigation bar Show Directories’ Buttons on Navigation Bar – Enables/Disables directories’ buttons on the navigation bar Show Delete Confirmation Dialog - select this option to show delete confirmation dialog. Close Successfully Completed Operations – select this option to automatically close successfully completed file copy, move and delete operations. Automatically Check For Product Updates – select this option to instruct DiskBoss to automatically check for available product updates. Use Internal Image Viewer – select this option to use the DiskBoss' built-in image viewer as the default image viewer. Copy File Attributes – select this option to enable default copying file attributes for all file copy and move operations. Copy File Timestamps – select this option to enable default copying file timestamps for all file copy and move operations.

The ‘Shortcuts’ tab provides the user with the ability to customize keyboard shortcuts. Click on a shortcut item to edit the currently assigned key sequence. Press the ‘Default Shortcuts” button to reset all keyboard shortcuts to default values.

114

DiskBoss User Manual

Flexense Ltd.

The 'E-Mail' tab allows one to define an e-mail account to be used for sending e-mail notifications. In order to enable e-mail notifications, select the 'Enable E-Mail Notifications' checkbox and enter account details. In the 'SMTP Server Name' entry specify the host name of the SMTP server that should be used to send notifications, enter an appropriate user name, password and specify a source e-mail address to be used as the ‘From’ e-mail address for DiskBoss e-mails. In order to test the specified email account, click on the 'Verify E-Mail account' button.

The 'Database' tab allows one to configure an ODBC data source to use to export disk space analysis, file classification, duplicate files, file search and disk change monitoring reports to an SQL database. In order to enable database exports, specify the ODBC data source name, user name and password to use to connect to the SQL database.

115

DiskBoss User Manual

Flexense Ltd.

The 'Reports' tab allows one to keep a user-specified number of reports in the reports directory or the reports SQL database while automatically deleting old reports and freeing up the disk space. These features are especially useful for fully automated disk space analysis, file classification, file search or disk change monitoring operations when the user needs to keep a history of report files in a reports directory or a history of reports in an SQL database.

By default, DiskBoss keeps all reports in the reports directory or the SQL database. In order to enable automatic report management, open the 'Options' dialog, select the 'Reports' tab and change the 'Report Files' or 'Report Database' options to appropriate values. The 'Report Files' option is applicable to HTML, text, Excel CSV, XML and DiskBoss native reports saved to a reports directory or to the user's home directory using the DiskBoss server or the command line utility. After saving each new report, DiskBoss will check if there are too many reports of the same type (HTML, XML, CSV, etc.) in the reports directory and delete old reports according to the user-specified configuration. The 'Report Database' option is applicable to reports submitted to an SQL database using the DiskBoss GUI application, the DiskBoss server or the DiskBoss command line utility. After saving each new report to the database, DiskBoss will check if there are too many reports from the same host computer, for the same set of disks or directories and delete old reports according to the user-specified configuration. For example, if reports from two different servers are submitted to the same SQL database, DiskBoss will keep in the database X last reports for each server. The 'File Categories' option allows one to enable/disable exporting of file categories to HTML, text, Excel CSV and XML reports. Second-level file categories are available when reports are saved using the DiskBoss GUI application manually. Automatically generated reports or reports saved using the DiskBoss command line utility always saved without file categories. When the 'File Categories' option is enabled, DiskBoss GUI application will save second-level file categories to HTML, text, Excel CSV and XML reports. The 'Compressed Reports' option allows one to save automatically generated HTML, text, Excel CSV and XML reports as compressed archive files.

116

DiskBoss User Manual

Flexense Ltd.

The ‘Advanced’ tab provides the following configuration options:

• • • •

Maximum Tasks – According to the selected value, DiskBoss will save results for X last operations (such as search, classify, analyze, etc.). For detailed information about task management capabilities refer to the ‘Task Management’ section in this document. Maximum Errors – use this option to set the maximum number of errors for all file management operations. If a file management operation such as copy, move, delete, synchronize will reach the specified maximum number of errors, the operation will be aborted. Maximum Consecutive Errors – use this option to set the maximum number of consecutive errors for all file management operations. If a file management operation such as copy, move, delete, synchronize will reach the specified maximum number of consecutive errors, the operation will be aborted. Data Directory – use this option to set the directory where DiskBoss should save the user generated data such as user-defined commands and file system signatures. Save Errors Logs In – enable this option and specify an existing directory to automatically save all error logs to the specified directory. Save Tasks Logs In - enable this options and specify an existing directory to automatically save tasks logs to the specified directory. Proxy Configuration - Periodically, DiskBoss connects to the product's web site and checks for available product updates. If DiskBoss is installed on a computer connected to the Internet through an HTTP proxy, use the proxy configuration options to set a custom HTTP proxy configuration.

117

DiskBoss User Manual

Flexense Ltd.

12.8

Registering Product

Licenses for DiskBoss Pro, DiskBoss Ultimate, DiskBoss Server, discounted license packs and various license bundles may be purchased on the following page: http://www.diskboss.com/purchase.html 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 support@flexense.com and if it is nor here contact our support team.

After you will receive your unlock key, start the DiskBoss 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.

118

DiskBoss User Manual

Flexense Ltd.

13 XML-Based Format
13.1 Overview
DiskBoss extensively uses various types of file matching rules for all the supported file management operations ranging from basic file search to advanced file classification and storage utilization analysis. In general, file matching rules define the set of files on which a file management operation should be performed. For example, in file synchronization, file copy, file delete and other operations, the user is provided with the ability to process files matching user-defined criteria. These user-defined criteria may be specified using the XML format explained in this document.

13.2 Rules List
The rules list is the most fundamental element of the XML format and it is widely used in file search, file classification and other file management operations. A rule list may contain one or more file matching rules. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc., which are explained in details in subsequent sections of this document. During the file matching process, file matching rules are evaluated in the same order as they are specified in the rules list. <rules logic=’OR’> <r1>Rule Data</r1> <r2>Rule Data</r2> … <rX>Rule Data</rX> </rules> Rules Logic: Logic AND (Default) Description If the rules logic is set to ‘AND’, the rules list matches a file when all the specified rules evaluated to TRUE. Rules are evaluated until a first FALSE evaluation, after which, all the remaining file matching rules are dismissed. If the rules logic is set to ‘OR’, the rules list matches a file when any of the specified rules evaluated to TRUE. Rules are evaluated until a first TRUE evaluation, after which, all the remaining file matching rules are skipped.

OR

13.3 Nested Rules
Sometimes, it may be necessary to match files according to multiple criteria with nested logical operations. For example, it may be required to organize or analyze all documents and image files that were modified during the last month. In this case, we need to define a composite rules list where the top level list will contain a rule matching files that were modified during the last month and a nested rules list containing rules matching documents and image files. <rules logic=’AND’> <r1>Rule matching file modified during this month</r1> … <rules logic=’OR’> <r2>Rule matching all types of document files</r2> <r3>Rule matching all types of image files</r3> </rules> </rules>

119

DiskBoss User Manual

Flexense Ltd.

13.4

File Matching Rules

13.4.1 File Extension The ‘extension’ rule allows one to match files by a specific pattern in the file extension. The rule accepts up to 8 extension patterns for each declaration. By default, the ‘extension’ rule matches all files having one of the specified file extensions. If the rule operator is set to ‘NE’ (not equal), the rule matches all files with the file extension matching none of the specified extension patterns. In addition to the EQ/NE operators, the user is provided with numerous advanced pattern matching operators allowing one to match files with extensions beginning with, ending with or containing specific extension patterns.

Format: <extension op=’Operator’>ext1 ext2 … extX</extension>

Operators:

Operator EQ (Default) NE CS NC BW NB EW NS

Description Matches files having one of the specified extensions. Matches files having none of the specified extensions. Matches files with extensions containing one of the specified strings. Matches files with extensions containing none of the specified strings. Matches files with extensions beginning with one of the specified strings. Matches files with extensions beginning with none of the specified strings. Matches files with extensions ending with one of the specified strings. Matches files with extensions ending with none of the specified strings.

Examples:

Rule <extension>mpg mp3 mpeg</extension> <extension op='BW'>mp</extension>

Description Matches all files with extensions: ‘MPG’, ‘MP3’ and ‘MPEG’ Matches all files with extensions beginning with: ‘MP’ Matches all files except files with extensions: ‘MPG’ and ‘MP3’. Matches all files containing pattern ‘HTM’ in files’ extensions including ‘HTM’, ‘HTML’, ‘SHTML’, etc.

<extension op=’NE’>mpg mp3</extension> <extension op=’CS’>htm</extension>

120

DiskBoss User Manual

Flexense Ltd.

13.4.2 File Name and Path DiskBoss provides a number of file matching rules allowing one to match files by a specific text pattern in the file name, file path, full file name (file name including full path) and file name only (without extension and path). By default, all name rules will match files having the specified text pattern in the selected part of the file name. If the rule operator is set to ‘NE’ (not equal), these rules will match files with file names different from the specified text pattern. In addition to the EQ/NE operators, the user is provided with numerous advanced pattern matching operators allowing one to match files with names beginning with, ending with or containing specific text patterns. Format: <RuleName op=’Operator’>Text Pattern</RuleName> Rules: Rule NAME PATH FULLNAME DIRNAME NAMEONLY Operators: Operator EQ (Default) NE CS NC BW NB EW NS Description Matches files with the file name identical to the specified text pattern. Matches files with the file name different from the specified text pattern. Matches files with the file name containing the specified text pattern. Matches files with the file name not containing the specified text pattern. Matches files with the file name beginning with the specified text pattern. Matches files with the file name not beginning with the specified text pattern. Matches files with the file name ending with the specified text pattern. Matches files with the file name not ending with the specified text pattern. Description Compares the file name with the specified text pattern Compares the file path (path without the file name) with the specified pattern. Compares the full file name (file name and path) with the specified pattern. Compares the name of the directory (without path) with the specified pattern. Compares the file name only (without path and extension).

Examples: Rule <name>readme.txt</name> Description Matches all README.TXT

files

with

the

file

name:

<name op='BW'>readme</name>

<name op=’NE’>readme</name> <name op=’CS’>report</name> <path>C:\</path> <fullname op='BW'>c:\readme</fullname >

Matches all files with the file name beginning with ‘README’ including: README, README.TXT, README.DOC, etc. Matches all files except files with the file name: README Matches all files containing the text pattern ‘REPORT’ in the file name. Matches files located in the root directory of disk ‘C:\’. Matches files with the full file name beginning with: ‘C:\README’

121

DiskBoss User Manual

Flexense Ltd.

13.4.3 File Size The ‘size’ rule allows one to match files by a specific file size. By default, the ‘size’ rule matches all files having the specified file size. If the rule operator is set to ‘NE’ (not equal), the rule matches all files with the file size different from the specified value. In addition to the basic EQ/NE operators, the user is provided with numerous advanced operators allowing one to match files with the file size less than, less or equal, more than, more or equal to the specified value. Finally, there are two range-based operators capable of matching files having the file size within or outside of a specific range. Basic Format: <size op=’Operator’>Size Modifier(Value)</size> Range Format: <size op=’Range Operator’>Size Modifier(From Value … To Value)</size>

Operators: Operator EQ (Default) NE GT GE LT LE Description Matches files Matches files Matches files Matches files Matches files Matches files

with with with with with with

the the the the the the

file file file file file file

size size size size size size

equal to the specified value. different from the specified value. greater than the specified value. greater or equal to the specified value. less than the specified value. less or equal to the specified value.

Range Operators: Operator IN NI Size Modifiers: Modifier Bytes KBytes MBytes GBytes Examples: Rule <size>Bytes(1024)</size> <size op='LT'>Bytes(1024)</size> <size op='GT'>MBytes(10)</size> Description Matches files with the file size 1024 bytes Matches files with the file size less than 1024 Bytes Matches files with the file size greater than 10 MBytes Matches files with the file size from 1 to 100 MBytes. Matches zero-length files. Matches non-zero-length files. Description The file size value The file size value The file size value The file size value Description Matches files having the file size within the specified range Matches files having the file size outside of the specified range

or or or or

range range range range

is is is is

specified specified specified specified

in in in in

Bytes. Kilobytes. Megabytes. Gigabytes.

<size op=’IN’>MBytes(1…100)</size>

<size op=’EQ’>Bytes(0)</size> <size op=’NE’>Bytes(0)</size>

122

DiskBoss User Manual

Flexense Ltd.

13.4.4 File Time DiskBoss provides a number of file matching rules allowing one to match files by a specific file creation, last modification or last access time. By default, all time rules will match files having the specified time value in the selected file time. If the rule operator is set to ‘NE’ (not equal), these rules will match files with the selected file time different from the specified time value. In addition to the basic EQ/NE operators, the user is provided with numerous advanced operators allowing one to match files with the file time less than, less or equal, more than, more or equal to the specified time value. Finally, there are two range-based operators capable of matching files having the selected file time within or outside of a specific time range. Basic Format: <RuleName op=’Operator’>Time Modifier( Time Value )</RuleName> Range Format: <RuleName op=’Operator’>Time Modifier( From … To )</RuleName>

Rules: Rule CTIME MTIME ATIME Operators: Operator EQ NE GT GE LT LE Description Matches files Matches files Matches files Matches files Matches files Matches files Description Compares the file creation time with the specified time value. Compares the file last modification time with the specified time value. Compares the file last access time with the specified time value.

with with with with with with

the the the the the the

file file file file file file

time time time time time time

equal to the specified value. different from the specified value. greater than the specified value. greater or equal to the specified value. less than the specified value. less or equal to the specified value.

Range Operators: Operator IN NI Description Matches files having the selected file time within the specified range Matches files having the selected file time outside of the specified range

Time Modifiers: Modifier Days Weeks Months Years Examples: Rule <atime op='GT'>Weeks(2)</atime> <ctime op=’LE’>Months(3)</ctime> <mtime op=’IN’>Years(1…5)</mtime> Description Matches files last accessed more than 2 weeks Matches files created during the last 3 months Matches files last modified from 1 to 5 years Description The file time value The file time value The file time value The file time value

or or or or

range range range range

is is is is

specified specified specified specified

in in in in

days. weeks. months. years.

123

DiskBoss User Manual

Flexense Ltd.

13.4.5 File Date In addition to the relative time-based file matching rules, DiskBoss provides a set of rules allowing one to match files by absolute creation, last modification or access dates. By default, all date rules match files having the specified date value in the selected file date. If the rule operator is set to ‘NE’ (not equal), these rules will match files with the selected file date different from the specified date value. In addition to the basic EQ/NE operators, the user is provided with numerous advanced operators allowing one to match files with the file date less than, less or equal, more than, more or equal to the specified date value. Finally, there are two range-based operators capable of matching files having the selected file date within or outside of a specific date range. Basic Format: <RuleName op=’Operator’>Absolute Date</RuleName> Range Format: <RuleName op=’Operator’>From Absolute Date … To Absolute Date</RuleName>

Rules: Rule CDATE MDATE ADATE Operators: Operator EQ NE GT GE LT LE Description Matches files Matches files Matches files Matches files Matches files Matches files Description Compares the file creation date with the specified date value. Compares the file last modification date with the specified date value. Compares the file last access date with the specified date value.

with with with with with with

the the the the the the

file file file file file file

date date date date date date

equal to the specified value. different from the specified value. greater than the specified value. greater or equal to the specified value. less than the specified value. less or equal to the specified value.

Range Operators: Operator IN NI Description Matches files having the selected file date within the specified range Matches files having the selected file date outside of the specified range

Absolute Date Format: Absolute dates should be specified in the following format: YYYY/MM/DD Examples: Rule
<adate>2009/03/01</adate> <cdate op=’LT’>2009/03/01</cdate> <mdate op=’IN’>2009/02/01…2009/03/01</mdate>

Description
Matches files last accessed on 1-Mar-2009 Matches files created before 1-Mar-2009 Matches files last modified from 1-Feb-2009 to 1-Mar-2009

124

DiskBoss User Manual

Flexense Ltd.

13.4.6 Text Patterns The ‘text’ rule allows one to match files containing or not containing a specific text pattern. By default, the ‘text’ rule matches all files containing the specified text pattern. If the rule operator is set to ‘NC’ (not contain), the rule matches files not containing the specified text pattern.

Format:

<text op=’Operator’>Text Pattern</text>

Operators:

Operator CS (Default) NC

Description Matches files containing the specified text pattern. Matches files not containing the specified text pattern.

Examples:

Rule <text>Have a Good Day</text> <text op=’NC’>Have a Good Day</text>

Description Matches file containing the specified text. Matches files not containing the specified text.

<rules logic=’OR’> <text>Pattern 1</text> <text>Pattern 2</text> </rules>

Matches files containing ‘Pattern 1’ or ‘Pattern 2’.

<rules logic=’AND’> <text op=’CS’>Pattern 1</text> <text op=’NC’>Pattern 2</text> </rules>

Matches files containing ‘Pattern 1’, but containing ‘Pattern 2’.

not

Special Cases: 1. If the operator is set to ‘CS’ and the file size is shorter than the specified text pattern, the rule evaluates to FALSE without checking the text pattern. 2. If the operator is set to ‘NC’ and the file size is shorter than the specified text pattern, the rule evaluates to TRUE without checking the text pattern.

125

DiskBoss User Manual

Flexense Ltd.

13.4.7 Binary Patterns The ‘pattern’ rule allows one to match files containing or not containing a specific binary pattern at a user-specified position. By default, the ‘pattern’ rule matches all files having the specified binary pattern at the specified position. If the rule operator is set to ‘NE’ (not equal), the rule matches files not containing the specified binary pattern at the specified position.

Format: <pattern op=’Operator’ pos=’Position’>Binary Pattern</pattern> Operators: Operator EQ (Default) NE Description Matches files containing the specified pattern at the specified position. Matches files not containing the specified pattern at the specified position.

Position: The position attribute specifies the absolute position from the beginning of the file where the specified binary pattern should be found. If not specified, DiskBoss will search for the specified binary pattern at the position 0.

Binary Pattern: The binary pattern should be specified as one or more two-symbol HEX tokens delimited by the space character with each token representing a single byte of data. The length of the binary pattern is determined by the amount of the specified HEX tokens. For example, ‘FF FE FD FE’ represents a four-byte binary pattern. The ‘pattern’ rule is capable of matching binary patterns of up to 255 bytes long.

Examples: Rule <pattern pos=’12’>FF FE FD FC</pattern> <pattern>4D 5A</pattern> <pattern op=’NE’>4D 5A</pattern> Description Matches files containing the pattern ‘FF FE FD FE’ at the position 12 Matches files containing the pattern ‘4D 5A’ at the position 0 Matches files not containing the pattern ‘4D 5A’ at the position 0 Matches files containing the pattern ‘4D 5A’ at the position 1 and the pattern ‘5A 4D’ at the position 6.

<rules logic=’AND’> <pattern pos=’1’>4D 5A</pattern> <pattern pos=’6’>5A 4D</pattern> </rules>

Special Cases: 1. If the operator is set to ‘EQ’ and after setting the position the remaining file size is shorter than the length of the specified binary pattern, the rule evaluates to FALSE without checking the binary pattern. 2. If the operator is set to ‘NE’ and after setting the position the remaining file size is shorter than the length of the specified binary pattern, the rule evaluates to TRUE without checking the binary pattern.

126

DiskBoss User Manual

Flexense Ltd.

13.4.8 File Category The ‘category’ rule matches files related to a specific file category or file class in a file classification plugin. If the user has specified an individual file class, the ‘category’ rule will match all files related to the specified file class. If the user has specified a class group, the ‘category’ rule will match all files related to any file class in the specified class group including all classes in all subgroups. If the rule operator is set to ‘NE’ (not equal), the rule matches files not related to the specified class group or file class. Format: <category op=’Operator’> <plugin>File Classification Plugin Name</plugin> <group>Full Group Name</group> <class>Optional Class Name</class> <display>Optional Display String</display> </category> Operators: Operator EQ (Default) NE Description Matches files related to the specified file category. Matches files not related to the specified file category.

(Optional) (Optional) (Optional)

Elements: Element Plugin Description The ‘plugin’ element specifies the name of the file classification plugin that should be used during the file matching process. The specified file classification plugin should be registered in the product configuration. If the specified file classification plugin does not exist or not valid, the whole operation will be aborted. The ‘group’ element specifies the name of the class group that should be used during the file matching process. If the user has specified a class group and not specified a file class, the ‘category’ rule will match all files related to any file class in the specified class group including all classes in all subgroups. Subgroups should be specified including full names of all parent groups delimited by the ‘/’ character. The ‘class’ element is an optional element allowing one to specify the name of an individual file class that should be used during the file matching process. If the user has specified a file class, the ‘category’ rule will match files related to this specific class only. The ‘display’ element is an optional element allowing one to specify a short textual description of the category to be displayed in the DiskBoss GUI application instead of the full group/class name. If not specified, DiskBoss will construct a default display name automatically.

Group

Class

Display

Examples: Rule <category> <plugin>Default File Hierarchy</plugin> <group>Music and Audio Files</group> </category> Description Matches all files related to the ‘Music and Audio Files’ group in the ‘Default File Hierarchy’ file classification plugin.

127

DiskBoss User Manual

Flexense Ltd.

13.4.9 JPEG EXIF Tags DiskBoss provides the user with the ability to perform operations on JPEG images by one or more standard or custom EXIF tags. By default, the EXIF-based file matching rule match JPEG images having the specified text pattern in the selected EXIF tag. If the rule operator is set to ‘NE’ (not equal), the rule will match JPEG images with the selected EXIF tag different from the specified text pattern. In addition to the EQ/NE operators, the user is provided with numerous advanced pattern matching operators allowing one to match JPEG images with EXIF tags beginning with, ending with or containing specific text patterns.

Format: <exif op=’Operator’ tag=’EXIF Tag ID’>Text Pattern</exif>

EXIF Tag ID: The EXIF tag ID should be specified as a HEX number without the leading ‘0x’ prefix. DiskBoss allows one to match files by any standard or custom EXIF tag ID.

Operators: Operator EQ (Default) NE CS NC BW NB EW NS Description Matches files with the EXIF tag identical to the specified text pattern. Matches files with the EXIF tag different from the specified text pattern. Matches files with the EXIF tag containing the specified text pattern. Matches files with the EXIF tag not containing the specified text pattern. Matches files with the EXIF tag beginning with the specified text pattern. Matches files with the EXIF tag not beginning with the specified text pattern. Matches files with the EXIF tag ending with the specified text pattern. Matches files with the EXIF tag not ending with the specified text pattern.

Examples:

Rule
<exif tag=’10F’>NIKON CORPORATION</exif>

Description
Matches JPEG images with the EXIF tag ‘10F’ (Camera Vendor) set to ‘NIKON CORPORATION’. Matches JPEG images with the EXIF tag ‘110’ (Camera Model) beginning with ‘NIKON’. Matches JPEG images with the EXIF tag ‘A002’ (Image Width) not set to 1024.

<exif op='BW' tag=’110’>NIKON</exif>

<exif op=’NE’ tag=’A002’>1024</exif>

128

DiskBoss User Manual

Flexense Ltd.

13.4.10

Windows File Attributes

The ‘attr’ rule allows one to match files by one or more of Windows file attributes. By default, the ‘attr’ rule matches files having all of the specified file attributes. If the rule operator is set to ‘NE’ (not equal), the rule matches files with none of the specified Windows file attributes. Format: <attr op=’Operator’>Attribute List</attr>

Operators: Operator EQ (Default) NE

EQ, NE Description Matches files having all the specified Windows file attributes. Matches files having none of the specified Windows file attributes.

Attribute List: The attribute list may include one or more of the following Windows file attributes: ARCHIVE, COMPRESSED, ENCRYPTED, HIDDEN, NORMAL, OFFLINE, READONLY, REPARSE-POINT, SPARSE-FILE, SYSTEM, TEMPORARY. For detailed information about meaning of each specific file attribute refer to the Windows help.

Examples: Rule <attr>SYSTEM HIDDEN</attr> <attr op=’NE’>SYSTEM</attr> Description Matches system and hidden files. Matches non-system files.

<rules logic=’AND’> <attr op=’EQ’>HIDDEN</attr> <attr op=’NE’>SYSTEM</attr> </rules>

Matches hidden, but not system files.

129

DiskBoss User Manual

Flexense Ltd.

13.4.11

UNIX File Permissions

The ‘perm’ rule allows one to match files by UNIX file access permissions. By default, the ‘perm’ rule matches files having all the specified file permissions. If the rule operator is set to ‘NE’ (not equal), the rule matches files with not matching file permissions. Format: <perm op=’Operator’>Permissions</perm>

Operators: Operator EQ (Default) NE

EQ, NE Description Matches files having the specified UNIX file permissions. Matches files not having the specified UNIX file permissions.

Permissions: File permissions should be specified as three octal (0-7) digits specifying user, group and other permissions respectively. For more detailed information about UNIX file permissions refer to UNIX or Linux operating system manuals. Examples: Rule <perm>777</perm> Description Matches files with read, write and execute permissions enabled for the user, group and other. Matches files with file permissions different from 777.

<perm op=’NE’>777</perm>

<rules logic=’OR’> <perm>777</perm> <perm>666</perm> </rules>

Matches files with file permissions set to 777 or 666.

130

DiskBoss User Manual

Flexense Ltd.

13.4.12

User Name

The ‘user’ rule allows one to match files by the user name. By default, the ‘user’ rule matches all files having the specified user name. If the rule operator is set to ‘NE’ (not equal), the rule matches all files with the user name different from the specified value. In addition to the EQ/NE operators, the user is provided with numerous advanced pattern matching operators allowing one to match files with the user name beginning with, ending with or containing specific text patterns.

Format: <user op=’Operator’>User Name</user>

Operators:

Operator EQ (Default) NE CS NC BW NB EW NS

Description Matches files owned by the specified user. Matches files with the user name different from the specified pattern. Matches files with the user name containing the specified pattern. Matches files with the user name containing none of the specified patterns. Matches files with the user name beginning with the specified pattern. Matches files with the user name not beginning with the specified pattern. Matches files with the user name ending with the specified pattern. Matches files with the user name not ending with the specified pattern.

Examples:

Rule <user>Admisistrator</user> <user op='BW'>Admin</user>

Description Matches all files owned by user ‘Administrator’ Matches all files related to user names beginning with ‘Admin’ Matches all files not owned by ‘root’. Matches all files with containing pattern ‘Admin’ the user name

<user op=’NE’>root</user> <user op=’CS’>Admin</user>

131

DiskBoss User Manual

Flexense Ltd.

13.5

File Classification Plugins

13.5.1 Overview DiskBoss is capable of scanning disks, network shares and enterprise storage systems, classifying all the existing files and organizing them into a categorized file hierarchy. File classification and categorization operations are performed using file classification plugins. By default, DiskBoss comes with the ‘Default File Hierarchy’ file classification plugin and provides numerous additional file classification plugins that may be installed from the DiskBoss plugins server. In addition to file classification plugins provided by Flexense, DiskBoss allows one to add custom file classification plugins especially designed for user-specific needs and requirements. This section explains how to write custom DiskBoss file classification plugins using an XMLBased format. Properly written XML classification plugins may be imported into the DiskBoss product configuration and used in various file management operations including file classification, file search, file synchronization, storage utilization analysis, etc. 13.5.2 Structure A file classification plugin consists of three distinct sections: the plugin info section, the class list section and the group list section. The plugin info section includes information about the plugin version, the required DiskBoss version, the plugin protection status and an optional author name. Format: <plugin name=’Plugin Name’>

<!-- Plugin Info --> <version>Plugin Version</version> <diskboss>Required DiskBoss Version</diskboss> <protected>Protection Status</protected> <author>Module Author</author> <match>Maximum Match Count</match>

(Optional) (Optional) (Optional)

<!-- Class List --> <class1>Class Data</class1> … <classX>Class Data</classX>

<!-- Group List --> <group1>Group Data</group1> … <groupX>Group Data</groupX>

</plugin>

The class list should include declarations for one or more file classes specifying file matching rules that should be used in order to detect each specific file class. The group list should include declarations for one or more class groups specifying references to all file classes related to each specific class group. In order to be registered in the DiskBoss product configuration, each file classification plugin should have a unique plugin name. Use the ‘name’ attribute in the ‘plugin’ element to specify a unique file classification plugin name.

132

DiskBoss User Manual

Flexense Ltd.

13.5.3 Plugin Info Operator Version Description The ‘version’ element specifies the version of the file classification plugin. DiskBoss uses the plugin version to show the plugin status in the plugins management dialog. The plugin version should be specified in the format ‘X.Y.Z’ (tree decimal numbers delimited by the ‘.’ Character) where X represents the major version, Y represents the minor version and Z represents the revision of the file classification plugin. The ‘diskboss’ element specifies the minimal version of DiskBoss required for this specific file classification plugin. The DiskBoss version should be specified in the format ‘X.Y.Z’ (tree decimal numbers delimited by the ‘.’ Character) where X represents the major version, Y represents the minor version and Z represents the revision of the required version of DiskBoss. The ‘protected’ element specifies the plugin protection status. The protection status may be set to ‘YES’ (default is ‘YES’) or ‘NO’. If the protection status is set to ‘YES’, DiskBoss will prevent the file classification plugin from being exported to any of the supported file formats. If the protection status is set to ‘NO’, DiskBoss will allow export of the plugin to all the supported file formats. The ‘author’ element is an optional element allowing one to specify the plugin’s author name (default is ‘Flexense’). The plugin’s author may be specified as a free-format text string up to 255 characters long. The ‘match’ element is an optional element (default value is 1) allowing one to specify the maximum number of matches for each file during the file classification process. Sometimes, it may be useful to categorize each file to more than one file class. This parameter controls the maximum number of classes each file may be related to.

DiskBoss

Protected

Author

Match

13.5.4 Class List Each file classification plugin should define one or more file classes specifying file matching rules that will be used to detect each specific file class. Each file class in the class list should have a unique class name. During the file classification process, DiskBoss will pass each file through the class list and evaluate file matching rules specified in each specific file class. Format: <class name=’Class Name 1’> <rules> <!-- File Matching Rules --> </rules> </class> … <class name=’Class Name X’> <rules> <!-- File Matching Rules --> </rules> </class> File classes are evaluated in the same order as they are defined in the class list. The maximum match count parameter (described in the plugin info section) controls the maximum number of matches allowed for each file. If the parameter is set to 1 (default), DiskBoss will process each file until a first matching class and skip all remaining classes in the class list.

133

DiskBoss User Manual

Flexense Ltd.

13.5.5 Class Definition Each file class should specify one or more file matching rules that will be used during the file classification process. All the specified file matching rules will be evaluated in the same order as they are specified in the class definition. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Format: <class name=’Class Name’> <rules logic=’or’> <r1>Rule Data</r1> <r2>Rule Data</r2> … <rX>Rule Data</rX> </rules> </class>

13.5.6 Nested Rules Sometimes, it may be necessary to match files according to multiple criteria with nested logical operations. For example, it may be required to organize or analyze all documents and image files that were modified during the last month. In this case, we need to define a composite rule list where the top level list will contain a rule matching files that were modified during the last month and the nested rule list will contain rules matching documents or image files. Example: <class name=’Class Name’> <rules logic=’AND’> <r1>Rule matching file modified during this month</r1> … <rules logic=’OR’> <r2>Rule matching all types of document files</r2> <r3>Rule matching all types of image files</r3> </rules> </rules> </class> DiskBoss allows one to physically reorganize data on the disk according to the logical hierarchy defined by a file classification plugin. During this operation, DiskBoss builds a hierarchy of directories according to the hierarchy of class groups and file classes as it is defined in the selected file classification plugin. In order to use this specific capability, the character set used for group and class names should be limited to characters allowed for file names on the target file system. Due to this reason the following characters are not allowed to be used in group and class names: ‘/’, ‘\’, ‘:’, ‘*’, ‘?’, ‘>’, ‘<’, ‘|’.

134

DiskBoss User Manual

Flexense Ltd.

13.5.7 Class Groups Each file classification plugin should define one or more class groups with references to one or more file classes related to each specific class group. Each class group should have a unique group name in the group list. Format: <group name=’Group Name 1’> <class>Class Name 1</class> … <class>Class Name 2</class> </group> … <group name=’Group Name X’> <class>Class Name 3</class> … <class>Class Name 4</class> </group>

13.5.8 Nested Groups The group list may be organized into a logical hierarchy with an unlimited number of nested class groups. The hierarchy of class groups is used by DiskBoss to display file classification results and perform file management operations on file classification results. Format: <group name='Top Level Group'> <group name=’Nested Group 1’> <class>Class Name 1</class> <class>Class Name 2</class> … <class>Class Name X</class> </group> <group name=’Nested Group 2’> <class>Class Name 1</class> <class>Class Name 2</class> … <class>Class Name Y</class> </group> </group>

DiskBoss allows one to physically reorganize data on the disk according to the logical hierarchy defined by a file classification plugin. During this operation, DiskBoss builds a hierarchy of directories according to the hierarchy of class groups and file classes as it is defined in the selected file classification plugin. In order to use this specific capability, the character set used for group and class names should be limited to characters allowed for file names on the target file system. Due to this reason the following characters are not allowed to be used in group and class names: ‘/’, ‘\’, ‘:’, ‘*’, ‘?’, ‘>’, ‘<’, ‘|’.

135

DiskBoss User Manual

Flexense Ltd.

13.5.9 Example File Classification Plugin Finally, let’s write an example file classification plugin capable of categorizing Microsoft office documents, text files, image files and Photoshop graphics files into a simple, two-group file hierarchy. Example Plugin: <plugin name=’My File Classification Plugin’> <!-- Plugin Info --> <version>1.0.0</version> <diskboss>3.0.0</diskboss> <!-- Class List --> <class name=’Text Files’> <rules> <extension>TXT</extension> <rules> </class> <class name=’Microsoft Office Files’> <rules> <extension>DOC PPT XLS</extension> <rules> </class> <class name=’Image Files’> <rules> <extension>JPG BMP PNG</extension> <rules> </class> <class name=’Photoshop Graphic Files’> <rules> <extension>PSD PDD</extension> <rules> </class>

<!-- Group List --> <group name=’Text Files and Documents’> <class>Text Files</class> <class>Microsoft Office Files</class> </group> <group name=’Graphic Files’> <class>Image Files</class> <class> Photoshop Graphic Files</class> </group> </plugin>

The plugin info section defines the plugin version and the minimum required DiskBoss version. The class list defines four file classes with file matching rules detecting each specific file type by the file extension. The group list organizes all the defined file classes into two class groups.

136

DiskBoss User Manual

Flexense Ltd.

13.6

User-Defined Commands

DiskBoss is a powerful and flexible product providing a large number of features, capabilities and configuration options allowing one to perform many different file and storage management operations. In order to simplify management and execution of frequently used operations, DiskBoss provides the user with the ability to add user-defined commands. All major product features such as file search, classification, organizing, synchronization, copy, move, delete, storage utilization analysis, duplicate files search and disk monitoring may be added as user-defined commands and pre-configured for user-specific needs and custom hardware configurations. In addition to the user-defined commands management capabilities available in the DiskBoss main GUI application, the user is provided with the ability to write user-defined commands in an XML-Based format. The XML-Based format, which is explained in this section, provides the user with full control over all the features available in the DiskBoss main GUI application. Properly written XML user-defined commands may be imported to the DiskBoss' product configuration or executed on-the-fly using the DiskBoss command line tool, which is available in DiskBoss Ultimate and DiskBoss Server.

Example Command #1: <search name=’Search Command Name’> <inputs> <dir>D:\</dir> <dir>F:\</dir> </inputs> <rules logic=’AND’> <extension>JPG BMP PNG </extension> <size op=’GT’>MBytes(10)</size> </rules> </search> The first example command will search for JPG, BMP and PNG image files with the file size greater than 10 MBytes on disks ‘D:\’ and ‘F:\’.

Example Command #2: <classify name='Classify Command Name'> <inputs> <dir>D:\</dir> <dir>F:\</dir> </inputs> <plugin>Default File Hierarchy</plugin> <report type='HTML'> <title>My Classification Report</title> <save-to>C:\classification_report.html</save-to> </report> </classify> The second example command will classify disks ‘D:\’ and ‘F:\’ and save a file classification report to the file ‘C:\classification_report.html’. Each specific command type has its own set of parameters and options, which are explained in details in subsequent sections of this document.

137

DiskBoss User Manual

Flexense Ltd.

13.6.1 File Search DiskBoss provides powerful and flexible file search capabilities allowing one to search files using multiple search criteria including the file name, file type, file size, access/modification/creation times, text or binary patterns, etc. The user is provided with the ability to define composite search queries using multiple search rules and apply the AND/OR logical operators. Frequently used queries may be saved as user-defined commands and executed in a single mouse click. In addition to the ability to define search queries using the DiskBoss GUI application, DiskBoss allows one to specify search queries using an XML-Based format. The XML format provides support for all the search features available in the DiskBoss main GUI application including all types of file matching rules, nested rules, logical operators, etc. File search queries defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format: <search name=’Command Name’> <inputs> <dir>Directory Name 1</dir> … <dir>Directory Name X</dir> <file>File Name 1</file> … <file>File Name X</file> </inputs> <rules> <r1>Rule Data</r1> … <rX>Rule Data</rX> </rules> <file-name>File Name Filter</file-name> <max-result>Max Search Result</max-result> <scanning>File Scanning Mode</scanning> <shortcut>Keyboard Shortcut</shortcut> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> </process> <report type=’Report Type’> <title>Custom Report Title</title> <save-to>Report File Name</save-to> </report> <actions results='Number of Search Results'> <user-command>User Command</user-command> <custom-command> Command</custom-command> <email>E-Mail Address</email> </actions> <exclude> <dir>Exclude Directory 1</dir> … </exclude> </search> (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional)

(Optional) (Optional) (Optional) (Optional)

(Optional)

138

DiskBoss User Manual

Flexense Ltd.

Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel. Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list. File Matching Rules The list of file matching rules should specify one or more rules that will be used during the file search process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Miscellaneous Parameters (Optional) Parameter file-name Description The ‘file-name’ element allows one to specify a file name pattern to search for instead of specifying file matching rules. For example, set the file name pattern to ‘*.pdf’ to find all PDF documents. The ‘max-result’ element controls the maximum number of search results for the search command. By default, DiskBoss finishes the search process after first 1000 search results. DiskBoss is capable of scanning multiple disks or directories in parallel thus improving the speed of the file search process on multi-CPU/multi-core systems. The ‘scanning’ element allows one to control the file scanning mode. Set the scanning mode to 'PARALLEL' if you wish to scan all input disks and directories simultaneously. The DiskBoss GUI application provides the user with the ability to execute user-defined commands using keyboard shortcuts. Use the ‘shortcut’ element to specify a keyboard shortcut for the command.

max-result

scanning

shortcut

Process Options (Optional) Parameter streams Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the file search process, use multiple processing streams when scanning input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the file search process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode requires the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.).

speed

139

DiskBoss User Manual

Flexense Ltd.

Automatic Report Generation (Optional) The ‘report’ element instructs DiskBoss to automatically save results to a report file. The ‘type’ attribute may be set to ‘HTML’, ‘TEXT’ or ‘CSV’. An optional ‘title’ element may be used to set a custom report title. If the ‘save-to’ element is not specified, DiskBoss will automatically generate a file name and save the report into the user’s home directory. If the specified ‘save-to’ value represents an existing directory, DiskBoss will automatically generate a file name and save report into the specified directory. In all other cases, DiskBoss will save the report using the ‘save-to’ value as an absolute file name.

Search Actions The ‘actions’ element allows one to execute various types of actions if the search operation reaches the specified number of search results. The user is provided with the ability to execute a user-defined command, a custom command or send an e-mail notification. Parameter results user-command Description This parameter specifies the number of search results that will trigger execution of the specified search actions. This element specifies the name of a user-defined command that should be executed if the search operation reaches the specified number of search results. This element specifies the name of a custom command, shell script or batch file that should be executed if the search operation reaches the specified number of search results. This element specifies the e-mail address that should be used to send an E-Mail notification if the search operation reaches the specified number of search results.

custom-command

email

140

DiskBoss User Manual

Flexense Ltd.

13.6.2 File Classification DiskBoss is capable of scanning disks, network shares and enterprise storage systems, classifying all the existing files and organizing them into a categorized file hierarchy. DiskBoss automatically recognizes more than 2000 file types and allows one to browse or export the categorized file hierarchy, perform various actions on specific files or file groups and physically reorganize existing files according to a user-defined list of rules and policies. In addition to the ability to define file classification commands using the DiskBoss GUI application, DiskBoss allows one to specify file classification commands using an XML-Based format. The XML format provides support for all the file classification features and capabilities available in the DiskBoss main GUI application. File classification commands defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format: <classify name=’Command Name’> <plugin>File Classification Plugin Name</plugin> <inputs> <dir>Directory Name 1</dir> … <file>File Name 1</file> … </inputs> <action type=’Action Type’>Action Value</action> <filter>File Scanning Filter</filter> <scanning>File Scanning Mode</scanning> <shortcut>Keyboard Shortcut</shortcut> <rules> <r1>Rule Data</r1> … </rules> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> <copy>Copy Options</copy> <verify>Verification Mode</verify> </process> <report type=’Report Type’> <title>Custom Report Title</title> <save-to>Report File Name</save-to> </report> <exclude> <dir>Exclude Directory 1</dir> … </exclude> </classify> Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel. (Optional) (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional) (Optional)

141

DiskBoss User Manual

Flexense Ltd.

Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. Userdefined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list. File Matching Rules (Optional) DiskBoss Ultimate provides the user with the ability to limit the file classification process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the file classification process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Miscellaneous Parameters (Optional) Parameter action Description The ‘action’ element allows one to specify an automatic file classification action that should be performed instead of displaying file classification results. The ‘type’ attribute may be set to one of the following values: ‘LINK’, ‘COPY’, ‘MOVE’, ‘MOVE-AND-LINK’ or ‘EXECUTE’. For detailed information about all action types and values refer to the DiskBoss product manual. The ‘filter’ element allows one to specify a file name filter instead of specifying file matching rules. For example, set the file name filter to ‘*.pdf’ to process all PDF documents. DiskBoss is capable of scanning multiple disks or directories in parallel thus improving the speed of the file classification process on multi-CPU/multi-core systems. The ‘scanning’ element allows one to control the file scanning mode. Set the scanning mode to 'PARALLEL' if you wish to scan all input disks and directories simultaneously.

filter

scanning

Process Options (Optional) Parameter streams Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the file classification process, use multiple processing streams when scanning input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the file classification process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.).

speed

Automatic Report Generation (Optional) The ‘report’ element instructs DiskBoss to automatically save results to a report file. The ‘type’ attribute may be set to ‘HTML’, ‘TEXT’ or ‘CSV’. An optional ‘title’ element may be used to set a custom report title. If the ‘save-to’ element is not specified, DiskBoss will automatically generate a file name and save the report into the user’s home directory. If the specified ‘save-to’ value represents an existing directory, DiskBoss will automatically generate a file name and save report into the specified directory. In all other cases, DiskBoss will save the report using the ‘save-to’ value as an absolute file name.

142

DiskBoss User Manual

Flexense Ltd.

13.6.3 Storage Utilization Analysis Overtime, disks on home computers and enterprise storage systems collect outdated files wasting storage space and making it difficult to find the required information. DiskBoss provides advanced storage utilization analysis capabilities allowing one to analyze one or more local disks or network shares, identify abnormal storage utilization patterns and automatically execute (DiskBoss Ultimate) user-defined actions. In addition to the ability to define storage analysis commands using the DiskBoss GUI application, DiskBoss allows one to specify storage analysis commands using an XML-Based format. The XML format provides support for all the storage analysis features and capabilities available in the DiskBoss main GUI application. Storage analysis commands defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format: <analyze name=’Command Name’> <inputs> <dir>Directory Name 1</dir> … <file>File Name 1</file> … </inputs> <actions mode=’Actions Mode’> (Optional) <action> <for mode='M' op='O' value='V' units='U'>Condition</for> <do mode='M'>Action</do> </action> … </actions> <filter>File Scanning Filter</filter> <scanning>File Scanning Mode</scanning> <shortcut>Keyboard Shortcut</shortcut> <rules> <r1>Rule Data</r1> … </rules> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> </process> <report type=’Report Type’> <title>Custom Report Title</title> <save-to>Report File Name</save-to> </report> <exclude> <dir>Exclude Directory 1</dir> … </exclude> </analyze> Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel. (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional)

(Optional) (Optional) (Optional) (Optional)

143

DiskBoss User Manual

Flexense Ltd.

Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list. File Matching Rules (Optional) DiskBoss Ultimate provides the user with the ability to limit the storage analysis process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the storage analysis process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Miscellaneous Parameters (Optional) Parameter filter Description The ‘filter’ element allows one to specify a file name filter instead of specifying file matching rules. For example, set the file name filter to ‘*.pdf’ to process all PDF documents. DiskBoss is capable of scanning multiple disks or directories in parallel thus improving the speed of the storage analysis process on multi-CPU/multi-core systems. The ‘scanning’ element allows one to control the file scanning mode. Set the scanning mode to 'PARALLEL' if you wish to scan all input disks and directories simultaneously. The DiskBoss GUI application provides the user with the ability to execute user-defined commands using keyboard shortcuts. Use the ‘shortcut’ element to specify a keyboard shortcut for the command.

scanning

shortcut

Process Options (Optional) Parameter streams Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the storage analysis process, use multiple processing streams when scanning input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the storage analysis process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.).

speed

Automatic Report Generation (Optional) The ‘report’ element instructs DiskBoss to automatically save results to a report file. The ‘type’ attribute may be set to ‘HTML’, ‘TEXT’ or ‘CSV’. An optional ‘title’ element may be used to set a custom report title. If the ‘save-to’ element is not specified, DiskBoss will automatically generate a file name and save the report into the user’s home directory. If the specified ‘save-to’ value represents an existing directory, DiskBoss will automatically generate a file name and save report into the specified directory. In all other cases, DiskBoss will save the report using the ‘save-to’ value as an absolute file name.

144

DiskBoss User Manual

Flexense Ltd.

Storage Analysis Actions (Optional) DiskBoss Ultimate allows one to define one or more conditional actions capable of detecting user-specified storage utilization patterns, executing automatic actions and sending e-mail notifications. The ‘mode’ attribute may be set to ‘PREVIEW’ or ‘EXECUTE’. In the ‘PREVIEW’ mode, the command will display the storage analysis results and a list of actions that were triggered. In the DiskBoss GUI application, the user will be provided with the ability to manually select actions that should be executed. In the ‘EXECUTE’ mode, DiskBoss will automatically execute all the triggered actions without showing storage analysis results. The actions list may include one or more conditional actions specifying conditions to detect and actions to execute for each directory meeting the specified condition. The ‘for’ element allows one to specify a condition that should be detected. Use the ‘mode’ attribute to set the condition mode to one of the following values: Mode EID EDU DIR Description Instructs to evaluate the condition for each input directory. Instructs to evaluate the condition for each directory under the directory specified as the value in the ‘for’ element. Instructs to evaluate the condition for the directory specified as the value in the ‘for’ element.

Use the ‘op’ attribute to set the condition operator to one of the following values: Operator EQ GT LT Description Triggers action when the evaluated value equal to the condition value. Triggers action when the evaluated value greater than the condition value. Triggers action when the evaluated value less than the condition value.

Use the ‘value’ attribute to set the condition value. The condition value, which should be specified as a decimal integer, will be evaluated according to the specified mode and operator. Use the ‘units’ attribute to set one of the following condition units. Value FILES MBYTES GBYTES TBYTES MSPACE GSPACE TSPACE PSPACE Description The condition The condition The condition The condition The condition The condition The condition The condition

value value value value value value value value

specifies specifies specifies specifies specifies specifies specifies specifies

a number of files. an amount of used space in MBytes. an amount of used space in GBytes. an amount of used space in TBytes. an amount of free space in MBytes. an amount of free space in GBytes. an amount of free space in TBytes. an amount of free space in percents.

Use the ‘do’ element to specify one of the following actions that should be executed: Mode EMAIL-HTML EMAIL-TEXT USER-CMD CUSTOM-CMD REPORT-HTML REPORT-TEXT REPORT-CSV Description Send an HTML e-mail notification to the specified e-mail address. Send a text e-mail notification to the specified e-mail address. Execute the specified user-defined command. Execute the specified custom command. Save an HTML storage analysis report to the specified file. Save a text storage analysis report to the specified file. Save a CSV storage analysis report to the specified file.

Depending on the specified action type, the ‘do’ element’s value will be used as an e-mail address, a command name or a report file name. For detailed information about all features related to storage analysis conditional actions refer to the DiskBoss product manual.

145

DiskBoss User Manual

Flexense Ltd.

13.6.4 Duplicate Files Search DiskBoss' built-in duplicate files finder provides a large number of advanced features and capabilities allowing one to identify and cleanup duplicate files on personal computers and enterprise storage systems. In addition, power users and IT professionals are provided with policy-based duplicate files detection and removal capabilities (DiskBoss Ultimate only) allowing one to define custom duplicate files detection and removal commands and execute them in a fully unattended, automatic mode. In addition to the ability to define duplicate files search commands using the DiskBoss GUI application, DiskBoss allows one to specify duplicate files search commands using an XMLBased format. The XML format provides support for all the duplicate files search features and capabilities available in the DiskBoss main GUI application. Duplicate files search commands defined in the XML format may be imported into the DiskBoss product configuration as userdefined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format: <duplicates name=’Command Name’> <inputs> <dir>Directory Name 1</dir> … <file>File Name 1</file> … </inputs> <actions mode=’Actions Mode’> <action>Action 1</action> … <action>Action X</action> </actions> <signature>Signature Type</signature> <sets>Max Duplicate File Sets</sets> <filter>File Scanning Filter</filter> <scanning>File Scanning Mode</scanning> <shortcut>Keyboard Shortcut</shortcut> <rules> <r1>Rule Data</r1> … </rules> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> </process> <exclude> <dir>Exclude Directory 1</dir> … </exclude> </duplicates> Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel. (Optional)

(Optional) (Optional) (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional)

(Optional)

146

DiskBoss User Manual

Flexense Ltd.

Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list. File Matching Rules (Optional) DiskBoss Ultimate provides the user with the ability to limit the duplicates search process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the duplicates search process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Miscellaneous Parameters (Optional) Parameter signature Description The ‘signature’ element allows one to set one of the following duplicate files search algorithms: MD5, SHA1 or SHA256 (default). The SHA256 algorithm is the most reliable one and it is used by default. The MD5 and SHA1 algorithms are significantly faster, but less reliable. The ‘sets’ element provides the user with the ability to control the maximum number of duplicate file sets (default is 1000) reported by DiskBoss. After finishing the search process, DiskBoss will sort all the detected duplicate file sets by the amount of the wasted storage space and display the top X duplicate file sets as specified by this parameter The ‘filter’ element allows one to specify a file name filter instead of specifying file matching rules. For example, set the file name filter to ‘*.pdf’ to process all PDF documents. DiskBoss is capable of scanning multiple disks or directories in parallel thus improving the speed of the duplicates search process on multi-CPU/multi-core systems. The ‘scanning’ element allows one to control the file scanning mode. Set the scanning mode to 'PARALLEL' if you wish to scan all input disks and directories simultaneously. The DiskBoss GUI application provides the user with the ability to execute user-defined commands using keyboard shortcuts. Use the ‘shortcut’ element to specify a keyboard shortcut for the command.

sets

filter

scanning

shortcut

Process Options (Optional) Parameter streams Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the duplicates search process, use multiple processing streams when scanning input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the duplicates search process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.).

speed

147

DiskBoss User Manual

Flexense Ltd.

Duplicate Files Removal Actions (Optional) DiskBoss Ultimate provides the user with the ability to predefine one or more automatic duplicates detection and removal actions. Each action may contain a number of rules specifying how to detect the original file in each duplicate file set and what action to perform if the original was successfully detected. Format: <actions mode=’Actions Mode’> <action> <original mode=’original mode’>original value</original> <rules> <r1>Rule Data</r1> … <rX>Rule Data</rX> </rules> <do>Action</do> </action> … <action>Action X</action> </actions> (Optional) (Optional)

Use the ‘mode’ attribute to set the actions mode to one of the following values: ‘SELECT’ or ‘EXECUTE’. In the ‘SELECT’ actions mode, DiskBoss will evaluate duplicate files and try to detect the original file in each set of duplicate files according to the specified original detection rules and policies. Actions containing the original file detection rules will be evaluated one after one in the order as they specified in the actions list. If a duplicate file will match rules defined in an action, the duplicate file will be set as the original and the matching action will be set as the active action for the duplicate set. The ‘EXECUTE’ mode is the most advanced duplicates detection and removal move, which is intended for automatic execution of actions matching one or more duplicate file sets. During the search process, DiskBoss will evaluate all duplicate files and set matching actions. After finishing the search process, DiskBoss will automatically execute all actions that were set and remove all duplicate files using policies defined in each specific action. The ‘original’ element controls the original file detection mode. If the ‘mode’ attribute is set to ‘MTIME’, the original file value should be set to ‘OLDEST’ or ‘NEWEST’ and in this case the original file will be set to the oldest or the newest file respectively. If the ‘mode’ attribute is set to ‘DIR’, the original value should specify a directory where original files should be located in. The ‘rules’ element is an optional element, which may be used to limit the duplicates removal action to specific file types according to the specified file matching rules. For detailed information about file matching rules refer to an appropriate section in this document. Use the ‘do’ element to specify the action that should be performed (or selected) for duplicate file sets with successfully detected original files. The ‘do’ element may be specified using one of the following formats: Action <do>LINK</do> <do>DELETE</do> <do mode=’MOVE-TO’>Directory</do> Description Replaces all duplicate files with links to originals. Deletes all duplicate files. Moves all duplicate files to the specified directory.

148

DiskBoss User Manual

Flexense Ltd.

13.6.5 File Synchronization DiskBoss provides advanced file synchronization capabilities allowing one to synchronize files between directories, local disks and network shares. The DiskBoss' built-in file synchronization engine offers numerous one-way and two-way file synchronization modes, rule-based file matching capabilities and advanced performance tuning options. Frequently used file synchronization operations may be pre-configured as user-defined commands and executed in a single mouse click. In addition to the ability to define file synchronization commands using the DiskBoss GUI application, DiskBoss allows one to specify file synchronization commands using an XML-Based format. The XML format provides support for all the file synchronization features and capabilities available in the DiskBoss main GUI application. File synchronization commands defined in the XML format may be imported into the DiskBoss product configuration as userdefined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format: <sync name='Command Name'> <source>Source Directory</source> <dest>Destination Directory</dest> <mode>Synchronization Mode</mode> <recursive>Recursive Mode</recursive> <preview>Preview Mode</preview> <shortcut>Keyboard Shortcut</shortcut> <rules> <r1>Rule Data</r1> … </rules> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> <copy>Copy Options</copy> </process> <exclude> <dir>Exclude Directory 1</dir> … </exclude> </sync> Mandatory Parameters Parameter source dest Description Use the ‘source’ element to specify the source directory for the file synchronization command. Use the ‘dest’ element to specify the destination directory for the file synchronization command. (Optional) (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional) (Optional)

(Optional)

File Matching Rules (Optional) DiskBoss Ultimate provides the user with the ability to limit the file synchronization process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the file synchronization process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document.

149

DiskBoss User Manual

Flexense Ltd.

Miscellaneous Parameters (Optional) Parameter mode Description The ‘mode’ element allows one to set one of the following sync modes: • SD (Synchronize Destination Directory, one-way, default mode) - All changes made in the source directory will be propagated to the destination directory. Files deleted from the source directory will be deleted from the destination directory. All files changed or deleted in the destination directory will be restored using files from the source directory. No changes will be made in the source directory. After the file synchronization process is complete both locations will be identical. SUD (Update Destination Directory, one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No changes will be made in the source directory. SAD (Accumulate and Update Files in Destination, one-way) - Newly created and modified source files will be copied to the destination directory. Files deleted from the destination directory will be restored using files from the source directory. Newly created and modified destination files will be kept in place. No files will be deleted from the destination directory. No changes will be made in the source directory. STW (Two-Way File Synchronization) - Newly created and modified files will be synchronized in both directions. Files deleted from the source directory will be deleted from the destination directory. Files deleted from the destination directory will be restored from the source directory. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical. STA (Two-Way Accumulation and Update) - Newly created and modified files will be updated in both directions. Files deleted from one location will be restored from the second location. Changes may be made in both locations. After the file synchronization process is complete both locations will be identical.

recursive preview shortcut

The ‘recursive’ element may be set to ‘YES’ or ‘NO’. If the ‘recursive’ element is set to ‘YES’ (default), DiskBoss will synchronize directories recursively including all subdirectories. The ‘preview’ element may be set to ‘YES’ or ‘NO’. If the ‘preview’ element is set to ‘YES’ (default), DiskBoss will show the file synchronization preview dialog allowing one to manually select or unselect files that should be synchronized. The DiskBoss GUI application provides the user with the ability to execute user-defined commands using keyboard shortcuts. Use the ‘shortcut’ element to specify a keyboard shortcut for the command.

Process Options (Optional) Parameter streams Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the file synchronization process, use multiple processing streams when synchronizing directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the file synchronization process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.). The ‘copy’ element may specify one or more of the following copy flags: • ATTR – Instructs to copy file attributes • DACL – Instructs to copy discrete access control lists (DACL) • SACL – Instructs to copy security control lists (SACL) • OWNER – Instructs to copy user/group ownership information

speed

copy

150

DiskBoss User Manual

Flexense Ltd.

13.6.6 File Organizing DiskBoss' file organizing capabilities allow one to perform various file management operations on files matching user-defined criteria. The user is provided with the ability to specify one or more file matching rules and define what action should be performed on all the matching files. Multiple file organizing operations may be performed during a single pass through the entire file system. For example, the user may backup recently modified documents, archive unused music files and cleanup temporary files during a single pass trough one or more file systems containing millions of files. In addition to the ability to define file organizing commands using the DiskBoss GUI application, DiskBoss allows one to specify file organizing commands using an XML-Based format. The XML format provides support for all the file organizing features and capabilities available in the DiskBoss main GUI application. File organizing commands defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format: <organize name='Command Name'> <inputs> <dir>Directory Name 1</dir> … <file>File Name 1</file> … </inputs> <action name='Action Name 1> <rules> <r1>Rule Data</r1> … <rX>Rule Data</rX> </rules> <do>Action</do> <process> <copy>Copy Options</copy> <verify>Verification Mode</verify> </process> </action> … <action name=’Action Name X’>Action Data</action> <preview>Preview Mode</preview> <shortcut>Keyboard Shortcut</shortcut> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> <progress>Progress Mode</progress> <retry-count>X</retry-count> <retry-delay>X</retry-delay> </process> </organize> (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional)

151

DiskBoss User Manual

Flexense Ltd.

Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel.

Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list.

File Matching Rules Each file organizing action should include a list of file matching rules specifying files that should be processed. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document.

Actions Use the ‘do’ element to specify the action that should be performed for all files matching the specified file matching rules. The ‘do’ element may be specified using one of the following formats:

Action <do mode=’COPY-TO’>Directory</do> <do mode=’MOVE-TO’>Directory</do> <do mode=’MOVE-AND-LINK’>Dir</do>

<do>DELETE</do>

Description Copies files matching the specified file matching rules to the specified directory. Moves files matching the specified file matching rules to the specified directory. Moves files matching the specified file matching rules to the specified directory and creates links pointing to the moved files in the destination directory. Deletes all files matching the specified file matching rules.

152

DiskBoss User Manual

Flexense Ltd.

Global Process Options (Optional)

Parameter streams

speed

progress

retry-count retry-delay

Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the file organizing process, use multiple processing streams when processing input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the file organizing process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.). The ‘progress’ element may be set to ‘YES’ or ‘NO’. If the ‘progress’ element is set to ‘YES’, DiskBoss will display a progress bar on the operation process dialog. In order to optimize the file organizing performance when processing large amounts of files, it may be significantly more efficient to disable the progress bar. The ‘retry-count’ element allows one to specify the number of retries should be made on locked source files for copy/move operations. The ‘retry-delay’ element allows one to specify a retry delay that should be made between retries to copy/move locked source files.

Action Process Options (Optional) Parameter copy Description The ‘copy’ element may specify one or more of the following copy flags: • ATTR – Instructs to copy file attributes • DACL – Instructs to copy discrete access control lists (DACL) • SACL – Instructs to copy security control lists (SACL) • OWNER – Instructs to copy user/group ownership information • TIME – Instructs to copy file timestamps The ‘verify’ element may be set to ‘YES’ or ‘NO’ (default). If the ‘verify’ element is set to ‘YES’, DiskBoss will verify each copied or moved file.

verify

Miscellaneous Parameters (Optional) Parameter preview Description The ‘preview’ element may be set to ‘YES’ or ‘NO’. If the ‘preview’ element is set to ‘YES’ (default), DiskBoss will show the file organizing preview dialog allowing one to manually select or unselect actions that should be performed. The DiskBoss GUI application provides the user with the ability to execute user-defined commands using keyboard shortcuts. Use the ‘shortcut’ element to specify a keyboard shortcut for the command.

shortcut

153

DiskBoss User Manual

Flexense Ltd.

13.6.7 File Copy DiskBoss provides a large number of advanced multi-stream file copy and rule-based data migration capabilities allowing one to copy vast amounts of files fast, efficiently and reliably. DiskBoss allows one to copy files including access control lists (ACLs), security attributes, ownership information, timestamps and file attributes. The user is provided with a large number of flexible copy performance tuning and fault tolerance options allowing one to copy data at various speeds, recover failed copy operations and minimize the potential impact on running production systems. In addition to the ability to define file copy commands using the DiskBoss GUI application, DiskBoss allows one to specify file copy commands using an XML-Based format. The XML format provides support for all the file copy features and capabilities available in the DiskBoss main GUI application. File copy commands defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed on-the-fly using the DiskBoss command line tool (DiskBoss Ultimate). Format:
<copy name='Command Name'> <inputs> <dir>Directory Name 1</dir> … <file>File Name 1</file> … </inputs> <dest>Destination Directory</dest> <shortcut>Keyboard Shortcut</shortcut> <rules> <r1>Rule Data</r1> … </rules> <process> <progress>Progress Mode</progress> <overwrite>Overwrite Mode</overwrite> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> <copy>Copy Options</copy> <retry-count>1</retry-count> <retry-timeout>62</retry-timeout> <verify>Verification Mode</verify> </process> </copy> (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional) (Optional)

(Optional) (Optional)

A file move command may be defined by using the ‘move’ command type instead of the ‘copy’ command type. All other parameters and options are completely identical.
<move name=’Command Name’> <!-- Command Data --> </move>

Mandatory Parameters Parameter
dest

Description
Use the ‘dest’ element to specify a destination directory for the copy command.

Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel.

154

DiskBoss User Manual

Flexense Ltd.

Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list. File Matching Rules (Optional) DiskBoss Ultimate provides the user with the ability to limit the file copy process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the file copy process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Overwrite Mode (Optional) Mode
ALLWAYS SKIP GEN-NAME IF-NEWER

Description
Always overwrites files already existing in the destination directory. Skips files already existing in the destination directory. Appends a unique file suffix and copies to the destination directory. Overwrites if the source file is newer than the destination file.

Process Options (Optional) Parameter
streams

Description
DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the copy process, use multiple processing streams when processing input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the copy process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.). The ‘progress’ element may be set to ‘YES’ or ‘NO’. If the ‘progress’ element is set to ‘YES’, DiskBoss will display a progress bar on the operation process dialog. In order to optimize the file copy performance when processing large amounts of files, it may be significantly more efficient to disable the progress bar. The ‘retry-count’ element allows one to specify the number of retries should be made on locked source files for copy/move operations. The ‘retry-delay’ element allows one to specify a retry delay that should be made between retries to copy/move locked source files. The ‘copy’ element may specify one or more of the following copy flags: • ATTR – Instructs to copy file attributes • DACL – Instructs to copy discrete access control lists (DACL) • SACL – Instructs to copy security control lists (SACL) • OWNER – Instructs to copy user/group ownership information • TIME – Instructs to copy file timestamps The ‘verify’ element may be set to ‘YES’ or ‘NO’ (default). If the ‘verify’ element is set to ‘YES’, DiskBoss will verify each copied or moved file.

speed

progress

retry-count retry-delay copy

verify

155

DiskBoss User Manual

Flexense Ltd.

13.6.8 File Delete DiskBoss provides the user with a large number of flexible file delete capabilities allowing one to delete huge amounts of files very fast and effectively. In addition, power computer users and IT professionals are provided with the ability to optimize performance of delete operations for user-specific storage configurations and performance requirements. Finally, users required to physically destroy confidential or classified information are provided with numerous multipass data wiping capabilities ranging from a simple single-pass wipe to a powerful, 7-Pass DOD 5220.22-M compliant (DiskBoss Ultimate) data wiping algorithm. In addition to the ability to define file delete commands using the DiskBoss GUI application, DiskBoss allows one to specify file delete commands using an XML-Based format. The XML format provides support for all the file delete features and capabilities available in the DiskBoss main GUI application. File delete commands defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed onthe-fly using the DiskBoss command line tool (DiskBoss Ultimate).

Format: <delete name='Command Name'> <inputs> <dir>Directory Name 1</dir> … <dir>Directory Name X</dir> <file>File Name 1</file> … <file>File Name X</file> </inputs> <rules> <r1>Rule Data</r1> … <rX>Rule Data</rX> </rules> <process> <streams>Number of Process Streams</streams> <speed file-delay=’X’ block-delay=’Y’>Mode</speed> <progress>Progress Mode </progress> <wipe>Wipe Mode</wipe> </process> (Optional) (Optional) (Optional) (Optional) (Optional)

</delete>

Command Inputs The inputs list should specify all the directories and files that should be processed. Each directory or file in the input list should include a full path name. Depending on the file scanning mode, all the specified directories will be processed sequentially (one after one) or in parallel.

156

DiskBoss User Manual

Flexense Ltd.

Special Input Modes

In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list.

File Matching Rules (Optional)

DiskBoss Ultimate provides the user with the ability to limit the file delete process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the file delete process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document.

Process Options (Optional)

Parameter streams

speed

progress

Description DiskBoss is optimized for multi-core/multi-CPU computers and advanced RAID storage systems and capable of scanning multiple file systems in parallel. In order to speed up the delete process, use multiple processing streams when processing input directories located on multiple physical hard disks or a RAID disk array. In order to minimize potential performance impact on running production systems, DiskBoss allows one to intentionally slow down the delete process. According to your specific needs, set the process speed mode to ‘FULL’, ‘MEDIUM’, ‘LOW’ or ‘MANUAL’. The ‘MANUAL’ performance mode required the ‘file-delay’ and ‘block-delay’ parameters to be specified (ms.). The ‘progress’ element may be set to ‘YES’ or ‘NO’. If the ‘progress’ element is set to ‘YES’, DiskBoss will display a progress bar on the operation process dialog. In order to optimize the file delete performance when processing large amounts of files, it may be significantly more efficient to disable the progress bar. The ‘wipe’ element may be set to one of the following values: ZERO-1 – wipes data using a single-pass, zero pattern algorithm ALT-2 – wipes data using a two-pass, alternating-pattern algorithm ALT-3 – wipes data using a three-pass, alternating-pattern algorithm ALT-4 – wipes data using a four-pass, alternating-pattern algorithm ALT-5 – wipes data using a five-pass, alternating algorithm DOD-7 – wipes data using a seven-pass, DOD 5220.22-M compliant algorithm BS-7 – wipes data using a seven-pass, Bruce Schneier's algorithm GMS-35 – wipes data using a 35-pass, Gutmann's Maximum Security algorithm

wipe

157

DiskBoss User Manual

Flexense Ltd.

13.6.9 Disk Monitoring DiskBoss Ultimate includes a built-in disk monitor capable of detecting file creations, modifications, attribute changes and deletions in real-time. The real-time disk monitor provides the user with the ability to monitor one or more disks, directories or network shares and detect all changes made in the monitored file systems. In addition, the user is provided with the ability to specify conditional real-time actions capable of executing DiskBoss' userdefined commands, custom commands, scripts or batch files. In addition to the ability to define disk monitoring commands using the DiskBoss GUI application, DiskBoss allows one to specify disk monitoring commands using an XML-Based format. The XML format provides support for all the disk monitoring features and capabilities available in the DiskBoss main GUI application. Disk monitoring commands defined in the XML format may be imported into the DiskBoss product configuration as user-defined commands or executed on-the-fly using the DiskBoss command line tool. Format: <monitor name='Command Name'> <inputs> <dir>Directory Name 1</dir> … </inputs> <detect>Change Types</detect> <recursive>yes</recursive> <shortcut>Keyboard Shortcut</shortcut> <rules> <r1>Rule Data</r1> … </rules> <actions changes='Change Count'> <report type=’Report Type’> <title>Custom Report Title</title> <save-to>Report File Name</save-to> </report> <user-command>Command </user-command> <custom-command>Command </custom-command> <email>E-Mail Address</email> </actions> </monitor> Mandatory Parameters: Parameter detect Description Use the ‘detect’ element to specify changes that should be detected: • FNAME – detect file name changes • DNAME – detect directory name changes • ATTR – detect file and directory attribute changes • SIZE – detect file size changes • ATIME – detect file access time changes • CTIME – detect file creation time changes • MTIME – detect file modification time changes • SECURITY – detect file security attributes changes (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional) (Optional)

(Optional) (Optional) (Optional)

158

DiskBoss User Manual

Flexense Ltd.

Command Inputs The inputs list should specify all the directories that should be monitored. Each directory in the input list should include a full path name. Special Input Modes In addition to the ability to process explicitly specified inputs, the DiskBoss GUI application provides two special input modes allowing one to process external parameters or the current directory instead of the inputs list. User-defined commands with the inputs mode set to the external-parameters mode are accepting drag-and-drop operations into the command item in the commands tool pane. In order to set a user-defined command to the external-parameters mode, specify <inputs>USER-PARAMS</inputs> instead of the regular input list. User-defined commands with the input mode set to the current-directory mode are processing the file navigator’s current directory. In order to set a user-defined command to the currentdirectory inputs mode, specify <inputs>CURRENT-DIR</inputs> instead of the input list. Miscellaneous Parameters (Optional) Parameter recursive Description The ‘recursive’ element may be set to ‘YES’ or ‘NO’. If the ‘recursive’ element is set to ‘YES’ (default), DiskBoss will monitor directories recursively including all subdirectories. The DiskBoss GUI application provides the user with the ability to execute user-defined commands using keyboard shortcuts. Use the ‘shortcut’ element to specify a keyboard shortcut for the command.

shortcut

File Matching Rules (Optional) DiskBoss provides the user with the ability to limit the disk monitoring process to files matching user-defined criteria. An optional list of file matching rules may specify one or more rules that should be used during the disk monitoring process. All the specified file matching rules will be evaluated in the same order as they are specified in the user-defined command. DiskBoss supports a large number of various types of rules capable of matching files by the file extension, name, path, size, time, content, etc. For detailed information about all the supported types of file matching rules refer to an appropriate section in this document. Actions (Optional) One of the most powerful capabilities of the DiskBoss' real-time disk monitor is the ability to perform user-defined actions each time the disk monitor reaches a user-specified number of changes. Specify one or more actions and set the ‘changes’ attribute to the required number of changes. Each specified action may save a change report, execute a user-defined command and/or execute a custom command. The ‘report’ element instructs DiskBoss to automatically save changes to a report file. The ‘type’ attribute may be set to ‘HTML’, ‘TEXT’ or ‘CSV’. An optional ‘title’ element may be used to set a custom report title. If the ‘save-to’ element is not specified, DiskBoss will automatically generate a file name and save the report into the user’s home directory. If the specified ‘save-to’ value represents an existing directory, DiskBoss will automatically generate a file name and save report into the specified directory. In all other cases, DiskBoss will save the report using the ‘save-to’ value as an absolute file name. Use the ‘user-command’ element to specify the name of a user-defined command that should be executed each time the monitoring command reaches the specified number of changes. Use the ‘custom-command’ element to specify the name of an executable or a batch file that should be executed. The ‘email’ element allows one to specify an E-Mail address to send notifications to when the monitoring operation will reach the specified number of changes.

159

DiskBoss User Manual

Flexense Ltd.

14 Appendix
14.1
32-Bit • • • • • • • • • • 64-Bit • • • • • • • • • Windows XP Professional 64-Bit Windows Server 2003 64-Bit Windows Vista 64-Bit Windows Server 2008 64-Bit Windows 7 64-Bit Ubuntu Linux Debian Linux Fedora Linux Redhat Linux Windows 2000 Windows XP Windows Server 2003, Windows Server 2003 R2 Windows Vista Windows Server 2008 Windows 7 Ubuntu Linux Debian Linux Fedora Linux Redhat Linux

Supported Operating Systems

14.2

System Requirements

Minimal • • • 1 GHz or better CPU 512 MB of system memory 25 MB of free disk space

Recommended • • • 2 GHz dual-core or better CPU 1 GB of system memory 25 MB of free disk space

Ultimate • • • • 2 GHz quad-core or better CPU 2 GB or more of system memory Gigabit Ethernet or Fibre Channel link to the storage device 25 MB of free disk space

160

DiskBoss User Manual

Flexense Ltd.

14.3

Default Keyboard Shortcuts

All keyboard shortcuts are fully customizable and may be changed on the DiskBoss options dialog. In addition, the user is provided with the ability to define custom keyboard shortcuts for file system location bookmarks and jump to any directory in a single key press. Keyboard Shortcut
ESC HOME END UP, LEFT DOWN, RIGHT ENTER, RETURN F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F12 CTRL + A CTRL + U, Backspace CTRL + B CTRL + T CTRL + C CTRL + X CTRL + V CTRL + O CTRL + P CTRL + R CTRL + N DEL

Operation
Clears current selection Selects the first item in the main view Selects the last item in the main view Selects the previous item in the main view Selects the next item in the main view Opens directory or file Opens online help Navigates to the Computer Home Starts search Starts file organizing Starts file classification Starts storage utilization analysis Starts duplicate files search Starts disk clean-up operation Starts Copy-To operation Starts Move-To operation Opens Advanced Commands Management Dialog (Ultimate Only) Selects all items in the main view Navigates to the parent location (Go Up) Bookmarks the current location Opens a terminal window Copies the current selection Cuts the current selection Starts a copy or move operation (After CTRL ^ C or CTRL ^ X) Open Selected File With … Open the file properties dialog Refresh the current view Rename the currently selected file or directory Starts delete operation

161

Sign up to vote on this title
UsefulNot useful