11.2. Eine neue Berichtsvorlage erstellen

11.2. Eine neue Berichtsvorlage erstellen
	Kapitel 11. Benutzerdefinierte Berichte

11.2.1. Unterstützte Parametertypen
11.2.2. Umgang mit Parametern

Wählen Sie unter Konfigurieren den Menüpunkt Berichtsvorlagen aus.

Abbildung 11.2. Die Seite „Berichtsvorlagen“

Ein Klick auf den Button Neu erzeugt eine neue Berichtsvorlage. Es öffnet sich die Seite Berichtsvorlage - Detailansicht:

Name	Der Name des Berichts.
Beschreibung	Eine Beschreibung des Berichts.
Ausgabeformat	Das Ausgabeformat: PDF oder Excel.
Status	Der Status des Berichts: Entwurf oder genehmigt.

Klaros-Testmanagement wird mit mehreren vordefinierten Berichtsvorlagen ausgeliefert. Diese sind schreibgeschützt, können aber mit dem Icon dupliziert werden. Das Duplikat kann dann nach Belieben geändert werden.

Abbildung 11.3. Die Seite „Berichtsvorlagen - Details“

Die Ansicht Parameter zeigt die für diese Vorlage definierten Parameter an. Bei neu erzeugten Berichten ist diese Liste leer.
Die Ansicht Script verwaltet das Berichts-Skript. Neu erzeugte Berichte verfügen bereits über eine vordefinierte Klasse mit den notwendigen Methoden.
Die Layout-Vorlage wird in der Ansicht Layout-Vorlage verwaltet. Wie beim Berichts-Skript ist für neue Berichte bereits ein Grundlayout vorhanden.

Anmerkung

Für größere Berichtsvorlagen kann es hilfreich sein, eine IDE (z.B. Eclipse) für das Skript und die Layout-Vorlage zu verwenden. Die erstellten Dateien können dann in Klaros-Testmanagement hochgeladen werden. Um Fehler zu vermeiden, fügen Sie die Klaros-Modellbibliotheken zum Build-Pfad Ihres Eclipse-Projekts hinzu. Das Tutorial-Dokument verfügt über ein Kapitel zur Erstellung von Berichtsvorlagen, in dem dies detailliert erläutert wird.

Anstatt das Berichts-Skript und die Vorlage direkt in der Anwendung zu editieren, können diese auch aus einer Datei importiert werden. Geben Sie die zu verwendende Datei an, indem Sie auf den Button Browse klicken und die zu importierende Datei auswählen. Ein Klick auf OK im Datei-Dialog und danach auf Upload importiert die ausgewählte Datei in das Skript- oder Vorlagenfeld.

Diese Seite bietet drei ausführbare Aktionen:

Vorschau erzeugt eine Vorschau des Berichtes.
Speichern speichert die Berichtsvorlage.
Verwerfen verwirft alle Änderungen an der Berichtsvorlage.

Um Berichte flexibler zu gestalten, können Parameter an das Berichts-Skript zu übergeben werden. Diese können z.B. dazu verwendet werden, eine Zeitspanne festzulegen, für die die Daten ermittelt werden.

Mit einem Klick auf das Icon wird ein neuer Parameter angelegt Abbildung 11.4, „Die Ansicht „Parameter“ “.

Abbildung 11.4. Die Ansicht „Parameter“

Der Typ der Parameter kann durch Auswahl des entsprechenden Wertes aus der Typenliste angegeben werden. Unterstützte Typen sind Text, Number, Datum, Boolean, List und Multi List. Es kann ein Vorgabewert angegeben und ein Pflicht-Flag gesetzt werden. Mit Klick auf das Icon wird der Parameter aus der Liste entfernt.

Auf die übergebenen Parameter kann das Berichts-Skript zugreifen, indem es entweder die Methode getParameterValue(String name) oder die Methode getParameter(String name) aufruft. Diese Methoden geben null zurück, wenn kein Parameter mit dem angegebenen Namen gefunden werden konnte.

11.2.1. Unterstützte Parametertypen

Die folgenden Parametertypen werden unterstützt:

Text
Zahl
Datum
Aufzählung
Mehrfach-Aufzählung

11.2.2. Umgang mit Parametern

Wie bereits erwähnt, können die übergebenen Parameter über die Methoden getParameterValue(String name) und getParameter(String name) aus dem Kontext abgerufen werden.

Der folgende Code-Ausschnitt zeigt, wie auf Parameter zugegriffen werden kann und wie sie im Berichts-Skript verwendet werden können:

  StringBuffer query = new StringBuffer();
    query.append("select tcr from KlarosTestCaseResult tcr where tcr.executionTime < ");
    query.append(context.getParameterValue("executionTime"));
    List<?> tcr = context.executeQuery(query.toString());

Diese Abfrage ruft alle Objekte vom Typ KlarosTestCaseResult ab, die einen Ausführungszeitpunkt haben der vor dem mit dem Parameter executionTime übergebenen Wert liegen.

Alternativ kann, wie im folgenden Code-Ausschnitt dargestellt, in der Abfrage auch direkt auf die Parameter zugegriffen werden:

  query.append("select tcr from KlarosTestCaseResult tcr where tcr.executionTime <:executionTime");
    List<?> tcr = context.executeParameterizedQuery(query.toString());

Von der Layout-Vorlage aus kann auf Parameter wie folgt zugegriffen werden:

<p:text value="Test results for test runs with execution time &lt; #{executionTime} ms" />

	Anmerkung
	Stellen Sie sicher, dass Zeichen wie `&`, `<` oder `>` oder `>` escaped werden, wenn sie in XML-Attributen in der Layout-Vorlage verwendet werden. In unserem Beispiel ist < das Escape-Zeichen für `<`.


Kapitel 11. Benutzerdefinierte Berichte		11.3. Einen Bericht erzeugen