Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Note

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. 
Standard ErgebnistypStandard 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

...

In der Maske wird dann "Mitglied_ID" bei dem jeweiligen Feld angezeigt.

Infonote

Wichtige Hinweise:

  • Parameternamen dürfen keine Leerzeichen oder Sonderzeichen enthalten und nicht mit einer Zahl beginnen.
  • Für die Sortierung der Parameter der Eingabemaske zum Ausführen des Reports verwendet das System immer alphabetisch bzw. numerisch alphanumerisch aufsteigende 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.bei Bedarf den einzelnen Parameternamen  Buchstaben (A-Z, a-z) vorangestellt werden, Zahlen oder andere Zeichen sind nicht unterstützt.


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:

...

  • Klein-/Groß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.

...

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

...

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

 

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:

FeldBedeutung 
AnzeigenameAbweichender 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
  • Benutzereingabe (Wert wird im Forumlar angezeigt)
  • URL Parameter (für zukünftige Benutzung)
  • Entity ID : Der Parameter bekommt die "Zeile", aus der der Report aufgerufen wurde. Das Feld wird NICHT im Formular angezeigt, sondern vom System vor Reportausführung belegt.
  • Owner ID: Der Parameter bekommt den "Besitzer" der Zeile aus der der Report aufgerufen wurde (bei gruppierungsspezifischen Reports, die id der besitzenden Gruppierung). Das Feld wird NICHT im Formular angezeigt, sondern vom System vor Reportausführung belegt.
 

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 ReportsBemerkungen
ica-1.5.xbis Version 5.5 (jrxml Dateien mit Versionsformat 5.1 bis 5.5)
  • iReport 5.1 bis iReport 5.6
  • Jasper Studio 6.6 (als Eclipse Plugin 4.9.x Versionen)
    • jrxml Version 5.5.2 verwenden