Standardreport (Formatierung): Unterschied zwischen den Versionen

Aus ProfilGlossar
Wechseln zu: Navigation, Suche
(Artikel wurde geändert)
(Artikel wurde geändert)
Zeile 127: Zeile 127:
   
 
=== Welcher Stand der GUI soll im Report wiedergegeben werden? ===
 
=== Welcher Stand der GUI soll im Report wiedergegeben werden? ===
  +
'''Für Mappen gilt:''' Es gab vor längerer Zeit eine Entscheidung in der FAG Allgemeines des ZIAF-Verbundes, die besagte, dass bei einem Standardreport das zu drucken ist, was man sieht.
'''Für Mappen gilt:''' Es soll der letzte gespeicherte Stand im Report erscheinen.
 
   
 
'''Für Sucher/Auswerter gilt:''' Nur Seitenansicht erstellen lassen, wenn bereits eine Suche/Auswertung erfolgt ist.
 
'''Für Sucher/Auswerter gilt:''' Nur Seitenansicht erstellen lassen, wenn bereits eine Suche/Auswertung erfolgt ist.
Zeile 135: Zeile 135:
   
   
'''Hinweis:''' Das gilt nur für neue/geänderte Werkzeuge gelten, da sie sonst alle geändert werden müssen und wir entsprechend Angebote schreiben müssten.
+
'''Hinweis:''' Das gilt nur für neue/geänderte [[Werkzeug]]e gelten, da sie sonst alle geändert werden müssen und wir entsprechend Angebote schreiben müssten.
 
   
 
=== Text- und Overlayformatierung ===
 
=== Text- und Overlayformatierung ===

Version vom 14. Oktober 2014, 11:05 Uhr


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.


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.

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 er erstellt wurde


Titel:

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

Untertitel:

Wenn es einen Untertitel gibt, kommt unter den Titel eine 0,25 pt dünne waagerechte Linie.
Danach folt der Untertitel. 
Dieser wird linksbündig unter der 0,25 pt dünnen Linie dargestellt. 
Die erste Zeile des Untertitels wird nicht 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 1,5 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. Er enthält eine waagerechte Linie und eine Seitenzahl.

Linie:

Den Anfang eines jeden Footers bildet eine 0,5 pt dünne waagerechte Linie.

Seitenzahl:

Unter der waagerechten Linie, rechts ausgerichtet, folgt eine Seitenzahl.
Es gibt 2 Varianten diese Seitenzahl darzustellen:
   1. Seite: "X" (-> Nur wenn der Standardreport lediglich 1 Seite hat)
   2. Seite "X" von "Y" (-> Wenn der Standardreport länger als eine Seite ist)

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 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 gab vor längerer Zeit eine Entscheidung in der FAG Allgemeines des ZIAF-Verbundes, die besagte, dass bei einem Standardreport das zu drucken ist, was man sieht.

Für Sucher/Auswerter gilt: Nur Seitenansicht erstellen lassen, 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."


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

Text- und Overlayformatierung

Schriftart

Als Schriftart wird eine Schriftart mit Serifen ("Times Roman") verwendet. Ausnahmen bilden alle Überschriften, die mit einer serifenlosen Schriftart versehen sind ("Helvetica").

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 Tabelleninhalten sowie Tabellenkopf wird die Schriftgröße 8 verwendet.
Der Tabellenkopf wird fett geschrieben. 

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 können, 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 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 Label geändert werden.



Tabs

Wenn das Dokument/die GUI, aus dem der Standardreport erstellen wird, mehrere Tabs enthält, 
wird jeder Tab auf eine eigene Seite im Standardreport gelegt. 
Der Name des Tabs befindet sich unter der 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 dann, wenn die einzelnen Tabs zusammen so wenig Informationen enthalten, 
dass es keinen Sinn machen würde, jedes Tab auf eine eigene Seite zu legen.

Textfelder und Labels:

Formatierung:

Labels werden fett geschrieben und mit einem Doppelpunkt abgeschlossen.
Sie 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 markierten Checkboxen bekommen im Standardreport ein ja, alle nicht markierten 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örigem 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!


Mehrfachauswahlfelder:

Formatierung:

Aus dem Mehrfachauswahlfeldern werden nur, die vom Benutzer, ausgewählten Elemente im Standardreport dargestellt.
Sie werden rechts neben dem zugehörigem 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 | 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 | 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.  Alle Tabellen haben eine Überschrift.
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 Tabellenkörper wird immer weiß hinterlegt.
6.  Wenn die Tabelle über eine Seite hinaus geht, wird der Tabellenkopf auf jeder Seite wiederholt.
7.  Die Spaltenüberschriften werden linksbündig ausgerichtet.
8.  Die Ausrichtung der Werte im Tabellenkörper erfolgt analog zum weiter oben beschriebenen Verfahren.
9.  Alle Einheiten, die in der Tabelle benutzt werden, werden im Tabellenkopf angegeben und nicht im Tabellenkörper.
10. Die Spaltenbreiten der Tabelle sind variabel, sollten aber sinnvoll und am Inhalt angepasst sein.
11. Die Tabelle (als Ganzes betrachtet) linksbündig auf dem Standardreport dargestellt werden.
12. Das Datumsformat lautet wie folgt: dd.mm.yyyy - hh:mm:ss
13. Es sollen keine leeren Seiten gedruckt werden. Dies könnte z.B. passieren, wenn einzelne Tabs in der GUI ausgegraut sind und somit keinen Inhalt haben.
14. Die in der GUI vorgenommene Sortierung (aufsteigend/absteigend) soll im Report übernommen werden.
15. Gibt es zu einer "Obertabelle" noch eine "Untertabelle" mit zusätzlichen Details, 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

Abweichungen von diesem Standard werden im jeweiligen DK dokumentiert.

Beispiel:

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


Baumstruktur:

Siehe offene Fragen auf Diskussionsseite!

Formatierung:

Für die Darstellung einer Baumstruktur in einem Standardreport wird immer eine Tabellenform benutzt,
allerdings gibt es 2 verschiedene Möglichkeiten:

1.  - In der ersten Spalte steht die Anwendung
    - In der zweiten Spalte stehen alle Knoten bis zum Blatt aufgelistet,
      wobei die einzelnen Knoten mit einem "/" getrennt sind
    - In der dritten und letzten Spalte steht der Name des Blattes
   (Bspw.: Anwendung: Profil Eler | Kategorie: Profil Eler/ Antrag / FP 3801 | Recht: Ausfuehren

2. - Erste Spalte aus der ersten Möglichkeit wird weggelassen
   - In der ersten Spalte steht die "Anwendung" mit dem kompletten Weg über Knoten bis zum Blatt
   - In der zweiten Spalte der Name des Blattes
   - Und in den folgenden Spalten (wenn vorhanden) die Attribute.(Bspw. "Bestätigt")

Beispiele:

Möglichkeit 1:
(Rollenverwalter)
Möglichkeit 2:
(Nutzerverwalter /
Tab: Reche/Rollen)

Übersicht:

Dieses Bild liefert eine Übersicht über alle Komponenten.


Siehe auch