Cisco WAE Design 6.3 Integration and Development Guide
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- August 3, 2015
Chapter: Reporting Tools
Reporting Tools
There are two CLI reporting tools. One is mate_jasper, which integrates with the JasperReports library. The other is manage_reports, which provides a way to manage reports that are generated in a plan file.
JasperReports Tool
JasperReports is an open-source reporting library, which is distributed with WAE Design. The mate_jasper tool provides integration with this library. The tool enables you to produce reports in PDF or HTML format using either a plan file or arbitrary SQLite database file as input and using a.jrxml (JasperReports) file as a template.
You can call the mate_jasper tool from an add-on so as to produce reports directly from the GUI. You can find two such example add-ons in the following locations.
For information regarding add-ons, see the Add-Ons and GUI Customizations chapter. For more information on using this tool, see the mate_jasper Help output.
Example: This shows the mate_jasper tool generating a report named peak_util.pdf and placing it in the $CARIDEN_HOME/addons/peak_traffic/report directory. It uses the apac_backbone.pln plan file as input and the traffic_template.jrxml file as a template.
mate_jasper -template traffic_template.jrxml -out-file $CARIDEN_HOME/addons/peak_traffic/report/peak_util.pdf -plan-file apac_backbone.pln
Reports in Plan Files
Reports are created when certain tools are run, such as Simulation Analysis ( sim_analysis) and Demand Deduction ( dmd_deduct). These reports are stored in the plan file on which the tool is run and can be accessed through the Window->Reports menu. Add-ons and other scripts can use this reporting functionality.
The manage_reports tool provides access to the reports in a plan file for any of the following functions.
- Insert a report into a plan file
- Delete a report from a plan file
- Extract a report from a plan file
- Rename a report within a a plan file
- List the reports in a plan file
- Print a report in a plan file
Once a report is generated, use the manage_reports tool to insert the report into a plan file. If manage_reports is used to extract a report from a plan file, the extracted report uses this same report format.
Plan File Report Format
The plan file report format consists of a directory containing the data and formatting details for each section in the report. The directory must contain a config.txt configuration file that includes a <Sections> table identifying sections of the report. All columns in this <Sections> table are required ( Table 8-1 ).
Optionally, the config.txt file contains a <TableColumns> table that provides formatting information on how to display the TABLE sections of the report ( Table 8-2 ). If the <TableColumns> table is not included, WAE Design defaults are used.
The name of the report is the name of the directory containing the report. If you create a report in an add-on executable using the report-dir option, in which case you cannot name the directory, the report is named after the add-on.
Table 8-1 Columns of the Required <Sections> Table in the config.txt File
Table 8-2 Columns in the Optional <TableColumns> Table in the config.txt File
Example Plan File Report Directory and Tables
This example shows a sample report in the /QuarterlyReport directory.
Table 8-3 shows the <Sections> table in the config.txt file. Notice that each section name has an associated file that corresponds with the files listed in the above directory. Both the Interfaces and the Nodes sections of this report draw their contents from the same file.txt file. The report output lists these sections in the order identified in the Index column.
Table 8-3 Example <Sections> Table
|
|
|
|
|
|---|---|---|---|
Table 8-4 shows the columns of the Nodes and Interfaces TABLE sections being defined in the <TableColumns> table in the config.txt file. All empty fields use the WAE Design defaults.
Table 8-4 Example <TableColumns> Table
|
|
|
|
|
|
|
|
|---|---|---|---|---|---|---|
Feedback