Extreme Networks EPICenter 4.1, Software Installation Manual

Page: 394 / 546

394 EPICenter Software Installation and User Guide
Dynamic Reports
Useful Methods for Debugging
The
GetfromDB
,
ExecuteExtrCommand
and
GetSessionParam
methods are defined as follows:
#####################################################################
# extr::GetFromDB
# Used to make any SQL query to the database through the
# Epicenter server. The result is a SQL result table,
# formatted within HTML tags.
#
# Arguments
# A string representing an SQL query.
# An optional callback function that is executed for each row of data
# Returns
# The result table of an SQL query embedded in HTML tags.
#
#####################################################################
#####################################################################
# extr::ExecuteExtrCommand
# This is the public method typically used during debugging.
# When a user wants to run an HTML file through the reporting
# engine, to generate dynamic html, s/he calls this method.
# Users will need to use this method only during debugging.
#
# Arguments
# filePath This is the fully specified path of where to
# find the HTML file that has embedded <extr> tags.
# params A string containing params and their values that
# should be available to the procedures in the HTML files.
# The parameters are specified as in HTML. i.e. the param
# is a string of type "param1=value1&param2=value2"
#
# Returns
# The result of executing the command. Typically this is parsed HTML.
#
#####################################################################
#####################################################################
# extr::getSessionParam
# Used in reports to get the value of a specific parameter
# that was passed into the reporting system.
# This method, along with GetFromDB form the two most
# commonly used routines by users of the reporting system.
# The params passed into ExecuteExtrCommand are available
# through this method.
#
# Arguments
# param A param name. This should be one of the params
# that was passed into ExecuteExtrCommand.
# Returns
# The value of the parameter. Returns "" if param was not defined.
#
#####################################################################