Difference between revisions of "Create a Basic iReport Template"

From IMSMA Wiki
Jump to: navigation, search
Line 50: Line 50:
 
<div align="center">
 
<div align="center">
 
''Figure 3. iReport Wizard - Step 4''
 
''Figure 3. iReport Wizard - Step 4''
−
</div>
+
 
  
  
Line 68: Line 68:
 
| align="center" | [[Image:iRepDLA.png]] || Indicates all fields from the report.
 
| align="center" | [[Image:iRepDLA.png]] || Indicates all fields from the report.
 
|}
 
|}
−
</center>
+
</div>
  
−
{{note|If you would like to organise the report results by country structure areas, you should include the country structure level by which you would like to group the results as one of the fields. Be aware that including the country structure level field in the report will return a string that contains all country structure levels above the selected level.}}
+
{{note|It is recommended to always include the ''guid'' field when designing a report}}
  
 
<ol start="5">
 
<ol start="5">
 
<ol type="a" start="2">
 
<ol type="a" start="2">
−
<li>Click the '''Next''' button.</li>
+
<li>Click the '''Next''':
−
:A window displays the selected fields.
+
The window to group the report data displays. The [[Modify an iReport Template#Grouping and Sorting|group by]] step allows you to list item records that have the same value for the selected group by field together in the report. The below figure illustrates an example of a report that groups its results by gazetteer. For more information on grouping, refer to Grouping.
−
</ol>
 
−
 
 
−
<li>Click the '''Next''' button.</li>
 
−
The window to group the report data displays. The group by step allows you to list item records that have the same value for the selected group by field together in the report. The below figure illustrates an example of a report that groups its results by gazetteer. For more information on grouping, refer to Grouping.
 
 
</ol>
 
</ol>
  

Revision as of 18:55, 16 September 2013

How To

Creating a Basic Report Using the Wizard

IMSMANG provides an iReport Wizard to help in the process of creating new iReport templates.

To create a report:

  1. From the File menu, select New....
    2. The iReport Wizard window displays.
  2. From the Report Templates list, select the template you would like to use for your report. Blank A4 or an IMSMA specific template are preferrable
Figure 1. iReport Wizard – Step 1

Figure 1. iReport Wizard – Step 1

  1. Click the Launch Report Wizard button.
    2. The window to name the report and file location displays.
Figure 2. iReport Wizard - Step 2

Figure 2. iReport Wizard - Step 2

  1. Select the desired Data Source for the report and choose Next
Figure 2. iReport Wizard - Step 3

Figure 3. iReport Wizard - Step 3

  1. Select the desired data fields for the report and choose Next
Figure 2. iReport Wizard - Step 4

Figure 3. iReport Wizard - Step 4


Table 2. iReport Wizard – Buttons for selecting fields
Button Description
IRepRA.png Includes the selected field in the report.
IRepDRA.png Includes data for all fields in the report.
IRepLA.png Removes the selected field from the report.
IRepDLA.png Indicates all fields from the report.
Note.jpg It is recommended to always include the guid field when designing a report
    1. Click the Next: The window to group the report data displays. The group by step allows you to list item records that have the same value for the selected group by field together in the report. The below figure illustrates an example of a report that groups its results by gazetteer. For more information on grouping, refer to Grouping.
    Figure 3. Group by example
    1. If you would like to group the report data, select the attribute on which you would like to group the data from the Group list.
    Note.jpg If you choose to group the report data, you may also want to sort the data using the attribute. For more information on sorting, refer to Sorting.
    1. Click the Next button.

      2. The window to select a layout displays. The iReport wizard provides two layout options. The Columnar layout option displays the field names in one column and their corresponding report result in another column.

    Figure 4. Columnar layout

    Figure 4. Columnar layout

    The tabular layout option displays the field names across the top of the page. The corresponding report results are displayed below each field name.

    Figure 5. Tabular layout

    Figure 5. Tabular layout

    1. From the window to select a layout:
      1. Select the layout option.
      2. Click the Next button.
        3. The window displays a message stating that you have successfully created a new report.
    2. Click the Finish button.
      3. The template for your report displays.
    3. Ensure that the data source selected matches the item of the report.
    Figure 6. Report data source

    Figure 6. Report data source

    1. Click the File:IRepCompile.png button to compile the report.
      2. The Save report window displays.
    2. Enter a name for the report in the File name field.
    3. If there are no compilation errors, click the File:IRepRun.png button to run the report.
      4. The results of the report display in the iReport JasperViewer window.

    Grouping

    Grouping allows you to organise the report results using the values of a particular field. Grouping results makes it easier to identify the records which share a common value. Rather than having to visually scan the report results to determine which records have a common value, grouping automatically organises the results for you.

    To illustrate, suppose you wanted to create a report to list all land within each location ID. The procedures that have been discussed so far in this training module would simply list all land along with their location ID. Although the location ID is included in the report, it would be difficult, tedious, and time-consuming to scan the entire report to identify those land that have a common location ID.

    Figure 7. Land report with no grouping

    Figure 7. Land report with no grouping

    Grouping report results automatically organises the records using the values on the specified field. Using the example above, the land in the report shown in Figure 8 are organised within the location to which they are associated. Records that do not contain a value for the selected grouping are put into their own group.

    Land grouped by location

    Land grouped by location

    Modify an iReport Template

    Template:NavBox HowTo use iReport
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Create_a_Basic_iReport_Template&oldid=10823"