IBM FileNet P8 Content Platform Engine 5.5.4.0-P8CPE-IF001 Interim Fix Readme
© Copyright IBM Corporation 2020.

Readme file for: IBM® FileNet® P8 Content Platform Engine
Update name: 5.5.4.0-P8CPE
Fix ID: 5.5.4.0-P8CPE-IF001
Publication date: 26 March 2020
Last modified date: 26 March 2020

Contents

About this interim fix
Download location
Prerequisites
New in this Interim Fix
Known problems, restrictions and solutions
Installation
Preparing the server for installation
Installing this Interim Fix
Server
Server Install
Configuration Manager Installation
Configuring the server after installation
Client
Installing the client updates
Installing the Process Designer and Process Engine Tools updates
Installing .Net API updates
Fix list (APARs)
Notices
Trademarks
Document change history

About this interim fix

This interim fix updates the Content Platform Engine, FileNet Deployment Manager, Process Designer, Content Engine Bulk Import (CEBI), and Content Platform Engine client files.

Important: If you are using this interim fix as a part of a new installation of the Content Platform Engine, install the interim fix files as directed here but stop before "Configuring the server after installation". Instead follow the instructions in the Knowledge Center topic "Installing and configuring Content Platform Engine" Installing Content Platform Engine to complete your new installation.

Important: If you are using this interim fix to upgrade from a release prior to 5.5.4, install the interim fix files as directed here but stop before "Configuring the server after installation". Instead continue with the upgrade process as described in the Knowledge Center topic "Upgrading and configuring Content Platform Engine" Upgrading Content Platform Engine.

Download location

Click the following link to access the files for this interim fix server update: Fix Central for Interim Fix 5.5.4.0-P8CPE-IF001. You need an IBM login and password to access this download location.

Prerequisites

This interim fix requires:

New in Interim Fix 5.5.4.0-P8CPE-IF001

The following changes are introduced in this 5.5.4.0-P8CPE-IF001 Interim Fix:

Known problems, restrictions and solutions

Following are some known problems and restrictions that are related to this interim fix:

Installation

Installation of this interim fix consists of the following tasks:

Preparing the server for installation

In environments where there is more than one Content Platform Engine server running in the P8 domain, the Content Platform Engine nodes can be set up in either a managed or non-managed configuration.

When you deploy Content Platform Engine in a "managed" application server environment, this Content Platform Engine interim fix is installed and configured on the administration server. The Configuration Manager uses the administration tools of the application server to deploy the Content Platform Engine EAR file to the managed servers. This is known as a "managed" deployment.

When you deploy Content Platform Engine in a "non-managed" application server environment, install and configure this Content Platform Engine interim fix on any Content Platform Engine server in the environment. After configuring the Content Platform Engine EAR file on this first server, you will be directed to copy the EAR file to each of the other servers and deploy the EAR file on all of the servers.

Complete the following tasks to prepare the Content Platform Engine server for this interim fix.

  1. Log on to the Content Platform Engine server as the user who is designated as the "cpe_install_user" user.
  2. Download this interim fix and extract its contents to a temporary location. For information, see Download location.
  3. Optionally stop the FileNetEngine and any client applications.

    As updating to this interim fix from an existing 5.5.4.0-P8CPE deployment is a minor version update, it is not required for the Content Platform Engine to be stopped prior to deploying the interim fix.

Installing this Interim Fix

Complete the following tasks to install this interim fix.

Important: The Content Platform Engine (CPE) EAR file naming convention is "Engine-xx.ear" where "xx" represents the Content Platform Engine application server type (ws, wl, wl122).
For WebLogic customers, the Engine-wl.ear is for users of WebLogic 12.1 and earlier while Engine-wl122.ear is for users of WebLogic 12.2 and later.

Server
  1. Navigate to the temporary directory where you extracted the contents of this interim fix.
  2. Server Install

    Backup existing files as listed below.
    Then copy the updated versions of the files that were extracted from the fix (see prior step) into the same directory as the existing copy that you just backed up. (This action overwrites the existing copy.)

    UNIX

    installation_location/ContentEngine/lib/Engine-xx.ear

    Windows

    installation_location\ContentEngine\lib\Engine-xx.ear

  3. Configuration Manager cleanup

Configuring the server after installation

Complete the tasks in this section to configure the server set-up information and to deploy Content Platform Engine. Following are an overview of the steps.

Important: If you are using this interim fix as a part of a new installation of the Content Platform Engine or upgrade from a pre-5.5.4 version of the Content Platform Engine, stop here. Return to the instructions in the Knowledge Center topic to complete the process for your new installation of a 5.5.4.0-P8CPE version or your upgrade from a pre-5.5.4 CPE version.

Gathering Content Platform Engine information

Before you can deploy Content Platform Engine, you must gather information that is needed for the application server configuration profile and for startup and deployment of the Content Platform Engine EAR file.

Use the Installation and Upgrade Planning Worksheet to help identify all the required information about your Content Platform Engine installation. Refer to the following link for more details:
See Knowledge Center Using the installation and upgrade worksheet.

Completing Configuration Manager tasks

Complete the tasks in this section to configure the server set-up information and to deploy Content Platform Engine.

Completing Configuration Manager update tasks interactively

Completing Configuration Manager tasks Command-line: Add and execute deployupdate

Completing Configuration Manager tasks interactively

Starting the Configuration Manager

  1. Log on to the Content Platform Engine server as the "config_mgr_user" user.
  2. Start Configuration Manager by completing the procedure that is appropriate for the operating system.

    UNIX

    Run the following command from the command line: ce_install_path/tools/configure/configmgr.

    Windows

    Select Start > All Programs > IBM FileNet P8 Platform > FileNet Configuration Manager or run the following command: ce_install_path\tools\configure\configmgr.exe.

Deploy Update

To redeploy/update an existing 5.5.4.0-P8CPE FileNetEngine application, add and run the "Deploy Update" task.

Important: Do NOT select "Deploy Update" for new installs or upgrades from a version previous to 5.5.4.0-P8CPE.

See Knowledge Center topic Planning and preparing for FileNet P8 updates for deploy update WebSphere Application Edition Management (AEM) details.

  1. Open the existing 5.5.4.0 Configuration Manager profile or create a new 5.5.4.0 Configuration Manager profile.
  2. Choose Add New Task > Deploy Update task.
  3. Provide the property values for your deployment. For details on the fields, hover your mouse over the "?" icon to view the property description.
  4. Save your changes then select Run Task.

    Running the deploy task might take several minutes. The task status messages are displayed in the Console pane below the deploy application properties.

  5. If the FileNetEngine application server was shutdown, or the application server does not restart it in a timely fashion, manually restart the FileNetEngine application after confirming the new files were distributed by the application server to all nodes or managed servers.
  6. Open the Content Engine (CE) ping page (http://server:port/FileNet/Engine) and verify that the value in the Startup Message key for Content Platform Engine is the same as the Content Platform Engine build number from the version.txt file, which is located in the temporary directory where you extracted the contents of this interim fix.

Update of the FileNetEngine application is now complete. Continue with the next section, Installing the client updates.

Completing Configuration Manager Tasks Command-line

Add and execute deployupdate

Complete the following procedure to specify setup information and deploy an update to an existing Content Platform Engine

Important: Do NOT use deployupdate for new installs or for upgrades from a version previous to 5.5.4.0-P8CPE.

  1. Log on to the Content Platform Engine server as the user who is designated as the config_mgr_user user
  2. Change the current directory to ce_install_path/tools/configure, where ce_install_path is the path where you installed Content Platform Engine. For example, ce_install_path might be /opt/FileNet/ContentEngine
  3. If the ear folder is present in the Configuration Manager profile, make a backup of the files in the myprofile/ear folder. If the myprofile/ear folder does not exist, create one.
    Copy the ear that supports your application server type and version from the installation_location to the ear folder in the Configuration Manager profile.

    Important: The Content Platform Engine (CPE) EAR file naming convention is "Engine-xx.ear" where "xx" represents the Content Platform Engine application server type (ws, wl, wl122).
    For WebLogic customers, the Engine-wl.ear is for users of WebLogic 12.1 and earlier while Engine-wl122.ear is for users of WebLogic 12.2 and later. The installation_location is where you previously copied the new ear:

    UNIX:
    installation_location/ContentEngine/lib/Engine-xx.ear

    Windows:
    installation_location\ContentEngine\lib\Engine-xx.ear

    If your application server version is WebLogic 12.2 or higher, rename the file Engine-wl122.ear to Engine-wl.ear in the installation location.
    Verify the permissions on the ear file allow the account running the Configuration Manager read/write access.
  4. Generate the deployupdate.xml task file for an existing CPE 5.5.4 configuration manager profile or as part of a new CPE 5.5.4 configuration manager profile using this command
  5. configmgr_cl generateconfig -appserver WebSphere/WebLogic -deploy standard/cluster/netdeploy -task deployupdate -profile myprofile

  6. Supply the needed values in the deployupdate.xml task file. If this is a new configuration manager profile, also complete the applicationserver.xml file.
  7. Use the command-line to execute the deployupdate task. Enter the command on one line without line breaks

    configmgr_cl execute -task deployupdate -taskfile deployupdate.xml -profile myprofile

  8. If the application server was shutdown, or the application server does not restart in a timely fashion, manually restart the FileNetEngine application after confirming the new files were distributed by the application server to all nodes or managed servers.
  9. Open the Content Engine (CE) ping page (http://server:port/FileNet/Engine) and verify that the value in the Startup Message key for Content Platform Engine is the same as the Content Platform Engine build number from the version.txt file, which is located in the temporary directory where you extracted the contents of this interim fix.

Completing Configuration Manager tasks

In a non-managed application server environment, repeat the EAR deployment for all servers.


Client Installation

Installing the client download updates

This interim fix updates the Client Download client-download.jar file.

Note: If Client downloader is not installed, this step can be skipped.

  1. Navigate to the temporary directory where you extracted the content of this interim fix.
  2. Client Application Install

Installing the client updates

The following Content Platform Engine client API files are included in this interim fix. These files must be installed as needed on the Content Platform Engine clients and customized application installation locations.

Complete the following procedure to update Content Platform Engine with the updated JAR files.

  1. Backup existing files as listed below.
    Then copy the updated versions of the files that were extracted from the fix (see prior step) into the same directory as the existing copy that you just backed up. (This action overwrites the existing copy.)

    UNIX
    installation_location/ContentEngine/lib/Jace.jar
    installation_location/ContentEngine/lib/pe.jar

    Windows
    installation_location\ContentEngine\lib\Jace.jar
    installation_location\ContentEngine\lib\pe.jar

  2. On some systems (for example, systems using custom applications), the Jace.jar, Jace_t.jar, pe.jar or peResources.jar files might also exist in other directories or be otherwise bundled with the custom application (for example, with the J2EE WAR or EAR file). If you have any custom applications, search for the files and replace other instances with the new version supplied in this interim fix.

Note: You use the Content Platform Engine client installer to install the new jars that will come from the updated Content Platform Engine server via the download service. It's important that the Content Platform Engine server be already updated by this interim fix and be running prior to running the client installer. By following the client installation instructions below, the updated files will be installed on all clients that are supported by the client installer. The files are also provided separately for clients not supported by the client installer.

You can install the client update either interactively or silently. This section consists of the following steps:


Installing the Content Platform Engine client update on Content Platform Engine-related Java EE applications interactively

After you have updated the Content Platform Engine servers complete the following tasks for all of the Content Platform Engine-related Java EE applications, and any custom Content Platform Engine-related Java EE applications.

  1. Back up the existing Content Platform Engine client directories.
  2. Download the appropriate client update file from the latest generally available release and extract its contents to a temporary location.
  3. The following table lists the names of the compressed fix client update files by operating system type:

    Name of compressed Content Platform Engine client update file by operating system type
    Operating system type
    Name of compressed Content Platform Engine client update file
    AIX
    5.5.4.0-P8CPE-CLIENT-AIX.tar.gz
    Linux
    5.5.4.0-P8CPE-CLIENT-LINUX.tar.gz
    Windows
    5.5.4.0-P8CPE-CLIENT-WIN.zip
    zLinux
    5.5.4.0-P8CPE-CLIENT-ZLINUX.tar.gz
  4. Complete the following instructions as appropriate for the client installation:
  5. Tip If the client installation program is unable to detect the existing installation of the FileNet P8 application you are updating, you must manually ensure that the update occurs. Check the item in the "Select FileNet P8 Applications" dialog box and complete the client installation by entering (or browsing to) the location where that application is installed.

  6. Review the Content Platform Engine client log files for installation errors.

    Installation errors are recorded in the ceclient_install_log_5.5.4.0.txt file, which is in the ceclient_install_path directory.

  7. Restart the applications that use the Content Platform Engine client.

The installation and configuration of the client upgrade for this interim fix is complete.


Installing the Content Platform Engine client updates silently

Complete the following procedure to install the Content Platform Engine client updates silently.

  1. Log on as a user with permissions to install software.
  2. Stop all custom applications that use the Content Platform Engine client.
  3. Back up the existing Content Platform Engine client directories.
  4. Download the appropriate client update file from the latest generally available fix pack and extract its contents to a temporary location.
  5. The following table lists the names of the compressed fix client update files by operating system type:

    Name of compressed Content Platform Engine client update file by operating system type
    Operating system type
    Name of compressed Content Platform Engine client update file
    AIX
    5.5.4.0-P8CPE-CLIENT-AIX.tar.gz
    Linux
    5.5.4.0-P8CPE-CLIENT-LINUX.tar.gz
    Windows
    5.5.4.0-P8CPE-CLIENT-WIN.zip
    zLinux
    5.5.4.0-P8CPE-CLIENT-ZLINUX.tar.gz
  6. Open the ceclient_silent_install.txt file and edit the file as appropriate for your configuration, including the following fields and other fields that apply to your system.
  7. Install this fix by running the following command that is appropriate for your operating system.

    Silent installation start commands by operating system for the Content Platform Engine client update
    Operating system
    Command to install the Content Platform Engine server update
    AIX
    5.5.4.0-P8CPE-CLIENT-AIX.BIN -i silent -f ceclient_silent_install.txt
    Linux
    5.5.4.0-P8CPE-CLIENT-LINUX.BIN -i silent -f ceclient_silent_install.txt
    Windows
    5.5.4.0-P8CPE-CLIENT-WIN.EXE -i silent -f ceclient_silent_install.txt
    TIP You can monitor completion of this interim fix server update installation on Windows-based systems by using the Windows Task Manager.
    zLinux
    5.5.4.0-P8CPE-CLIENT-ZLINUX.BIN -i silent -f ceclient_silent_install.txt

  8. Review the Content Platform Engine client log files for installation errors.

    Installation errors are recorded in the ceclient_install_log_5.5.4.0.txt file, which is in the ceclient_install_path directory.

  9. Restart the custom applications that use the Content Platform Engine client.

The installation and configuration of the client upgrade for this interim fix is complete.


Tools Installation

Installing the Process Designer and Process Engine Tools updates

This interim fix updates the Process Designer and Process Engine Tools Jace.jar, pe.jar, peResources.jar and petools.jar files.

Complete the following procedure to update Process Designer and Process Engine Tools.

  1. After downloading the fix and extracting its contents to a temporary location (in step 2 under Preparing the server for installation ), the updated Jace.jar, pe.jar, peResources.jar and petools.jar files should be in the temporary location.
  2. Backup existing files as listed below.
    Then copy the updated versions of the files that were extracted from the fix (see prior step) into the same directory as the existing copy that you just backed up. (This action overwrites the existing copy.)

    Linux
    installation_location/ContentEngine/lib/Jace.jar
    installation_location/ContentEngine/lib/pe.jar
    installation_location/ContentEngine/lib/applets.jar

    Windows
    installation_location\ContentEngine\lib\Jace.jar
    installation_location\ContentEngine\lib\pe.jar
    installation_location\ContentEngine\lib\applets.jar


Installing .Net API updates

This interim fix updates the .Net API FileNet.Api.dll and FileNetApiSetup.msi files.

Complete the following procedure to update .Net API client installed on a Windows machine.

  1. Log on as a user with permissions to install software.
  2. After downloading the fix and extracting its contents to a temporary location (in step 2 under Preparing the server for installation ), the updated FileNetApiSetup.msi file should be in the temporary location.
  3. Launch FileNetApiSetup.msi and complete the IBM FileNet Content Engine .NET API Setup Wizard.

Fix list (APARs)

The following table lists the product fixes for this interim fix.

5.5.4.0-P8CPE-IF001
APAR
Description
PJ45887
Administration Console for Content Platform Engine (ACCE) localization issue in string and integer Choicelists.
PJ45961
Administration Console for Content Platform Engine (ACCE): Content Platform Engine(CPE) Security Policy does not save configuration of Security Template when using Roles.
PJ45964
Administration Console for Content Platform Engine (ACCE) Choice lists have a null value added.
PJ45992
NullPointerException occurs if a property with null value is included in an arithmetic clause in a filter expression.
PJ46004
Apostrophe in the Process Engine (PE) in-basket filter search causes a syntax failure when configured for case insensitive Search.
PJ46028
Administration Console for Content Platform Engine (ACCE) using greater than ">" or less than "<" in a sweep job filter expression throws syntax error "Bad filter expression".
PJ46033
Snaplock Fixed Content Device (FCD) update retention failure for NFS mount.
PJ46034
Stand-alone Process designer error "java.lang.ClassNotFoundException: com.filenet.wcm.toolkit.client.ui.WcmDlgFactory". See technote 1171240.
PJ46044
Administration Console for Content Platform Engine (ACCE) Opening subclass Annotation doesn't display the annotation in a new tab.
PJ46049
External Share REST API: Allow user to enable share even if we cannot resolve email template resource bundle for a locale.
PJ46050
PISRT ADV0020631 (CVE-2019-4679): IBM FileNet Content Manager security vulnerabilities in Administration Console for Content Platform Engine (ACCE) logon response header. See security bulletin 1283950.
PJ46053
On some Content Platform Engine (CPE) client applications intermittent FIPSRuntimeExceptions may occur.
PJ46054
FNRAM9018 exception returned creating Case History store after upgrading.
PJ46059
On Administration Console for Content Platform Engine (ACCE) document properties page, the right panel is transparent.
PJ46061
FNRAC1005E error occurs when trying to add Choice Item to a Choice List with 951 choice items.
PJ46069
Case History - Handle update events on case comments.
PJ46070
Content Engine Audit disposition code has a check against the bookmark which is inverted.
PJ46075
BACSoC NullPointerException from PE when any Process Engine (PE) RCP's are performed after 72 hours from initial logon.

Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing
IBM Corporation
J74/G4
555 Bailey Avenue
San Jose, CA 95141
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: 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 states 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.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation
J46A/G4
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice and represent goals and objectives only.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.

Trademarks

IBM, the IBM logo and ibm.com are trademarks or registered 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 www.ibm.com/legal/copytrade.shtml.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft, Windows, Windows NT and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

Other product and service names might be trademarks of IBM or other companies.

Document change history


Date
Description
26 March 2020
Initial interim fix release.