Developer Changelog

The values of the various options in combo boxes are no longer uniformly supplemented with a "  ." This facilitates automated testing of the user interfaces.

The classes arrow-spacing-sm (small) and arrow-spacing-xs (extra small) can now be applied to buttons to reduce the arrow’s spacing.

If a BPC module used a different versioning scheme than the BPC Core, the " project.version " property affected the dependencies in the BPC Core and caused problems. Dependencies within the BPC Core are no longer affected by the ` project.version ` property in the module.

Forms now correctly translate Labels for all components, including those in the state. This makes it possible to set bindings on Labels. See Multilingual Content.

setFormState can now also correctly handle Labels in multiple languages. As part of this, a bug was fixed that caused setFormState bindings to be removed, resulting in the submit after setFormState containing only data from before setFormState. Additionally, all components can now be used in combination with setFormState, including combo boxes and tables.

Previously, the reset function removed bindings. As a result, the current state could no longer be submitted after a reset. This issue has been resolved.

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

See Developing a BPC Module and Module and Module Instance Settings

The documentation on creating and using Monitor Deeplinks has been updated. Monitor Deeplink

Revised instructions. See Developing a BPC Module

The user session can be supplemented with customData that comes 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 currently set font can be retrieved via the CSS variable --font-family.

With this update, it is necessary to update 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 you are using (2.17.2). 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

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

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 version was included in earlier templates for BPC modules.

If the HTTP headers system.id and instance.id are set, their values are written to a new JSON object named 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 formatting function.

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

A dedicated prefix is now used for values in LocalStorage. This prevents content from other applications from being deleted.

See Developing Button Types Provided by BPC

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 indexes that are to be created and managed.

See also Creating Indexes

Paths in themes should now always be specified as absolute paths.

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

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

See also: Developing a BPC Theme

See Developing a BPC Theme

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, you can reference the IGUASU instance that generated the entry.

Labels for instance types 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"

Information regarding the dependency on "theme-triton" for custom CSS in custom frontend modules has been added to the documentation.

Developing a BPC Module

BPC modules can now respond to restored indexes via events.

See also Backing up indices

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

See also Creating Indexes

See also Creating Indexes

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

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

Only relevant for BPC module developers

Previously, BPC modules either obtained the ExtJS framework from our own NPM repository or it had to be provided separately. ExtJS can now be obtained directly from Bitbucket via npm. To do 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. Note 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 observed that npm does not take newer commits into account during an update in this case.

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

A directory or symlink named “ext” is no longer necessary.

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

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.

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

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.

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.

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.

See HTML Sanitizing and the sanitizeHTML setting

An update to Karaf is required for this BPC update.

Customer themes and custom BPC modules must be modified 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 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:

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

If you are compiling your code for 4.0.8 or 4.1 and encounter errors, please update the 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 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(…​)

then please replace it with

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

Plugins are passed a context when 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>

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 version of CXF 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 you are using as well. 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

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.

For BPC module developers

ExtJS components that use the mixin Ext.form.Labelable and, as a result, the attributes labelWidth and fieldLabel, can use the plugin to dynamically set the ` labelWidth ` based on the actual text width.

If needed, the additional spacing can be configured in the plugin using ` labelOffset `:

` See also Dynamic Field Label

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

If you compile your code for 4.0.8 or 4.1 and receive errors, please update the 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 adapt 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.

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.

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 backend module developers. Please ensure in the src/main/resources/OSGI-INF/blueprint/context.xml (if used; do not create a new one) that the cxf:bus is set as follows:

<cxf:bus><cxf:features> </cxf:features></cxf:bus><!-- 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] -→ <cxf:bus><cxf:features> </cxf:features></cxf:bus><!-- It seems that when set it waits for CXF first. -→ <cxf:bus><cxf:features> </cxf:features></cxf:bus><!-- To get rid of the CXF loggings …​ Karaf-Konsole: log:set ERROR org.apache.cxf -→ <cxf:bus><cxf:features> </cxf:features> <cxf:features>      <cxf:logging />    </cxf:features> <cxf:features> </cxf:features></cxf:bus>

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.

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, 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 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 Jackson version you are using as well. 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

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>