In den PLANOUT Reports können zur Abfrage von Benutzereingaben nur Widgets benutzt werden. Diese müssen über ein entsprechendes xml- Dokument mit den für sie gültigen Werten befüllt werden, um Fehler zu vermeiden. Dazu gibt es für jedes Widget eine mehr oder weniger unterschiedliche Anzahl an Parametern, mit entsprechendem Einfluss auf das Widget.

Widgets mit mehreren Rückgabewerten hängen an den Namen des jeweiligen defaultValue einen weiteren Bezeichner an, z.B.: <defaultValue name="reportKeyStart"> oder <defaultValue name="reportKeyEnd">. In den meisten Fällen gilt: Ist ein Key oder dazugehöriger Wert nicht angegeben, wird im Widget ein Default verwendet, dies ist jedoch zu vermeiden! In manchen Fällen kann ein leerer Wert angegeben werden, um nichts anzuzeigen, hauptsächlich in den Label- Bereichen. Die derzeit verwendeten Einträge sind:

<defaultValue name="headLine"> Hier wird die im Widget angezeigte Überschrift angegeben. Hier wären mehrere (angehängte) Bezeichner eher unwahrscheinlich.

<defaultValue name="defaultValue"> Hier wird der voreingestellte Wert angegeben. Dieser wird meist vorher im Widget mit einem Default erzeugt und dann mit dem hier angegebenen überschrieben, wenn möglich.

<defaultValue name="reportKey"> Hier muss der Key eingegeben werden, der im Report den eingegebenen Wert annehmen soll. Damit ist es auch möglich, ein Widget mehrfach zu verwenden.

<defaultValue name="label"> Hier wird bei manchen Widgets der Text angegeben, der vor oder hinter einem Auswahlfeld steht.

<defaultValue name="param"> Hier wird bei manchen Widgets ein Steuerungsparameter angegeben, der z.B. Einfluss auf die Gültigkeitsprüfungen nehmen kann.

 

 

---

 

 

Die xml Files benötigen folgenden Aufbau:

<params>

 <header>

         <reportName></reportName>

         <reportDescription></reportDescription>

         <startPoint></startPoint>

 </header>

 <widget>

         ...

 </widget>

</params>

 

 

 

 

Die derzeitigen Widgets und ihre Einträge:

 

Beispielhafte xml- Dateiabschnitte für die derzeitigen Widgets mit bisher gültigen Werten:

Achtung! In den Widgets darf kein "ä", "ü" oder "ö" vorkommen.

 

 

PORepBooleanWidget = Erzeugt eine Checkbox mit der gewählt werden kann(z.B. Ja/Nein - An/Aus)

 

 <widget>

         <class>de.opencom.planout.poServer.report.jasper.gui.widgets.PORepBooleanWidget</class>

         <defaultValue name="defaultValue">false</defaultValue>

         <defaultValue name="headLine">Langnamen benutzen</defaultValue>

         <defaultValue name="label">versuche bevorzugt Langnamen zu nutzen</defaultValue>

         <defaultValue name="reportKey">Langnamen_benutzen</defaultValue>

 </widget>

 

 

-headLine                String; voreingestellt: „Bedingung“; leer möglich

-label                        String; voreingestellt: „Bedingung“; leer möglich

-defaultValue                Boolean; voreingestellt: false; per Boolean.parseBoolean() ermittelt

-reportKey                String; voreingestellt: „condition“

 

 

---

 

 

PORepStringWidget = Erzeugt ein Textfeld mit dem eine Zeichenkette vom User eingegeben werden kann

 <widget>

         <class>de.opencom.planout.poServer.report.jasper.gui.widgets.PORepStringWidget</class>

         <defaultValue name="headLine">Reporttitel</defaultValue>

         <defaultValue name="defaultValue">Testreport</defaultValue>

         <defaultValue name="reportKey">Titel</defaultValue>

 </widget>

 

 

-headLine                String; voreingestellt: „Text eingeben“; leer möglich

-defaultValue                String; voreingestellt: leer; leer möglich

-reportKey                String; voreingestellt: „string“

 

 

---

 

 

PORepTimeFromToWidget = Erzeugt einen Kalenderdialog mit dem ein Start- und Enddatum eingegeben werden kann

 <widget>

         <class>de.opencom.planout.poServer.report.jasper.gui.widgets.PORepTimeFromToWidget</class>

         <defaultValue name="defaultValueStart">01.01.2009</defaultValue>

         <defaultValue name="defaultValueEnd">18.01.20010</defaultValue>

         <defaultValue name="reportKeyStart">angezeigtes_Startdatum</defaultValue>

         <defaultValue name="reportKeyEnd">angezeigtes_Enddatum</defaultValue>

         <defaultValue name="headLine"></defaultValue>

         <defaultValue name="labelFrom"></defaultValue>

         <defaultValue name="labelTo"></defaultValue>

         <defaultValue name="paramStartBeforeEndCheck"></defaultValue>

 </widget>

 

 

-defaultValueStart                Date, laut Konvention; voreingestellt: „new Date()“; leer möglich

-defaultValueEnd                Date, laut Konvention; voreingestellt: „new Date()“; leer möglich

-reportKeyStart                String; voreingestellt: „startDate“

-reportKeyEnd                        String; voreingestellt: „endDate“

-headLine                        String; voreingestellt: „Zeitbereich wählen“; leer möglich

-labelFrom                        String; voreingestellt: „von: “; leer möglich

-labelTo                        String; voreingestellt: „bis: “; leer möglich

-paramStartBeforeEndCheck        Boolean; voreingestellt: true; leer möglich, sonst ausschließlich „true” oder „false“ (nicht case sensitive); per Boolean.parseBoolean() ermittelt

 

 

---

 

 

PORepTimeWeekYearWidget = Erzeugt eine Auswahl zur Eingabe von Wochen- und Jahreszahl

 <widget>

         <class>de.opencom.planout.poServer.report.jasper.gui.widgets.PORepTimeWeekYearWidget</class>

         <defaultValue name="defaultValueYear">2007</defaultValue>

         <defaultValue name="defaultValueWeek">45</defaultValue>

         <defaultValue name="headLine">Woche waehlen</defaultValue>

         <defaultValue name="reportKeyYear">Jahr</defaultValue>

         <defaultValue name="reportKeyWeek">Woche</defaultValue>

         <defaultValue name="labelWeek">Woche: </defaultValue>

         <defaultValue name="labelYear">Jahr: </defaultValue>

 </widget>

 

 

-defaultValueYear                Integer (1-4000); voreingestellt: Integer „Jahr“ von new Date(); leer möglich

-defaultValueWeek                Integer (1-52/53); voreingestellt: Integer „Woche“ von new Date(); leer möglich

-reportKeyWeek                String; voreingestellt: „week“

-reportKeyYear                String; voreingestellt: „year“

-headLine                        String; voreingestellt: „Woche wählen“; leer möglich

-labelWeek                        String; voreingestellt: „Woche: “; leer möglich

-labelYear                        String; voreingestellt: „Jahr: “; leer möglich

 

 

---

 

 

PORepResourcesWidget = Erzeugt eine Ressourcenauswahl, je nach Einstellung auch mit Unterressourcen

 <widget>

         <class>de.opencom.planout.poServer.report.jasper.gui.widgets.PORepResourcesWidget</class>

         <defaultValue name="defaultValue"></defaultValue>

         <defaultValue name="reportKey">resourceIDs</defaultValue>

         <defaultValue name="paramAmountResReturned">11</defaultValue>

         <defaultValue name="headLine">Die anzuzeigende Ressource.</defaultValue>

         <defaultValue name="labelBoxWithSub">mit Unterressourcen</defaultValue>

         <defaultValue name="paramWithSub">false</defaultValue>

         <defaultValue name="paramCanChooseWithSub">false</defaultValue>

         <defaultValue name="paramShowBoxWithSub">false</defaultValue>

         <defaultValue name="paramMustReturnValue">false</defaultValue>

 </widget>

 

 

-defaultValue                        String; voreingestellt: leer; leer möglich; gültig: [„int, int, int, …“] bei gültigen IDs

-reportKey                        String; voreingestellt: „ ressources “

-headLine                        String; voreingestellt: „Ressourcen wählen“; leer möglich

-labelBoxWithSub                String; voreingestellt: „incl. aller Unterressourcen“; leer möglich

-paramWithSub                boolean; voreingestellt: „false“; MUSS zu anderen Parametern passen!

-paramCanChooseWithSub        boolean; voreingestellt: „true“; MUSS zu anderen Parametern passen! (z.B. paramAmountResReturned)

-paramShowBoxWithSub        boolean; voreingestellt: „true“; MUSS zu anderen Parametern passen!

-paramAmountResReturned        Integer (11, 12, 21, 22); voreingestellt: 11; gültig entsprechend den Konstanten in der Klasse 11=eine, 12=eine und Unterr., 21=mehrere, 22=mehrere und Unterr.; MUSS zu                                        anderen Parametern passen!

-paramMustReturnValue        boolean; voreingestellt: „false“; MUSS zu anderen Parametern passen!

 

 

---

 

 

PORepTasksWidget = Erzeugt eine Vorgansauswahl

 <widget>

         <class>de.opencom.planout.poServer.report.jasper.gui.widgets.PORepTasksWidget</class>

         <defaultValue name="defaultValue"></defaultValue>

         <defaultValue name="reportKey">projectIDs</defaultValue>

         <defaultValue name="paramAmountTasksReturned">11</defaultValue>

         <defaultValue name="headLine">Das Projekt das angezeigt werden soll.</defaultValue>

         <defaultValue name="labelBoxWithSub">mit Untervorgaengen</defaultValue>

         <defaultValue name="paramWithSub">false</defaultValue>

         <defaultValue name="paramCanChooseWithSub">false</defaultValue>

         <defaultValue name="paramShowBoxWithSub">false</defaultValue>

         <defaultValue name="paramMustReturnValue">false</defaultValue>

         <defaultValue name="paramShowOnlyProjects">true</defaultValue>

 </widget>

 

 

-defaultValue        String; voreingestellt: leer; leer möglich; gültig: [„int, int, int, …“] bei gültigen IDs

-reportKey                String; voreingestellt: „ tasks “

-headLine                String; voreingestellt: „Vorgang wählen“; leer möglich

-labelBoxWithSub        String; voreingestellt: „incl. aller Untervorgänge“; leer möglich

-paramWithSub                boolean; voreingestellt: „false“; MUSS zu anderen Parametern passen!

-paramCanChooseWithSub        boolean; voreingestellt: „true“; MUSS zu anderen Parametern passen! paramAmountResReturned

-paramShowBoxWithSub        boolean; voreingestellt: „true“; MUSS zu anderen Parametern passen!

-paramAmountTasksReturned        Integer (11, 12, 21, 22); voreingestellt: 11; gültig entsprechend den Konstanten in der Klasse 11=eine, 12=eine und Untervorg., 21=mehrere, 22=mehrere und Untervorg.; MUSS zu anderen Parametern passen!

-paramMustReturnValue        boolean; voreingestellt: „false“; MUSS zu anderen Parametern passen!

-paramShowOnlyProjects        boolean; voreingestellt: „false“;