Changes

{{HowTo'sWarning |[[Start and Configure i-Report|Start and Configure i-Report]]|[[Create a Basic i-Report Template|Create a Basic i-Report Template]]|[[Modify an iReport Template|Modify an iReport Template]]|[[Format an iReport Template|Format an iReport Template]]|[[Create i-Report Templates with Subreports|Create i-Report Templates with Subreports]]|[[Summarize i-Report Template Data|Summarize i-Report Template Data]]}}==Overview==Once an iReport template has been created, there Do not edit / overwrite the iReports templates that are many options for modifying included in the report template including adding new fields, creating variables, filtering installation package. Use the query results '''''Save as''''' function and many other options. This section covers give the main customizations performed on iReport templates for use in {{IMSMANGtemplate a '''new''' name.}}

==Fields, Variables, and ParametersOverview==__NOEDITSECTION__===Adding a Field to Once an iReport Template===<p>If you need to include a field that was not selected while using the Report Wizardtemplate has been created, there are several many options for modifying the report template including additional adding new fields, creating variables, filtering the query results and many other options. This section covers the main customisations performed on iReport templates for use in {{IMSMANG}}. The definition of a field

==Fields, Variables, and Parameters==__NOEDITSECTION__===Adding a Field to an iReport Template===__NOEDITSECTION__<p>If you need to include a field that was not selected while using the Report Wizard, there are several options for including additional fields.  ====Option 1: Get fields from Datasource====__NOEDITSECTION__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 delete any unwanted fields from the report . {{warning Note| Make sure that the datasource selected in iReports corresponds to the data source for the report.}} To add fields from the Report Query dialogue:# Choose the Report Query button.#:<div align="center">[[Image:IReport_ReportQueryButton.png‎|center|250px500px|''Report Query Button'']]''iReport Report Query Button''</div>

# All fields will now be displayed. Unnecessary fields can be removed at this time.

====Option 2: Copy and Paste====__NOEDITSECTION__

# Create a new report using the [[Create a Basic i-Report iReport Template|iReport Wizard]] and the same data source

# Right click on the field and select copy.

# Right-click on the fields tree in Report Inspector and choose '''paste'''.

{{note | 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===__NOEDITSECTION__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.

# In the '''Properties''' pane, enter a parameter name (e.g. ItemGUID} and edit any other properties. Normally it is For example, if you do not required want to edit anything other than use the nameparameter as a prompt, then deselect the '''Use as a prompt''' option.

===Adding a Variable to an iReport Template===__NOEDITSECTION__

====For numeric variables====__NOEDITSECTION__

# From the '''Report Inspector''', Select select the field that you wish to sum or count.# Drag the field to the Summary Band of the iReport Template canvas.

# Choose '''OK'''.

====To add a variable manually====__NOEDITSECTION__

## Enter a Variable name (e.g. SumAreaSize} .

## Choose the '''Calculation''' type, normally '''Sum''' or '''Count'''.## Enter a '''Variable Expression'''. Normally this is simply selecting the field to be summed or counted (e.g. '''$F{areaSize}'''). Click the [[Image:Editor Button.png]] on the Variable Expression line to open the Variable Expression editor.

# Choose OK.# Drag the variable to the iReport template as desired.

==Report Query Filtering==__NOEDITSECTION__iReport Designer provides an option for limiting or filtering the results of the query that returns data to the report. While in most cases this Report Query filter is ignored by {{IMSMANG}} once the report as has been imported in favor of the search criteria, there are some cases where it is important to edit the Report Query filters in iReport. The two main reasons are:

* '''permanently''': for use in [[Create iReport Templates with Subreports |Subreports]] to restrict the data returned to those that have a relationship with the main report. For example to only return Activities that are associated with the Land in the main report.

===Using Report Query filters===__NOEDITSECTION__

#Open the Report Query window from iReport Designer.#:[[Image:IReport ReportQueryButton.png|center|200px500px|''iReport Report Query Button'']]<div align="center">''Open Report Query''</div># Choose '''ImsmaQuery''' from the '''Query Languagelanguage''' drop down.

# Enter a valid [[#ImsmaQuery Language Syntax|ImsmaQuery Language]] filter in the textbox (e.g. localId='"MF-HQ-1'").

===ImsmaQuery Language Syntax===__NOEDITSECTION__The ImsmaQuery Language syntax is a language designed to limit or filter datasets in iReportsinteracting with {{IMSMANG}}. It is similar to the WHERE clause syntax in SQL though not identical. ImsmaQuery language generally uses the following format:

#To start using ImsmaQuery Language, first decide which field you want to include in your filter. You may choose any field that is available on the data source to begin your filtering. As in most places in iReport fields are case sensitive. Therefore '''''localId''''' will work but '''''LocalId''''', '''''LocalID''''' and '''''localid''''' will all fail to filter the data.}}

====ImsmaQuery Examples====__NOEDITSECTION__ localId LIKE "MF-HQ-%" endDate > 2010-09-01 AND endDate <2010-09-30 links.toGuid = "$P{ItemGUID}" and type = "ProgressReport" areaSize < 1000.0 status = "Active" OR status = "Transitional" {{note | Numeric fields should always have the ''value'' portion of the filter set to a decimal. Dates should use the format yyyy-MM-dd. Strings from lookup tables (i.e. ImsmaEnum) should always refer to the key value rather than the translated value. In one of the above examples, the query filters the status on "Active". However, the status value for the returned rows will be the translated value "Open" instead of "Active".}} ==Special Fields ==__NOEDITSECTION__In addition to providing access to all of the data fields on a particular object, the iReport data sources provide access to several special fields to access hard to reach data from the IMSMA database. ===The SQL Field===__NOEDITSECTION__All iReport data sources have access to a special field called the SQL field to access hard to reach data. This field allows report designers to insert and execute a SQL query to access data from within an iReport template. It's usage requires a knowledge of SQL and the IMSMA database structure and is only recommended for IMSMA administrators with a strong information management background. In all data sources, this special field is called '''SQLField'''. These fields can be added during the [[Create a Basic iReport Template|iReport Wizard]] process or manually added later.  To use the SQL field to select data from the IMSMA database:# In the '''Report Inspector''', click on the SQLField to view its properties in the '''Properties''' pane.# Edit the name of the SQL field by adding a unique value to the end of the SQL field in parentheses. For example, ''SQLField(testSQL)'' or ''SQLField(VictimCount)''.# Choose the '''Properties''' setter to open the '''Properties List'''.#: [[Image:IReport SQLField1.png|center|300px|''SQL Field Properties'']]<div align="center">''SQL Field Properties''</div># Choose '''Add''' to create a new property.#: [[Image:IReport SQLField2.png|center|300px|''Create the SQL Property'']]<div align="center">''Create the SQL Property''</div># Set the '''Property Name''' to '''''SQL'''''# Set the '''Property Value''' to the desired SQL statement. #: [[Image:IReport SQLField3.png|center|300px|''Set the SQL Values'']]<div align=Editing "center">''Set the SQL Values''</div># Return to the report and use the new SQL Field just like any other '''string''' field. {{note|Even if the query returns a numeric value, it is converted into a string; the result of the SQLField is always a string. Therefore, if the return values have to be used as input to some calculation, they need to be explicitly cast to numeric values.}} ====SQL FieldExamples====__NOEDITSECTION__The SQL statement can be any valid PostgreSQL statement that '''returns a result'''. Especially when working with charts, null values will lead to errors. Therefore, it is a good practice to use a function like COALESCE() in order to ensure that null values are replaced by a custom value. You can use any valid PostgreSQL statement in the SQL field including* VIEWS, JOINS, HAVING, sub-selects, and sub-queries* PostrgreSQL functions such as COALESCE()* a special parameter called {guid} that passes the value of the {guid} from the report to the SQL statement. This can be used like a regular string to limit the SQL statement according to the object in the report.  Examples of SQLField statements include: SELECT hazard_localid FROM hazard WHERE hazard_guid = '{guid}'  SELECT COALESCE(sum(qty),0) as QTY FROM hazreducdeviceinfo WHERE hazreduc_guid = '{guid}' AND ordnance_guid IN (SELECT ordnance_guid FROM ordnance WHERE model LIKE '%AP%')

==Sorting =links.toGuid===__NOEDITSECTION__Another example of a special field available in iReport templates is the '''links.toGuid''' value. links.toGuid is available on any of the major objects in {{IMSMANG}} including Land, Activity, Education, Accident, Victim, Assistance, Location, and Grouping=Quality Management. This field can be used in the Report Query portion of a report to filter the results based on linkages to other objects. For example, on a Land report with an Activity subreport, the subreport could contain the following Report Query filter to return only Activities with linkages to the Land on the main report: links.toGuid ="$P{HazardGUID}"

===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 valueAs with other areas in iReport, grouping automatically organises the results for you''links.</p><p>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 toGuid'' field is included in the report, it would case sensitive and must be difficult, tedious, and time-consuming to scan the entire report to identify those land that have a common location IDreferenced exactly.</p>

Further information about this can be found on the [[Create iReport Templates with Subreports|Subreport instruction pages]]. ==Sorting and Grouping==__NOEDITSECTION__ ===Grouping===__NOEDITSECTION__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. [[Image:iRep07.png|center|500px|''Figure 7. Land report with no grouping'']]

''Figure 7. Land report with no grouping''

<p>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 the figure below 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.</p>

===Adding a Group to an iReport Template===__NOEDITSECTION__

{{note|You may also enter #From the '''Report Inspector''', right-click on the top node of the expression in Report.#Select '''Add Report Group''' from the menu#: [[Image:IReport Group1.png|center|200px|''Add a Report Group'']]<div align="center">''Add a Report Group''</div>#Select a name for your Report Group Expression and choose a field if to group by (e.g. maAreaType to group by land classification). The name should be a meaningful name that allows you know to easily identify the exact spelling contents of the group such as the field name on which you would like to group the resultsare grouped#: [[Image:IReport Group2. The syntax is $F{png|center|500px|''Create a Report Group'']]<div align="center">''Create a Report Group''</div># Choose '''Next''' and '''Finish'FieldName''}.}} This will create a new group in the iReport template as well as two additional bands (a header and a footer for the group).

===Sorting Report Results===__NOEDITSECTION__It may be helpful to sort the report results using the value values in one or more of the fields. Sorting the results makes it easier to review the results them and locate any records that you may be searching for.

<ol start="131">

<li>From the '''Data''' menu, select Select the '''Report Query''' optionbutton.</li>

:The Sorting Options window displays.

<ol start="186"><li>From the '''Sort Typetype''' list, select either the ''Ascending'' or ''Descending'' sort order.</li>

::The Sorting window displays. The Sort by list displays all the fields that you have selected field displays in for the Sorting Options windowreport.

<li>After you have completed adding added all the fields on which you would like to sort the results, click the '''Close''' button.</li>:The Sorting Options window closes.

<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}} =Working with Images=====Adding an Image to an iReport Template===????[[Category:VIE]]