Zum Ende der Metadaten springen
Zum Anfang der Metadaten

 

Seit Version 3.2.0 wird eine neues Application Programming Interface entwickelt, mit dem diverse Aspekte in Nuclos flexibel und komfortabel konfiguriert werden können sollen. Auf diesen Seiten finden Sie allgemeine Grundlagen zur Verwendung der API. Die einzelnen Einsatzzwecke werden auf den jeweiligen spezifischen Seiten genauer erläutert.

Namensräume und Packages

Ein Namensraum wird pro Nuclet definiert. Ist ein Businessobjekt einem Nuclet zugewiesen, so muss beim Aufruf der entsprechende Namespace angegeben werden. Ist ein Businessobjekt keinem Nuclet zugeordnet, so wird der Default Namespace 'DEF' verwendet.

Packages werden für die Initialisierung spezieller Bibliotheksregeln benötigt. Alles Inhalte (also Bibliotheksregeln) eines Nuclet-Packages können Spring-managed sein und so innerhalb von Nuclos spezielle Funktionalitäten nutzen und bereitstellen (z.B. aufrufbare Funktionen).

Dynamische Eigenschaften und Berechnete Werte

Dynamische Eigenschaften (z.B. Hintergrundfarbe von Zeilendarstellungen) und berechnete Werte (z.B. Berechnungsausdruck bei Attributen) können in Groovy-Code definiert werden.

Berechnete Werte

Clientregeln für berechnete Werte werden immer auf dem Zielfeld definiert. Im Businessobjekt findet sich in der Attributdefinition ein Button 'Berechnungsausdruck'. Hier wird der Groovy-Code hinterlegt.

ApplicationProgrammingInterface 1.jpg

Sie können im Code über die Variable "context" und passende Ausdrücke (im Code: context."Ausdruck" auf die Kontextinformationen und Daten des Objekts zugreifen.

Folgende Ausdrücke werden im Moment unterstützt:

Referenzierte Kontexte

Häufig wird ein Zugriff auf Werte eines referenzierten Objekts benötigt. Hierfür kann der Ausdruck #{[namespace].[entity].[field].context} verwendet werden. Dieser Ausdruck liefert ein neues Context-Objekt, mit dem Sie in identischer Weise weiterarbeiten können. Zu beachten ist, dass ein referenzierter Kontext häufig nur eingeschränkte Daten liefert. Bei Auswahlfeldern stehen z.B. nur die Werte des referenzierten Datensatzes zur Verfügung - ein erneuter Aufruf von #{[namespace].[entity]} oder #{[namespace].[entity].[field].context} ist also nicht möglich. Sollten die zur Verfügung stehenden Daten nicht ausreichen, müssen Funktionen verwendet werden.

Beispiel

Hier ein Beispiel für die Berechnung eines Gesamtbetrages. Der Gesamtbetrag wird durch Iteration über ein Unterformular 'auftrag_position' ermittelt.

Ein weiteres Beispiel zum Iteration mit if - Anweisung.

 

def innenring = context."#{TVI.Auftragspositionen.auftrag.context}"."#{TVI.Auftrag.kunde.context}"."#{TVI.Kunde.innenringbedruckung}"

Hintergrundfarbe von Zeilendarstellungen

In Suchergebnislisten und Unterformularen können Zeilen farblich hinterlegt werden. Die Definition geschieht über einen Groovy-Code der pro Businessobjekt angegeben wird. Im letzten Schritt vom Businessobjekt befindet sich ein Button 'Hintergrundfarbe der Zeilendarstellung konfigurieren'. Hier wird das Skript hinterlegt.

ApplicationProgrammingInterface 2.jpg

Die Farben werden im Return-Statement anhand von Hexadezimalen Farbcodes angegeben.

Beispiel

Nachfolgend ein Beispielcode für die Farbeneinstellungen:

Hintergrundfarbe von einzelnen Feldern

Die Funktion wurde implementiert unter Businessobjekt "Attribut/Allg.Eigenschaften" dort kann man das GroovySkript hinterlegen.

In Detailmasken kann das Skript "übergangen" werden, indem im Layout die Hintergrundfarbe explizit gesetzt wird. Für Suchergebnislisten oder Unterformulare wird dennoch das Skript ausgewertet.


Die Farben werden im Return-Statement anhand von Hexadezimalen Farbcodes angegeben.

Aktivieren und Deaktivieren von Feldern bzw. Buttons in Unterformularen

In den Eigenschaften eines Subformelements im Layout können über Clientregeln die Buttons für Neuanlage, Klonen und Löschen sowie einzelne Spalten aktiviert bzw. deaktiviert werden.

ApplicationProgrammingInterface 3.jpg

Die gerade aktuelle Spalte kann mittels

abgefragt werden.

 Neu / Löschen / Klonen aktiv (dynamsich)

Die Aktivierung/Deaktivierung der Buttons wird entsprechend eines boolschen Rückgabewertes durchgeführt.

  • return true = Button aktiv
  • return false = Button nicht aktiv

Bearbeiten aktiv (dynamisch)

Die Aktivierung/Deaktivierung der Spalten wird entsprechend eines boolschen Rückgabewertes durchgeführt.

  • return true = Feld aktiv
  • return false = Feld nicht aktiv

 

Achtung: Der Ausgangskontext für "Neu aktiv (dynamisch)" ist immer das übergeordnete BO der Subform, der Ausgangskontext für "Bearbeiten aktiv (dynamisch)", "Löschen aktiv (dynamisch)" und "Klonen aktiv (dynamisch)" hingegen ist immer das BO der Subform selbst.

Will man sich also beispielsweise in einem Subform für Auftragspositionen den Status des Auftrages holen, muss man dies für "Neu" mittels

context."#{NAME.Auftrag.nuclosStateNumber}" 

tun, für "Bearbeiten", "Löschen" und "Klonen hingegen muss man erst einen Kontext nach oben gehen mittels

context."#{NAME.Auftragsposition.auftrag.context}"."#{NAME.Auftrag.nuclosStateNumber}".

 

Beispiel 1

Bestimmte Felder sollen abhängig des ausgewählten Wertes (componentType) aktiviert oder deaktiviert sein.

Beispiel 2

Feld invoiceamountinhours soll abhängig des ausgewählten Wertes (chargedashours) aktiviert oder deaktiviert sein.

Vorsicht: Da im Namen des BO ein Leerzeichen enthalten ist, muss es auch im Groovy-Code so angesprochen werden ("External services").


Funktionen über Bibliotheksregeln

Sie können in Bibliotheksregeln Funktionen definieren, die in dynamischen Eigenschaften und berechneten Werten verwendet werden können. Eine Bibliotheksregel muss hierfür mit der Annotation org.springframework.stereotype.Component gekennzeichnet werden, damit sie von der Laufzeitumgebung erkannt wird (Hinweis: es wird nur eine Instanz der Klasse erzeugt - beachten Sie dies beim Einsatz von Klassenvariablen). Falls Sie eine Methode dieser Klasse als Funktion verwenden möchten, kennzeichnen Sie diese mit der Annotation org.nuclos.api.annotation.Function und vergeben Sie einen global eindeutigen Namen. Diesen Namen verwenden Sie später, um die Funktion mit Hilfe über context."#FUNCTION{<Funktionsname>}" aufzurufen. Bei der Implementierung von Funktionen ist darauf zu achten, dass Parameter- und Rückgabe-Typen übereinstimmen. Ggf. notwendige Umwandlungen müssen manuell vorgenommen werden. Ausserdem muss beachtet werden, dass der Namensraum des Packages im Nuclet Mangagement und der Packagename der Componente (Bibliotheksregel) gleich sind.

Beispiel

In folgendem Beispiel wird eine automatische Vergabe von Bestellnummern in Abhängigkeit des ausgewählten Kunden implementiert.

 Bibliotheksregel mit Funktion

Dynamisch berechneter Wert

context."#FUNCTION{org.nuclet.rules.MyFunction}"(context."#{DEF.Kunde.kundennr}")

 

Logausgaben

Um Clientregeln zu debuggen, können Logausgaben eingegeben werden:

    log.info("Logausgabe")

Die Ausgabe kann in der Scripting-Ausgabe (Fenster / Ausgabe (Scripting)) eingesehen werden.

 

Aktueller User (Nuclos Version 4.0.15 und höher)

Die Variable username kann in Groovy Skripten verwendet werden.

In dieser Variable vom Typ java.lang.String steht der aktuelle User.

z.B.: def anwender = username

Der aktuelle User wird in die Variable anwender übertragen.

 

Known Issues- Best Practice

Feld aus Elternbusinessobjekt / Hauptbusinessobjekt auslesen

z.B. Statusnumeral des Elternobjektes ermitteln:

Das Feld, das aus dem Elternbusinessobjek ausgelesen werden soll, muss im Layout vorhanden sein. Soll es nicht sichtbar sein für den Benutzer, kann es deaktiviert werden.

  • Keine Stichwörter

Kommentar

  1. Beispiel, um eine Messagebox anzuzeigen (Skript als Berechnungsskript beim auslösenden Attribut definieren, hier Eingangsdatum):

     

    import groovy.swing.SwingBuilder
    import javax.swing.*
    import java.awt.*

    def swing = new SwingBuilder()
    def myMainFrame = new Frame()

    if (context."#{S663.Auftrag.eingangsdatum}" != null) {
    swing.edt {
    JOptionPane.showMessageDialog(
    myMainFrame, "Hello There");
    }
    }