Difference between revisions of "Summarize iReport Template Data"

Revision as of 16:10, 20 September 2013

Summarizing Report Data

In addition to displaying report details in an iReport template, the iReport Designer allows you create summaries or calculations of data returned in the report. These can take the form of totals, sums, and counts (stored in Variables), or more complicated data summaries such as Crosstabs or Charts. Because summarizing data necessarily depends on multiple records, data summaries must exist in bands after the Detail band such as the Summary band, Footer bad, or Group Footer bands.

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. If a desired band is not visible on the iReport Designer canvas:

1. Select the desired band in the Report Inspector
2. In the Properties pane, change the Band Height property to something more than 0 (e.g. 50).

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 Report Inspector, select Variables.

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.

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.

4. To display the number of records in each group, drag the <GroupName>_COUNT variable to the <GroupName>Footer section.

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, drag the text field element from the Palette pane.

Displaying Totals

iReport allows you to display the total of a particular attribute in the report. This is done by creating a variable to store the total value (see Adding a Variable to an iReport).

To display a total:

1. Ensure that a group footer or summary section has been added to the report.
2. From the Report Inspector pane, choose Variables and drag the variable to the summary section. 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.

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 other types of variable calculations. 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. Follow the steps to add a variable to an iReport
2. From the Calculation Type list in the Properties pane, select the calculation that you would like to perform.

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

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

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.

5. 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 edit the Variable Expression field.
   
   Variable Expression Editor

In addition to the summary functions available on the variable, specific expressions can be used in the Expression Editor to define values. For example:

Crosstabs

In addition to summary variables, iReport provides the capability to build crosstab tables that display data in a grid for easy analysis and summary. Crosstabs allow you to choose data rows, columns, and the variable to measured and then automatically produce a grid of results for display in a chart. As with other summary variables Crosstabs are generally used in the Summary Band in a report.

To create a Crosstab:

1. In the Palette pane, drag a Crosstab item to the Summary Band of the report.
2. The Crosstab wizard displays

   

   Crosstab wizard

3. Select the Field to use in the Row of the Crosstab grid.

   

   Crosstab wizard

4. Select the Field to use in the Column of the Crosstab grid.

   

   Crosstab wizard

5. Select the Field or Variable to use to represent the data in the grid. Typically this is a numeric field (e.g. areaSize) or if a count of the records is desired, the REPORT_COUNT variable.

   

   Crosstab wizard

6. Finalize the Crosstab display.

   

   Crosstab wizard

7. The Crosstab displays.

   

   Crosstab wizard

The report can now be run or additional adjustments to the report can be made including resizing columns and rows, number formatting, or display adjustments.

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:

1. At least one grouping. The report groupings are used by iReport to determine what fields may be plotted. See Modify an iReport Template for more information on grouping.
2. 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. The Reset type of this calculation should be set to Group and use the report grouping defined in #1. See Modify an iReport Template for more information on adding variables.

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 (e.g. status)
2. Ensure that the Summary Band is available on the iReport template canvas.
3. Create a Variable to contain the values to be displayed in the chart (e.g. SUM_areaSize_byStatus). This variable should be based on a numeric field (e.g. areaSize) and should have the Reset type set to Group and the group selected set to the field you wish to create the chart from (e.g. status).
4. Select the Chart option from the Palette pane and drag it to the Summary Band of the report template to start the Chart Wizard.
5. Select one of the pie chart options.

   

   Chart options

6. Choose Main report dataset.

   

   Chart options

7. The next step is to provide the correct data for the chart to use. Pie Charts require a unique identifier and a numeric value where the unique identifier is the field to group the data by (i.e. the names of the wedges) and numeric value is the value to sum.

   

   Chart options

8. To select the unique value choose the Expression editor button and choose the field the report is grouped by (e.g. status). Note that charts in iReport will fail if the unique value is null. 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.

   $F{status} == null ? "N/A" : $F{status}

   

   Set Unique Value

9. Next, select the numeric value that contains the desired numeric data for the chart. Note: This should always be the variable created in step 3 above (e.g. SUM_status_byAreaSize).

   

   Select the desired numeric variable

10. Choose Next.

    

    Select the desired numeric variable

11. Choose Finish.

    

    Select the desired numeric variable

</ol>

17. Click the Close button

The Chart Properties window closes.

18. Save the report by either clicking the icon, or by selecting the Save option from the File menu.

Below is an example of a report template that totals the area size of land by priority.

The resulting report pages are shown below.

Bar Charts

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.

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

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.

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.

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.

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.

$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 below, the Series Expression will be the same as the Category expression.

• 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 below, 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 land which block water access (red) vs. those that do not block the water (blue).

The Chart Properties window for this bar chart is shown below. Notice that the series expression and category expression differ.

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

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

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.

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.

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

4. Click the Apply button.
15. 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.

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.
16. Click the OK button.

The Chart Properties window closes.

17. Click the Close button.

The Chart Properties window closes.

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

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.

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.

For a grouped bar chart, you will need to specify at least two groupings.

2. Add any variables that you may need to calculate the value that you would like to show on the chart.
3. 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.

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

A window of the various chart options displays.

6. Select one of the bar chart options.

8. Click the OK button.
9. Right-click anywhere on the chart.
10. select the Chart Properties option.
11. From the Chart Properties window, select the Chart Data tab.
12. From the Chart Data tab, select the Details tab.
13. Click the Add button.

The Chart Properties window displays. By default, the Data tab should be selected.

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

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

3. Click the Apply button.
15. 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.

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.

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

3. Click the Apply button.
16. 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.

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.
17. Click the OK button.

The Chart Properties window closes.

18. Click the Close button.

The Chart Properties window closes.

19. Save the report by either clicking the File:IRepSave.png icon, or by selecting the Save option from the File menu.

iReport requires you to save the report after adding or changing a chart.

20. Click the File:IRepCompile.png button to compile the report.
21. 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.

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.

For a stacked bar chart, you will need to specify at least two groupings.

2. Add any variables that you may need to calculate the value that you would like to show on the chart.
3. 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.

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 land 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.
4. Add a summary section to the report.
5. Click the File:IRepBarChart.png icon.
6. 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.

A window of the various chart options displays.

7. Select one of the stacked bar chart options.

8. Click the OK button.
9. Right-click anywhere on the chart.
10. Select the Chart Properties option.
11. From the Chart Properties window, select the Chart Data tab.
12. From the Chart Data tab, select the Details tab.</li.
13. Click the Add button.

The Chart Properties window displays. By default, the Data tab should be selected.

14. For a stacked bar chart, the series expression contains the fields whose distinct value.
15. 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.

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

3. Click the Apply button.
16. 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.

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

3. Click the Apply button.
17. 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.

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.
18. Click the OK button.

The Chart Properties window closes.

19. Click the Close button.

The Chart Properties window closes.

20. Save the report by either clicking the File:IRepSave.png icon, or by selecting the Save option from the File menu.
21. Click the File:IRepCompile.png button to compile the report.
22. Click the File:IRepRun.png button to execute the report.

Template:NavBox HowTo use iReport