Readme file for: IBM® FileNet® P8 Content Search Services
Update name: 5.1.0.0-P8CSS
Fix ID: 5.1.0.0-P8CSS-IF006
Publication date: 1 November 2013
Last modified date: 1 November 2013
This interim fix includes the Oracle Outside In Technology (OIT) 8.4.1 patch 17206068_841_003 to Content Search Services server (CSS) 5.1.0.0. The Outside In Technology binaries apply to the Content Search Services server for each supported platform.
This interim fix also updates the lucene-core-3.0.3.jar file, the whitney_core.jar file, and the platform-specific scripts for dumpIndex and setup.
In addition, this interim fix updates the IBM Java™ Software Developer's Kit (SDK) Version 1.6 to SR13 FP2.
This interim fix requires:
Click the following link to access the files for this interim fix server update: Fix Central for Interim Fix 5.1.0.0-P8CSS-IF006.
Complete the following steps in the appropriate section to install this interim fix:
Tip You can safely install this interim fix even if you have virus protection software that is running in the background.
/css_installation_location/server_name/bin/shutdown.sh
Restrictions
Do not rename the lucene jar provided in this interim fix. The new name is expected by the scripts in the bin directory.
Do not copy the collection.xml file into existing text search index directories.
Important: "text_search_index_directories" can be determined by first locating the root directory of an index area. If you do not know the location of the root directory, it can be determined by looking at the index area's Root Directory Path property of the object store using FileNet Enterprise Manager. Under the Root Directory Path, there is one subfolder for each index.
An Object Store can have one or more index areas, and an index area can have one or more text search indexes, each of which has a dedicated copy of the parser_config.xml file. For example, if your index area has a root directory /opt/Collections, then the location of the existing parser_config.xml would look something like: /opt/Collections/textSearchIndexXXX/parser_config.xml, where textSearchIndexXXX represents the actual index directory.
css_installation_location\server_name\bin\shutdown.bat
Restrictions
Do not rename the lucene jar provided in this interim fix. The new name is expected by the scripts in the bin directory.
Do not copy the collection.xml file into existing text search index directories.
Important: Each of the "text_search_index_directories" can be determined by first locating the root directory of an index area. If you do not know the location of the root directory, it can be determined by looking at the index area's Root Directory Path property of the object store using FileNet Enterprise Manager. Under the Root Directory Path, there is one subfolder for each index.
An Object Store can have one or more index areas, and an index area can contain one or more text search indexes, each of which has a dedicated copy of the parser_config.xml file. For example, if your index area has a root directory \\ServerShare\Collections, then the location of the existing parser_config.xml would look something like: \\ServerShare\Collections\textSearchIndexXXX/parser_config.xml, where textSearchIndexXXX represents the actual index directory.
Tip When you use a Windows service, use the batch files to start and stop the Content Search Services Windows Service.
To fix a potential performance problem, you must update the collection.xml files with the edits shown in Edit the collection.xml file. You should modify all collections; you will find the collection.xml file in the following locations:
New collections: installation_location/config/defaults/collection.xml
The installation_location specifies the directory path where the Content Search Services software is installed.
Existing collections: text_search_index_directories/collection.xml
The text_search_directories specifies the administrator-specified root directory paths on each index area that is associated to an object store.
The path to the collection.xml file can be determined using the the "Root Directory Path" property of each of the IndexAreas under each ObjectStore in FileNet Enterprise Manager. The path can be different on each IndexArea, so there might be several places to look for a collection.xml file. Under the Root Directory Path, there is one subfolder for each index, and within each index there is a collection.xml file that must be edited.
Make the following changes in all collection.xml files:
Tip: Change the MaxMerge config properties only if you do not have 5.1.0.0-P8CSS-IF003 or higher installed.
From:
<property name="MergeFactor" value="5"/>
<property name="MaxMergeMB" value="10000"/>
To:
<property name="MergeFactor" value="10"/>
<property name="MaxMergeMB" value="4000"/>
$ chmod +x textExtractor
Important: Java SDK 6.0 SR13 FP2 files must only be installed once.
For Solaris, extract the content of sol6460sr13fp2hydrid-20130429_01-sdk.zip into the new css_installation_location/Java60 directory.
$ cd Java60/jre/bin
$ chmod 777 *
$ java -version
For example, the following display on a Windows 7 server indicates that the Java Runtime Environment is now SR13 FP2.
<JAVA_HOME>\jre\bin\java.exe -version
java version "1.6.0"
Java(TM) SE Runtime Environment (build pwa6460sr13fp2-20130424_01(SR13 FP2))
IBM J9 VM (build 2.4, JRE 1.6.0 IBM J9 2.4 Windows 7 amd64-64 jvmwa6460sr13fp2-2
0130423_146146 (JIT enabled, AOT enabled)
J9VM - 20130423_146146
JIT - r9_20130108_31100ifx1
GC - 20121212_AA)
JCL - 20130419_01
<JAVA_HOME>\jre\bin>./java com.ibm.xml.xlxp.scan.Version
1.1.17 (built Sun, 22 Apr 2012 13:01:43 EDT)
For comparison, before you install the update, the -version output shows SR9 FP1.
<JAVA_HOME>\jre\bin\java.exe -version
java version "1.6.0"
Java(TM) SE Runtime Environment (build pwa6460sr9fp1-20110208_03(SR9 FP1))
IBM J9 VM (build 2.4, JRE 1.6.0 IBM J9 2.4 Windows 7 amd64-64 jvmwa6460sr9-20110
203_74623 (JIT enabled, AOT enabled)
J9VM - 20110203_074623
JIT - r9_20101028_17488ifx3
GC - 20101027_AA)
JCL - 20110203_01
<JAVA_HOME>\jre\bin>./java com.ibm.xml.xlxp.scan.Version
1.1.14 (built Tue, 9 Feb 2010 00:45:42 EST)
AIX, Linux, Solaris (all supported versions)
Run the following script:
/css_installation_location/server_name/bin/startup.sh
Windows (32 bit and 64 bit)
Start the Content Search Services Windows service, or run the following script:
css_installation_location\server_name\bin\startup.bat
This interim fix does not have an uninstall option. You can return to the prior release level by manually restoring the files that you backed up earlier:
AIX, Linux, Solaris (all supported versions)
Windows (32 bit and 64 bit)
To restore the backed up Oracle Outside In Technology directory:
To restore the backed up Java SDK:
Important: Only users who have Java 6.0 SR13 FP2 or higher installed can restore to prior versions.
The following tables list the product fixes that are in this interim fix update.
| APAR |
Description |
|---|---|
PJ41369 |
Limit textExtractor memory consumption on Solaris, AIX, and Linux. |
PJ41379 |
Occasionally Content Search Services (CSS) indexing might experience a large delay in the indexing performance on NAS devices. |
PJ41471 |
Content Search Services (CSS) indexing that uses Oracle Outside In Technology (OIT/INSO) on Linux uses incorrect system TEMP (i.e., /tmp) instead of CSS TEMP folder. |
PJ41554 |
Upgrade OIT from 8.3.7 to 8.4.1. |
PJ41555 |
Windows service status does not reflect the real status of the CSS server when the java.exe process crashed. |
| APAR |
Description |
|---|---|
NA |
IBM Content Collector searches and IBM eDiscovery Manager compliance searches might not return correct results for documents that contain a certain combination of Japanese characters. |
PJ40770 |
Unable to start a server that uses a secure port and constructor that uses Secure Socket Layers (SSL). |
PJ40929 |
Content Search Services indexing content retrieval causes excessive socket time-out waits. |
PJ40964 |
Content Search Services needs an option to enable logging during index write operations to detect index corruption. |
PJ40973 |
Content Search Services must close the socket in case of a socket exception or an incomplete read operation. |
PJ40999 |
The Temp folder is not cleaned when the text extractor is stopped. |
PJ41155 |
Content Search Services needs configurable parameters to reduce search and indexing memory consumption. |
PJ41164 |
On the Content Search Services server, certain zip files cause long extraction times. |
PJ41173 |
Content Search Services eDiscovery Manager searches do not return the expected results. |
PJ41192 |
Content Search Services requires search performance improvements: optimization for search and configuration of searchable refresh rate. |
PJ41316 |
A JDK bug causes a Content Search Services "Out of Memory" error during indexing. |
| APAR |
Description |
|---|---|
PJ40964 PJ41093 |
Content Search Server full-text indexes might be corrupted when using Lucerne 3.0.2. |
| APAR |
Description |
|---|---|
NA |
Content Based Retrieval (CBR) performance improvements to Content Search Services (CSS). |
NA |
Content Search Service (CSS) server service in Windows does not reflect the current status of CSS server. |
NA |
Add indexing parameter MaxConcurrentIndexingCollections. |
NA |
Add Max Collections parameter MaxConcurrentIndexingCollections. |
PJ40574 |
IBM Content Collector (ICC) CSS Text Extractor fails on Supported file type PDF; multiple ibmfndcm.exe processes cause high CPU usage. |
PJ40597 |
Concatenate the mime type into the document text in case a document is processed by the constructor. |
PJ40641 |
Portable Document Format (PDF) files consume excessive swap space memory, and TextExtractors do not exit normally. |
PJ40744 |
Index HTML documents with password-protected and encrypted attachments. |
| APAR |
Description |
|---|---|
NA |
Significant degradation occurs in Content Based Retrieval search time when searches run concurrently with indexing. |
NA |
Host validation fails for Content Search Services (CSS) Secure Sockets Layer (SSL) when using CA signed certificate and the hostname is not in the Issuer field of the certificate field. |
NA |
A java.lang.OutOfMemoryError is returned in IBM Content Collector (ICC) email search tests. |
NA |
Content Search Services memory consumption in IBM Content Collector (ICC) email search tests is higher than expected |
NA |
Performing a CBR Query that contains a large number of 'OR' terms read together returns a 'IQQG0020E Wrong Header Len' exception. |
NA |
Disk space is not released after index optimization. |
NA |
IBM Content Collector (ICC) search tests against Content Search Services full text indexes showed high search response times and high CPU cost on Content Search Services server. |
PJ39647 |
A Content Search Services Handshake test returns an erroneous severe level error message in the Content Search Services Server log. |
| APAR |
Description |
|---|---|
| NA |
Content Search Services I/O errors occur during concurrent indexing and content-based retrieval search tests. |
NA |
Out-of-memory errors occur during content-based retrieval longevity tests that have concurrent indexing. |
NA |
The NOT operator does not work correctly when used with parenthesis. |
NA |
A Content Engine indexing job for IBM Content Collector (ICC) emails timed out after 12960 seconds. |
NA |
Temporary Content Search Services (CSS) indexing files are not removed during ICC indexing which can cause out-of-space errors. |
NA |
In IBM Content Collector email indexing tests, certain valid zip files were handled as invalid by the Content Search Services ZipParser. |
NA |
Out-of-memory error occurred when indexing large email attachment through ICC constructor. |
NA |
A java.lang.StringIndexOutOfBoundsException: String index out of range encountered in email P8-Content Search Services indexing through ICC constructor occurred. |
NA |
Content Search Services memory (used heap) grows over time in search only tests against a static index. |
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, FileNet, 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 |
|---|---|
1 November 2013 |
Initial release of this interim fix. |