Rules and Queries - Data Classification Enabler

Topics | How To

Overview

Use query string as rule

Overview

Data Classification uses the traditional rules established for the supported File Archiver Agents. In addition, it provides several unique rules. These rules are available only when Data Classification is enabled for the supported agent, and the rules apply only to local data. All the rules for Data Classification are configurable from the DataClassSet subclient properties Rules tab of the File Archiver Agent.

The unique Data Classification rules include the following:

• Folders/Files Owned By - Allows you to select and exclude files belonging to specific users and user groups
• File Paths - Allows you to select and exclude files based on file location and specific file characteristics (e.g., file extensions)
• SQL Query Strings - Allow you to use SQL query-like commands to define more complex rules based on your requirements

Whenever a DataClassSet subclient is created, a default set of rules is established. These rules are reflected in the various rules tabs. Also, the SQL query string, which has its own tab, is automatically disabled; however, the default set of rules is formulated into the SQL query string. At this point, you can start changing rules either from the various rules tabs or within the SQL query string.

If you change rules from the various rules tabs, these rules will be formulated into the SQL query string (which is still disabled). However, if you choose to enable and edit the SQL query string, the rules reflected in the string will be enforced, and the rules previously established by the various rules tabs will be disabled. Subsequently, if you disable the rules in the SQL query string, the rules that were previously in effect via the various rules tabs will be enforced.

Each DataClassSet subclient has its own rules, and these rules can be shared by other DataClassSet subclients; however, changing the rules in one DataClassSet subclient will not affect the rules in another DataClassSet subclient.

See Migration Archiving - File Archiver Agents for more information.

Use query string as rule

Warning:  SQL query string rules are intended only for advanced users, and they should be changed only at the risk of such users. If in doubt, do not change rules using SQL query strings without assistance from your Software Provider. Also, whenever you are modifying a SQL query string, be sure not to remove the following special tokens:

• For Windows, do not remove GALAXY_DIR, WINDOWS_DIR, and SYSTEM_DIR
• For Unix, do not remove SYSTEM_DIR (/tmp, /usr, /etc, /kernel, etc.)

Removing any of these tokens may yield undesired results.

By default, the rules that you select from the various rules tabs are formulated into a query that is used during archiving. This query is available from the Rules/Advanced tab within DataClassSet subclient properties. You can change the settings in this query to extend rules capabilities beyond what is possible using just the various rules tabs.

You can use the following database fields to create customized user-defined queries:

• Windows:
  • shortName - the file name
  • fullPath - the fully qualified path and file name
  • attrs - the file or folder attributes stored as a single decimal value (see the attribute definitions in the table below)
  • fileSize - the file size (in bytes)
  • lowFreeVolume - the low water free space on the volume expressed as a percentage
  • highFreeVolume - the high water free space on the volume expressed as a percentage
  • username - the file owner expressed as a domain\user name if the computer is in a domain; if not, the file owner is expressed as computer name\user name
  • groupname - the name of an Active Directory group (Windows)
• Unix:
  • NAME - the file name
  • ANAME - the fully qualified path and file name
  • SIZE - the file size (in bytes)
  • lowFreeVolume - the low water free space on the volume expressed as a percentage
  • highFreeVolume - the high water free space on the volume expressed as a percentage
  • USER - the file owner
  • GROUP - the name of the group

For Windows only, the following table includes the SQL advanced query values for file attributes in decimal and the associated meaning for each value. You can combine these values as necessary.

The following operators are supported:

• For Windows, AND, OR, NOT, LIKE, IN, =, <, >, %, and & are supported. Also, all queries must begin with "find files where". For example:

  find files where fullPath like 'c:\users\tom%'

• For Unix, AND, OR, NOT, LIKE, IN, =, <, >, %, and & are supported. Also, all queries must begin with “SELECT ANAME,SIZE,FILE_TYPE,CTIME,MODE from files where”. For example:

  “ sql query: SELECT ANAME,SIZE,FILE_TYPE,CTIME,MODE from files where ANAME LIKE '/lvfsdmdc/Logs1/%'

Before running a job, you can test your query to raise the confidence level that the correct files will be archived. See Test Your Query Before it Runs for a step-by-procedure.

Back to Top