Developer-Changelog

The values of the different options in combo boxes are now no longer generally supplemented with a  . This makes automated testing of the interfaces easier.

Buttons can now use the classes arrow-spacing-sm (small) and arrow-spacing-xs (extra small) to reduce the spacing of the arrow.

If a BPC module used a different versioning than the BPC core, the project.version property affected the dependencies in the BPC core and caused problems. The dependencies within the BPC core are now no longer influenced by the project.version property in the module.

Forms now correctly translates the labels for all components, including in the state. This makes it possible to set bindings on labels. See Mehrsprachige Inhalte.

setFormState can now also handle labels in multiple languages correctly. In this context, a bug was fixed that caused bindings to be removed when using setFormState, so that after setFormState, only data from before setFormState was present in the submit. In addition, all components can now be used in combination with setFormState, including Combobox and Table.

The reset function previously removed bindings. As a result, after a reset, the current state could no longer be submitted. This problem has been fixed.

The components Table and Combobox have been improved and now behave like the other components.

See BPC Modul entwickeln and Modul und Modulinstanz Einstellungen

The documentation on the creation and use of monitor deeplinks has been expanded. Monitor Deeplink

Revised instructions. See BPC Modul entwickeln

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

See also User Session um zusätzliche Organisationen/Rollen/Rechte und weitere Daten ergänzen

The currently set font can be read out via the CSS variable --font-family.

We used CXF version 3.5.4 in our previous Karaf releases. This CXF version provides Jackson in version 2.14.3. Now we ship Karaf with CXF 3.6.5, which provides Jackson in the version 2.17.2.

Please update the CXF version (3.6.5) in your pom.xml. And more important is to update also the used Jackson version (2.17.2). For this check if you have an Import-Package statement for it. This must be added or adjusted when you use Jackson functionality like the ObjectMapper class.

Replace

with

Modules can now send updates to the plugins loaded there via their hooks. See also: BPC Plugins entwickeln

Module developers must ensure that no additional parameters are specified in the Bundle-SymbolicName.

Incorrect: de.virtimo.bpc.module-id;blueprint.aries.xml-validation:=false

Correct: de.virtimo.bpc.module-id

The incorrect variant was included in earlier templates for BPC modules.

If the HTTP headers system.id and instance.id are set, the values are written into a new JSON object externalReference under the fields iguasuSystemId and iguasuInstanceId.

The browser function https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify][JSON.stringify] is now available as an ExtJS format function.

This allows it to be easily used in various places to convert JSON into text.

A dedicated prefix is now used for the values in LocalStorage. As a result, the contents of other applications are not deleted.

See Vom BPC bereitgestellte Button-Typen entwickeln

The HTTP status codes for responses to the REST API have been documented in greater detail. See: BPC API

The core now automatically searches for a configuration for indices that are to be created and managed.

See also Anlegen von Indices

Paths in themes should now always be specified as absolute.

Correct: $CompanyIcon: "/bpc-theme-customer/resources/images/favicon.png"

Incorrect: $CompanyIcon: "../resources/images/favicon.png"

See also: BPC Theme entwickeln

See BPC Theme entwickeln

An endpoint for sending events has been provided See also: Event API

It is now possible to specify references to external resources when writing audit information. For example, it is possible to refer to the IGUASU instance that created the entry.

For instance types, labels can be defined using language keys. The language key is composed as follows: "<MODULE_ID>_INSTANCE_TYPE_<INSTANCE_TYPE>" The language key for core modules is composed as follows: "CORE_<MODULE_ID>_INSTANCE_TYPE_<INSTANCE_TYPE>" or, for example: "CORE_BACKENDCONNECTION_INSTANCE_TYPE_HTTP_PROXY": "HTTP Proxy"

The documentation has been updated to include information about the dependency on "theme-triton" for custom CSS in custom frontend modules.

BPC Modul entwickeln

BPC modules can now react to restored indices via events.

See also Backup von Indices

If a managed index was deleted during or shortly before a write access, it was automatically recreated. However, the general index configuration was not taken into account in this process. This behavior is now avoided.

See also Anlegen von Indices

See also Anlegen von Indices

Due to this change, the use of Java 17 is now mandatory and support for Java 11 has ended.

Due to this change, the use of Java 17 is now mandatory and support for Java 11 has ended.

Only relevant for BPC module developers

BPC modules previously obtained the ExtJS framework either via our own NPM repository or it had to be provided separately. Now, ExtJS can be obtained directly from Bitbucket via npm. For this, the dependency "@virtimo/sencha-extjs-sdk": "git+ssh://git@bitbucket.org/virtimo/sencha-extjs-sdk#c728d7e2 [git+ssh://git@bitbucket.org/virtimo/sencha-extjs-sdk#c728d7e2]" must be set in the package.json. It should be noted that the part at the end #c728d7e2 corresponds to a GIT commit ID. This should be chosen so that it matches the current branch or BPC version. c728d7e2 corresponds to the current BPC 4.1 branch "support/4.1.x". Alternatively, you can also specify the branch name. However, this is not recommended, as it has been shown that npm does not consider newer commits in this case when updating.

After entering the dependency, the path to the ExtJS framework in the workspace.json file can be set as follows:

A directory or symlink "ext" is no longer necessary.

At de.virtimo.bpc.module.monitor.api.service.MonitorService, it is now possible to check via isAcccessible(…​) whether a user is allowed to access certain monitor functions.

Update OpenSearch according to the update guide.

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 use the OpenSearch REST High Level Client, packages will most likely need to be adjusted, as OpenSearch has moved some classes here.

Update OpenSearch according to the update guide.

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 use the OpenSearch REST High Level Client, packages will most likely need to be adjusted, as OpenSearch has moved some classes here.

Update OpenSearch according to the update guide.

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 use the OpenSearch REST High Level Client, packages will most likely need to be adjusted, as OpenSearch has moved some classes here.

Only relevant for 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.

Only relevant for 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.

See HTML Sanitizing and the setting sanitzeHTML

An update of the Karaf is mandatory 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 a /. To achieve this usually the file build.gradle can be adapted. An example can be seen https://bitbucket.org/virtimo/bpc-theme-template/commits/469a13171aa82655b6f0475b38a561d2ebceee52 [https://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 de.virtimo.bpc.core to the de.virtimo.bpc.api package.

If you compile your code for 4.0.8 or 4.1 and get errors, then please adjust the Java imports. In most cases you just have to replace .core. by .api.. Otherwise delete the import and let the IDE find it for you.

And please be sure that you do not have <Import-Package> statements in your pom.xml to the following packages:

In case you used BPC Core utils classes.

Please adjust your Java import statements

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

In case you used

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

then please replace it with

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

For BPC developers Plugins are passed a context when called. Two attributes in the context object have been renamed. moduleId became baseModuleId and instanceId became 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, then please update your resources/OSGI-INF/blueprint/context.xml

and replace

 <bean id="bpcJAXRSInvoker" class="en.virtimo.bpc.jaxrs.BpcJAXRSInvoker"/>

with

 <bean id="bpcJAXRSInvoker" class="en.virtimo.bpc.jaxrs.BpcJAXRSInvoker" init-method="onStartup" destroy-method="onShutdown">     <argument ref="blueprintBundleContext"/>  </bean>

A Content Security Policy(CSP) is set via HTTP header. This can affect custom 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 in version 2.13.4. Now we ship Karaf with CXF 3.5.5, which provides Jackson in the version 2.14.1.

Please update the CXF version (3.5.4 → 3.5.5) in your pom.xml. And more important is to update also the used Jackson version. For this check if you have an Import-Package statement for it. This must be added or adjusted when you use Jackson functionality like the ObjectMapper class.

Replace

with

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

In case you used

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

then please use

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

instead.

For BPC module developers

There was an undocumented function that reacted globally, on all components with the attribute targetModule, to the event click. This passed the value of targetModule to the BpcCommon.Api.showModule method, triggering navigation to that module. This function has now been removed. If you have used the attribute targetModule, e.g. on buttons, for navigation, you have to set this up by a separate handler that only affects your components.

For BPC module developers

ExtJS components that use the mixin Ext.form.Labelable and thus the attributes labelWidth and fieldLabel can have the plugin dynamically set the labelWidth based on the actual text width.

If required, the additional spacing can be configured using labelOffset on the plugin:

See also Dynamisches Field Label

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

If you compile your code for 4.0.8 or 4.1 and get errors, then please adjust the Java imports. In most cases you just have to replace .core. by .api.. Otherwise delete the import and let the IDE find it for you.

And please be sure that you do not have <Import-Package> statements in your pom.xml to the following packages:

In case you used BPC Core utils classes.

Please adjust your Java import statements

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

In case you used

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

then please replace it with

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

For BPC developers Plugins are passed a context when called. Two attributes in the context object have been renamed. moduleId became baseModuleId and instanceId became moduleId.

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

In case you used

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

then please use

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

instead.

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

For the BPC backend module developers. Please make sure in the src/main/resources/OSGI-INF/blueprint/context.xml (if used; do not create when it does not exist) that the cxf:bus is set as follows:

 <!-- BPC-6587 [/browse/BPC-6587] - org.apache.cxf.BusException: No DestinationFactory was found for the namespace http://cxf.apache.org/transports/http [http://cxf.apache.org/transports/http] -→  <!-- It seems that when set it waits for CXF first. -→  <!-- To get rid of the CXF loggings …​ Karaf-Konsole: log:set ERROR org.apache.cxf -→  <cxf:bus>    <cxf:features>      <cxf:logging />    </cxf:features>  </cxf:bus>

For BPC module developers

There was an undocumented function that reacted globally, on all components with the attribute targetModule, to the event click. This passed the value of targetModule to the BpcCommon.Api.showModule method, triggering navigation to that module. This function has now been removed. If you have used the attribute targetModule, e.g. on buttons, for navigation, you have to set this up by a separate handler that only affects your components.

An update of the Karaf is mandatory 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 a /. To achieve this usually the file build.gradle can be adapted. An example can be seen https://bitbucket.org/virtimo/bpc-theme-template/commits/469a13171aa82655b6f0475b38a561d2ebceee52 [https://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 used CXF version 3.5.4 in our previous Karaf releases. This CXF version provides Jackson in version 2.13.4. Now we ship Karaf with CXF 3.5.5, which provides Jackson in the version 2.14.1.

Please update the CXF version (3.5.4 → 3.5.5) in your pom.xml. And more important is to update also the used Jackson version. For this check if you have an Import-Package statement for it. This must be added or adjusted when you use Jackson functionality like 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, then please update your resources/OSGI-INF/blueprint/context.xml

and replace

 <bean id="bpcJAXRSInvoker" class="en.virtimo.bpc.jaxrs.BpcJAXRSInvoker"/>

with

 <bean id="bpcJAXRSInvoker" class="en.virtimo.bpc.jaxrs.BpcJAXRSInvoker" init-method="onStartup" destroy-method="onShutdown">     <argument ref="blueprintBundleContext"/>  </bean>