Installation with preconfigured BPC

A preconfigured BPC can be started directly with/after Installation. Both module and module instance settings can be configured Module and module instance settings as well as preconfigured OpenSearch indices can be imported. This is particularly useful in the Kubernetes/container environment.

Import module and module instance settings

Module and module instance settings can be exported as a JSON file via the deployment and imported after the installation. The following section explains how to import module and module instance settings Preparation and Implementation.

Prerequisites and preparation

An existing BPC installation is required, the configuration of which is to be used as the basis for the new system. To do this, export the required configurations from this to a JSON file (deployment target) via Deployment.

Application

Rename the JSON file previously created by deployment. It must have the file extension .bpc-deployment-export. Now copy this to the [KARAF]/deploy directory in the newly set up system. The configurations contained therein are imported automatically.

Notes:

The system checks every 3 seconds whether a file with this file extension exists in the [KARAF]/deploy directory
Only deployment exports in which ALL modules used are loaded can be imported. For example, if the Karaf is just starting up, it will try again in 3 seconds, etc.

File extensions

As mentioned above, the file to be imported must initially have the file extension .bpc-deployment-export.

After processing, this import file is renamed so that the same file is not processed again and again. It will have one of the following file extensions:

.processed - after successful processing
.empty - if the import file does not contain any module information
.invalid_json - if the import file does not contain any valid JSON
.error - if an error occurred while checking whether all relevant modules have been loaded, an error occurred
.error_on_import - if there was a problem during the import

Importing OpenSearch indices

In addition to module and instance settings, OpenSearch indices can also be imported. In the following we describe the Preparation and Implementation.

Prerequisites and preparation

To import an OpenSearch index, you must create an export file in JSON format. This must have the file extension .bpc-index-export and is structured as follows:

{
    "indexAlias": "index-name",
    "mappings": {
        //...
    },
    "data": {
        "1" : {"processid":1,"textfield":"Test","numberfield":1337,"lastupdate":"2025-12-04T12:00:00.000Z"},
        "2" : {"processid":2,"textfield":"Hallo Welt","numberfield":1338,"lastupdate":"2025-12-04T12:00:01.000Z"},
        "3" : {"processid":3,"textfield":"Foo Bar","numberfield":999,"lastupdate":"2025-12-05T12:00:01.000Z"}
    }
}

The field indexAlias is the alias of the index to be created.

The field mappings contains the mapping of the index which can be seen in the frontend under Administration→Core Services→Indices→Display mapping.

The individual OpenSearch documents are saved at data. The key of the entries (in the example "1", "2", "3") is the document ID, and the value is the document.

Application

The JSON file created must be renamed with the file extension .bpc-index-export. Now copy this to the [KARAF]/deploy directory in the newly set up system. The index described is created and filled with the respective data if no index with this name already exists.

Notes:

The system checks every 3 seconds whether a file with this file extension exists in the [KARAF]/deploy directory

File extensions

As mentioned above, the file to be imported must initially have the file extension .bpc-index-export.

After processing, this import file is renamed so that the same file is not processed again and again. It will have one of the following file extensions:

.processed - after successful processing
.invalid_json - if the import file does not contain valid JSON
.error - if an error occurs during the import
.index_already_exists - if the described index already exists

Keywords: