Extreme Networks EPICenter 4.1, Software Installation Manual

Page: 392 / 546

392 EPICenter Software Installation and User Guide
Dynamic Reports
In addition, you can define new methods in any Tcl file in the
< epicenter_install_dir >/user/reports/tcl
directory, and use those methods inside the HTML file
within the
<extr>
and
</extr>
tags.
A number of reports have been defined for use as examples. Look at the various HTML files to
understand how
<extr>
tags are used within HTML files.
Look at the methods defined in the file
user/reports/tcl/examples.tcl
for details on using these
methods to generate the data that will become a part of the generated report. Some utility methods
have been provided in
commands.tcl
to help parse the result that comes back from the EPICenter
software API.
In general, the Tcl methods defined here will generate well-formatted HTML. Everything between the
<extr>
and
</extr>
tags is replaced by HTML code generated by the embedded Tcl code. Using this
method, you can generate lots of new reports quickly, and without disrupting the EPICenter software
server.
Adding a User-Defined Report to the Reports Menu
To add a new user-defined report to the report menu, simply place the HTML file into the
< epicenter_install_dir >/user/reports/html/userdefined
directory. The EPICenter server
automatically creates a link on the Reports menu for files in the userdefined directory. It will use the
report file names as the report names. They will appear below the heading User Defined Reports at the
bottom of the left-hand panel of the Reports page.
The file names must conform to two restrictions:
• They must use
.html
as the extension.
.htm
is not supported.
• The file name may not contain spaces.
If you want to create a set of hierarchical reports, you can create a subdirectory under the userdefined
directory to contain subordinate HTML files that should not have a direct link from the Reports menu.
NOTE
If you put files into the
userdefined
directory that were originally in the
< epicenter_install_dir >/user/reports/html
directory, be sure you also copy the report stylesheet
(
reportstylesheet.css)
into the
userdefined
directory.
Debugging
The EPICenter software provides a mechanism that you can use to debug any Tcl procedures you write.
Debugging is done in the Tcl shell that is shipped with the EPICenter software. You do not need to view
your reports through a browser to debug them.
To debug Tcl code you have created or modified, follow these steps:
1 Run
<epicenter_install_dir>/tcl/bin/tclsh83d.exe
to invoke the Tcl shell.
2 Change to the
<epicenter_install_dir>/user/reports/tcl
directory.