Custom Reports

The XML tags present in an exported custom report XML file.

XML Tag Description
Name Name of the custom report.
Description Description of the custom report.
ReportType Type of report upon which this custom report is based. No spaces are included in the ReportType definition.
ShareType Flag indicating whether this report is shared with other users on the appliance so they can run it.

0 = No. 1 = Yes.

IsSummary Flag indicating whether the report is a summary or real-time report.

0 = Real-Time. 1 = Summary.

FormValues The tags under FormValues map directly to the fields in the UI report screen.
device Name of the log source on which the report is run.
deviceType Type of device on which the report is run.
reportType Type of report upon which this custom report is based. No spaces are included in the reportType definition.
timeInterval Indicates whether the report is run hourly (hours), daily (days), or in a specific date/time period (specificTime).
csv Flag indicating whether to save the custom report output in a .csv file.

1 = Yes. 0 = No.

day (when timeInterval is days only)

Day on which the report is run, either Today or Yesterday.

hour (when timeInterval is hours only)

Hours on which the report is run: Last Hour, Last 2 Hours, Last 4 Hours, etc.

fromDate (when timeInterval is specificTime only)

Start date of the time period on which the report is run.

fromTime (when timeInterval is specificTime only)

Start time of the time period on which the report is run.

toDate (when timeInterval is specificTime only)

End date of the time period on which the report is run.

toTime (when timeInterval is specificTime only)

End time of the time period on which the report is run.

expression Name of the search filter used by the custom report.
pageType Type of page from which the custom report was saved: either filterPage or reportPage.
predefined Name of the pre-defined search filter selected for this report.
FormValues​AdvancedOption Advanced Options definitions for this custom report vary for every report type based on available Advanced Options for the report. The basic structure follows this example: 
<Param><name>reportDescriptionText</name>
<value>Active Directory Continuity Report
</value>
</Param>
Next topic: Devices and Device Groups
Previous topic: Alerts