Developer Changelog

Fix for BpcCommon.Api.getTranslation: If a translation incorrectly returns an object (e.g., for "config"), the system now falls back to the key string to avoid [object Object].

In the frontend, the global event beforeShowModule is fired before switching to a new view (module or module component). The following parameters are passed: the module ID of the current view, the module ID of the new view to be displayed, and additional options. If an event listener returns ` false `, the transition to the new view is canceled. If this behavior is implemented, the user should also receive feedback explaining why the transition was canceled.

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 used on buttons to reduce the arrow spacing.

This update requires updating Karaf.

The BPC provides OpenAPI-compliant specification files for our APIs. These are located under Downloads and can also be accessed dynamically via the BPC, provided this option is enabled. For more information, see the BPC-API section.

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. The dependencies within the BPC Core are no longer influenced by the project.version property in the module.

When handling events, Map should be used instead of Dictionary.

Forms now correctly translates 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 update, a bug was fixed that caused setFormState to remove bindings, 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.

The reset function previously 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 " Common Table Expression Abfrage " setting in replication can now be edited in an editor that supports SQL syntax.

Performance has been improved and heap memory usage reduced. Java now needs to perform significantly fewer garbage collector calls. This is especially true when the log levels for the BPC packages are set to the default (WARN). This affects the standard BPC modules for Karaf as well as the OpenSearch plugin.

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

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

In selected code editors (JSON, CSS, …​), you can now use the to display the content in a pop-up window. This provides more screen space and makes it easier to view or edit the content.

BPC module developers can now use the corresponding components from the CoreCommon package.

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

You can use the LogService API to be redirected directly to the LogService configuration or to connected monitors. There are two new LogService endpoints that redirect users to the corresponding BPC pages when called:

See also API documentation: Log Service API

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, the values are written to a new JSON object named externalReference under the fields iguasuSystemId and iguasuInstanceId.

The browser function `JSON.stringify ` is now available as an ExtJS formatting function.

This makes it easy to use 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.

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

The Core now automatically searches for a configuration for indices 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

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.

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

Labels can be defined for instance types using language keys. The language key is structured as follows: "<MODULE_ID>_INSTANCE_TYPE_<INSTANCE_TYPE>" The language key for core modules is structured 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

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.

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

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.

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" must be set in the package.json. Please 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.

BPC modules can now react to restored indices 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