Using the Tool

CA RiskMinder Administration Guide › Managing Reports › Exporting Reports › arreporttool: Report Download Tool › Using the Tool

Using the Tool

The arreporttool.jar file is available at the following location:

On Windows:

<install_location>\Arcot Systems\tools\common\arreporttool

On UNIX Platforms:

<install_location>/arcot/tools/common/arreporttool

Syntax:

Run the following command to see the help associated with the tool:

java -jar arreporttool.jar --help

Run the following command to use the tool:

java -jar arreporttool.jar --protocol <protocol> --host <host> 
--port CA Portal --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 describes the options supported by the tool.

Option	Description
protocol	The protocol that is 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 Administration Console.
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 is specified. Range: If range is specified, end-date-time is mandatory.
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, RiskFort reports.
data-type	This is applicable only for RiskFort reports. This option specifies whether data type is 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 an URL-encoded value is passed.
start-date-time	Specify the data 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. Example: 03/21/2010 09:10:20
end-date-time	[Optional] Specify the end date and time till which report content should be selected.
logfile	[Optional] Specify the location of the log file. If no log file is specified, the 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 10 MB.
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. <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.