Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
COSMOS Design 230405
Back to Data Reporting Design
Contents
Change History
| Name: | Date: | Revised Sections: |
|---|---|---|
| Sheldon Lee-Loy | 06/17/2008 |
|
Workload Estimation
| Process | Sizing | Names of people doing the work |
|---|---|---|
| Design | 0.4 | Sheldon Lee-Loy |
| Code | 1.4 | |
| Test | 0.5 | |
| Documentation | 0.5 | |
| Build and infrastructure | 0.2 | |
| Code review, etc.* | ||
| TOTAL | 3 |
'* - includes other committer work (e.g. check-in, contribution tracking)
Requirement
It would be beneficial for adopters to create reports based on CMDBf constructs such as the CMDBf graph response or meta data. One useful report would show a list of configuration items returned by a graph report. Custom drill down reports can be created to render record information.
Design
The following shows the component diagram design.
COSMOS Report Servlet
This servlet has several functions.
- Receives http request to generate a report.
- Provides the report viewer with the report template and datasource id needed to render the http response.
- Looks up the report template based on meta data information
- Manages the datasource information in session.
- Provides the datasource information to the report viewer.
The http request received by the servlet will contain two pieces of information:
- meta data search parameters
- report parameters
Meta Data Search Parameters
The search parameters will be name value pairs that defines the search criteria used to select the report template. For example, the request may ask to generate a report that is associated with a namespace equal to "http://examplemdr/student". The servlet will search the report repository for the report template that matches the search criteria. Note the search parameters are logically "ANDED".
Report Parameters
This is a list of name value pairs that are required by the report template to generate the report. For more information refer to the BIRT documentation on report parameters.
Example request
The following is an example of a request. Notice that the meta search and report parameters are encoded in the request.
ReportServlet/?metasearch=namespace%2Fhttp%3F%2F%2Fexamplemdr%3Fstudent&reportparams=myparams=%2fhello
Open Issues/Questions
All reviewer feedback should go in the Talk page for 230405.