Administration Changelog

The driver provided via pax-jdbc-mssql is no longer included in the release.

Make sure that the MSSQL driver you are using is at least the following version: 10.2.4, 11.2.4, 12.2.1, 12.6.5, 12.8.2, 12.10.2, 13.2.1

If an older driver is being used, it should be replaced. Remove the old driver by deleting it from the deploy directory or by uninstalling it from pax-jdbc-mssql or the driver itself. Then install an up-to-date driver (without the " pax-jdbc-mssql" feature). See also: Databases

If the configured Identity Provider is unreachable, the system no longer incorrectly logs that the local Karaf Identity Provider is selected as a fallback. Instead, a note is displayed indicating that it could be enabled as a fallback.

Retrieving subgroups has been adjusted to accommodate changes in the Keycloak API.

An error in the commented-out option DE_VIRTIMO_BPC_DECANTER_APPENDER_OPENSEARCH_DELETEENTRIESOLDERTHAN in the central configuration file (bpc.env.sh) has been fixed. Previously, enabling this option did not work because the value must be enclosed in quotation marks. The Windows version was not affected.

This update upgrades Karaf to version 4.4.8. It is necessary to update the modules bpc-be-core, bpc-be-analysis, bpc-be-forms, and bpc-be-monitor.

For BPC module developers:

With the updated Karaf, we are shipping CXF 3.6.8 instead of 3.6.7, which provides Jackson version 2.19.2.

Please update the CXF version (3.6.8) and Jackson version (2.19.2) in your pom.xml. To do this, check whether you have an import package statement for this version. This must be added or adjusted if you use Jackson functions such as the ` ObjectMapper ` class.

HTTP calls made via an HTTP proxy or Flow connection filter out the BPC API key header (X-APIKey). Caution: This could affect existing BPC configurations if, for example, an INUBIT process is triggered that, in turn, makes calls to the BPC API using the API key provided. (In this case, it would be better to store a fixed BPC API key within the INUBIT process.)

For Boolean values in the settings tables, a combo box is no longer displayed; instead, only the checkbox with the truth value appears. The value can be changed by clicking, pressing the spacebar, or pressing Enter.

HTTP calls made via an HTTP proxy or Flow connection filter out the BPC API key header (X-APIKey). Note: This could affect existing BPC configurations if, for example, an INUBIT process is triggered that in turn makes calls to the BPC API using the API key provided. (In this case, it would be better to store a fixed BPC API key within the INUBIT process.)

For new backend Connections of the HTTP-Proxy and Flow types, the " Filter BPC Session " option is enabled by default.

Replication could get stuck in a specific time window if that window was adjacent to the present and no records were found.

For existing Karaf installations, include the following value in KARAF/etc/custom.properties:

The option to group settings is now enabled by default. It is recommended to use this view, as it displays the settings in a shared context.

A preselected value can now be configured for the process status change. The preselection is controlled by the configuration preselectState in the setting function_changeStateConfig.

"preselectState": "_first": Always selects the first available value from the dropdown. "preselectState": "<Suchwert>": Selects the first entry that contains the specified text (case-sensitive). Both raw values and display names (from Custom Renderer) can be used.

If exactly one process is loaded and there are exactly two values to choose from, the status field automatically selects the status that does not match the current status.

When BPC is running in a cluster, it may not be possible to disable maintenance mode via the GUI.

The logging configuration has been changed so that session tokens are masked. For new Karaf installations, this happens automatically. For existing installations, please update the configuration file [KARAF]/etc/org.ops4j.pax.logging.cfg. Replace the old line

with the following lines:

Since session tokens in Keycloak and OIDC are UUIDs that are also used elsewhere, we log the first and last four characters here.

When binary files were uploaded via INUBIT or another backend system, the files might have been corrupted during download or viewing.

Dashboard widgets now only display the configuration icon if the user is authorized to edit the dashboard. To do so, the user needs the " bpcDashboard_editDashboard" permission. Users without this permission can no longer edit dashboard widgets. If editing capabilities (e.g., for custom widgets) are to continue to be offered, either the corresponding permission must be granted or the configuration must be provided through alternative means (e.g., via the widget header).

In the moduleHeaderContent setting, the Parameter showSelectionCounter in the metablock can be used to control whether the number of selected records is displayed.

See also Monitor Quick Actions

Dashboard widgets now only display the configuration icon if the user is allowed to edit the dashboard. To do so, the user needs the " bpcDashboard_editDashboard" permission. Users without this permission can no longer edit dashboard widgets. If editing capabilities (e.g., for custom widgets) are to continue to be offered, either the corresponding permission must be granted or the configuration must be provided through alternative means (e.g., via the widget header).

The startup script no longer waits 30 seconds after OpenSearch and Karaf start. If problems arise where OpenSearch is not available in a timely manner, the watchdog should be used.

The startup script no longer makes any changes to the environment. Directories must be configured according to the installation instructions, and JAVA_HOME must also be configured correctly.

The ProcessStarter configuration for windowWidth and windowHeight now correctly affects the window.

The selection of an operator for "number" filters has been restricted to the operator list. "=" is defined as the default operator, and the default operator can also be changed in the filter configuration within the column configuration. See also Configuring the Monitor Columns

The bpcMonitor_editMonitorViews permission can be set for specific instances to create and modify views in certain monitors by appending the module ID at the end.

See OpenSearch Index View

There is now a description of*the* BPC’s internal model_version at Versioning of the Internal BPC Configuration. It also explains that this can affect a BPC downgrade and the Deployment between different BPCs.

The changelog now indicates when an update to the internal configuration is available.

In addition, the Administration Changelog displays an overview of all versions in which a change to the model_version occurred. As part of this, an overview of versions with Karaf and OpenSearch updates was also added.

See MinIO as an S3 Backup for OpenSearch

The installation via bundle file is now described at Installation. The included start and stop scripts are now described.

Notes added stating that database connections generally require read-only permissions.

See Backend Connections, Security, and Documents.

Instructions for downgrading BPC, taking technical specifics into account. See: * Versioning of the Internal BPC Configuration * Troubleshooting * Downgrade Guide

Update OpenSearch according to the update instructions

Monitors that contain an externalReference field with an IGUASU reference can display a link that allows users to jump to the data source in IGUASU. To do this, the renderer flow!_!flowRenderer must be set in the monitor column configuration.

See also: BPC → IGUASU

Scripts are provided that can be used to start and stop the BPC, Karaf, and OpenSearch.

See Download - Virtimo File Server

The user session can be supplemented with customData coming from the Additional Info endpoint of the Identity Provider Backend Connection.

See also Add additional organizations, roles, permissions, and other data to the user session

The OpenSearch log contains many entries such as "QueryGroup _id can’t be null, It should be set before accessing it." This is a known OpenSearch bug that was introduced in version 2.18.0. We have reduced the number of these messages as much as we could on our end.

To display existing charts using a dark theme without a white background, the background color of the charts should be set to full transparency (RGBA alpha value set to 0) under Chart Configuration → Settings → Background Color.

Snapshots whose names do not conform to the current naming scheme have blocked the execution of backups.

When the HTTP proxy used an HTTP/2 connection, the pseudo-header ":status" was passed on to the client. Under a strict interpretation, this results in an error. For example, in this case, nginx reported a 502 Bad Gateway error to the client.

If a deployment was performed from a BPC with existing monitor views to a BPC that did not yet have any views, an error occurred.

This error has been fixed.

A bug was fixed that prevented instance-specific HTML content editing permissions from being granted by the role htmlcontent_editor_<MODUL-ID>.

Update OpenSearch according to the update instructions

Properties have been set in the custom.java.security

If you are not yet using a ` custom.java.security ` file via Central configuration file, you should do so.

Existing ` custom.java.security ` files should be updated with the following entry:

The bpc.env files now also apply the security.properties settings from the file custom.java.security to OpenSearch. As a result, changes made to this file affect both Karaf and OpenSearch.

If you are using a BPC.env file, it is recommended that you update it. If it does not already exist, the file custom.java.security be added. To do so, the following must be added.

See also Central configuration file

Settings can now be protected from changes via the BPC license. This will primarily be used in our cloud installations (K8s). For example, using the core setting 'backupRepository', we define the configuration for OpenSearch backups in an Amazon S3 bucket, and we do not want this to be changeable via the BPC frontend.

To achieve this, when creating the license, the XML can be extended with the list element ` NON_WRITEABLE_SETTINGS `, which contains the IDs of the non-editable settings.

Excerpt from a sample license:

The settings (example: _core_noinstance_backupRepository) are the same as those used in the OpenSearch index ‘BPC-configuration’.

The structure is as follows: <ModuleId>_<InstancId>_<SettingName>

If the setting pertains to a module and not to an instance or component, then the value noinstance must be used for the <InstanceId>. You can access the <SettingName> by displaying the "ID" column in the Settings grid in the BPC frontend.

Example: _core_noinstance_backupRepository

We have reduced the number of shards to 1 in the Core_IndexTemplates setting. This is also the default setting that Elasticsearch/OpenSearch has been using for new indices for a few years now. This only affects newly created indices. Existing indices are not affected.

By optimizing accesses to the OpenSearch Backup API, fewer accesses are made to the data storage. This reduces the associated costs, for example, when using Amazon S3.

When saving JSON settings, attributes within objects were automatically sorted. This behavior has been disabled. This makes it possible to arrange the order according to your own criteria.

The bpc.env files now also set the security.properties for OpenSearch from the file custom.java.security. As a result, changes made to this file affect both Karaf and OpenSearch.

If you are using a BPC.env file, it is recommended that you update it. If it does not already exist, the file custom.java.security To do this, add the following:

See also Central configuration file

The license filename may now also be license.xml.virtimo. Previously, it had to be license.xml.bpc. This makes it possible to use a license that is also a valid INUBIT license file.

This change speeds up the loading of the BPC configuration in the client.

Properties have been set in the custom.java.security

If you are not yet using a custom.java.security file via Central configuration file, you should do so.

Existing custom.java.security files should be updated with the following entry:

The placeholder #user.loginName# is now correctly replaced in the Data_Filter when the dynamic filter # is used.

If the client sends multiple session cookies—possibly because multiple BPC instances are installed on the server—the appropriate session cookie is now taken into account.

In cases involving frequent data changes, errors could occur in the monitor when displaying detail views. As a result, the entire rendering of the application was disrupted, and the page had to be reloaded manually.

Uploaded files are no longer kept entirely in memory. This reduces memory usage and prevents "OutOfMemoryException".

This update requires updating Karaf and the modules bpc-be-core, bpc-be-analysis, bpc-be-forms, and bpc-be-monitor.

For BPC module developers:

In our earlier Karaf versions, we used CXF version 3.5.4. This CXF version includes Jackson version 2.14.3. We now ship Karaf with CXF 3.6.5, which includes Jackson version 2.17.2.

Please update the CXF version (3.6.5) in your ` pom.xml`. More importantly, you must also update the Jackson version (2.17.2) you are using. To do this, check whether you have an import package statement for this version. This must be added or updated if you use Jackson functions such as the ` ObjectMapper ` class.

Replace

with

Update OpenSearch according to the update instructions

The log level for the BPC plugin in OpenSearch has been reduced from trace to info. This setting can be found in the file opensearch/config/log4j2.properties.

The bundle info, which can be accessed via the Karaf console, no longer displays the build date but rather the date of the last change to the underlying source code.

Update OpenSearch according to the update instructions

Starting with IGUASU version 3.0.6, you can now jump directly from the BPC Flow Processor overview to the IGUASU processor. “Frontend URL” and “System ID” are now available in the Flow Manager. “URL” has been renamed to “Service URL.” Username and password are no longer required. Long descriptions of the processors are displayed in abbreviated form, with the full text available in a tooltip.

If free disk space falls below defined thresholds, shards are distributed to other nodes. It may also happen that indexes are set to read-only to prevent the disk from filling up.

The value of ` cluster.routing.allocation.disk.threshold_enabled ` is now ` true`. This corresponds to the OpenSearch default value.

Fields containing nested JSON objects are assigned the value "formatter" : "jsonStringify" in the initial column configuration. This converts the contents to text and displays them in the monitor.

A bug has been fixed that caused individual replication jobs to not be distributed correctly across all available nodes when changes were made to the nodes in the BPC cluster.

Although the OpenSearch connection was configured to use HTTP, the system attempted to establish the TLS context based on the configuration. However, if this configuration was incorrect, an error occurred.

The configuration is now ignored, as it is not relevant for HTTP connections.

Nevertheless, it is recommended to use secure connections in this context.

There were various issues when the time zone of the "Last Updated" column in the database table was set to UTC: - Tail Sync did not always delete all records. - Instead, it updated all records on every run. - Interaction with replication was also disrupted.

The documentation on configuring secure network connections has been revised.

See in particular Secure Connection (TLS/HTTPS)

Update OpenSearch according to the update instructions

A dark theme is now available for the BPC. It can be downloaded from the download page.

To switch between installed themes, you can use the plugin Theme Switcher, for example.

When impersonating other users, the language can no longer be changed in the impersonated user’s Keycloak profile. For this to work, Keycloak must be configured correctly so that Impersonator information is provided via an active scope.

The configuration grid_showHeader is obsolete because it causes errors. The behavior of the header has been controlled for some time now using the parameter moduleHeader_enabled. This setting is automatically removed during the BPC update.

Karaf access via SSH is described in more detail, and useful notes have been added.

The following documentation pages have been updated.

Update OpenSearch according to the update instructions

When the BPC is loaded, the version number of the Core Common Package (Fe-Core) is determined and stored in Local Storage. If this version number differs from the one saved during the previous load, the local storage is reset.

It is now possible to include references to external resources when writing audit information. For example, you can reference the IGUASU instance that generated the entry.

See System Monitoring (Metrics for Prometheus)

Instance-specific roles for editing can now be assigned for the HTML Content Module: htmlcontent_editor_<MODUL_ID> See also: HTML Content Module (User-Defined Content)

JSESSIONID cookie has been disabled

Update OpenSearch according to the update instructions

If an IP pinning error occurs, you can now log in normally after reloading the page in your browser. The error will not reappear (unless the IP address changes again).

In current Karaf versions, Karaf-specific environment variables for setting JVM memory have been removed and must be replaced with an alternative.

Linux

Please replace `

` with ` bpc.env.sh

` and adjust the values accordingly.

Windows

Please replace bpc.env.cmd

with

and adjust the values accordingly.

See also Central configuration file and Karaf

In current Karaf versions, Karaf-specific environment variables for setting JVM memory have been removed and must be replaced with an alternative.

Linux

Please replace `

` with ` bpc.env.sh

` and adjust the values accordingly.

Windows

Please replace bpc.env.cmd

with

and adjust the values accordingly.

See also Central configuration file and Karaf

Data binding within forms has been revised. Combining multiple data bindings now requires an operator such as +. For more information: Binding Form Component Attributes

Update OpenSearch according to the update instructions

Data binding within forms has been revised. Combining multiple data bindings now requires an operator such as +. For more information: Binding Form Component Attributes

Update OpenSearch according to the update instructions

Karaf logs are now made available via a monitor (see also Karaf Log).

The additional component 'Decanter' is used to write the Karaf logs to the OpenSearch index bpc-logs. In a new Karaf installation, this component is already preinstalled, and no action is required. If an existing Karaf installation cannot or should not be replaced, it can also be installed later via the Karaf console (internet connection required).

For configuration instructions, see Karaf Log.

As a result of this change, the use of Java 17 is now mandatory, and support for Java 11 has ended.

Karaf must be updated with this update.

Karaf logs are now made available via a monitor (see also Karaf Log).

The additional component 'Decanter' is used to write the Karaf logs to the OpenSearch index bpc-logs. In a new Karaf installation, this component is already pre-installed, and no action is required. If an existing Karaf installation cannot or should not be replaced, it can also be installed later via the Karaf console (internet connection required).

For configuration instructions, see Karaf Log.

New status endpoint for querying the role of individual nodes in cluster mode. This endpoint can now be used to check whether a node has the "Leader" role or not. See also BPC API /cxf/bpc-core/status/clustermaster

As a result of this change, the use of Java 17 is now mandatory, and support for Java 11 has ended.

Karaf must be updated with this update.

An update to the OpenSearch plugin (os-BPC-plugin) is required.

An update to the OpenSearch plugin (os-BPC-plugin) is required.

For existing installations, the file bpc-be-dashboard.jar can be omitted without replacement and deleted from the KARAF/deploy directory. The Dashboard module now consists solely of the file bpc-fe-dashboard.war.

Update OpenSearch according to the update instructions

If the environment variable KARAF_PAX_JDBC_FEATURES_TO_INSTALL is used in the central configuration file bpc.env.sh, ensure that the new module PAX JDBC Feature Installer is installed.

If backend module developers are using the OpenSearch REST High Level Client, they will most likely need to adapt their packages, as OpenSearch has moved some classes.

Update OpenSearch according to the update instructions

If the environment variable KARAF_PAX_JDBC_FEATURES_TO_INSTALL is used in the central configuration file bpc.env.sh, ensure that the new module PAX JDBC Feature Installer is installed.

If backend module developers are using the OpenSearch REST High Level Client, they will most likely need to adapt their packages, as OpenSearch has moved some classes.

Update OpenSearch according to the update instructions

If the environment variable KARAF_PAX_JDBC_FEATURES_TO_INSTALL is used in the central configuration file bpc.env.sh, ensure that the new module PAX JDBC Feature Installer is installed.

If backend module developers are using the OpenSearch REST High Level Client, packages will most likely need to be adapted, as OpenSearch has moved some classes.

Karaf must be updated with this update.

By default, users from the users.properties are no longer allowed to log in to the Karaf console via SSH. To allow users to log in via SSH, add the role ssh to the individual user’s entry in the file KARAF/etc/users.properties, or add the role from admingroup.

Entries in the file KARAF/etc/keys.properties that you do not use for logging in with a public/private key can be removed.

Entries in the file KARAF/etc/keys.properties that you do not use for logging in with a public/private key can be removed.

Karaf must be updated with this update.

By default, users from the users.properties are no longer allowed to log in to the Karaf console via SSH. To allow users to log in via SSH, add the role ssh to the individual user’s file at KARAF/etc/users.properties or add the role from admingroup.

If set, remove the following os-bpc-plugin -specific settings that are no longer needed from the conf/opensearch.yml.

If this is not done, OpenSearch will not start and will return the error "please check that any required plugins are installed, or check the breaking changes documentation for removed settings".

Affects only module developers When using the BPC JsonEditor (xtype bpcJsonField or bpcCodeEditorWindow.json), the optional JSON schema is now passed via schema and no longer via jsonSchema.

Previously, the content of the monitor jump column was trimmed (removal of leading and trailing spaces) when filtering in the target monitor. This is no longer done so that you can filter specifically for values with spaces at the beginning or end.
If you use values with additional spaces in your monitor jump column (e.g., in connection with the separator) that do not match the target values in the target monitor, these may need to be removed.

Applies only to module developers When using the BPC JsonEditor (xtype bpcJsonField or bpcCodeEditorWindow.json), the optional JSON schema is now passed via schema and no longer via jsonSchema.

If set, remove the following os-bpc-plugin -specific settings that are no longer needed from the conf/opensearch.yml.

If this is not done, OpenSearch will not start and will return the error "please check that any required plugins are installed, or check the breaking changes documentation for removed settings".

Previously, the content of the Monitor Jump column was trimmed (removal of leading and trailing spaces) when filtering in the target monitor. This is no longer done so that you can specifically filter for values with spaces at the beginning or end.
If you use values with additional spaces in your monitor jump column (e.g., in connection with the separator) that do not match the target values in the target monitor, these may need to be removed.

An update to OpenSearch or the os-BPC-plugin is required.

An update to OpenSearch or the os-BPC-plugin is required.

The name of the Common function "getInstanceUrl" (introduced with BPC 4.1.0) is being replaced by "getModuleUrl."

Update OpenSearch according to the update instructions

The name of the Common function "getInstanceUrl" (introduced with BPC 4.1.0) is replaced by "getModuleUrl".

Update OpenSearch according to the update instructions

To prevent scripting attacks, renderers can no longer be defined as plain text JavaScript in the columns. Custom renderer functions can be referenced as described here. Formatting functions from Ext.util.Format can be used by specifying the formatter. See also: Column configuration

A Karaf update is required for this BPC update.

Customer themes and custom BPC modules must be adapted so that the Web-ContextPath and Webapp-Context in the manifest file must begin with /. To achieve this, you can usually modify the file build.gradle. An example can be found at https://bitbucket.org/Virtimo/BPC-theme-template/commits/469a13171aa82655b6f0475b38a561d2ebceee52 [can be viewedhttps://bitbucket.org/virtimo/bpc-theme-template/commits/469a13171aa82655b6f0475b38a561d2ebceee52][here].

In the configuration file [karaf]/etc/org.ops4j.pax.web.cfg, Parameters have been renamed:

We had to move some interfaces/classes from the package de.virtimo.bpc.core to the package de.virtimo.bpc.api.

If you compile your code for 4.0.8 or 4.1 and receive errors, please update your Java imports. In most cases, you only need to replace .core. with .api.. Otherwise, delete the import and let the IDE find it for you.

And please make sure you do not have any <Import-Package> statements in your pom.xml for the following packages:

If BPC Core util classes were used.

Please update the Java import statements

And the pom.xml (<Import-Package>)

If the following was used

de.virtimo.bpc.core.utils.BpcTrustStoreUtil.setTo(…​)

please replace it with

de.virtimo.bpc.util.BpcTrustStore.getInstance().setTo(…​)

Plugins are passed a context when they are called. Two attributes in the context object have been renamed. moduleId has been changed to baseModuleId, and instanceId has been changed to moduleId.

Relevant for BPC module developers / Important for BPC Developers

This is only necessary when you use one of the following annotations in your backend modules/bundles:

If this is the case, please update your resources/OSGI-INF/blueprint/context.xml

and replace

<bean id="bpcJAXRSInvoker" class="de.Virtimo.BPC.jaxrs.BpcJAXRSInvoker"/>

with

<bean id="bpcJAXRSInvoker" class="de.Virtimo.BPC.jaxrs.BpcJAXRSInvoker" init-method="onStartup" destroy-method="onShutdown"> <argument ref="blueprintBundleContext"/> </bean>

With the Karaf update, a stronger algorithm is now used for hashing passwords. This affects all JAAS-based https://docs.Virtimo.net/BPC-docs/latest/core/admin/identity_provider/idp_config.html [https://docs.virtimo.net/bpc-docs/latest/core/admin/identity_provider/idp_config.html][Identity Provider] and the login to the Karaf console. All existing user passwords will no longer be valid and must be recreated!

If you wish to continue using the old user passwords, you must continue to use the old password hashing algorithm. This is described below. If you wish to use the new algorithm, you do not need to follow the steps below.

Configuration via https://docs.Virtimo.net/BPC-docs/latest/core/admin/configuration/bpc_env.html [https://docs.virtimo.net/bpc-docs/latest/core/admin/configuration/bpc_env.html][BPC.env] (recommended)

Add the following values to the bpc.env to retain the old algorithm.

Configuration via Karaf configuration files

Change the following values in the configuration file [karaf]/etc/org.apache.karaf.jaas.cfg. This will revert to the previous (weak) encryption.

Existing JAAS JDBC

The Virtimo JAAS JDBC implementation now uses the password encryption settings from the file: [karaf]/etc/org.apache.karaf.jaas.cfg. These do not match the ones used previously.

Therefore, if JAAS JDBC was already in use and you wish to continue using the existing (weak) hashes, please create the following file: [karaf]/etc/de.virtimo.bpc.core.auth.jaas.jdbc.cfg

The following content restores the previous (weak) configuration:

To use a more secure hash algorithm such as argon2, all passwords must be regenerated and thus reset.

A Content Security Policy (CSP) is set via an HTTP header. This may affect your own modules, INUBIT WebApps, or integrated third-party applications. To customize the CSP, see Content Security Policy

We used CXF version 3.5.4 in our previous Karaf releases. This CXF version provides Jackson version 2.13.4. We now ship Karaf with CXF 3.5.5, which includes Jackson version 2.14.1.

Please update the CXF version (3.5.4 → 3.5.5) in your pom.xml. It is also important to update the version of Jackson being used. To do this, check if you have an Import-Package statement for it. This must be added or adjusted when you use Jackson functionality such as the ` ObjectMapper ` class.

Replace

with

Dashboard settings Dashboard_Responsive(ID: module_isResponsive) and Dashboard_Layout(ID: layout_config) have been removed. Dashboards are now "responsive" by default and utilize the available space within their column. Users can now adjust the height and width of widgets. These changes are stored in the browser but can also be saved to the dashboard by authorized users. Resetting local changes is no longer possible directly on the widget; instead, it is done via a button in one of the toolbars. To display this button, the value ` "resetUserState" ` must be added to one of the settings: ModuleHeader_Content, Toolbar_LeftContent, or Toolbar_RightContent.

See also Dashboard Quick Actions

Replication status information is no longer displayed on the monitor. This status information will be provided in a future release via a plugin.

If you have been using the following

de.virtimo.bpc.core.utils.ServiceUtil.unregisterService(bundleContext, ServiceRegistration, Class);

please use

de.virtimo.bpc.api.BpcService.unregister(bundleContext, ServiceRegistration, Class);

instead.

For BPC module developers

There was an undocumented function that responded globally to the " click" event on all components with the " targetModule" attribute. In this process, the value of " targetModule " was passed to the " BpcCommon.Api.showModule " method, thereby triggering navigation to that module. This function has now been removed. If you have used the targetModule attribute—for example, on buttons—for navigation, you must set this up using your own handler that applies only to your components.

A big request: when updating Karaf, do not simply copy all etc files from the old installation to the new one. This may result in new Karaf options not being set, and in the worst case, Karaf may not start.

And if at all possible, do not manually edit [karaf]/etc files; instead, make the adjustments via bpc.env.sh (Linux/macOS) or bpc.env.cmd (Windows). This makes Karaf updates much easier and can be used in BPC versions >= 3.4. See Central configuration file for more information.

Most customizations can be made by overriding values in etc files without having to edit an etc file.

For example, if you want to set different paths for the keystore and truststore files: The paths are defined in the configuration file [karaf]/etc/org.ops4j.pax.web.cfg under the options org.ops4j.pax.web.ssl.keystore and org.ops4j.pax.web.ssl.truststore.

To set different paths for these two options, you can add two environment variables to bpc.env.sh:

 export ORG_OPS4J_PAX_WEB_ORG_OPS4J_PAX_WEB_SSL_KEYSTORE=/opt/bpc.env/ssl/virtimo_keystore.jks  export ORG_OPS4J_PAX_WEB_ORG_OPS4J_PAX_WEB_SSL_TRUSTSTORE=/opt/bpc.env/ssl/virtimo_truststore.jks

Here’s another example of how to set the ` de.virtimo.bpc.core.maintenancemode.fileSystemLimitInMB ` option in the ` [karaf]/etc/de.virtimo.bpc.core.cfg `:

export DE_VIRTIMO_BPC_CORE_DE_VIRTIMO_BPC_CORE_MAINTENANCEMODE_FILESYSTEMLIMITINMB=4096

A limitation will be resolved with the next Karaf update. The deployment directory ([karaf]/deploy) cannot currently be set via an environment variable due to a "bug." This affects the option felix.fileinstall.dir in the configuration file [karaf]/etc/org.apache.felix.fileinstall-deploy.cfg.

Depending on usage, three files should be copied or replaced with symbolic links:

Of course, this is only necessary if these files have been modified at all. The options in the two cfg files could also be set via environment variables, but that would require setting several environment variables.

An update to Karaf is strongly recommended for security reasons.

Monitor views created with a BPC version < 2.1.6 are no longer supported. To preserve these views, they must be opened once in the "Manage Views" dialog and saved. This process saves the views in the correct format.

A big request: when updating Karaf, please do not simply copy all etc files from the old installation to the new one. This may result in new Karaf options not being set, and in the worst case, Karaf may fail to start.

And if at all possible, do not manually edit [karaf]/etc files; instead, make adjustments via bpc.env.sh (Linux/macOS) or bpc.env.cmd (Windows). This makes Karaf updates much easier and can be used in BPC versions >= 3.4. See Central configuration file for more information.

Most customizations can be made by overriding values in etc files without having to edit an etc file.

For example, if you want to set different paths for the keystore and truststore files: The paths are defined in the configuration file [karaf]/etc/org.ops4j.pax.web.cfg under the options org.ops4j.pax.web.ssl.keystore and org.ops4j.pax.web.ssl.truststore.

To set different paths for these two options, you can add two environment variables to bpc.env.sh:

 export ORG_OPS4J_PAX_WEB_ORG_OPS4J_PAX_WEB_SSL_KEYSTORE=/opt/bpc.env/ssl/virtimo_keystore.jks  export ORG_OPS4J_PAX_WEB_ORG_OPS4J_PAX_WEB_SSL_TRUSTSTORE=/opt/bpc.env/ssl/virtimo_truststore.jks

Here’s another example of how to set the ` de.virtimo.bpc.core.maintenancemode.fileSystemLimitInMB ` option in the ` [karaf]/etc/de.virtimo.bpc.core.cfg `:

export DE_VIRTIMO_BPC_CORE_DE_VIRTIMO_BPC_CORE_MAINTENANCEMODE_FILESYSTEMLIMITINMB=4096

A limitation will be resolved with the next Karaf update. The deployment directory ([karaf]/deploy) currently cannot be set via an environment variable due to a "bug." This affects the option felix.fileinstall.dir in the configuration file [karaf]/etc/org.apache.felix.fileinstall-deploy.cfg.

Depending on usage, three files should be copied or replaced with symbolic links:

Of course, this is only necessary if these files have been modified at all. The options in the two cfg files could also be set via environment variables, but that would require setting several environment variables.

We had to move some interfaces/classes from the de.virtimo.bpc.core package to the de.virtimo.bpc.api package.

If you’re compiling your code for 4.0.8 or 4.1 and encounter errors, please update your Java imports accordingly. In most cases, you only need to replace .core. with .api.. Otherwise, delete the import and let the IDE find it for you.

And please make sure you don’t have any <Import-Package> statements in your pom.xml for the following packages:

If BPC Core util classes were used.

Please update the Java import statements

And the pom.xml (<Import-Package>)

If the following was used

de.virtimo.bpc.core.utils.BpcTrustStoreUtil.setTo(…​)

please replace it with

de.virtimo.bpc.util.BpcTrustStore.getInstance().setTo(…​)

Plugins are passed a context when called. Two attributes in the object context have been renamed. moduleId has been changed to baseModuleId, and instanceId has been changed to moduleId.

Dashboard settings Dashboard_Responsive(ID: module_isResponsive) and Dashboard_Layout(ID: layout_config) have been removed. Dashboards are now "responsive" by default and utilize the available space within their column. Users can now adjust the height and width of widgets. These changes are stored in the browser but can also be saved to the dashboard by authorized users. Resetting local changes is no longer possible directly on the widget; instead, it is done via a button in one of the toolbars. To display this button, the value ` "resetUserState" ` must be added to one of the settings: ModuleHeader_Content, Toolbar_LeftContent, or Toolbar_RightContent.

See also Dashboard Quick Actions

Replication status information is no longer displayed on the monitor. This status information will be provided via a plugin in a future release.

If you have been using the following:

de.virtimo.bpc.core.utils.ServiceUtil.unregisterService(bundleContext, ServiceRegistration, Class);

please use

de.virtimo.bpc.api.BpcService.unregister(bundleContext, ServiceRegistration, Class);

instead.

To prevent scripting attacks, renderers can no longer be defined as plain text JavaScript in the columns. Custom renderer functions can be referenced as described here. Formatting functions from Ext.util.Format can be used by specifying the formatter. See also: Column configuration

The Karaf update now uses a stronger algorithm for hashing passwords. This affects all JAAS-based https://docs.Virtimo.net/BPC-docs/latest/core/admin/identity_provider/idp_config.html [https://docs.virtimo.net/bpc-docs/latest/core/admin/identity_provider/idp_config.html][Identity Providers] and login to the Karaf console. All existing user passwords will no longer be valid and must be recreated!

If you wish to continue using the old user passwords, you must continue to use the old password hashing algorithm. This is described below. If you wish to use the new algorithm, you do not need to follow the steps below.

Configuration via https://docs.Virtimo.net/BPC-docs/latest/core/admin/configuration/bpc_env.html [https://docs.virtimo.net/bpc-docs/latest/core/admin/configuration/bpc_env.html][BPC.env] (recommended)

Add the following values to ` bpc.env ` to retain the old algorithm.

Configuration via Karaf configuration files

Change the following values in the configuration file ` [karaf]/etc/org.apache.karaf.jaas.cfg `. This will revert to the previous (weak) encryption.

Existing JAAS JDBC

The Virtimo JAAS JDBC implementation now uses the password encryption settings from the file: [karaf]/etc/org.apache.karaf.jaas.cfg. These do not match the ones used previously.

Therefore, if JAAS JDBC was already in use and you wish to continue using the existing (weak) hashes, please create the following file: [karaf]/etc/de.virtimo.bpc.core.auth.jaas.jdbc.cfg

The following content restores the previous (weak) configuration:

To use a more secure hash algorithm such as argon2, all passwords must be regenerated and thus reset.

A Content Security Policy (CSP) is set via an HTTP header. This may affect your own modules, INUBIT WebApps, or integrated third-party applications. To customize the CSP, see Content Security Policy

For BPC module developers

There was an undocumented function that reacted globally, on all components with the attribute targetModule, to the event click. In this case, the value of ` targetModule ` was passed to the method ` BpcCommon.Api.showModule , thereby triggering navigation to that module. This function has now been removed. If you have used the ` `targetModule` attribute—for example, on buttons—for navigation, you must implement your own handler that applies only to your components.

An update to Karaf is required for this BPC update.

Customer themes and custom BPC modules must be adapted so that the Web-ContextPath and Webapp-Context in the manifest file must begin with /. To achieve this, the file build.gradle can usually be modified. An example can be https://bitbucket.org/Virtimo/BPC-theme-template/commits/469a13171aa82655b6f0475b38a561d2ebceee52 [be viewedhttps://bitbucket.org/virtimo/bpc-theme-template/commits/469a13171aa82655b6f0475b38a561d2ebceee52][here].

In the configuration file [karaf]/etc/org.ops4j.pax.web.cfg, parameters have been renamed:

An update to Karaf is strongly recommended for security reasons.

We used CXF version 3.5.4 in our previous Karaf releases. This CXF version includes Jackson version 2.13.4. We now ship Karaf with CXF 3.5.5, which includes Jackson version 2.14.1.

Please update the CXF version (3.5.4 → 3.5.5) in your pom.xml. It is even more important to update the version of Jackson being used as well. To do this, check if you have an Import-Package statement for it. This must be added or adjusted if you use Jackson functionality such as the ` ObjectMapper ` class.

Replace

with

Relevant for BPC module developers / Important for BPC Developers

This is only necessary when you use one of the following annotations in your backend modules/bundles:

If this is the case, please update your resources/OSGI-INF/blueprint/context.xml

and replace

<bean id="bpcJAXRSInvoker" class="de.Virtimo.BPC.jaxrs.BpcJAXRSInvoker"/>

with

<bean id="bpcJAXRSInvoker" class="de.Virtimo.BPC.jaxrs.BpcJAXRSInvoker" init-method="onStartup" destroy-method="onShutdown">     <argument ref="blueprintBundleContext"/>  </bean>