IBM Case Manager Version 5.2.1 Fix Pack 1 Readme

This readme document contains information about installation and removal of the fix pack and about known problems, restrictions, and solutions in support of IBM Case Manager® Version 5.2.1 Fix Pack 1.

Readme file for: IBM® Case Manager
Product or component release: Version 5.2.1.1
Update name: Fix Pack 1
Fix ID:
  • 5.2.1.1-ICM-AIX-FP001
  • 5.2.1.1-ICM-LINUX-FP001
  • 5.2.1.1-ICM-ZLINUX-FP001
  • 5.2.1.1-ICM-WIN-FP001
Publication date:
31 December, 2014
Last modified date:
31 December, 2014
Online version of readme file: http://www.ibm.com/support/knowledgecenter/SSCTJ4_5.2.1/readme/icmfp5211.html
Important: The most current version of the readme file can always be found online.

Download location

This Fix Pack is available on the IBM Fix Central website. To locate this fix on Fix Central, select "Enterprise Content Management" as your Product Group, "Case Manager" as your Select from Enterprise Content Management choice, "5.2.1.0" as the Installed Version, and select your desired Platform. You can also choose to view fixes for all versions and all platforms of your product. Select the Continue button and search for this fix by using the Individual fix ID or by choosing the Browse for fixes as option. A fix ID is the package name that is used to identify a fix. You are prompted for your IBM ID and password when you try to download the wanted fix.

Download the fix from the following location: http://www.ibm.com/support/fixcentral/ or access the fix from the following table:

Table 1. Files associated with readme file
Product or Component Name Platform File Name
IBM Case Manager AIX 5.2.1.1-ICM-AIX-FP001.tar.gz
IBM Case Manager Linux 5.2.1.1-ICM-LINUX-FP001.tar.gz
IBM Case Manager Linux for System z 5.2.1.1-ICM-ZLINUX-FP001.tar.gz
IBM Case Manager Windows 5.2.1.1-ICM-WIN-FP001.zip

New features

IBM Case Manager, Version 5.2.1 Fix Pack 1 includes the following new or updated features.

  • IBM Case Manager Client on Mobile devices using Version 2.0.33.
  • Content Platform Engine V5.2.1.0 support.
  • Leverage Process Designer in IBM Content Navigator plugin from Content Platform Engine V5.2.1.0 to reduce the dependency for Workplace XT.
  • Support for 3 new languages:
    • Catalan
    • Kazakh
    • Vietnamese
  • Ability to upgrade from "IBM Case Manager V5.1.1.x with IBM Content Manager V8.4.3" to "IBM Case Manager V5.2.1.1 with IBM Content Manager V8.5".

Known problems, restrictions, and solutions

Known problems, restrictions, and solutions that affect administration and usage of Fix Packs are documented as techdocs in the product support knowledge base.

You can find information about known problems, restrictions, and solutions that affect the administration and usage of Fix Packs by reviewing the following technical support documents. As problems are discovered and resolved and as other helpful information is developed, the IBM Software Support team updates the knowledge base. By searching the knowledge base, you can find workarounds or solutions to problems and useful tips that might help you with product administration or usage.

To review all known problems, restrictions, and solutions that affect Version 5.2.1, use the following link to query the product support knowledge base: http://www.ibm.com/support/entry/portal/overview/software/enterprise_content_management/case_manager.

At the time of publication of this Fix Pack readme, the following problems, restrictions, and solutions were known:

Prerequisites for Version 5.2.1 Fix Pack 1

The following are prerequisites for IBM Case Manager Version 5.2.1 Fix Pack 1:

  • IBM Case Manager Version 5.2.1.0
  • IBM Content Navigator Version 2.0.3.2
  • For mobile devices, this requires IBM Content Navigator Version 2.0.33 or later available from the Apple iTunes App Store.
Important: When you install IBM Content Navigator V2.0.3.2 fix pack or later version & Content Platform Engine V5.2.1.0 or later version, you must do so BEFORE you install IBM Case Manager Version 5.2.1 Fix Pack 1.

The official statements for hardware and software support for IBM Case Manager are provided as part of the hardware and software requirements for IBM Case Manager Version 5.2.1. For complete details about the hardware and software requirements for IBM Case Manager, see http://www.ibm.com/support/docview.wss?uid=swg27042449.

Installing and configuring IBM Case Manager Version 5.2.1 Fix Pack 1

To install an IBM Case Manager Fix Pack, you must prepare the environment for the Fix Pack installation and use the installation program to install the Fix Pack.

Preparing the server for installation

Before you run the IBM Case Manager version 5.2.1 fix pack 1 installation tool, you must prepare your server for the installation. To prepare your server:

  1. Ensure that you have IBM Case Manager Version 5.2.1.0 or later installed on your system.
  2. Log on to the IBM Case Manager server. Log on as the same user who installed IBM Case Manager Version 5.2.1.0; otherwise, the installer cannot find the correct .com.zerog.registry.xml file. Ensure that this user has write access to the destination directory for your installation of IBM Case Manager.
  3. Ensure that the Case Manager configuration tool is not running.
  4. Ensure that you created backup copies of the icm_home/configure/configmgr.ini and icm_home/configure/configmgr_cl.ini files and save them to a location outside the icm_home directory. Where icm_home is the name of the IBM Case Manager installation directory.
  5. If you are using IBM Forms with IBM Case Manager, create a backup copy of the web.xml file that is in the Case Forms installation folder before you install the Fix Pack. For example, in a Windows environment the default path for the installation folder is C:\Program Files (x86)\IBM\CaseManagement\configure\exploded_apps\forms\WEB-INF. When you install the Fix Pack, a revised version of that file is installed in the folder. After the installation is complete, replace the revised version of the web.xml file with the backup copy that you created before the installation.

Installing the Fix Pack

You can install the Fix Pack interactively by using the installation program. Alternatively, you can install the Fix Pack silently by adding installation values to an input file and running the installation from a command line.

If your environment is configured for high availability and if IBM Forms is used in this environment, you must run the installation on all managed nodes. If IBM Forms is not used in the high availbility environment, run the installation on the server where you previously installed the Case Manager and ran the configuration tool. For more information, see the IBM Case Manager Version 5.2.1 Knowledge Center topics in the Installing and configuring in a cluster deployment or network deployment section.

Before you begin

Ensure that you meet all requirements that are mentioned in the Preparing the server for installation section.

Installing the Fix Pack interactively

If you want to install the Fix Pack interactively, use the installation program. The installation program installs the files and updates for IBM Case Manager and the Case Management configuration tool.

To install the Fix Pack interactively:
  1. Log on to the IBM Case Manager server. Log on as the same user who installed IBM Case Manager Version 5.2.1.0; otherwise, the installer cannot find the correct .com.zerog.registry.xml file.
  2. Navigate to the IBM Case Manager Fix Pack software package.
  3. Run the installation program:

Operating System Command
AIX 5.2.1.1-ICM-AIX-FP001.BIN
Linux 5.2.1.1-ICM-LINUX-FP001.BIN
Linux for System z 5.2.1.1-ICM-ZLINUX-FP001.BIN
Windows 5.2.1.1-ICM-WIN-FP001.EXE

  1. Click OK on the pages to confirm that the installation program detects required software.
  2. Review the preinstallation summary, and click Install.
  3. When the installation completes, click Next.
  4. Respond to the subsequent prompts to complete the installation.
Important: Ensure that you complete the steps in the What to do next section.

Installing the Fix Pack silently

If you want to install the Fix Pack silently, run a command in the Fix Pack software package that refers to parameters in an installation text file.

To install the Fix Pack silently:
  1. Log on to the IBM Case Manager server where you plan to install the Fix Pack. Log on as the same user who installed IBM Case Manager Version 5.2.1.0; otherwise, the installer will not find the correct .com.zerog.registry.xml file.
  2. Navigate to the IBM Case Manager Fix Pack software package.
  3. Edit the cm_silent_install.txt file to change the LICENSE_ACCEPTED value to TRUE.
  4. Run the installation program:

Operating System Command
AIX 5.2.1.1-ICM-AIX-FP001.BIN -i silent -f cm_silent_install.txt
Linux 5.2.1.1-ICM-LINUX-FP001.BIN -i silent -f cm_silent_install.txt
Linux for System z 5.2.1.1-ICM-ZLINUX-FP001.BIN -i silent -f cm_silent_install.txt
Windows 5.2.1.1-ICM-WIN-FP001.EXE -i silent -f cm_silent_install.txt

  1. When the installation completes, check for errors in the Fix Pack installation log. The IBM_Case_Manager_5.2.1.1-FP001_InstallLog.txt file is created in the installation directory. For example: /opt/IBM/CaseManagement/logs/IBM_Case_Manager_5.2.1.1-FP001_InstallLog.txt.
Important: Ensure that you complete the steps in the What to do next section.

What to do next

  1. Compare files, and then update the settings in the newly installed icm_home/configure/configmgr.ini and icm_home/configure/configmgr_cl.ini files to match the settings in the backup copies of these files.
  2. If you are using IBM Forms with IBM Case Manager, and you created a backup copy of the web.xml file as described in Preparing the server for installation, replace the new web.xml file in the Case Forms installation folder with the backup copy that you created before the installation.
  3. You must run the IBM Case Manager configuration tool and complete the configuration tasks for your environment before you can use IBM Case Manager. See “Configuring IBM Case Manager Version 5.2.1.1 Fix Pack 001” for instructions.

Configuring IBM Case Manager Version 5.2.1 Fix Pack 1

After you install Fix Pack 1, you must update the configuration for the Case Manager Builder application and the Case Manager Client application.

About this task

If you are applying the Fix Pack to a new IBM Case Manager installation that was not yet configured, you must complete all of the configuration tasks.

If you are applying the Fix Pack to an existing IBM Case Manager installation that was already configured, then you must rerun some configurations tasks. You can use your existing IBM Case Manager configuration tool profiles to run the required configuration tasks.

Configuring an existing IBM Case Manager deployment

If you install the Fix Pack to an existing IBM Case Manager installation that was previously configured, you must then update the development environment and the production environment.

Use your existing IBM Case Manager configuration tool profiles to run the required configuration tasks.

If you plan to use the IBM Case Manager configuration tool to configure the environments, see the following topics for detailed information about how to run the tasks:

If you plan to use the command line to configure the environments, see the following topics for detailed information about how to run the tasks:

Procedure:

  • Configure the development environment by running the following tasks:
    1. Update the Content Platform Engine Client Connector files.
      Important: After you complete the task in step #1, you need to restart the IBM Case Manager configuration tool and when restarted, continue to the next step.
    2. Configure the Case Management Object Stores.
    3. Note: The fix pack 1 has new feature which allows you to select Process Designer container using IBM Content Platform Engine Applets Support Plug-in instead of Workplace XT. The IBM Content Platform Engine (CPE) applets support plug-in is more convenient to use since it does not require user to install Workplace XT any more. If you choose to use IBM CPE Applets support plug-in instead of Wokplace XT, execute this task.
      Right click the root node of the profile > Select "Add New Task" > "Register the IBM Content Platform Engine Applets Support Plug-in" > Run this task.
    4. Important: If you choose to use the Process Designer using IBM CPE Applets support plug-in ensure to select " IBM CPE applets support plug-in " as the value for "Process Designer container" before running this task.
      Create Case Manager Applications.
    5. Deploy the Case Manager API.
    6. Register the IBM Case Manager Services Plug-in.
    7. If Workplace XT is on the same server and you want the configuration tool to deploy Workplace XT in the same profile with IBM Case Manager, then run the Deploy Workplace XT task. If you prefer, you can skip this task and deploy Workplace XT manually.
    8. Deploy Case Manager Builder.
    9. Deploy Case Manager Help System.
    10. Deploy and Register Widgets Package.
    11. If your environment uses Forms features, then run the Deploy the Forms Application task.
    12. Register the IBM Case Manager Administration Client Plug-in.
    13. Register Project Area.
    14. If your environment uses business rules, then run the Configure Business Rules task.
    15. Deploy Solution by using Case Manager Builder.

  • Configure the production environment by running the following tasks:
    1. Update the Content Platform Engine Client Connector files.
      Important: After you complete the task in step #1, you need to restart the IBM Case Manager configuration tool and when restarted, continue to the next step.
    2. Configure the Case Management Object Stores.
    3. Create Case Manager Applications.
    4. Deploy the Case Manager API.
    5. Register the IBM Case Manager Services Plug-in.
    6. Deploy Case Manager Help System.
    7. Deploy and Register Widgets Package.
    8. If your environment uses Forms features, then run the Deploy the Forms Application task.
    9. Register the IBM Case Manager Administration Client Plug-in.
    10. Register Target Environment.
    11. If your environment uses business rules, then run the Configure Business Rules task.
    12. Deploy Solution by using Case Manager Administration Client.

Configuring a new IBM Case Manager installation

If you install the Fix Pack to a new IBM Case Manager installation, you must then complete all of the configuration tasks. Configuring your system prepares the Case Manager Builder application and the Case Manager Client application for deployment on the application server. After you deploy these applications, you can create, test, manage, deploy, and work with your business solutions.

For complete configuration details, see Configuring IBM Case Manager and find the topic that is appropriate for your environment.

Removing the Fix Pack

The Fix Pack updates the IBM Case Manager uninstallation program. There is no option to remove only the files that were installed with the Fix Pack. The updated IBM Case Manager uninstallation program removes both the base IBM Case Manager files and the Fix Pack files.

About this task

To remove IBM Case Manager, see Removing IBM Case Manager.


Cumulative fix list (APARs)

The cumulative fix list contains all APARs that were fixed since the generally available release of Version 5.2.1 of IBM Case Manager.

Important: For some APARs, such as security-related APARs, information about that APAR is not made available to customers to avoid compromising customer and product security. If an APAR is listed in the fix list but no information is available, the APAR might be a security APAR.
Table 2. Fix list for IBM Case Manager Version 5.2.1 Fix Pack 1
APAR Description
PJ42305 The locked work item warning message is shown in English on Japanese locale environment.
PJ42589 When using Internet Explorer browser with Property View Designer, if a user enters a name, collection ID, or property ID for external properties, the user must refocus on the fields after typing each character.
PJ42590 In Case Manager environments with a production profile, the external document class' default instance security setting is removed, causing users to be unable to add external documents into the case folder.
PJ42595 When using the View Designer in some non-English language locales, the view becomes corrupted when any boolean setting for any object in the view is applied.
PJ42596 After deploying an upgraded solution, the values for exposed workflow fields that are not defined in a case will be set to NULL.
PJ42598 Resetting test environment does not persist database storage location (TABLESPACE) properties on the Target Object Store.
PJ42599 If Content Platform Engine uses a non-DB2 database, then external documents cannot be removed or unfiled from a case folder.

After the fix, external documents can be unfiled from a case but the proxy document will not be removed. To know more about how to manually cleanup unreferenced proxy documents visit the "Manually removing external proxy documents from IBM Case Manager" technote available at: http://www.ibm.com/support/docview.wss?uid=swg27043684

PJ42600 Attachments still open in same window when "Open document in a separate browser window" is checked for Attachments Widget.
PJ42609 Inbasket name shows "False" after reassigning work item for IE 9 and IE 10 browser.
PJ42659 A System Error: icmConverter.java:2410 error is displayed when trying to delete a case type of an upgraded solution.
PJ42662 Fail to save a Work Item after click Read-only Date Time field.
PJ42669 Multivalue List Item dialog in Properties widget should have only 1 button ("OK") when in ReadOnly mode in Case Client runtime.

When users click on the properties, the List Item dialog is displayed with "OK" and "Cancel" buttons. If they click on "OK", nothing happens. If they click on "Cancel", the dialog is closed. Instead, there should be only 1 button ("OK") and the dialog should close when it is clicked by the user. This happens on Summary Case, Add Case, Case Details, Work Details pages in the Case Client runtime UI.

PJ42672 Enable Case Manager Version 5.2.1 support on Mobile devices.

The 5.2.1.0-ICM-IF002 interim fix is minimum required to have Case Manager 5.2.1 on Mobile devices. This requires IBM Content Navigator 2.0.31 or later available from the Apple iTunes App Store.

PJ42698 DocGenerator tool shows the Type of choice list for the choice list name instead of the expected value Name.
PJ42699 Could not import a Case Manager version 5.2.0.x solution to a Case Manager version 5.2.1.x environment with production profile.
PJ42708 Setting viewer widget's height to automatic results in errors at runtime.
PJ42712 Documents added using fileAttachmentsToCurrentCase to local repository were wrongly classified as External Repository Documents.
PJ42718 Unable to work with cases at runtime if marking sets are associated with case properties after upgrade to ICM 5.2.1.
PJ42744 When user clicks on a column to sort in in-basket widget then navigates away and then back to work tab, the sort order is lost.
PJ42746 Solution Deployment takes relatively longer time to complete if Case Manager solution contains tasks with preconditions.
PJ42760 With fix for APAR# PJ41731 custom code to set properties widget values on Work Details fails if page title uses Case ID or Case Title.
PJ42770 If a task property is custom defined with choice list and exposed in in-basket, the display value will not be used as expected.
PJ42780 Sorting the in-basket work list causes widget to apply previously removed filter.
PJ42784 Calling Case.fetchInstance with a non-null value for propFilt can result in error: FNRCA0024E: API_PROPERTY_NOT_IN_CACHE.
PJ42793 When retrieving a security manifest, and groups are assigned to Roles, an LDAP search against users will be performed.
PJ42796 Incorrect default task name in add task dialog when hidden task is defined.
PJ42797 Users are presented with a dialog to un-file from all locations when trying to remove a document from a case.
PJ42798 Cannot add MAX value item to Multi-Value Date-Time property in properties widget if you first add MIN value item, close, reopen.
PJ42799 Right-Click > Properties context menu does not work consistently between Case Info and Case Attachment widget.
PJ42800 Unable to edit case properties in an IBM Content Manager (CM8) environment the very first time a case is opened.
PJ42801 The "Modified By" username does not show the external repository username for Case Documents from external repositories.
PJ42802 Import 5.2.0 solution with web site viewer widget having a URL string in the encoded form results in an error.
PJ42803 Adding docs to external repository for a Case Type fails if the Case Info widget is configured to only show solution Doc Types.
PJ42804 A properties widget with an integer property will allow the user to close the page even when there are errors on it.
PJ42805 Adding a case is not displaying a validation error for a property table when all required Date-Time properties are not filled in.
PJ42806 Unable to use scrollbar to scroll to see all users for a particular role when reassigning a work item.
PJ42807 A page with a localized name containing a push in-basket might not load after another in-basket on another page loaded before.
PJ42809 When entering data via property view designer the user has to refocus on the fields after every key stroke.
PJ42810 Width and height settings for the property view widget are ignored for an imported or upgraded solution.
PJ42811 When 2 split case pages are opened the checkbox in the heading for 'select all' does not work.
PJ42812 Multi-values properties (integer, float, string) are not editable on first try via Chrome browser.
PJ42813 The OK button is nonresponsive when viewing property values from the multiple value dialog.
PJ42814 Connection point configured with Config Tool on a target environment for a CM8 object store does not display in Admin Client.
PJ42817 Creating a task that uses IBM BPM process breaks Case Type XPDL and the process data field name choice list miss BPM field names.

Copyright and trademark information

IBM, the IBM logo, and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml

Notices

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Other company, product, or service names may be trademarks or service marks of others.

THIRD-PARTY LICENSE TERMS AND CONDITIONS, NOTICES AND INFORMATION

The license agreement for this product refers you to this file for details concerning terms and conditions applicable to third party software code included in this product, and for certain notices and other information IBM must provide to you under its license to certain software code. The relevant terms and conditions, notices and other information are provided or referenced below. Please note that any non-English version of the licenses below is unofficial and is provided to you for your convenience only. The English version of the licenses below, provided as part of the English version of this file, is the official version.

Notwithstanding the terms and conditions of any other agreement you may have with IBM or any of its related or affiliated entities (collectively "IBM"), the third party software code identified below are "Excluded Components" and are subject to the following terms and conditions:
  • the Excluded Components are provided on an "AS IS" basis
  • IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  • IBM will not be liable to you or indemnify you for any claims related to the Excluded Components
  • IBM will not be liable for any direct, indirect, incidental, special, exemplary, punitive or consequential damages with respect to the Excluded Components.