Search <book_title>...

Veritas Data Insight Administrator's Guide

Last Published: 2020-07-14

Product(s): Data Insight (6.1.5)

Name

reportcli.exe — a utility to create reports using a properties file that contains the input parameters, execute and list configured reports, check the status of the reports, and cancel report runs.

SYNOPSIS

reportcli.exe  -  - list-jobs¦ -  - list-reports¦ -  - list-outputs¦ -  - create
 -  - execute¦ -  - cancel¦ -  - help [OPTIONS]

reportcli.exe  - c

reportcli.exe  - e

reportcli.exe  - h

reportcli.exe  - j

reportcli.exe  - l

reportcli.exe  - o

Options

reportcli.exe -n -r <name of report> -p <property file path> -u <user name of creator> [-rt <report type>] [--users <path of users' .csv file>] [-t <path of .csv file of paths>] [--custodian <path of custodian' .csv file>]

Creates a report using the properties file in which the input parameters are specified. The following attributes apply:

*-r --report <name of report>*	Creates a report with the specified name.
*-p --properties <property file path>*	Property file containing the input parameters for the report. Note: By default, a sample properties file is installed in the INSTALL_DIR/DataInsight/reports folder.
*-u --creator <user name of creator>*	Creator of the report.
*-rt --type <report_type>*	Creates the specified report type. For example, Activity Details report.
*--users <path of users' .csv file>*	Path of the .csv file containing the names of users in the user@domain,<user group> format. Specify the path to input user information for the report.
*--paths <path of .csv file of paths>*	Path of the .csv file containing the fully qualified paths of the data for which you want to create the report.
*--custodian <path of custodian' .csv file>*	Path of the .csv file that contains information about custodians on configured paths. The names of the custodians are specified in the .csv file in the format user@domain. Specify the path to the custodian.csv file to include custodian information in the report.

- j: Lists the report jobs that are currently running.

- l: Lists all configured reports.

- o - m <TOP_N> - r <Report Name>: Lists all report outputs. The following attributes apply:

*- m --max <TOP_N>*	Limits output to specified number of records, and lists the latest output first. If the number of records is not specified, prints status for the last run.
*- r - - report <Report Name>*	Prints the status of jobs for the specified report. You can either specify the report ID or the report name.
*- rt - - type<Report Type>*	Prints the status of jobs for the specified report type.

report.exe - e [ - d <Output_Dir> - r <Report Name> - w <Max_Wait>: Executes report. The following attributes apply:

*- d --output <Output_Dir>*	The generated report output, including the SQLite database is copied to the specified directory. If you specify this option, you do not have to pass the - -w option.
*- r --report<Report Name>*	Executes the specified report. You can either specify the report ID or the report name.
*- -w --wait <Max_Wait>*	Returns the report output only after the report execution is complete or the specified wait time in minutes is exceeded. Specify - 1 to wait forever.

reportcli.exe -e -r <name of report> [-rt <report type>]--p <property file path> --creator <user name of creator> [--output <Output_Dir>] [--users <path of users' .csv file>] [--paths <path of .csv file >] [--wait <MAX_WAIT>] [--custodian <path of custodian' .csv file>]

Executes a report using the properties file in which the input parameters are specified. The following attributes apply:

*-r --report <name of report>*	Creates a report with the specified name.
*-p -properties <property file path>*	Property file containing the input parameters for the report.
*-u --creator <user name of creator>*	Creator of the report.
*--custodian <path of custodian.csv>*	Path of the .csv file containing the names of the custodians
*-d --output <OUTPUT_DIR>*	Copies the report database and output to specified location.
*-rt --type <report_type>*	Creates the specified report type. For example, Activity Details report.
*--users <path of users' .csv file>*	Path of the .csv file containing the names of users in the user@domain,<user¦group> format.
*--paths <path of .csv file* >**	Path of the .csv file containing the fully qualified paths of the data for which you want to create the report.
*-w --wait<MAX_WAIT>*	If the wait time is specified, the command returns only after the report is executed OR the specified wait time in minutes is exceeded. Specify -1 to wait forever. Data Insight cancels the report execution if the wait time is exceeded.
*--custodian <path of custodian' .csv file>*	Path of the .csv file that contains information about custodians on configured paths. The names of the custodians are specified in the .csv file in the format user@domain. Specify the path to the custodian.csv file to include custodian information in the report.

Reportcli.exe - sa op_excl_path [ - ap <FILE_PATH>] - at <ATTRIBUTE NAME> - av <ATTRIBUTE VALUE>] -ty <ATTRIBUTE TYPE> --path - r <name of report> -rt <report type>

Creates a report by excluding the paths specified in the .csv file for computing open shares data on the Data Insight dashboard. The following attributes apply:

*- ap <file path>*	Path of the .csv file containing the fully qualified paths that you want to exclude from open share computation for the dashboard.
*-rt --type <report_type>*	Creates the specified report type.
*-r --report <name of report>*	Creates a report with the specified name.

You can exclude any path on a file server or a SharePoint server from the dashboard data computation. However, Data Insight does not support the exclusion of DFS paths using this method.

report.exe - c - i <JOB_ID>: Cancels execution of the specified report job.