Veritas Data Insight User's Guide
- Section I. Introduction
- Section II. Data Insight Workspace
- Navigating the Workspace tab
- Analyzing data using the Workspace views
- Viewing access information for files and folders
- Viewing user activity on files or folders
- About visualizing collaboration on a share
- Viewing access information for users and user groups
- Section III. Data Insight reports
- Using Data Insight reports
- About Data Insight security reports
- Permissions reports
- Permissions Search report
- Creating a Permissions Query Template
- Permissions Query Template actions
- Ownership Reports
- About Data Insight storage reports
- About Data Insight custom reports
- Managing reports
- Viewing reports
- Using Data Insight reports
- Section IV. Remediation
- Configuring remediation workflows
- Managing workflow templates
- Creating a workflow using a template
- Managing workflows
- Using the Self-Service Portal
- About the Self-Service Portal
- Managing data
- About managing data using Enterprise Vault and custom scripts
- About adding tags to files, folders, and shares
- Managing permissions
- Configuring remediation workflows
- Appendix A. Command Line Reference
Creating DQL reports with custom variables
Data Insight further extends the flexibility of DQL reports by allowing you to define custom variables and passing the parameter values at runtime. With this, you can leverage the same DQL report to generate multiple outputs by passing different values when executing.
To define custom variables
In the DQL Query tab while creating a DQL report, declare the custom variables in the query in the following format:
"_dqlparam_<variableName>_"
Where,
'dqlparam_' is the prefix, and '_' (underscore) is a suffix for the 'variableName', which is the name of the actual variable that you want to define.
A variable name can be a combination of the following characters:
alphanumeric characters [a-z, A-Z, 0-9]
underscore [ _ ]
dot [ . ],
hyphen [ - ].
Example:
FROM path GET absname, size AS size_bytes, formatdate(created_on,'YYYY/MM/DD HH:MM:SS Z') AS creation_time, formatdate(last_accessed,'YYYY/MM/DD HH:MM:SS Z') AS last_accessed_time, formatdate(last_modified,'YYYY/MM/DD HH:MM:SS Z') AS last_modified_time IF type = "FILE" AND extension IN ("_dqlparam_ext_") AND device.name IN ("_dqlparam_device_") SORTBY size DESC
In this example, the variables defined in the IF clause are:
Key
Value
ext
to contain the extensions such as txt, pdf, png etc.
device
to contain the device names such as filer1, 10.209.89.3 etc.
Click Validate Query to ensure that the query does not have errors.
You can use the following system variables in the Advanced options tab while creating a DQL report to fetch the corresponding attributes at runtime. You can also define custom variables in the Advanced Options in the same format as described above.
Note:
You do not need to provide values for these variables. The values are automatically assigned while executing the report.
Variable name | Description |
---|---|
"dqlparam_report-name_" | Name of the report |
"dqlparam_report-type_" | Type of the report |
"dqlparam_report-id_" | Report ID |
"dqlparam_report-run-id_" | Report instance ID |