Parameterspeicher (Parameter Store)

Ab Intrexx Version 12.0.0

Der Parameter Store ist ein zentraler Speicher, der es ermöglicht, nicht-sensible Verbindungsparameter (z.B. Hosts, Ports, Benutzernamen), die in Prozessen (z.B. in IMAP-Ereignisquellen oder generischen Elementen) verwendet werden, unabhängig von den Prozessen zu speichern und zur Laufzeit zur Verfügung zu stellen.

Dieses Feature ist Voraussetzung für die Verwaltung von Prozessen in öffentlichen Git-Repositories sowie für die Weitergabe von Prozessen an Dritte. Der Parameterspeicher ermöglicht eine verbesserte Staging-Umgebung vom Test- zum Produktionsbereich.

Den Parameterspeicher finden Sie im Modul "Integration" links unterhalb des Eintrags "Verbindungsdatenverwaltung". Mit einem Klick darauf werden im rechten Bereich die im Portal definierten Parameter mit Namen, Wert, Beschreibung und Datum der letzten Änderung aufgelistet.

Für die Verwaltung der Parameter wird das Portalrecht "Portaleigenschaften ändern" benötigt.

Oben rechts finden Sie die Schaltfläche "Parameter hinzufügen". Ein Klick darauf öffnet einen Dialog, über den neue Parameter erstellt werden können.

Parameter erstellen

Der Parametername und Wert sind hier erforderlich, optional kann eine Beschreibung eingetragen werden. Der Parametername muss eindeutig sein und darf nur folgende Zeichen enthalten: [a-z][A-Za-z0-9]*.

Klicken Sie "OK", um die Änderungen zu speichern und den Dialog wieder zu schließen.

Parameter bearbeiten"

Öffnet einen Dialog, in dem der aktuell in der Liste markierten Parameter bearbeitet werden kann.

Parameter bearbeiten

Der Name des Parameters kann nicht geändert werden. Wert und Beschreibung können bearbeitet werden. Klicken Sie "OK", um die Änderungen zu speichern und den Dialog wieder zu schließen.

Die Änderungen werden dabei sofort übernommen und stehen zur Laufzeit von Prozessen zur Verfügung. Ausnahme: Wenn sich der Wert eines Parameters ändert, müssen Prozesse mit Ereignisquellen, die den Parameter verwenden, neu veröffentlicht werden.

Parameter entfernen

Löscht den aktuell in der Liste markierten Parameter. Beim Entfernen wird geprüft, ob der ausgewählte Parameter in Prozessen verwendet wird. Wenn ja, wird entsprechend abfragt, ob der Parameter dennoch gelöscht werden soll.

Parameter, die in Groovy-Skript verwendet werden, können nicht zu 100% ermittelt werden.

Verwendung in Intrexx anzeigen

Öffnet einen Dialog, in die Prozesse angezeigt werden, die den Parameter verwenden.

Verwendung in Intrexx

Hier wird geprüft, in welchen Prozessen der ausgewählte Parameter verwendet wird. Die gefundenen Prozesse werden in einer Liste angezeigt.

Parameter , die in Groovy-Skript verwendet werden, können nicht zu 100% ermittelt werden.

Klicken Sie "OK", um die Änderungen zu speichern und den Dialog wieder zu schließen.

Suchfeld

Über der Parameter-Tabelle im rechten Bereich finden Sie ein Suchfeld. Die Tabelle wird nach Parametern gefiltert, die den Suchbegriff im Parameternamen beinhalten.

Aktualisieren

Über das Hauptmenü "Parameterspeicher / Aktualisieren" oder die entsprechende Schaltfläche in der Symbolleiste kann die Parameterliste neu vom Server geladen werden.

parameterstore.cfg

Alle Parameter werden in der XML-Datei "parameterstore.cfg" im Portalverzeichnis "internal/cfg" gespeichert. Hier ein Beispiel:

<?xml version="1.0" encoding="UTF-8"?>
<parameters xmlns="http://schemas.intrexx.com/intrexx/2024/parameter-store/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.intrexx.com/intrexx/2024/parameter-store/ http://schemas.unitedplanet.de/intrexx/2024/package/de/uplanet/lucy/server/parameterstore/cfg/res/parameterstore.xsd"/>
        <parameter name="myHost" lastModified="2024-04-15T13:32:51.320Z" value="test.example.org">
        <description>Host für Testsystem</description>
    </parameter>
    <parameter name="myPort" lastModified="2024-04-15T13:33:39.181Z" value="993">
        <description>Port für Testsystem</description>
      </parameter>
        <parameter name="myUser" lastModified="2024-04-15T13:34:20.375Z" value="testUser">
        <description>Benutzername für Testsystem</description>
    </parameter>
</parameters>

Parameter in Prozesselementen

Im Modul "Prozesse" können in den Eigenschaften von Prozesselementen Parameter an verschiedenen Stellen ausgewählt und auch neu erzeugt und im Parameterspeicher aufgenommen werden. Die Parameter können alternativ auch direkt im Prozess gespeichert werden.

Für das Erstellen und Bearbeiten von Parametern wird das Portalrecht "Portaleigenschaften ändern" benötigt. Für die reine Auswahl von bestehenden Parametern ist das Portalrecht "Zugriff auf Modul Prozesse" bzw. "Zugriff auf Modul Applikationen" ausreichend.

Die Speicherung eines Parameters erfolgt in einem separaten Bean Property, dessen Name wie der Name des Bean Properties des statischen Wertes sowie dem Suffix „ParamRef“ lautet. Der Wert des Bean Propertys entspricht dem Namen des Parameters, der im Parameter Store vergeben wurde. Beispiel: userParamRef = "myUser".

IMAP-Ereignisquelle (Typ "Standard IMAP")

Bei der IMAP-Ereignisquelle können IMAP-Server, IMAP-Port und der Benutzername in den Eigenschaften des Elements auf dem Reiter "E-Mail-Server" festgelegt werden.

Wenn Sie jeweils auf den nach unten gerichteten kleinen Pfeil rechts klicken, wird ein Menü geöffnet, in dem Sie auswählen können, ob der jeweilige Wert mit dem Prozess gespeichert (Standard) oder aus dem Parameter Store bezogen werden soll.Wenn Sie "Aus Parameterspeicher" auswählen, wird das jeweilige Eingabefeld zur Auswahlliste, aus der Sie den gewünschten Parameter auswählen können. Im Prozess wird dann der Name des Parameters gespeichert.

Wenn Sie das Menü "Aus Parameterspeicher" ausgewählt haben, ändert sich das jeweilige Icon rechts neben den Feldern "IMAP-Server", "IMAP-Port" oder "Benutzername" in ein anderes Symbol. Ein Klick darauf öffnet jeweils einen Dialog, in dem bestehende Parameter bearbeitet und auch neue Parameter angelegt werden können.

Parameter auswählen

Hier werden alle bestehenden Parameter aufgelistet. Mit Klick auf "Parameter hinzufügen" können von hier aus neue Parameter erstellt und bestehende Parameter bearbeitet werden.

Nur Parameter mit ganzzahligen Werten anzeigen

Bei der Parameterauswahl für den IMAP-Port finden Sie zusätzlich die Einstellung "Nur Parameter mit ganzzahligen Werten anzeigen".

Für den IMAP-Port stehen nur Parameter mit einem Integerwert zur Verfügung. Wenn Sie die Einstellung "Nur Parameter mit ganzzahligen Werten anzeigen" deaktivieren, werden alle Parameter angezeigt. Wählbar sind aber nur Parameter mit Integerwert.

IMAP-Ereignisquelle (Typ "Exchange Online")

Hier können Mandant, Benutzerprinzipalname und Anwendungs-ID auf die selbe Weise festgelegt oder ausgewählt werden wie bei der IMAP-Ereignisquelle mit dem Typ "Standard IMAP".

Generische Elemente

Beim Bearbeiten eines Properties gibt es die Möglichkeit, mit Klick auf "Wert aus Parameter einfügen" einen Parameter auszuwählen, wenn das Property den Suffix "ParamRef" hat. In der Runtimeklasse muss beim Setter und Getter des Bean Properties für den statischen Wert die Annotation "@Referenceable" gesetzt werden.

@Referenceable
public String getUser()
{
    return m_strUser;
}

@Referenceable
public void setUser(String p_strUser)
{
        m_strUser = p_strUser;
}

public String getUserParamRef()
{
        return m_strUserParamRef;
}

public void setUserParamRef(String p_strParamRef)
{
        m_strUserParamRef = p_strParamRef;
}

Reiter "Expert"

Die Verwendung von Parametern über den Reiter "Expert" in den Eigenschaften von Prozesselementen funktioniert analog zur Vorgehensweise bei Generischen Elementen.

Groovy API

Für den Zugriff auf den Parameter Store gibt es das Kontextobjekt "g_parameterReferences". Weitere Informationen finden Sie hier.

Sicherheit

Für die Sicherheit des Parameter Stores gibt es folgende Maßnahmen:

  • Rechteprüfung: Benutzer benötigen zum Hinzufügen, Bearbeiten oder Entfernen von Parametern das Portalrecht "Portaleigenschaften ändern " und zum Lesen bzw. Auswählen das Portalrecht "Portaleigenschaften ändern", Zugriff auf Modul "Applikationen" oder Zugriff auf Modul "Prozesse".

  • Beim Prozessexport werden nur die Namen der Parameter exportiert, keine Werte. Während oder nach dem Prozessimport können die Werte durch den Benutzer neu gesetzt werden, wenn das erforderliche Portalrecht vorhanden ist.

Veröffentlichung von Prozessen

Prüfung auf undefinierte Parameter

Vor dem Veröffentlichen eines Prozesses wird geprüft, ob die im Prozess verwendeten Parameter im Portal definiert sind. Dabei werden die Bean Properties der Elemente, sowie die Groovy-Skripte geprüft.

Parameter, die in Groovy-Skripten verwendet werden, können nicht zu 100% ermittelt werden.

In einem Prozess können undefinierte Parameter vorkommen - z.B. wenn ein importierter Prozess einen Parameter enthält, der im aktuellen Portal nicht vorhanden ist. Wenn es im Prozess undefinierte Parameter gibt, dann wird ein entsprechender Hinweis angezeigt, in dem auch auf mögliche Probleme beim Veröffentlichen oder bei der Ausführung des Prozesses hingewiesen wird. Der Benutzer hat die Möglichkeit, das Veröffentlichen fortzusetzen oder abzubrechen.

In den Eigenschaften der Elemente werden undefinierte Parameter mit dem Zusatz (undefiniert) gekennzeichnet (Ausnahme: Generische Elemente und Reiter "Expert").

Hinweise-Tab

Zusätzlich zur Hinweismeldung werden im Bereich "Hinweise" die betreffenden Elemente und ggf. Groovy-Skript-Dateien aufgelistet. Das Warndreieck zeigt bei Mauskontakt die Beschreibung des Eintrags an.

Mit Doppelklick auf ein Element wird dieses auf der Arbeitsfläche hervorgehoben.

Auch Groovy-Skript-Dateien können angezeigt werden können. Beim Doppelklick auf den entsprechenden Eintrag öffnet sich der Skripteditor. Der Cursor springt in die Zeile der ersten Verwendung eines undefinierten Parameters.

metaParameter.xml

Beim Veröffentlichen werden die im Prozess verwendeten Parameter-Namen in die neue Datei "metaParameter.xml" im Prozessverzeichnis geschrieben. Die Parameter-Namen werden aus der Datei "model.xml", sowie aus Dateien mit der Endung ".groovy" gesammelt.

Parameter, die in Groovy-Skripten verwendet werden, können nicht zu 100% ermittelt werden.
<meta xmlns="http://schemas.intrexx.com/intrexx/2024/meta/parameter/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.intrexx.com/intrexx/2024/meta/parameter/ http://schemas.unitedplanet.de/intrexx/2024/package/de/uplanet/lucy/parameterstore/meta/res/metaparameter.xsd">
    <parameter name="myHost"/>
    <parameter name="myPort"/>
    <parameter name="myUser"/>
</meta>

Prozessimport

Wenn in mindestens einem der für den Import ausgewählten Prozesse ein Parameter verwendet wird, dann wird im Import-Assistenten die neue Seite "Parameter" angezeigt.

Hier werden die Namen der Parameter aus den ausgewählten Prozessen angezeigt. Quelle der Namen ist jeweils die Datei "metaParameter.xml".

Klicken Sie in der ersten Spalte der Parameter-Liste auf "Info", um die Verwendung im Importpaket anzuzeigen. In der zweiten Spalte wird der Parameter-Name angezeigt.

In der dritten Spalte finden Sie ein Kontrollkästchen, über das ein Parameter neu angelegt werden kann, falls es im Zielportal noch nicht vorhanden ist.

Parameter konfigurieren

Mit Klick auf "Parameter konfigurieren" wird ein Dialog geöffnet, über den der neue Parameter konfiguriert werden kann. Bei Neuanlage muss der Parameter konfiguriert werden, d.h. es muss ein Wert eingegeben werden. Der Name des Parameters muss eindeutig sein und darf nur folgende Zeichen enthalten: [a-z][A-Za-z0-9]*. Optional kann auch eine Beschreibung eingetragen werden.

Wenn das Kontrollkästchen gesetzt und der neue Parameter konfiguriert ist, dann wird es beim Importvorgang dem Parameter Store hinzugefügt.

Für die Neuanlage von Parameter wird das Portalrecht "Portaleigenschaften ändern" benötigt.

In der vierten Spalte wird angezeigt, ob es eine Zuordnung für den Parameter aus dem Parameter Store des Portals gibt. Die Zuordnung erfolgt automatisch, wenn im Portal ein Parameter mit demselben Namen wie im Importpaket vorhanden ist. Eine Zuordnung mit einem anderen Namen ist nicht möglich, da die Verwendung in Groovy-Skripten nicht zu 100% ermittelt werden kann und daher eine Anpassung des Namens nicht in jedem Fall möglich wäre.

Alternativ können fehlende Parameter auch sofort zum Parameter Store des Portals hinzugefügt werden. Öffnen Sie dazu den Parameter Store über die Schaltfläche "Parameterspeicher öffnen". Weitere Informationen dazu finden Sie hier.

Beim Beenden des Dialogs werden die Zuordnungen zum Portal aktualisiert.

Wenn nicht alle Parameter zugeordnet sind oder die Neuanlage von Parametern nicht vollständig konfiguriert ist, wird bei Klick auf "Weiter" eine Hinweismeldung angezeigt. Der Import kann auf Nachfrage trotzdem fortgesetzt werden.

Weitere Informationen

Verbindungsdatenverwaltung

Anmeldeinformationsspeicher (Credential Store)