NoPublic, bureaucrat, administrator
6,632
edits
Changes
no edit summary
__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 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 PDF, RTF, XLS, and other formats. iReportDesigner version 5. For detailed information on using iReport, refer to the iReport help or documentation0.CONVENTIONSTable 1 lists is included with the conventions used in the manual.<center>{| class="wikitable" width="500"|-| align="center" colspan="2" | '''Table 1{IMSMANG}} distribution. Conventions'''|-| width="100pt" | '''Convention'''| align="center" width="400pt" | '''Meaning'''|-| ''Bold'' || Indicates menuUsing iReport Designer, buttonusers create .jrxml iReport templates, icona kind of xml report definition, or list names.|-| ''[Bold in brackets]'' || Indicates a keyboard key.|-| ''Italics'' || Indicates text that should can be typed exactly as it is shown in the user manual into a field. Italicized text is also used by {{IMSMANG}} to note options that may be selected from a list.|-| [[File:Note.jpg|40px]] |Producing Reports Using IMSMANG| Indicates produce a tip for using IMSMA.|-| [[File:Warning.jpg|40px]] || Indicates steps for completing a task.|-| [[File:MobilePen.png|40pxformatted report]] || Indicates an error that you might encounter.|}</center>
=== Article 7: Form A=iReport Basics==__NOEDITSECTION__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 iReport uses standard reporting terms to refer to the reported reductions, and a count basic building blocks 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 titletemplates. ====Table 6=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 || Article 7 Form A.jrxml|-| +Available 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)Sources
|-
| Sub-reportsAccident Device || 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"MRE
|-
| File nameAccident || Article 7 Form C.jrxmlMRE Detail
|-
| Data sourceAssistance Classification || HazardNeeds Assessment Classification
|-
| VariablesCause Classification || REPORT_COUNT (built-in iReport variable)Ordnance
|-
| Derived fieldsField Report || NoneOrganisation
|-
| Sub-reportsGazetteer || 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"Place
|-
| File nameGeopoint || Bar Chart Sample.jrxmlQM
|-
| Data sourceGeospatialinfo || HazardQuestion
|-
| VariableHazard || Sum of area sizeCount of metal contamination levelReceived MRE
|-
| Derived fieldsHazard Device || NoneTask
|-
| Sub-reportsHazard Reduction || 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"Victim
|-
| File NameHazard Reduction Device || Clearance by Year and District Sample.jrxmlVictim Assistance
|-
| Data sourceImpact Survey || Hazard reductionVictim Assistance Assistance
|-
| VariablesInterviewee || Count variables for all the derived fieldsVictim Cause
|-
| Derived fieldsLink || 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.Victim Needs Assessment
|-
| Sub-reportsLocation || 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'']]Work Item
|}
|-
|-
| Data sourceTitle || MRE DetailsDisplayed once at the beginning of the report
|-
| VariablesColumn or Group Header || Sums Displayed at the top 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 reportpage or section
|-
| Derived FieldsDetail || MREDetailMaleAudience (Total Male Audience)MREDetailFemaleAudience (Total Female Audience)MREDetailUnknownAudience (Total Unknown Audience)Displayed once for each data row returned by the report. Most often data elements will exist in this band.
|-
| Sub-reportsSummary || NoneDisplayed once at the end of the report. Useful for charts, crosstabs, and totals.
|}
==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==Groups=={| class="wikitable"|-__NOEDITSECTION__ | File name || Pie Chart Sample.jrxml|-| Data source || Hazard|-| Variables || Sum of area sizeCount 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 Groups in iReport are linked to them. In this example, the victim data is linked used to the accident and returned via display records with one or more common values together on a sub-report. For this type of reportexample, compile Land with the sub-same value for "Province" could be grouped together in a report (Sub-reports\Summary_AccidentVictim_sub-report0.jrxml) before attempting to run Groups can be added in the main iReport Wizard or after a reporthas been created. Set the SUB-REPORT_DIR parameter to .\Sub-reports\. [[Image:Accident Victim.png|center|500px|''Figure 48.'' ''Sample report- Accident victim summary'']] ====Table 13=Subreports===__NOEDITSECTION__ {| class="wikitable"|-| File name|| Summary_AccidentVictim.jrxml|-| Data Subreports are used in iReport to include more than one data source|| AccidentQuery executor (used by victim sub-in a report)|-| Variables|| Sum of area sizeCount of metal contamination level|-| Derived fields|| None|-| 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 For example, to include information about Activities performed on a particular Land, you would include an Activity subreport in the Land 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 ReportCrosstabs, Charts, and Formatting Elements===__NOEDITSECTION__ 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 reportIn addition to the iReport elements addressed above, compile the sub-report (Sub-reports\Summary_Mre_sub-report1.jrxml) before attempting additional specialized iReport elements are available to run the main reportinclude in iReport templates including Crosstabs, Charts, and additional formatting elements such as lines, rectangles, etc. Set Crosstabs and chart elements typically belong only in the SUB-REPORT_DIR parameter to .\Sub-reports\.[[Image:MRE Summary.png|center|500px|''Figure 52.'' ''Sample band of a report- MRE summary'']] ====Table 15===={| class="wikitable"|-| File name|| Summary_MRE.jrxml|-| Data source|| MREQuery executor (used by while formatting elements including images can be included anywhere within the sub-report)|-| Derived fields|| None|-| Sub-reports|| Sub-reports\Summary_Mre_sub-report1template.jrxml|} ===Organisation List Report===File: Summary_Organisation.jrxmlData source: Organisation [[Image:Organisation List Report.png|center|500px|''Figure 53.'' ''Sample report- Organisation list'']]