Changes

|[[HowTo:Start and Configure i-Report|Start and Configure i-ReportiReport]]|[[HowTo:Create a Basic i-Report iReport Template]]|Create a Basic i-Report [[Modify an iReport Template]]|[[HowTo:Create i-Report Templates with SubreportsFormat an iReport Template]]|[[Create i-Report iReport Templates with Subreports]]|[[HowTo:Summarize i-Report Template Data|Summarize i-Report iReport Template Data]]

==Introductionto iReport==__NOEDITSECTION__===i-Report===iReport Designer (also known as 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 Report templates designed in iReport with IMSMA. It provides the steps for configuring can be imported into {{IMSMANG}} and using iReport run by {{IMSMANG}} users to report extract data based on IMSMA datasearch criteria. It is not intended Reports can be exported to serve as a complete guide for using iReportPDF, RTF, XLS, and other formats. For detailed information on using iReport, refer to the iReport help or documentationDesigner version 5.CONVENTIONSTable 1 lists the conventions used in the manual0.<center>{| class="wikitable" width="500"|-| align="center" colspan="2" | '''Table 1. Conventions'''|-| width="100pt" | '''Convention'''| align="center" width="400pt" | '''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 included with the user manual into a field{{IMSMANG}} distribution. Italicized text is also used to note options that may be selected from a list.|-| [[Image:Note.jpg|40px]] || Indicates a tip for using IMSMA.|-| [[Image:Warning.jpg|40px]] || Indicates steps for completing a task.|-| [[Image:MobilePen.jpg|40px]] || Indicates an error that you might encounter.|}</center> ==Sample Reports==IMSMA includes several Using iReport sample reports. These reports may be used as is or used as a reference to Designer, users 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 onjrxml iReport templates, the total area size of all hazards that have been linked to the reported reductions, and a count kind of all victims that have been linked to the reported reductions. If a search xml report definition is associated with the report, the search definition name will that can be displayed in the report title. [[Image:fig41SampleReport.png|center|500px|''Figure 41. Sample report - Article 7 form A'']]<div align="center">''Figure 41. Sample report - Article 7 form A''</div> ====Table 6====used by {{| class="wikitable"|-| File name || Article 7 Form A.jrxml|-| Data source|| Hazard reduction|-| Variables || Sum of hazard reduction area sizeSum of total hazard area sizeSum of victim counts|-| Derived fields || HazreducLinkedHazardAreaSize (Total Hazard Area Size)HazreducLinkedVictimCount (Victim Count)|-| Sub-reports|| None |IMSMANG}} ===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. to [[Image:Article 7FormC.pngProducing Reports Using IMSMANG|center|500px|''Figure 42. Sample report- Article 7-form C'']]<div align="center">''Figure 42. Sample report – Article 7 form C''</div> ====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 produce a bar chart which summarizes the total area size of hazards by their metal contamination level.  [[Image:BarChartSample.png|center|500px|''Figure 43.'' ''Sample formatted report- Bar chart'' '']] ====Table 8===={| class="wikitable"|-| File name|| Bar Chart Sample.jrxml|-| Data source|| Hazard|-| Variable|| Sum of area sizeCount 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{{note|''Figure 44iReport does not support Java 8. Sample report-Clearance by year and district'']]}}

==iReport Basics==Table 9__NOEDITSECTION__iReport uses standard reporting terms to refer to the basic building blocks of report templates.===Data Sources===__NOEDITSECTION__Data sources in iReport refer to the connection between the report template and the {{IMSMANG}} database. Each iReport template will have one data source. Data sources in iReport generally refer to items in {{IMSMANG}} such as Land, Activity, Education, Accident, Victim, etc. Available data sources include:{| class="wikitable"style="margin: 1em auto 1em auto;"|+Available Data Sources

| File NameAccident Device || Clearance by Year and District Sample.jrxmlMRE

| Data sourceAccident || Hazard reductionMRE Detail

| VariablesAssistance Classification || Count variables for all the derived fieldsNeeds Assessment Classification

| Derived fieldsCause Classification || 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.Ordnance

| Sub-reportsField Report || 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"Organisation

| File name Gazetteer || Hazards by Ordnance Type.jrxmlPlace

| Data sourceGeopoint || HazardQM

| Variables Geospatialinfo || Count of hazards for each ordnance sub-categorySum of area size,Average of area sizeQuestion

| Derived fields Hazard || HazardOrdnanceSubCategoryList (Ordnance SubCategory List)Received MRE

| Sub-reportsHazard Device || 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"Task

| File name Hazard Reduction || MRE Audience by Age.jrxmlVictim

| Data sourceHazard Reduction Device || MRE DetailsVictim Assistance

| VariablesImpact Survey || Sums of each gender (derived fields) by group and reportSum of total audience by group and reportCount of number of events (MRE Details) by group and reportVictim Assistance Assistance

| Derived FieldsInterviewee || MREDetailMaleAudience (Total Male Audience)MREDetailFemaleAudience (Total Female Audience)MREDetailUnknownAudience (Total Unknown Audience)Victim Cause

| Sub-reportsLink || 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.jrxmlVictim Needs Assessment

| Data source Location || Hazard|-| Variables || Sum of area sizeCount of metal contamination levelWork Item

==Accident Victim Summary Report==The Accident Victim Summary report lists accidents iReport datasource management and selection window can be found just below the victims that are linked to themmenu bar in iReport Designer. 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[[Image:IReport Datasources Window.png|center|500px|''Datasource selection window'']]<div align="center">''iReport Datasource Selection Window''</div>

Set ===Fields===__NOEDITSECTION__ Fields in iReport refer to individual IMSMA data elements that are available from a data source. Fields are denoted in iReport using the SUB-REPORT_DIR parameter to following syntax '''''$F{fieldname}''''' (e.g. '''''$F{guid}''''').\Sub-reports\Each data source contains a list of available fields. [[Image:Accident Victim===Variables===__NOEDITSECTION__ Variables in iReport are created within the iReport template to manipulate or calculate data. Using variables, users can create calculations such as sums, counts, averages, or other totals.png|center|500px|Variables are denoted in iReport using the following syntax '''''$V{variablename}'''''Figure 48(e.g.'' ''Sample report- Accident victim summary'$V{SumAreaSize}''''']]). Variables can use field and/or parameter data.===Parameters=Table 13==__NOEDITSECTION__ Parameters in iReport are used to accept and transfer external information, such as information from another report. Parameters are denoted in iReport using the following syntax '''''$P{parametername}''''' (e.g. '''''$P{ParentGuid}''''')===Bands===__NOEDITSECTION__ Bands are used in iReport to specify areas on the resulting report. Each band acts differently in a report. The most used bands in iReport are:{| class="wikitable"|-| File name|| Summary_AccidentVictim.jrxml|-| Data source|| AccidentQuery executor (used by victim sub-report)|-| Variables|| Sum of area sizeCount of metal contamination level|-| Derived fields|| Nonestyle="margin: 1em auto 1em auto;"

| Sub-reports|| Sub-reports\Summary_AccidentVictim_sub-report0.jrxml|} ==Hazard Summary Report==File: Summary_Hazard.jrxmlData source: Hazard [[Image:Hazard Summary.png|center|500px|''Figure 49.'' ''Sample report- Hazard summary'']] ===Hazard Reduction Summary Report===File: Summary_Hazreduc.jrxmlData source: Hazard Reduction[[Image:Hazard Reduction.png|center|500px|''Figure 50.'' ''Sample report- Hazard reduction summary'']] ===Location Summary Report===File: Summary_Location.jrxmlData source: Location[[Image:Location Summary.png|center|500px|''Figure 51.'' ''Sample report- Location summary'']] ==MRE Summary Report==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"! Band Name !! Use

| File nameTitle || Summary_MRE.jrxmlDisplayed once at the beginning of the report

| Data sourceColumn or Group Header || MREQuery executor (used by Displayed at the sub-report)top of each page or section

| Derived fieldsDetail || NoneDisplayed once for each data row returned by the report. Most often data elements will exist in this band.

| Sub-reportsSummary || Sub-reports\Summary_Mre_sub-report1Displayed once at the end of the report. Useful for charts, crosstabs, and totals.jrxml

===Organisation List ReportGroups===__NOEDITSECTION__ File: Summary_OrganisationGroups in iReport are used to display records with one or more common values together on a report. For example, Land with the same value for "Province" could be grouped together in a report. Groups can be added in the iReport Wizard or after a report has been created.jrxmlData ===Subreports===__NOEDITSECTION__ Subreports are used in iReport to include more than one data source: Organisationin a report. For example, to include information about Activities performed on a particular Land, you would include an Activity subreport in the Land report.===Crosstabs, Charts, and Formatting Elements===__NOEDITSECTION__ [[Image:Organisation List ReportIn addition to the iReport elements addressed above, additional specialized iReport elements are available to include in iReport templates including Crosstabs, Charts, and additional formatting elements such as lines, rectangles, etc.png|center|500px|''Figure 53Crosstabs and chart elements typically belong only in the Summary band of a report while formatting elements including images can be included anywhere within the report template.'' ''Sample report- Organisation list'']]

===Place List Report===File: Summary_Place.jrxmlData source: Place[[Image:Place List Report.png{{Note |center|500px|''Figure 54.'' ''Sample reportAll field, variable, and parameter references in {{IMSMANG}} are case- Place list'']]sensitive}}

===Quality Control Summary Report===File: Summary_QA.jrxml{{NavBox HowTo Standardizing Data source: QaAnalysis and Information Reporting}}[[ImageCategory:Quality Control Summary Report.png|center|500px|''Figure 55.'' ''Sample report- Quality control summary''NAA]]