{= include("docs.util"); start_docs_page(docs.technical_manual.page_titles.reports); =}
Reports
Reports, created with $PRODUCT_NAME, present log file statistics in an attractive and easily navigable format.
The header of the Reports page is a bar containing the following:
Logo: The logo for $PRODUCT_NAME
Profile Name: The name of the active profile, the profile whose reports are being displayed
Admin: A link to the administrative interface, the profiles list, and other administrative functions
Logout: A link to log out of $PRODUCT_NAME
Help: A link which opens a new window containing the $PRODUCT_NAME documentation
Below the header is a bar which contains the following:
Reports: A link to the Reports, which should be selected if you are current in the Reports. Click this link to get to the Reports from another page.
Config: A link to the Config page, where you can perform profile actions (like rebuilding the database) and change profile options.
Calendar: Click this to open the Calendar window, where you can select a single day, month, or year to use as the date/time filter. When you have selected an item in the Calendar, all reports will show only information from that time period, until the date/time filter is removed (by clicking "Show All" in the Calendar).
Date Range: Click this to open the Date Range window, where you can select a range of days to use as the date/time filter. When you have selected a range in the Date Range, all reports will show only information from that time period, until the date/time filter is removed (by clicking "Show All" in the Calendar).
Filter: Click this to open the Global Filter window, where you can create filters for any fields, in any combination. Filters created here dynamically affect all reports; once you have set a Global Filter, all reports will show only information for that section of the data. Global Filters remain in effect until you remove them in the Global Filter window.
At the left of the window is the Reports Menu, which lets you select the report to view. Clicking a category will expand or collapse that category; clicking a report name will change the report display to show that one. Clicking a report name will remove any Zoom filters, but will not remove Global Filters or Date/Time Filters.
The main portion of the window (lower right) is occupied by the report itself. This is a view of the data selected by the filters (global filters, date/time filters, and zoom filters). This provides one breakdown of the data specified by the filters -- you can select another report in the Reports Menu to break down the same data in a different way.
There are several parts of the report:
At the top of the report is a bar containing the report label and the current global and date/time filters, if any.
The Zoom Display shows what you're zoomed in on, if you're using Zoom filters. For instance, if you've clicked on item X in a table for field F, you will see "Zoomed in on F: > X". You can apply a zoom filter by clicking on a linked table item. Zoom filters disappear when you click a new report name in the Reports Menu at the left.
The Zoom To Menu shows the name of the report that will be displayed when you zoom. For instance, if you select R from the menu, and then click an item X in a table for field F, it will zoom you in on X, and simultaneously switch to report R. This can be useful if you want to break down each item in a table by some other report, for instance to see what traffic looked like by hours of day, for a particular day; choose Hour Of Day from the menu in the Days report, and then click on a day to zoom in on that day and see the hours of the day for that day.
If you are not zoomed on anything, there will be no immediate effect when you select a new item in the Zoom To Menu -- it will just change the menu selection. But when you click, the selection in the Zoom To Menu will be used to determine which report to display.
For some reports, there will be a graph above the table. The existence of this graph, its size, type; e.g., pie chart or bar or line, and other characteristics, varies from report to report and can be edited in the profile config. The graph displays the same information as the table below it.
The Report Table contains the main information of the report. It displays one row per database field item, with the aggregated numerical values (e.g. sum of hits) in columns next to it. It may also include columns showing bar graph representations of the numbers, and/or percentages. The Table Options link above and to the right of the table can be used to change which columns are visible, the sort order, and other aspects of the report. The Number Of Rows menu above and to the right of the table can be used to change the number of rows that are displayed in the table. The sort order can also be changed by clicking a column name; click once to sort by that column, or again to sort in reverse. You can zoom in on a particular item by clicking it -- that will switch you to the report specified in the Zoom menu, and will set a Zoom filter for that item.
There are many levels of filters when viewing reports:
Global Filters. These remain in effect until they are removed in the Global Filters page.
Date/Time Filters. These remain in effect until they are removed in the Calendar page.
Zoom Filters. These remain in effect until they are removed in the Calendar page.
Report Filters. These are set per report in the profile config, and cannot be removed from the web interface.
Report Element Filters. These are set per report-element in the profile config, and cannot be removed from the web interface.
All these filters are "anded" together; i.e., an item is in the total filter set if it is selected by the Global Filters AND by the Date/Time Filters AND by the Zoom Filters AND by the Report Filters AND by the Report Element Filters. For instance, if the Global Filters show events during 1am-2am, and the Zoom Filters show events on January 1, then the table will show event from January 1, during 1am-2am.
{= end_docs_page() =}