Zum Inhalt

Master-Reports

Verwaltung von Master-Report-Konfigurationen in calServer V2.


Uebersicht

Der AdminReportSettingController ermoeglicht die Konfiguration von Master-Reports. Diese bilden die Grundlage fuer die Berichterstellung und definieren, welche JasperReports-Vorlagen mit welchen Variablen verwendet werden.

Konzept

Master-Report (Einstellung)
    |
    +-- JasperReports-Vorlage (.jrxml)
    +-- Variablen-Konfiguration
    +-- Ausgabeformat (PDF / Excel / CSV)
    +-- Ausfuehrungsprotokoll

Report-Konfiguration

Uebersicht

Unter Admin > Berichte > Master-Reports werden alle konfigurierten Reports angezeigt:

Feld Beschreibung
Name Bezeichnung des Reports
Vorlage Zugeordnete .jrxml-Datei
Ausgabeformat PDF, Excel oder CSV
Status Aktiv / Inaktiv

Zeilen mit dem Etikett „Systembericht"

Ein paar Berichte erzeugt calServer selbst, ohne dass jemand sie auswaehlt (z. B. den Leihschein der Ausleihe-Mail). Diese Zeilen sind immer vorhanden und nicht loeschbar, sonst aber ganz normale Berichte. Details: Systemberichte.

JasperReports-Vorlage hochladen

  1. Navigieren Sie zu Admin > Berichte > Master-Reports
  2. Klicken Sie auf Neuer Report
  3. Laden Sie die .jrxml-Datei hoch
  4. Konfigurieren Sie die Variablen
  5. Waehlen Sie das Ausgabeformat
  6. Speichern Sie die Konfiguration

JasperReports

Vorlagen werden im JasperReports-Format (.jrxml) erstellt. Zur Bearbeitung empfiehlt sich TIBCO Jaspersoft Studio.

Bilder brauchen einen Alternativtext

Jedes Bild in einer Vorlage (Logo, Unterschrift, Barcode, Diagramm) erscheint im erzeugten PDF als Figur. Ohne Alternativtext kuendigt eine Sprachausgabe nur „Grafik" an und sagt nichts weiter (EN 301 549 10.1.1.1).

Den Text setzt die Vorlage ueber <hyperlinkTooltipExpression> am Bildelement — in Jaspersoft Studio das Feld Tooltip in den Hyperlink-Eigenschaften:

<image>
  <reportElement key="messverlauf" x="0" y="0" width="500" height="200"/>
  <hyperlinkTooltipExpression><![CDATA["Messverlauf ueber zwoelf Monate, "
    + "Abweichung faellt von 0,8 auf 0,2 Prozent"]]></hyperlinkTooltipExpression>
  <imageExpression><![CDATA[$P{chart}]]></imageExpression>
</image>

Fehlt der Tooltip, setzt der Report-Runner ersatzweise den key des Elements ein, sonst einen Gattungsbegriff. Das verhindert eine Figur ohne Text, beschreibt aber nichts — bei einem Diagramm gehoert die Kernaussage hinein, bei einem Barcode sein Wert.

Variablen

Report-Variablen verknuepfen Datenbankfelder mit Platzhaltern in der Vorlage:

Variable Typ Beschreibung
$P{deviceName} String Geraetebezeichnung
$P{calibrationDate} Date Kalibrierdatum
$P{result} String Kalibrierergebnis
$P{technician} String Kalibriertechniker
$P{nextDueDate} Date Naechster Kalibriertermin

Variablen konfigurieren

Variable:      deviceName
Datenquelle:   inventory.name
Typ:           String
Standardwert:  (leer)

Geltungsbereich: global, pro Berichtstyp, pro Bericht

Berichtsvariablen werden unter Admin > Berichtsverwaltung > Berichtsvariablen gepflegt und koennen drei Geltungsbereiche haben:

Geltungsbereich Bedeutung
Global (all) Variable gilt fuer alle Berichte aller Typen
Berichtstyp Variable gilt fuer alle Berichte eines Typs (Inventar, Kalibrierung, Buchung, Reparatur)
Einzelner Bericht Variable gilt nur fuer den ausgewaehlten Master-Report

Bei der Generierung werden die Variablen in dieser Reihenfolge aufgeloest — bericht-spezifische Variablen ueberschreiben gleichnamige Typ- und globale Variablen. So kann z. B. ein einzelner Kalibrierschein eine eigene Fusszeile erhalten, waehrend alle anderen Berichte den globalen Text verwenden.

Pro-Bericht-Variablen

Legen Sie eine Variable mit demselben Variablennamen an und ordnen Sie sie einem Bericht zu, um den globalen Wert nur fuer diesen Bericht zu ueberschreiben. System-Variablen (company_*) koennen nicht geloescht, aber pro Bericht ueberschrieben werden.

Unterschriften positionieren

Unter Admin > Berichtsverwaltung > Unterschriften werden die Unterschrift-Plaetze je Bericht angelegt. Ein Unterschrift-Platz definiert, wo auf dem erzeugten PDF eine erfasste Unterschrift aufgebracht wird.

Statt die Position in Pixeln zu tippen, wird die Unterschrift direkt auf einer Seitenvorschau eingezeichnet:

  • Klicken setzt die Unterschrift mittig an die Klickposition (Standardgroesse).
  • Ziehen verschiebt den Unterschrift-Rahmen.
  • Ecken ziehen skaliert den Rahmen.
  • Erste/Letzte Seite waehlt, auf welcher Berichtsseite die Unterschrift landet.

Die Werte Oben / Links / Breite / Hoehe darunter bleiben synchron und lassen sich fuer pixelgenaue Feinjustierung direkt bearbeiten.

Koordinatensystem

Positionen werden in CSS-Pixeln (96 DPI) relativ zur oberen linken Ecke einer A4-Hochformatseite (794 × 1123 px) gespeichert — dieselben Werte, die V1 verwendet. Beim Download rechnet der Server sie in PDF-Punkte um und brennt die Unterschrift an die konfigurierte Stelle.

Ausgabeformate

Format MIME-Typ Verwendung
PDF application/pdf Kalibrierscheine, Pruefberichte
Excel application/xlsx Datenexport, Analysen
CSV text/csv Maschinenlesbarer Export

PDF als Standard

Fuer Kalibrierscheine und offizielle Dokumente sollte immer PDF als Ausgabeformat verwendet werden.

Ausfuehrungsprotokoll

Der AdminReportRunLogController protokolliert jede Report-Ausfuehrung:

Feld Beschreibung
Zeitpunkt Wann der Report ausgefuehrt wurde
Benutzer Wer den Report ausgeloest hat
Report Welcher Master-Report verwendet wurde
Status Erfolgreich / Fehlgeschlagen
Dauer Ausfuehrungszeit in Sekunden
Fehler Fehlermeldung (bei Misserfolg)
Admin > Berichte > Ausfuehrungsprotokoll

Fehlgeschlagene Reports

Pruefen Sie bei fehlgeschlagenen Reports das Ausfuehrungsprotokoll. Haeufige Ursachen sind fehlende Variablen oder Verbindungsprobleme zum JasperReports-Microservice.