Difference between revisions of "Use iReport"

From IMSMA Wiki
Jump to: navigation, search
 
(62 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
__FORCETOC__
 +
{{TOC right}}
 
{{HowTo's
 
{{HowTo's
−
|[[HowTo:Start and Configure i-Report|Start and Configure i-Report]]
+
|[[Start and Configure iReport]]
−
|[[HowTo:Create a Basic i-Report Template|Create a Basic i-Report Template]]
+
|[[Create a Basic iReport Template]]
−
|[[HowTo:Create i-Report Templates with Subreports|Create i-Report Templates with Subreports]]
+
|[[Modify an iReport Template]]
−
|[[HowTo:Summarize i-Report Template Data|Summarize i-Report Template Data]]
+
|[[Format an iReport Template]]
 +
|[[Create iReport Templates with Subreports]]
 +
|[[Summarize iReport Template Data]]
 
}}
 
}}
  
−
==Introduction==
+
==Introduction to 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. Report templates designed in iReport can be imported into {{IMSMANG}} and run by {{IMSMANG}} users to extract data based on search criteria. Reports can be exported to PDF, RTF, XLS, and other formats. iReport Designer version 5.0.1 is included with the {{IMSMANG}} distribution. Using iReport Designer, users create .jrxml iReport templates, a kind of xml report definition, that can be used by {{IMSMANG}} to [[Producing Reports Using IMSMANG|produce a formatted 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===
+
{{note|iReport does not support Java 8.}}
−
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
+
==iReport Basics==__NOEDITSECTION__
−
Table 1 lists the conventions used in the manual.
+
iReport uses standard reporting terms to refer to the basic building blocks of report templates.
−
<center>
+
===Data Sources===__NOEDITSECTION__
−
{| class="wikitable" width="500"
+
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
 +
|-
 +
| Accident Device ||MRE 
 +
|-
 +
| Accident ||MRE Detail
 +
|-
 +
| Assistance Classification ||Needs Assessment Classification
 +
|-
 +
| Cause Classification ||Ordnance
 +
|-
 +
| Field Report ||Organisation
 +
|-
 +
| Gazetteer ||Place
 +
|-
 +
| Geopoint ||QM
 +
|-
 +
| Geospatialinfo ||Question
 +
|-
 +
| Hazard ||Received MRE
 +
|-
 +
| Hazard Device ||Task
 
|-
 
|-
−
| align="center" colspan="2" | '''Table 1. Conventions'''
+
| Hazard Reduction ||Victim
 
|-
 
|-
−
| width="100pt" | '''Convention'''
+
| Hazard Reduction Device ||Victim Assistance
−
| align="center" width="400pt" | '''Meaning'''
 
 
|-
 
|-
−
| ''Bold'' || Indicates menu, button, icon, or list names.
+
| Impact Survey ||Victim Assistance Assistance
 
|-
 
|-
−
| ''[Bold in brackets]'' || Indicates a keyboard key.
+
| Interviewee ||Victim Cause
 
|-
 
|-
−
| ''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.
+
| Link ||Victim Needs Assessment
 +
|-
 +
| Location ||Work Item
 +
 
 +
|}
 +
 
 +
The iReport datasource management and selection window can be found just below the menu bar in iReport Designer.
 +
[[Image:IReport Datasources Window.png|center|500px|''Datasource selection window'']]
 +
<div align="center">
 +
''iReport Datasource Selection Window''
 +
</div>
 +
 
 +
===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 following syntax '''''$F{fieldname}''''' (e.g. '''''$F{guid}'''''). Each data source contains a list of available fields.
 +
===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. Variables are denoted in iReport using the following syntax '''''$V{variablename}''''' (e.g. '''''$V{SumAreaSize}'''''). Variables can use field and/or parameter data.
 +
===Parameters===__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" style="margin: 1em auto 1em auto;"
 
|-
 
|-
−
| [[File:Note.jpg|40px]] || Indicates a tip for using IMSMA.
+
! Band Name !! Use
 
|-
 
|-
−
| [[File:Warning.jpg|40px]] || Indicates steps for completing a task.
+
| Title || Displayed once at the beginning of the report
 
|-
 
|-
−
| [[Image:MobilePen.png|40px]] || Indicates an error that you might encounter.
+
| Column or Group Header || Displayed at the top of each page or section
 +
|-
 +
| Detail || Displayed once for each data row returned by the report. Most often data elements will exist in this band.
 +
|-
 +
| Summary || Displayed once at the end of the report. Useful for charts, crosstabs, and totals.
 
|}
 
|}
−
</center>
+
 
 +
===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. Groups can be added in the iReport Wizard or after a report has been created.
 +
===Subreports===__NOEDITSECTION__
 +
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 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 Summary band of a report while formatting elements including images can be included anywhere within the report template.
 +
 
 +
{{Note | All field, variable, and parameter references in {{IMSMANG}} are case-sensitive}}
 +
 
 +
{{NavBox HowTo Standardizing Data Analysis and Information Reporting}}
 +
[[Category:NAA]]

Latest revision as of 20:24, 20 February 2020

How To

Introduction to iReport

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. Report templates designed in iReport can be imported into IMSMANG and run by IMSMANG users to extract data based on search criteria. Reports can be exported to PDF, RTF, XLS, and other formats. iReport Designer version 5.0.1 is included with the IMSMANG distribution. Using iReport Designer, users create .jrxml iReport templates, a kind of xml report definition, that can be used by IMSMANG to produce a formatted report.

Note.jpg iReport does not support Java 8.

iReport Basics

iReport uses standard reporting terms to refer to the basic building blocks of report templates.

Data Sources

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:

Available Data Sources
Accident Device MRE
Accident MRE Detail
Assistance Classification Needs Assessment Classification
Cause Classification Ordnance
Field Report Organisation
Gazetteer Place
Geopoint QM
Geospatialinfo Question
Hazard Received MRE
Hazard Device Task
Hazard Reduction Victim
Hazard Reduction Device Victim Assistance
Impact Survey Victim Assistance Assistance
Interviewee Victim Cause
Link Victim Needs Assessment
Location Work Item

The iReport datasource management and selection window can be found just below the menu bar in iReport Designer.

Datasource selection window

iReport Datasource Selection Window

Fields

Fields in iReport refer to individual IMSMA data elements that are available from a data source. Fields are denoted in iReport using the following syntax $F{fieldname} (e.g. $F{guid}). Each data source contains a list of available fields.

Variables

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. Variables are denoted in iReport using the following syntax $V{variablename} (e.g. $V{SumAreaSize}). Variables can use field and/or parameter data.

Parameters

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

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:

Band Name Use
Title Displayed once at the beginning of the report
Column or Group Header Displayed at the top of each page or section
Detail Displayed once for each data row returned by the report. Most often data elements will exist in this band.
Summary Displayed once at the end of the report. Useful for charts, crosstabs, and totals.

Groups

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. Groups can be added in the iReport Wizard or after a report has been created.

Subreports

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

In 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. Crosstabs 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.

Note.jpg All field, variable, and parameter references in IMSMANG are case-sensitive
Standardising Data Analysis and Information Reporting
Use iReport
Currently there are no subpages here
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Use_iReport&oldid=24412"