Flow

Flow is a specialized modification of http_proxy Backend Connections and is used to establish connections to process engines (IGUASU and INUBIT). Detailed documentation on connecting IGUASU can be found here.

The various configuration options for Flow are presented and described below.

Create new Flow component

Add a new component in the Flow tab.

The type of Flow is selected using the "Type" input field. Depending on the type selected, the specific configuration options are displayed.

Type INUBIT

Module

General module settings

Name (ID) Description

Name (`ID`)	Description
Name (`module_name`)	Name or title of the module/component.
Icon (`module_iconCls`)	Individually selectable icon that is displayed before the title. If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Name
(module_name)

Name or title of the module/component.

Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Target

Settings for the target system

Name (ID) Description

Name (`ID`)	Description
Service URL (`connectionBaseUrl`)	This parameter defines the base URL to the target system and is prefixed each time it is used if no frontend URL is defined.
Frontend URL (`frontendUrl`)	If the Flow frontend is accessible under a different URL, this can be configured here. This is relevant for jumps from the BPC to the Flow. e.g. https://flow.virtimo.de/flow

Service URL
(connectionBaseUrl)

This parameter defines the base URL to the target system and is prefixed each time it is used if no frontend URL is defined.

Frontend URL
(frontendUrl)

If the Flow frontend is accessible under a different URL, this can be configured here. This is relevant for jumps from the BPC to the Flow. e.g. https://flow.virtimo.de/flow

Proxy

Proxy settings

Name (ID) Description

Name (`ID`)	Description
Hostname (`proxyServer`)	The host name of the network proxy server to be used.
Port (`proxyServerPort`)	The port under which the proxy server can be reached.
HTTP Header Filter (`httpHeaderFilter`)	List of header names that are to be filtered out. For security purposes the BPC API key header ("X-APIKey") is always filtered out.

Hostname
(proxyServer)

The host name of the network proxy server to be used.

Port
(proxyServerPort)

The port under which the proxy server can be reached.

HTTP Header Filter
(httpHeaderFilter)

List of header names that are to be filtered out. For security purposes the BPC API key header ("X-APIKey") is always filtered out.

Connection

Settings for establishing a backend connection

Name (ID) Description

Name (`ID`)	Description
Username (`connectionUsername`)	Username for authentication of the connection
Password (`connectionPassword`)	Password for authentication of the connection (BasicAuth on the target server)
Timeout (`connectionTimeout`)	Timeout of the connection in seconds.

Username
(connectionUsername)

Username for authentication of the connection

Password
(connectionPassword)

Password for authentication of the connection (BasicAuth on the target server)

Timeout
(connectionTimeout)

Timeout of the connection in seconds.

Security

Application security settings

Name (ID) Description

Name (`ID`)	Description
Inject OIDC ID-Token (`injectSessionJwt`)	An OIDC ID-Token is set in the header ("X-Bpc-Session"), which contains the user information.
Send BPC session id (`sendSessionId`)	If active, a session id is passed (in the header "X-Bpc-SessionId") that allows to query for the user information including roles and rights, but without allowing to use the API-endpoints.
Disable TLS Certificate Checks (`allowUntrustedConnections`)	The server's certificate is not checked when the TLS connection is established.
CSRF Token Check (`checkCsrfToken`)	Enables the CSRF token check.

Inject OIDC ID-Token
(injectSessionJwt)

An OIDC ID-Token is set in the header ("X-Bpc-Session"), which contains the user information.

Send BPC session id
(sendSessionId)

If active, a session id is passed (in the header "X-Bpc-SessionId") that allows to query for the user information including roles and rights, but without allowing to use the API-endpoints.

Disable TLS Certificate Checks
(allowUntrustedConnections)

The server's certificate is not checked when the TLS connection is established.

CSRF Token Check
(checkCsrfToken)

Enables the CSRF token check.

Type IGUASU

Module

General module settings

Name (ID) Description

Name (`ID`)	Description
Name (`module_name`)	Name or title of the module/component.
Icon (`module_iconCls`)	Individually selectable icon that is displayed before the title. If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Name
(module_name)

Name or title of the module/component.

Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Target

Settings for the target system

Name (ID) Description

Name (`ID`)	Description
Service URL (`connectionBaseUrl`)	This parameter defines the base URL to the target system and is prefixed each time it is used if no frontend URL is defined.
Frontend URL (`frontendUrl`)	If the Flow frontend is accessible under a different URL, this can be configured here. This is relevant for jumps from the BPC to the Flow. e.g. https://flow.virtimo.de/flow
System ID (`systemId`)	The system ID is configured in the IGUASU HybridRESTClientController Service and is only relevant if the BPC receives messages from different IGUASU instances. Default value: IGUASU

Service URL
(connectionBaseUrl)

This parameter defines the base URL to the target system and is prefixed each time it is used if no frontend URL is defined.

Frontend URL
(frontendUrl)

If the Flow frontend is accessible under a different URL, this can be configured here. This is relevant for jumps from the BPC to the Flow. e.g. https://flow.virtimo.de/flow

System ID
(systemId)

The system ID is configured in the IGUASU HybridRESTClientController Service and is only relevant if the BPC receives messages from different IGUASU instances. Default value: IGUASU

Proxy

Proxy settings

Name (ID) Description

Name (`ID`)	Description
Hostname (`proxyServer`)	The host name of the network proxy server to be used.
Port (`proxyServerPort`)	The port under which the proxy server can be reached.
HTTP Header Filter (`httpHeaderFilter`)	List of header names that are to be filtered out. For security purposes the BPC API key header ("X-APIKey") is always filtered out.
HTTP-Header (`additionalHttpHeaders`)	Additional HTTP headers that are sent when the target system is called. It is possible to use placeholders such as "{license.KeyID}" or "{config.de.virtimo.bpc.core.karaf.uuid}" in the values.

Hostname
(proxyServer)

The host name of the network proxy server to be used.

Port
(proxyServerPort)

The port under which the proxy server can be reached.

HTTP Header Filter
(httpHeaderFilter)

List of header names that are to be filtered out. For security purposes the BPC API key header ("X-APIKey") is always filtered out.

HTTP-Header
(additionalHttpHeaders)

Additional HTTP headers that are sent when the target system is called. It is possible to use placeholders such as "{license.KeyID}" or "{config.de.virtimo.bpc.core.karaf.uuid}" in the values.

Connection

Settings for establishing a backend connection

Name (ID) Description

Name (`ID`)	Description
Username (`connectionUsername`)	Username for authentication of the connection
Password (`connectionPassword`)	Password for authentication of the connection (BasicAuth on the target server)
Timeout (`connectionTimeout`)	Timeout of the connection in seconds.

Username
(connectionUsername)

Username for authentication of the connection

Password
(connectionPassword)

Password for authentication of the connection (BasicAuth on the target server)

Timeout
(connectionTimeout)

Timeout of the connection in seconds.

Security

Application security settings

Name (ID) Description

Name (`ID`)	Description
Inject OIDC ID-Token (`injectSessionJwt`)	An OIDC ID-Token is set in the header ("X-Bpc-Session"), which contains the user information.
Send BPC session id (`sendSessionId`)	If active, a session id is passed (in the header "X-Bpc-SessionId") that allows to query for the user information including roles and rights, but without allowing to use the API-endpoints.
Disable TLS Certificate Checks (`allowUntrustedConnections`)	The server's certificate is not checked when the TLS connection is established.
CSRF Token Check (`checkCsrfToken`)	Enables the CSRF token check.

Inject OIDC ID-Token
(injectSessionJwt)

An OIDC ID-Token is set in the header ("X-Bpc-Session"), which contains the user information.

Send BPC session id
(sendSessionId)

If active, a session id is passed (in the header "X-Bpc-SessionId") that allows to query for the user information including roles and rights, but without allowing to use the API-endpoints.

Disable TLS Certificate Checks
(allowUntrustedConnections)

The server's certificate is not checked when the TLS connection is established.

CSRF Token Check
(checkCsrfToken)

Enables the CSRF token check.

Flow Manager

The Flow Manager contains the most important basic settings of a flow component for quick and clear configuration. It contains the additional "Processors" area, in which the processors with which the BPC can communicate in order to start a flow are listed in a table. This table contains information about the ID, name and description of the processors that have been configured in the respective process engine (IGUASU or INUBIT). You can jump directly to the processor via the jump column.

The jump only works if an external URL has been set as a Service or Frontend URL. If an internal URL is used as a Service URL because both are in the same system, a Frontend URL must be set. If they are not in the same system and Service URL is an external URL, Frontend URL does not have to be set additionally.

Flow in Process Monitoring

If a user wants to jump to the IGUASU from a monitor, a flow component must be set up. This makes it possible to navigate directly to the respective process or Service in the IGUASU via a defined link. For this jump to work, the monitor view must contain a column that provides the corresponding link. This is done via the column externalReference, which is configured with a so-called flowId. The flowId is the ID of the flow component and can be defined when the component is created.
Prerequisite: A flow component must have been created beforehand. The flowId of this component must then be stored in the column configuration (Monitor_ColumnConfig).
Detailed information can be found at Jump from BPC to IGUASU.

The following application option is still under development. The next section is for completeness and the warning will be removed when the feature is released.

Various endpoints can be configured in the monitor settings, for example to perform process actions, status changes or downloads. Instead of endpoints, processors can also be selected directly from Flow in this case.

Selection window for Flow processors and HTTP endpoints

Keywords: