Create iReport Templates with Subreports

From IMSMA Wiki
Revision as of 14:22, 19 September 2013 by Noah (talk | contribs) (Reports on Linked Items)
Jump to: navigation, search


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 (Land, Activity, Accident, Victim, Education, and QM).

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

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 Land with all the Progress Report data, then the target IMSMA item for your main report should be Land and the target data for your sub-report should be Activity assuming that Progress Reports are entered into the system as Activity. 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 Create a Basic i-Report Template section.

Step 2 – Add Subreport to the Main report

Once the main report has been created you can add a subreport to the main report. The intent of the subreport is to bring data from a different but related datasource into the main report. For example, you could include Activity data on a report about Land. Below is the instructions to create a sub-report:</p>

  1. On the main report, from the Palette pane, select Subreport and drag it to the desired band on the iReport template (normally this is the Detail band.
    Subreport Palette
    Subreport Palette
  2. Release the button and the window below displays.
    Add Sub-report to the Main report
  3. Click Next to define a new sub-report unless you have an existing report that you would like to use for sub-report.
  4. Select the desired iReport Template to apply (Blank is recommended).
    Select the desired iReport Template
  5. 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 Land with Progress Reports, then “Activity” should be the data source for the sub-report. Click Next.
    Select the desired datasource
  6. Select the attributes to be included in your sub-report. Click Next.
    Select the desired fields for the subreport
  7. Enter a name for the sub-report or use the default. Choose Next.
    Enter a name for the subreport
  8. Select Use the same connection use to fill master report. Click Finish.
    Use same connection
  9. The sub-report displays.

Step 3 – Add Parameter to Subreport

To connect a subreport to the Main report, we next need to create a parameter for passing the identification (guid) of the primary IMSMA Item between the subreport and the main report. In the Report Inspector on the subreport, add a Parameter to hold the guid of the IMSMA Item on the main report. It is recommended to add a fairly generic parameter name such as ItemGUID so that the subreport can be more easily re-used.

  1. From the Report Inspector, right click on the Parameter tree and choose Add Parameter.
    Add Parameter
  2. In the Properties pane, enter a parameter name (e.g. ItemGUID} and edit any other properties. Normally it is not required to edit anything other than the name.
    Add Parameter
  3. Once the parameter is added it will be available in the Report Inspector and can be referenced as $P{parametername}. For example:

Step 4 – Define Report Query for Subreport

The next step is to create a report query for the subreport you just created in Step 3 to define how the IMSMA item on the Main report is related to the IMSMA item on the subreport. Typically the subreport Report Query will receive the guid from the main report via the parameter created in Step 4 and then use it to limit items in the subreport to the those linked to the main report. Below is the instructions on how to define the Report Query:

  1. Open the Report Query window
  2. From the Report query window, select ImsmaQuery from the Query language list.
  3. Enter a Report Query filter using the parameter defined above to limit the objects according to the main report object. The most common Report Query filter would be to filter to only linked objects. For example links.toGuid="$P{ItemGUID}". In this step, the Report Query tells the subreport to return only rows that are linked to the guid of the the item in the main report via the link table. Other combinations of Report Query filters can be used on subreports beyond the link table. These are documented in the Possible Subreport Relationships section below.
  4. Click OK. :The Report query window closes.
  5. Save the subreport.
Possible Subreport Relationships
Main Report Subreport can be Value to Pass to Subreport Report Query
Location Any Item with a Location location guid location.guid = "$P{ItemGUID}"
Any linked item Any linked Item Item guid (e.g. Land guid) links.toGuid="$P{ItemGUID}"
Activity Impact survey, Interviewee, or Vegetation removal Activity guid hazreduc.guid = "$P{ItemGUID}"
Interviewee Question interviewee guid interviewee.guid = “$P{ItemGUID}”
Task Work Item Task guid task.guid = "$P{ItemGUID}"
Any Item with Geospatial information GeospatialInfo geoSpatialInfos guid IN $P{GeospatialInfoList}
Geospatial Info GeoPoint GeospatialInfo guid geospatialInfoGuid = "$P{ItemGUID}"
Any item with devices Item Device (e.g. AccidentDevice) Item guid (e.g. Accident guid) accident.guid = "$P{ItemGUID}" hazard.guid = "$P{ItemGUID}"
MRE MREDetail MRE guid mre.guid = "$P{ItemGUID}"
Victim Victim Needs Assessment victim guid victim.guid="$P{ItemGUID}"
Victim Victim Cause victim guid victim.guid="$P{ItemGUID}"
Victim Assistance Victim Assistance Assistance victimAssistance.guid victimAssistance.guid="$P{ItemGUID}"
Task Objective SQL Field list of Objectives guid IN ($P{SQLList})
Work Item Linked Items (Activity, Education, QM, Victim Assistance) SQL Field list of Items guid IN ($P{SQLList})

Step 5 – Add Subreport Parameter to Main Report

We created a parameter on the sub-report to connect to the Main report in Step 4, 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 tabs at the top of the iReport Designer canvas pane.
  2. Select the subreport box within the Main report.
    Select the Subreport on the main report
    Select the Subreport on the main report
  3. On the Properties pane for the Subreport, select the Parameter selector.
    Subreport properties
    Subreport properties
  4. Add a parameter and give it a name (e.g. ItemGUID)
    Add a parameter
    Add a parameter
  5. For the value expression, select the appropriate field to include in the parameter. Normally this is $F{guid} but other choices are available.
    Select the appropriate field
    Select the field to include in the parameter
  6. Click OK and close Subreport properties windows.

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.

Kinds of Subreports

There are three main kinds relationships in IMSMA on which subreports can be generated from IMSMA data. These are:

  • Location relationship
  • Link relationship
  • Direct relationship

Location relationship subreports

Because each of the main items in IMSMANG,

  • Accident
  • Activity
  • Assistance
  • Education
  • Land
  • QM
  • Victim

must be reconciled to a Location during the data entry phase, each of these objects has a relationship with Location and can thus be a subreport on a Location main report. Since all accidents, land, activities, educations, QMs, assistances, and victims are associated with a single location each record knows what location it is related to based on the location guid field. When creating a report where the main report is a Location and the subreport is one of the associated objects the Location's guid is passed to the subreport in a parameter and the subreport can use a special ImsmaQuery language syntax to limit the subreport data to those associated with the main report's location:

location.guid = "$P{parametername}"

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

Figure 14. location_guid example

Figure 14. location_guid example

Link relationship subreports

In addition to the Location relationship, the main items in IMSMANG can also be linked with one another during the reconciliation process. This is how, for example, Activities are linked with Land in the IMSMANG database. Accidents, land, activities, educations, assistances, QMs, and victims may be related to one another via links. For example, a victim may be associated to an accident in a particular land. If these relationships are known, IMSMA users may define these links while reconciling the Data Entry Form. This special relationship can also be modeled in iReport using a report and subreport

The process for creating a report on an item and its linked items is similar to the process for creating a report on items with a Location relationship. The item in the main report is the primary item for which you would like to find linked items. The sub-report would return the records for the particular item that is linked to the primary item. The key difference is the query used in the sub-report.

To create a subreport using the link relationship:

  1. From the main report, pass the guid of the main report object to the subreport in a parameter (e.g. pass an accident's guid in a parameter called ItemGUID)
  2. Create a parameter on the subreport with the same name as in #1.
  3. In the subreport for the related item (e.g. a Victim) use the parameter in the following ImsmaQuery language syntax

This has the effect of limiting the subreport records to only those records that have a link to the guid or object passed from the main report.

Items with Data Subsets

Certain items have subsets of data that are contained within them. For example, an education may have education details such as the education type, total audience, and percentage of women and men. The education details data requires the education to exist. Table 3. Parent/child relationships lists the items and the data subsets that depend on them.

Table 3. Parent/child relationships
Parent item Child item(s) which require the parent item
Activity Impact survey

Interviewee Organisation Question Vegetation removal

Location Accident

Land Activity Education QM Victim

Education Education details
Victim Received Education

The process for creating a report on a parent item and its children is similar to the process for creating a report on locations and their associated items. The key difference is that the main report will contain the attributes of the parent item. The sub-report will contain the attributes for the child item. For example, if you were trying to create a report of educations and their associated education details, the main report would contain the attributes for education and the sub-report would contain the attributes for education details.

Template:NavBox HowTo use iReport