Changes

{{HowTo's==Creating Subreports==__NOEDITSECTION__|[[Start and Configure i-Report|Start and Configure i-Report]]|[[Create A subreport is a report 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 subreport is used in a situation where you have one or more sets of data relating to a Basic i-Report Template|Create single IMSMA item. A common use case would be a Basic i-Report Template]]|[[Modify an iReport Template|Modify an iReport Template]]|[[Format an iReport Template|Format an iReport Template]]|[[Create i-Report Templates Location report with Subreports|Create i-Report Templates with Subreports]]|[[Summarize i-Report Template Data|Summarize i-Report Template Data]]}}multiple details bands of different IMSMA items (Land, Activity, Accident, Victim, Education, and QM).

==Sub-Reports==<p>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).</p><p>Regardless of what IMSMA data you’re including in your report and sub-reportssubreports, there are 6 5 basic steps to create a report with sub-reportssubreports::Step 1 – Create the main report:Step 2 – Add a subreport to the main report:Step 3 – Add a parameter to the subreport:Step 4 – Define the report query for the subreport:</p>Step 5 – Add subreport parameter to the main report

:====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====__NOEDITSECTION__

[[Image:iRepStep01.png|center|500px|''Step 1 – Create the Main Report'']] ====''Step 1 – Create the Main Report''==== <p>Before creating the main report, you will need to determine what data to should be included on in 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 subreport 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.</p>

*What is the target IMSMA Item item for the Main main report? This is the primary data of your report.*What is the target IMSMA Item item for the sub-reportssubreports? 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? How are they linked?

The Main main report should be created with the IMSMA item determined to be the primary data of your report. The Main main report is just a basic report and can be created using the steps provided in the [[Create a Basic i-Report iReport Template]] section.

====''Step 2 – Add Subreport to the Main report''====__NOEDITSECTION__

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 are the instructions to create a sub-reportsubreport:</p>

# 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).

#:[[Image:IReportSubReport1.png|center|500px|''Add Sub-report Subreport to the Main report'']]# Click '''Next''' to define a new sub-report subreport unless you have an existing report that you would like to use for sub-reportsubreport.

# 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” “Hazard Reduction” should be the data source for the sub-reportsubreport. Click Next.

# Select the attributes to be included in your sub-reportsubreport. Click '''Next'''.

# Select the fields to group by. This step is not required. Click '''Next'''.#:[[Image:Subreport_Group_by.png|center|500px|''Select the fields to group by'']]# Enter a name for the sub-report subreport or use the default. Choose '''Next'''.

# Select '''Use the same connection use used to fill master report'''. Click Finish.

# The sub-report subreport displays.

[[Image:iRepStep03.png|center|500px|''====Step 3 – Add Parameter to Sub-report'']]Subreport====__NOEDITSECTION__

====Step 3 – Add Parameter to Subreport==== To connect a subreport to the Main main report, we next need to create a parameter for passing the identification (guid) of the primary IMSMA Item item between the subreport and the main report. In the '''Report Inspector''' on the subreport, [[Modify an iReport Template#Adding a Parameter to an iReport Template|add a Parameter]] to hold the guid of the IMSMA Item 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.

# 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, you might however want to deselect the '''Use as a prompt''' option.

====Step 4 – Define Report Query for Subreport====__NOEDITSECTION__

The next step is to create a report query for the subreport you just created in Step 3 2 to define how the IMSMA item on the Main main report is related to the IMSMA item on the subreport. Typically the subreport Report Query report query will receive the guid from the main report via the parameter created in Step 4 3 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 Queryreport query:

# Open the [[Modify an iReport Template#Using Report Query filters|Report Query report query window]] .# From the Report report query window, select '''ImsmaQuery''' from the Query query language list.# Enter a Report Query report query filter using the parameter defined above to limit the objects according to the main report object. The most common Report Query 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 report query filters can be used on subreports beyond the link table. These are documented in the [[#Possible Example Subreport Relationships|Possible Subreport Relationships]] section below.# Click '''OK'''. :The Report report query window closes.

=====Possible Subreport Relationships====={| class="wikitable"| align="center" style="background:#f0f0f0;"|'''Main Report'''| align="center" style="background:#f0f0f0;"|'''Subreport can be'''| align="center" style="background:#f0f0f0;"|'''Value to Pass to Subreport'''| align="center" style="background:#f0f0f0;"|'''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 Link the Subreport Parameter to the Main Report====__NOEDITSECTION__ We created a parameter on Now that both the sub-report to connect to main and the Main report in Step 4subreport are ready, now we need the only thing that remains to create a parameter on be done is linking the Main report as welltwo together. Below is are the instructions to create the parameter you need for link the Main reporttwo reports:# Make sure you are at the Main main report by selecting the name of the Main main report from the tabs at the top of the iReport Designer canvas pane.# Select the subreport box within the Main main report.

# '''Add''' a parameter and give it a type '''exactly the name of the subreport parameter created in step 3''' (e.g. ''ItemGUID'')

# Click '''OK''' and close Subreport properties windowsParameters window. [[Image:iRepStep06.png|center|500px|''Step 6 – Repeat Step 2-5 for additional sub-reports.'']]====Step 6 – Repeat Step 2-5 for additional sub-reports.====__NOEDITSECTION__

<p>You can have multiple sub-reports in one Main are now ready to run your main report. To add more sub-reports to Running (i.e. previewing) the Main main report, just repeat Step 2 to Step 5.</p><p>Once you have all will automatically run the sub-reports created for your Main reportsubreport(s) as well, you can compile and run your Main reportthe data from the main as well as from the subreport(s) will be included in the output.</p>

==Kinds of Subreports==__NOEDITSECTION__There are three main kinds of relationships in IMSMA on which subreports can be generated from IMSMA data. These are:

===Location relationship subreports===__NOEDITSECTION__Because each of the main items in {{IMSMANG}},*Accident *, Activity*, Assistance *, Education*, Land*, QM*, and 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:

[[Image:iRep14.png|center|500px|''Figure 14. location_guid example'']]

''Figure 14. location_guid example''

# From the main "Location" report, pass the location '''''guid''''' to the subreport in a parameter (e.g. in a parameter called '''ItemGUID''').

This has the effect of limiting the subreport records to '''only those records that are associated to the location'''' from the main report.

===Link relationship subreports===__NOEDITSECTION__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 (s).

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 subreport 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-reportsubreport.

# 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''').

===Geospatial relationships===__NOEDITSECTION__In addition to Location and Link relationships, many objects in IMSMA can store geospatial/geographic information (i.e. point/polygon information). This relationship with the geospatial data can be modeled in a report/subreport relationship for any item that has geospatial information associated with it. To include point/polygon information on an object's main report, follow 3 basic steps:

# *Step 1: Create a main report for an object with geospatial info*Step 2: Create a GeospatialInfo subreport on the main report, i.e. a report using the GeospatialInfo datasource*Step 3: Create a Geopoint subreport on the GeospatialInfo report, i.e. a report using the Geopoint datasource Step 1: Create a main report for an object with geospatial info* Create a main report with an object that has geospatial information (e.g. Land).* Ensure that the '''''geospatialInfos''''' field is added to the main report.# Add Step 2: Create a GeospatialInfo subreport on the main report* On the main report, add a subreport using the '''GeospatialInfo''' datasource# * Pass the '''''geospatialInfos''''' field to the subreport in a parameter (e.g. GeospatialInfoList)#. '''Note: {{note|''' instead of passing the '''''$F{guid}''''' field to the parameter, the parameter value should be '''''$F{geospatialInfos}'''''}}# Create a parameter on the subreport with the same name as in #3.# * In the GeospatialInfo subreport use the parameter in the following ImsmaQuery language syntax

Certain items in {{IMSMANG}} have subsets This has the effect of limiting the Geospatial records to only those records whose guid is linked to the geospatialinfo of data that are contained within themthe main report. For This is an exampleof nested reports, an education may have education details such as the education typei.e. a main report, total audiencea subreport, and percentage of women and mena sub-subreport. Other sub

===Other subreport relationships===In addition to Location and Link relationships, there are several other kinds of relationships in IMSMA that are available for use with subreports. These relationships take many different forms, however, two in particular are*Sub-object relationships*__NOEDITSECTION__Certain items in {{IMSMANG}} 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. Other subExamples of other subreport relationships include:

| align="center" colspan="2" | '''Table 3. Parent/child Other subreport relationships'''

| width="450pt" | '''Child item(s) which require the parent item'''

| Activity || Activity Device Impact survey 

The process for creating a report on a parent item and its children is similar to the process for creating a same as any other 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/subreport relationship.

===Example Subreport Relationships===__NOEDITSECTION__{| class="wikitable"| align="center" style="background:#f0f0f0;"|'''Main Report'''| align="center" style="background:#f0f0f0;"|'''Subreport can be'''| align="center" style="background:#f0f0f0;"|'''Value to Pass to Subreport'''| align="center" style="background:#f0f0f0;"|'''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 or Interviewee||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||Needs Assessment||victim guid||victim.guid="$P{ItemGUID}"|-| Victim||Cause||victim guid||victim.guid="$P{ItemGUID}"|-| Assistance||Assistance Given||victimAssistance.guid||victimAssistance.guid="$P{ItemGUID}"|-| Task||Objective||SQL Field list of Objectives||guid IN ($P{SQLList})|-| Work Item||Linked Items (Activity, Education, QM, Assistance)||SQL Field list of Items||guid IN ($P{SQLList})|}{{NavBox HowTo use iReportStandardizing Data Analysis and Information Reporting}}[[Category:VIE]]