Changes

Jump to: navigation, search

Create a Basic iReport Template

5,122 bytes removed, 21:32, 20 February 2020
no edit summary
==Report Basics==__FORCETOC__===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*Field Report*Land*Activity*Location*Education*Organisation*Place*QM*Victim*Task*Work Item{{TOC right}}
{| class="wikitable"=Creating a Basic iReport Template Using the Wizard==__NOEDITSECTION__|-| [[File:Note.jpg | 40px]] || The sample report ''Summary_Location .jrxml'' There is a wizard in iReport to help in the <''process of creating new iReport Installation Directory''>\iReports_IMSMA\IMSMA reports directory provides templates. To create an example of a basic report. |}iReport template using the Wizard:
To create a report:
<ol>
<li>From In the '''File''' menu, select &rarr; '''Report WizardNew...'''. </li>:The iReport Wizard window displays. <li>From Select the '''Connection/Data Sources''' list, select the item for which template you would like to create a use for your report.Blank A4 or an IMSMA specific template are preferrable</li>
</ol>
 [[Image:iRep01{{note|At iReport startup, it can take several seconds to load the window with the templates.png|center|500px|The next time you click on '''Figure 1New. iReport Wizard – Step 1..''']]however, the templates appear instantaneously.}}
<div align="center">
[[Image:iReport Wizard1.png|center|500px|''Figure iReport Wizard – Step 1. '']]''iReport Wizard – Step 1''
</div>
<ol start="3">
<li>Click the '''NextLaunch Report Wizard''' button.</li>:The window to select the attributes to include in the report displays.
</ol>
<div align="center">[[Image:iRep02iReport Wizard2.png|center|500px|''Figure 2. iReport Wizard - Step 2'']]<div>''Figure 2. iReport Wizard - Step 2''
</div>
<ol start="4">
<li>From the Step 2. select fields screen:</li><ol type="a"><li>Select the attributes that you would like to include in desired Data Source for the report. and choose '''Error! Reference source not found.Next''' describes the available buttons.</li>
</ol>
<div align="center">
[[Image:iReport Wizard3.png|center|500px|''iReport Wizard - Step 3'']]
''iReport Wizard - Step 3''
</div>
 
<ol start="5">
<li>Select the desired data fields for the report and choose '''Next'''</li>
</ol>
<div align="center">
[[Image:iReport Wizard4.png|center|500px|''iReport Wizard - Step 4'']]
''iReport Wizard - Step 4''
 
 
<center>
{| class="wikitable" width="500"
|-
| align="center" colspan="2" | '''Table 2. iReport Wizard – Buttons for selecting fields'''
|-
| width="125pt" | '''Button'''
| align="center" | [[Image:iRepDRA.png]] || Includes data for all fields in the report.
|-
| align="center" | [[Image:iRepLA.png]] || Removes Deletes the selected field from the report.
|-
| align="center" | [[Image:iRepDLA.png]] || Indicates a tip for using IMSMADeletes all fields from the report.
|}
</centerdiv>
{{note| class="wikitable"|-| [[File:Note.jpg | 40px]] || If you would like It is recommended to organise the report results by country structure areas, you should always 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. |} <ol start="5"><ol type="a" start="2"><li>Click the '''Next'guid'' button.</li>:A window displays the selected fields. </ol> <li>Click the '''Next''' button.</li> 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. [[:Image:iRep03.png|Figure 3]] illustrates an example of when designing a report that groups its results by gazetteer. For more information on grouping, refer to Grouping.</ol> [[Image:iRep03.png|center|500px|''Figure 3. Group by example'']]}}
<ol start="6">
<li>Click the '''Next''' button.The [[Modify an iReport Template#Sorting_and_Grouping|group by]] step allows you to list item records that have the same value for the selected group by field together in the report. 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.</li>
</ol>
 
{| class="wikitable"
|-
| [[File:Note.jpg | 40px]] || 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.
|}
 
<ol start="7">
<li>Click the '''Next''' button.</li>
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.
</ol>
 
[[Image:iRep04.png|center|500px|''Figure 4. Columnar layout'']]
<div align="center">
[[Image:iReport Wizard5.png|center|500px|''Figure 4. Columnar layoutiReport Wizard - Step 5''</div> <p>The tabular layout option displays the field names across the top of the page. The corresponding report results are displayed below each field name.</p>]]
[[Image:iRep05.png|center|500px|''Figure iReport Wizard - Step 5. Tabular layout'']]<div align="center">''Figure 5. Tabular layout''
</div>
 
<ol start="7">
<li>From the window to select a layout:</li><ol type="a"><li>Select the layout option.</li><li>Click the '''Next''' button.</li>:The window displays a message stating that you have successfully created a new report.</ol><li>Click the and then '''Finish''' button.</li>:The Wizard is complete and the iReport template for designer window is open. Depending on your selections your report displays. <li>Ensure that the data source selected matches the item of template will look different from the reportexample below.</li>
</ol>
[[Image:iRep06.png|center|500px|''Figure 6. Report data source'']]
<div align="center">
[[Image:iReportHome1.png|center|500px|''iReport Wizard - Final Step'']]'Figure 6. Report data source'iReport Wizard - Final Step''
</div>
<ol start="11">=iReport Designer Orientation==__NOEDITSECTION__<li>Click Once your initial iReport template has been created you can begin adding data elements to the template, modifying the layout and formatting, and other aspects of [[Image:iRepCompile.pngModify an iReport Template|modifying an iReport Template]] button to compile the report.</li>:The Save report window displays.<li>Enter Below is a name for brief orientation to the report panes and functions available in the File name fieldiReport Designer.</li><li>If there any of the panes or windows are no compilation errors, click unavailable they can be added back by selecting the [[Image:iRepRun.png]] button to run relevant item from the report'''Window''' menu.</li>:The results of the report display in the iReport JasperViewer window. </ol>
===GroupingReport Inspector ===__NOEDITSECTION__<p>Grouping allows you to organise the report results using the values The Report Inspector pane displays a hierarchical structure of a particular field. Grouping results makes it easier to identify the records which share a common value. Rather than having iReport template and provides access to visually scan the report results to determine which records have a common valueavailable fields, parameters, grouping automatically organises and variables as well as all formatting elements of the results for you.</p><p>To illustrate, suppose you wanted to create a report to list all hazards within each location ID. The procedures that have been discussed so far in this training module would simply list all hazards along with their location ID. Although Each node can be expanded for more details about the location ID is included elements contained in the report, it would be difficult, tedious, and time-consuming to scan the entire report to identify those hazards that have a common location ID ([[:Image:iRep07.png|'''Figure 7''']]).</p>
[[Image:iRep07.png|center|500px|''Figure 7. Hazard report with no grouping'']]<div align="center">==Report Canvas ===__NOEDITSECTION__''Figure 7The middle area of the iReport Designer displays a graphical representation of the iReport template that corresponds to the hierarchical structure in the Report Inspector. In this pane you move elements around on the canvas as well as select individual elements for editing. Hazard report with no grouping''</div>
<p>Grouping report results automatically organises ===Properties Pane ===__NOEDITSECTION__This pane will display all of the records using the values on the specified field. Using the example above, the hazard properties of items selected in the report shown in Figure 8 are organised within the location to which they are associatedReport Inspector or Report Canvas. Records that do not contain The Properties Pane displays a value context-senstive list of properties for the any selected grouping are put into their own groupitem for editing.</p>
[[Image:iRep08.png|center|500px|''Figure 8. Hazards grouped by location'']]<div align="center">==Palette===__NOEDITSECTION__''Figure 8The Palette is the area where individual graphic elements can be selected and dragged onto the canvas. This includes subreports and crosstab elements. Hazards grouped by location''</div>
====Adding a Group to an Existing Report=Formatting Tools ===__NOEDITSECTION__{| class="wikitable"|-| [[File:Note.jpg | 40px]] || The field Formatting Tools pane provides access to various formatting functions designed to manage the size and space between elements on which you would like to group your report results must be included in the report. |}
To add a group to an existing report:<ol><li>From the '''View''' menu, select '''Report Groups'''.</li><li>A window displays the groups for the report.</li><li>Click the '''New''' button.</li>===iReport Output ===__NOEDITSECTION__:The Add/modify group window displays. <li>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.</li><li>Click the [[Image:iRepExpress.png]] icon.</li>:The Expression editor window displays.<li>Ensure that the Objects and expressions tab is selected.</li><li>Click '''Fields'''.</li><li>Double-click the name of the field on which you would like to add a grouping.</li>:The Expression editor window shows $F{FieldName} where FieldName is the name of the field that you selected previously. <li>Click the '''Apply''' button.</li>:The Add/modify group window pane displays any problems or output from the expression in the Group Expression field. <li>Click the '''OK''' button.</li>:The Add/modify group window closes. </ol>{| class="wikitable"|-| [[File:Note.jpg | 40px]] || 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''}reports. |}
===Adding Fields=XML and Preview Views==__NOEDITSECTION__<p>If you need In addition to include a field that was not selected while using the Report WizardDesigner View, iReport Designer provides 2 additional views, 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><ol><li>From the '''XML View''' menu, select the '''Fields''' option.</li>:A window displays three tabs (Fields, Variables, and Parameters).<li>From the Fields tab, click the '''New''' button.</li>:The Add/modify field window displaysPreview.<li>In Using the '''Field Name''' field, enter the name XML View you can get an editable version of the field that you would like to include.</li><li>Click the '''OK''' buttonjrxml file created by iReport Designer.</li>:The field This is useful for troubleshooting specific problems with a report but is included on the Fields tabgenerally only for advanced users.<li>Close the window that displays the Fields, Variables, and Parameters tabs.</li><li>Reposition the fields on your report as needed to accommodate the new field.</lidiv align="center"><li>Click the [[Image:iRepFiReportXMLView.png|center|500px|''XML View'']] icon.</li><li>Click the detail section of the report.</li><li>While holding down the mouse button, drag the cursor to form the rectangle which will contain the new field.</li><li>Release the mouse button.</li>:A placeholder for the field is displayed in the design section of the report. ''XML View''<li>Double-click the placeholder that was added for the field.</li><lidiv>Change the placeholder text so that the field that you added is between the brackets.</li></ol>
===Sorting Report Results===It may be helpful to sort the report results using The Preview view runs the value in one or more current version of the fields. Sorting iReport template and generates an output file with the results makes it easier to review of the results and locate any records that you may be searching for. To sort report results:<ol start="13"><li>Create the report.</li><li>From the '''Data''' menu, select the '''Report Query''' option.</li>:The Report query window displays.<li>Click the '''Sort options''' button that This is located at the bottom of the Report query window.</li>:The Sorting Options window displays. <li>Click the '''Add Field''' button.</li>:The Sort Field window displays. The Sort by list displays all the fields useful for ensuring that you have selected for the reportis functioning as desired prior to importing into {{IMSMANG}}. <li>From This is the '''Sort by''' list, select the field by which you would like to sort primary method for running iReport templates within the report resultsiReport Designer.</li></ol> {| classdiv align="wikitablecenter">|-| [[FileImage:NoteIReportPreview.jpg png| 40px]] center|500px| When sorting data in reports that contain groups, ensure the “Group by” fields appear first in the sort order.|} <ol start="18"><li>From the ''Preview View'Sort Type''' list, select either the ''Ascending'' or ''Descending'' sort order.</li>]]<li>Click the ''Preview View'OK''' button.</li>:The selected field displays in the Sorting Options window. <li>Repeat steps 4-7 for each field on which you would like to sort the results.</li><li>After you have completed adding the fields on which you would like to sort the results, click the '''Close''' button.</li>:The Sorting Options window closes. <li>From the Report query window, click the '''OK''' button.</lidiv>:The Report query window closes.</ol>
<p>You will need to compile {{NavBox HowTo Standardizing Data Analysis and execute the report for the sort options to take effect.</p>Information Reporting}}[[Category:NAA]]
6,632
edits

Navigation menu