Page tree
Skip to end of metadata
Go to start of metadata

Das Vorlagen-Modul ermöglicht die Verwaltung von Reports

  • die vom System verwendet werden, um bestimmte Dokumente zu erzeugen, z.B. Rechnungsvorlagen
  • sowie von beliebigen individuellen Reports, die unter Modul Reports erstellt wurden. 

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.

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.

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.

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:

ParameternameVerwendungszweckBeispiel
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.

Es sind nur alphanumerische Zeichen zulässig, keine Leerzeichen, der Name muss eindeutig sein.

musterReport20
BeschreibungBeschreibung des Reports 
Dateipfad

Absoluter Pfad der .jrxml Datei auf dem Server.

  • /home/jboss/reports/
/home/jboss/reports/musterTemplate.jrxml
XML-Dateinicht implementiertmuss leer bleiben
Report-KlasseSystem-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
RechtAuswahl eines (funktionalen, nicht gruppierungsbeschränkten) Rechts, über das ein Benutzer verfügen muss, um den Report ausführen zu können. 

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 kompilierte Version entfernt werden (.jasper). Die Namen der Dateien (ohne Suffix) entsprechen dem Namen in der JasperReport-Tabelle. Diese Dateien befinden sich im Unterverzeichnis

  • ./build 

Falls die existierenden Dateien im Unterverzeichnis ./build nicht gelöscht wurden, werden die "alten" Dateien weiterverwendet.

Standardvorlagen

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.

SystemparameterBeschreibungVoreinstellung
RECHNUNG_REPORT_MITGLIEDER_DEFAULTID der zu verwendenden Vorlage Ausgangsrechnung Mitgliederabrechnung2
RECHNUNG_REPORT_VERBAND_DEFAULTID der zu verwendenden  Vorlage Ausgangsrechnung Verbandsabrechnung4

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

VorlageInhaltBemerkungen
rechnungMitglieder.jrxmlVorlage für die Rechnung bei Mitgliederabrechnung.

Beim Report für die Mitgliedsabrechnung muss bei der Klassen-Defintion (Feld: Report-Klasse) die Klasse de.iconcept.nami.entity.abrechnung.RechnungMgl gesetzt werden.

rechnungVerbandMitEinzel.jrxmlVorlage für die Rechnung bei Verbandsabrechnung.inkl. Detailaufstellung

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:

SystemparameterBeschreibungVoreinstellung
FZ_USE_JASPER_REPORTSnur wenn auf ja gesetzt, werden .jrxml-Vorlagen verwendetnein (in älteren Versionen wurde für die Vorlagen des Moduls Führungszeugnisse eine andere Technologie verwendet, die weiter unterstützt wird)
REPORT_FUEHRUNGSZEUGNIS_BEANTRAGUNGID der zu verwendenden Vorlage für die mehrseitigen Antragsunterlagen15
REPORT_FUEHRUNGSZEUGNIS_BESCHEINIGUNGID der zu verwendenden Vorlage für die Bescheinigung4

Folgende Vorlagen werden als Basis mitgeliefert:

VorlageInhaltBemerkungen
ica-fz-beantragen.jrxmlVorlage für die mehrseitigen Antragsunterlagen 
ica-fz-bescheinigung.jrxmlVorlage für die Bescheinigung 

.jrxml-Report/Vorlage erstellen oder bearbeiten

Siehe dazu Modul Reports.

  • No labels