__FORCETOC__
{{TOC right}}
{{HowTo's
|[[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 IMSMAcan be imported into {{IMSMANG}} and run by {{IMSMANG}} users to extract data based on search criteria. It provides the steps for configuring Reports can be exported to PDF, RTF, XLS, and using other formats. iReport to report on IMSMA dataDesigner version 5.0. It 1 is not intended to serve as a complete guide for using included with the {{IMSMANG}} distribution. Using iReportDesigner, users create . For detailed information on using jrxml iReporttemplates, a kind of xml report definition, refer that can be used by {{IMSMANG}} to the iReport help or documentation[[Producing Reports Using IMSMANG|produce a formatted report]].
===Conventions===<u>Table 1</u> lists the conventions used in the manual.<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 the user manual into a field. 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.png|40px]] || Indicates an error that you might encounter.|}</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. [[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===={| 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 |} ===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'']]<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 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 does not support Java 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|''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 TypeiReport Basics==__NOEDITSECTION__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 iReport uses standard reporting terms to refer to the name basic building blocks of the search in the report title. [[Image:MRE audience.png|center|500px|''Figure 45templates.'' ''Sample report- Hazard by ordnance type'']] ====Table 10=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;"|-| File name || Hazards by Ordnance Type.jrxml|-| +Available Data source|| HazardSources
|-
| Variables Accident Device || Count of hazards for each ordnance sub-categorySum of area size,Average of area sizeMRE
|-
| Derived fields Accident || HazardOrdnanceSubCategoryList (Ordnance SubCategory List)MRE Detail
|-
| Sub-reportsAssistance Classification || 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"Needs Assessment Classification
|-
| File name Cause Classification || MRE Audience by Age.jrxmlOrdnance
|-
| Data sourceField Report || MRE DetailsOrganisation
|-
| VariablesGazetteer || 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 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"Place
|-
| File name Geopoint || Pie Chart Sample.jrxmlQM
|-
| Data source Geospatialinfo || HazardQuestion
|-
| Variables Hazard || Sum of area sizeCount of metal contamination levelReceived MRE
|-
| Derived fields Hazard Device || NoneTask
|-
| Sub-reportsHazard Reduction || 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 nameHazard Reduction Device || Summary_AccidentVictim.jrxmlVictim Assistance
|-
| Data sourceImpact Survey || AccidentQuery executor (used by victim sub-report)Victim Assistance Assistance
|-
| VariablesInterviewee || Sum of area sizeCount of metal contamination levelVictim Cause
|-
| Derived fieldsLink || NoneVictim Needs Assessment
|-
| Sub-reportsLocation || 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'']]Work Item
===Location Summary Report===
File: Summary_Location.jrxml
Data 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"
|-
| 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.jrxmlData source: Organisation [[Image:Organisation List Report.png|center|500px|''Figure 53.'' ''Sample report- Organisation list'']] ===Place List Report===File: Summary_Place.jrxmlData source: Place[[Image:Place List Report.png|center|500px|''Figure 54.'' ''Sample report- Place list'']] ===Quality Control Summary Report===File: Summary_QA.jrxmlData source: Qa[[Image:Quality Control Summary Report.png|center|500px|''Figure 55.'' ''Sample report- Quality control summary'']] ==Appendix A: IMSMA Database=====Overview===The IMSMA database contains tables for IMSMA’s base data (country structures, explosive, ordnance, organisations, and places), locations, iReport datasource management and selection window can be found just below the locations’ associated accidents, hazards, hazard reductions, MREs, QCs, and victimsmenu bar in iReport Designer. [[Image:fig56iR_AppndxIReport Datasources Window.png|center|500px|''Figure 56. Conceptual database modelDatasource selection window'']]
<div align="center">
''Figure 56. Conceptual database modeliReport Datasource Selection Window''
</div>
Within each country structure ===Fields===__NOEDITSECTION__ Fields in iReport refer to individual IMSMA data elements that are zero or more locations. For example, available from a particular province may have multiple locations within it while another province has no locations. Each location may have zero or more items such as accidents, hazards, hazard reductions, MREs, QCs, or victims associated with themdata source. These accidents, hazards, hazard reductions, MREs, QCs, or victims Fields are added to denoted in iReport using the IMSMA database via field reportsfollowing syntax '''''$F{fieldname}''''' (e.g. '''''$F{guid}'''''). Each data source contains a list of available fields. ===Variables===__NOEDITSECTION__ IMSMA items may have either a direct or a linked relationship to other items. Direct relationships occur when one item requires Variables in iReport are created within the other item iReport template to exist. For example, an accident, hazard, hazard reduction, MRE, QC, manipulate or victim has a direct relationship to the location to which it is associatedcalculate data. The accidentUsing variables, hazard, hazard reductionusers can create calculations such as sums, MREcounts, QCaverages, or victim cannot exist unless it is associated with a locationother totals. This direct relationship is enforced Variables are denoted in IMSMA via iReport using the reconciliation processfollowing syntax '''''$V{variablename}''''' (e.g. '''''$V{SumAreaSize}'''''). Direct relationships also exist when subsets of Variables can use field and/or parameter data .===Parameters===__NOEDITSECTION__ Parameters in iReport are contained within an item. For exampleused to accept and transfer external information, an MRE may have MRE details such as the MRE type, total audience, and percentage of women and meninformation from another report. The MRE details data requires Parameters are denoted in iReport using the MRE to existfollowing syntax '''''$P{parametername}''''' (e. Table 15g. Direct relationships between items lists '''''$P{ParentGuid}''''')===Bands===__NOEDITSECTION__ Bands are used in iReport to specify areas on the items and the data subsets that depend on themresulting report. Each band acts differently in a report. <center>The most used bands in iReport are:{| class="wikitable" width="500"|-| align="center" colspanstyle="2margin: 1em auto 1em auto;" | '''Table 15. Direct relationships between items'''
|-
| width="100pt" | '''Parent item'''| align="center" width="400pt" | '''Child item(s) which require the parent item'''! Band Name !! Use
|-
| Hazard reduction Title || Impact surveyIntervieweeOrganisationQuestionSampleSectorVegetation removalDisplayed once at the beginning of the report
|-
| Location Column or Group Header || AccidentHazardHazard reductionMREQAVictim Displayed at the top of each page or section
|-
| MRE Detail || MRE detailsDisplayed once for each data row returned by the report. Most often data elements will exist in this band.
|-
| Victim Summary || Received MREDisplayed once at the end of the report. Useful for charts, crosstabs, and totals.
|}
</center>
Linked relationships are optional relationships which may exist between items. Accidents, hazards, hazard reductions, MREs, QCs, and victims may be related to one another via links. For example, a victim may be associated to an accident in a particular hazard. If these relationships are known, IMSMA users may define these links while reconciling the field report.
===Guids===
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, and in determining what links exists between item records.
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 ([[:Image:fig57iR_Appndx.png|Figure 57]]).
[[Image:fig57iR_Appndx.png|center|500px|''Figure 57. location_guid'']]
<div align="center">
''Figure 57. location_guid''
</div>
The location_guid field in the item table contains the guid of the location to which the item record is associated. [[:Image:fig58iR_Appndx.png|Figure 58]] 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.
[[Image:fig58iR_Appndx.png|center|500px|''Figure 58. location_guid example'']]
<div align="center">
''Figure 58. location_guid example''
</div>
When you create a report on a location and its associated items, you will need to use location.guid = "$P{'''LocationParamName'''}" in the query of the sub-report where '''LocationParamName''' is the name of the parameter that you created for the location ([[:Image:fig59iR_Appndx.png|Figure 59]]).
[[Image:fig59iR_Appndx.png|center|500px|''Figure 59. Sub-report query for location and associated items'']]
<div align="center">
''Figure 59. Sub-report query for location and associated items''
</div>
IMSMA allows users to define relationships between item records of differing types. For example, an accident may be related to a particular hazard. These relationships are referred to as links. The link table contains the links that have been defined between item records. The link table contains the guid of the item from which the link was established (from_guid) and the guid to which the link is being established (to_guid). [[:Image:fig60iR_Appndx.png|Figure 60]] shows an example of a link that was created from an accident to a hazard. These links are stored in the link table.
[[Image:fig60iR_Appndx.png|center|500px|''Figure 60. Link table example'']]
<div align="center">
''Figure 60. Link table example''
</div>
When you create a report that includes linked items, you will need to use links.toGuid = "$P{'''PrimaryParamName'''} in the query of the sub-report where '''PrimaryParamName''' is the name of the parameter that you created for the primary report item ([[:Image:fig61iR_Appndx.png|Figure 61]]).
[[Image:fig61iR_Appndx.png|center|500px|''Figure 61. Sub-report query for linked items'']]
<div align="center">
''Figure 61. Sub-report query for linked items''
</div>
==Appendix B=Groups===__NOEDITSECTION__ Groups 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. Data Source FieldsGroups can be added in the iReport Wizard or after a report has been created.===Subreports===__NOEDITSECTION__ The following sections list Subreports are used in iReport to include more than one data source in 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__ In addition to the various data sources that 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. Crosstabs and chart elements typically belong only in the fields Summary band of a report while formatting elements including images can be included anywhere within themthe report template.
Need to add derived fields to this list{{Note | All field, variable, and parameter references in {{IMSMANG}} are case-sensitive}}
===Accident===A field for each country structure level will also be available. Because the country structure levels may vary for each site, these fields are not listed below. <center>{| class="wikitable" width="500"|-| align="center" colspan="2" | '''Accident fields'''|-| width="250pt" | '''Field name'''| align="center" width="250pt" | '''{NavBox HowTo Standardizing Data type'''|-| Accident Description || Text|-| Accident ID || Varchar(50)|-| Area Marked || Varchar(38)|-| Area Officer || Varchar(50)|-| Clearance In Progress? || Varchar(38)|-| Confirmed || Varchar(38)|-| Data Gathered By || Varchar(25)|-| Date of Accident || Datetime|-| Description of ref area |||-| Distance From Nearest Town || Text|-| Distance From City || |-| Equipment Damage || Float|-| Guid || Varchar(38)|-| Inquiry Report Reference || Text|-| Lat/Long || |-| Linked Victim Name(s) || A derived field that returns A comma separated list of the names (first Analysis and last) of all victims that are linked to the accident.|-| Location ID || Varchar(38)|-| Mine Action Activity Type || Varchar(38)|-| Municipality || Varchar(125)|-| Number of Linked Victims || A derived field that returns the number of victims that are linked to the accident. |-| Number of Persons Involved || Int(10)|-| Property Damage || Float|-| Reliability of Information || Varchar(38)|-| Reliability of Source || Varchar(38)|-| Source || Varchar(50)|-| Type of Accident || Varchar(38)|-| Type of Area || Varchar(38)|-| Type of Hazardous Area || Varchar(38)|-| Unknown Device || Varchar(38)|-| Was Mine/UXO Marked? || Varchar(38)|Reporting}}</center>[[Category:VIE]]
