Installing IBM Business Automation Workflow - Process Federation Server V20.0.0.1

• Problems addressed in this upgrade
• Installation instructions
  • Cumulative fix prerequisites
  • Installing the cumulative fix
  • Downloading repositories to the local system
  • Upgrading an installation interactively
  • Upgrading an installation silently using the command line (imcl)
• Rolling back the cumulative fix
  • Rolling back the cumulative fix installation interactively
  • Rolling back the cumulative fix installation silently using the command line (imcl)
• Trademarks and service marks

© Copyright International Business Machines Corporation 2020. 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 the cumulative fix, you will raise the fix level of your Process Federation Server to Version 20.0.0.1.

The fixes addressed in this cumulative fix are explained in the Process Federation Server V20.0.0.1 fix list.

Installation instructions

• Installing the upgrade requires having IBM WebSphere Application Server Liberty Network Deployment V8.5.5 Fix Pack 20.0.0.3 installed with IBM Installation Manager.
  
  Note: Make sure you apply the necessary security fixes:
  • Security Bulletin: WebSphere Application Server and IBM HTTP Server
• To avoid problems, such as certificate issues, ensure you have IBM Installation Manager V1.9.1.2 or later (the minimum level is 1.9.0). You can obtain links to the latest versions from Installation Manager and Packaging Utility download documents.
• If you are federating a BPM 2017.03 CF server or later and you want to use the quick start path, you must re-enable HTTP access by switching Process Federation Server to secure production mode (see Roadmap for configuring Process Federation Server and federated environments). If this is not possible, you must re-enable insecure HTTP access to the REST APIs of the IBM BPM 8.5.7.0 2017.03 CF server by following these steps:

1. Shut down all the servers.
2. Go to the <install_root>/bin directory, run "wsadmin -conntype none -lang jython -profileName <dmgrProfile>". For IBM BPM Express, use the stand-alone server's profile.
3. Enter the following commands on the wsadmin prompt (where 'De1' is the name of your BPM deployment environment):
   
   wsadmin> print AdminTask.configureBPMTransportSecurity( [ '-de', 'De1', '-apps', 'productREST', '-transportSecurity', 'allowhttp'] )
   
   wsadmin> AdminConfig.save()
   
   wsadmin> exit
4. Restart all the servers.

1. Download the cumulative fix repository to a local directory.
2. Choose one of the installation paths based on your environment.

• Upgrading an installation interactively
• Upgrading an installation silently using the command line (imcl)
   

1. Download Liberty fix pack 20.0.0.3-WS-LIBERTY-ND-FP from Fix Central to a disk location of your choice. Note the location where you have downloaded the file.
2. Download pfs.20001.delta.repository.zip to a disk location of your choice. Note the location where you have downloaded the file.

Back to top

Upgrading an installation interactively
These steps upgrade one installation of Process Federation Server.

1. Start the 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: Before you start the Process Federation Server upgrade installation, the IBM Installation Manager must be at a minimum level of Version 1.9.0.

On Windows, right-click IM_INSTALL_LOCATION\IBMIM.exe and select Run as administrator.

On Linux or UNIX, start IBM Installation Manager by using the IM_INSTALL_LOCATION/IBMIM command.

2. Add the repository to the IBM Installation Manager preferences by clicking File > Preferences and, under Repositories, adding the location of the local repository that you downloaded.

Important:

1. Click Add Repository.
2. Type or browse to the pfs.20001.delta.repository.zip file for the Process Federation Server repository that you downloaded and click OK.
3. Click OK to save the new repository settings.

3. Click Update.

4. Select the package group where you installed Process Federation Server and click Next. After Installation Manager checks the service repositories, the Update Packages window opens and the Process Federation Server upgrade is shown.

5. Ensure that the cumulative fix is selected.

6. 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 are selected.

7. 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.

8. Click Update to start the update. The cumulative fix is downloaded from your local repository and installed. When the installation is complete, you receive a confirmation.

9. To upgrade additional Process Federation Server installations, repeat the steps, or return to step 4 to install the cumulative fix by using the same Installation Manager.

10. Before you restart the server the first time, run the server start pfsserver --clean command for each installation that you upgraded.

Note:
You may see error messages about missing underlying Liberty features such as: "CWWKF0042E: A feature definition cannot  be found for the xyz feature. Try running the command, bin/installUtility install xyz, to install the feature."  To solve this issue:

1. Run the following commands:
<liberty_home>/bin/installUtility install jsp-2.3
<liberty_home>/bin/installUtility install jdbc-4.2
<liberty_home>/bin/installUtility install jaxrs-2.1

2. Restart the server with the -clean argument.

Back to top

Upgrading an installation silently using the command line (imcl)
You can use the command-line interface in Installation Manager to update your product installation silently. These steps upgrade one installation of Process Federation Server.

1. Gather the following information about your environment and the cumulative fix 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_DIR
The full path to the installation directory of the product you are upgrading.

REPOSITORY
The full path to the upgrade 20.0.0.3-WS-LIBERTY-ND-FP.zip and pfs.20001.delta.repository.zip that you are applying.

LOG_FILE
A full path and name for a log file to capture the logging output of the command.

FIX_PACKAGE
com.ibm.bpm.pfs.v85 com.ibm.websphere.liberty.ND.v85

2. Using the information gathered in the previous step, run the imcl command from the tools directory under the Installation Manager installation location. For more information, see Installing packages by using imcl commands.

IM_INSTALL_LOCATION/eclipse/tools/imcl install FIX_PACKAGE -acceptLicense -installationDirectory INSTALL_DIR -repositories REPOSITORY -log LOG_FILE

By including the -acceptLicense parameter, you agree to the terms and licenses of this product.

The following command is an example of upgrading Process Federation Server on Windows from Process Federation Server V8.5:

C:\Program Files (x86)\IBM\Installation Manager\eclipse\tools\imcl.exe install com.ibm.websphere.liberty.ND.v85 com.ibm.bpm.pfs.v85 -acceptLicense -installationDirectory C:\IBM\BPM\v8.5 -repositories C:\20.0.0.3-WS-LIBERTY-ND-FP.zip,C:\pfs.20001.delta.repository.zip -log C:\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 message displays on the command line for each package that was installed:

Updated to 20.0.0.3-WS-WLP-IFPH24154_20.0.3.20200422_0622 in the C:\IBM\BPM\v8.5 directory
Updated to com.ibm.bpm.pfs.v85_8.6.20020001.20200612_1651 in the C:\IBM\BPM\v8.5 directory

4. Repeat the process for each installation in the environment.

5. Before you restart the server the first time, run the server start pfsserver --clean command for each installation that you upgraded.

Note:
You may see error messages about missing underlying Liberty features such as: "CWWKF0042E: A feature definition cannot  be found for the xyz feature. Try running the command, bin/installUtility install xyz, to install the feature."  To solve this issue:

1. Run the following commands:
<liberty_home>/bin/installUtility install jsp-2.3
<liberty_home>/bin/installUtility install jdbc-4.2
<liberty_home>/bin/installUtility install jaxrs-2.1

2. Restart the server with the -clean argument.

Back to top

Rolling back the cumulative fix

You can roll back the cumulative fix by using one of the following options: 
Rolling back the cumulative fix installation interactively

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

Note: The following procedure rolls back only the Process Federation Server installation.

Rolling back the upgrade 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.

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.

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. Close Installation Manager. 

10. Repeat the process for each installation in the environment.

11. Before you restart the server the first time, run the server start pfsserver --clean command for each installation that you rolled back.

Back to top

Rolling back the upgrade 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.

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_DIR
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_DIR -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 roll back to the previous target version of a product in the installation.

IM_INSTALL_LOCATION/eclipse/tools/imcl rollback PACKAGE_VERSION_IDS -installationDirectory INSTALL_DIR -log LOG_FILE

To include local repositories for the target version, add the -repositories REPOSITORIES option.

3. When the rollback completes, check the log files to ensure that the rollback completed successfully. A success message displays on the command line:

Rolled back to com.ibm.bpm.pfs.v8.5.7000.20160301_1551 in the C:\IBM\BPM\v8.5 directory. 

4. Repeat the process for each installation in the environment.

5. Before you restart the server the first time, run the server start pfsserver --clean command for each installation that you rolled back.

Back to top

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