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
Nachdem ein Report als .jrxml-Datei erstellt wurde (siehe Modul Reports), 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 |
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.
Standardvorlagen
Für die Mitglieder- und Verbandsabrechnung existiert eine Standardvorlage. Die Definition für die zu verwendende Standardvorlage wird in der Regel über Systemparameter gesteuert.
| Systemparameter | Verwendung | Voreinstellung |
|---|---|---|
| RECHNUNG_REPORT_MITGLIEDER_DEFAULT | Vorlage Ausgangsrechnung Mitgliederabrechnung | 2 |
| RECHNUNG_REPORT_VERBAND_DEFAULT | Vorlage Ausgangsrechnung Verbandsabrechnung | 4 |
Liste der Standardvorlagen, die mindestens in der jeweils aktuellen Version mit dem System installiert werden:
| Vorlagenname | Inhalt |
|---|---|
| rechnungMitglieder.jrxml | Vorlage für die Rechnung bei Mitgliederabrechnung. |
| rechnungVerbandMitEinzel.jrxml | Vorlage für die Rechnung bei Verbandsabrechnung. |
Report/Vorlage (.jrxml) erstellen oder bearbeiten
Siehe dazu Modul Reports.