Changes

<ol>==Summarising Report Data==__NOEDITSECTION__<li>From In addition to displaying report details in an iReport template, the iReport Designer allows creating 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'View''' menuthe Detail band such as the Summary band, Footer band, select '''Bands'''or Group Footer bands.</li>:The <FileName> bands… window displays. <li>Do one of ===Adding a Footer or Summary Section to the following:</li>Report===__NOEDITSECTION__*If you would like to add a footer Totals, averages, and other summary data are typically found at the end of a grouping, select or at the <''GroupAttribute''>Footer from the left pane where ''GroupAttribute'' is the name end of the attribute on which the results will be groupeda report. For example, if you are creating If a report desired band is not visible on hazards and group the results by iReport Designer canvas:# Select the priority, desired band in the name of the band would be priorityFooter.*If you would like to add a summary section, select ''summary'Report Inspector''' from the left pane. <li># In the right pane, enter a numeric value in the '''Band HeightProperties''' field. The height of the section may also be adjusted later.</li><li>Click pane, change the '''ApplyBand Height''' buttonproperty to something more than 0 (e.g.</li>:The section is added to the report50). </ol>

===Displaying Counts===__NOEDITSECTION__

<li>From the '''ViewReport Inspector''' menu, select '''Variables'''.</li>

[[Image:iRep22.png|center|500px|''Figure 22. REPORT_COUNT element in summary section'']]

''Figure 22. REPORT_COUNT element in summary section''

{| class="wikitable"|-| [[File:Note.jpg | 40px]] |{note| 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. |}}

<olstart="4">

{| class="wikitable"|-| [[File:Note.jpg | 40px]] |{note| It may be helpful to add a text label beside any counts that you add to the report to identify the value. To add a text label, click drag the static text element [[Image:iRepText.png]] iconfrom the '''Palette''' pane. |}}

===Displaying Totals===__NOEDITSECTION__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 [[Modify an iReport Template#Adding a Variable to an iReport Template| Adding a Variable to an iReport]]).

<li>From the Library pane, click [[Image:iRepTotal.png]].</li></ol> {| class="wikitable"|-| [[File:Note.jpg | 40px]] || If the Library pane is not displayed, display it by doing the following:<ol><li>From the '''ViewReport Inspector''' menupane, select choose '''Docking PanesVariables'''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.</li><li>From If you drag it to the '''Docking Panes''' menusummary, select '''Library'''the total for all values will be calculated.</li>

<ol start="3"><li>Drag the [[Image: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.</li>:A window displays to allow you to select the object to sum ([[:Image:iRep23.png]]).</ol> [[Image:iRep23.png|center|500px|''Figure 23. Window to select object to sum'']]<div align="center">''Figure 23. Window to select object to sum''</div> <ol><li>Double-click ''Fields''.</li><li>Click the name of the attribute that you would like to sum.</li><li>Click the '''OK''' button.</li></ol> ===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 other types of variablecalculations. 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.

<ol><li>From # Follow the '''View''' menu, select '''Variables'''.</li><li>Click the '''New''' button.</li>:The Add/modify variable window displays.</ol> steps to [[Image:iRep24.pngModify an iReport Template#Adding a Variable to an iReport Template|center|500px|''Figure 24. Add/modify add a variable window''to an iReport]]<div align="center">''Figure 24. Add/modify variable window''</div> <ol start="3"><li>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.</li><li># From the '''Variable Class Calculation 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.</li></ol> {| class="wikitable"|-| [[File:Note.jpg | 40px]] || To determine the class type of a field:<ol><li>Right-click the field element in the report pane.</li><li>Select '''Properties'''.</li><li>Select the '''Text Field''' tab.</li>:The class type will be displayed in the '''Text Field Expression Class''' field. </ol>|} <ol start="5"><li>From the '''Calculation Type''' listpane, select the calculation that you would like to perform.</li></ol>

| align="center" colspan="2" | '''Table 4. Calculation types'''

<ol start="63">

| align="center" colspan="2" | '''Table 5. Reset Types'''

<ol start="74">

{| class="wikitable"|-| [[File:Note.jpg | 40px]] |{note| 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. |}}

<ol start="85"><li>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.</li><li>From the '''Increment Group''' list, select the group at which the variable will be incremented.</li><li>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:</li><ol type="a"><li>Click the [[Image:iRepEditor.png]] button that is displayed beside edit the '''Variable Expression''' field.</li>[[Image:The Expression editor window displaysIReport VariableAdd5.<li>From the Objects and expressions tab, select png|center|500px|''Variable Expression Editor'Fields''' from the left pane.]]</lidiv align="center"><li>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.</li><li>Click the '''Apply''' button.</li>:The Expression editor window closes. The Add/modify variable window displays the selected field in the Variable Expression field. <li>Click the '''OKEditor''' button.</lidiv>:The Add/modify variable window closes and the variable that you just added is listed as a variable in the Library pane.</olli>

In addition to the summary functions available on the variable, specific expressions can be used in the Expression Editor to define values. For example:{| class="wikitable"width="600" align="center"|-| align="center" colspan="2" | '''Expression Operations'''|-| width="150pt" | '''Operation'''| width="450pt" | '''Expression'''|-| Division || $F{areaSize}/$V{REPORT_COUNT}|-| Addition || $F{areaSize} + 500.0|-| Subtraction || $F{areaSize} - $P{ClearedArea}|-| Multiplication || $F{areaSize} * $V{REPORT_COUNT}

| [[File:Note.jpg Concatenation (string only)| 40px]] || If the Library pane is not displayed, display it by doing the following:<ol><li>From the '''View''' menu, select '''Docking Panes'''.</li><li>From the '''Docking Panes''' menu, select '''Library'''.</li></ol>$F{localId} + $P{LocationName}

==Crosstabs==__NOEDITSECTION__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 be 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:# In the '''Palette''' pane, drag a '''Crosstab''' item to the Summary Band of the report.# The Crosstab wizard displays#: [[Image:IReport Crosstab1.png|center|500px|''Crosstab wizard'']]<div align="center">''Crosstab wizard''</div># Select the '''Field''' to use in the '''Row''' of the Crosstab grid.#: [[Image:IReport Crosstab2.png|center|500px|''Crosstab wizard'']]<div align="center">''Crosstab wizard''<ol /div># Select the '''Field''' to use in the '''Column''' of the Crosstab grid.#: [[Image:IReport Crosstab3.png|center|500px|''Crosstab wizard'']]<div align="center">''Crosstab wizard''</div># 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.#: [[Image:IReport Crosstab4.png|center|500px|''Crosstab wizard'']]<div align="center">''Crosstab wizard''</div># Finalise the Crosstab display.#: [[Image:IReport Crosstab5.png|center|500px|''Crosstab wizard'']]<div align="center">''Crosstab wizard''</div># The Crosstab displays.#: [[Image:IReport Crosstab6.png|center|500px|''Crosstab wizard'']]<div align="center">''Crosstab wizard''</div> 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.[[Image:IReport Crosstab7.png|center|500px|''Crosstab Preview'']]<div align="center">''Example Crosstab Preview''</div> ==Charts==__NOEDITSECTION__ 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. See [[Modify an iReport Template|Modify an iReport Template]] for more information on [[Modify an iReport Template#Grouping|grouping]].#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|Modify an iReport Template]] for more information on [[Modify_an_iReport_Template#To_add_a_variable_manually|adding variables]]. ===Pie Chart===__NOEDITSECTION__ ====Add a Pie Chart====__NOEDITSECTION__To add a pie chart to the report:#Create a report which groups the results by the attribute on which you would like to base your chart (e.g. ''status'').#Ensure that the Summary Band is available on the iReport template canvas.#[[Modify_an_iReport_Template#Adding a Variable to an iReport Template|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'').#Select the '''Chart''' option from the '''Palette''' pane and drag it to the '''Summary Band''' of the report template to startthe '''Chart Wizard'''.#Select one of the pie chart options.#:[[Image:iReport Charts1.png|center|500px|''Chart options'']]<div align="11center">''Chart options''</div>#Choose Main report dataset.#:[[Image:iReport Charts2.png|center|500px|''Chart options'']]<div align="center">''Chart options''<li/div>From # 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. #:[[Image:iReport Charts3.png|center|500px|''Chart options'']]<div align="center">''Chart options''</div># To select the '''unique value''' choose the '''Expression editor''' button and '''choose the Library ''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.#: '''$F{status} == null ? "N/A" : $F{status}'''#:[[Image:iReport Charts5.png|center|500px|''Set Unique Value'']]<div align="center">''Set Unique Value''</div>#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_areaSize_byStatus''). #:[[Image:iReport Charts6.png|center|500px|''Select the desired numeric variable'']]<div align="center">''Select the desired numeric variable''</div>#Choose '''Next'''.#:[[Image:iReport Charts7.png|center|500px|''Chart Wizard Completed'']]<div align="center">''Chart Wizard Completed''</div># Choose '''Finish''' and the iReport template displays with the Chart.#:[[Image:iReport Charts8.png|center|500px|''iReport displays with Chart'']]<div align="center">''iReport displays with Chart''</div># The report can now be previewed to ensure it is functioning as expected.#:[[Image:iReport ChartsPreview.png|center|500px|''Preview with Chart'']]<div align="center">''Preview with chart''</div>====Modify a Pie Chart====__NOEDITSECTION__Once a chart has been created in iReport Designer, its properties can be edited by selecting the '''Chart Data''' option on the right click menu and adjusting the values and properties.  To modify a chart:# Right click on the chart in iReport Designer and select '''Chart Data''' from the menu.# The Chart details window displays.#: [[Image:IReport ChartData1.png|center|500px|''Chart Data Properties'']]<div align="center">''Chart Data Properties''</div># To edit the main properties of the chart, select the '''Details tab'''. Additionally, this screen can be used to edit the reset type of the chart which is relevant if the chart is displayed on a band other than the summary band.# The '''Chart Details''' window displays.#: [[Image:IReport ChartData2.png|center|500px|''Chart Data Properties'']]<div align="center">''Chart Data Properties''</div># In this window, the basic properties of the chart that were established in the Chart Wizard can be edited. These include:#* '''Key Expression''': the field used to group data for charting purposes. To change the field, simply select another field. '''Note:''' The field must be used in the creation of the variable used in the value expression or the results will be incorrect.#* '''Value Expression''': the variable used to store the data to be displayed in the chart. If changes are made this value it is recommended to edit the variable properties as well.#* '''Label Expression''': the area used to define the labels for the chart. Any valid expression can be used here. See [[Summarize iReport Template Data#Variable Expressions|Variable Expressions]] for more details.  ===Bar Charts===__NOEDITSECTION__Bar charts, unlike Pie Charts, have a third variable option that can be included in the report. In addition to the category and value expressions, bar charts add the option of a '''''series'''''. The series choice adds an additional possibility of grouping data though is not required. ====Add a Bar Chart====__NOEDITSECTION__To add a bar chart to the report:#Create a report which groups the results by the attribute on which you would like to base your chart (e.g. ''status'')#Ensure that the Summary Band is available on the iReport template canvas.#[[Modify_an_iReport_Template#Adding a Variable to an iReport Template|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'').#Select the '''Chart''' option from the '''Palette''' paneand drag it to the '''Summary Band''' of the report template to start the '''Chart Wizard'''.#Select one of the bar chart options.#:[[Image:IReport BarChart.png|center|500px|''Chart options'']]<div align="center">''Chart options''</div>#Choose Main report dataset.#:[[Image:IReport BarChart_Step1.png|center|500px|''Chart options'']]<div align="center">''Chart options''</div># Provide a '''Series Expression''' (''optional''). #:[[Image:iReport Chart Bar1.png|center|500px|''Series Expression'']]<div align="center">''Series Expression''</div># The Series Expression allows you to define an added level of detail to your bar chart (if desired). To select the '''Series''' choose the '''Expression editor''' button and '''choose one of the ''fields'' the report is grouped by''' (e.g. ''status''). Note that charts in iReport will fail if the '''Series''' value is null. In order to account for null values, click 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 the field the name of the variable field that you selected above.#: '''$F{status} == null ? "N/A" : $F{status}'''#:[[Image:iReport Charts5.png|center|500px|''Set Series Value'']]<div align="center">''Set Series Value''</div>#: The expression that you created 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.#:[[Image:iRep30.png|center|500px|''Bar chart –Single attribute y-axis'']]<div align="center">''Bar chart –Single attribute y-axis''</div>#*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 averagesecondary 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).#:[[Image:iRep31.png|center|500px|''Bar chart with different series expression'']]<div align="center">''Bar chart with different series Expression''</lidiv>#* '''Finally, the Series value can be left blank if desired.'''# The next step is to provide the correct data for the chart to use. Bar charts require a '''category expression''' and a '''value expression''' where the value expression is a field to group the data by (i.e. the names of the X axis) and value expression is the value to sum. #:[[Image:iReport Chart Bar2.png|center|500px|''Category and Values'']]<div align="center">''Category and Values''<li/div>Drag # To select the '''category expression''' choose the '''Expression editor''' button and '''choose one of the ''fields'' the report is grouped by''' (e.g. ''status''). Note that charts in iReport will fail if the '''category expression''' is null. In order to account for null values, you will need to modify the variable 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 field with the field that you selected above.#: '''$F{status} == null ? "N/A" : $F{status}'''#:[[Image:iReport Charts5.png|center|500px|''Set Category Expression'']]<div align="center">''Set Category Expression''</div>#Next, select the '''value expression''' that contains the desired numeric data for the summary section chart. '''Note: This should always be one of the variables created in step 3 above''' (e.g. ''SUM_status_byAreaSize''). #:[[Image:iReport Charts6.png|center|500px|''Select the desired value expression'']]<div align="center">''Select the desired value expression''</div># Choose '''Finish''' and the iReport template displays with the Chart.#:[[Image:iReport Chart Bar3.png|center|500px|''iReport displays with Chart'']]<div align="center">''iReport displays with Chart''</div># The reportcan now be previewed to ensure it is functioning as expected.#:[[Image:iReport Chart BarPreview.png|center|500px|''Preview with Chart'']]<div align="center">''Preview with chart''</div> ====Modify a Bar Chart====__NOEDITSECTION__Once a bar chart has been created in iReport Designer, its properties can be edited by selecting the '''Chart Data''' option on the right click menu and adjusting the values and properties.  To modify a bar chart:# Right click on the chart in iReport Designer and select '''Chart Data''' from the menu.# The Chart Data properties display.# To edit the main properties of the chart, select the '''Details tab'''. Additionally, this screen can be used to edit the reset type of the chart which is relevant if the chart is displayed on a band other than the summary band.# The '''Chart Details''' window displays#: [[Image:IReport Chart Bar ChartData1.png|center|500px|''Chart Data Properties'']]<div align="center">''Chart Data Properties''</lidiv># For Bar Charts this presents the '''Category Series''' chooser. Typically there will be only one or two series to choose from here though more can be added at this point. Select the series to modify and choose '''Modify'''.# The Chart Data properties window will display#: [[Image:IReport Chart Bar ChartData2.png|center|500px|''Chart Data Properties'']]<div align="center">''Chart Data Properties''</oldiv># In this window, the basic properties of the bar chart that were established in the Chart Wizard can be edited. These include:#*'''Series Expression''': the field used to first group data for charting purposes. To change the field, simply select another field. '''Note:''' while this field is required it can be made blank or fixed by being set to a constant such as: "" or "Blank".#*'''Category Expression''': the field used to group data for charting purposes. To change the field, simply select another field. '''Note:''' The field must be used in the creation of the variable used in the value expression or the results will be incorrect.#* '''Value Expression''': the variable used to store the data to be displayed in the chart. If changes are made this value it is recommended to edit the variable properties as well.#* '''Label Expression''': the area used to define the labels for the chart. Any valid expression can be used here. See [[Summarize iReport Template Data#Variable Expressions|Variable Expressions]] for more details. {{NavBox HowTo Standardizing Data Analysis and Information Reporting}}[[Category:VIE]]