Manage Report Design

JasperReports is the open source report generation and design library that is used to design and render reports in OpenEMPI. Report generator requires three different types of information in order to construct a report:

• Report Design Template - Defines the layout of the report and how it will look like when it will be generated in printable form.  A report design template is generated using the tool iReport and results in an XML formatted file that comprises the entire report design.
• Report Data - The actual data that is presented on the screen and are retrieved by SQL queries for a specific instance of a report.
• Report Parameters - The information that is passed in from the administrator user and used to filter the data using SQL queries.

The Manage Report Design page is where the administrator user uses the Report Design Template defined by iReport to configure the report parameters and SQL query to retrieve the data for a report design.

To access the Report Design page

Log in OpenEMPI and select Admin > Manage Report Design from the menu bar. The Manage Report Design page is displayed with a list of the current report designs:

To add a report design

1. Access the Report Design page.
2. Click the Add Report button. The Add Report Design window opens.
   
   
   
3. Enter values for the following fields located In the top section of the window:
   
   • Name - The internal name for the report design.
   • Name Displayed - The name that is displayed on the report design.
   • Description - A brief description of the report design.
   • Template File - The name of the report design template that is generated using the iReport tool.
   • Data Generator - The default is jdbcReportGenerator.
4. Click the Add Parameter button and provide values for the following fields:
   
   • Name
   • Name Displayed
   • Description
   • Data Type (Date, String, or Numeric)
5. Click Add Parameter.
6. Click the Add Query button.
7. Add values for the following fields:
   
   • Name
   • Query
8. Select a parameter from the drop-down list.
9. Click the Add Query Parameter button. The Query Parameter is added to the list.
10. Double-click the Query Parameter and enter the following:
    
    • Query Parameter Name
    • Y or N
    • Substitution Key
11. Click Save.
12. Click Add Report.

To edit a report design

1. Access the Report Design page.
2. Click the Edit Report button. The Edit Report Design window opens:
   

   

3. You now have options to add, edit, or delete parameters and queries associated with the selected report design.
   

   Example: Edit Report Parameter window

   

   
   

   Example: Edit Report Query window

   

4. Click the appropriate button and then click the Update Report button.
5. Click the associated update button. The report design updated.

To delete a report design

1. Access the Report Design page.
2. Select the report design that you want to delete.
3. Click the Delete Report button. The Delete Report Design window opens with the details of the report:
   

   

4. Click the Delete Report button. A window pops up asking you to confirm the deletion.
   
5. Click Yes to confirm the deletion. The report is removed from the database.

.