Upgrading and configuring IBM Case Manager

The steps for upgrading IBM® Case Manager are the same for a single-server installation or a distributed installation. To prepare for an upgrade, you must update the IBM Case Manager software and supporting software to a minimum update version level.

Before you begin

For details about the hardware and software requirements, see the IBM Case Manager information in the IBM FileNet® P8 Hardware and Software Requirements guide.

About this task

If you upgrade from V5.1.1, you can install V5.2.1 in a different location on the same server on which IBM Case Manager is currently installed or on a separate server. If you upgrade from V5.2.0, the installation of V5.2.1 upgrades the current installation of V5.2.0. Alternatively, you can install V5.2.1 on a separate server as a fresh installation and remove the V5.2.0 server when the upgrade to V5.2.1 is complete.

To help ensure the integrity of existing solutions, the following changes occur when you upgrade a 5.1.1 solution:
  • The upgrade process adds default pages to the solution. These pages are the same default pages that are created for a new V5.2.1 solution.
  • For existing roles, the upgrade process assigns new Work and Case static pages by default.
  • For existing custom non-static pages, the upgrade process creates the page objects and populates them with the content of the corresponding default page of that page type.
Upgrade and configure the development environment

After the supporting applications and IBM Case Manager V5.2.1 software is installed, you use the IBM Case Manager configuration tool to configure the development environment. You use the tool to create an upgrade profile that contains tasks, where you enter properties for all aspects of your development environment applications and connections.

When you run the configuration tool, you must specify connection information for a new WebSphere® Application Server profile except if you upgrade from V5.2.0 on the existing server. If you upgrade from V5.2.0 on the existing server, the existing WebSphere Application Server profile is used for IBM Case Manager V5.2.1.

For a V5.1.1 development environment, you might want to configure the system to create new design and target object stores instead of reusing the existing object stores. With new object stores, you can upgrade solutions one at a time and validate each one before you migrate it to the production environment. Your V5.2.1 solutions can coexist with your V5.1.1 solutions until you are ready to remove the V5.1.1 system.

If you configure the system to use new object stores, use the IBM Case Manager V5.1.1 administration client to export your V5.1.1 solutions. Use the V5.2.1 administration client or configuration tool to import the solutions to the new design object store. To enable new features, open each solution in Case Manager Builder V5.2.1 and click the Upgrade button when you are prompted to confirm whether you want to upgrade the imported solution to a newer level.

If your 5.1.1 solution includes custom widgets, you must convert the widgets from the V5.1.1 iWidget format to a new IBM Case Manager V5.2.1 widget format. You must also edit the solution configuration settings and customize the page layout, menus, toolbars, and wiring.

For help with converting custom widgets, see the detailed procedures in Creating custom widgets and actions.

You can use the default web application to test the changes that you make in each solution. Before it can be used, you must register and configure the converted 5.1.1 widget in the V5.2.1 environment.

Before you export a solution to the test or production environment, ensure that the solution works correctly in the new client framework.

Upgrade and configure the test or production environment

After the supporting applications and IBM Case Manager V5.2.1 software is installed, you use the IBM Case Manager configuration tool to configure the production environment. You use the tool to create an upgrade profile that contains tasks, where you enter properties for all aspects of your production environment applications and connections.

When you run the configuration tool, you must specify connection information for a new WebSphere Application Server profile except if you upgrade from V5.2.0 on the existing server. If you upgrade from V5.2.0 on the existing server, the existing WebSphere Application Server profile is used for IBM Case Manager V5.2.1.

The first time that you run the configuration tool, you must define at least one target environment. For an existing target object store, the definition of the target environment on V5.2.1 upgrades the underlying target object store to V5.2.1. Later, as you upgrade solutions, you can upgrade individual target environments as needed to support the upgraded solutions.

After you convert and test an upgraded solution in the development environment, you can import it into the staging object store. After you deploy the imported solution, the solution becomes visible through the Case Manager Client and your IBM Case Manager V5.2.1 system is ready to use.

Important: In a production environment where V5.1.1 and V5.2.1 solutions coexist:
  • If you need to deploy or redeploy a V5.1.1 solution, use the V5.1.1 administration client to export the solution and to import the solution into your V5.1.1 production environment. Until the solution is upgraded to V5.2.1, you cannot use the V5.2.1 administration client to import a solution into the production environment.
  • Back up the environment each time you deploy an upgraded solution. Having a backup allows you to roll back the solution if problems occur.

After you deploy a solution in the new environment, you can disable access to the V5.1.1 solution. After all of your solutions are upgraded, you can remove the IBM Case Manager Version 5.1.1 system. You can also disable or remove the WebSphere Application Server profile that the V5.1.1 system was configured to use.