Mit dem Reports-Modul können auf Basis von mit dem JasperSoft iReport-Designer (http://community.jaspersoft.com/project/ireport-designer) erstellten Reportdateien verfügbar gemacht und zentral (in diesem Interface) oder gruppierungsbasiert (in der Gruppierungsverwaltung) ausgeführt werden.

Der Unterschied zwischen dem Modul "Vorlagen" und dem Modul "Reports" besteht daran, dass unter "Reports" auch das Ausführen eines Reports möglich ist. Bezüglich der Verwaltung von Reports sind beide Interfaces ansonsten identisch.

Reports dürfen nicht mit Berichten verwechselt werden (siehe Modul Berichte). Die Berichte stehen im Rahmen der Suchmaske (siehe Suche) zur Verfügung, um Reports für die Suchergebnisliste einer Suche zu erstellen und basieren auf einer anderen Technologie. Das Reports-Modul hingegen erlaubt es, im Backend des Systems im Prinzip beliebige Reports auf den Daten der Datenbank zu fahren.

Funktionsweise

Das Modul basiert auf den JasperReports Bibliotheken (freier Report-Designer unter http://community.jaspersoft.com/project/ireport-designer). Dabei werden .jrxml Dateien (Report-Vorlagen), die auf der Server-Umgebung zur Verfügung stehen - falls notwendig - zur Laufzeit (bei Report-Erzeugung) übersetzt. Danach wird der Report ausgeführt. Dazu stellt das System die aktuelle Datenbankverbindung und die benötigten Laufzeitparameter (Reporting-Parameter) zur Verfügung. Die Reporting-Parameter sind dabei von System-Seite definiert und nicht von Report-Seite.

Vorlagen verwalten - Anlegen & Bearbeiten von Reports

Nachdem ein Report als .jrxml-Datei erstellt wurde (s.u.), muss der Report physisch an der definierten Stelle im Dateisystem abgelegt werden; es ist im Moment nicht möglich, Reports direkt hochzuladen.

Damit Vorlagen verwendet werden können, müssen diese dem System anschließend bekannt gemacht werden, indem im Interface ein neuer Report angelegt wird. Folgende Parameter müssen definiert sein:

Parametername	Verwendungszweck	Beispiel
Name	Intern: Interner Name der Vorlage zur Identifikation im System-Logging. Es sind nur alphanumerische Zeichen zulässige. Keine Leerzeichen. Das Name muss eindeutig sein.	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.

Die Übersetzung der Report-Dateien erfolgt im Verzeichnis

/home/jboss/reports/build

Erforderlich sind Lese- und Schreibberechtigung für den Benutzer, unter dem der Application Server läuft. Bei der Erzeugung der Reports entstehen im Verzeichnis /tmp ebenfalls temporäre Dateien. Diese sollten bzw. müssen regelmäßig über einen Systemjob (cron-job) aufgeräumt werden.

Sicherheit - Beschränkung des Datenzugriffs

Da das Reporting Modul ggf. Zugriff auf sämtliche Daten benötigt, ist eine Rechtekontrolle innerhalb der Daten, die für einen Report verwendet werden, nicht mehr möglich. Das bedeutet, dass der Benutzer, der einen Report erstellt, sich um das Thema Datensicherheit kümmern muss, insbesondere bei gruppierungsspezifischen Reports. Reports können nur von Benutzern mit entsprechenden Rechten angelegt werden, außerdem müssen die Report-Dateien physikalisch auf dem Server abgelegt werden.

Vorlagen verwalten - Dateien ersetzen

Bei der Aktualisierung von Report-Vorlagen muss der neue Report im Verzeichnis

/home/reports

abgelegt werden. Damit der Report neu übersetzt wird, muss die vom System erzeugte Report-Datei (.jrxml) und die kompilierte Version entfernt werden (.jasper). Die Namen der Dateien (ohne Suffix) entsprechen dem Namen in der JasperReport-Tabelle. Falls die existierenden Dateien im Unterverzeichnis

./build

nicht gelöscht wurden, werden die "alten" Dateien weiterverwendet.

Erstellen von Reports

Software zum Erstellen von Reports

Alle Vorlagen (.jrxml) können mit dem iReport-Designer (ab Version 5.1) der JasperSoft Community (siehe http://community.jaspersoft.com/project/ireport-designer) bearbeitet werden.

Eine Datenbank für die Bearbeitung von Reports ist nicht notwendig. Allerdings liefert der Preview dann natürlich keine Ergebnisse.

Hinweis: Für die Sortierung der Parameter der Eingabemaske zum Ausführen des Reports verwendet das System immer alphabetisch bzw. numerisch aufsteiegende Sortierung. Um eine sinnvolle Sortierung der Felder in der Maske zu erreichen, können beim Erstellen des Reports den einzelnen Feldern bzw. deren Labels z.B. Buchstaben oder Zahlen vorangestellt werden.

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.

Darüber hinaus sollte -sofern die verwendeten Schriften keine Standardschriften sind - die Option "pdfEmbedded" (im iReport Designer unter "Styles") angehakt werden. Dies führt bei der Erzeugung des Reports aus der Reportvorlage dazu, dass die verwendete Schriftart in der erzeugten PDF-Datei enthalten ist. Damit kann erreicht werden, dass ein Dokument auch auf Systemen angezeigt (gedruckt) werden kann, die die angegebene Schriftart nicht kennen.

Sollen andere Schriften als die Standardschriften verwendet werden, dann sollte vorab geprüft werden, ob diese auf dem Server System installiert sind (Kommandozeile: fc-list :lang=DE).

Standardschriften

Die JasperReport Biliotheken verwenden die iText Bibliotheken, um die Schriften zu rendern. Folgende Schriften funktionieren damit in jedem Fall:

Courier
Courier-Bold
Courier-BoldOblique
Courier-Oblique
Helvetica
Helvetica-Bold
Helvetica-BoldOblique
Helvetica-Oblique
Symbol
Times-Roman
Times-Bold
Times-BoldItalic
Times-Italic
ZapfDingbats

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_HOST
mysqldump -u $user -p -h $host $db Rechnung RechnungsItem LinkableEntry \
ZahlungsKondition BeitragsSatz BeitragsArt BeitragsKonto BeitragsZahlung> ica_report_data.sql

Besonderheiten für gruppierungsspezifische Reports

Reports, die nicht durch administrative Benutzer mit Vollzugriff auf alle Gruppierungen und Mitglieder ausgeführt werden sollen, sondern im Rahmen der Gruppierungsverwaltung angeboten werden (siehe Reports (Gruppierung)), sollten in der Report-Datei bestimmte Parameter verwenden, die den Zugriff auf Daten automatisch beschränken:

Parameter	Beschreibung	Bemerkungen
h_grpId	ID der aktuellen Gruppierung
h_grpNummer	Gruppierungsnummer der aktuellen Gruppierung
h_ebeneTiefe	Wert der Ebene, Angabe als ganzzahlige Zahl
h_crtUserId	ID des aktuellen Benutzers

Diese Parameter werden in der Maske beim Ausführen des Reports nicht angezeigt, aber automatisch mit den Daten des aktuellen Kontexts gefüllt. So wird eine Beschränkung der Ergebnisse z.B. auf die aktuelle Gruppierung erreicht, aus der ein Report ausgeführt wird.

Mindestens das Setzen von h_grpId sollte immer stattfinden. Wird keiner der aufgeführten Parameter gesetzt, ist ein Zugriff auf alle Daten möglich, wenn der Report ausgeführt wird.

Vorlagen für das Modul Führungszeugnisse

Siehe dazu Modul Vorlagen.

Für das Modul Führungszeugnisse (siehe Modul Führungszeugnisse) werden zwei Vorlagen benötigt:

Antragsunterlagen (mehrere Seiten)
Bescheinigung

Damit Vorlagen als .jrxml-Dateien verwendet werden können, mussen einige Systemparameter gesetzt werden:

Systemparameter	Verwendung	Voreinstellung
FZ_USE_JASPER_REPORTS	nur wenn auf ja gesetzt, werden .jrxml-Vorlagen verwendet	nein (in älteren Versionen wurde für die Vorlagen des Moduls Führungszeugnisse eine andere Technologie verwendet, die weiter unterstützt wird)
REPORT_FUEHRUNGSZEUGNIS_BEANTRAGUNG	ID der zu verwendenden Vorlage für die mehrseitigen Antragsunterlagen	15
REPORT_FUEHRUNGSZEUGNIS_BESCHEINIGUNG	ID der zu verwendenden Vorlage für die Bescheinigung	4

Folgende Vorlagen werden als Basis mitgeliefert:

Vorlagenname	Inhalt	Bemerkungen
	Vorlage für die mehrseitigen Antragsunterlagen
	Vorlage für die Bescheinigung

Vorlagen für die Abrechnung

Siehe dazu Modul Vorlagen.

Ausführen von Reports

Vorausgesetzt, der Benutzer verfügt über entsprechende Rechte, kann ein Report in der Liste markiert und mit rechtem Mausklick über

"Ausführen" oder
"Ausführen XLS"

ausgeführt werden. Es öffnet sich eine Maske mit den jeweils im Report definierten Eingabeparametern (siehe Modul Vorlagen.)

Der Report wird anschließend als PDF-Datei (oder .xls-Datei) zum Download angeboten:

Der Link kann genau ein einziges Mal verwendet werden, d.h. die Dateien werden nicht dauerhaft auf dem Server gespeichert.

Zum Ausführen von gruppierungsspezifischen Reports siehe Reports (Gruppierung).

Page tree

Modul Reports