Funktionsweise

Das Reporting Vorlagen-Modul ermöglicht die Anpassung Verwaltung von Reports,

• die vom System verwendet werden, um

...

• bestimmte Dokumente zu erzeugen, z.B.

...

Aktuell wird das Reporting-Modul für die Rechnungserstellung verwendet.

Das Reporting Module basiert auf den JasperReports Bibliotheken (hier Lizenz verweis??). Dabei werden .jrxml Dateien (Report-Vorlagen), die auf der Server-Umgebung zur Verfügung - 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.

Damit Reports verwendet werden können müssen diese dem System über die Module/JasperReports Tabelle bekannt gemacht werden. Folgende Parameter müssen definiert sein

...

• Rechnungsvorlagen
• sowie von beliebigen individuellen Reports, die unter Modul Reports erstellt wurden. 

Vorlagen verwalten - Anlegen & Bearbeiten von Reports

Report im Dateisystem ablegen

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

• /home/jboss/reports/

Die Übersetzung der Report-Dateien erfolgt im Verzeichnis

• /home/jboss/reports/build 

In diesem Verzeichnis entsteht eine umbenannte Kopie der Original-.jrxml-Datei sowie weitere Dateien (.jasper). Erforderlich sind Lese- und Schreibberechtigung für den Benutzer, unter dem der Application Server läuft.

Anlegen & Bearbeiten von Reports

Damit eine ins Dateisystem kopierte Vorlage verwendet werden kann, muss diese dem System anschließend bekannt gemacht werden, indem im Interface ein neuer Report angelegt wird. Folgende Parameter müssen definiert sein:

Die Übersetzung der .Report-Dateien erfolgt im Verzeichnis /home/jboss/reports/build (Lese- und Schreibberechtigung für den Benutzer unter dem der Applikation Server läuft). Bei der Erzeugung der Reports entstehen im Verzeichnis /tmp ebenfalls temporäre Dateien. Dies sollten, bzw. müssen regelmäßig über einen Systemjob (cron-job) aufgeräumt werden.

Verwendung

Das Reporting-Modul wird gegenwärtig für die Abrechnung verwendet.

In der Regel existiert für die Eingangs- und Ausgangsrechnungen ein Standardvorlage für die Eingangs- und Ausgangsrechnungen.

Die Definition für die zu verwendende Standardvorlage wird in der Regel über Systemparameter gesteutert.

Aktualisierung von Report Vorlagen

...

Vorlagen verwalten - Dateien ersetzen

Will man eine existierende Report-Vorlage überschreiben, muss zuerst der neue Report im Verzeichnis

• /home/reports 

abgelegt werden (s.o.).

Damit der Report neu übersetzt wird, muss außerdem die vom System erzeugte Report-Datei (.jrxml) und auch die compilierte kompilierte Version entfernt werden (.jasper). Die Namen der Dateien (ohne suffixSuffix) entsprechen dem Namen in der JasperReport-Tabelle. Diese Dateien befinden sich im Unterverzeichnis

• ./build 

Standardvorlagen

Sicherheit

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 Datensicherheit hier nur über den Zugriff der Report-Generierung hergestellt werden kann. Aus diesem Grund ist die Einstellung und Definition von Reports systemseitig beschränkt.

Standardvorlagen bearbeiten

Alle Standardvorlagen (.jrxml) können mit dem iReport- Designer (ab Version 5.1) der JasperSoft Community  von (Download über SourceForge) bearbeitet werden.

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

Schrifften

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. Sprich: 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 Schrift 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 verhindert werden, dass ein Dokument ggf. auf auch Systemen angezeigt (gedruckt) werden kann, die die angegebene Schriftart nicht kennen.  

Beispieldatenbank

Beispieldatenbank auf dem Produktivsystem erzeugen - 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

Standardvorlagen

Liste der Standardvorlagen, die in der jeweils aktuellen Version mit dem System installiert werden:

...

Abrechnung

Für die Mitglieder- und Verbandsabrechnung existiert eine Standardvorlage. Die Definition für die zu verwendende Standardvorlage wird in der Regel über Systemparameter (siehe System) gesteuert.

Liste der Standardvorlagen, die mindestens in der jeweils aktuellen Version mit dem System installiert werden:

Modul Führungszeugnisse

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

1. Antragsunterlagen (mehrere Seiten)
2. Bescheinigung

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

Folgende Vorlagen werden als Basis mitgeliefert:

.jrxml-Report/Vorlage erstellen oder bearbeiten

Siehe dazu Modul Reports.