Upgrading your IBM Case Manager system by using the embedded IBM Content Navigator

Edit online

Traditional:
This approach can be used only for non-production environments. It augments IBM Case Manager with IBM Business Automation Workflow and uses the IBM Content Navigator embedded in Business Automation Workflow.

Before you begin

If you haven't done so already, review the requirements and support considerations in Preparing for the upgrade. For download and upgrade instructions, see the support document Upgrading IBM Case Manager to IBM Business Automation Workflow V21.0.3. For answers to upgrade questions, see Frequently asked questions.

About this task

This upgrade requires IBM Case Manager and a new installation of Business Automation Workflow on a new WebSphere® Application Server installation.

Figure 1. Topology before and after augmentation

During the upgrade process, you will

Back up your source databases.
Update your IBM Content Navigator and Content Platform Engine.
If you haven't already, install and configure Business Automation Workflow.
Configure Business Automation Workflow to use your Content Platform Engine.
Run the case configuration tasks.
Update custom extension packages and custom case widgets if you are using them.
Restart the deployment environment.

Procedure

Back up your IBM Case Manager databases, including the databases for the IBM Content Navigator, the design object store, and the target object store. For example, ICNDB, DOSDB, and TOSDB.
Update your IBM Content Navigator and Content Platform Engine to the version supported by Business Automation Workflow.
See IBM Business Automation Workflow detailed system requirements. For instructions, see Upgrading IBM Content Navigator and Upgrading Content Platform Engine.
Optional: If you already installed Business Automation Workflow and created a deployment environment, make sure that you configure IBM Content Navigator to reuse your previous IBM Content Navigator database.
1. Start the deployment manager and nodes.
2. Log in to the WebSphere Application Server administrative console.
  The URL is http://hostname:port1/admin or https://hostname:port2/admin.
3. Click Resources > JDBC > data sources . Click the IBM BPM Content Navigator ECM client data source.
  In the Common and required data source properties table, change the following properties:
  - Server name: The hostname of the computer where your previous IBM Content Navigator is located.
  - Database name: The name of your previous IBM Content Navigator database.
  - Port number: The port that is used for the database.
  Save your changes.
4. Make the same changes as in the previous substep for the IBM BPM Content Navigator task manager data source.
Optional: If you did not yet install Business Automation Workflow, install it.
1. Choose a sample properties file from the Workflow_install_root\BPM\samples\config\externalcpe directory, based on your database and the type of deployment environment you want.
  For a development environment, choose a properties file with bpm.de.environment=Process Center. These files do not contain the Content Platform Engine configuration. You must configure the newly installed Business Automation Workflow to reuse your previous Content Platform Engine configuration.
2. Modify the properties file by using your real environment values.
  Pay special attention to the following properties and make sure that they are configured correctly:
  - To use the embedded IBM Content Navigator and the external Content Platform Engine, make sure that you set the following properties as shown:
```
bpm.de.deferSchemaCreation=true
bpm.de.useExternalNavigator=false
bpm.de.useExternalCPE=true
```
  - To configure your previous IBM Content Navigator database to work with the embedded IBM Content Navigator, set the value of bpm.de.db.number.hostname to the hostname of the previous IBM Content Navigator server. Set the value of bpm.de.db.number.schema to the schema of the previous IBM Content Navigator database. Set the value of bpm.de.db.number.tsicn to the table space name of the previous IBM Content Navigator database. Set the type and port number based on the database that you are intending to use.
```
bpm.de.db.number.type=database_type
bpm.de.db.number.hostname=host_name
bpm.de.db.number.portNumber=port_number
bpm.de.db.number.databaseName=ICNDB_name
bpm.de.db.number.schema=ICNDB_schema
bpm.de.db.number.tsicn=ICNDB_tablespace
```
  - Set the ECMTechnicalUserAlias as the user from the LDAP shared user repository that will be used as the administrator for the object store, for example:
```
###########################################
# ECM technical user authentication alias #
###########################################
bpm.de.authenticationAlias.number.name=ECMTechnicalUserAlias
bpm.de.authenticationAlias.number.user=user from LDAP shared user repository
bpm.de.authenticationAlias.number.password=password of the user
```
3. Create the Business Automation Workflow deployment environment by using the BPMConfig command-line utility.
  Follow the instructions for your database type under the following link:
  - Configuring profiles and creating a network deployment environment on Linux
  - Configuring profiles and creating a network deployment environment on Windows
4. After you create the deployment environment, before you try to start it, run the BPMConfig -create command to generate the SQL scripts that create the schemas and tables for the applications. Then, run the scripts, except for the scripts for the databases for IBM Content Navigator and Content Platform Engine (usually called CPEDB, or ICNDB, DOSDB, and TOSDB).
  See the BPMConfig command-line utility for instructions.
5. Run the bootstrapProcessServerData command to load the configuration data into the database.
  Follow the instructions for your environment:
  - Loading the database with system information in a network deployment environment on AIX or Linux
  - Loading the database with system information in a network deployment environment on Windows
6. Start the environment and run a deployment environment health check.
  Follow the instructions in Starting your environment and Verifying the status of your environment using the Health Center.
Configure Business Automation Workflow to use your previous Content Platform Engine, namely the same environment that IBM Case Manager uses for the design object store (DOS) and target object store (TOS). Follow the instructions in Configuring an existing external Content Platform Engine.
For considerations on object store configuration, see Planning for an external Content Platform Engine.
Configure properties for Lightweight Directory Access Protocol (LDAP) so that the same configuration is used by both Business Automation Workflow and FileNet Content Manager.
For example, the user and group name attributes:
- Business Automation Workflow - user-full-name-prop and group-name-prop
- Content Platform Engine - userShortNameAttribute and GroupNameAttribute
For more information, see Configuring the user registry and Directory service providers.
Run the Case configuration tool to deploy the case plug-ins onto the IBM Content Navigator server.
For information about the Case configuration tool, see the topic for your environment:
- Workflow Center: Running the development environment case configuration tasks
- Workflow Server: Running the production environment configuration tasks
Important:
- For the Edit Profile Properties task, on the second panel, enter the values that you used for the embedded IBM Content Navigator. However, for the IBM Content Navigator administrator username and password, you must enter the values for the previous IBM Content Navigator. Otherwise, you cannot test the connection successfully.
- For the Configure Business Rules task, specify the same path that you used in IBM Case Manager.
- Make sure that the Network Shared Directory property value in the Edit Development Environment Profile Properties wizard is the same as the one that you set in the Business Automation Workflow properties file. If you want to change this network shared directory value, then after you change the value in the wizard, you must also rerun the BPMConfig command, for example:
```
BPMConfig  -update -profile DmgrProfile -de De1 -networkDirectory new network directory -component CaseManager
```
- If you previously configured IBM Content Navigator or Content Platform Engine related plug-ins (such as the Content Platform Engine Applets Support plug-in), you must run the related task in the configuration tool (such as Register the IBM Content Platform Engine Applets Support plug-in) to redeploy the plug-ins using the new path to the network shared directory. If the mapped tasks are disabled, enable and run them.
1. Optional: If you are using custom extension packages, update them.
  In the Case configuration tool, run the Deploy & Register Extensions Package task to deploy the custom extension package plug-in to the IBM Content Navigator.
  1. Right-click the task and select Enable Task.
  2. Enter and check the properties.
  3. Run the task.
2. Optional: If you are using case custom widgets that refer to IBM Case Manager resources, you must update the implementation code because, after augmentation, the resources are located on the remote Business Automation Workflow computer instead of the IBM Case Manager computer.
  In the Case configuration tool, run the Deploy & Register Custom Widgets Package task to deploy the Case custom widget plug-in to the IBM Content Navigator.
  1. Right-click the task and select Enable Task.
  2. Enter and check the properties.
  3. Run the task.
  For troubleshooting information, see Troubleshooting system upgrades.
To avoid encountering problems when you deploy your case management solutions in Business Automation Workflow, make sure the following files are present in the Content Platform Engine directory:
1. Copy the ODMMessages.jar file from the Business Automation Workflow home directory <install_root>/lib/ext to the external Content Platform Engine directory at <WAS-home>/lib/ext.
  The ODMMessages.jar is required for the embedded IBM Operational Decision Manager rules SDK.
2. Copy the ejb-lookup.jar file from the Business Automation Workflow directory <install_root>/CaseManagement/configure/deploy to the Content Platform Engine directory at <WAS-home>/lib/ext.
3. Restart the external Content Platform Engine for changes to take effect.
Restart the Business Automation Workflow deployment environment.
To avoid accidentally editing solutions in the previous version of Case Builder or logging in to the previous version of the navigator after the upgrade, remove the previous CaseBuilder and navigator apps.
1. In the WebSphere administrative console for IBM Case Manager (https://case_computer:9043/ibm/console) go to Applications > All Applications.
  - Select CaseBuilder and click Remove.
  - Select navigator and click Remove.
2. Save the changes to the WebSphere Application Server configuration, and restart the WebSphere Application Server profile.

Results

You must reconfigure other systems that rely on IBM Content Navigator.

The following image shows a typical topology by using the embedded IBM Content Navigator.

Diagram that shows a typical topology to support the IBM Content Navigator embedded in Business Automation Workflow .

The Case Navigator plug-ins are available through the following URLs:

Workflow Task: https://Workflow_hostName:SSL_port/teamworks/navigator-plugins/workflow-icn-plugin.jar
Case Client: https://Workflow_hostName:SSL_port/ICMClient/ICMClient.jar
Case API: https://Workflow_hostName:SSL_port/ICMClient/ICMAPIPlugin.jar
Case Administration: https://Workflow_hostName:SSL_port/ICMClient/ICMAdminClientPlugin.jar
Case Monitor Dashboard: https://Workflow_hostName:SSL_port/ICMClient/ICMMonitor.jar

Note: The ICMClient context is the default context. If you changed the ICMClient context, you must specify this custom context instead of the default context.

Tip: The Content Engine Applet support plug-in (CPEAppletsPlugin.jar) can be directly loaded from the Content Engine.

What to do next

If you encounter case management problems after you install or upgrade to IBM Business Automation Workflow, see Troubleshooting system upgrades.

After a successful upgrade, you can promote your case solutions to workflow projects, which you can easily manage in Business Automation Workflow. See Upgrading or creating case solutions.