IBM Support

Installing IBM Business Automation Workflow Version 21.0.3

Fix Readme


Abstract

This document provides instructions for installing IBM Business Automation Workflow Version 21.0.3 to upgrade IBM Business Process Manager (BPM) or an earlier version of IBM Business Automation Workflow. Use the same instructions to update IBM Workflow Center (previously IBM Process Center) and IBM Workflow Server (previously IBM Process Server).

Content

The following tabs primarily provide information about IBM Business Automation Workflow V21.0.3. However, the Upgrading IBM Case Manager tab provides information about upgrading IBM Case Manager to IBM Business Automation Workflow V21.0.3.

This cumulative fix is a cumulative maintenance package that applies to all distributed operating systems. It is a single package that bundles a number of individual fixes. The cumulative fix is to be used on IBM Business Automation Workflow V18.0.0.x, V19.0.0.x, V20.0.0.x, V20.0.0.2, or V21.0.2, IBM Business Process Manager Server V8.6.x, or on IBM Business Process Manager Standard, IBM Business Process Manager Advanced, or IBM Business Process Manager Advanced - Process Server Version V8.5.x. To upgrade Process Federation Server, see Downloading IBM Business Automation Workflow - Process Federation Server V21.0.3.

Table of Contents

© Copyright International Business Machines Corporation 2021. All rights reserved. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Problems addressed in this upgrade

By installing this upgrade, you will raise the fix level of your product to Version 21.0.3. The fixes addressed in this upgrade are explained in the Fix list for IBM Business Automation Workflow.

Installation instructions

Upgrade prerequisites

To install this upgrade, you must have Version 8.5.0.0, V8.5.0.1, V8.5.0.2, V8.5.5.0, V8.5.6.0, V8.5.6.0 CF01, V8.5.6.0 CF02, V8.5.7.0, V8.5.7 CF2016.06, V8.5.7 CF2016.09, V8.5.7 CF2016.12, V8.5.7 CF2017.03, V8.5.7 2017.06, V8.6, V8.6 2017.12, or V86. 2018.03 of IBM Business Process Manager Server, IBM Business Process Manager Standard, IBM Business Process Manager Advanced, or IBM Business Process Manager Advanced - Process Server or Version 18.0.0.1, V18.0.0.2, V19.0.0.1, V19.0.0.2, V19.0.0.3, V20.0.0.x, or V21.0.2 of IBM Business Automation Workflow installed.

Restrictions:

  • Case management is supported only when Federated Repositories is used as the user registry.
  • IBM Business Process Manager Express V8.5.x and IBM Business Process Manager Server Express V8.6.x support only migration, not upgrading. See Migrating and upgrading in the documentation.

Important:
  • If you are on a UNIX or Linux system, make sure that you check the ulimit setting. See Preparing Linux systems for installation or Preparing AIX systems for installation.
  • To avoid problems such as certificate issues, ensure that you have IBM Installation Manager V1.9.1.2 (the minimum level required is V1.9.0). You can obtain links to the latest versions from Installation Manager and Packaging Utility download documents.
  • Hardware and software prerequisites for IBM Business Automation Workflow are available on the detailed system requirements pages.

    Installing the upgrade

    To install the upgrade, follow these instructions to download the fix pack repositories, choose your installation path, and review the post-upgrade tasks.

    1. Download the fix pack repository to a local directory. For more information, see Downloading the repositories to the local system. If you are installing the fix pack interactively by using IBM Installation Manager to connect to the live repository, this step is not required.
    2. Choose one of the installation paths based on your environment.
      1. If you have an existing deployment environment, follow the instructions based on your current version.
        Note: To continually run production applications during the upgrade and regression test period, you can roll out maintenance incrementally in an installation that consists of a Process Center and multiple Process Servers. See Performing a rolling upgrade in the product documentation. Also, see Testing the IBM Business Automation Workflow upgrade for methods to find potential upgrade problems.
      2. If you are installing Business Automation Workflow V21.0.3 in a new environment, see Installing and configuring IBM Business Automation Workflow.
        Note: If you are using the launchpad to install and you have Internet access, you must include the cumulative fix from the live repository during installation. When you start the launchpad, you are also prompted to update the launchpad. Click Update.
        Otherwise, if you do not have Internet access, you must install the cumulative fix and the launchpad update (if you want to use the launchpad) from local directories.
        1. From http://public.dhe.ibm.com/software/websphere/bpm/repositories/server/launchpad/2000/, download both files for the launchpad interim fix and put them into a directory on your local system.
        2. Create the following file:
        On Windows:  C:/users/user_name/bpm_updates.properties
        On Linux or UNIX:  /user_home_directory/bpm_updates.properties
        3. In the bpm_updates.properties file, add text to point to the location of the cumulative fix and the launchpad interim fix in your local system, for example:
        launchpad.1=interim_fix_location
        fixpack.BPM_CF=local_repository_path
        For more information about installing upgrades from a local directory, see step 1 of Installing and configuring Workflow Center in the product documentation.
      3. If you installed IBM BPM V8.5.0.x, V8.5.5, V8.5.6.x, V8.5.7.x, V8.6.x or IBM Business Automation Workflow V18.0.0.x, V19.0.0.x, V20.0.0.x or V21.0.2, but you have not yet created a deployment environment, choose one of the following options to update the product:
    3. Review the optional post-upgrade task information for additional actions you might need to take.

    Your installations are now IBM Business Automation Workflow V21.0.3 . You will see "8.6.3.21030" in the versionInfo command output, the SystemOut.log header, and the administrative console Welcome screen. For information about determining the installed version, see Product version and history information.

    Downloading the repositories to the local system

    Download the upgrade repositories to a local directory so that they can be used with Installation Manager during the upgrade process.

    Notes:

    • If you are installing interactively by using Installation Manager to make the updates and you have Internet access, you do not need to download the required WebSphere Application Server fix pack and IBM Business Automation Workflow cumulative fix from Fix Central.
    • New installations require the IBM Business Automation Workflow installation media, as noted in the IBM Business Automation Workflow product documentation.
    1. Download the cumulative fix repository by following the Downloading document. Download workflow.2103.delta.repository.zip to a temporary disk location.
    2. You must have WebSphere Application Server V8.5.5 Fix Pack 20 or a later fixpack installed or you must install it during the upgrade process. To upgrade the WebSphere Application Server fix pack, download the applicable version for your environment. For example, download 8.5.5-WS-WAS-FP020-part1.zip, 8.5.5-WS-WAS-FP020-part2.zip, and 8.5.5-WS-WAS-FP020-part3.zip for WebSphere Application Server V8.5.5.20. Ensure that all the files are extracted to the same root directory; for example, staging_directory\WAS85520. For information about the fixes and download links, see Fix list for IBM WebSphere Application Server V8.5.
    3. Install the latest security fixes for WebSphere Application Server V8.5.5.20. See WebSphere Application Server and IBM HTTP Server Security Bulletin List.
    4. Download any required interim fixes from IBM Fix Central that are specific to Business Automation Workflow V21.0.3. Select your installation type and 21.0.3 to search for recommended fixes on this site. Download all recommended fixes.
      Important: Download and apply mandatory fix JR64797 so that the System Data & Content Integration toolkit is updated.
    5. Extract each set of cumulative fix or interim fix repository zip files to its own local directory, although a common staging directory can be used. For example, staging_directory\BAWCF, staging_directory\WAS, or staging_directory\IFix1.
      Note: If a repository consists of multiple .zip files, ensure that they are all extracted to the same root directory. For example, extract the three 8.5.5-WS-WAS-FP0xx files to staging_directory\WAS855xx. Because the cumulative fix consists of a single .zip file, you can point Installation Manager directly to the .zip file without extracting it.
    6. Return to the installation instructions and continue with the appropriate steps based on your existing setup.

    Upgrading an installation interactively

    These steps upgrade one installation. If you have an existing deployment environment, follow the profile upgrade steps first. Ensure that these steps are followed only after you are directed here by the profile upgrade steps.

    Note: If you are upgrading from V8.5.x and still using Java 6, you cannot select all repositories including IBM WebSphere Application Server and IBM Business Automation Workflow to upgrade. You must upgrade in the following sequence:
    a) Upgrade IBM WebSphere Application Server.
    b) Upgrade IBM Business Automation Workflow.

    1. Start IBM Installation Manager. For more information about where Installation Manager is installed and the type of installation, see Installation directories for the product and profiles.
      Note: Installation Manager must be at a minimum level of Version 1.9.0 before you start the upgrade. Installation Manager detects an available update if you are connected to the Internet on the workstation where you plan to upgrade.
      • On Windows, right-click IM_INSTALL_LOCATION\IBMIM.exe and select Run as administrator.
      • On Linux or UNIX, start Installation Manager using the IM_INSTALL_LOCATION/IBMIM command.
    2. Add the repositories to the Installation Manager preferences. Click File > Preferences. Under Repositories, select one of the following options:
      • If you have Internet access, ensure that the Search service repositories during installation and updates option is selected.
      • If you do not have Internet access, add the location of the local repositories that you downloaded in the Downloading the repositories to the local system section.
        1. Click Add Repository.
        2. Type or browse to the repository.config file for the repository that you extracted and click OK. If the fix consists of a single .zip file, you can just point to the .zip file.
        3. Repeat steps 1 and 2 for all new repositories that you downloaded.
        4. Click OK to save the new repository settings.
    3. Click Update. Select the package group where you previously installed IBM BPM or Business Automation Workflow and click Next.
    4. After Installation Manager checks the service repositories, the Update Packages window opens and IBM Business Automation Workflow V21.0.3 is shown, unless there is a later fix available from the live update repository. If you are also installing WebSphere Application Server V8.5.5 Fix Pack 20 or a later fix pack, it is also shown.
    5. Ensure that these repositories are all selected. Clear the Show recommended only check box to make sure that you can see all the added fixes. Click Next. If you have Internet connectivity or have added local repositories, another Update Packages window opens. A list of interim fixes is displayed.
    6. Ensure that the interim fixes are all selected and then click Next.
      Note: Applying this upgrade will remove any previously installed interim fixes. If a fix is included in the upgrade, then you do not have to reinstall the interim fix.
    7. Read and accept the terms of the license agreements by selecting the appropriate button and click Next. The Features window opens. All the installed features will be selected.
    8. Click Next.
    9. Click Next. All the features that need to be updated are shown in the Summary window. The disk space that is required to perform the update is shown at the bottom.
    10. Click Update to start the update. The updates are downloaded either from the live update repository or from your local repository. The updates are installed. After the installation of the updates is complete, you receive a confirmation.
    11. If you included a WebSphere Application Server fix in the upgrade, and you have Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy files installed, they might have been overwritten. If so, reinstall the policy files before continuing. Otherwise, secure connections might fail if, for example, they rely on certain minimum key lengths.
    12. If you have an existing deployment environment, follow the links below to return to the profile upgrade instructions to continue upgrading your profiles. If you want to upgrade additional installations, repeat the steps, or return to step 4 for installations using the same Installation Manager.

    Upgrading an installation silently using the command line (imcl)

    Installation Manager offers a command-line interface to update your product installation silently. These steps upgrade one installation of IBM Business Process Manager. If you have an existing deployment environment, ensure that these steps are followed only after you are directed here by the profile upgrade steps.

    Note: These instructions assume you are using Java 7 or 8. If you are still using Java 6, you cannot select all repositories including IBM WebSphere Application Server and IBM Business Automation Workflow to upgrade. You must upgrade in the following sequence:
    a) Upgrade IBM WebSphere Application Server.
    b) Upgrade IBM Business Automation Workflow.

    1. Gather the following information about your environment and the fixes you want to apply.
      • IM_INSTALL_LOCATION 
        The location where Installation Manager is installed. See table 7 in Installation directories for the product and profiles for more information about Installation Manager default installation directories.
      • INSTALL_ROOT
        The full path to the installation directory of the product you are upgrading.
      • REPOSITORIES
        The full directory path to the unpacked repositories associated with each fix package that you are applying. The directories are the local staging directories that you used at the end of the Downloading the repositories to the local system steps. If you are installing fixes from multiple repositories, include each directory path and separate them with commas. For example:
        C:\BPMFixStaging\BPMfixpack,C:\BPMFixStaging\WASfixpack,C:\BPMFixStaging\IFix1
      • LOG_FILE
        A full path and name for a log file to capture the logging output of the command.
      • FIX_PACKAGES
        A list of the package associated with Business Automation Workflow V21.0.3 and any refresh pack, fix pack, cumulative fix, or interim fix that you are applying. If you are applying multiple fixes, separate them with spaces. For interim fix package IDs, check the readme file for the fix ID. Alternatively, you can run the listAvailablePackages command on a repository to see the fixes that it includes. You will need the currently installed package ID and version, as described in the next paragraph. For information about the command, see Listing available packages by using imcl commands. For a refresh pack, fix pack, or cumulative fix, the package ID depends on the package ID of the product that is already installed. If you are unsure of the exact packages that you have installed, you can use the following command to list the current products associated with a particular installation: 
        On Windows: install_root\bin\versionInfo
        On Linux: install_root/bin/versionInfo.sh
        This command lists all products associated with the installation and includes a package output for each. The package line has the package ID followed by an underscore and the version ID. The following table shows the package ID for products that could be installed:
        Product being updated Package ID
        IBM Business Automation Workflow Enterprise or IBM Business Process Manager Server or IBM Business Process Manager Advanced com.ibm.bpm.ADV.v85
        IBM Business Automation Workflow Express com.ibm.bpm.EXP.v85
        IBM Business Process Manager Advanced - Process Server com.ibm.bpm.PS.v85
        IBM Business Process Manager Standard com.ibm.bpm.STD.v85
        WebSphere Application Server com.ibm.websphere.ND.v85 (or com.ibm.websphere.ND.le.v85 for Little Endian systems)
        Java com.ibm.websphere.IBMJAVA.v80
    2. Using the information gathered in the previous step, run the imcl command from the tools directory under the Installation Manager installation location:
      IM_INSTALL_LOCATION/eclipse/tools/imcl install FIX_PACKAGES -acceptLicense -installationDirectory INSTALL_ROOT -repositories REPOSITORY -log LOG_FILE
      For more information, see Installing packages by using imcl commands.
      By including the -acceptLicense parameter, you agree to the terms and licenses of this product.
      For IBM BPM upgrades, you must add one of these features to the package ID:
      WorkflowEnterprise.NonProduction - For test, staging, or development
      WorkflowEnterprise.Production - For production or Workflow Center
      The following command is an example of upgrading IBM BPM Advanced on Windows:
      imcl.exe install com.ibm.websphere.ND.v85 com.ibm.bpm.ADV.v85,WorkflowEnterprise.Production -acceptLicense -installationDirectory "C:\IBM\WebSphere\AppServer" -repositories C:\workflow\was85520.zip,C:\workflow\workflow.2103.delta.repository.zip -log silent_update.txt
    3. When the silent installation completes, check the log files to ensure that the installation completed successfully. A success message that is similar to the following text displays on the command line for each package that was installed:
      Updated to com.ibm.websphere.ND.v85_8.5.5020.20210708_1826 in the C:\IBM\WebSphere\AppServer directory.
      Updated to com.ibm.bpm.ADV.v85_8.6.20021020.20210611_1955 in the C:\IBM\WebSphere\AppServer directory.
    4. If you included a WebSphere Application Server fix in the upgrade, and you have Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy files installed, they might have been overwritten. If so, reinstall the policy files before continuing. Otherwise, secure connections might fail if, for example, they rely on certain minimum key lengths.
    5. Repeat the process for each installation in the environment. When you are finished, if you have an existing deployment environment, continue following the profile upgrade instructions.

    Installing the latest version of the User Management Service (UMS)

    Install the latest version of UMS as described in the topic Installing the User Management Service.

    Rolling back the upgrade

    You can roll back the upgrade by using one of the following options:
    Rolling back the installation interactively
    Rolling back the installation silently using the command line (imcl)

    Note: The following procedure rolls back only the V21.0.3 installation. If you have existing profiles, follow the instructions for the version you were upgrading from.

    New profiles created after the upgrade cannot be reused; you must delete and re-create the profiles after you complete the rollback process. See Removing a managed node profile from a deployment environment for more information.

    Rolling back the installation interactively

    1. Close all programs that were installed by using Installation Manager.
    2. Start Installation Manager. For information about where Installation Manager is installed, see Installation directories for the product and profiles.
    3. From the Start page of the Installation Manager, click Roll back to start the Roll back packages wizard.
    4. On the Roll Back Packages page, from the Package Group Name list, select the package group that contains the packages that you want to roll back and click Next.
      Important: On Linux, to avoid problems, do not roll back all packages at once. Roll back IBM Business Automation Workflow, followed by IBM WebSphere Application Server.
    5. Select the version of the package that you want to roll back to and click Next.
    6. Read the summary information and click Roll Back to roll back the package. When the rollback process completes, a message that confirms the success of the process is displayed near the top of the page.
    7. Optional: Click View log file to open the log file for the current session in a new window.
    8. Click Finish to close the wizard.
    9. If you are rolling back the environment (profiles and database), reinstall all the previous interim fixes for IBM Business Process Manager and IBM WebSphere Application Server. You must reinstall all the interim fixes that you previously had installed before you upgraded and then rolled back.
    10. Close Installation Manager.
    11. If you have existing profiles, continue with the profile rollback steps for your existing environment.

    Warnings displayed during the rollback process

    You might see warnings similar to the following warning in the Installation Manager rollback log
    (install_root/logs/wbi/uninstall/uninstallconfig_server.log):
    <message>/opt/IBM/WebSphere/AppServer/properties/version/nif/config.wbi/uninstall.ngi/99SRunISCDeploy.ant:33: exec returned: 127 at org.apache.tools.ant.taskdefs.ExecTask.runExecute(ExecTask.java:591) at org.apache.tools.ant.taskdefs.ExecTask.runExec(ExecTask.java:617) at org.apache.tools.ant.taskdefs.ExecTask.execute(ExecTask.java:452)
    You can fix them by running the following command:

    • On Windows: install_root\bin\iscdeploy -restore
    • On Linux or UNIX: install_root/bin/iscdeploy -restore

    Rolling back the installation silently using the command line (imcl)

    Installation Manager offers a command-line interface to silently roll back your product installation to the previous version. In the instructions, it is assumed that you completed all the necessary backup tasks before you upgraded. The instructions are described in

    The previous profile is restored after you complete the rollback task.
    1. Gather the following information about your environment and the target version you want to roll back to.
      • IM_INSTALL_LOCATION 
        The location where Installation Manager is installed. See table 7 in Installation directories for the product and profiles for more information about Installation Manager default installation directories.
      • INSTALL_ROOT
        The full path to the installation directory of the product that you upgraded.
      • LOG_FILE
        A full path and name for a log file to capture the logging output of the command.
      • PACKAGE_VERSION_IDS
        The package and version IDs for the target version you want to roll back to. You will need the package ID followed by an underscore and the specific version ID. If you are rolling back multiple packages in the installation, separate each package and version ID with a space. If you supply only the package ID, the package is rolled back to the most recent previous version. To find the IDs of the packages you can roll back to, run this command:
        IM_INSTALL_LOCATION/tools/imcl listInstalledPackages -rollbackVersions -installationDirectory INSTALL_ROOT -log LOG_FILE
      • REPOSITORIES
        Optionally, you might need to supply the fix repositories for the target of the rollback if you did not use the option to save files for rollback and do not have access to the live repository. Download and unpack the fix repositories for the target version. Gather the full directory path to your unpacked repositories associated with each fix package that you are applying. If you are rolling back multiple products, separate the repository directory paths with commas.
    2. Using the information gathered in the previous step, run the imcl command to rollback to the previous target version of a product in the installation. If you have existing profiles, be sure that you have stopped the servers as specified in
    3. If you need to include local repositories for the target version, add the -repositories REPOSITORIES option.
      Important: On Linux, to avoid problems, do not roll back all packages at once. Roll back IBM BPM, followed by IBM WebSphere Application Server.
      When the rollback completes, a success message similar to the following message displays on the command line:
      Rolled back to com.ibm.bpm.ADV.v85_8.5.7000.20160301_1551 in the opt/IBM/BPM/v8.5 directory.
    4. Check the log files to ensure that the rollback completed successfully.
    5. If you are rolling back the environment (profiles and database), reinstall all the previous interim fixes for IBM Business Process Manager and IBM WebSphere Application Server. You must reinstall all the interim fixes that you previously had installed before you upgraded and then rolled back.
    6. Repeat the process for each installation in the environment. Once you are finished, continue with the profile rollback step for existing environments.

    Rolling back IBM Process Designer

    IBM BPM does not support rolling back the desktop IBM Process Designer using Installation Manager. Instead, complete the following steps to roll back the desktop Process Designer.

    1. After rolling back your Workflow Center to a previous version, use Installation Manager to uninstall the desktop Process Designer.
    2. Delete the directory in which Process Designer was installed.
    3. Reinstall Process Designer with a new zip file that is downloaded from Workflow Center or Process Center. For instructions, see Installing the desktop IBM Process Designer.

    Reference

    You can find additional information about any of these topics in the IBM Business Automation Workflow product documentation.

    For further information about the update strategy or obtaining updates, see the support page for your product.

    IBM Business Automation Workflow Support page Trademarks and service marks

    For trademark attribution, visit the IBM Terms of Use Web site.

[{"Type":"MASTER","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS8JB4","label":"IBM Business Automation Workflow"},"ARM Category":[{"code":"a8m50000000CcaaAAC","label":"Install and Deployment Environments"}],"ARM Case Number":"","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"21.0.3"},{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSFTN5","label":"IBM Business Process Manager Advanced"},"ARM Category":[{"code":"a8m50000000CcaaAAC","label":"Install and Deployment Environments"}],"Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"8.5.0;8.5.5;8.5.6;8.5.7","Line of Business":{"code":"LOB45","label":"Automation"}},{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSFTDH","label":"IBM Business Process Manager Standard"},"ARM Category":[{"code":"a8m50000000CcaaAAC","label":"Install and Deployment Environments"}],"Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"8.5.0;8.5.5;8.5.6;8.5.7","Line of Business":{"code":"LOB45","label":"Automation"}},{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSFPJS","label":"IBM Business Process Manager"},"ARM Category":[{"code":"a8m50000000CcaaAAC","label":"Install and Deployment Environments"}],"Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"8.6.0","Line of Business":{"code":"LOB45","label":"Automation"}}]

Product Synonym

IBM BPM, IBM Case Manager

Document Information

Modified date:
14 September 2022

UID

ibm16507343