Upgrading your IBM Case
Manager system
using an external IBM Content
Navigator
This approach is the only approach for production environments. It is the recommended
approach for all environments, because it augments IBM Case
Manager with IBM Business Automation
Workflow while keeping the IBM Case
Manager environment as it is. It uses an
external IBM Content
Navigator that can be
shared by other IBM products.
Before you begin
Ensure you are running IBM Case
Manager
V5.3.3.
Ensure you are running IBM Business Automation
WorkflowV19.0.0.3. If you are running IBM Business Process
Manager or an earlier version of IBM Business Automation
Workflow, you must upgrade first. See Upgrading to IBM Business Automation Workflow.
Ensure all participant computers have a host name with a domain name suffix, for example,
my_computer.my_domain_name.com.
About this task
This upgrade requires IBM Case
Manager and a
new installation of Business Automation Workflow on a separate
server.
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.
Configure Business Automation Workflow to use your
IBM Content
Navigator.
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.
Optional:
If you have already installed Business Automation Workflow and
created a deployment environment, skip this step. Otherwise, install Business Automation Workflow and configure the Business Automation Workflow deployment environment with no IBM Content
Navigator or Content Platform Engine feature enabled.
Choose a sample properties file from the
Workflow_install_root\BPM\samples\config\externalicnexternalcpe
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. For a production environment, choose a file with
bpm.de.environment=Process Server. These files do not contain the IBM Content
Navigator or Content Platform Engine database configurations.
Modify the properties file using your real environment values.
Pay special attention to the following properties and make sure that they are configured correctly:
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.2.name=ECMTechnicalUserAlias
bpm.de.authenticationAlias.2.user=admin
bpm.de.authenticationAlias.2.password=admin
Modify the network shared directory that will be used by the external IBM Content
Navigator, for
example:
# The network directory shared among multiple process servers in the deployment environment.
bpm.de.caseManager.networkSharedDirectory=${WAS_INSTALL_ROOT}/CaseManagement/properties
Important: Make sure that the Business Automation Workflow server is available before you restart the IBM Content
Navigator environment.
Run the Business Automation Workflow Case configuration tool to
deploy the case plug-ins onto the IBM Content
Navigator server.
For information about the Case configuration tool, which is located under
Workflow_install_root/CaseManagement/configure/, see the
topic for your environment:
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:
Optional: If you are using custom extension packages, update them.
Update the previous case resource path with the absolute path for the IBM Content
Navigator in the
Extension.json file. For example, use
https://ICN_hostName:ICN_portNumber/navigator/plugin
instead of /navigator/plugin.
Enable cross-origin resource sharing (CORS) settings for this custom extension package, for
example, manually place the reference to a CORS filter servlet in the web.xml
file in the IBM Content
Navigator, and set the
Access-Control-Allow-Origin:
https://Workflow_hostName:Workflow_portNumber
header in the CORS filter.
In the Business Automation Workflow Case configuration tool, run
the Deploy & Register Extensions Package task to deploy the custom extension
package plug-in to the IBM Content
Navigator.
Right-click the task and select Enable Task.
Enter and check the properties.
Run the task.
For more information about how to specify the CORS filter, see CORS
Filter.
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.
Update the previous case resource path with the absolute path for the remote Business Automation Workflow Case Client in the custom plug-in. JAR file. For
example, use
https://Workflow_hostName:CaseClient_portNumber/ICMClient/icm
instead of /ICMClient/icm. Make this replacement in each place that refers to
case resources.
Enable CORS settings for this custom widget, for example,
Manually place the following CORS filter Servlet in the web.xml file in the
custom widget EAR
file:
Put the casecors.jar file in the custom widgets application EAR
lib folder. You can get the casecors.jar file from the
following
directory:
Workflow_install_root/BPM/Case/lib/
In the Business Automation Workflow Case configuration tool, run
the Deploy & Register Custom Widgets Package task to deploy the Case custom
widget plug-in to the IBM Content
Navigator.
Right-click the task and select Enable Task.
Enter and check the properties.
Run the task.
For more information about how to specify the CORS filter, see CORS
Filter.
Restart the Business Automation Workflow deployment
environment.
To avoid accidentally editing solutions in the previous version of Case Builder after they are
already upgraded, remove the previous CaseBuilder app.
In the WebSphere administrative console for IBM Case
Manager V5.3.3
(https://case533_computer:9043/ibm/console) go to Applications > All Applications, select CaseBuilder and click
Remove.
Save the changes to the WebSphere® Application
Server
configuration, and restart the WebSphere Application
Server
profile.
Results
All the desktops that you previously had are augmented to the Business Automation Workflow environment and you can continue to use them as
before. The default desktop is baw. You can change the desktop in the IBM Content
Navigator administration console.
The
following image shows a typical topology with an external IBM Content
Navigator.
The Case Navigator plug-ins are available through the following URLs:
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 Content Engine Applet support plug-in (CPEAppletsPlugin.jar)
can be directly loaded from the Content Engine.
Now that Business Automation Workflow is configured with an external IBM Content
Navigator, both Process Designer in Case Builder and case forms are disabled. See Enabling the case management features to enable them.