Difference between revisions of "Modify an iReport Template"

From IMSMA Wiki
Jump to: navigation, search
(→‎Adding a Parameter to an iReport Template)
(→‎Adding a Variable to an iReport Template)
Line 48: Line 48:
  
 
===Adding a Variable to an iReport Template===
 
===Adding a Variable to an iReport Template===
−
Two ways to do it.  
+
Often it is necessary to add a variable to an iReport template. Variables are used to store calculations and totals in an iReport template. They are often used in the Summary Band portion of a report to store sums of numeric fields (e.g. areaSize) or record counts. There are two main ways to add variables to an iReport template.
−
# Add a variable manually
+
 
−
# Drag to Summary Band
+
For numeric variables:
 +
For variables that are numeric (area sizes, number of devices, etc):
 +
# From the '''Report Inspector''', Select the field that you wish to sum or count.
 +
# Drag the field to the Summary Band of the iReport Template canvas
 +
# A dialogue will pop up, select '''The result of an aggregation function''' and choose the calculation type you want to perform.
 +
#: [[Image:IReport VariableAdd1.png|center|300px|''Select aggregation function'']]<div align="center">''Choose the type of calculation''</div>
 +
# Choose '''OK'''
 +
# The variable will now appear in the '''Report Inspector''' and can be used in the iReport.
 +
#: [[Image:IReport VariableAdd2.png|center|300px|''Select aggregation function'']]<div align="center">''Choose the type of calculation''</div>
  
 
Adding a variable manually:
 
Adding a variable manually:
−
# Right click -> Add Variable
+
# From the '''Report Inspector''' right click -> Add Variable
 +
#: [[Image:IReport VariableAdd3.png|center|300px|''Select aggregation function'']]<div align="center">''Choose the type of calculation''</div>
 +
#
  
 
==Report Query Filtering==
 
==Report Query Filtering==

Revision as of 14:42, 17 September 2013

How To

Overview

Once an iReport template has been created, there are many options for modifying the report template including adding new fields, creating variables, filtering the query results and many other options. This section covers the main customizations performed on iReport templates for use in IMSMANG

Fields, Variables, and Parameters

Adding a Field to an iReport Template

If you need to include a field that was not selected while using the Report Wizard, there are several options for including additional fields. The definition of a field

Option 1

Using the Report Query dialogue, you can select the option to Get Fields from Datasource Provider, which will automatically add all fields from the selected datasource to the report template. You can then remove any unwanted fields from the report

Warning.jpg Make sure that the datasource selected in iReports corresponds to the data source for the report
To add fields from the Report Query dialogue:
  1. Choose the Report Query button
    Report Query Button
    iReport Report Query Button
  2. From the Report Query Window, choose the Datasource Provider tab.
    Report Query Window
    Report Query Window
  3. Select the Get Fields From Datasource button.
    Datasource Fields
    Datasource Fields
  4. All fields will now be displayed. Unnecessary fields can be removed at this time.
  5. Choose Ok to save the fields and return to the iReport Designer.

Option 2

Alternatively, you can create a new report template using the Wizard and add the desired fields to the new report. Fields can then be copied and pasted from the new report to the original report.

  1. Create a new report using the iReport Wizard and the same data source
  2. Select the desired fields and finish the report
  3. Using the Report Inspector, navigate to the desired fields
  4. Right click on the field and select copy.
    Field Copy
    Field Copy
  5. Navigate to the original report with the missing fields
  6. Right-click on the fields tree in Report Inspector and choose paste.
Note.jpg It is not recommended to the use the "Add Field" option from the Report Inspector due to the complexity of adding the correct field attributes and properties.

Adding a Parameter to an iReport Template

It is sometimes necessary to add a parameter to an iReport template. Usually parameters are used for transferring data from a main report to a subreport. Below are the steps to add a parameter to an an iReport Template.

  1. From the Report Inspector, right click on the Parameter tree and choose Add Parameter.
    Add Parameter
  2. In the Properties pane, enter a parameter name (e.g. ItemGUID} and edit any other properties. Normally it is not required to edit anything other than the name.
    Add Parameter

Adding a Variable to an iReport Template

Often it is necessary to add a variable to an iReport template. Variables are used to store calculations and totals in an iReport template. They are often used in the Summary Band portion of a report to store sums of numeric fields (e.g. areaSize) or record counts. There are two main ways to add variables to an iReport template.

For numeric variables: For variables that are numeric (area sizes, number of devices, etc):

  1. From the Report Inspector, Select the field that you wish to sum or count.
  2. Drag the field to the Summary Band of the iReport Template canvas
  3. A dialogue will pop up, select The result of an aggregation function and choose the calculation type you want to perform.
    Select aggregation function
    Choose the type of calculation
  4. Choose OK
  5. The variable will now appear in the Report Inspector and can be used in the iReport.
    Select aggregation function
    Choose the type of calculation

Adding a variable manually:

  1. From the Report Inspector right click -> Add Variable
    Select aggregation function
    Choose the type of calculation

Report Query Filtering

Filtering results/Query Limitation

the SQL Field

Editing the SQL Field

Sorting and Grouping

Grouping

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

To illustrate, suppose you wanted to create a report to list all land within each location ID. An ungrouped report 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

Adding a Group to an iReport Template

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

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.

Working with Images=

Adding an Image to an iReport Template

????

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