This tool enables the user to run reports from outside of Netcool Reporter by opening a properly-formatted URL via the web browser.
This tool is generic for all supported types of reports and will automatically generate a form for any parameterized report. Any report which either has no parameters or where the parameters and values are passed on via the URL, will not require a form to be generated and the report will immediately run.
A correct URL must be formatted as follows:
url = ( 'http://' | 'https://' ) machine_name [ ':' port_number ] '/infospc/jsp/netcool/tools/runreport.jsp' url_parameters ;
Where,
• machine_name = qualified_hostname | unqualified_hostname ;
• url_parameters = '?' required_parameters [ optional_parameters ] report_parameters ;
• required_parameters = 'rep=' report_name ;
• optional_parameters = [ '&show' ] [ '&owner=' report_owner][login_credentials ] ;
• login_credentials = '&usr=' username '&pwd=' password ;
• report_parameters = { report_defined_parameters };
• report_defined_parameters = '&' report_parameter '=' value ;
The above syntax is in Extended BNF format as defined by the ISO/IEC 14977 : 1996(E) standard. The definition and explanation of the symbols used by this standard are covered in the following document, http://www.cl.cam.ac.uk/~mgk25/iso-14977.pdf.
The following examples are explained in this section. Each example uses a different URL, describing the different report results.
Enter the following URL into a browser window when not logged into Reporter, where example is the name of the machine upon which Reporter 2.1 is installed.
http://example/infospc/jsp/netcool/tools/runreport.jsp?rep=MSSQL_Oracle_Quick_Check_by_Node.par&usr=netcool&pwd=netcool
Since the parameter is not specified on the URL, a form is dynamically generated with a prompt for the parameter, as shown below.
|
|
Figure A1: Provide Parameter Window-Allow Manual Entry |
Click on the first parameter value in the list. This value will appear in the parameter text box.
Enter 365 in the ELAPSED_PERIOD parameter value text box to generate a report for the period of 365 days.
Press Submit. The report will now run, and the resulting report results will be displayed in the browser window.
The form is generated based upon information gathered from the report definition. If you run the same report URL with the conditional parameter checkbox Allow manual entry not checked (Conditions tab -> Edit Parameter), then the form would look like the one below.
|
|
Figure A2: Provide Parameter Window-Read Only Parameter Values |
Please note that the parameter value text box is now gray, and editing capabilities have been removed.
To run the same report with the parameter specified on the URL, enter the URL below:
http://example/infospc/jsp/netcool/tools/runreport.jsp?rep=MSSQL_Events_by_Node.par&usr=netcool&pwd=netcool&ELAPSED_PERIOD=365&show
You will now be presented with he following screen.
|
|
Figure A3: Provide Parameter Window-Parameter Value Show |
This screen is displayed because show parameter was passed on the URL along with the report parameter and associated value. If show was omitted, then the report would be run directly without the need for user intervention. Examining the URL, you will notice that the report parameter, as defined in the report definition, is being passed on the URL with an associated value, that is, ELAPSED_PERIOD=365.
Multiple report parameters can be passed on the URL, including a sub set of parameters values. In this case the form will be generated with prompts for the missing parameters:
Enter the following URL into your browser window:
http://example/infospc/jsp/netcool/tools/runreport.jsp?rep=MSSQL_Quick_Check_by_Serial.par&usr=netcool&pwd=netcool&SERVERNAME=NCOMS
The following form will be generated.
|
|
Figure A4: Provide Parameter Window-Passing Parameter Subset |
The parameter value separator character can be changed. Edit the infospc/jsp/jsp.conf file and set a new character. The default separator value for multi-value select parameters is pipe (|). The contents of this configuration file is:
document.separator = "|";
If you wish to change the separator character to #, for example, then the jsp.conf entry would need to be changed to:
document.separator = "#";
If a report is selected which has a multi-value select parameter and is editable, the current separator is shown so that the user will know that any manual entries of multiple values in the forms parameter text box will require the user to also manually enter the current separator character between items, as shown below.
|
|
Figure A5: Provide Parameter Window-Passing Multiple Parameter Values |
You will notice here that in the parameter value text box, the values selected below in the value list are separated by the pipe character. If you add any additional parameters to this list, then you must ensure that the parameters are separated by the indicated separator character.
If a report is owned by another user to the user who’s login credentials have been passed on the URL, then there is an extra URL parameter which can be passed to specify who the owner of the report definition is. This parameter is owner and an example of the usage of this URL parameter is as follows:
http://example/infospc/jsp/netcool/tools/runreport.jsp?rep=administrators_report.par&usr=netcool&pwd=netcool&owner=administrator
The report referenced needs to of been published to the user who’s credentials are being passed on the URL.
The following list describes the process for using the runreport.jsp:
1. The Reporter 2.1 server must be running for this tool to function correctly.
2. The tool is run from a URL and the parameters passed are used to build the dynamic form.
3. There is one required parameter and four optional parameter. The parameters are:
• rep - Report name including file extension (required).
• usr - Reporter login user name (conditionally optional - see the next note item).
• pwd - Reporter login user password (conditionally optional - see the next note item).
• show - Show URL provided parameters before submitting the form (optional).
• owner - Specify who the owner of the report definition is (optional).
4. If an existing session exists and the user name and password parameters are passed, then the current session will be invalidated and a new session created with the provided credentials.
5. If an existing session exists and the user name and password parameters are not passed on the URL, then the existing session will be used.
6. If the URL does not contain a valid report definition file name, then an error is generated.
7. The report parameters passed are generic for any report type with zero or more parameters.
8. The report parameters must be passed by name as defined in the report definition and in the format of parameter_name=value.
9. The parameters must be referenced as they are defined in the original report.
10. You must try to ensure that all report names are unique in the users folders to avoid the case where the report which runs is indeterminate.
11. If all the parameters required by the defined report are passed on the URL, then the report is directly run with those parameter values. For example, if the URL contains the report name and all the required parameters, the runparamreport.jsp is run and the report results are returned to the user without any extra interaction from the user.
12. If all the parameters required by the given report are passed on the URL and the URL parameter show is passed, then a read only form is submitted. All the parameters are shown on the form before the user interacts with the form to run the report.
13. If the URL contains the report name and the a partial set of the required parameters, then a dynamic form is generated for the missing parameter items and user interaction is required to fill in the missing parameters, before submitting the form.
14. If the URL contains the report name and none of the required parameters, then a dynamic form is generated for all the required parameters and user interaction is required to fill in all the parameter values before submitting the form.
15. If the URL is for a report which does not require any parameters (.rpt or similar report type), then the report is run without any further user interaction.