View source for Reports

[[Category:Applications]]
<span style="display:none" class="helpSource reports">Reports</span>
<span style="display:none" class="helpSource reports_status">Reports#Status</span>
<span style="display:none" class="helpSource reports_data">Reports#Data</span>
<span style="display:none" class="helpSource reports_email_templates">Reports#Email_Templates</span>
<span style="display:none" class="helpSource reports_reports_users">Reports#Reports_Users</span>
<span style="display:none" class="helpSource reports_name_map">Reports#Name_Map</span>
<span style="display:none" class="helpSource reports_all_reports">Reports#All_Reports</span>
<span style="display:none" class="helpSource reports_reports">Reports#Reports</span>

{| width='100%'
|-
| align="center" | [[Image:Reports_128x128.png]] &nbsp; &nbsp; '''Reports'''
| align="center" |
{|
|-
| Other Links:
|-
|[http://www.untangle.com/store/reports.html Reports Description Page]
|-
|[http://demo.untangle.com/admin/index.do#service/reports Reports Demo]
|-
|[http://forums.untangle.com/reports/ Reports Forums]
|-
|[[Reports FAQs]]
|}
|}
<br/>
----


== About Untangle Reports ==

Reports provides users with detailed statistics of the traffic and activity on your network.

These reports can be viewed online, either through the administration interface or through the separate reporting interface available to non-administrators reporting-only users.

Report summaries can be sent via email, which includes basic information and a link to view the online reports if the user has access. 

Reports can backup your data in multiple formats to Google Drive for long term storage.

[[Image:112_report_viewer_081015.png|700px|center|Web Filter - Reports]]


== Settings ==

This section reviews the different settings and configuration options available for Reports.


=== Status ===

On this tab you can click '''View Reports''' to open up Reports in a new browser tab.

{{ServiceAppScreenshot|reports|status}}


=== All Reports ===

This is the full list of all currently existing reports. This includes all the default reports and any custom reports that have been added.

To edit a report, click on ''View'' and then click on ''Settings.''

To delete a custom reports, click on ''View'' and then click on ''Delete.''

To create a new custom report, click ''View'' on an existing similar report, then click ''Settings'' then change the name and click ''Save as New Report.''

To create a report from scratch, goto ''Reports'' and click on ''Create New'' in the lower left.
When creating reports from scratch, each field must be carefully chosen and tuned until the desired data is provided. This process can be time consuming and difficult. It is suggested to work with a similar report to required the desired result. Additionally you can ask for help via support or the forums and import the report if someone can craft it for you.

If creating a report from scratch, the settings and fields and their purposes are described below.

{{ServiceAppScreenshot|reports|all-reports}}

==== Report Entry ====

A report is many settings that essentially describe how to craft a SQL query and how to display the data.
Here are the fields:

{| border="1" cellpadding="2"
|+
! Name !! Value !! Available !! Description

|- 
| style="width: 20%;"|Report Type
| Text, Pie Graph, Time Graph, Time Graph Dynamic, Event List
| The type of graph

|-
| Title
| Text
| All
| The report title

|-
| Category
| Any existing category/application
| All
| The category in which the report is located

|-
| Description
| Text
| All
| A brief description of the report

|-
| Text String
| Text
| Text
| The text used to create the Text Report Type

|-
| Pie Group Column
| Text
| Pie Graph
| The column to "group by" in top X charts (usually user, host, etc)

|-
| Pie Sum Column
| Text
| Pie Graph
| The column to sum in the top X charts (usually count, bytes, etc)

|-
| Order By Column
| Text
| Pie Graph
| The column to order by

|-
| Graph Style
| Pie, Pie 3D, Donut, Donut 3D, Column, Column 3D
| Pie Graph
| The render style of the pie graph

|-
| Pie Slices Number
| Integer
| Pie Graph
| The number of slices to display

|-
| Units
| Text
| Pie Graph
| The units being displayed (usually bytes, sessions, etc)

|-
| Graph Style
| Line, Area, Stacked Area, Column, Overlapped Column, Stacked Columns
| Time Graph
| The render style of the time graph

|-
| Time Data Interval
| Auto, Second, Minute, Hour, Day, Week, Month
| Time Graph
| The time aggregation unit or resolution

|-
| Approximation
| Average, High, Low, Sum
| Time Graph
| The method used to aggregate/combine data points 

|-
| Units
| Text
| Time Graph
| The units being displayed (usually bytes, sessions, etc)

|-
| Series Renderer
| None, Interface, Protocol
| Time Graph
| The renderer used to display human-readable names

|-
| Dynamic Column
| Text
| Time Graph Dynamic
| The column to select for/group by

|-
| Dynamic Value
| Text
| Time Graph Dynamic
| The value to sort by and display

|-
| Dynamic Limit
| Integer
| Time Graph Dynamic
| The number of series to show

|-
| Aggregation Function
| Count, Sum, Min, Max
| Time Graph Dynamic
| The function used to aggregate by dynamic values grouped by dynamic column

|-
| Graph Style
| Line, Area, Stacked Area, Column, Overlapped Column, Stacked Columns
| Time Graph Dynamic
| The render style of the time graph

|-
| Approximation
| Average, High, Low, Sum
| Time Graph Dynamic
| The method used to aggregate/combine data points 

|-
| Units
| Text
| Time Graph Dynamic
| The units being displayed (usually bytes, sessions, etc)

|-
| Series Renderer
| None, Interface, Protocol
| Time Graph Dynamic
| The renderer used to display human-readable names

|-
| Colors
| Colorpicker
| All
| The color pallete to use

|-
| Display Order
| Integer
| All
| The integer used to determine the report's position in the category list

|}


=== Data ===

* '''Data Retention''': This value controls how much time report data is kept on disk. Please note that increasing the number increases the amount of disk space that is needed for data storage.

* '''Upload Data to Google Drive'' If enabled, and the Google Connector in [[Directory Connector]] is enabled, your daily data will be uploaded to google drive each night for safe storage.

* '''Upload CSVs to Google Drive'' If enabled, and the Google Connector in [[Directory Connector]] is enabled, your daily CSV files will be uploaded to google drive each night for safe storage.

* '''Google Drive Directory''' configures which subdirectory data will be uploaded to in google drive.

* '''Import/Restore Data Backup Files''' imports data from a previous backup into the database. ''NOTE:'' this directly imports the SQL contents. If you have upgraded and the database schema has significantly changed since the time of the back, the import will not work correctly.

{{ServiceAppScreenshot|reports|data}}


=== Email Templates ===

You can customize emailed reports using Report Templates.  You can create as many as you wish with any combination of:

:* '''Interval''': Daily, Weekly, Monthly, Week to Date, Month to Date.  The determines the time interval that the report will cover. Beware that enough data is available via the Retention settings to provide the data for the configured interval.
:* '''Mobile''': Generate chart images more appropriate for a mobile device.
:* '''Reports''':   Select those reports under Config and Application sections.  Text and chart reports are allowed but not event list reports.  Reports for applications will be included only if that application is installed.

Additionally, you can copy the settings for an existing report.

The default Daily Reports template includes common text and chart reports for your system.  This template is fixed and cannot be changed or modified.  

Email Templates must be associated with Report Users.

{{ServiceAppScreenshot|reports|email-templates}}

=== Reports Users ===

Reports users are users that are not administrators, but can still view reports.

:* '''Email Address''' is the email address (and username) of the report user. ''admin'' is a special case that determines if administrators will receive emails and alerts.
:* '''Email Alerts''' determines if this reports user will receive email alerts.
:* '''Email Reports''' determines if this reports user will received email report summaries.
:* '''Email Templates''' determines which email report summaries this user will receive if ''Email Reports'' is enabled.
:* '''Online Access''' determines if the reports user has online access to the reports web application.
:* '''Change Password''' changes the password for this reports user.

{{ServiceAppScreenshot|reports|reports-users}}


=== Name Map ===

You can use the Name Map to manually configure the hostname for hosts. Untangle often can automatically determine the hostname for the IP automatically via DHCP or other methods. You can view the current names for currently active hosts in the [[Hosts]]

However, when Untangle is unable to automatically determine a hostname for an IP the Name Map provides a way to manually name them. 

{{ServiceAppScreenshot|reports|name-map}}


== Accessing Reports ==

If a user is set up to receive email report summaries, they only need to view or download the HTML attachment to see an overview report. If they need more information or would like to drill down to specific users or machines, they can use the link in the email, which will open Reports on the Untangle if it is accessible from their location. 

To access Reports directly from a browser, you have two options:

* '''Outside the Untangle's network''': Browse to the IP of the Untangle /reports using HTTPs, such as <tt>https://1.2.3.4/reports</tt>.
* '''Inside the Untangle's network''': Browse to the IP of the Untangle /reports, such as <tt>https://192.168.1.1/reports</tt>.

Please note that to view Reports from outside the network you'll need to check '''Allow HTTPS on WANs''' at '''Config > Network > Advanced > Filter Rules'''. If you have changed the '''External HTTPS Port''', you'll need to use the proper HTTPS port when connecting from the outside.

{{:Report Viewer}}

== Related Topics ==

[[Custom Reports]]

== Reports FAQs ==

{{:Reports FAQs}}