Difference between revisions of "Manage Report Templates in IMSMA"

From IMSMA Wiki
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{TOC right}}
 
{{TOC right}}
  
−
iReport templates provide the foundation on which IMSMA reports are based. A report template defines:
+
iReport templates provide the foundation on which IMSMA reports are based. A iReport template defines:
 
* the data source (e.g. Land, Activity, Accident)
 
* the data source (e.g. Land, Activity, Accident)
 
* the attributes that should be displayed on the report (e.g. Land ID, Land Name and Areasize for a land report)
 
* the attributes that should be displayed on the report (e.g. Land ID, Land Name and Areasize for a land report)
 
* the overall appearance of the report (title, formatting, etc.)
 
* the overall appearance of the report (title, formatting, etc.)
  
−
A tutorial on using iReport and building templates can be found in [[Use iReport]].
+
How to create and edit iReport templates with the iReport tool may be found [[Use iReport | '''here''']].
  
−
==The IMSMA Report Template Manager==__NOEDITSECTION__
+
The Report Template Manager allows adding, changing and deleting iReport template definitions. To access the Report Template Manager, choose '''Customisation > Report Template Manager'''.
−
The IMSMA Report Template Manager allows adding, changing and deleting report templates. To access the Report Template Manager, choose '''Customisation > Report Template Manager'''.
 
  
 
This opens the Report Template Manager.
 
This opens the Report Template Manager.
  
−
==Add a new iReport Template into IMSMA==__NOEDITSECTION__
+
[[Image:ReportTemplatesWindow.png|500px|center]]
−
To add a new iReport template:
 
−
<ol>
 
−
<li>Click the [[Image:FieldTemplateIcon.png]] button. The Add Report Template window displays.</li>
 
−
[[Image:fig84.png|500px|center]]
 
−
<li>Enter a name for the IMSMA report template in the '''Name''' field.</li>
 
−
<li>Enter a description for the IMSMA report template in the '''Description''' field.</li>
 
−
<li>Select the iReport template that you would like to associate with IMSMA report template by doing the following:</li>
 
−
<li>Click the '''Browse''' button.</li>
 
−
<li>Navigate to the directory where the iReport '''.jrxml''' files are saved.</li>
 
−
<li>Select the '''.jrxml''' file associated with the iReport template. You do '''not''' need to include any .jasper file. {{IMSMANG}} will not be able to read a .jasper file.</li>
 
−
<li>Click the '''Open''' button.</li>
 
−
:The name of the .jrxml file displays in the File field.
 
−
<li>Click the '''Save''' button.</li>
 
−
{{note| If you select a template that has sub-reports in a different folder, you will be prompted to select the sub-report after the save button is pressed.}}
 
−
</ol>
 
−
 
 
−
==Preview, Change and Remove iReport Templates==__NOEDITSECTION__
 
−
iReport templates can be previewed, changed and removed using the following buttons in the Report Template Manager window.
 
 
<center>
 
<center>
 
{| class="wikitable" width="600"
 
{| class="wikitable" width="600"
 
|-
 
|-
−
| align="center" colspan="2" | '''Preview, Change and Remove Buttons in the Report Template Manager'''
+
| align="center" colspan="2" | '''Overview of functions for iReport template definitions'''
 
|-
 
|-
 
| width="55pt" | '''Button'''
 
| width="55pt" | '''Button'''
 
| width="475pt" | '''Description'''
 
| width="475pt" | '''Description'''
 
|-
 
|-
−
| align="center"| [[Image:ViewIcon.png | Preview]] || Allows you to preview a report template. This will preview the layout, but no data will be included.
+
| align="center"| [[Image:Run.png | Run]] || Allows you to create a report. This function may also be started from the Reports menu and is described [[Add Reports in IMSMA | ''' here''']].
 +
|-
 +
| align="center"| [[Image:ViewIcon.png | Preview]] || Allows you to preview a iReport template. This will [[Preview an iReport Template in IMSMA | preview]] the layout, but no data will be included.
 +
|-
 +
| align="center"| [[Image:FieldTemplateIcon.png | Add]] || Allows you to [[Delete an iReport Template Definition from IMSMA Database | add]] an iReport template definition to the {{IMSMANG}} database.
 
|-
 
|-
−
| align="center"| [[Image:FieldViewIcon.png | Edit]] || Allows you to update the existing report template, for example for assigning it a new name, or changing the .jrxml template file. If you change the .jrxml template file, it has to be changed to a template that uses the same type, that is, you cannot change from a "Location" report to a "Land" report.
+
| align="center"| [[Image:FieldViewIcon.png | Edit]] || Allows you to [[View or Change an iReport Template Definition in IMSMA | update]] an existing iReport template definition, for example for assigning it a new name, or changing the .jrxml template file. If you change the .jrxml template file, it has to be changed to a template that uses the same type, that is, you cannot change from a "Location" report to a "Land" report.
 
|-
 
|-
−
| align="center" | [[Image:EcksButton.png | Delete]] || Allows you to delete a report template. You can only delete a report template if there is no report in IMSMA building on that template, because then the report would get unusable. Therefore, if you really would like to delete a template, you have to first delete all the associated reports.
+
| align="center" | [[Image:EcksButton.png | Delete]] || Allows you to [[Delete an iReport Template Definition from IMSMA Database | delete]] an iReport template definition. You can only delete a report template if there is no report in IMSMA building on that template definition. Therefore, if you really would like to delete an iReport template definitions, you have to first delete all the associated reports.
 
|}
 
|}
 
</center>
 
</center>
 
{{NavBox HowTo Produce Reports}}
 
{{NavBox HowTo Produce Reports}}
−
[[Category:VIE]]
+
[[Category:NAA]]

Latest revision as of 20:30, 20 February 2020

iReport templates provide the foundation on which IMSMA reports are based. A iReport template defines:

  • the data source (e.g. Land, Activity, Accident)
  • the attributes that should be displayed on the report (e.g. Land ID, Land Name and Areasize for a land report)
  • the overall appearance of the report (title, formatting, etc.)

How to create and edit iReport templates with the iReport tool may be found here.

The Report Template Manager allows adding, changing and deleting iReport template definitions. To access the Report Template Manager, choose Customisation > Report Template Manager.

This opens the Report Template Manager.

ReportTemplatesWindow.png
Overview of functions for iReport template definitions
Button Description
Run Allows you to create a report. This function may also be started from the Reports menu and is described here.
Preview Allows you to preview a iReport template. This will preview the layout, but no data will be included.
Add Allows you to add an iReport template definition to the IMSMANG database.
Edit Allows you to update an existing iReport template definition, for example for assigning it a new name, or changing the .jrxml template file. If you change the .jrxml template file, it has to be changed to a template that uses the same type, that is, you cannot change from a "Location" report to a "Land" report.
Delete Allows you to delete an iReport template definition. You can only delete a report template if there is no report in IMSMA building on that template definition. Therefore, if you really would like to delete an iReport template definitions, you have to first delete all the associated reports.
Producing Reports Using IMSMANG
Manage Report Templates in IMSMA
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Manage_Report_Templates_in_IMSMA&oldid=24438"