Der Parameter benennt den Pfad und Namen einer Konfigurationsdatei für
Datenbankverbindungen. Wird eine solche Datei angegeben, dann wird
die dort konfigurierte Datenbankverbindung zur Abfrage der Daten
für den Report verwendet, andernfalls die Datenbankverbindung des Job Schedulers.
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.
Der Parameter spezifiziert den Pfad und Namen einer Datei,
die die Report-Konfiguration enthält. Der Quell-Code der Konfigurationsdatei ist im XML Format organisiert
und wird meist mit der Endung
.jrxml
abgelegt. Weisen Sie diesem Parameter die kompilierte
Konfigurationsdatei zu, die meist mit der Endung
.jasper
gespeichert wird.
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
.
Der Parameter benennt den Pfad und Namen einer Eingabedatei mit SQL-Statements.
Wird dem Parameter ein Dateiname zugewiesen, dann wird die
in dieser Datei enthaltene Abfrage für den Report verwendet anstelle der in der Berichtskonfiguration
enthaltenen Abfrage, siehe Parameter
report_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
.
Der Wert des Parameters ist ein in base64 encodiertes SQL-Statement.
Der Wert wird zunächst decodiert und anschließend die Abfrage
für JasperReport verwendet.
Die Parameter
query_filename
und
query_statement
dürfen nicht gleichzeitig angegeben werden,
da SQL-Statements nur aus einer dieser beiden Quellen stammen können.
The value of this parameter is a sql statement encoded with base64. This value will be decoded
and used for the report query.
The parameters
query_filename
and
query_statement
are mutually exclusive,
as sql statements can be used from one of these sources only.
Der Parameter gibt den Namen einer Datei mit SQL-Statements an.
Ist dem Parameter ein Dateiname zugewiesen, dann wird die Abfrage ausgeführt
und das Resultat der Abfrage JasperReports als Parameter übergeben.
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.
Der Parameter spezifiziert den Ausgabetyp des Reports:
-
PDF
Der Report wird als PDF-Datei generiert.
-
HTM
Der Report wird im Format HTML vorwiegend für Browser erzeugt.
Dieses Format ist nicht seitenorientiert aufgebaut und
daher weniger für Druckausgaben geeignet.
-
RTF
Der Report wird im Rich Text Format für Textsysteme wie MS Office, OpenOffice etc. erzeugt.
-
XML
Der Report wird im XML-Format erzeugt.
-
XLS
Der Report wird im Format für MS Excel erzeugt.
Der Ausgabetyp ist unabhängig vom gewählten Dateinamen des Reports,
den Sie passend im Parameter
output_filename
angeben sollten.
This parameter specifies the output type of the report:
-
PDF
The report will be created as pdf file.
-
HTM
The report will be created as HTML file preferably for browsers.
This format is not perfectly suitable for printing
as no separate pages are created.
-
RTF
The report is created in Rich Text Format for word processors as MS Office, OpenOffice etc.
-
XML
The report is created as xml document.
-
XLS
The 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
.
Der Parameter spezifiziert den Pfad und Namen der Report-Datei, die
von diesem Job erzeugt wird.
This parameter specifies the path and name of the report file
that is created by this job.
Wird diesem Parameter ein Wert zugewiesen, dann wird der generierte Report über diesen Druckernamen
gedruckt. Wenn der Druckername das Prefix
factory:
enthält, dann wird dieser Druckername
nicht direkt im Betriebssystem gesucht, sondern über die Document Factory aus dem Namen
einer Druckerwarteschlange und dem dort konfigurierten Druckernamen ermittelt.
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 prefix
factory:
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.
Anzahl zu druckender Exemplare. Der Wert des Parameters muss aus Ziffern bestehen größer 0 sein.
Der Parameter wird nur berücksichtigt, wenn ein Druckername angegeben ist, siehe Parameter
printer_name
.
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 parameter
printer_name
.
Wird für diesen Parameter der Wert
true
angegeben, dann werden mit
der eMail-Funktion des Job Schedulers Reports per eMail versendet.
Es wird berücksichtigt, falls zusätzlich
die Parameter
mail_to
,
mail_cc
,
mail_bcc
,
mail_subject
und
mail_body
angegeben
sind, die den Empfänger und das Format spezifizieren.
Wenn diese Parameter fehlen, dann werden diese Angaben aus den Einstellungen
der Konfigurationsdatei
factory.ini
entnommen.
Enthält der Job-Parameter
mail_it
nicht den Wert
true
,
dann werden eMails mit Hilfe der Java-Klasse
SOSMailOrder
versendet,
falls einer der Parameter
mail_to
,
mail_cc
,
mail_bcc
,
mail_subject
oder
mail_body
angegeben ist.
Voraussetzungen zum eMail-Versand mit der Klasse
SOSMailOrder
sind:
- 1. Datenbankverbindung (des Job Schedulers)
-
2. Tabelle
SETTINGS
-
3. Einträge zum eMail-Versand in der Tabelle
SETTINGS
Diese Voraussetzungen sind durch die Installation der Komponente
Managed Jobs
bei
der Installation des Job Schedulers gegeben.
Die Empfänger, der Betreff und der Inhalt der Nachricht werden grundsätzlich
aus Job-Parametern verarbeitet, nicht aus Einstellungstabellen.
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 as
mail_to
,
mail_cc
,
mail_bcc
,
mail_subject
and
mail_body
that 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 file
factory.ini
.
Should the value
false
be assigned to this parameter then mails will be sent with
the java class
SOSMailOrder
, if one of the parameters
mail_to
,
mail_cc
,
mail_bcc
,
mail_subject
or
mail_body
has been specified.
Prerequisites for the use of
SOSMailOrder
are:
- 1. Database connection (of the Job Scheduler)
-
2. Table
SETTINGS
-
3. Entries for mail forwarding in table
SETTINGS
These requirements are met if the component
Managed Jobs
has been selected
during installation of the Job Scheduler.
Recipients, subject and body of mails are always applied from job parameters, not from settings.
Geben Sie hier eine oder mehrere eMail-Adressen an, die den Report erhalten.
Mehrere eMail-Adressen werden durch Komma getrennt.
Ist diese Einstellung leer, dann werden Reports nicht per eMail versendet.
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.
Geben Sie hier eine oder mehrere eMail-Adressen an, die den Report als carbon copy erhalten.
Mehrere eMail-Adressen werden durch Komma getrennt.
One or more mail addresses of recipients of carbon copies of a report. Multiple addresses are separated by commas.
Geben Sie hier eine oder mehrere eMail-Adressen an, die den Report als blind carbon copy erhalten.
Mehrere eMail-Adressen werden durch Komma getrennt.
One or more mail addresses of recipients of blind carbon copies of a report. Multiple addresses are to be separated by commas.
Der Inhalt des Parameters wird als Betreff der eMail des
Reports verwendet und muss ausgefüllt sein.
Für diesen Parameter können automatische Ersetzungen vereinbart werden,
in dem eines der folgenden Präfixe zugeordnet wird:
- factory:
- factory_file:
- plain:
- plain_file:
Ist kein Präfix angegeben, dann wird der Inhalt des Parameters ohne Änderung übernommen.
Ist ein Präfix angegeben, dann können im Wert des Parameters Platzhalter
vorhanden sein, die beim Versenden per eMail automatisch ersetzt werden.
Voraussetzung für das Verwenden der Präfixe
factory:
bzw.
factory_file:
ist die Installation des Produkts Document Factory.
Nach den Präfixen factory_file: und plain_file: werden die Pfade für Vorlagen angegeben.
z.B. factory_file:C:\factory\templates\Vorlage.txt
Der Unterschied von factory_file: bzw. plain_file: und factory: bzw. plain:
ist das Ablegen der Vorlagen einmal in einem Verzeichnis im Dateisystem und in einer Datenbanktabelle.
Es können folgende Platzhalter verwendet werden, die durch
[]
geklammert werden:
- [date] - aktuelles Datum
- [datetime] - aktuelles Datum und Uhrzeit
- [orderid] - ID des Auftrags
- [jobname] - Name des Jobs
- [taskid] - ID der Task
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.
Having specified the prefixes factory_file: or plain_file: the path for a template
should be given, e.g.
factory_file:C:\factory\templates\Vorlage.txt.
For the prefixes factory_file: and plain_file: the templates are looked up in the file system.
For the prefixes factory: and plain: templates are looked up in a database table.
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
Mit diesem Parameter kann das Layout des Nachrichteninhalts
des Reports im HTML-Format oder als plain text angegeben werden.
Für diesen Parameter können automatische Ersetzungen vereinbart werden,
in dem eines der folgenden Präfixe zugeordnet wird:
- factory:
- factory_file:
- plain:
- plain_file:
Ist kein Präfix angegeben, dann wird der Inhalt des Parameters ohne Änderung übernommen.
Ist ein Präfix angegeben, dann können im Wert des Parameters Platzhalter
vorhanden sein, die beim Versenden per eMail automatisch ersetzt werden.
Voraussetzung für das Verwenden der Präfixe
factory:
bzw.
factory_file:
ist die Installation des Produkts Document Factory.
Nach den Präfixen factory_file: und plain_file: werden die Pfade für Vorlagen angegeben.
z.B. factory_file:C:\factory\templates\Vorlage.txt
Der Unterschied von factory_file: bzw. plain_file: und factory: bzw. plain:
ist das Ablegen der Vorlagen einmal in einem Verzeichnis im Dateisystem und in einer Datenbanktabelle.
Es können folgende Platzhalter verwendet werden, die durch
[]
geklammert werden:
- [date] - aktuelles Datum
- [datetime] - aktuelles Datum und Uhrzeit
- [orderid] - ID des Auftrags
- [jobname] - Name des Jobs
- [taskid] - ID der Task
- [sql] - SQL-Abfrage, aus der der Report erstellt wurde
- [xml] - aus dem Ergebnis der Abfrage generiertes xml vor der Transformation
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.
Having specified the prefixes factory_file: or plain_file: the path for a template
should be given, e.g.
factory_file:C:\factory\templates\Vorlage.txt.
For the prefixes factory_file: and plain_file: the templates are looked up in the file system.
For the prefixes factory: and plain: templates are looked up in a database table.
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 parameter
scheduler_order_report_asbody
be set to
true
:
in this case the content of the report is used as mail body.
Unterdrückt das Versenden von Reports als Anhang von eMails, wenn der Wert
true
angegeben ist.
Prevents reports from being sent as mail attachments if the value
true
is specified.
Dieser Parameter wird verwendet, um mehrsprachigen Reports dynamisch eine Sprache zuzuordnen.
Dazu können Sprachdateien für einen Report definiert werden.
Die Sprachdatei muss in dem selben Verzeichnis abgelegt sein wie die Report-Definition.
Der Name der Sprachdatei wird folgendermaßen aufgebaut:
<report datei>_<sprache>.properties
Ein Beispiel:
Ein Bericht
auswertungen.jasper
kann folgende Sprachdateien besitzen:
-
auswertungen.properties
(Default Sprachdatei)
-
auswertungen_en.properties
(englische Sprachdatei)
-
auswertungen_de.properties
(deutsche Sprachdatei)
Sind keine Sprachdateien angegeben, dann wird die Default Sprachdatei verwendet.
Der Name der Default Sprachdatei lautet hier
auswertungen.properties
.
Die Sprachdateien sind aufgebaut aus Paaren
key=value
, z.B.
-
text.bestellungen_von=Bestellungen von
-
text.bis=bis
Bitte hier nur die rechte Seite der Zuweisung in die gewünschte Sprache übersetzen.
Die linke Seite enthält Variablennamen für Reports,
die beim Formattieren ersetzt werden. Das obige Beispiel wird in Englisch übersetzt:
-
text.bestellungen_von=orders dated from
-
text.bis=to
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
Es können beliebige zusätzliche Job-Parameter angegeben werden, die automatisch
an JasperReports weitergegeben und in einem Report ersetzt werden.
Any additional job parameters may be specified that are automatically handed to JasperReports
and will be substituted in a report.