reporttool
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
reporttool [2007/11/01 15:28] faltin |
reporttool [2009/03/04 07:45] morten column summing actually works now |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== The report tool ====== | ====== The report tool ====== | ||
| - | {{tools:report.png| }} The report tool presents a number of reports with information from your network. The report tool also links to the IP device center, to the "IP address scope - graphical view" and the services - graphical view. | + | {{tools:report.png| }} The report tool presents a number of reports with information from your network. The report tool also links to the "IP address scope - graphical view" and the services matrix. |
| Each NAV report is in essence an SQL query to the database. It shown its data in a number of columns. The | Each NAV report is in essence an SQL query to the database. It shown its data in a number of columns. The | ||
| Line 23: | Line 23: | ||
| * To navigate back to the report home page, use the "current path" provided below the NAV bar. | * To navigate back to the report home page, use the "current path" provided below the NAV bar. | ||
| * The search bars on top are shortcuts to interesting reports. The room searc lets you go directly to a room of interest. You may also search for a particular port name, or you may dive directly into the IP device center of a device in interest. | * The search bars on top are shortcuts to interesting reports. The room searc lets you go directly to a room of interest. You may also search for a particular port name, or you may dive directly into the IP device center of a device in interest. | ||
| - | |||
| - | |||
| - | ===== IP Device Center ===== | ||
| - | |||
| - | The IP device center is a dashboard for a given device showing relevant information. It presents | ||
| - | recent events for the device, if any. If the device is a switch or router a switch port and/or | ||
| - | router interface view is given. | ||
| - | |||
| - | {{ screenshot:3.3:devcenter.png?700 |IP device center }} | ||
| Line 50: | Line 41: | ||
| ====== Configuration ====== | ====== Configuration ====== | ||
| - | As mentioned the report system is highly configurable, you can alter the configuration file report.conf. | + | As mentioned the report system is highly configurable, you can alter the configuration file "report.local.conf", either adding new reports or overloading existing reports that exists in "report.conf". |
| - | (In a later version of NAV 3.4 we will strengthen the means of editing reports by adding support for local reports, | + | |
| - | if interested, see [[devel:tasklist#smj3improve_the_report_tool|details]]). | + | |
| - | ==== report.conf ==== | + | ==== Report configuration ==== |
| The NAV reports are made based on the ''report.conf'' configuration file. You can expand this file | The NAV reports are made based on the ''report.conf'' configuration file. You can expand this file | ||
| - | with new reports as you like. Each report is in essence an SQL-query to the database (with some | + | with new reports as you like in ''report.local.conf''. Each report is in essence an SQL-query to the database (with some |
| limitations). It is easy to make hyper links from data in the report to other reports or elsewhere. | limitations). It is easy to make hyper links from data in the report to other reports or elsewhere. | ||
| Line 67: | Line 56: | ||
| <code> | <code> | ||
| gwport { | gwport { | ||
| + | $description = "Extended information about router ports."; | ||
| $sql= " | $sql= " | ||
| SELECT netbox.sysname, gwport.ifindex, gwport.interface, module.module, | SELECT netbox.sysname, gwport.ifindex, gwport.interface, module.module, | ||
| Line 96: | Line 86: | ||
| $url_otherbox="netbox?sysname=$otherbox"; | $url_otherbox="netbox?sysname=$otherbox"; | ||
| $url_remoteif="swport?b1.sysname=$otherbox&s1.interface=$remoteif"; | $url_remoteif="swport?b1.sysname=$otherbox&s1.interface=$remoteif"; | ||
| + | $explain_gwp="Router Ports"; | ||
| + | $sum="gwport"; | ||
| } | } | ||
| </code> | </code> | ||
| - | The syntax of report.conf is: | + | The syntax of the report configuration is: |
| Each report is enclosed within brackets: | Each report is enclosed within brackets: | ||
| Line 111: | Line 103: | ||
| This report is seen as ''https://your_nav/report/r1'' | This report is seen as ''https://your_nav/report/r1'' | ||
| - | Further explanation of the report.conf syntax: | + | Further explanation of the report configuration syntax: |
| ^Command ^Description | | ^Command ^Description | | ||
| - | |$sql="SELECT ..."; |The SQL query | | + | | $description="..."; | Textual description of what the report shows | |
| - | | $title="..."; |The report title | | + | | $sql="SELECT ..."; | The SQL query | |
| - | | $name_MYCOL |changes the column header. | | + | | $title="..."; | The report title | |
| - | | $explain_MYCOL |shows an explanation as popup in the browser when you hold the curser over the column header.| | + | | $name_MYCOL | Changes the column header. | |
| - | | $order_by |defines the default ordering of the sql query. By clicking on the column headers in the report, you can sort/reverse sort on other criteria. | | + | | $explain_MYCOL | Shows an explanation as popup in the browser when you hold the curser over the column header.| |
| - | | $url_MYCOL |makes a hyperlink to another report or elsewhere. Takes parameters from the current report| | + | | $order_by | Defines the default ordering of the sql query. By clicking on the column headers in the report, you can sort/reverse sort on other criteria. | |
| - | | $hide |columns that must be included in the $sql because they are used in $url. $hide will not show the column in the report. | | + | | $url_MYCOL | Makes a hyperlink to another report or elsewhere. Takes parameters from the current report| |
| - | | $extra |extra "static" columns at the right that can be used for hyperlinks | | + | | $hide | Columns that must be included in the $sql because they are used in $url. $hide will not show the column in the report. | |
| - | | $sum |shows the total of a given column (currently not working)| | + | | $extra | Extra "static" columns at the right that can be used for hyperlinks | |
| + | | $sum | Show the sum total of a given column (which must contain numeric values) | | ||
reporttool.txt · Last modified: 2011/04/03 17:28 by faltin
Page Tools
