Difference between revisions of "Use iReport"

From IMSMA Wiki
Jump to: navigation, search
Line 34: Line 34:
 
|}
 
|}
 
</center>
 
</center>
 +
 +
==Sample Reports==
 +
IMSMA includes several iReport sample reports. These reports may be used as is or used as a reference to create your reports. The sample reports are installed in the \iReports\IMSMA reports directory of your IMSMA installation directory.
 +
 +
=== Article 7: Form A===
 +
The ''Article 7: Form A'' report returns the total area size of all reductions that are being reported on, the total area size of all hazards that have been linked to the reported reductions, and a count of all victims that have been linked to the reported reductions. If a search definition is associated with the report, the search definition name will be displayed in the report title.
 +
 +
====Table 6====
 +
{| class="wikitable"
 +
|-
 +
| File name || Article 7 Form A.jrxml
 +
|-
 +
| Data source|| Hazard reduction
 +
|-
 +
| Variables 
 +
|| Sum of hazard reduction area size
 +
Sum of total hazard area size
 +
Sum of victim counts
 +
|-
 +
| Derived fields
 +
|| HazreducLinkedHazardAreaSize (Total Hazard Area Size)
 +
HazreducLinkedVictimCount (Victim Count)
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
===Article 7: Form C===
 +
The ''Article 7: Form C'' report returns a crosstab by district and hazard with the number of hazards by hazard type.
 +
 +
[[Image:Article 7FormC.png|center|500px|''Figure 42.'' ''Sample report- Article 7-form C'' '']]
 +
 +
====Table 7====
 +
{| class="wikitable"
 +
|-
 +
| File name|| Article 7 Form C.jrxml
 +
|-
 +
| Data source|| Hazard
 +
|-
 +
| Variables|| REPORT_COUNT (built-in iReport variable)
 +
|-
 +
| Derived fields|| None
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
==Bar Chart Sample==
 +
The ''Bar Chart'' sample report returns the metal contamination level of hazards and area size. The report includes a bar chart which summarizes the total area size of hazards by their metal contamination level.
 +
 +
[[Image:BarChartSample.png|center|500px|''Figure 43.'' ''Sample report- Bar chart'' '']]
 +
 +
====Table 8====
 +
{| class="wikitable"
 +
|-
 +
| File name|| Bar Chart Sample.jrxml
 +
|-
 +
| Data source|| Hazard
 +
|-
 +
| Variable
 +
|| Sum of area size
 +
Count of metal contamination level
 +
|-
 +
| Derived fields|| None
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
==Clearance by Year and District==
 +
The Clearance by Year and District report returns the total area cleared, hours spent, devices, and number of positive samples grouped by year and district.
 +
 +
[[Image:Clearance Operaitons by Year and District.png|center|500px|''Figure 44. Sample report-Clearance by year and district'']]
 +
 +
====Table 9====
 +
{| class="wikitable"
 +
|-
 +
| File Name|| Clearance by Year and District Sample.jrxml
 +
|-
 +
| Data source|| Hazard reduction
 +
|-
 +
| Variables|| Count variables for all the derived fields
 +
|-
 +
| Derived fields
 +
|| One derived field for each device sub-category (i.e., Anti-Tank, Anti-Vehicle, etc.,) created by using parameterized derived field com.fgm.imsma.ext.report.OrdnanceWithSubCategoryExists, passing in the device subcategory imsma enum.
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
==Hazards by Ordnance Type==
 +
The Hazards by Ordnance Type report shows summary data based on the full set of Ordnance Types present.  This report groups Hazards based on the full list of Ordnance SubCategories that are found on the Hazard.  The report displays the name of the search in the report title.
 +
 +
[[Image:MRE audience.png|center|500px|''Figure 45.'' ''Sample report- Hazard by ordnance type'']]
 +
 +
====Table 10====
 +
{| class="wikitable"
 +
|-
 +
| File name || Hazards by Ordnance Type.jrxml
 +
|-
 +
| Data source|| Hazard
 +
|-
 +
| Variables
 +
|| Count of hazards for each ordnance sub-category
 +
Sum of area size,
 +
Average of area size
 +
|-
 +
| Derived fields || HazardOrdnanceSubCategoryList (Ordnance SubCategory List)
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
==MRE Audience Totals by Age==
 +
The MRE Audience Totals by Age report lists the different age categories of MRE audiences and the total number of male, female, and unknown gender in each age category.
 +
 +
[[Image:MRE audience.png|center|500px|''Figure 46.'' ''Sample report- MRE audience totals by age'']]
 +
 +
====Table 11====
 +
{| class="wikitable"
 +
|-
 +
| File name  || MRE Audience by Age.jrxml
 +
|-
 +
| Data source|| MRE Details
 +
|-
 +
| Variables
 +
|| Sums of each gender (derived fields) by group and report
 +
Sum of total audience by group and report
 +
Count of number of events (MRE Details) by group and report
 +
|-
 +
| Derived Fields
 +
|| MREDetailMaleAudience (Total Male Audience)
 +
MREDetailFemaleAudience (Total Female Audience)
 +
MREDetailUnknownAudience (Total Unknown Audience)
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
==Pie Chart Sample==
 +
The Pie Chart sample report returns the metal contamination level of hazards and area size. The report includes a pie chart which summarizes the total area size of hazards by their metal contamination level.
 +
 +
[[Image:Pie Chart.png|center|500px|''Figure 47.'' ''Sample report- Pie chart'']]
 +
 +
====Table 12====
 +
{| class="wikitable"
 +
|-
 +
| File name || Pie Chart Sample.jrxml
 +
|-
 +
| Data source || Hazard
 +
|-
 +
| Variables
 +
|| Sum of area size
 +
Count of metal contamination level
 +
 +
|-
 +
| Derived fields || None
 +
|-
 +
| Sub-reports|| None
 +
|}
 +
 +
==Accident Victim Summary Report==
 +
The Accident Victim Summary report lists accidents and the victims that are linked to them. In this example, the victim data is linked to the accident and returned via a sub-report. For this type of report, compile the sub-report (Sub-reports\Summary_AccidentVictim_sub-report0.jrxml) before attempting to run the main report.
 +
 +
Set the SUB-REPORT_DIR parameter to .\Sub-reports\.
 +
[[Image:Accident Victim.png|center|500px|''Figure 48.'' ''Sample report- Accident victim summary'']]
 +
 +
====Table 13====
 +
{| class="wikitable"
 +
|-
 +
| File name|| Summary_AccidentVictim.jrxml
 +
|-
 +
| Data source
 +
|| Accident
 +
Query executor (used by victim sub-report)
 +
|-
 +
| Variables
 +
|| Sum of area size
 +
Count of metal contamination level
 +
|-
 +
| Derived fields|| None
 +
|-
 +
| Sub-reports|| Sub-reports\Summary_AccidentVictim_sub-report0.jrxml
 +
|}
 +
 +
==Hazard Summary Report==
 +
File: Summary_Hazard.jrxml
 +
Data source: Hazard
 +
 +
[[Image:Hazard Summary.png|center|500px|''Figure 49.'' ''Sample report- Hazard summary'']]
 +
 +
===Hazard Reduction Summary Report===
 +
File: Summary_Hazreduc.jrxml
 +
Data source: Hazard Reduction
 +
[[Image:Hazard Reduction.png|center|500px|''Figure 50.'' ''Sample report- Hazard reduction summary'']]
 +
 +
===Location Summary Report===
 +
File: Summary_Location.jrxml
 +
Data source: Location
 +
[[Image:Location Summary.png|center|500px|''Figure 51.'' ''Sample report- Location summary'']]
 +
 +
For this type of report, compile the sub-report (Sub-reports\Summary_Mre_sub-report1.jrxml) before attempting to run the main report.
 +
 +
Set the SUB-REPORT_DIR parameter to .\Sub-reports\.
 +
[[Image:MRE Summary.png|center|500px|''Figure 52.'' ''Sample report- MRE summary'']]
 +
 +
====Table 15====
 +
{| class="wikitable"
 +
|-
 +
| File name|| Summary_MRE.jrxml
 +
|-
 +
| Data source
 +
|| MRE
 +
Query executor (used by the sub-report)
 +
|-
 +
| Derived fields|| None
 +
|-
 +
| Sub-reports|| Sub-reports\Summary_Mre_sub-report1.jrxml
 +
|}
 +
 +
===Organisation List Report===
 +
File: Summary_Organisation.jrxml
 +
Data source: Organisation
 +
 +
[[Image:Organisation List Report.png|center|500px|''Figure 53.'' ''Sample report- Organisation list'']]
 +
 +
===Place List Report===
 +
File: Summary_Place.jrxml
 +
Data source: Place
 +
[[Image:Place List Report.png|center|500px|''Figure 54.'' ''Sample report- Place list'']]
 +
 +
===Quality Control Summary Report===
 +
File: Summary_QA.jrxml
 +
Data source: Qa
 +
[[Image:Quality Control Summary Report.png|center|500px|''Figure 55.'' ''Sample report- Quality control summary'']]

Revision as of 20:54, 23 October 2012

How To

Introduction

i-Report

iReport is a third-party application that allows you to generate custom-defined reports on IMSMA data. Using iReport, you may define the attributes that are returned by a report and also customise the appearance of the report.

How To Use This Manual

This guide provides information for using iReport with IMSMA. It provides the steps for configuring and using iReport to report on IMSMA data. It is not intended to serve as a complete guide for using iReport. For detailed information on using iReport, refer to the iReport help or documentation. CONVENTIONS Table 1 lists the conventions used in the manual.

Table 1. Conventions
Convention Meaning
Bold Indicates menu, button, icon, or list names.
[Bold in brackets] Indicates a keyboard key.
Italics Indicates text that should be typed exactly as it is shown in the user manual into a field. Italicized text is also used to note options that may be selected from a list.
Note.jpg Indicates a tip for using IMSMA.
Warning.jpg Indicates steps for completing a task.
40px Indicates an error that you might encounter.

Sample Reports

IMSMA includes several iReport sample reports. These reports may be used as is or used as a reference to create your reports. The sample reports are installed in the \iReports\IMSMA reports directory of your IMSMA installation directory.

Article 7: Form A

The Article 7: Form A report returns the total area size of all reductions that are being reported on, the total area size of all hazards that have been linked to the reported reductions, and a count of all victims that have been linked to the reported reductions. If a search definition is associated with the report, the search definition name will be displayed in the report title.

Table 6

File name Article 7 Form A.jrxml
Data source Hazard reduction
Variables Sum of hazard reduction area size

Sum of total hazard area size Sum of victim counts

Derived fields HazreducLinkedHazardAreaSize (Total Hazard Area Size)

HazreducLinkedVictimCount (Victim Count)

Sub-reports None

Article 7: Form C

The Article 7: Form C report returns a crosstab by district and hazard with the number of hazards by hazard type.

Figure 42. Sample report- Article 7-form C

Table 7

File name Article 7 Form C.jrxml
Data source Hazard
Variables REPORT_COUNT (built-in iReport variable)
Derived fields None
Sub-reports None

Bar Chart Sample

The Bar Chart sample report returns the metal contamination level of hazards and area size. The report includes a bar chart which summarizes the total area size of hazards by their metal contamination level.

Figure 43. Sample report- Bar chart

Table 8

File name Bar Chart Sample.jrxml
Data source Hazard
Variable Sum of area size

Count of metal contamination level

Derived fields None
Sub-reports None

Clearance by Year and District

The Clearance by Year and District report returns the total area cleared, hours spent, devices, and number of positive samples grouped by year and district.

Figure 44. Sample report-Clearance by year and district

Table 9

File Name Clearance by Year and District Sample.jrxml
Data source Hazard reduction
Variables Count variables for all the derived fields
Derived fields One derived field for each device sub-category (i.e., Anti-Tank, Anti-Vehicle, etc.,) created by using parameterized derived field com.fgm.imsma.ext.report.OrdnanceWithSubCategoryExists, passing in the device subcategory imsma enum.
Sub-reports None

Hazards by Ordnance Type

The Hazards by Ordnance Type report shows summary data based on the full set of Ordnance Types present. This report groups Hazards based on the full list of Ordnance SubCategories that are found on the Hazard. The report displays the name of the search in the report title.

Figure 45. Sample report- Hazard by ordnance type

Table 10

File name Hazards by Ordnance Type.jrxml
Data source Hazard
Variables Count of hazards for each ordnance sub-category

Sum of area size, Average of area size

Derived fields HazardOrdnanceSubCategoryList (Ordnance SubCategory List)
Sub-reports None

MRE Audience Totals by Age

The MRE Audience Totals by Age report lists the different age categories of MRE audiences and the total number of male, female, and unknown gender in each age category.

Figure 46. Sample report- MRE audience totals by age

Table 11

File name MRE Audience by Age.jrxml
Data source MRE Details
Variables Sums of each gender (derived fields) by group and report

Sum of total audience by group and report Count of number of events (MRE Details) by group and report

Derived Fields MREDetailMaleAudience (Total Male Audience)

MREDetailFemaleAudience (Total Female Audience) MREDetailUnknownAudience (Total Unknown Audience)

Sub-reports None

Pie Chart Sample

The Pie Chart sample report returns the metal contamination level of hazards and area size. The report includes a pie chart which summarizes the total area size of hazards by their metal contamination level.

Figure 47. Sample report- Pie chart

Table 12

File name Pie Chart Sample.jrxml
Data source Hazard
Variables Sum of area size

Count of metal contamination level

Derived fields None
Sub-reports None

Accident Victim Summary Report

The Accident Victim Summary report lists accidents and the victims that are linked to them. In this example, the victim data is linked to the accident and returned via a sub-report. For this type of report, compile the sub-report (Sub-reports\Summary_AccidentVictim_sub-report0.jrxml) before attempting to run the main report.

Set the SUB-REPORT_DIR parameter to .\Sub-reports\.

Figure 48. Sample report- Accident victim summary

Table 13

File name Summary_AccidentVictim.jrxml
Data source Accident

Query executor (used by victim sub-report)

Variables Sum of area size

Count of metal contamination level

Derived fields None
Sub-reports Sub-reports\Summary_AccidentVictim_sub-report0.jrxml

Hazard Summary Report

File: Summary_Hazard.jrxml Data source: Hazard

Figure 49. Sample report- Hazard summary

Hazard Reduction Summary Report

File: Summary_Hazreduc.jrxml Data source: Hazard Reduction

Figure 50. Sample report- Hazard reduction summary

Location Summary Report

File: Summary_Location.jrxml Data source: Location

Figure 51. Sample report- Location summary

For this type of report, compile the sub-report (Sub-reports\Summary_Mre_sub-report1.jrxml) before attempting to run the main report.

Set the SUB-REPORT_DIR parameter to .\Sub-reports\.

Figure 52. Sample report- MRE summary

Table 15

File name Summary_MRE.jrxml
Data source MRE

Query executor (used by the sub-report)

Derived fields None
Sub-reports Sub-reports\Summary_Mre_sub-report1.jrxml

Organisation List Report

File: Summary_Organisation.jrxml Data source: Organisation

Figure 53. Sample report- Organisation list

Place List Report

File: Summary_Place.jrxml Data source: Place

Figure 54. Sample report- Place list

Quality Control Summary Report

File: Summary_QA.jrxml Data source: Qa

Figure 55. Sample report- Quality control summary
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Use_iReport&oldid=5457"