...
Parametername | Verwendungszweck | Beispiel | ||
---|---|---|---|---|
Name | Interner Name der Vorlage. Dieser Name wird u.a. verwendet, um aus der auf sem Server hinterlegten .jrxml-Datei die ausführbaren Dateien zu erzeugen.
| musterReport20 | ||
Beschreibung | Beschreibung des Reports | |||
Dateipfad | Absoluter Pfad der .jrxml Datei auf dem Server.
| /home/jboss/reports/musterTemplate.jrxml | ||
XML-Datei | nicht implementiert | muss leer bleiben | ||
Report-Klasse | System-Klasse, für die der Report verwendet werden kann. | de.iconcept.nami.entity.abrechnung.Rechnung | ||
Subreport-ID | Kontext-spezifische ID eines Report anhand einer übergebenen Kontextvariablen. Beispiel: Bei der Erstellung einer Ausgangsrechnung wird als Kontext-ID die ID der Gruppierung, die die Ausgangsrechnung erstellt hat, übergeben. Existiert nun ein Eintrag mit der Subreport-ID 20, dann wird nicht die Standardvorlage verwendet, sondern die spezifische Vorlage. | 20 | ||
Recht | Auswahl eines (funktionalen, nicht gruppierungsbeschränkten) Rechts, über das ein Benutzer verfügen muss, um den Report ausführen zu können. | |||
Standard Ergebnistyp | Standard Mime-Typ des Ergebnisses (PDF, XLS). Ab Version 1.5.1.6, Unterstützung bei der Reportausführung (Gruppierung), ab Version 1.5.1.7 |
Vorlagen verwalten - Dateien ersetzen
Will man eine existierende Report-Vorlage überschreiben, muss zuerst der neue Report im Verzeichnis
/home/jboss/reports
abgelegt werden (s.o.).
...
Note |
---|
Falls die existierenden Dateien im Unterverzeichnis ./build nicht gelöscht wurden, werden die "alten" Dateien weiterverwendet. |
Besonderheiten beim Arbeiten mit Sub-Reports
Das System unterstützt Vorlagen, die mit Sub-Reports arbeiten, nicht automatisch. Wird ein solcher Report wie oben beschrieben in das Verzeichnis /home/jboss/reports/ geladen, so kann er nicht ausgeführt werden.
Um einen Report mit Sub-Reports lauffähig zu bekommen, müssen zusätzlich alle Sub-Reports als .jasper-Dateien in das Unterverzeichnis
/home/jboss/reports/build
gelegt werden.
Sicherheit - Beschränkung des Datenzugriffs
...
Eine Datenbank für die Bearbeitung von Reports ist nicht notwendig. Allerdings liefert der Preview dann natürlich keine Ergebnisse.
...
Parameter / Eingabemaske
Parameter für die Eingabe durch den Benutzer, der den Report ausführt (bzw. verborgene Parameter bei Gruppierungsspezifischen Reports) werden nach folgendem Schema definiert:
<parameter name="´Mitglied_ID" class="java.lang.Long"/>
In der Maske wird dann "Mitglied_ID" bei dem jeweiligen Feld angezeigt.
Note |
---|
Wichtige Hinweise:
|
Note |
---|
Ab Version 1.5.1.5 wird der Zeitstempel des Orginalreports gegen die compilierten Versionen geprüft. Ist dieser neuer wird der Report automatisch neu übersetzt. Dies gilt NICHT für Subreports in einem Report. Diese müssen IMMER compiliert im build Verzeichnis liegen. Dies gilt auch für referenzierte Style-Dateien und eingebettete Bilder. |
Schriften
Bei Änderungen an den Reports sollte unbedingt darauf geachtet werden, dass nicht alle Schriftarten (Fonts), die ggf. im Report Designer angeboten werden, verwendbar sind. Verwendet werden können nur diejenigen Schriftarten, die auf dem Server, auf dem der Report später erzeugt wird, auch installiert sind. Da die Font-Dateien sind nicht Bestandteil der Reportvorlage sind (da die Weitergabe von Fonts ggf. rechtlichen Beschränkungen unterliegen kann), sollte die Reporterzeugung in jedem Fall auf dem Zielsystem geprüft werden.
...
Courier
Courier-Bold
Courier-BoldOblique
Courier-Oblique
Helvetica
Helvetica-Bold
Helvetica-BoldOblique
Helvetica-Oblique
Symbol
Times-Roman
Times-Bold
Times-BoldItalic
Times-Italic
ZapfDingbats
Bilddateien in Reports
Bilddateien - wie etwa Logos - die im Report verwendet werden, müssen ins Build-Verzeichnis (z.B. /home/jboss/reports/build) kopiert werden und die Pfade im Report müssen entsprechend gesetzt werden (nicht absolut angeben).
Style Dateien
Für Style-Dateien (.jrtx) gilt das gleiche, wie für Bilddateien. Die Style-Datei muss im "/build" Unterverzeichnis abgelegt sein, da der Report im Build-Verzeichnis erzeugt wird und die referenzierte Style-Datei von hier aus relativ gefunden werden muss.
Beispieldatenbank
Eine Beispieldatenbank dient dazu, sich die Ergebnisse von Änderungen an Vorlagen sinnvoll ansehen zu können. Beispieldatenbank auf dem Produktivsystem erzeugen über folgende shell-Kommandos:
user=LIVE_USER
db=LIVE_DB
host=LIVE_HOSTmysqldump -u $user -p -h $host $db Rechnung RechnungsItem LinkableEntry \
ZahlungsKondition BeitragsSatz BeitragsArt BeitragsKonto BeitragsZahlung> ica_report_data.sql
Typische Fehlerquellen
LeinKlein-/großschreibungGroßschreibung: Der Report wird auf einer Windows-Umgebung erstelltl, dann unterscheidet die Maysql Mysql / MariaDB Datenbank (im Standard) bei Tabellennamen keine Groß- und Kleinschreibung. Die Unix-Zielumgebung ist jedoch immer case-sensitive, d.h. der Report, bzw. die Abfragen des Reports funktionieren dann nicht.
Schriften: Die Schriftarten, die über "Styles" definiert sein sollten, stehen auf dem Zielsystem nicht zur Verfügung, der Report kann dann nicht erzeugt werden.
Bilder, andere Objekte: Falls diese nicht ins Zielverzeichnis (/home/jboss/reports/build) mitkopiert wurden oder die Pfade im Report absolut angegeben wurden, kann der Report nicht erzeugt werden.
...
Standard-Vorlagen für die Abrechnung
Siehe dazu Modul Vorlagen.
Note |
---|
Hinweis: Beim Report für die Mitgliedsabrechnung muss bei der Klassen-Defintion (Feld: Report-Klasse) die Klasse de.iconcept.nami.entity.abrechnung.RechnungMgl gesetzt werden. |
Ausführen von Reports
Vorausgesetzt, der Benutzer verfügt über entsprechende Rechte, kann ein Report in der Liste markiert und mit rechtem Mausklick über
...
ausgeführt werden. Es öffnet sich eine Maske mit den jeweils im Report definierten Eingabeparametern (siehe Modul Vorlagens.o.).
Der Report wird anschließend als PDF-Datei (oder .xls-Datei) zum Download angeboten:
...
Zum Ausführen von gruppierungsspezifischen Reports siehe Reports (Gruppierung).
Mögliche Fehlerquellen:
Info |
---|
Ab Version 1.5.1. |
...
5 gibt wird nur noch ein Link angeboten. "Ausführen generisch". Das Formular enthält jetzt die Auswahl für den Ergebnistyp (PDF oder xls). |
Reportparameter
Ab Version 1.5.1.5 unterstützt das System die Verwendung von Reportparametern. Dazu muss der Systemparameter "REPORT_USE_ICA_PARAMTER" gesetzt sein (siehe auch: Systemkonfiguration)
Bei Anlage, bzw. Änderung eines Reports werden die Reportparameter ausgelesen und in der Datenbank abgelegt.
Bedeutung
Für jeden Reportparameter können folgende Werte bestimmt werden:
Feld | Bedeutung | |
---|---|---|
Anzeigename | Abweichender Name für den Parameter bei Ausführung des Reports (nur für die Anzeige). Der vom Benutzer eingegebene Wert wird dem Report nach wie al "Parameter Name" übergeben | |
Reihenfolge | Reihenfolge, in der der Parameter im Eingabeformular angezeigt werden soll | |
Parametertyp |
|
Geändertes Verhalten bei Verwendung von Reportparametern
Wenn ein Report ausgeführt wird
Rechte
Für die Verwaltung der Report-Parameter werden die Rechte (ID Menu: 150 und zugehörige ID Rechte) benötigt. Für die automatische Anlage, bzw. Aktualisierung reicht das entsprechende Report Recht.
Jasper Report Versionen
Stand: 09.04.2019
ICA Version | Jasper Report Engine (Version der jrxml Datei) | Entwicklungsumgebung Reports | Bemerkungen |
---|---|---|---|
ica-1.5.x | bis Version 5.5 (jrxml Dateien mit Versionsformat 5.1 bis 5.5) |
|