Flow

Flow ist eine spezialisierte Erweiterung der HTTP-Proxy Backend Connections. Das Modul dient der Anbindung von Process Engines wie IGUASU und INUBIT an das BPC. Eine detaillierte Dokumentation zur IGUASU-Anbindung finden Sie unter Prozess-Engines konfigurieren.

Benutzeroberfläche (Flow Manager)

Der Flow Manager ermöglicht die schnelle Konfiguration der wichtigsten Grundeinstellungen einer Flow-Komponente. In der Tabelle "Prozessoren" werden alle verfügbaren Endpunkte der Process Engine aufgelistet, mit denen das BPC kommunizieren kann. Diese Tabelle enthält die ID, den Namen und die Beschreibung der in IGUASU oder INUBIT konfigurierten Prozessoren.

Benutzeroberfläche des Flow Managers

Der direkte Sprung zu einem Prozessor über die Sprungspalte erfordert eine korrekt gesetzte Service- oder Frontend-URL. Wenn eine interne URL als Service-URL verwendet wird, muss zusätzlich eine Frontend-URL für den externen Zugriff konfiguriert werden.

Voraussetzungen

Um Flow-Komponenten nutzen zu können, müssen folgende Voraussetzungen erfüllt sein:

  • Eine Verbindung zu einer Process Engine (IGUASU oder INUBIT) ist technisch möglich.

  • Sie verfügen über die notwendigen Administrationsrechte im BPC.

  • Für den Sprung aus dem Monitor ist eine konfigurierte Monitor-Ansicht erforderlich.

Flow-Komponente anlegen

In diesem Abschnitt wird beschrieben, wie Sie eine neue Flow-Komponente für eine Process Engine erstellen.

  1. Navigieren Sie zum Reiter Flow.

  2. Klicken Sie auf das Plus-Icon, um eine neue Komponente hinzuzufügen.

  3. Wählen Sie im Feld Typ die gewünschte Process Engine aus (INUBIT oder IGUASU).

    Die spezifischen Konfigurationsoptionen für den gewählten Typ werden eingeblendet.

  4. Konfigurieren Sie die Parameter gemäß der Anforderungen Ihrer Process Engine.

  5. Klicken Sie auf Speichern ().

Die neue Flow-Komponente wurde erfolgreich angelegt und ist einsatzbereit.

Konfiguration für INUBIT

Die folgenden Parameter sind für den Typ INUBIT verfügbar:

Modul

Allgemeine Moduleinstellungen

Name (ID) Beschreibung

Name
(module_name)

Name bzw. Titel des Moduls/der Komponente.

Icon
(module_iconCls)

Individuell auswählbares Icon, das vor dem Titel angezeigt wird.
Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.

Ziel

Einstellungen zum Zielsystems

Name (ID) Beschreibung

Service-URL
(connectionBaseUrl)

Dieser Parameter definiert die Basis-URL zum Zielsystem und wird bei jeder Verwendung vorangestellt, wenn keine Frontend URL definiert ist.

Frontend-URL
(frontendUrl)

Falls das Flow Frontend unter einer abweichenden URL erreichbar ist, kann diese hier konfiguriert werden. Dies ist relevant für Sprünge vom BPC zum Flow. z.B. https://flow.virtimo.de/flow

Proxy

Einstellungen zum Proxy

Name (ID) Beschreibung

Hostname
(proxyServer)

Der Hostname des zu verwendenden Netzwerk-Proxy-Servers.

Port
(proxyServerPort)

Der Port unter dem der Proxy-Server erreichbar ist.

HTTP-Header-Filter
(httpHeaderFilter)

Liste der HTTP-Header Namen, die aus Requests Richtung Zielsystem gefiltert werden sollen. Aus Sicherheitsgründen wird der BPC-API-Key-Header ("X-APIKey") stets gefiltert.

Verbindung

Einstellungen zur Herstellung einer Verbindung zu einer Backend Connection

Name (ID) Beschreibung

Benutzername
(connectionUsername)

Username für Authentifizierung der Connection

Passwort
(connectionPassword)

Password für Authentifizierung der Connection (BasicAuth am Zielserver)

Timeout
(connectionTimeout)

Timeout der Verbindung in Sekunden.

Sicherheit

Einstellungen zur Applikationssicherheit

Name (ID) Beschreibung

OIDC ID-Token hinzufügen
(injectSessionJwt)

Es wird der OIDC ID-Token im Header ("X-Bpc-Session") gesetzt, der die Nutzerinformationen enthält.

BPC Session-ID mitsenden
(sendSessionId)

Wenn aktiv, wird eine Session Id (im Header "X-Bpc-SessionId") mitgeschickt, mit der man den Nutzer und dessen Rollen und Rechte abfragen kann, ohne jedoch API-Calls in seiner Identität durchführen zu können.

TLS-Zertifikatsprüfung deaktivieren
(allowUntrustedConnections)

Beim Aufbau der TLS-Verbindung wird das Zertifikat des Servers nicht geprüft.

CSRF-Token Prüfung
(checkCsrfToken)

Ermöglicht das De-/Aktivieren des CSRF-Token-Checks.

Konfiguration für IGUASU

Die folgenden Parameter sind für den Typ IGUASU verfügbar:

Modul

Allgemeine Moduleinstellungen

Name (ID) Beschreibung

Name
(module_name)

Name bzw. Titel des Moduls/der Komponente.

Icon
(module_iconCls)

Individuell auswählbares Icon, das vor dem Titel angezeigt wird.
Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.

Ziel

Einstellungen zum Zielsystems

Name (ID) Beschreibung

Service-URL
(connectionBaseUrl)

Dieser Parameter definiert die Basis-URL zum Zielsystem und wird bei jeder Verwendung vorangestellt, wenn keine Frontend URL definiert ist.

Frontend-URL
(frontendUrl)

Falls das Flow Frontend unter einer abweichenden URL erreichbar ist, kann diese hier konfiguriert werden. Dies ist relevant für Sprünge vom BPC zum Flow. z.B. https://flow.virtimo.de/flow

System-ID
(systemId)

Die System-ID wird im IGUASU HybridRESTClientController Service konfiguriert und ist nur relevant, wenn das BPC Nachrichten von verschiedenen IGUASU-Instanzen empfängt. Standardwert: IGUASU

Proxy

Einstellungen zum Proxy

Name (ID) Beschreibung

Hostname
(proxyServer)

Der Hostname des zu verwendenden Netzwerk-Proxy-Servers.

Port
(proxyServerPort)

Der Port unter dem der Proxy-Server erreichbar ist.

HTTP-Header-Filter
(httpHeaderFilter)

Liste der HTTP-Header Namen, die aus Requests Richtung Zielsystem gefiltert werden sollen. Aus Sicherheitsgründen wird der BPC-API-Key-Header ("X-APIKey") stets gefiltert.

HTTP-Header
(additionalHttpHeaders)

Zusätzliche HTTP-Header, die beim Aufruf des Zielsystems mitgesendet werden. In den Werten ist es möglich Platzhalter wie z.Bsp "${license.KeyID}" oder "${config.de.virtimo.bpc.core.karaf.uuid}" zu nutzen.

Verbindung

Einstellungen zur Herstellung einer Verbindung zu einer Backend Connection

Name (ID) Beschreibung

Benutzername
(connectionUsername)

Username für Authentifizierung der Connection

Passwort
(connectionPassword)

Password für Authentifizierung der Connection (BasicAuth am Zielserver)

Timeout
(connectionTimeout)

Timeout der Verbindung in Sekunden.

Sicherheit

Einstellungen zur Applikationssicherheit

Name (ID) Beschreibung

OIDC ID-Token hinzufügen
(injectSessionJwt)

Es wird der OIDC ID-Token im Header ("X-Bpc-Session") gesetzt, der die Nutzerinformationen enthält.

BPC Session-ID mitsenden
(sendSessionId)

Wenn aktiv, wird eine Session Id (im Header "X-Bpc-SessionId") mitgeschickt, mit der man den Nutzer und dessen Rollen und Rechte abfragen kann, ohne jedoch API-Calls in seiner Identität durchführen zu können.

TLS-Zertifikatsprüfung deaktivieren
(allowUntrustedConnections)

Beim Aufbau der TLS-Verbindung wird das Zertifikat des Servers nicht geprüft.

CSRF-Token Prüfung
(checkCsrfToken)

Ermöglicht das De-/Aktivieren des CSRF-Token-Checks.

Sprung zum IGUASU im Process Monitoring konfigurieren

Sie können das Process Monitoring so konfigurieren, dass Anwender direkt aus einer Monitor-Ansicht zu einem Prozess oder Service in IGUASU springen können.

Voraussetzungen:

  • Stellen Sie sicher, dass eine Flow-Komponente angelegt wurde, die eine Verbindung zu der Process Engine (IGUASU oder INUBIT) hergestellt hat.
    Die ID dieser Komponente wird später gebraucht.

  • Die Process Engine muss die notwendigen Referenzinformationen in den Log Service schreiben.

IGUASU schreibt die Referenzinformationen automatisch, wenn der BPC-Logger ausgewählt ist bzw. wenn der PutBPCAuditLog-Prozessor verwendet wird. Die Referenzinformationen sind ein JSON-Objekt mit den folgenden Feldern:

{
  "system": "IGUASU",
  "instance": <ID der Instanz>,
  "type": "iguasu",
  "processor": <ID des Prozessors>
}

  1. Konfigurieren Sie den Index (data_index) in den Monitor-Einstellungen mit der Log-Service Komponente, die Sie zum Schreiben der Daten verwenden.

  2. Navigieren Sie zur Spaltenkonfiguration (column_config) der Monitor-Einstellungen.
    Wenn AuditLogs oder ProcessLogs erstellt wurden, wird am Monitor automatisch eine Spalte mit dem Index externalReference generiert.

  3. Hinterlegen Sie die flowId (Die ID der Flow-Komponente) in der Konfiguration dieser Spalte.

{
    "filter": {
        "type": "json"
    },
    "hidden": false,
    "dataIndex": "externalReference", (3)
    "hideable": true,
    "width": 200,
    "customRenderer": "flow!_!flowRenderer", (1)
    "minWidth": 64,
    "hideUnknownObjects": true, (2)
    "text": "externalReference", (3)
    "sortable": true,
    "linkIcon": "x-fal fa-fire", (4)
    "flowId": "mein-iguasu" (5)
}
1 Erforderlich, wenn der Inhalt der Spalte zu einem Link transformiert werden soll.
2 Optional. Versteckt unbekannte Objekte, die nicht den Typ iguasu oder inubit haben.
3 Der Name externalReference ist der Standard, der vom Log Service angelegt wird, aber nicht verpflichtend und kann geändert werden.
4 Optional. Definiert das Icon, das neben dem Text angezeigt wird.
5 Erforderlich, um Links mit dem customRenderer ("flow!_!flowRenderer") zu generieren. ID der Flow-Komponente, die das System referenziert, das Daten in den Log-Service schreibt.

Dies ermöglicht den Sprung von einem Monitor Record zu dem Event bzw. Prozessor oder Service in IGUASU.

Ansicht des Monitors mit Custom Renderer für externalReference Spalte

Verknüpfung von Flow-Prozessoren mit dem Monitor

Dies ermöglicht Aktionen wie Statuswechsel oder Mehrfach-Aktionen direkt über Flow-Prozessoren.

Konfiguration von Flow-Prozessoren im Monitor
Keywords:
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen