Standardreport (Formatierung)

Aus ProfilGlossar
Wechseln zu: Navigation, Suche
Für diese Seite gibt es Sicherheitseinschränkungen.


Der Standardreport (SR) ist in profil die Druckansicht/Seitenansicht für Mappen und Dokumente. Die Standardreporte werden durch den Sachbearbeiter im Amt eingesehen und nicht vom Antragsteller. Um zu gewährleisten, dass alle Standardreports gleich aussehen, wurde dieser Wiki-Eintrag erstellt.

Abgrenzung: Die hier aufgeführten Beschreibungen zur Formatierung des Standardreportes beziehen sich nicht auf Ausgabemöglichkeiten in CSV- oder Excel-Format.


Einleitung

Dieser Eintrag gibt wieder, wie in Zukunft alle Standardreports von den Entwicklern zu formatieren/entwickeln sind, damit die Abteilung QS gewissenhaft die Standardreporte testen kann. Aus diesem Grund und damit die Sachbearbeiter eine immer gleiche Ansicht haben, wurde dieser Eintrag verfasst.

In diesem Eintrag wird der Standard beschrieben. Abweichungen vom Standard sind in den jeweiligen Detailkonzepten zu beschreiben.

Hinweis:

Bereits bestehende Abweichungen sind bei Gelegenheit anzupassen bzw. können so bleiben, wenn die Kunden dem nicht widersprechen.

Kopfzeile

Die Kopfzeile (oder der Header) besteht aus einer Tabelle mit 2 Zeilen und 2 Spalten, einem Titel und teilweise aus einem Untertitel. Des Weiteren wiederholt er sich auf jeder Seite des Standardreports.

Tabelle:

1. Zeile:
   1. Spalte: "Rechnergesützte Verwaltung von Fördermitteln in der Landwirtschaft"
   2. Spalte: Enthält den Namen der Anwendung (bspw. profil eler)

2. Zeile
   1. Spalte: Besteht aus Ersteller, System, Standort
   2. Spalte: Datum und Uhrzeit, wann der Report erstellt wurde


Titel:

Unter der Tabelle der Kopfzeile folgt der Titel des Standardreports (bspw. Antragsmappe).

Hinweis: Im Titel muss nicht das Wort "Standardreport" auftauchen. Über die Aktionen Drucken/Seitenansicht wird der Standardreport erstellt und ist als grundlegende Funktion in (fast) jedem Werkzeug von profil c/s enthalten. Gibt es eine gesonderte Ausgabe von (z.B. CSV-Export) dann ist dort ggf. die Besonderheit kenntlich zu machen.

Untertitel:

Ein Untertitel sollte nur ausgegeben werden, wenn es Informationen aus der Titelzeile der zu druckenden GUI gibt, die noch nicht im Titel stehen. 
Die Anzahl gefundener Mappe gehört nicht in den Untertitel.
Wenn es einen Untertitel gibt, kommt unter den Titel eine 1 pt dünne waagerechte Linie.
Danach folgt der Untertitel. 
Dieser wird linksbündig unter der 1 pt dünnen Linie dargestellt. 
Die erste Zeile des Untertitels wird eingerückt.

Definition Titel/Untertitel:

Inhalt ELER Antragsmappe ELER Teilvorgang ELER Indikatorenblatt DZ Antragsblatt AUM Antragsblatt AS unabhängige Mappe
Titel

Was ist geöffnet

Antragsmappe

Zahlungsblatt

Indikatorenblatt

Antragsblatt

Antragsblatt

Name des geöffneten Fensters

Untertitel

genauere Angaben

Anhängsel

TVG ( ) + Anhängsel

Anhängsel

Abruf + Berechnungsnr. + Anhängsel

Abruf + Berechnungsnr. + Anhängsel

Art d. Mappe lt. Reg/AJ: Bezeichnung der Mappe lt. Reg.

Anhängsel: FP-Nummer FP-Name/AJ: BNR-ZD/AS-Nummer AS-Name AZ:

Beispiel: 200 Betriebsprämie/2014: 019980001709/10101545 Mustermann, Max Az: 2001400001

Anmerkung: der FP-Name ist nicht abzukürzen.


Abschluss:

Den Abschluss bildet eine 2 pt dünne waagerechte Linie unter dem Titel, bzw. unter dem Untertitel.

Beispiel:


Fußzeile

Die Fußzeile (oder der Footer) gibt es an jedem einzelnen Seitenende des Standardreports.

Linie:

Den Anfang eines jeden Footers bildet eine 1 pt dünne waagerechte Linie.

Seitenzahl:

Unter der waagerechten Linie, rechts ausgerichtet, folgt eine Seitenzahl.
Seite: "X" 

Beispiel:


Mittelteil

Der Mittelteil (oder der Body) bildet das Herzstück eines jeden Standardreports.

Aber anders als der Header oder der Footer besteht der Body meist aus mehreren verschieden Komponenten.

Diese werden nicht immer gleich formatiert.

Dieser Abschnitt gibt wieder, was im Report erscheinen soll und wie jede einzelne Komponente formatiert werden muss.


Welcher Stand der GUI soll im Report wiedergegeben werden?

Für Mappen gilt: Es sollen alle Werte aus der GUI angezeigt werden, die persistiert wurden (und eventuell vorhandene transiente Attribute). Eine Ausnahme bilden hierbei editierbare Tabellen, die grundsätzlich den aktuellen Stand enthalten.

Für Sucher/Auswerter gilt: Seitenansichten können nur erstellt werden, wenn bereits eine Suche/Auswertung erfolgt ist. Wurde bei der letzten Suche/Auswertung eine ungültige Kombination von Kriterien verwendet (worauf einen das Programm hinweist - z.B. ZA-Auswerter) soll bei der Erstellung der Seitenansicht ebenfalls eine entsprechende Fehlermeldung erscheinen, > z.B.: "Es kann keine Seitenansicht erstellt werden, weil ungültige Kriterien eingegeben wurden."

Im Standardreport sind immer die Suchkriterien auszugeben, die zum angezeigten Suchergebnis geführt haben.[1]

Im Standardreport sind immer die Suchkriterien auszugeben, die aktuell in der GUI zu sehen sind (auch wenn sie nach der Suche geändert wurden).

Hinweis: Das gilt nur für neue/geänderte Werkzeuge, da sonst viele geändert werden müssen und wir entsprechend Angebote schreiben müssten.

Text- und Overlayformatierung

Schriftgröße

Für normalen Text wird die Schriftgröße 10 verwendet.
Für Überschriften werden die Schriftgrößen 16 (Überschriften) und 10-Bold (Unter-Überschriften) verwendet.

Für die Kopfzeile werden unterschiedliche Schriftgrößen verwendet:
     - Bei dem Kopf (mit Anwendung, Datum, Ersteller, System, Standort usw.) wird die Schriftgröße 12 verwendet.
     - Bei dem Titel wird die Schriftgröße 16 verwendet.
     - Bei dem Untertitel wird die Schriftgröße 12 verwendet.

Bei dem Tabelleninhalt sowie Tabellenkopf wird die Schriftgröße 8 verwendet.
Der Tabellenkopf wird fett geschrieben. 

Schrifteffekte und -hervorhebungen

Ist Schrift in der GUI farblich hervorgehoben (z.B. abgelaufene ZVP-Zuordnungen), kursiv dargestellt (z.B. manuelle Bearbeitung in vorbelegten Tabellen) oder durch andere Effekte hervorgehoben, sind diese in den Standardreport zu übernehmen.

Ausrichtung von Werten

Hier muss zwischen nummerischen und alphanummerischen Werten unterschieden werden. Sonderfälle werden explizit aufgeführt.

Numerische Werte
Es gilt: Werte mit denen gerechnet werden kann, sollen rechtsbündig dargestellt werden. Trifft dies nicht zu, so werden sie linksbündig dargestellt.
Sonderfälle sind in der unten stehenden Tabelle aufgelistet. 
Antragsjahr

rechtsbündig

Datum

rechtsbündig

Kontonummer

rechtsbündig

Bankleitzahl

rechtsbündig

Alphanumerische Werte
Alphanumerische Werte werden linksbündig dargestellt. 
Kann ein Wert, wie z.B. das Aktzenzeichen, entweder nur aus Buchstaben, nur aus Ziffern oder beidem bestehen - so wird der Wert immer linksbündig dargestellt.

Beispiele:

BNR-ZD

linksbündig

AS-Nummer

linksbündig

Amt

linksbündig


Definition Überschrift/Unter-Überschrift

1. Tabnamen bilden Überschriften

1.1 Gibt es keine Tabs, aber z.B. eine Tabelle mit Überschrift, wird diese zur Überschrift


2. Tabs innerhalb eines Tabs bilden Unter-Überschriften

2.1 wie 2. mit zusätzlicher Tabellen-Überschrift. Da keine weitere Abstufung der Überschriften vorgesehen ist, wird diese wie eine Unter-Überschrift behandelt.

2.2 Gibt es in einem Tab z.B. Tabellen mit Überschriften, wird diese Tabellenüberschrift zur Unter-Überschrift.



Anmerkung: Es gibt teilweise "Beschreibungen" eines Panels (siehe Bild). Diese werden im Report nicht ausgegeben. Wenn sie im Report dargestellt werden sollen, muss diese "Beschreibung" in eine Überschrift oder ein Label geändert werden.



Tabs

Wenn das Dokument/die GUI, aus dem der Standardreport erstellt wird, mehrere Tabs enthält, 
wird jeder Tab auf eine eigene Seite im Standardreport gelegt. Es wird jedes Tab gedruckt, auch wenn es zum Zeitpunkt der Erstellung des Standardreportes nicht ausgewählt ist.
Der Name des Tabs befindet sich unter dem Abschluss (waagerechte Linie). 
Es ist darauf zu achten, dass der Abstand zur Abschlusslinie innerhalb eines Reportes immer gleich ist.
Um den Tabnamen von den darunter befindlichen Labels hervorzuheben, wird auf den Doppelpunkt nach dem Namen verzichtet.
Einzige Ausnahme besteht, wenn die einzelnen Tabs zusammen so wenig Informationen enthalten, 
dass es keinen Sinn macht, jedes Tab auf eine eigene Seite zu legen.
Werden auf einem Register keine Daten angezeigt, ist dieses Register im Standardreport trotzdem aufzuführen. Auf Unterabschnitte/-überschriften wird verzichtet. Ergänzend ist der Standardsatz "Es sind keine Daten vorhanden." auszugeben. Für inaktive (nicht auswählbare) Register hingegen (z.B. Anteils-/festbetragsfinanzierung im Sanktionsblatt bei mengenfinanzierten Fördergegenständen) muss keine Überschrift gedruckt werden.

Textfelder und Labels

Formatierung:

Labels werden fett geschrieben und mit einem Doppelpunkt abgeschlossen.
Diese werden - im Gegensatz zur GUI - linksbündig angeordnet.
Einzeilige Textfelder werden rechts neben den Labels dargestellt
Mehrzeilige Textfelder werden unter dem Label dargestellt

Beispiele:

Einzeiliges Textfeld:
(Eler Antragsmappe)
Mehrzeiliges Textfeld:
(Auflagen)

Checkboxen

Formatierung:

Alle gewählten Checkboxen bekommen im Standardreport ein ja, alle nicht gewählten ein nein.

Es sei noch einmal explizit darauf hingewiesen, dass sowohl "ja" also auch "nein" !! klein !! zu schreiben sind!

Beispiel:

(ELER Antragsmappe)


Listenfelder, Optionsfelder und Dropdownmenüs

Formatierung:

Das ausgewählte Element wird als Text neben dem zugehörigen Label dargestellt.
Einträge, die in der GUI in " <  > " stehen, sollen auch so im Report erscheinen. 

Beispiele:

GUI & Report: <mit>, <ohne>, <alle>, <ja>, <nein>, <entfällt>

Hinweis: bitte klein schreiben!

Combobox mit Mehrfachauswahl

Formatierung:

Das in der Combobox angezeigte Element wird als Text neben dem zugehörigen Label dargestellt.
Einträge, die in der GUI in " <  > " stehen, sollen auch so im Report erscheinen. 

Mehrfachauswahlfelder

Formatierung:

Aus den Mehrfachauswahlfeldern werden nur die vom Benutzer ausgewählten Elemente im Standardreport dargestellt.
Sie werden rechts neben dem zugehörigen Label dargestellt.
Im Report soll alles ausgegeben werden, was in der GUI als "<Mehrfachauswahl>" zusammengefasst wurde. 
FP-Nummern werden nicht in eckigen Klammern dargestellt. 

Beispiele:

(Registratur: Suche nach AJ)

Ausgabe in profil: Darstellung im Report:

Container - Komponente

Formatierung:

Für die Darstellung der Container - Komponenten gibt es 2 verschiedene Möglichkeiten:
   1. Alle Label mit den Zugehörigen Textfeldern werden untereinander aufgelistet.
      (soll für die Abbildung aller normalen Dokumente verwendet werden| bspw. ELER FP-Mappe)
   2. Man übernimmt 1:1 die Anordnung der Labels und Textfelder aus der GUI.
      (soll für die Abbdildung aller Suchanzeigen verwendet werden| bspw. die Suche in der Registratur)

Beispiele:

Möglichkeit 1:
(Eler Antragsmappe)
Möglichkeit 2:
(Registratur)

Tabellen

Formatierung:

Für die korrekte Darstellung einer Tabelle gibt es mehrere Regeln:

1.  Eine Tabelle wird immer dann mit einer Überschrift dargestellt, wenn diese ebenfalls in der GUI eine Überschrift hat.
2.  Wurde eine Suche durchgeführt, so wird über der Tabelle, aber unter der Überschrift, die Anzahl der (Suchergebnis-)Einträge in der Tabelle ausgegeben. 
    Für alle anderen Tabellen - z.B. Prüfungen im VWKP ist dieser Eintrag nicht erforderlich.
3.  Tabellen bestehen immer aus einem Tabellenkopf und einem "Tabellenkörper". 
4.  Der Tabellenkopf wird immer grau hinterlegt. 
5.  Der Tabellenkopf soll immer auf dem Report dargestellt werden.
6.  Der Tabellenkörper wird immer weiß hinterlegt.
7.  Wenn die Tabelle über eine Seite hinaus geht, wird der Tabellenkopf auf jeder Seite wiederholt.
8.  Die Spaltenüberschriften werden linksbündig ausgerichtet.
9.  Die Ausrichtung der Werte im Tabellenkörper erfolgt analog zum weiter oben beschriebenen Verfahren.
10.  Alle Einheiten, die in der Tabelle benutzt werden, werden im Tabellenkopf angegeben und nicht im Tabellenkörper.
11. Die Spaltenbreiten der Tabelle sind variabel, sollten aber sinnvoll und am Inhalt angepasst sein.
12. Die Tabelle (als Ganzes betrachtet) ist linksbündig im Standardreport auszurichten.
13. Für Icons, die innerhalb einer Tabelle verwendet werden, ist im zugehörigen Detailkonzept eine Legende zu ergänzen. Diese beinhaltet die textuelle Übersetzung der Icons für den Report.
14. Die in der GUI vorgenommene Sortierung (aufsteigend/absteigend) soll im Report übernommen werden. 
    Ausnahme stellen vorerst alle ELER/i-Antragsmappen mit ihren zugehörigen Blättern dar.
15. Gibt es zu einer "Obertabelle" noch eine "Untertabelle" mit zusätzlichen Details, so sind stets beide Tabellenköpfe darzustellen.
16. Zusätzlich gilt für die Darstellung folgendes:
    Möglichkeit a) Wenn der Sachbearbeiter fachlich alles auf einen Blick haben muss, so müssen beide Tabellen vollständig dargestellt werden.
    Aufbau: Obertabelle Zeile 1
                Zeile 1 der Untertabelle zu Zeile 1 der Obertabelle (eingerückt darstellen)
                Zeile n der Untertabelle zu Zeile 1 der Obertabelle
            Obertabelle Zeile 2
                Zeile n der Untertabelle zu Zeile 2 der Obertabelle
                usw.
    Möglichkeit b) Wenn es fachlich betrachtet nicht nötig ist, den gesamten Inhalt abzudrucken so gilt:
            entweder ist eine Zeile selektiert: dann den dazugehörigen Eintrag der Untertabelle drucken
            oder es ist keine Zeile selektiert: dann wird die Untertabelle gar nicht gedruckt

Ausnahme:

  • Aktuell werden Zeilenumbrüche innerhalb von Tabellen nicht in den Standardreport übernommen. Dieses Problem soll mit der Einführung des Frameworks JasperReports behoben sein. Entscheidung
  • Eine geänderte Spaltenreihenfolge, welche durch das Verschieben von Spaltenköpfen per Drag&Drop entstanden ist, wird ebenfalls nicht in den Standardreport übernommen. Die Spalten werden in der ursprünglichen Reihenfolge dargestellt.

Abweichungen von diesem Standard werden im jeweiligen DK dokumentiert.

Beispiel:

(ÄA / Bewilligungsblatt / Tab: Bewilligte Beträge)


Filter

Ist über den Button "Filter einschalten" eine Filterung durchgeführt worden, ist die Filterzeile als normale Tabellenzeile im Standardreport mit auszugeben.

Die durch die Filterung angepasste Summenzeile ist ebenfalls als Tabellenzeile im Standardreport auszugeben.

Master-Detail-Ansichten

Auf der FAG Allgemeines am 20./21.02.2018 wurde folgendes beschlossen:

Die Mastertabelle wird zeilenweise mittels einer Schleife ausgegeben. Dabei werden je Masterzeile die zugehörigen Detailinformationen im Anschluss an die Masterzeile ausgegeben. Gibt es mehrere Detailtabellen zu einer Mastertabelle sind alle Details im Anschluss an die zugehörige Masterzeile auszugeben. Handelt es sich um ein mehrstufiges Master-Detail-Modell, erfolgt die Ausgabe also rekursiv.

Baumstruktur

Siehe offene Fragen auf Diskussionsseite!

Formatierung:

Die Unterknoten sind wie in der Master-Detail-Ansicht darzustellen. Die Informationen unterhalb eines Knotens werden dabei als Details betrachtet.

Übersicht:

Dieses Bild liefert eine Übersicht über alle Komponenten.


Siehe auch