Draft comment: This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-01-20 10:38
Traditional: 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 topology similar to the one before the upgrade. It uses an external FileNet® content environment that can be shared by other IBM products.
Restriction:
Embedded IBM Content
Navigator can be used
only in non-production environments and for basic IBM Case
Manager functions.
Customization and extension of embedded IBM Content
Navigator is not
supported.
About this task
This upgrade requires IBM Case
Manager and a new
separate installation of Business Automation Workflow and WebSphere® Application
Server. Do not install and
configure Business Automation Workflow into
an existing WebSphere Application
Server Network Deployment
where Content Platform Engine or
IBM Content
Navigator is
configured.
Due to a collocation restriction from IBM Content
Navigator, in the
external IBM Content
Navigator and external
Content Platform Engine environment,
installing Business Automation Workflow,
Content Platform Engine and IBM Content
Navigator into single
WebSphere
application server
cell is not supported. For more information, see Planning for your web application server. In case you insist
to install them into one single
WebSphere
application server cell, you
must install Business Automation Workflow on
each node machine, and external Content Platform Engine and external IBM Content
Navigator must use a
WebSphere
profile (non-bpm
profile) template.
Figure 1. Topology before and after augmentation
In the new topology the case code and custom case widgets and extension packages are on
different servers, Business Automation Workflow versus IBM Content
Navigator, which
requires adjustments to the custom widget and extension package paths.
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.
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 by 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 is 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 is 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
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.
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
To continue using the same configurations and customizations in IBM Content
Navigator after the
upgrade, configure Business Automation Workflow to use your IBM Content
Navigator.
Important: Make sure that the Business Automation Workflow server is available
before you restart the IBM Content
Navigator
environment.
Run the 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:
If you are using custom extension packages, update them.
Enable cross-origin resource sharing (CORS) settings for this custom extension package, which is
installed and deployed in IBM Content
Navigator. This is
done by enabling and configuring the CORS filter servlet in IBM Content
Navigator.
Add the filter-mapping for custom extension plug-ins from IBM Content
Navigator
Modify the <IBM Content Navigator installation
location>\configure\explodedformat\navigator\WEB-INF\web.xml to add
Run IBM Content
Navigator
configuration tool to rebuild and redeploy the application.
Create a new CORS.properties.
Add the following text for CORS
cors.origin.hostname=[bawserver]
cors.origin.port=[bawserver port]
cors.allow.methods=GET, OPTIONS, HEAD, PUT, POST
cors.allow.credentials.boolean=true
cors.options.status=202
[bawserver] - the URL that client users access Workflow Center, Case Builder.
[bawserver port] -
the PORT that client users access Workflow Center, Case Builder.
Add a com.ibm.ecm.icn.cors.file JVM parameter that points to the
CORS.properties file that you created in (b)
For
example,
-Dcom.ibm.ecm.icn.cors.file=/tmp/CORS.properties
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.
Right-click the task and select Enable Task.
Enter and check the properties.
Run the task.
Note: After deploying the package and by using the custom case extensions in Case Builder, it is suggested that you
add an exception to your browser to handle an invalid server certificate for the external IBM Content
Navigator server. This
can be accomplished by opening the IBM Content
Navigator URL in the
same browser session as Case Builder and then adding the
exception for the invalid server certificate when prompted. The IBM Content
Navigator URL uses the
following format:
https://ICN_hostName:ICN_portNumber/navigator
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 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 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:
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.
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
(https://case_computer:9043/ibm/console) goes 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.
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 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.
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.
After a successful upgrade, you can promote your case solutions to workflow projects, which you
can easily manage in Business Automation Workflow. See Promoting case solutions to the Workflow Center.
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-01-20 10:38