WebApps:Planungsassistent

Aus CoPlanner 11
Zur Navigation springenZur Suche springen


Erstellen eines XML-Templates für den Planungsassistenten

In CoPlanner besteht die Möglichkeit, einen Assistenten zu definieren, mit dem eine einfache Planung erstellt werden kann.

Damit man das Verhalten des Assistenten festlegen kann, wird derzeit ein XML-Template verwendet.

In diesem Abschnitt wird kurz beschrieben, wie man ein derartiges Template baut.

Grundlegender Aufbau des Templates

Die Datei, die für die Beschreibung eines Templates verwendet wird, ist gegliedert in vier Abschnitte:

  • Dimensionen (Tag PreselectedDimensions): hier werden die Dimensionen angegeben, welche in der Planung immer vorhanden sein müssen. Diese können vom Benutzer nicht gelöscht werden und müssen im System bestehen.
  • Parameter (Tag Parameters): hier können vom Benutzer Eingaben eingefordert werden, die für das Weiterschreiben notwendig sind (z.B. welches Measure der neuen Planung entspricht dem Umsatz, den ich weiterschreiben will)
  • Formeldefinitionen (Tag FormulaTemplates): nachdem eine Planung alleinstehend oft nicht viel Sinn macht, kann man hier Formeln definieren, um die neuen Inhalte in den Rechenkern zu integrieren. Hier kann auf die Parameter zugegriffen werden.
  • Tiles-Einbettung (Tag TilesInformation): in diesem Abschnitt kann definiert werden, wo die Kachel, hinter der die Matrixmaske zur neuen Planung hinterlegt ist, erzeugt werden soll

Erklärung anhand eines Beispiels

Wir wollen einen einfachen Assistenten bauen, mit dem der Benutzer einen Umsatz planen kann. Der Benutzer muss somit angeben, wo in der Zieltabelle der Umsatz steht.

Der doppelte Wert (um Berechnungen zu demonstrieren) soll dabei um n Monate versetzt (um die Berechnung eines Zeitversatzes zu demonstrieren) in die Tabelle TBL_Ergebnis_PLAN geschrieben werden. Den Wert für n gibt der Benutzer dabei im Assistenten an.

Zusätzlich soll der Benutzer angeben, auf welchem Element der GuVGKV der Umsatz landen soll. Die vom Benutzer erstellte Planung soll auch noch eine Projektedimension enthalten, die einfach 1:1 weitergeschrieben wird

Abschnitt Dimensionen

Für das oben angeführte Beispiel werden in der erzeugte Planung die beiden Dimensionen Zeit und Projekte benötigt, dies wird durch folgenden Abschnitt sichergestellt (dabei bekommt die Dimension in der Tabelle keinen anderslautenden Alias).


<PreselectedDimensions>

       <PreselectedDimension>

               <UniqueNameInTable>Zeit</UniqueNameInTable>

               <CopDimensionName>Zeit</CopDimensionName>

       </PreselectedDimension>

       <PreselectedDimension>

               <UniqueNameInTable>Projekte</UniqueNameInTable>

               <CopDimensionName>Projekte</CopDimensionName>

       </PreselectedDimension>

</PreselectedDimensions>

Abschnitt Parameter

Im Beispiel muss der Benutzer folgende Festlegungen treffen:

  •  Auswahl eines Measures, auf dem die Umsätze stehen
  •  Auswahl eines Dimensionselementes aus der Dimension GuVGKV
  •  Angabe eines Monatsversatzes, mit dem der Umsatz übernommen werden soll


Dies wird mit folgendem Abschnitt in der xml-Datei erreicht:

<Parameters>

       <Measure>

               <Id>Umsaetze</Id>

               <Caption>Umsätze</Caption>

               <Description>Wählen Sie das Measure aus, das die Umsätze enthält</Description>

       </Measure>

       <Dimension>

               <Id>GuvGKVSelection</Id>

               <Caption>Guv-Struktur</Caption>

               <Description>Bitte wählen Sie das passende Element aus der GuV-Struktur aus</Description>

               <DimensionName>GuVGKV</DimensionName>

       </Dimension>

       <Value>

               <Id>Monatsversatz</Id>

               <Caption>Versatz in Monaten </Caption>

               <Description>Geben Sie den Versatz in das Zahlungsziel in Monaten an</Description>

       </Value>

</Parameters>


Abschnitt Formeldefinitionen

Im Beispiel wird eine einzige Formel benötigt, die den Wert aus der neu erstellten Planung weiterschreibt.

Bei der Definition der Formeltemplates kann mit m“#“ auf Parameter zugegriffen werden, so liefert z.B. „#Umsatze#“ den Wert des Measures, der im Assistenten für den Parameter Umsätze ausgewählt wurde. Der Aufbau dieses Bereiches orientiert sich dabei am Aufbau einer Mengenformel


Dies wird mit folgendem Abschnitt erreicht:

<FormulaTemplates>

       <FormulaTemplate>

               <Name>Ergebnis</Name>

               <TargetTable>TBL_Ergebnis_PLAN</TargetTable>

               <MeasureAssignments>

                       <MeasureAssignment>

                               <Source>2.0 * #Umsaetze#</Source>

                               <Target>Wert LC</Target>

                       </MeasureAssignment>

               </MeasureAssignments>

               <DimensionAssignments>

                       <DimensionAssignment>

                               <Source>Projekte</Source>

                               <Target>Projekte</Target>

                       </DimensionAssignment>

                       <DimensionAssignment>

                               <Source>FKT_TimeDimAdd(‚M‘,#Monatsversatz#, #Zeit#)</Source>

                               <Target>Zeit</Target>

                       </DimensionAssignment>

                       <DimensionAssignment>

                               <Source>#GuvGKVSelection# </Source>

                               <Target>GuVGKV</Target>

                       </DimensionAssignment>

               </DimensionAssignments>

       </FormulaTemplate>

</FormulaTemplates>


Um fixe Dimensionswerte (mit Hilfe einer Anwendungseigenschaft) zu schreiben, kann folgendes verwendet werden:

                       <DimensionAssignment>

                               <Source>@Session_Entity_ID@</Source>

                               <Target>Unternehmen</Target>

                       </DimensionAssignment>

Abschnitt Tiles-Einbettung

Damit der Assistent weiß, an welcher Stelle in den Tiles die neu erstellte Planung einfügt werden soll, wird folgender Abschnitt benötigt:

<TilesInformation>

       <TilesId>@NAV_Target@</TilesId>

       <TilesImageName>Img\Tiles\investitionen.png</TilesImageName>

       <TilesInsertOption>AsChild</TilesInsertOption>

</TilesInformation>

Exkurs XML

XML steht für Extensible Markup Language (https://de.wikipedia.org/wiki/Extensible_Markup_Language) und ist eine einfache Sprache zur Darstellung von hierarchischen Strukturen in Form einer Textdatei. Wichtig dabei zu wissen ist, dass XML mit Tags arbeitet, und Elemente jeweils mit einem Starttag beginnen und mit einem Endtag enden. Will man z.B. ein Element „Vorname“ definieren, dann kann das wie folgt aussehen:

<Vorname>

      Josef

</Vorname>


Dabei ist <Vorname> das Starttag, „Josef“ der Wert des Elements und „</Vorname>“ das Endtag.

In XML kann man auch Kommentare in die Datei schreiben, Kommentare haben dabei folgendes Format

<!-- ein Bespielkommentar -->


Um gut mit XML arbeiten zu können, empfiehlt sich die Verwendung eines Editors, der XML unterstützt (z.B. Notepad++ mit XML Tools Erweiterung, VS Code, …)