Update-Guide

This page describes how to update an existing BPC installation (version 4.2) to a newer patch level (also version 4.2).

Migration to a higher major or minor version

If you are updating to a higher major or minor version, please follow the corresponding migration instructions first.

See also Migration

These instructions are general and describe how you can update individual components of the BPC. Please always refer to Changelog for the respective versions.

If you are using the BPC together with INUBIT, the INUBIT Patch Guide must also be observed. If the BPC was installed via the installer, you should go to the section Update via INUBIT Installer.

For an explanation of the version numbering, see Explanation of versioning.

The following steps are divided into the following categories:

  • RECOMMENDED - This step is not necessary, but recommended.

  • REQUIRED - This step is not necessary for every update, but only if explicitly mentioned in Changelog.

  • OBLIGATORY - This step must be carried out for every update.

Identify necessary steps

OBLIGATORY

To identify all necessary steps for an update, you should check Changelog. In particular, the comments on the "Breaking Changes" must be taken into account. You should check all Changelogs that were provided after the currently installed version.

Backup

EMPFOHLEN

It is recommended that you perform a backup of the entire system. See also Backup & Restore

Update BPC modules

OBLIGATORY

You need the module files that match your installation for the update. The required files can be found at Download - Virtimo Fileserver. There are so-called frontend and backend files. The file names correspond to the pattern bpc-fe-MODULNAME.war (frontend) or bpc-be-MODULNAME.jar (backend). BPC modules consist of at least one of the two files.

You must have at least the Core component (core module) However, it is recommended that you update all existing modules to the latest version.

If you are also using Karaf you should do this first or combine both steps.

  1. Back up your current directory INSTALLATIONSVERZEICHNIS/karaf/deploy.

  2. Copy the new BPC modules to the folder INSTALLATIONSVERZEICHNIS/karaf/deploy.

Update Karaf

BEDINGT - If this is recommended in Changelog.

You will find the required file on the download page.

  1. Stop the Karaf process.

  2. Save the directory INSTALLATIONSVERZEICHNIS/karaf (or the directory to which the link points).

  3. Remove the link INSTALLATIONSVERZEICHNIS/karaf.

  4. Install Karaf as described in the installation instructions described.

  5. If you have made configurations directly in your previous Karaf, transfer these to the new Karaf.

    1. To make future updates easier, you should carry out all Karaf configurations via Central configuration file.

    2. If you still want to change the configuration on the Karaf, the individual configurations should be made directly in the files of the new Karaf. When simply copying the files, they may overwrite other configuration parameters that are necessary or recommended for the operation of the BPC.

  6. Copy the content from the old karaf/deploy directory to the new Karaf.

  7. Update the BPC modules (see Update BPC modules).

  8. If you have previously installed JDBC drivers and have not yet used the central configuration file for this, you must repeat this (see Databases) or update the central configuration file or adapt the central configuration file.

  9. Start the Karaf process.

Update OpenSearch

REQUIRED - If this is recommended in Changelog.

  1. Stop the OpenSearch process.

  2. Save the directory INSTALLATIONSVERZEICHNIS/opensearch_data, this contains the database data and may be adapted by the new OpenSearch version and can then no longer be used with old versions.

  3. Remove the link INSTALLATIONSVERZEICHNIS/opensearch.

  4. Install OpenSearch as described in the Installation instructions described.

  5. If you have made configurations to the old installation, you can transfer these from the backup to the file INSTALLATIONSVERZEICHNIS/opensearch/config/opensearch.yml.

  6. Start the OpenSearch process.

You can skip step 5 if you have swapped out the OpenSearch configuration directory. (E.g. if the configuration is located in INSTALLATIONSVERZEICHNIS/opensearch_config.)

Central configuration file (bpc.env)

If an update of Central configuration file is necessary, you should always make a backup copy of your current file.

For the update, you should update your existing bpc.env file with the latest version (see on the download page). If entries are missing in your bpc.env file, you can usually transfer them directly. If there are deviating entries, you should evaluate them carefully and compare them with the Documentation and the Changelog.

It is recommended to make changed configurations recognizable by comments and possibly to document them directly. This facilitates future updates.

Update OpenSearch-Plugin

REQUIRED - If this is recommended in Changelog.

It is recommended to always update the entire OpenSearch (Update OpenSearch). However, it is also possible to update only the plugin.

The os-bpc-plugin.zip file for the desired target version is required for the update. You can find this on the Download page.

  1. Stop OpenSearch.

  2. Remove the old plugin.

    OPENSEARCH/bin/opensearch-plugin remove os-bpc-plugin
  3. Install the new plugin.

    OPENSEARCH/bin/opensearch-plugin install file:///PFAD/ZUM/PLUGIN/os-bpc-plugin.zip
  4. Start OpenSearch.

Update Java

REQUIRED - If this is recommended in 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 INSTALLATIONSVERZEICHNIS/_jvm).

  1. Remove the link INSTALLATIONSVERZEICHNIS/_jvm.

  2. Install Java again (see Installation - Java).

Update INUBIT workflows

PLEASE - If you use BPC INUBIT workflows.

For some functionalities, the BPC uses 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 user group BusinessProcessCenter of INUBIT.

If you require further workflows for other modules or only a special workflow part, you can also select a different workflow package. The file names or parts thereof provide information about the content.

  • The files with .setup. in the name contain all TWFs of the respective package, while those with .patch. do not contain the hook TWFs (which have "_hook" as a name suffix for the diagram group or workflow).
    Therefore, the adjustments to hook TWFs are not changed when importing .patch., but changes/improvements made to the standard are, depending on the package selected (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 necessary if INUBIT is to be used as an identity provider for the BPC

  • .Monitor. implements functions for the BPC Process Monitor, e.g. transferring data from a TWF to the log. For example, writing data from a TWF to the log, changing the status of a process instance from 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 the PDF export of Diagrams in BPC Documentation. As this package does not contain any hook TWFs, there is no division into .setup. and .patch.

Update via INUBIT Installer

If you have installed the BPC using the INUBIT Installer, you should also use this for the update. Otherwise, you can also update the components individually as described on this page.

Download the Patch Installer and the Patch Installation Guide from the User Portal.

Further information can be found at INUBIT Patch Guide.

The Patch Installer creates most BPC modules in your installation directory. You can find further BPC modules in the Downloads.

Go through the patch installer and patch installation guide

OBLIGATORY

Go through the steps for your version jump with regard to BPC at Changelog. In the course of this, run the patch installer with 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 also applies if INUBIT and BPC are not installed on separate systems but on the same system.

See also INUBIT Patch Guide.

Update INUBIT workflows

OBLIGATORY

For some functionalities, the BPC uses technical workflows (TWFs) in INUBIT. If these are used in your installation, please update them according to the instructions Updating the BPC workflows.


Keywords: