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.

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.

Navigieren Sie zum Reiter Flow.
Klicken Sie auf das Plus-Icon, um eine neue Komponente hinzuzufügen.
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.
Konfigurieren Sie die Parameter gemäß der Anforderungen Ihrer Process Engine.
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 (`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.

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

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

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

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.

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

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.

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

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.

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 (`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.

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

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

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

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.

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

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.

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

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.

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)

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.

Stellen Sie sicher, dass eine Flow-Komponente mit einer eindeutigen flowId angelegt wurde.
Navigieren Sie zur Spaltenkonfiguration der Monitor-Ansicht (Monitor_ColumnConfig).
Fügen Sie die Spalte externalReference hinzu.
Hinterlegen Sie die flowId der Flow-Komponente in der Konfiguration dieser Spalte.
Verknüpfen Sie bei Bedarf Prozessoren direkt in den Monitor-Einstellungen.

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

Die Verknüpfung zwischen BPC-Monitor und IGUASU wurde erfolgreich hergestellt.

Keywords: