Modify an iReport Template - Revision history

Alnaucler at 19:30, 20 February 2020

2020-02-20T19:30:43Z

← Older revision		Revision as of 21:30, 20 February 2020
Line 217:		Line 217:

	{{NavBox HowTo Standardizing Data Analysis and Information Reporting}}		{{NavBox HowTo Standardizing Data Analysis and Information Reporting}}
	[[Category:~~VIE~~]]		[[Category:NAA]]

Alnaucler at 17:38, 11 December 2017

2017-12-11T17:38:55Z

← Older revision		Revision as of 19:38, 11 December 2017
Line 1:		Line 1:
	~~__FORCETOC__~~
	{{TOC right}}		{{TOC right}}
			{{Warning \| Do not edit / overwrite the iReports templates that are included in the installation package. Use the '''''Save as''''' function and give the iReport template a '''new''' name.}}

	==Overview==__NOEDITSECTION__		==Overview==__NOEDITSECTION__
	Once an iReport template has been created, there are many options for modifying the report template including 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}}.		Once an iReport template has been created, there are many options for modifying the report template including 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}}.

Alnaucler at 12:57, 16 June 2017

2017-06-16T12:57:59Z

← Older revision		Revision as of 14:57, 16 June 2017
Line 9:		Line 9:

	====Option 1: Get fields from Datasource====__NOEDITSECTION__		====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~~ any unwanted fields from the report. {{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:		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 delete any unwanted fields from the report. {{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.		# Choose the Report Query button.
	#:<div align="center">[[Image:IReport_ReportQueryButton.png‎\|center\|500px\|''Report Query Button'']]''iReport Report Query Button''</div>		#:<div align="center">[[Image:IReport_ReportQueryButton.png‎\|center\|500px\|''Report Query Button'']]''iReport Report Query Button''</div>

Dionysia at 12:50, 13 November 2015

2015-11-13T12:50:55Z

Alnaucler at 16:22, 3 June 2014

2014-06-03T16:22:37Z

← Older revision		Revision as of 18:22, 3 June 2014
Line 9:		Line 9:

	====Option 1: Get fields from Datasource====__NOEDITSECTION__		====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 any unwanted fields from the report. {{~~warning~~ \| Make sure that the datasource selected in iReports corresponds to the data source for the report.}} To add fields from the Report Query dialogue:		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 any unwanted fields from the report. {{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.		# Choose the Report Query button.
	#:<div align="center">[[Image:IReport_ReportQueryButton.png‎\|center\|500px\|''Report Query Button'']]''iReport Report Query Button''</div>		#:<div align="center">[[Image:IReport_ReportQueryButton.png‎\|center\|500px\|''Report Query Button'']]''iReport Report Query Button''</div>

Evinek at 15:22, 7 April 2014

2014-04-07T15:22:28Z

← Older revision		Revision as of 17:22, 7 April 2014
Line 190:		Line 190:

	===Sorting Report Results===__NOEDITSECTION__		===Sorting Report Results===__NOEDITSECTION__
	It may be helpful to sort the report results using ~~the value~~ in one or more of the fields. Sorting the results makes it easier to review ~~the results~~ and locate any records that you may be searching for.		It may be helpful to sort the report results using values in one or more of the fields. Sorting the results makes it easier to review them and locate any records that you may be searching for.
	To sort report results:		To sort report results:
	<ol start="1">		<ol start="1">
Line 209:		Line 209:
	::The Sorting window displays. The Sort by list displays all the fields that you have selected for the report.		::The Sorting window displays. The Sort by list displays all the fields that you have selected for the report.
	<li>Repeat steps 4-7 for each field on which you would like to sort the results.</li>		<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>		<li>After you have added all the fields on which you would like to sort the results, click the '''Close''' button.</li>
	:The Sorting window closes.		:The Sorting window closes.
	<li>From the Report query window, click the '''OK''' button.</li>		<li>From the Report query window, click the '''OK''' button.</li>

Evinek at 14:58, 7 April 2014

2014-04-07T14:58:47Z

← Older revision		Revision as of 16:58, 7 April 2014
Line 131:		Line 131:
	# Set the '''Property Value''' to the desired SQL statement.		# Set the '''Property Value''' to the desired SQL statement.
	#: [[Image:IReport SQLField3.png\|center\|300px\|''Set the SQL Values'']]<div align="center">''Set the SQL Values''</div>		#: [[Image:IReport SQLField3.png\|center\|300px\|''Set the SQL Values'']]<div align="center">''Set the SQL Values''</div>
	# Return to the report and use the new SQL Field just like any other '''string''' field.		# 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 Field Examples====__NOEDITSECTION__		====SQL Field Examples====__NOEDITSECTION__
	The SQL statement can be any valid ~~SQL~~ statement that returns a result. ~~This field can be used~~ to ~~retrieve data that~~ is in ~~difficult~~ to ~~access areas of the database~~. You can use any valid PostgreSQL statement in the SQL field including		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		* VIEWS, JOINS, HAVING, sub-selects, and sub-queries
	* PostrgreSQL functions such as COALESCE()		* PostrgreSQL functions such as COALESCE()
Line 152:		Line 152:

	As with other areas in iReport, the ''links.toGuid'' field is case sensitive and must be referenced exactly.		As with other areas in iReport, the ''links.toGuid'' field is case sensitive and must be referenced exactly.

			Further information about this can be found on the [[Create i-Report Templates with Subreports\|Subreport instruction pages]].

	==Sorting and Grouping==__NOEDITSECTION__		==Sorting and Grouping==__NOEDITSECTION__

Evinek at 14:50, 7 April 2014

2014-04-07T14:50:17Z

Evinek at 13:00, 7 April 2014

2014-04-07T13:00:08Z

← Older revision		Revision as of 15:00, 7 April 2014
Line 111:		Line 111:
	Dates should use the format yyyy-MM-dd.		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 ~~filter is:~~ status = "Active" ~~-- however~~, the status value for the returned rows will be the translated value "Open" instead of "Active".}}		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__		==Special Fields ==__NOEDITSECTION__

Evinek at 12:57, 7 April 2014

2014-04-07T12:57:31Z

← Older revision		Revision as of 14:57, 7 April 2014
Line 106:		Line 106:
	links.toGuid = "$P{ItemGUID}" and type = "ProgressReport"		links.toGuid = "$P{ItemGUID}" and type = "ProgressReport"
	areaSize < 1000.0		areaSize < 1000.0
	status ="Active" OR status = "Transitional"		status = "Active" OR status = "Transitional"

	{{note \| Numeric fields should always have the ''value'' portion of the filter set to a decimal.		{{note \| Numeric fields should always have the ''value'' portion of the filter set to a decimal.
	Dates should use the format yyyy-MM-dd.		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.}}		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 filter is: status = "Active" -- however, the status value for the returned rows will be the translated value "Open" instead of "Active".}}

	==Special Fields ==__NOEDITSECTION__		==Special Fields ==__NOEDITSECTION__

← Older revision		Revision as of 14:50, 13 November 2015
Line 22:		Line 22:
	====Option 2: Copy and Paste====__NOEDITSECTION__		====Option 2: Copy and Paste====__NOEDITSECTION__
	Alternatively, you can create a new report template using the Wizard and add the desired fields to the new report. Fields can then be copied and pasted from the new report to the original report.		Alternatively, you can create a new report template using the Wizard and add the desired fields to the new report. Fields can then be copied and pasted from the new report to the original report.
	# Create a new report using the [[Create a Basic ~~i-Report~~ Template\|iReport Wizard]] and the same data source		# Create a new report using the [[Create a Basic iReport Template\|iReport Wizard]] and the same data source
	# Select the desired fields and finish the report		# Select the desired fields and finish the report
	# Using the Report Inspector, navigate to the desired fields		# Using the Report Inspector, navigate to the desired fields
Line 69:		Line 69:
	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 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:		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 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:
	* '''temporarily''': to limit the results returned when previewing the report during the design phase in iReport		* '''temporarily''': to limit the results returned when previewing the report during the design phase in iReport
	* '''permanently''': for use in [[Create ~~i-Report~~ 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.		* '''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.

	Both approaches use the same steps.		Both approaches use the same steps.
Line 119:		Line 119:
	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'''.		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 ~~i-Report~~ Template\|iReport Wizard]] process or manually added later.		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:		To use the SQL field to select data from the IMSMA database:
Line 153:		Line 153:
	As with other areas in iReport, the ''links.toGuid'' field is case sensitive and must be referenced exactly.		As with other areas in iReport, the ''links.toGuid'' field is case sensitive and must be referenced exactly.

	Further information about this can be found on the [[Create ~~i-Report~~ Templates with Subreports\|Subreport instruction pages]].		Further information about this can be found on the [[Create iReport Templates with Subreports\|Subreport instruction pages]].

	==Sorting and Grouping==__NOEDITSECTION__		==Sorting and Grouping==__NOEDITSECTION__

← Older revision		Revision as of 16:50, 7 April 2014
Line 117:		Line 117:

	===The SQL Field===__NOEDITSECTION__		===The SQL Field===__NOEDITSECTION__
	~~Most~~ 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 an 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 ~~most cases the~~ field ~~has the name in the form of:~~		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'''.
	''~~[object]~~''~~SQLField~~
	~~For example~~
	~~HazardSQLField~~
	~~AccidentSQLField~~
	~~MRESQLField~~

	These fields can be added during the [[Create a Basic i-Report Template\|iReport Wizard]] process or manually added later.		These fields can be added during the [[Create a Basic i-Report Template\|iReport Wizard]] process or manually added later.

	To use the SQL field to select data from the IMSMA database:		To use the SQL field to select data from the IMSMA database:
	# In '''Report Inspector''', ~~choose~~ the ~~desired~~ SQLField ~~(e.g. HazardSQLField)~~ to view ~~it's~~ properties in the '''Properties''' pane.		# 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, ''~~HazardSQLField~~(testSQL)'' or ''~~AccidentSQLField~~(VictimCount)''.		# 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'''.		# 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>		#: [[Image:IReport SQLField1.png\|center\|300px\|''SQL Field Properties'']]<div align="center">''SQL Field Properties''</div>
Line 136:		Line 131:
	# Set the '''Property Value''' to the desired SQL statement.		# Set the '''Property Value''' to the desired SQL statement.
	#: [[Image:IReport SQLField3.png\|center\|300px\|''Set the SQL Values'']]<div align="center">''Set the SQL Values''</div>		#: [[Image:IReport SQLField3.png\|center\|300px\|''Set the SQL Values'']]<div align="center">''Set the SQL Values''</div>
	# Return to the report and use the new SQL Field just like any other string field.		# Return to the report and use the new SQL Field just like any other '''string''' field.

	====SQL Field Examples====__NOEDITSECTION__		====SQL Field Examples====__NOEDITSECTION__