[[Category:ReadyMadeJobs]][[Category:JobSchedulerJasperReportJob]]
===Description of JobSchedulerJasperReportJob - Create Report with JasperReport===
This job uses JasperReports (see http://jasperreports.sourceforge.net) to ceate a report file from a report configuration.
Report configurations are usually created with a visual editor such as iReport (see http://ireport.sourceforge.net).
The database connection of the Job Scheduler is used or alternatively a configurable database connection can be used to query report data.
TODO:Die Berichtsdaten können zusätzlich mittels Job Parameter generiert werden. Alle Jobparameter werden den JasperReport als Parameter zum Weiterverarbeiten weitergegeben.
This job supports the report formats PDF, HTML, RTF, XML and XLS.
Adding the -Djava.awt.headless=true to your Job: <job title="Create JasperReport for Application Manager" java_options="-Djava.awt.headless=true">
An example for a job-xml file:
<job order='no' >
<params>
<param name="[[#settings_filename|settings_filename]]" value="" />
<param name="[[#report_filename|report_filename]]" value="" />
<param name="[[#query_filename|query_filename]]" value="" />
<param name="[[#query_statement|query_statement]]" value="" />
<param name="[[#parameter_query_filename|parameter_query_filename]]" value="" />
<param name="[[#output_type|output_type]]" value="pdf" />
<param name="[[#output_filename|output_filename]]" value="" />
<param name="[[#printer_name|printer_name]]" value="" />
<param name="[[#printer_copies|printer_copies]]" value="1" />
<param name="[[#mail_it|mail_it]]" value="false" />
<param name="[[#mail_to|mail_to]]" value="" />
<param name="[[#mail_cc|mail_cc]]" value="" />
<param name="[[#mail_bcc|mail_bcc]]" value="" />
<param name="[[#mail_subject|mail_subject]]" value="config/default.xslt" />
<param name="[[#mail_body|mail_body]]" value="" />
<param name="[[#suspend_attachment|suspend_attachment]]" value="false" />
<param name="[[#report_locale|report_locale]]" value="de" />
<param name="[[#any additional parameters|any additional parameters]]" value="" />
</params>
<script language="java" java_class="sos.stacks.jasperreports.JobSchedulerJasperReportJob" />
</job>
===Parameter used by JobSchedulerJasperReportJob===
{| border="1"
|+ List of parameter
! ! Name || title || mandatory || default
|-
| [[#settings_filename|settings_filename]]
|
| false
|
|-
| [[#report_filename|report_filename]]
|
| true
|
|-
| [[#query_filename|query_filename]]
|
| false
|
|-
| [[#query_statement|query_statement]]
|
| false
|
|-
| [[#parameter_query_filename|parameter_query_filename]]
|
| false
|
|-
| [[#output_type|output_type]]
|
| false
| pdf
|-
| [[#output_filename|output_filename]]
|
| true
|
|-
| [[#printer_name|printer_name]]
|
| false
|
|-
| [[#printer_copies|printer_copies]]
|
| false
| 1
|-
| [[#mail_it|mail_it]]
|
| false
| false
|-
| [[#mail_to|mail_to]]
|
| false
|
|-
| [[#mail_cc|mail_cc]]
|
| false
|
|-
| [[#mail_bcc|mail_bcc]]
|
| false
|
|-
| [[#mail_subject|mail_subject]]
|
| false
| config/default.xslt
|-
| [[#mail_body|mail_body]]
|
| false
|
|-
| [[#suspend_attachment|suspend_attachment]]
|
| false
| false
|-
| [[#report_locale|report_locale]]
|
| false
| de
|-
| [[#any additional parameters|any additional parameters]]
|
| false
|
|}
====Parameter settings_filename: ====
----
This parameter specifies the path and name of a configuration file for database connection settings. If such a file is specified then its database connection settings are used for the report query, otherwise the Job Scheduler database connection is used.
Data-Type :
====Parameter report_filename: ====
----
This parameter specifies the path and name of a file containing the report configuration. The source code of a configuration files is organized as xml document and is usually stored with the extension .jrxml . You should assign to this parameter the compiled configuration file name that is usually stored with the extension .jasper .
Data-Type :
This parameter is mandatory.
====Parameter query_filename: ====
----
This parameter specifies the path and name of an input file with sql statements. If this parameter is assigend a file name then the query given in this file will be used for the report insted of the query that has been given in the report configuration file, see report_filename .
Data-Type :
====Parameter query_statement: ====
----
The value of this parameter is a sql statement encoded with base64. This value will be decoded and used for the report query.
The parametersquery_filenameandquery_statementare mutually exclusive, as sql statements can be used from one of these sources only.
Data-Type :
====Parameter parameter_query_filename: ====
----
This parameter specifieds the name of a file with sql statements. Should a filename be assigned to this parameter then the query will be executed and the result set will be handed to JasperReports as parameters.
Data-Type :
====Parameter output_type: ====
----
This parameter specifies the output type of the report:
* PDFThe report will be created as pdf file.
* HTMThe report will be created as HTML file preferably for browsers. This format is not perfectly suitable for printing as no separate pages are created.
* RTFThe report is created in Rich Text Format for word processors as MS Office, OpenOffice etc.
* XMLThe report is created as xml document.
* XLSThe report is created for MS Excel.
The output type is independent from the file name given for the report file, you should choose a suitable file name and extension for the parameter output_filename .
Data-Type :
The default value for this parameter is '''pdf'''.
====Parameter output_filename: ====
----
This parameter specifies the path and name of the report file that is created by this job.
Data-Type :
This parameter is mandatory.
====Parameter printer_name: ====
----
Should a value be assigned to this parameter then the generated report will be printed to a printer with this name. If the printer name contains the prefixfactory:then the printer will not be looked up in the operating system, but will be matched to the name of a print queue and corresponding printer name in the Document Factory.
Data-Type :
====Parameter printer_copies: ====
----
The number of copies to be printed. The value of this parameter has to contain digits with a value greater 0. This parameter is considered if a printer name has been specified, see parameterprinter_name.
Data-Type :
The default value for this parameter is '''1'''.
====Parameter mail_it: ====
----
Should this parameter be assigned the value true , then reports will by sent by mail with the built-in mail function of the Job Scheduler.
Additional parameters are considered asmail_to,mail_cc,mail_bcc,mail_subjectandmail_bodythat specify the recipients and the format of mails. Should these additional parameters be missing then the values are used from the respective settings in the configuration filefactory.ini.
Should the value false be assigned to this parameter then mails will be sent with the java class SOSMailOrder , if one of the parametersmail_to,mail_cc,mail_bcc,mail_subjectormail_bodyhas been specified. Prerequisites for the use of SOSMailOrder are:
* 1. Database connection (of the Job Scheduler)
* 2. TableSETTINGS
* 3. Entries for mail forwarding in tableSETTINGS
These requirements are met if the componentManaged Jobshas been selected during installation of the Job Scheduler.
Recipients, subject and body of mails are always applied from job parameters, not from settings.
Data-Type :
The default value for this parameter is '''false'''.
====Parameter mail_to: ====
----
One or more mail addresses of recipients of a report. Multiple addresses are separated by commas. Should this setting be left empty, then no reports will be sent by mail. The reports will however be generated and saved to disk.
Data-Type :
====Parameter mail_cc: ====
----
One or more mail addresses of recipients of carbon copies of a report. Multiple addresses are separated by commas.
Data-Type :
====Parameter mail_bcc: ====
----
One or more mail addresses of recipients of blind carbon copies of a report. Multiple addresses are to be separated by commas.
Data-Type :
====Parameter mail_subject: ====
----
This parameter specifies the subject of mails that is used to send reports. This parameter is mandatory should reports be sent by mail.
Automated substitutions in the parameter value are optionally specified using one of the following prefixes:
* factory:
* factory_file:
* plain:
* plain_file:
Should no prefix be specified then the value of this parameter is used without changes. Should a prefix be specified then the value may contain placeholders that are automatically substituted at run time. As a prerequisite of the prefixes factory: and factory_file: the Document Factory product has to be installed.
The following placeholders can be used, surrounded by square brackets
[] :
* [date] - the current date
* [datetime] - the current date and time
* [orderid] - the order ID
* [jobname] - the job name
* [taskid] - the task ID
This parameter specifies the report body of mails that is used to send reports. This parameter is mandatory should reports be sent by mail.
Automated substitutions in the parameter value are optionally specified using one of the following prefixes:
* factory:
* factory_file:
* plain:
* plain_file:
Should no prefix be specified then the value of this parameter is used without changes. Should a prefix be specified then the value may contain placeholders that are automatically substituted at run time. As as rerequisite of the prefixes factory: and factory_file: the Document Factory product has to be installed.
The following placeholders can be used, surrounded by square brackets
[] :
* [date] - the current date
* [datetime] - the current date and time
* [orderid] - the order ID
* [jobname] - the job name
* [taskid] - the task ID
* [sql] - SQL query for which the report has been generated
* [xml] - xml format of the query result before any transformation is applied
Note that the value of this parameter will be ignored, should the parameterscheduler_order_report_asbodybe set to true : in this case the content of the report is used as mail body.
Prevents reports from being sent as mail attachments if the value true is specified.
Data-Type :
The default value for this parameter is '''false'''.
====Parameter report_locale: ====
----
This parameter is used to dynamically assign language files to reports that support multiple languages. Such language files are created per report and have to be located in the same directory as the report definition. Language file names follow this schema:
<report file>_<language>.properties
An example:
A report summary.jasper could use the following language files:
* summary.properties(default language file)
* summary_en.properties(english language file)
* summary_de.properties(german langauge file)
Should no language files be specified then the default language file will be used. The name of the default language file is summary.properties . Language files contain pairs of key=value , e.g.
* text.orders_from=orders dated from
* text.to=to
Please translate the right side of this assignment into the target language. The left side contains the name of the variable that is used in the report definition and that is substituted when the report is generated. The German version of this example could be:
* text.orders_from=Bestellungen von
* text.to=bis
Data-Type :
The default value for this parameter is '''de'''.
====Parameter any additional parameters: ====
----
Any additional job parameters may be specified that are automatically handed to JasperReports and will be substituted in a report.
Data-Type :
This article was last modified on (mm/dd/yyyy) {{REVISIONMONTH}}/{{REVISIONDAY}}/{{REVISIONYEAR}}.
[[File:Wiki-rabbit-left.jpg]] << [[JobScheduler_FAQ| back to all FAQs]]