Best Practice: arcplan Entwicklungsrichtlinien zum Aufbau von Dokumenten

arcplan ist ein Tool, das dem Entwickler wenige Grenzen setzt. Durch seinen Aufbau ist der Entwickler sehr flexibel in der Gestaltung seiner Berichte. Dies ist ein großer Vorteil, da die Berichte dadurch sehr flexibel an die Bedürfnisse der User angepasst werden können. Es kann allerdings auch schnell ein Nachteil werden, da Berichte über mehrere hundert Objekte mit entsprechend vielen Verbindungen verfügen können. Ohne Regeln beim Entwickeln wird eine Anwendung schnell unübersichtlich und schwer wartbar. Dies trifft insbesondere für Dritte oder neue Teammitglieder zu, denen die Einarbeitung in eine Anwendung schwerfällt. Sogar der Entwickler selbst kann hier schon mal den Überblick verlieren.

Um diesem Problem entgegenzuwirken, haben wir nachfolgend ein paar Regeln niedergeschrieben, die sich in unseren Projekten bewährt haben. Diese sind natürlich nur ein Vorschlag und können beliebig erweitert werden. Wichtig ist, dass überhaupt einheitliche Regeln vereinbart werden, ganz unabhängig davon, wie sie konkret ausgestaltet sind.

Funktionsabhängige Färbung

Eine der für uns mittlerweile wichtigsten Regeln ist eine funktionsabhängige Färbung der Objekte. Dazu legen wir auf Ebene 1 die Farben und ihre Bedeutung fest.

 

funktionsabhaengige-faerbung

Gruppieren zusammengehörender Objekten

Eine weitere Regel ist das Gruppieren von Objekten. Um die Ebenen übersichtlicher zu gestalten, ist es sinnvoll, zusammengehörige Objekte z. B. bei der Datenabfrage auch nah beieinander anzuordnen und sie durch ein weiteres Objekt, das als Rahmen dahintergelegt wird, als zusammengehörig zu kennzeichnen.

 

gruppieren-zusammengehoerender-objekte

Aufteilung der Ebenen

Auch die Aufteilung in drei Ebenen ist sinnvoll. So nutzen wir z.B. die erste Ebene für das Laden der Daten aus dem Datenbericht und ihre Aufbereitung für den View. Auch Funktionen wie die Formatierung des Views werden auf dieser Ebene hinterlegt.
Ebene 2 dagegen wird vorwiegend für übergreifende Funktionen wie das Drucken, den Excel-Export oder Favoriten-Funktionen genutzt.
In der verbleibenden Ebene werden die Texte geladen und Objekte hinterlegt, die momentan nicht gebraucht, eventuell später aber wieder benötigt werden.

 

aufteilung-der-ebenen

Keine Pfeile über Ebenen

Ein großes Tabu jeder Anwendung sollten Datenabfragen über mehrere Ebenen sein. Da die Pfeile nicht über Ebenen angezeigt werden, sind die Abfragen nur schwer nachvollziehbar.

 

keine-pfeile-ueber-ebenen

 

Durch das Abschalten der Anzeige von Pfeilen können Verbindungen zwar sichtbar gemacht werden. Allerdings werden sie nur angezeigt, wenn das Zielobjekt markiert ist. Es ist nicht möglich, von Quellobjekten auf Zielobjekte zu kommen.

 

keine-pfeile-ueber-ebene-alternative

Beschreibung von Objekten und Funktionen

Auch bei arcplan-Anwendungen ist es wichtig, Funktionen zu dokumentieren. Hierzu gehört zum einen die Beschreibung an den Objekten selbst, die angibt, wozu die einzelnen Objekte genutzt werden, und zum anderen die Beschreibung der Formeln innerhalb von Objekten

 

beschreibung-von-objekten-und-funktionen 

 

Auch Beschreibungen, die den gesamten Bericht betreffen, sind sehr sinnvoll und helfen dem Entwickler bei seiner Arbeit.

Funktionen

Es ist theoretisch möglich, Funktionen in jedem Objekt auszuführen; dazu stehen die verschiedenen Events wie „nach Aktualisierung“, „bei Anklicken“ etc. zur Verfügung. Dies erschwert allerdings oft die Arbeit. Zum einen muss der Entwickler wissen, in welchen Objekten er Änderungen durchführen muss. Zum anderen können Synergien so nicht ausgenutzt werden.
Die Praxis hat gezeigt, dass es grundsätzlich sinnvoll ist, Funktionen in Buttons zu platzieren und lediglich das Ausführen der Buttons über die Events in den betroffenen Objekten durchzuführen.
Wenn die Buttons sinnvoll beschrieben sind und eventuell auch ein kleiner Kommentar beiliegt, der aufzeigt, durch welches Objekt der Button ausgeführt wird, ist dies auf einen Blick verständlich.

 

funktionen-ausfuehrung

Aktualisierungen auf dem View

Oft müssen beim Umschalten von Menüs verschiedene Funktionen ausgeführt werden. Hierzu gehört beispielsweise das Aktualisieren von Datenabfragen und das Ausführen der Formatierung.
Um nicht jedes Menü beim Umschalten und jede Tabelle beim Aktualisieren mit einer Funktion zu hinterlegen, kann die Aktualisierung in einem Objekt gesammelt werden. Dieses Objekt sollte auf der ersten Ebene beschrieben werden. Wichtig für das Objekt ist vor allem, dass es sichtbar auf dem Bericht liegt, da es nur in diesem Fall aktualisiert wird.

Das Objekt wird im Event „Berechnung“ über die Funktion ISTLEER() * LEER() mit den zu aktualisierenden Objekten verknüpft (siehe Abbildung). Die Formel sorgt dafür, dass das Objekt z. B. beim Umschalten eines Menüs aktualisiert wird.
Zur Erklärung: Die Funktion ISTLEER() prüft, ob das angegebene Objekt über einen Inhalt verfügt, und gibt die Zahl 1 oder 0 zurück. Dies ist wichtig, da die Funktion LEER() multipliziert mit einer Zahl immer einen Leerstring ergibt.
Danach muss nur noch ein AUSFÜHREN()-Befehl in das Event „bei Aktualisierung“ eingebaut werden, sodass, wie im vorherigen Abschnitt beschrieben, ein Button ausgeführt wird.

 

aktualisierung-view

Views: 262
clear