Summarize iReport Template Data

From IMSMA Wiki
Revision as of 10:59, 8 July 2013 by Dionysia (talk | contribs)
Jump to: navigation, search

Editing Summarizing Report Data

Adding a Footer or Summary Section to the Report

Totals, averages, and other summary data are typically found at the end of a grouping or at the end of a report. You may add a section—or band as it is referred to in iReport—by doing the following:

  1. From the View menu, select Bands.
    2. The <FileName> bands… window displays.
  2. Do one of the following:
    • If you would like to add a footer at the end of a grouping, select the <GroupAttribute>Footer from the left pane where GroupAttribute is the name of the attribute on which the results will be grouped. For example, if you are creating a report on lands and group the results by the priority, the name of the band would be priorityFooter.
    • If you would like to add a summary section, select summary from the left pane.
  3. In the right pane, enter a numeric value in the Band Height field. The height of the section may also be adjusted later.
  4. Click the Apply button.
    5. The section is added to the report.

Displaying Counts

iReport has a built-in variable for calculating the number of records in a report and the number of records in each group if the report contains groups. The number of records in the report is stored in the REPORT_COUNT variable. The number of records in each group is stored in the <GroupField>_COUNT where GroupField is the name of the field on which the group is created.

To display one of the built-in count variables in the report:

  1. Expand the appropriate section to the report. If you would like to add the number of records in the report, you will need to expand the summary section of the report. If you would like to add the number of records for each group, you will need to expand the <GroupField>Footer section.
  2. From the View menu, select Variables.
    3. The REPORT_COUNT variable will always be available in the Variables list. The variable to display the count for the group will only be displayed if the report contains groups.
  3. To display the number of records in your report, drag the REPORT_COUNT variable to the summary section of the report.
Figure 22. REPORT_COUNT element in summary section

Figure 22. REPORT_COUNT element in summary section

Note.jpg If the REPORT_COUNT element is dragged to a section of the report other than the summary, the value returned by the REPORT_COUNT variable will be determined by where it is placed. For example, if the REPORT_COUNT is placed in the pageFooter section, the value returned will be the number of records displayed so far.
  1. To display the number of records in each group, drag the <GroupName>_COUNT variable to the <GroupName>Footer section.
Note.jpg It may be helpful to add a text label beside any counts that you add to report to identify the value. To add a text label, click the IRepText.png icon.

Displaying Totals

iReport allows you to display the total of a particular attribute in the report.

To display a total:

  1. Ensure that a group footer or summary section has been added to the report.
  2. From the Library pane, click File:IRepTotal.png.
Note.jpg If the Library pane is not displayed, display it by doing the following:
  1. From the View menu, select Docking Panes.
  2. From the Docking Panes menu, select Library.
  1. Drag the File:IRepTotal.png to the footer or summary section of the report. If you drag it to the footer, the total for the values in the group will be calculated. If you drag it to the summary, the total for all values will be calculated.
    2. A window displays to allow you to select the object to sum (Image:iRep23.png).
Figure 23. Window to select object to sum

Figure 23. Window to select object to sum

  1. Double-click Fields.
  2. Click the name of the attribute that you would like to sum.
  3. Click the OK button.

Creating Custom Variables

In addition to the built-in functions to calculate the number of records and the sum of a field, iReport also allows you to define a variable. A variable is a named object that stores the result of a calculation. iReport allows you to define new variables and how those variables should be calculated. For example, you may define a variable that calculates the average for a particular field such as the area size. Or, you may wish to display the maximum value of a field. In these situations, you may define a custom variable.

To create a custom variable:

  1. From the View menu, select Variables.
  2. Click the New button.
    3. The Add/modify variable window displays.
Figure 24. Add/modify variable window

Figure 24. Add/modify variable window

  1. In the Variable Name field, enter a name for the variable. You should provide a name that is meaningful and indicative of what the value returns.
  2. From the Variable Class Type list, select the data type of the resulting value. The variable class type will depend on the field that you are using in the calculation.
Note.jpg To determine the class type of a field:
  1. Right-click the field element in the report pane.
  2. Select Properties.
  3. Select the Text Field tab.
    4. The class type will be displayed in the Text Field Expression Class field.
  1. From the Calculation Type list, select the calculation that you would like to perform.
Table 4. Calculation types
Calculation type Description
None No type calculation performed.
Count Counts the number of non-null results.
Distinct count Counts the number of unique results.
Sum Adds the values together.
Average Averages the values together.
Lowest Returns the lowest value.
Highest Returns the highest value.
Standard deviation Returns the standard deviation of all values.
Variance Returns the variance of all values.
System No calculation is made. Instead the last value is stored.
  1. From the Reset Type list, select when a variable value should be reset to the initial value. For example, suppose you wanted to count the number of accidents in each location. Each time a new group—in this case a location—is encountered, the variable should be reset. To do this, you would need to reset the value of the variable after each group.
Table 5. Reset Types
Reset Type Description
None The initial value is always ignored.
Report The variable is initialised once at the beginning of the report using the Initial Expression value.
Page The variable is initialised at the top of each new page.
Column The variable is initialised in each new column.
Group The variable is initialised at each new group.
  1. If you select Group as the Reset Type, you will need to select the group on which you would like to reset the variable from the Reset Group list. The Reset Group list will contain all fields on which the report is grouped.
Figure 24. Add/modify variable window

Figure 25. Reset Type and Reset Group

Note.jpg If the field on which the variable should be reset is not listed in the Reset Group list, be sure that the field is included as one of the grouping levels for the report.
  1. From the Increment Type list, select the increment at which the value will need to be evaluated. It is useful when you want to calculate sub-totals.
  2. From the Increment Group list, select the group at which the variable will be incremented.
  3. The Variable Expression field specifies the expression that will be provided to the variable. Typically, this will be the value of a field in the report. To specify a field in the report:
    1. Click the File:IRepEditor.png button that is displayed beside the Variable Expression field.
      2. The Expression editor window displays.
    2. From the Objects and expressions tab, select Fields from the left pane.
    3. From the middle pane at the bottom of the Expression editor window, double-click the name of the field that you would like to use in the calculation.
    4. Click the Apply button.
      5. The Expression editor window closes. The Add/modify variable window displays the selected field in the Variable Expression field.
    5. Click the OK button.
      6. The Add/modify variable window closes and the variable that you just added is listed as a variable in the Library pane.
Note.jpg If the Library pane is not displayed, display it by doing the following:
  1. From the View menu, select Docking Panes.
  2. From the Docking Panes menu, select Library.
  1. From the Library pane, click the name of the variable that you created for the average.
  2. Drag the variable to the summary section of the report.

Charts

Charts provide a visual representation of the report data. Before you add a chart to your report, you should ensure that your report contains the following:

  • At least one grouping. The report groupings are used by iReport to determine what fields may be plotted.
  • At least one variable that contains a calculation. This calculation may be a count, total, or other custom calculation. These calculated variables define the size of the chart segment.

Pie Chart

Note.jpg The sample report Pie Chart Sample.jrxm lin the <iReport Installation Directory>\iReports_IMSMA\IMSMA reports directory provides an example of a report that includes a pie chart.

To add a pie chart to the report:

  1. Create a report which groups the results by the attribute on which you would like to base your chart.
  2. After creating the report, you should add a footer for the attribute on which the results will be grouped. This footer will be used to display the total for the group that will subsequently be used in the pie chart. To add a group footer:
    1. From the View menu, select Bands.
      2. The <FileName> bands… window displays.
    2. Select <GroupAttribute>Footer from the left pane where GroupAttribute is the name of the attribute on which the results will be grouped. For example, if you are creating a report on lands and group the results by the priority, the name of the band would be priorityFooter.
    3. In the right pane, enter a numeric value in the Band Height field. You may adjust the height of the summary.
    4. Click the Apply button.
  3. Add a summary section to the report.
  4. Click the File:IRepBarChart.png icon.
  5. In the summary section of the report, hold down the mouse button and drag the cursor to form the rectangle which will contain the chart.
    6. A window of the various chart options displays.
  6. Select one of the pie chart options.
Figure 26. Pie chart options

Figure 26. Pie chart options

  1. Click the OK button.
  2. Right-click anywhere on the chart.
  3. Select the Chart Properties option.
  4. From the Chart Properties window, select the Chart Data tab.
  5. From the Chart Data tab, select the Details tab.
  6. The Section Value tab should be selected by default. If it is not, select it.
  7. The Key Expression defines the various slices of the pie chart. This will typically be each unique value for an attribute. For example, if the chart were to contain the total area size of lands with a particular priority, the Key Expression would return the unique values for priority (e.g., Low, Medium, or High). To enter the key expression value:
    1. Click the File:IRepEditor.png icon that is displayed beside the Key Expression field.
      2. The Expression editor window displays.
    2. From the bottom pane, double-click the name of the attribute that contains the data that you would like to include in the chart.
      3. The expression to represent the attribute displays in the top pane.
    3. In order to account for null values, you will need to modify the expression so that null values are grouped into their own group. The expression should be modified to include the bolded text below. You should replace attribute with the name of the attribute that you selected in step b above.
      4. $F{attribute} != null ? $F{attribute} : "Unknown"
    4. Click the Apply button.
  8. The Value Expression field contains the expression that returns the numeric value for the key. For example, it may be the total land size of high priority lands.
    1. Click the File:IRepEditor.png icon that is displayed beside the Value Expression field.
      2. The Expression editor window displays.
    2. From the Objects and expressions tab, select Variables from the left pane.
    3. From the middle pane at the bottom of the Expression editor window, double-click the name of the variable that was created to store the total.
    4. Click the Apply button.
  9. The Label Expression field contains the expression that is used to determine the label for the segment of the pie chart. Because this expression will most likely be the same as the one used in the Key Expression, you can copy the expression from the Key Expression field and paste it into the Label Expression field.
  10. Figure 27 is an example of the Chart Properties window for a report that contains a pie chart which graphs the total area size of lands based on their priority.
Figure 27. Chart Properties

Figure 27. Chart Properties

  1. Click the Close button
    2. The Chart Properties window closes.
  2. Save the report by either clicking the icon, or by selecting the Save option from the File menu.

Below (Figure 28) is an example of a report template that totals the area size of lands by priority.

Figure 28. Sample report template with pie chart

Figure 28. Sample report template with pie chart

The resulting report pages are shown in Figure 29.

Figure 29. Sample report with pie chart

Figure 29. Sample report with pie chart

Bar Charts

Note.jpg The sample report Bar Chart Sample.jrxm lin the <iReport Installation Directory>\iReports_IMSMA\IMSMA reports directory provides an example of a report that includes a bar chart.

To add a bar chart to the report:

  1. Create a report which groups the results by the attribute on which you would like to base your chart.
  2. After creating the report, you should add a footer for the attribute on which the results will be grouped. This footer will be used to display the total for the group that will subsequently be used in the pie chart. To add a group footer:
    1. From the View menu, select Bands.
      2. The <FileName> bands… window displays.
    2. Select <GroupAttribute>Footer from the left pane where GroupAttribute is the name of the attribute on which the results will be grouped. For example, if you are creating a report on lands and group the results by the priority, the name of the band would be priorityFooter.
    3. In the right pane, enter a numeric value in the Band Height field. You may adjust the height of the summary
    4. Click the Apply button.
  3. Add a summary section to the report.
  4. Click the File:IRepBarChart.png icon.
  5. In the summary section of the report, hold down the mouse button and drag the cursor to form the rectangle which will contain the chart.
    6. A window of the various chart options displays.
  6. Select one of the bar chart options.
  7. Click the OK button.
  8. Right-click anywhere on the chart.
  9. Select the Chart Properties option.
  10. From the Chart Properties window, select the Chart Data tab.
  11. From the Chart Data tab, select the Details tab.
  12. Click the Add button.
    13. The Chart Properties window displays. By default, the Data tab should be selected.
  13. The Series Expression allows you to define an added level of detail to your bar chart. To enter the series expression value:
    1. Click the File:IRepEditor.png icon that is displayed beside the Key Expression field.
      2. The Expression editor window displays.
    2. From the bottom pane, double-click the name of the attribute that contains the data that you would like to include in the chart.
      3. The expression to represent the attribute displays in the top pane.
    3. In order to account for null values, you will need to modify the expression so that null values are grouped into their own group. The expression should be modified to include the bolded text below. You should replace attribute with the name of the attribute that you selected in step b above.

      4. $F{attribute} != null ? $F{attribute} : "Unknown"

    4. Click the Apply button.

    The expression that you enter in the Series Expression field will vary based on how you want the horizontal axis to appear:

    • If you would like the horizontal axis of the bar chart to reflect a single attribute such as the chart displayed in Figure 30, the Series Expression will be the same as the Category expression.
Figure 30. Bar chart –Single attribute y-axis

Figure 30. Bar chart –Single attribute y-axis

    • If you would like the horizontal axis of the bar chart to reflect the values of an additional attribute, the Series Expression would be the expression for the secondary level of detail. In the example shown in Figure 31, the x-axis reflects the land priorities (e.g., Low, Medium, or High). In addition to displaying the priority, the bars of the chart use a different colour to reflect those lands which block water access (red) vs. those that do not block the water (blue).
Figure 31. Bar chart with different series expression

Figure 31. Bar chart with different series expression

    The Chart Properties window for this bar chart is shown below (Figure 32). Notice that the series expression and category expression differ.
Figure 32. Chart Properties – Different series and category expressions

Figure 32. Chart Properties – Different series and category expressions

    • If you selected one of the stacked bar chart options, the series expression will be used to determine the segments of each bar. In Figure 33, the series expression creates red and blue segments in each bar to indicate whether or not water access is blocked.
Figure 33. Stacked bar chart

Figure 33. Stacked bar chart

  1. The Category Expression is the major grouping of the horizontal axis. To enter the category expression:
    1. Click the File:IRepEditor.png icon that is displayed beside the Category expression field.
      2. The Expression editor window displays.
    2. From the bottom pane, double-click the name of the attribute that contains the data that you would like to include in the chart.
      3. The expression to represent the attribute displays in the top pane.
    3. In order to account for null values, you will need to modify the expression so that null values are grouped into their own group. The expression should be modified to include the bolded text below. You should replace attribute with the name of the attribute that you selected in step b above.

      4. $F{attribute} != null ? $F{attribute} : "Unknown"

    4. Click the Apply button.
  2. The Value Expression field contains the expression that returns the numeric value for the key.
    1. Click the File:IRepEditor.png icon that is displayed beside the Value Expression field.
      2. The Expression editor window displays.
    2. From the Objects and expressions tab, select Variables from the left pane.
    3. From the middle pane at the bottom of the Expression editor window, double-click the name of the variable that was created to store the total.
    4. Click the Apply button.
  3. Click the OK button.
    4. The Chart Properties window closes.
  4. Click the Close button.
    5. The Chart Properties window closes.
  5. Save the report by either clicking the File:IRepSave.png icon, or by selecting the Save option from the File menu.

Grouped Bar Chart

The horizontal axis of the bar charts discussed in the previous section compared the values of a single variable. For example, the bar chart below compares the number of different activity types.

Figure 34. Bar chart comparing values of a single variable

Figure 34. Bar chart comparing values of a single variable

In this section, you will learn how to create a grouped bar chart. A grouped bar chart compares the values of a single variable in one group to the same variables in another group. In the example below, the grouped bar chart still compares the number of activity types. However, the chart also compares the number of activity types between the districts. The number of activity types (clearance, impact survey, technical survey, and road clearance) are represented by the different bar colours as indicated in the legend. The coloured bars are clustered together based on their district. The first cluster of bars shows the number of activity in the Bolikon district. The second cluster of bars shows the number of activities in the Waltern district.

Figure 35. Grouped bar chart comparing values of a single variable

Figure 35. Grouped bar chart comparing values of a single variable

The two main differences between adding a bar chart and a grouped bar chart are:

  • The grouped bar chart requires that you specify at least two groupings for the report.
  • The key expression and the category expression will differ; whereas, for a bar chart, the value for these expressions is the same.

To add a grouped bar chart to the report:

  1. Create a report which groups the results by the fields that will be represented on the horizontal axis of the chart.
Note.jpg For a grouped bar chart, you will need to specify at least two groupings.
  1. Add any variables that you may need to calculate the value that you would like to show on the chart.
  2. If you would like to display the calculated variable for each group, you should add the footer for the field on which the results will be grouped. This footer will be used to display the variable for the group that will subsequently be used in the chart. To add a group footer:
    1. From the View menu, select Bands.
      2. The <FileName> bands… window displays.
    2. Select <GroupFieldName>Footer from the left pane where GroupFieldNameis the name of the field on which the results will be grouped. For example, if you are creating a report on lands and group the results by the priority, the name of the band would be priorityFooter.
    3. In the right pane, enter a numeric value in the Band Height field. You may adjust the height of the summary.
    4. Click the Apply button.
    5. Add a summary section to the report.
  3. Click the File:IRepBarChart.png icon.
  4. In the summary section of the report, hold down the mouse button and drag the cursor to form the rectangle which will contain the chart.
    5. A window of the various chart options displays.
  5. Select one of the bar chart options.
Figure 36. Bar chart options

Figure 36. Bar chart options

  1. Click the OK button.
  2. Right-click anywhere on the chart.
  3. select the Chart Properties option.
  4. From the Chart Properties window, select the Chart Data tab.
  5. From the Chart Data tab, select the Details tab.
  6. Click the Add button.
    7. The Chart Properties window displays. By default, the Data tab should be selected.
  7. For a grouped bar chart, the series expression contains the field whose distinct values you would like to show via different colours on the bar chart.
Figure 37. Bar chart series expression

Figure 37. Bar chart series expression

To enter the series expression:

    1. Click the File:IRepEditor.png icon that is displayed beside the Key Expression field.
      2. The Expression editor window displays.
    2. From the bottom pane, double-click the name of the field that contains the data that you would like to include in the chart.
      3. The expression to represent the field displays in the top pane.
    3. Click the Apply button.
  1. The Category Expression is the field by which the series expression is grouped together.
Figure 38. Bar chart category expression

Figure 38. Bar chart category expression

To enter the category expression:

    1. Click the File:IRepEditor.png icon that is displayed beside the Category expression field.
      2. The Expression editor window displays.
    2. From the bottom pane, double-click the name of the field that contains the data that you would like to include in the chart.
      3. The expression to represent the field displays in the top pane.
    3. Click the Apply button.
  1. The Value Expression field contains the variable that returns the numeric value that will be represented on the chart.
    1. Click the File:IRepEditor.png icon that is displayed beside the Value Expression field.
      2. The Expression editor window displays.
    2. From the Objects and expressions tab, select Variables from the left pane.
    3. From the middle pane at the bottom of the Expression editor window, double-click the name of the variable that you would like to represent on the chart.
    4. Click the Apply button.
  2. Click the OK button.
    3. The Chart Properties window closes.
  3. Click the Close button.
    4. The Chart Properties window closes.
  4. Save the report by either clicking the File:IRepSave.png icon, or by selecting the Save option from the File menu.
Note.jpg iReport requires you to save the report after adding or changing a chart.
  1. Click the File:IRepCompile.png button to compile the report.
  2. Click the File:IRepRun.png button to execute the report.

Stacked Bar Chart

A stacked bar chart is similar to a grouped bar in that it allows you to represent two different fields on the chart. The key difference is that the stacked bar chart layers the values of the series expression (the field represented in the legend) allowing you to easily compare the categories to one another.

Figure 39. Stacked bar chart

Figure 39. Stacked bar chart

To add a grouped bar chart to the report:

  1. Create a report which groups the results by the fields that will be represented on the horizontal axis of the chart.
Note.jpg For a stacked bar chart, you will need to specify at least two groupings.
  1. Add any variables that you may need to calculate the value that you would like to show on the chart.
  2. If you would like to display the calculated variable for each group, you should add the footer for the field on which the results will be grouped. This footer will be used to display the variable for the group that will subsequently be used in the chart. To add a group footer:
    1. From the View menu, select Bands.
      2. The <FileName> bands… window displays.
    2. Select <GroupFieldName>Footer from the left pane where GroupFieldName is the name of the field on which the results will be grouped. For example, if you are creating a report on lands and group the results by the priority, the name of the band would be priorityFooter.
    3. In the right pane, enter a numeric value in the Band Height field. You may adjust the height of the summary
    4. Click the Apply button.
  3. Add a summary section to the report.
  4. Click the File:IRepBarChart.png icon.
  5. In the summary section of the report, hold down the mouse button and drag the cursor to form the rectangle which will contain the chart.
    6. A window of the various chart options displays.
  6. Select one of the stacked bar chart options.
Figure 40. Stacked bar chart options

Figure 40. Stacked bar chart options

  1. Click the OK button.
  2. Right-click anywhere on the chart.
  3. Select the Chart Properties option.
  4. From the Chart Properties window, select the Chart Data tab.
  5. From the Chart Data tab, select the Details tab.</li.
  6. Click the Add button.
    7. The Chart Properties window displays. By default, the Data tab should be selected.
  7. For a stacked bar chart, the series expression contains the fields whose distinct value.
  8. For a grouped bar chart, the series expression contains the field whose distinct values you would like to show via different colours on the bar chart. To enter the series expression:
    1. Click the File:IRepEditor.png icon that is displayed beside the Key Expression field.
      The Expression editor window displays.
    2. From the bottom pane, double-click the name of the field that contains the data that you would like to include in the chart.
      3. The expression to represent the field displays in the top pane.
    3. Click the Apply button.
  9. The Category Expression is the field by which the series expression is grouped together. To enter the category expression:
    1. Click the File:IRepEditor.png icon that is displayed beside the Category expression field.</vli>
      The Expression editor window displays.
    2. From the bottom pane, double-click the name of the field that contains the data that you would like to include in the chart.

      3. The expression to represent the field displays in the top pane.

    3. Click the Apply button.
  10. The Value Expression field contains the variable that returns the numeric value that will be represented on the chart.
    1. Click the File:IRepEditor.png icon that is displayed beside the Value Expression field.
      2. The Expression editor window displays.
    2. From the Objects and expressions tab, select Variables from the left pane.
    3. From the middle pane at the bottom of the Expression editor window, double-click the name of the variable that you would like to represent on the chart.
    4. Click the Apply button.
  11. Click the OK button.
    12. The Chart Properties window closes.
  12. Click the Close button.
    13. The Chart Properties window closes.
  13. Save the report by either clicking the File:IRepSave.png icon, or by selecting the Save option from the File menu.
  14. Click the File:IRepCompile.png button to compile the report.
  15. Click the File:IRepRun.png button to execute the report.

Template:NavBox HowTo use iReport

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