Readme file for: IBM® FileNet® P8 Content Platform Engine
Update name: 5.5.0.0-P8CPE
Fix ID: 5.5.0.0-P8CPE-IF003
Publication date: 20 December 2018
Last modified date: 20 December 2018
This interim fix updates the Content Platform Engine "engine-xx.ear" file, 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.
Click the following link to access the files for this interim fix server update: Fix Central for Interim Fix 5.5.0.0-P8CPE-IF003. You need an IBM login and password to access this download location.
This interim fix requires:
The following changes are introduced in this 5.5.0.0-P8CPE-IF003 Interim Fix:
The following changes are introduced in this 5.5.0.0-P8CPE-IF002 Interim Fix:
The following changes are introduced in this 5.5.0.0-P8CPE-ALL-LA001 Limited Availability Fix:
Following are some known problems and restrictions that are related to this interim fix:
Installation of this interim fix consists of the following tasks:
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 all Content Platform Engine servers in the environment. You will be directed to deploy the EAR file on all of the servers.
Complete the following tasks to prepare the Content Platform Engine server for this interim fix.
You can determine the location of the existing bootstrapped EAR file for Content Platform Engine by viewing the contents of the Servers.xml file, which is in the ce_install_path directory.
Complete the following tasks to install this interim fix.
Navigate to the temporary directory where you extracted the contents of this interim fix.
UNIX
installation_location/ContentEngine/lib
Windows
installation_location\ContentEngine\lib
Complete the following post-installation tasks to configure the affected servers after the installation of this interim fix.
Before you can deploy Content Platform Engine, you must gather information that is needed for the application server configuration profile and for start up and deployment of the Content Platform Engine EAR file.
To help prevent errors when you are deploying the updated version of Content Platform Engine, remove the previously deployed copy of Content Platform Engine from the application server before you deploy the updated Content Platform Engine. The following sections provide information on specific application servers.
Use the administrative console to uninstall the "FileNetEngine" application. This action deletes the Engine-ws.ear file from IBM WebSphere Application Server.
Use the Change Center in the administrative console to delete the "FileNetEngine" application. This action deletes the Engine-wl.ear file from Oracle WebLogic Server.
To help prevent errors when you are deploying the updated version of Content Platform Engine, remove the application server cache as described in the following topics.
MULTI-CPE NODE NOTE If your system has multiple Content Platform Engine nodes that run in a "managed" configuration, remove the application server cache directories from only the central "managing" application server and not from any managed application servers. If your system has multiple Content Platform Engine nodes that run in a "non-managed" configuration (multiple stand-alone application servers), remove the application server cache directories from all the application servers in the configuration.
C:\Program Files\IBM\WebSphere\AppServer\profiles\profile_name\temp\node_name\server_name\FileNetEngine\
C:\bea\user_projects\domains\mydomain\servers\AdminServer\tmp\_WL_user\FileNetEngine
C:\bea\user_projects\domains\mydomain\servers\AdminServer\cache\EJBCompilerCache
Clear the internet browser cache on all client computers that use Administration Console for Content Platform Engine (ACCE) for administering Content Platform Engine.
Before you can verify setup information and deploy Content Platform Engine, the user who is designated as the cpe_install_user user must grant certain permissions to the user who is designated as the config_mgr_user.
NOTE Complete this procedure only if you need to add or update permissions on the target directories and files.
The executable name depends upon the interface that will be used to run the Configuration Manager:
| Configuration Manager interface |
Executable name |
|---|---|
UNIX graphical user interface |
configmgr |
UNIX command line |
configmgr_cl |
Windows graphical user interface |
configmgr.exe |
Windows command line |
configmgr_cl.exe |
The ce_install_path/tools/configure directory is the default directory that Configuration Manager uses if a directory path is not specified when the configuration profile information for deploying Content Platform Engine is verified.
Complete the tasks in this section to configure the server set-up information and to deploy Content Platform Engine.
Completing Configuration Manager tasks interactively
Completing Configuration Manager tasks using the command line
Complete the following tasks in the order that is shown to set up and deploy the Content Platform Engine.
Select Start > All Programs > IBM FileNet P8 Platform > FileNet Configuration Manager or run the following command: ce_install_path\tools\configure\configmgr.exe.
Run the following command from the command line: ce_install_path/tools/configure/configmgr.
Complete the following procedure to choose which licenses apply for your system.
The licensing choices that are stored in the software tag files are written into the Content Platform Engine EAR file as part of the "Configure Bootstrap and Text Extraction" task execution.
The IBM System Dashboard for Enterprise Content Management Listener component is configured with that licensing information so that usage reporting and the IBM License Metric Tool can make the correct product and license association.
If you rerun the "Choose Licenses" task with a different set of licensing choices, you must complete the following steps in order that the Content Platform Engine component that is running always has the correct licensing information:
Complete the following procedure to enter, update, or verify the Content Platform Engine bootstrap information.
IMPORTANT The default value is Configure New, but you must change it to Upgrade.
(Multiple non-managed stand-alone application servers only) Copy the bootstrapped Content Platform Engine EAR file into the profiles directory (where 5.5.0.0-P8CPE was originally bootstrapped) on each of the remaining Content Platform Engine application servers in your P8 domain. For example:
ce_install_path\tools\configure\profiles\myprofile\ear
Complete the following procedure to enter, update, or verify deployment information.
IMPORTANT If a configuration profile previously existed and the configuration information does not require editing begin with Deploying Content Platform Engine. If you just created a configuration profile for an upgrade, continue with the following steps.
Parameter name |
Description |
|---|---|
| Deployment type |
Enter or verify the deployment type. The valid values are: Standard, Network Deployment, or Cluster.
If you change this setting, you will be required to provide values for the properties required by the selected deployment type. |
| Bootstrapped EAR path |
Enter or verify the fully qualified path to the bootstrapped and updated Content Platform Engine EAR file that was created by the "Configure bootstrap" task. |
| Content Platform Engine Application name |
Enter or verify the Content Platform Engine application name as it will appear in the application server (for example, in an administration console). The application name is subject to application server naming constraints. For WebSphere Application Server, each application in a cell must have unique name. The default is FileNetEngine. |
| Application server node |
Enter or verify the name of the WebSphere Application Server node where Content Platform Engine will be deployed (n/a for Cluster Deployment Type). |
| Application server name |
Enter or verify the name of the WebSphere Application Server where Content Platform Engine will be deployed (n/a for Cluster Deployment Type). |
| Script |
Enter or verify the fully qualified path to the deploy configuration task script. The task script filename depends on the application server type selected. |
| Temporary directory |
Enter or verify the fully qualified path to a temporary directory to be used by the configuration task. |
| Parameter name |
Description |
|---|---|
| Bootstrapped EAR path |
Enter or verify the fully qualified path to the bootstrapped and updated Content Platform Engine EAR file that was created by the "Configure bootstrap" task. |
| Content Platform Engine Application name |
Enter or verify the Content Platform Engine application name as it will appear in the application server (for example, in an administration console). The application name is subject to application server naming constraints. The default is FileNetEngine. |
| Script |
Enter or verify the fully qualified path to the deploy configuration task script. The task script filename depends on the application server type selected. |
| Temporary directory |
Enter or verify the fully qualified path to a temporary directory for use by the configuration task. |
Right-click Deploy Application in the Content Platform Engine Task View pane, and select Run Task to deploy Content Platform Engine. This task can take a few minutes. Task execution status messages display in the Console pane.
Stop and start the application server, as follows:
Stop and restart all servers and clusters where the Content Platform Engine EAR file has been deployed.
Complete the following procedure to specify setup information and deploy Content Platform Engine.
configmgr_cl listServers
configmgr_cl generateupgrade [-appserver app_server_type] -server server_name [-deploy deploy_type] -profile myprofile [-silent] [-force] [-help]
If a message indicates that a profile already exists, record the profile name. Use this profile name in places where this readme references myprofile.
The following table lists the descriptions for the configmgr_cl generateupgrade command parameters:
| Parameter |
Description |
|---|---|
| -appserver appserver_type |
The -appserver appserver_type parameter is required only if the ce_install_path/Servers.xml file does not exist or does not contain any servers. This parameter specifies the type of application server and must be one of the following values: WebSphere, or WebLogic. |
| -server server_name |
The -server server_name parameter indicates the server to create the upgrade profile for. Run the configmgr_cl listServers command to displays a list of valid server name values before you run the generateupgrade command. |
| -deploy deploy_type |
Type of deployment.
Required if the Servers.xml file does not exist or does not contain a deployment type for the selected server. If the Servers.xml file already has a deployment type for the selected server, then the value from the Servers.xml file is used instead of the value you specify on the command line.
|
| -profile myprofile |
The myprofile value can be one of the following items:
If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\cpe_was_tiv_db2\cpe_was_tiv_db2.cfgp". |
| -silent |
When -silent is specified, no prompts or informational messages display in the console, but errors are written to the log. Failure messages and validation error messages display as needed, such as messages about missing passwords or invalid port numbers.<
If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter. The -silent parameter is optional. |
| -force |
When -force is specified, the command is forced to continue running while in silent mode. |
| -help |
When -help is specified, a brief message displays on the command syntax instead of running the command. |
<propertyname="ApplicationServerAdminUsername">
<value>administrator_user_name</value>
</property>
<property name="ApplicationServerInstallationFolder">
<value>/opt/IBM/WebSphere/AppServer</value>
<description>Enter the absolute path to the directory where the WebSphere Application Server is installed.</description>
<displayName>Application server installation directory</displayName>
</property>
<property name="ApplicationServerProfileFolder">
<value>/opt/IBM/profiles/AppSrv01</value>
<description>Enter the absolute path to the directory where the WebSphere Application Server profile for Content Platform Engine is stored. If you are installing Content Platform Engine on a node in a cluster or on a managed server node and Deployment Manager is remote from Configuration Manager, use the directory for the WebSphere profile that is located on the node.</description>
<displayName>Application server profile directory</displayName>
</property>
configmgr_cl storepasswords -profile myprofile
Repeat this step as needed to edit the application server properties for each Content Platform Engine instance directory that was created.
configmgr_cl generateConfig -task configurebootstrap -profile myprofile -bootstrap upgrade -appserver appserver_type
The bootstrap information that you define is stored in the configurebootstrap.xml and the deployapplication.xml files. However, the system saves a unique configurebootstrap.xml file each time the bootstrap information is generated. For example, the initial file name is configurebootstrap.xml. The subsequent file names are configurebootstrap.n.xml where "n" represents the number of each of the subsequent files in ascending numerical order.
If this is the first time that the bootstrap information has been generated:
If the bootstrap information has been previously generated:
JBoss example: <configuration class="com.ibm.ecm.configmgr.product.ce.task.UpgradeJBBootstrap">
configmgr_cl execute -task configurebootstrap -profile myprofile -taskfile configurebootstrap.2.xml
Status messages display in the console.
configmgr_cl checkStatus -task configurebootstrap -profile myprofile -taskfile configurebootstrap.n.xml
configmgr_cl checkStatus -task configurebootstrap -profile myprofile
ContentEngine\tools\configure\profiles\myprofile\ear
configmgr_cl execute -task deployapplication -profile myprofile
configmgr_cl checkstatus -task deployapplication -profile myprofile
Installation of this interim fix is now complete. Continue with the next section, Configuring the server after installation: Verifying the deployment of the updated Content Platform Engine EAR file.
Complete the following procedure to verify that Content Platform Engine deployed successfully:
http://server:port/FileNet/Engine
The defaults for the application server HTTP port number are as listed:
The following file is included in this interim fix:
Complete the following procedure to update Content Engine with the Jace.jar file.
Note: You use the Content Engine client installers to install the new jar that will come from the updated Content Engine server via the download service. It's important that the Content Engine server be already updated by this interim fix and be running. By following the client installation instructions below, this file will be installed on all clients that are supported by the client installer. This file is 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:
After you have updated the Content Platform Engine servers complete the following tasks for all of the Content Platform Engine-related Java EE applications, such as Application Engine, IBM FileNet Services for Lotus Quicker, and IBM Enterprise Records servers and any custom Content Platform Engine-related Java EE applications (like IBM Content Navigator).
The following table lists the names of the compressed fix client update files by operating system type:
Operating system type |
Name of compressed Content Platform Engine client update file |
|---|---|
| AIX |
5.5.0.0-P8CPE-CLIENT-AIX.tar.gz |
| Linux |
5.5.0.0-P8CPE-CLIENT-LINUX.tar.gz |
| Windows |
5.5.0.0-P8CPE-CLIENT-WIN.zip |
| zLinux |
5.5.0.0-P8CPE-CLIENT-ZLINUX.tar.gz |
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.
If you are running IBM FileNet P8, Version 5.2 or later, you can update the Content Platform Engine client connector files when you run the IBM Content Navigator Configuration and Deployment Tool.
Synchronize the Content Platform Engine server and client files in your Case Manager V5.2 system by running the "Update the Content Platform Engine Client Connector Files" task in the Case Manager V5.2 configuration tool.
If you have a custom application which uses the Content Platform Engine client files then follow the below instructions:
Installation errors are recorded in the ceclient_install_log_5.5.0.0.txt file, which is in the ceclient_install_path directory.
The installation and configuration of the client upgrade for this interim fix is complete.
Complete the following procedure to install the Content Platform Engine client updates silently.
The following table lists the names of the compressed fix client update files by operating system type:
Operating system type |
Name of compressed Content Platform Engine client update file |
|---|---|
| AIX |
5.5.0.0-P8CPE-CLIENT-AIX.tar.gz |
| Linux |
5.5.0.0-P8CPE-CLIENT-LINUX.tar.gz |
| Windows |
5.5.0.0-P8CPE-CLIENT-WIN.zip |
| zLinux |
5.5.0.0-P8CPE-CLIENT-ZLINUX.tar.gz |
Install this fix by running the following command that is appropriate for your operating system.
Operating system |
Command to install the Content Platform Engine server update |
|---|---|
| AIX |
5.5.0.0-P8CPE-CLIENT-AIX.BIN -i silent -f ceclient_silent_install.txt |
| Linux |
5.5.0.0-P8CPE-CLIENT-LINUX.BIN -i silent -f ceclient_silent_install.txt |
| Windows |
5.5.0.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.0.0-P8CPE-CLIENT-ZLINUX.BIN -i silent -f ceclient_silent_install.txt |
Installation errors are recorded in the ceclient_install_log_5.5.0.0.txt file, which is in the ceclient_install_path directory.
The installation and configuration of the client upgrade for this interim fix is complete.
This interim fix does not have an uninstall option.
The following table lists the product fixes for this limited availability fix.
APAR |
Description |
|---|---|
PJ44316 |
Process Engine (PE) Handle java.lang.NullPointerException thrown by UserServer.writeObjectsInternal. |
PJ45146 |
PSIRT 12005 (CVE-2018-1844): External DTD vulnerability with FileNet Deployment Manager. See security bulletin 0732755 |
PJ45334 |
PSIRT 11720: (CVE-2018-1542), PSIRT 11721 (CVE-2018-1555), PSIRT 11722 (CVE-2018-1556): Administration Console for Content Platform Engine (ACCE) Cross-site scripting vulnerability. See security bulletin 2015943 |
PJ45337 |
PSIRT 12022 (CVE-2018-2768, CVE-2018-2806, CVE-2018-2801): Open Source Oracle Outside In Technology Vulnerabilities - April 2018. See security bulletin 2015721 |
PJ45429 |
PSIRT 11709 (CVE-2012-5783): HttpClient security vulnerability. See security bulletin 0731533 |
PJ45439 |
E_UNEXPECTED_EXCEPTION occurs when viewing documents with auditing enabled. |
PJ45440 |
PSIRT 12599 (CVE-2018-8036): Apache PDFBox vulnerabilities. See security bulletin 0716315 |
PJ45460 |
PSIRT 12766 (CVE-2018-2992, CVE-2018-3093, CVE-2018-3094, CVE-2018-3095, CVE-2018-3096, CVE-2018-3097, CVE-2018-3009, CVE-2018-3010, CVE-2018-3092, CVE-2018-3098, CVE-2018-3099, CVE-2018-3102, CVE-2018-3103, CVE-2018-3104): Open Source Oracle Outside In Technology Vulnerabilities - July 2018. See security bulletin 0718295 |
PJ45534 |
PSIRT 13565 (CVE-2018-11797): Apache PDFBox vulnerabilities. See security bulletin 0734711 |
PJ45567 |
Error from ACCE when attempt to SAVE change to System User password without also modifying System User name. |
APAR |
Description |
|---|---|
PJ45272 |
Timeout issue in Administration Console for Content Platform Engine (ACCE) in Docker Container environment - issue resolved in ICN toolkit 3.0.2 LA2. |
PJ45212 |
Asynchronous replication to remote site or multiple async replicas fail for advanced storage area. |
PJ45273 |
Upgrade error on continuity_data_name corrected to continuity_data. |
APAR |
Description |
|---|---|
PJ45039 |
Security Script Wizard updates the security on subfolders. |
PJ45042 |
Isilon session idle timeout handling fix. |
PJ44953 |
Administration Console for Content Platform Engine (ACCE) takes too long to expand an Object Store. |
PJ45055 |
PSIRT 10042 (CVE-2016-1000031): Open Source Apache Commons FileUpload Vulnerability. See techdoc 2010868. |
PJ45057 |
Snaplock Delete using Java File I/O leaves entry in the Content Queue. |
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.
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.
| Date |
Description |
|---|---|
| 20 December 2018 |
Initial release of this limited availability fix. |