Difference between revisions of "Create a Basic iReport Template"

From IMSMA Wiki
Jump to: navigation, search
Line 1: Line 1:
 
==Report Basics==
 
==Report Basics==
−
===Creating a Basic Report===
+
===Creating a Basic Report===__NOEDITSECTION__
 
Basic reports are reports that are generated against a single type of item. You may create a report of the following items:
 
Basic reports are reports that are generated against a single type of item. You may create a report of the following items:
 
*Accident
 
*Accident
Line 126: Line 126:
 
</ol>
 
</ol>
  
−
===Grouping===
+
===Grouping===__NOEDITSECTION__
 
<p>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.</p>
 
<p>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.</p>
 
<p>To illustrate, suppose you wanted to create a report to list all lands within each location ID. The procedures that have been discussed so far in this training module would simply list all lands 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 lands that have a common location ID ([[:Image:iRep07.png|'''Figure 7''']]).</p>
 
<p>To illustrate, suppose you wanted to create a report to list all lands within each location ID. The procedures that have been discussed so far in this training module would simply list all lands 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 lands that have a common location ID ([[:Image:iRep07.png|'''Figure 7''']]).</p>
Line 142: Line 142:
 
</div>
 
</div>
  
−
====Adding a Group to an Existing Report====
+
====Adding a Group to an Existing Report====__NOEDITSECTION__
  
 
{{note|The field on which you would like to group your report results must be included in the report.}}
 
{{note|The field on which you would like to group your report results must be included in the report.}}
Line 167: Line 167:
 
{{note|You may also enter the expression in the Group Expression field if you know the exact spelling of the field name on which you would like to group the results. The syntax is $F{''FieldName''}.}}
 
{{note|You may also enter the expression in the Group Expression field if you know the exact spelling of the field name on which you would like to group the results. The syntax is $F{''FieldName''}.}}
  
−
===Adding Fields===
+
===Adding Fields===__NOEDITSECTION__
 
<p>If you need to include a field that was not selected while using the Report Wizard, you will need to know the name of the field that is used by the data source. Find a list of available field names by using the Report Wizard.</p>  
 
<p>If you need to include a field that was not selected while using the Report Wizard, you will need to know the name of the field that is used by the data source. Find a list of available field names by using the Report Wizard.</p>  
 
<p>To add a field to your report:</p>
 
<p>To add a field to your report:</p>
Line 189: Line 189:
 
</ol>
 
</ol>
  
−
===Sorting Report Results===
+
===Sorting Report Results===__NOEDITSECTION__
 
It may be helpful to sort the report results using the value in one or more of the fields. Sorting the results makes it easier to review the results and locate any records that you may be searching for.  
 
It may be helpful to sort the report results using the value in one or more of the fields. Sorting the results makes it easier to review the results and locate any records that you may be searching for.  
 
To sort report results:
 
To sort report results:

Revision as of 11:23, 8 July 2013

Report Basics

Creating a Basic Report

Basic reports are reports that are generated against a single type of item. You may create a report of the following items:

  • Accident
  • Data Entry Form
  • Land
  • Activity
  • Location
  • Education
  • Organisation
  • Place
  • QM
  • Victim
  • Task
  • Work Item
Note.jpg The sample report Summary_Location .jrxml in the <iReport Installation Directory>\iReports_IMSMA\IMSMA reports directory provides an example of a basic report.

To create a report:

  1. From the File menu, select Report Wizard.
    2. The iReport Wizard window displays.
  2. From the Connection/Data Sources list, select the item for which you would like to create a report.
Figure 1. iReport Wizard – Step 1

Figure 1. iReport Wizard – Step 1

  1. Click the Next button.
    2. The window to select the attributes to include in the report displays.
Figure 2. iReport Wizard - Step 2

Figure 2. iReport Wizard - Step 2

  1. From the Step 2. select fields screen:
    1. Select the attributes that you would like to include in the report. Error! Reference source not found. describes the available buttons.
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 a tip for using IMSMA.
Note.jpg 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.
    1. Click the Next button.
      2. A window displays the selected fields.
  1. Click the Next button.

    2. 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. Figure 3 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 lands within each location ID. The procedures that have been discussed so far in this training module would simply list all lands 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 lands that have a common location ID (Figure 7).

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 lands 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.

Figure 8. Lands grouped by location

Figure 8. Lands grouped by location

Adding a Group to an Existing Report

Note.jpg The field on which you would like to group your report results must be included in the report.

To add a group to an existing report:

  1. From the View menu, select Report Groups.
  2. A window displays the groups for the report.
  3. Click the New button.
    4. The Add/modify group window displays.
  4. Enter an identifier for the group. This should be a meaningful name that allows you to easily identify the contents of the group such as the field on which the results are grouped.
  5. Click the File:IRepExpress.png icon.
    6. The Expression editor window displays.
  6. Ensure that the Objects and expressions tab is selected.
  7. Click Fields.
  8. Double-click the name of the field on which you would like to add a grouping.
    9. The Expression editor window shows $F{FieldName} where FieldName is the name of the field that you selected previously.
  9. Click the Apply button.
    10. The Add/modify group window displays the expression in the Group Expression field.
  10. Click the OK button.
    11. The Add/modify group window closes.
Note.jpg You may also enter the expression in the Group Expression field if you know the exact spelling of the field name on which you would like to group the results. The syntax is $F{FieldName}.

Adding Fields

If you need to include a field that was not selected while using the Report Wizard, you will need to know the name of the field that is used by the data source. Find a list of available field names by using the Report Wizard.

To add a field to your report:

  1. From the View menu, select the Fields option.
    2. A window displays three tabs (Fields, Variables, and Parameters).
  2. From the Fields tab, click the New button.
    3. The Add/modify field window displays.
  3. In the Field Name field, enter the name of the field that you would like to include.
  4. Click the OK button.
    5. The field is included on the Fields tab.
  5. Close the window that displays the Fields, Variables, and Parameters tabs.
  6. Reposition the fields on your report as needed to accommodate the new field.
  7. Click the File:IRepF.png icon.
  8. Click the detail section of the report.
  9. While holding down the mouse button, drag the cursor to form the rectangle which will contain the new field.
  10. Release the mouse button.
    11. A placeholder for the field is displayed in the design section of the report.
  11. Double-click the placeholder that was added for the field.
  12. Change the placeholder text so that the field that you added is between the brackets.

Sorting Report Results

It may be helpful to sort the report results using the value in one or more of the fields. Sorting the results makes it easier to review the results and locate any records that you may be searching for. To sort report results:

  1. Create the report.
  2. From the Data menu, select the Report Query option.
    3. The Report query window displays.
  3. Click the Sort options button that is located at the bottom of the Report query window.
    4. The Sorting Options window displays.
  4. Click the Add Field button.
    5. The Sort Field window displays. The Sort by list displays all the fields that you have selected for the report.
  5. From the Sort by list, select the field by which you would like to sort the report results.
Note.jpg When sorting data in reports that contain groups, ensure the “Group by” fields appear first in the sort order.
  1. From the Sort Type list, select either the Ascending or Descending sort order.
  2. Click the OK button.
    3. The selected field displays in the Sorting Options window.
  3. Repeat steps 4-7 for each field on which you would like to sort the results.
  4. After you have completed adding the fields on which you would like to sort the results, click the Close button.
    5. The Sorting Options window closes.
  5. From the Report query window, click the OK button.
    6. The Report query window closes.

You will need to compile and execute the report for the sort options to take effect.


Template:NavBox HowTo use iReport

Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Create_a_Basic_iReport_Template&oldid=9681"