Syntax:

CA AuthMinder Administration Guide › Managing Reports › arreporttool: Report Download Tool › Using the Tool › Syntax:

Syntax:

Run the following command to use the tool:

java -jar arreporttool.jar --protocol <protocol> --host <host> 
--port <app_server_port> --admin-orgid <admin-organization> 
--admin-id <admin-user-id> --admin-password <password> 
[--report-type hour | day | month [duration] | range] 
--report-id <Report ID> --reporturl <Url of the report> 
--is-filter-req <true | false> --data-type <Data Type> 
--reportdata [Report Data] --start-date-time <date-and-time> [--end-date-time <date-andtime>] [--logfile <logfile>] 
[--log-level <loglevel>][log-file-max-size] <logfilesize>] [--organizations <target orgNames>] [--userName <User/Admin Name>] [--output-file <output-file>.CSV] [--is-url-encoded [true|false]]

The following table lists the options that are supported by the tool:

Option	Description
protocol	The protocol being used for communication. The possible values are http and https. The default protocol is http.
host	The host name or the IP address of the system where you have deployed the Administration Console.
app_server_port	The port at which the Console is listening.
admin-orgid	The organization to which the administrator belongs.
admin-id	The unique administrator ID.
admin-password	The administrator password
report-type	Specify hour, day, month, or range. Hour, day, month can be followed by a numeric number. For example, --report-type day 2 indicates two days of records from the start-date-time specified. Range: If range is specified, enter an end-date-time.
report-id	Identifier of the report to be fetched. See "List of Report Identifiers" for the list of report identifiers that you can use.
reporturl	Administrator URL of the report. See "List of Report URLs" for the list of report URLs that you can use.
is-filter-req	This is true by default. Set this value to false for reports that do not have a filter page, for example, AuthMinder reports.
data-type	This is applicable only for AuthMinder reports to specify ACTIVE or STAGING.
reportdata	In addition to start and end dates, certain reports need additional filters. These additional filters can be specified as report data. The report data must be in the 'key=value' format. You can use a semicolon to separate multiple key-value pairs. The report data must be URL-encoded if it contains ; or =. Ensure that you set the is-url-encoded parameter to true if URL-encoded value is passed.
start-date-time	Specify the date or time after which report content must be fetched. Format: MM/dd/yyyy HH:mm:ss Hour (HH) and Minutes (mm) are optional and are used only for hourly reports. For daily and monthly reports, only the date part is used. By default, the TimeZone is in GMT. Example: 03/21/2010 09:10:20
end-date-time	[Optional] Specify the end date and time till which the report content should be selected.
logfile	[Optional] Specify the location of the log file. If no log file is specified, the arreporttool.log file is automatically created in the current directory.
log-level	[Optional] Specify the log level. Default log level is INFO.
log-file-max-size	[Optional] Specify the maximum size of the log file. The default value is 10MB.
organizations	[Optional] Specify semicolon-separated target organization names for the report. You must specify this value for reports that have organizations as a mandatory parameter. The value must be URL-encoded if the organization name contains a semicolon(;). Ensure that you set the is-url-encoded parameter to true if a URL-encoded value is passed.
userName	[Optional] Specify the user or administrator name.
output-file	[Optional] Specify the output file where the report content must be written. If no file name is specified, <reporttype>-timestamp.CSV is used.
is-url-encoded	[Optional] Set this value to true or false depending on whether your report data and organizations contain URL-encoded information. The default value is false.