Update Guide
This page describes how to update an existing BPC installation (version 4.1) to a newer patch level (also version 4.1).
|
Migration to a Higher Major or Minor Version
If you are updating to a higher major or minor version, please first review the corresponding migration guide. See also Migration |
This guide is general in nature and describes how to update individual components of the BPC. Please always refer to the Changelog for the respective versions.
If you are using BPC together with INUBIT, you must also follow the INUBIT Patch Guide. If BPC was installed using the installer, please proceed to the section Update via INUBIT Installer.
For an explanation of version numbering, see the versioning guide.
|
The following steps are divided into the following categories:
|
Identify Necessary Steps
MANDATORY
To identify all necessary steps for an update, you should check the Changelog. In particular, pay attention to the comments on the "Breaking Changes." You should review all changelogs released after the version you currently have installed.
Backup
RECOMMENDED
It is recommended that you back up the entire system. See also Backup & Restore
Update BPC Modules
MANDATORY
To perform the update, you need the module files that match your installation.
You can find the required files at Download - Virtimo File Server.
There are so-called frontend and backend files.
The file names follow the pattern bpc-fe-MODULNAME.war (frontend) or bpc-be-MODULNAME.jar (backend).
BPC modules consist of at least one of these two files.
You must update at least the core component (Core Module). However, it is recommended that you update all existing modules to the latest version.
|
If you also want to update Karaf, you should do so first or combine both steps. |
-
Back up your current directory
INSTALLATIONSVERZEICHNIS/karaf/deploy. -
Copy the new BPC modules to the folder
INSTALLATIONSVERZEICHNIS/karaf/deploy.
Update Karaf
CONDITIONAL - If this is recommended in the Changelog.
You can find the required file on the download page.
-
Stop the Karaf process.
-
Back up the directory
INSTALLATIONSVERZEICHNIS/karaf(or the directory to which the link points). -
Remove the link
INSTALLATIONSVERZEICHNIS/karaf. -
Install Karaf as described in the installation guide.
-
If you made any configurations directly in your previous Karaf installation, transfer them to the new Karaf.
-
To facilitate future updates, you should perform all Karaf configurations via the Central configuration file.
-
If you still wish to change the Karaf configuration, you should make the individual configuration changes directly in the files of the new Karaf. Simply copying the files may result in them overwriting other configuration parameters that are necessary or recommended for the operation of the BPC.
-
-
Copy the contents from the old
karaf/deploydirectory to the new Karaf. -
Update the BPC modules (see Update BPC Modules).
-
If you previously installed JDBC drivers and are not yet using the central configuration file for them, you must repeat this step (see Databases) or adjust the central configuration file.
-
Start the Karaf process.
Update OpenSearch
CONDITIONAL - If this is recommended in the Changelog.
-
Stop the OpenSearch process.
-
Back up the directory
INSTALLATIONSVERZEICHNIS/opensearch_data; this contains the database data and may be modified by the new OpenSearch version, after which it can no longer be used with older versions. -
Remove the link
INSTALLATIONSVERZEICHNIS/opensearch. -
Install OpenSearch as described in the installation guide.
-
If you have made any configuration changes to the old installation, you can transfer them from the backup to the file
INSTALLATIONSVERZEICHNIS/opensearch/config/opensearch.yml. -
Start the OpenSearch process.
Central configuration file (BPC.env)
If an update to Central configuration file is necessary, you should always create a backup copy of your current file.
To perform the update, you should compare your existing BPC.env file with the latest version (see the download page). If any entries are missing from your BPC.env file, you can usually copy them directly. If there are any entries that differ, you should evaluate them carefully and compare them with the documentation and the Changelog.
|
It is recommended to mark changed configurations with comments and, if necessary, document them directly. This makes future updates easier. |
Update OpenSearch Plugin
CONDITIONAL - If recommended in the Changelog.
It is recommended to always update the entire OpenSearch (Update OpenSearch). However, it is also possible to update only the plugin.
To perform the update, you’ll need the file os-bpc-plugin.zip for the desired target version.
You can find this on the download page.
-
Stop OpenSearch.
-
Remove the old plugin.
OPENSEARCH/bin/opensearch-plugin remove os-BPC-plugin
-
Install the new plugin.
OPENSEARCH/bin/opensearch-plugin install file:///PFAD/ZUM/PLUGIN/os-bpc-plugin.zip
-
Start OpenSearch.
Update Java
OPTIONAL - If recommended in the Changelog. You can find the recommended Java version on the download page.
|
Stop all processes (e.g., OpenSearch and Karaf) that use the current runtime environment (usually |
-
Remove the link
INSTALLATIONSVERZEICHNIS/_jvm. -
Reinstall Java (see Installation - Java).
Update INUBIT Workflows
CONDITIONAL - If you use BPC INUBIT Workflows.
For some functionalities, BPC relies on Technical Workflows (TWFs) in INUBIT.
By default, these are located in the INUBIT user group BusinessProcessCenter.
You can install or update these TWFs by importing the corresponding workflow package via the Workbench.
Please use the workflow package BusinessProcessCenter.workflow.inubit.integration.patch.protected.zip from the download area and import it into the INUBIT user group BusinessProcessCenter.
If you need additional workflows for other modules or just a specific part of a workflow, you can also select a different workflow package. The file names—or parts thereof—provide information about the content.
-
Files with
.setup.in their names contain all TWFs for the respective package, while those with.patch.do not contain the hook TWFs (which have “_hook” as a name suffix for diagram groups or workflows).
Therefore, when importing from.patch., the customizations to hook TWFs remain unchanged, but changes or improvements made to the default based on the selected package are retained (such as in the configuration TWFs _BPC_199_BPC_Configuration_, etc.). -
.inubit.integration.contains the workflow packages.IdenityProvider.,.Monitor., and.Documentation.(see the following points) -
.IdenityProvider.is required if INUBIT is to be used as the identity provider for the BPC -
.Monitor.implements functions for the BPC Process Monitor, such as writing data from a TWF to the log, changing the status of a process instance from within the PM, or executing a process action. -
.pm.migration.for the migration of the former Bosch Process Monitor -
.DataManagement.Workflows for the Data Management Module -
.Documentation.implement PDF export of Diagrams in BPC Documentation. Since this package does not contain any hook TWFs, there is no distinction between.setup.and.patch.
Update via INUBIT Installer
If you installed BPC using the INUBIT Installer, you should also use it for the update. Otherwise, you can update the components individually as described on this page.
Download the patch installer and the patch installation guide from the User Portal.
For more information, see the INUBIT Patch Guide.
Run the Patch Installer and follow the Patch Installation Guide
MANDATORY
Follow the steps for your BPC version upgrade as described in the Changelog. As part of this process, run the Patch Installer using the Business Process Center installation set.
If you also want to update INUBIT, you must run the patch installer with the INUBIT installation set—this applies even if INUBIT and BPC are installed on the same system rather than on separate systems.
See also the INUBIT Patch Guide.
Update INUBIT Workflows
MANDATORY
For some functionalities, BPC relies on Technical Workflows (TWFs) in INUBIT. If these are used in your installation, please update them according to the instructions in “Updating BPC Workflows.”