Create iReport Templates with Subreports

From IMSMA Wiki
Revision as of 19:07, 23 October 2012 by JMU (talk | contribs)
Jump to: navigation, search

Advanced Reports

Sub-Report

Sub-report is reports within a report; thus, providing a way to generate a report that includes data on the target IMSMA Item as well as data on other IMSMA Items that are associated to the target IMSMA Item. Generally a sub-report is used in a situation where you have one or more sets of data relating to a single IMSMA item. A common use case would be a Location report with multiple details bands of different IMSMA items (Hazard, Hazard Reduction, Accident, Victim, MRE, and QC).

Regardless of what IMSMA data you’re including in your report and sub-reports, there are 6 basic steps to create a report with sub-reports:

Step 1 – Create the Main report
Step 2 – Add Sub-report to the Main report
Step 3 – Add Parameter to the Sub-report
Step 4 – Define Report Query for the Sub-report
Step 5 – Add Sub-report Parameter to the Main report
Step 6 – Repeat Step 2-5 for additional Sub-reports
Step 1 – Create the Main Report

Step 1 – Create the Main Report

Before creating the main report, you will need to determine what data to be included on your report. For example, if you are creating a report about Hazard with all the Progress Report data, then the target IMSMA item for your main report should be Hazard and the target data for your sub-report should be Hazard Reduction assuming that Progress Reports are entered into the system as Hazard Reduction. Below is a list of questions and things to be considered when designing a report.

  • What are all the data to be included on the report?
  • What is the target IMSMA Item for the Main report? This is the primary data of your report.
  • What is the target IMSMA Item for the sub-reports? This is the secondary data of your report.
  • Determine the relationship between the primary data and the secondary data. How did they get reconciled to one another?

The Main report should be created with the IMSMA item determined to be the primary data of your report. The Main report is just a basic report and can be created using the steps provided in the “Creating a Basic Report” section. Below are the instructions:

    1. Create your main report with the IMSMA item determined as the primary data of your report. This is just a basic report.
    2. Save your main report
    3. Compile your main report to make sure that it’s error-free.
Step 2 – Add Sub-report to the Main report

Step 2 – Add Sub-report to the Main report

Sub-report is reports within a report. As mentioned earlier, a sub-report should be created with the IMSMA Item determined as the secondary data of the report. Below is the instructions to create a sub-report:

  1. Increase the size of Detail section of the Main report to make room for your sub-report.
    2. View -> Bands -> detail -> increase the Band Height -> Apply
  2. Click the File:IRepBand.png button
  3. Click the detail section of the report. Hold down the mouse button and drag the cursor to create a rectangle to define the area of sub-report. Release the botton and the window below displays.
500px
  1. Click Next to define a new sub-report unless you have an existing report that you would like to use for sub-report.
  2. Select from the Connection/Data Source list. This should be the IMSMA item determined as the secondary data of your report. For example, if you are creating a report about Hazard with Progress Reports, then “Hazard Reduction” should be the data source for the sub-report. Click Next.
  3. Select the attributes to be included in your sub-report. Click Next.
  4. Select the layout option. Click Next.
  5. Enter a name for the sub-report. Click Finish. The sub-report displays.
Step 3 – Add Parameter to Sub-report

Step 3 – Add Parameter to Sub-report

To connect a sub-report to the Main report, we need to create a parameter for passing the identification (guid) of the primary IMSMA Item between the sub-report and the main report. Below is the instructions to create the parameter you need for the sub-report:

  1. At the Sub-report window, select View -> Parameters.
    The window displays the parameters.
Figure 9. Window of fields, variables, and parameters

Figure 9. Window of fields, variables, and parameters

  1. Click the New button.
    2. The Add/modify parameter window displays.
  2. From the Add/modify parameter window:
    • Enter “object_guid” for the Parameter Name where object_guid is the suggested parameter name in the Column D of the Table - Required Parameters for Sub-report below.
    • Click the OK button.
  3. Close the window that displays the list of all parameters.
Step 4 – Define Report Query for Sub-report

Step 4 – Define Report Query for Sub-report

The next step is to create a report query for the sub-report you just created in Step 2 to define how the IMSMA item on the Main report is related to the IMSMA item on the Sub-report. Below is the instructions on how to define the Report Query:

  1. At the Sub-report window, select Data -> Report Query.
    2. The Report query window displays.
  2. From the Report query window:
    1. Select ImsmaQuery from the Query language list.
    2. Enter object.guid = “$P{object_guid}” for the ImsmaQuery where object is the object type of the IMSMA item on the Main report - See Column E in the Table - Required Parameters for Sub-report below to determine the ImsmaQuery string for your Sub-report.
Figure 10. Define Report Query for Sub-report

Figure 10. Define Report Query for Sub-report

    1. Click OK.
      2. The Report query window closes.
    2. Click the File:IRepCompile.png button to compile the sub-report.
Step 5 – Add Subreport Parameter to Main Report

Step 5 – Add Subreport Parameter to Main Report

We created a parameter on the sub-report to connect to the Main report in Step 3, now we need to create a parameter on the Main report as well. Below is the instructions to create the parameter you need for the Main report:

  1. Make sure you are at the Main report by selecting the name of the Main report from the Window menu or double-clicking the Main report from the Files pane.
  2. Double-click the sub-report box within the Main report.
    3. A window displays four tabs (Common, Sub-report, Sub-report (Other), and All).
  3. Select the Sub-report (Other) tab. Click Add.
  4. From the Add/modify parameter window:
    1. Enter “$P{object_guid}” for the Sub-report Parameter Name field where object_guid is the parameter name you created in Step 3 for the Sub-report. See Column B in the Table – Required Parameters for Sub-report below to determine the parameter name.
    2. In the Default Value Expression field, enter $F{guid}.
    3. Click OK and close the windowthe four tabs.
Step 6 – Repeat Step 2-5 for additional sub-reports.

Step 6 – Repeat Step 2-5 for additional sub-reports.

You can have multiple sub-reports in one Main report. To add more sub-reports to the Main report, just repeat Step 2 to Step 5.

Once you have all the sub-reports created for your Main report, you can compile and run your Main report.

Below is the table listing typical parameters required for both Main report and Sub-report.

A B C D E F
If your Main report is Sub-report parameter on Main report Your Sub-report can be… Parameter on Sub-report Report Query defined on Sub-report Comments
Location location_guid Hazard,

Hazard Reduction, Accident, Victim, MRE, or QC

location_guid location.guid = "$P{location_guid}" Relationship is defined as “New” to a Location during the reconciliation.
Hazard, Hazard Reduction,

Accident, Victim, MRE, or QC

object_guid Hazard, Hazard Reduction,

Accident, Victim, MRE, or QC

object_guid links.toGuid = "$P{ object_guid}" Relationship is defined using “Link” during the reconciliation.
MRE mre_guid MRE Detail mre_guid mre.guid = "$P{mre_guid}" Relationship is defined as “New” to a MRE during the reconciliation.
Hazard Reduction hazreduc_guid Impact survey,

Interviewee, Sector, or Vegetation removal

hazreduc_guid hazreduc.guid = "$P{hazreduc_guid}" Relationship is defined as “New” to a Hazard Reduction during the reconciliation.
Interviewee interviewee_guid Question interviewee_guid interviewee.guid = “$P{ interviewee_guid}” Relationship persisted automatically when Questions are entered for each Interviewee at Field Report.
Sector sector_guid Sample sector_guid sector.guid=”$P{sector_guid}” Relationship persisted automatically when Samples are entered for each Sector at Field Report.
Victim victim_guid Received MREs victim_guid victim.guid = "$P{victim_guid}" Relationship is defined as “New” to a Victim during the reconciliation.
Task task_guid Work Item task_guid task.guid = "$P{ task_guid}" Relationship is defined when adding a new Work Item to a Task at the Task Editor Window.

The following section of the Advance Reports chapter discusses relationships between Items in IMSMA and also provides instructions on how to create a specific report/sub-reports.

Reports on Items with a Direct Relationship

The reports discussed so far in this training module have been based on a single data source. In this part of the training module, you will learn to create more complex reports that reference multiple data sources. Some items are dependent on the existence of another item. This type of relationship is referred to as a direct relationship. For example, an accident, hazard, hazard reduction, MRE, QC, or victim has a direct relationship to the location to which it is associated. The accident, hazard, hazard reduction, MRE, QC, or victim cannot exist unless it is associated with a location. This direct relationship is enforced in IMSMA via the reconciliation process.

Figure 11. Location and item records directly associated with it

Figure 11. Location and item records directly associated with it

Direct relationships also exist when subsets of data are contained within an item. For example, an MRE may have MRE details such as the MRE type, total audience, and percentage of women and men. The MRE details data requires the MRE to exist.

The following sections will describe the process for creating reports on items that have a direct relationship between them.

Country Structure Areas and Associated Locations

Although a location must be associated with a country structure area, the process for creating a report of locations in a country structure area is very similar to a basic report. The location data source contains a field for each country structure area that is defined in your IMSMA database.

To create a report that lists locations within a country structure area:

  1. From the File menu, select Report Wizard.
    2. The iReport Wizard window displays.
  2. From the Connection/Data Sources list, select Location Data Source.
  3. Click the Next button.
    4. The window to select the attributes to include in the report displays.
  4. From the Step 2. select fields screen:
    1. Select the country structure level(s) on which you would like to list the associated locations.
    2. Select the fields that you would like to include in the report.
    3. Click the Next button.
      4. A window displays the selected fields.
  5. Click the Next button.
    6. The window group the report data displays.
  6. From the Group lists, select the country structure level(s) that you selected in step 4a.
Note.jpg Be sure to select the highest country structure level for Group 1, followed by the next highest country structure level for Group 2, and so on.
  1. Click the Next button.
    2. The window to select a layout displays.
  2. From the window to select a layout:
    1. Select the layout option for the report.
    2. Click the Next button.
      3. The window displays a message stating that you have successfully created a new report.
    3. Click the Finish button.
      4. The template for your report displays.
    4. Click the File:IRepCompile.png button to compile the report.
      5. The Save report window displays.
    5. Enter a name for the report in the File name field.
    6. If there are no compilation errors, you may click the File:IRepRun.png button to run the report.
      7. The results of the report display in the iReport JasperViewer window.

Location and Associated Items

A report of locations and associated items requires you to create an iReport sub-report. A sub-report is a report that is contained within another report. A report on locations and its associated item records will require you to create a report and a sub-report. The main report will contain the data for the location. For each associated item that you would like to include, you will need to create a sub-report.

Figure 12. Location and associated item records

Figure 12. Location and associated item records

All records in IMSMA have a guid. A guid is a unique value that identifies the record in the IMSMA database. Because the guid is lengthy and comprised of alphanumeric characters, it is typically not a useful value to display in a report. However, the guid is necessary in determining which item records have a direct relationship.

All accidents, hazards, hazard reductions, MREs, QCs, and victims are associated with a single location. The information about the location to which an item record is associated is stored in the location_guid field of the item table and corresponds to the location_guid of the location to which it is associated (Figure 13).

Figure 13. location_guid

Figure 13. location_guid

The location_guid field in the item table contains the guid of the location to which the item record is associated. Figure 14 shows an example of a location and the accident and hazard that are associated to the location. Notice that the location_guid value (1234-1234) in the accident and hazard are identical to the location_guid of the location.

Figure 14. location_guid example

Figure 14. location_guid example

Creating a report of a location and associated items will require you to complete the following parts:

  • Part 1: Create a report with location fields
  • Part 2: Create a sub-report for the associated item
  • Part 3: Add parameters to the sub-report
  • Part 4: Create a query the in sub-report to associate the guid to the location report
  • Part 5: Add parameters to the location report
  • Part 6: Compile and execute the location report

Part 1. Create a report with location fields

The first part of creating a report of locations and their associated items is to create a report of the location fields you would like to include.

  1. Ensure that the IMSMA server is started.
  2. From the File menu, select Report Wizard.
  3. From the Connection/Data Sources list, select Location Data Source to create a report of locations.
  4. Click the Next button.
    5. The iReport Wizard, Step 2 window displays a list of the location attributes.
  5. Select the fields you would like to include for the location.
  6. Click the Next button.
    7. The window displays a list of the attributes that you have selected.
  7. Click the Next button.
    8. The iReport Wizard, Step 3 window displays to allow you to group the report results.
  8. Because the report results for this exercise will not need to be grouped, click the Next button.
    9. The iReport Wizard, Step 4 window displays to allow you to select the report layout.
  9. Select a layout option.
  10. Click the Next button.
    11. The iReport Wizard, Step 5 window displays.
  11. Click the Finish button.
  12. Save the report by doing one of the following:
    13. The Save report window displays.
  13. Enter a name for the report in the File name field.
  14. Click the Save button.

Part 2. Create a sub-report for the associated item

The next part of the process for creating a report on locations and its associated items requires you to create a sub-report within the location report.
  1. Expand the detail section of the report by doing the following:
    1. From the View menu, select Bands.
    2. From the left pane, select detail.
    3. In the Band Height field that is in the right pane, increase the height of the detail section. At a minimum you will want to double the height.
Figure 15. Detail band height

Figure 15. Detail band height

    1. Click the Apply button.
    2. The height of the band increases based on the value that you entered.
Figure 16. Increased detail band

Figure 16. Increased detail band

  1. Click the File:IRepBand.png button to add a sub-report.
    2. The cursor changes to a crosshair.
Figure 17. Sub-report button

Figure 17. Sub-report button

  1. Click the detail section of the report.
  2. While holding down the mouse button, drag the cursor to form the rectangle which will contain the sub-report.
  3. Release the mouse button.
    4. The window below displays.
Figure 18. Sub-report creation

Figure 18. Sub-report creation

  1. From the window:
    1. Select the Create a new report option.
    2. Click the Next button.
      3. The How fill the sub-report screen displays.
  2. From the window:
    1. Select the data source for the associated item from the Connection/Data Source list. For example, if you are creating a report of locations and its associated accidents, you would select the accident data source.
    2. Click the Next button.
      3. The window to select the attributes to include in the report displays.
  3. From the window:
    1. Select the attributes that you would like to include in the report.
    2. Click the Next button.
      3. The window to select a layout displays.
  4. From the window to select a layout:
    1. Select the layout option.
    2. Click the Next button.
      3. The window to specify the sub-report expression displays.
  5. From the window to specify the sub-report expression:
    1. Enter a name for the sub-report.
    2. Click the Finish button.
      3. The sub-report displays.

Part 3. Add parameters to the sub-report

The next part of the process for creating a report on locations and its associated items is to define parameters that will be used for passing the location id between the sub-report and location report.
  1. From the View menu, select Parameters.
    2. The window displays the parameters.
Figure 19. Window of fields, variables, and parameters

Figure 19. Window of fields, variables, and parameters

  1. Click the New button.
    2. The Add/modify parameter window displays.
  2. From the Add/modify parameter window:
    1. In the Parameter Name field, enter a name for the parameter that will be used to identify the guid for the location.
Note.jpg Although there are no requirements for the parameter name, you should enter a name that is easy to remember and meaningful (for example, location or location_guid). Make note of this parameter name since it will used in a later step.
    1. Click the OK button.
    2. Close the window that displays the list of all parameters.

Part 4. Create a query in the sub-report to associate the guid to the location report

Note.jpg The next part of the process for creating a report on locations and its associated items is to create a query that defines how the location and associated item are related in the IMSMA database.
  1. From the Data menu, select Report Query.
    2. The Report query window displays.
  2. From the Report query window:
    1. Select ImsmaQuery from the Query language list.
    2. In the field below the Query language list, enter location.guid = "$P{ParameterName}"

      3. where ParameterName is the name of the parameter that you created for the location guid.

Figure 20. Query for report on locations and associated items

Figure 20. Query for report on locations and associated items

    1. Click the OK button.
      2. The Report query window closes.
  1. Click the File:IRepCompile.png button to compile the sub-report.

Part 5. Add parameters to the location sub-report

Note.jpg The next part of the process for creating a report on locations and its associated items is to update the location report to include the parameter that will be used to associate the location record to item records.
  1. Display the location report by doing one of the following:
    • From the Window menu, select the name of the location report.
    • Close the sub-report.
    • Bring the location report to the foreground by double-clicking the location report name that is displayed in the Files pane.
  2. Double-click the sub-report box within the report.
    3. A window displays four tabs (Common, Sub-report, Sub-report (Other), and All).
  3. From the window:
    1. Select the Sub-report (Other) tab.
    2. Click the Add button.
      3. The Add/modify parameter window displays.
  4. From the Add/modify parameter window:
    1. In the Sub-report Parameter Name field, enter the parameter name that you used for the location.
Note.jpg This is the parameter that you created previously.
    1. In the Default Value Expression field, enter $F{guid}.
    2. Click the OK button.
  1. Close the window with the four tabs.

Part 6. Compile and execute the location report

  1. Ensure that the Location data source is selected from the list.
  2. Click the File:IRepCompile.png button to compile the report.
  3. Click the File:IRepRun.png button to execute the report.
    4. The report results displays.
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Create_iReport_Templates_with_Subreports&oldid=5443"