Flow

Flow ist eine spezialisierte Abwandlung von http_proxy Backend Connections und dient der Herstellung von Verbindungen zu Process Engines (IGUASU und INUBIT). Eine detaillierte Dokumentation über die Anbindung von IGUASU finden Sie hier.

Im Folgenden werden die verschiedenen Konfigurationsmöglichkeiten von Flow vorgestellt und beschrieben.

Neue Flow-Komponente anlegen

Im Reiter Flow fügen Sie eine neue Komponente hinzu.

Die Art des Flows wird durch das Eingabefeld "Typ" ausgewählt. Je nach Auswahl des Typs werden die spezifischen Konfigurationsoptionen angezeigt.

Einstellungen

Setting (Key) Gruppe Typ Beschreibung

Setting (Key)	Gruppe	Typ	Beschreibung
ModuleHeader (`moduleHeader_enabled`)	Module	bool	Ermöglicht das De-/Aktivieren des ModuleHeaders
Module_Description (`moduleHeader_description`)	Module	text	Ermöglicht die Hinterlegung einer kurzen Beschreibung des Moduls. Kann z.B. im ModuleHeader angezeigt werden.
Module_Icon (`module_iconCls`)	Module	text	Angezeigtes FontAwesome-Icon der Backend Connection Instanz.
Module_Name (`module_name`)	Module	text	Name des Moduls
Connection_Password (`connectionPassword`)	Module	text	Password für Authentifizierung der Connection (BasicAuth am Zielserver)
Connection_Username (`connectionUsername`)	Connection	text	Username für Authentifizierung der Connection
Connection_Timeout (`connectionTimeout`)	Connection	number	Maximales Timeout der Connection. Default: 180
Connection_CheckCsrfToken (`checkCsrfToken`)	Security	bool	Ermöglicht das De-/Aktivieren des CSRF Token Checks.
Connection_FilterBpcSession (`filterSessionCookie`)	Security	bool	Ermöglicht das De-/Aktivieren des Session-Filters. Default: true
Connection_InjectUserSessionJWT (`injectSessionJwt`)	Security	bool	Es wird ein JWT im Header gesetzt, der die Session-Informationen enthält. Default: false Beispiel Call GET /?_dc=1569249450661 HTTP/1.1 X-Bpc-Session: SESSIONID. Cookie: oidc.userInfoJWT=eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyODA0MTg3MS00M2EzLTQ0NDAtYWUyZS1hNGFiZTM1NDViMzIifQ.eyJzdWIiOiI3ZmEwMWYxYS0wNzY5LTQ4Y2UtOTQzMS1hODU4Yjk5Y2ExN2EiLCJhdWQiOiJicGMtY29yZSIsImFkZHJlc3MiOnt9LCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYnBjX3JvbGVzIjpbImJwY2FkbWluIiwiYnBjdXNlciIsImFDbGllbnRSb2xlIl0sIm5hbWUiOiJUaW1vIFZpcnQiLCJpc3MiOiJodHRwOi8vZGV2MDYudmlydGltby5uZXQ6ODA5MS9hdXRoL3JlYWxtcy9icGMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJicGNhZG1pbiIsImdpdmVuX25hbWUiOiJUaW1vIiwiZmFtaWx5X25hbWUiOiJWaXJ0IiwiZW1haWwiOiJicGNhZG1pbkBleGFtcGxlLmNvbSJ9.tP3jJo86ONW0lbM47ne_Z0KgMIXCt645hkwK1Why4MtB1Z8e9Lxw4I76n-4zYkLGgADka1G6LkWI4nCDjbtJ7g; oidc=7fa01f1a-0769-48ce-9431-a858b99ca17a Accept: /,* Accept-Language: de-DE,de;q=0.9,en;q=0.8,en-US;q=0.7 accept-encoding: gzip, deflate, br Host: xyz.local:1234 Connection: keep-alive In dieser Konfiguration haben wir zwei verschiedene Informationen der User Session: Cookie `oidc.userInfoJWT` enthält den JWT mit UserDaten wie er vom Keycloak kommt. Dieser ist signiert und kann über OIDC validiert werden. Header `X-Bpc-Session` enthält die serialisierte BpcUserSession als JWT (plain, nicht signiert)
Connection_UntrustedCertificates (`allowUntrustedConnections`)	Security	text	Es wird allen Zertifikaten vertraut sowie der Common Name (CN) Check übersprungen. Default: false
Http_Header_Filter (`httpHeaderFilter`)	Proxy	json	Liste der Header Namen, die herausgefiltert werden sollen. Aus Sicherheitsgründen wird der BPC-API-Key-Header (`X-APIKey`) stets gefiltert. Default: `[ "X-Frame-Options" ]`
ProxyServer_Port (`proxyServerPort`)	Proxy	number	Der Port unter dem der Proxy-Server erreichbar ist. Default: 80
ProxyServer_URL (`proxyServer`)	Proxy	text	Die Adresse des zu verwendenden Proxy-Servers. Bleibt leer, wenn eine direkte Verbindung zum Zielserver möglich ist.
Service URL (`connectionBaseUrl`)	Target	text	Dieser Parameter definiert die Basis-URL zum Zielsystem und wird bei jeder Verwendung vorangestellt, wenn keine Frontend URL definiert ist.
FrontendURL (`frontendUrl`)	Target	text	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.

ModuleHeader
(moduleHeader_enabled)

Module

bool

Ermöglicht das De-/Aktivieren des ModuleHeaders

Module_Description
(moduleHeader_description)

Module

text

Ermöglicht die Hinterlegung einer kurzen Beschreibung des Moduls. Kann z.B. im ModuleHeader angezeigt werden.

Module_Icon
(module_iconCls)

Module

text

Angezeigtes FontAwesome-Icon der Backend Connection Instanz.

Module_Name
(module_name)

Module

text

Name des Moduls

Connection_Password
(connectionPassword)

Module

text

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

Connection_Username
(connectionUsername)

Connection

text

Username für Authentifizierung der Connection

Connection_Timeout
(connectionTimeout)

Connection

number

Maximales Timeout der Connection.
Default: 180

Connection_CheckCsrfToken
(checkCsrfToken)

Security

bool

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

Connection_FilterBpcSession
(filterSessionCookie)

Security

bool

Ermöglicht das De-/Aktivieren des Session-Filters.
Default: true

Connection_InjectUserSessionJWT
(injectSessionJwt)

Security

bool

Es wird ein JWT im Header gesetzt, der die Session-Informationen enthält.
Default: false

Beispiel Call

GET /?_dc=1569249450661 HTTP/1.1
X-Bpc-Session: SESSIONID.
Cookie: oidc.userInfoJWT=eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyODA0MTg3MS00M2EzLTQ0NDAtYWUyZS1hNGFiZTM1NDViMzIifQ.eyJzdWIiOiI3ZmEwMWYxYS0wNzY5LTQ4Y2UtOTQzMS1hODU4Yjk5Y2ExN2EiLCJhdWQiOiJicGMtY29yZSIsImFkZHJlc3MiOnt9LCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYnBjX3JvbGVzIjpbImJwY2FkbWluIiwiYnBjdXNlciIsImFDbGllbnRSb2xlIl0sIm5hbWUiOiJUaW1vIFZpcnQiLCJpc3MiOiJodHRwOi8vZGV2MDYudmlydGltby5uZXQ6ODA5MS9hdXRoL3JlYWxtcy9icGMiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJicGNhZG1pbiIsImdpdmVuX25hbWUiOiJUaW1vIiwiZmFtaWx5X25hbWUiOiJWaXJ0IiwiZW1haWwiOiJicGNhZG1pbkBleGFtcGxlLmNvbSJ9.tP3jJo86ONW0lbM47ne_Z0KgMIXCt645hkwK1Why4MtB1Z8e9Lxw4I76n-4zYkLGgADka1G6LkWI4nCDjbtJ7g; oidc=7fa01f1a-0769-48ce-9431-a858b99ca17a
Accept: */*,*
Accept-Language: de-DE,de;q=0.9,en;q=0.8,en-US;q=0.7
accept-encoding: gzip, deflate, br
Host: xyz.local:1234
Connection: keep-alive

In dieser Konfiguration haben wir zwei verschiedene Informationen der User Session:

Cookie oidc.userInfoJWT enthält den JWT mit UserDaten wie er vom Keycloak kommt. Dieser ist signiert und kann über OIDC validiert werden.
Header X-Bpc-Session enthält die serialisierte BpcUserSession als JWT (plain, nicht signiert)

Connection_UntrustedCertificates
(allowUntrustedConnections)

Security

text

Es wird allen Zertifikaten vertraut sowie der Common Name (CN) Check übersprungen.
Default: false

Http_Header_Filter
(httpHeaderFilter)

Proxy

json

Liste der Header Namen, die herausgefiltert werden sollen. Aus Sicherheitsgründen wird der BPC-API-Key-Header (X-APIKey) stets gefiltert.

Default:

[
  "X-Frame-Options"
]

ProxyServer_Port
(proxyServerPort)

Proxy

number

Der Port unter dem der Proxy-Server erreichbar ist.
Default: 80

ProxyServer_URL
(proxyServer)

Proxy

text

Die Adresse des zu verwendenden Proxy-Servers. Bleibt leer, wenn eine direkte Verbindung zum Zielserver möglich ist.

Service URL
(connectionBaseUrl)

Target

text

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

FrontendURL
(frontendUrl)

Target

text

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.

IGUASU spezifische Einstellungen

Setting (Key) Gruppe Typ Beschreibung

Setting (Key)	Gruppe	Typ	Beschreibung
System ID (`systemId`)	Target	text	Die System-ID wird im IGUASU HybridRESTClientController Service konfiguriert und ist nur relevant, wenn das BPC Nachrichten von verschiedenen IGUASU-Instanzen empfängt.

System ID
(systemId)

Target

text

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

Flow Manager

Der Flow Manager umfasst die wichtigsten Grundeinstellungen einer Flow-Komponente für eine schnelle und übersichtliche Konfiguration. Er enthält den zusätzlichen Bereich "Prozessoren", in dem tabellarisch die Prozessoren aufgelistet sind, mit denen das BPC kommunizieren kann, um einen Flow zu starten. Diese Tabelle umfasst Informationen über die ID, den Namen und die Beschreibung der Prozessoren, die in der jeweiligen Process Engine (IGUASU oder INUBIT) konfiguriert worden sind. Über die Sprungspalte kann man direkt zu dem Prozessor springen.

Der Sprung funktioniert nur, wenn eine externe URL als Service oder Frontend URL gesetzt worden ist. Nutzt man eine interne URL als Service URL, weil beides im selben System liegt, muss eine Frontend URL gesetzt werden. Liegen sie nicht im selben System und Service URL ist eine externe URL, muss Frontend URL nicht zusätzlich gesetzt werden.

Flow im Process Monitoring

Wenn ein Benutzer aus einem Monitor heraus zum IGUASU springen möchte, muss eine Flow-Komponente eingerichtet werden. Diese ermöglicht es, über eine definierte Verlinkung direkt zu dem jeweiligen Prozess oder Service im IGUASU zu navigieren. Damit dieser Sprung funktioniert, muss die Monitor-Ansicht eine Spalte enthalten, die die entsprechende Verknüpfung bereitstellt. Dies geschieht über die Spalte externalReference, die mit einer sogenannten flowId konfiguriert wird. Die flowId ist die ID der Flow-Komponente und kann beim Anlegen der Komponente selbst bestimmt werden.
Voraussetzung: Eine Flow-Komponente muss zuvor angelegt worden sein. Die flowId dieser Komponente muss dann in der Spaltenkonfiguration (Monitor_ColumnConfig) hinterlegt werden.
Detaillierte Informationen finden Sie unter Vom BPC zum IGUASU springen.

Keywords: