Seitenhistorie
Inhalt | ||
---|---|---|
|
Allgemein
Für die Regelprogrammierung müssen Informationen
...
zu den
...
Businessobjekten, den Statusmodellen und anderen Nuclos-Einheiten zur Verfügung stehen. Damit der Zugriff und die Verwendung möglichst einfach und fehlerfrei bleibt, werden diese Daten objektiviert als Java-Klassen bereit gestellt. Diese Java-Klassen können dann aus den Regeln heraus aufgerufen und benutzt werden.
Folgende Typen von unterstützenden Klassen gibt es:
Typ | Beschreibung | Suffix |
---|---|---|
BusinessObjekt | Ein BusinessObjekt |
...
ist z.B. Auftrag oder Kunde. Die dazugehörenden Felder werden aus den Meta- |
...
Informationen gelesen und als Attribute in die Klasse geschrieben. Ja nach Art des |
...
Attributs und der Zugriffsrechte werden setter und getter- |
...
Methoden zum Setzen und Auslesen von Werten zur Verfügung gestellt. Wird mittels |
...
Businessobjekt eine |
...
neus Businessobjekt angelegt oder eine bestehende verändert oder gelöscht, werden mit |
...
dem erfolgreichen Abschluss des Speichervorgangs |
...
alle Änderungen in dem dazugehörenden BusinessObjekt vorgenommen und im Classloader |
...
abgelegt. Damit stehen die Änderungen sofort zur Verfügung. Allgemeine Konventionen:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Beispiel eines BusinessObjekts "Adresse":
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Im Constructor des BusinessObjects werden alle Boolean-Pflichtfelder mit "FALSE" vorbelegt. Der Constructor sieht dann beispielsweise so aus:
| -- | |||
Statusmodell-Klasse | Eine Statusmodell-Klasse ist eine Java-Klasse, die fachlich einem in Nuclos erstellen Statusmodell entspricht. |
...
Statusmodell-Klassen werden in der Regelprogrammierung verwendet, um eine einfache und sichere Gestaltung von beispielsweise Statuswechseln zu gewährleisten. Allgemeine Konventionen:
|
...
|
...
|
...
Beispiel der Statusmodell-Klasse "AuftragSM":
|
...
Die hinterlegten Status können für manuelle Statuswechsel |
...
im StatemodelProvider verwendet werden. | SM |
Arbeitsschritt-Klasse | In Nuclos können Arbeitsschritte erstellt werden. Um auch innerhalb von Regeln |
...
Arbeitsschritte manuell ausführen zu können, werden nach |
...
dem erfolgreichen Speichern eines Arbeitsschrittes sogenannte Arbeitsschritt-Klassen |
...
oder auch Generation-Klassen erstellt. Diese können |
...
über den GenerationProvider gestartet werden. |
...
Eine Arbeitsschritt-Klasse ist mittels Generics typsicher aufgebaut und legt Quell- und |
...
Zielobjekte als BusinessObjekte |
...
fest. Allgemeine Konventionen:
Beispiel der Arbeitsschritt-Klasse "ErstelleRechnungAusAuftragGEN":
|
...
GEN | |
ReportDatasource-Klasse | ReportDatasource-Klassen stellen objektivierte Datenquellen aus "Report und Formular" dar. Werden in Nuclos Quellen für Report und Formular angelegt, wird eine entsprechende Report-Klasse erstellt. Diese kann in der Regelprogrammierung als Quelle verwendet und über den DatasourceService aufgerufen werden. Allgemeine Konventionen:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
Report-Klassen
Beispiel der ReportDatasource-Klasse "ExportRechnungsdatenDS":
| DS | ||
Report-Klasse | Wird in Nuclos ein Report |
...
angelegt, wird eine entsprechende Report-Klasse erstellt. Diese kann |
...
in der Regelprogrammierung |
...
verwendet und über den |
...
ReportService ausgeführt werden. Innerhalb der generierten Java-Klasse werden alle Ausgabeformate als Konstanten abgelegt, die der Benutzer in Nuclos für diesen Report hinterlegt hat. Soll aus einer Regel heraus ein Report ausgeführt werden, muss das Ausgabeformat mit angegeben werden.
Allgemeine Konventionen:
|
...
|
...
|
...
|
...
Beispiel der Report-Klasse "MeinAuftragReportRE":
| RE | ||||
Printout-Klassen (Formulare) | Wird in Nuclos ein Formular angelegt, wird eine entsprechende Formular-Klasse, bzw. Printout-Klasse erstellt. Diese kann in der Regelprogrammierung verwendet und über den PrintoutService ausgeführt werden. Innerhalb der generierten Java-Klasse werden alle Ausgabeformate als Konstanten abgelegt, die der Benutzer in Nuclos für dieses Formular hinterlegt hat. Soll aus einer Regel heraus ein Formular ausgeführt werden, muss das Ausgabeformat und die Id des Datensatzes, der zur Befüllung des Formulars verwendet werden soll, mit angegeben werden.
Allgemeine Konventionen:
Beispiel der Printout-Klasse "AngebotPO":
|
...
|
...
|
...
| PO | |||
ImportStrukturDefintion-Klassen | Wird in Nuclos eine ImportStrukturDefinition angelegt, wird eine entsprechende Definition-Klasse erstellt. Diese kann in der Regelprogrammierung verwendet und über den ImportProvider ausgeführt werden. Innerhalb der generierten Java-Klasse wird die interne Nuclos-Id der Strukturdefinition abgelegt. Allgemeine Konventionen:
| ISD | ||
System- und Nucletparameter | NucletParameter: Wird in Nuclos ein Nuclet Parameter angelegt, wird für das entsprechende Nuclet eine Parameter-Klasse generiert, die in der Regelprogrammierung mittels ParameterProvider verwendet werden kann. Innerhalb der generierten Java-Klasse wird der neue Parameter als Konstante angelegt. Allgemeine Konventionen:
|
...
|
...
SystemParameter: Werden in Nuclos Systemparameter über "Parameter" angelegt, wird die Klasse "NuclosSystemParameter" generiert. Diese beinhaltet alle SystemParameter, die nicht einem Nuclet zugewiesen sind, und kann mittels ParameterProvider verwendet werden. Allgemeine Konventionen:
|
...
|
...
|
...
|
Klassengenerierung und Regelkompilierung
Allgemein
...
Für die oben beschriebenen Klassen gelten bestimmte Regeln und Reihenfolgen, in der sie erstellt und bereitgestellt werden. Die Klassen werden je nach Typ
...
kompiliert und gruppiert in einer eigenen Jar im
...
CodeGenerator-Verzeichnis abgelegt. Von dort aus werden die Archive in den Classloader aufgenommen und können verwendet werden.
Typ | Klasse | Reihenfolge der Generierung |
---|---|---|
BusinessObjekte |
...
BOEntities.jar |
...
Die BusinessObjekte können als erstes erstellt werden, da sie lediglich auf die Meta-Informationen der Businessobjekt zurückgreifen müssen. | |
Report-Datasource-Klassen | ReportDSEntities.jar |
...
Die Report-Klassen können unabhängig von anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Reports zugreifen. |
Arbeitsschritt-Klasse |
...
Generation.jar | Die Arbeitsschritte verwenden als Quell- und Zielobjekte BusinessObjekte. Die Arbeitsschritt-Klassen können somit erst erstellt und kompiliert werden, wenn die BusinessObjekte in der BOEntities.jar fehlerfrei gebaut wurden und zur Verfügung stehen. | |
Statusmodell-Klasse | statemodels.jar | Die Statusmodell-Klassen können unabhängig von anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Statusmodelle zugreifen. |
Regeln und Bibliotheken | Nuclet.jar | Die Regeln werden immer als letztes gebaut, das sie auf alle BusinessObjekte, Report-, Statusmodel- und Arbeitsschritt-Klassen zugreifen können. Die Generierung der genannten Klassen ist somit eine notwendige Vorbedingung zur Erstellung der Nuclet.jar. Sollte es im Vorfeld Fehler geben, wird die Nuclet.jar nicht gebaut. Ein weiterer Grund dafür, dass die Nuclet.jar nicht gebaut werden kann, sind ungültige Referenzen, die Regeln untereinander besitzen. Wird z.B. die Signatur einer Utility-Klasse, die von einer Regel aufgerufen wird, verändert, dann die Regel nicht mehr kompiliert werden. Da beide zum Typ "Regeln und Bibliotheken" gehören, lässt sich die Nuclet.jar trotz korrekter Arbeitsschritt-Klassen, BusinessObjekte etc. nicht kompilieren. Sind diese jedoch strukturell in Ordnung, werden alle Klassen des Typs "Regeln und Bibliotheken" in einem Schritt kompiliert und im Archiv abgelegt. |
Report-Klassen | ReportEntities.jar | Die Report-Klassen können unabhängig von anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Reports zugreifen. |
Printout-Klassen | PrintoutEntities.jar | Die Printout-Klassen können unabhängig von anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Formulare zugreifen. |
ImportStrukturDefintion- Klassen | ImportStructDefsEntities.jar | Die ImportStrukturDefintion-Klassen können unabhängig von den anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Definitionen zugreifen. |
System- und Nucletparameter | Parameter.jar | Die System- und Nucletparameter können unabhängig von den anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Nuclets / Systemparameter zugreifen. |
Zeitpunkt der Generierung
Systemstart
Bei Systemstart werden alle der genannten Klassen neu gebaut und im Classloader bereitgestellt. Dazu werden alle vorhanden Klassen und Archive aus dem Codegenerator-Verzeichnis gelöscht. Sollte es an dieser Stelle zu einem Fehler kommen, bleiben die Verzeichnisse (teilweise) leer. Der Server startet weiterhin.
Import eines Nuclets
Mit dem Import eines Nuclets ändert sich in Nuclos alles. Es werden neue Strukturen eingespielt, neue Businessobjekte, Statusmodelle, etc. Logischerweise müssen alle bereits erstellen Klassen gelöscht und der neuen Umgebung entsprechend generiert werden. Auch hier kann es bei ungültigen Daten zu Fehlern und somit zu Fehlermeldungen bei der Kompilierung von Klassen kommen.
Laufzeit
Auch zur Laufzeit können sich Strukturen von Businessobjekten, Statusmodell, etc. ändern, was eine Anpassung und Neuerstellung der Java-Klassen notwendig macht. Wird eine Businessobjekt verändert, muss das entsprechende BusinessObjekt neu erstellt werden. Das Nuclet.jar und das Generation.jar mit den Arbeitsschritten im Anschluss ebenfalls, da sie mit dem betroffenen BusinessObjekt evtl. arbeiten. Für die Sicherstellung der Datenstrukturen ist das notwendig.
Report-Klassen, Arbeitsschritt-Klassen und Statusmodell-Klassen fordern ebenfalls eine Neugenerierung des Nuclet-jars, sollte im entsprechenden Editor das Modell verändert worden sein (löschen, anlegen oder aktualisieren).
Beispiel: In Nuclos wird ein Statusmodell im Editor geladen und dadurch verändert, dass ein Status hinzugefügt wird: Status 40 "Auftrag in Bearbeitung". Mit dem Speichern des Modells wird nun eine neue Statusmodell-Klasse "AuftragSM" erstellt, die diesen Status beinhaltet. Daraufhin erstellen wir eine Regel, die über den StatusmodelProvider eine gegebene Instanz eines Auftrags auf den neuen Status 40 anheben soll. Also einen Statuswechsel vornimmt. Mit dem Speichern der Regel soll die Nuclet.jar neu gebaut werden. Wurde "AuftragSM" korrekt erstellt, kann das Nuclet.jar mit unserer neuen Regel problemlos erstellt werden.
Nun soll aus nicht näher bekannten Gründen der neue Status ein anderes Numeral erhalten. Der Wert wird von 40 auf 50 gesetzt. Mit dem Speichern wird wie zuvor eine neue Statusmodell-Klasse erzeugt, die mit dem Status 50 aktuell ist. Dennoch erscheint jetzt eine Fehlermeldung, die besagt, dass eine Regel nicht kompiliert werden kann! Was ist passiert? Die Statusmodell-Klasse wurde zwar erfolgreich verändert und neu kompiliert. Unsere Regel möchte aber immer noch einen Auftrag auf den Status 40 anheben und findet diesen Status nun nicht mehr. Damit ist die Regel nicht mehr kompilierbar und die Nuclet.jar nicht baubar. Als Folge müssen alle Referenzen auf den Status 40 manuell aktualisiert werden. In unseren Fall eine Regel.
Strukturell müssen alle Informationen korrekt sein und dürfen gegen keine Java-Konvention verstoßen, da sonst die Klassen nicht erstellt werden können. Weitere Informationen finden Sie unter Probleme und Lösungen.
Regelkompilierung
...