Preventive Service Planning
Abstract
This document summarizes changes and corrections to the OmniFind Enterprise Edition, Version 9.1 information center.
Product overview
There are currently no changes or corrections to the product overview information.
Installing
This section contains changes or corrections to the installation information.
Web application server requirements
The planning for installation information correctly states that WebSphere Application Server is not required for fresh installations. However, even if you use WebSphere Application Server, the embedded Jetty web application server is required for certain functions. For example, the Jetty server is used for administration, monitoring, and the search functions for both search collections and classic search collections. (ESAdmin, ESSearchServer, and the customization applications run on the embedded application server.) You can use WebSphere Application Server to support classic search collections, but the functions that became available for search collections in Version 9.1 require the embedded Jetty web application server.
The installation steps in the Quick Start Guide do not instruct you to extract files for your operating system before you start the installation program. The revised steps are:
1. Insert the IBM OmniFind Enterprise Edition DVD.
2. Copy the archive file for your operating system (windows.zip, linux.tar, aix.tar, solaris.tar, zlinux.tar, or windowsagentserver.zip) to the server where you want to install the product and extract all files.
3. Change to the directory where you extracted the files.
4. Enter the following command, click Install Product, and launch the installation program: - AIX, Linux, or Solaris: ./launchpad.sh - Windows: launchpad.exe
The link to the topic about upgrading to version 9.1 is incorrect. The correct page is Upgrading to OmniFind Enterprise Edition, Version 9.1.
Installation and data directories
The default installation directory on AIX is /opt/IBM/es, not /usr/IBM/es, as documented in this topic.
Administrator ID and password
When you install the product as a non-root user, you do not need to restart the computer after the installation program is completed. The First Steps program automatically starts after the installation program ends.
The OmniFind Enterprise Edition administrative user ID must have read access to the parent directories of the installation and data directories. For example, if the installation directory (ES_INSTALL_ROOT) is the /opt/IBM/es directory, then the OmniFind Enterprise Edition administrative user must have read access to the /opt and /opt/IBM directories.
Administrator ID and password: Windows domain IDs
The Windows domain IDs section of this topic contains incorrect information about the differences between a local ID, a domain ID with a local profile, and a domain ID with a roaming profile. Here is the correct information:
Windows domain IDs
If you want to use a Windows domain user account for the default OmniFind Enterprise Search administrator, you must create the domain ID in advance. The default application administrator ID must be either a local ID or a domain ID with a local profile. A domain ID with a roaming profile is not supported.
When you install the product, specify the existing domain ID as the default administrator ID in the following format:
user_name@fully_qualified_domain_name
Local ID or domain ID with a local profile
For a local user ID or a domain ID with a local profile, the user's local profile is stored on the local computer. Any changes made to the local user profile are specific to the computer on which the changes are made. These are the only types of user IDs that can be used as the default administrator ID.
To obtain domain privileges for an ID, you can add the local user ID that you use for the administrator ID to a domain. If you add the local user ID to a domain, however, you must ensure that the domain security rights do not override the local user rights that are required by OmniFind Enterprise Edition (which are listed later in this topic).
Domain ID with a roaming profile
For a domain ID with a roaming profile, a copy of the user's local profile is stored on a shared server. This shared profile, which is known as a roaming user profile, is downloaded whenever the user logs on to any computer on the network. Changes made to the profile are synchronized with the server copy when the user logs off. The default administrator ID cannot be this type of user ID.
Upgrading to OmniFind Enterprise Edition, Version 9.1
A final step is missing from this procedure. After you crawl, parse, and index your collections, you must start the search servers. The search servers are not automatically started after you upgrade your system. For quick reference, use these URLs to open the search and administration interfaces:
- Search application for classic search collections: http://IP address/ESSearchApplication
- Search application for search collections: http://IP address/search
- Administration console: http://IP address:8390/ESAdmin
Mapping collection data to CIFS drives
Some of the information in this topic applies specifically to classic search collections or search collections.
Bullet 2 applies to classic search collections only: In a multiple server installation, different servers must use the same network drive letter but map to different physical locations. You cannot map to the same physical location from different OmniFind Enterprise Edition servers.
In Examples, the example for mapping different servers to the same physical location is valid for search collections only:
Correct for search collections only: Different servers map to the same physical location
Index server: ES_MAP_DRIVE=T:\\server1\dir1
Search server: ES_MAP_DRIVE=T:\\server1\dir1
Step 5 in the published procedure is not required. After you install the OmniFind Enterprise Edition software on an additional server, do the following steps to complete the installation:
5. Windows only: Restart the server.
6. Log in as the OmniFind Enterprise Edition administrative user and start the common communication layer (CCL) service:
- On AIX, Linux, or Solaris, enter: startccl.sh -bg
- At a Windows command prompt, enter: startccl
- Using the Windows Services administrative tool to start the CCL in the background: 1. Start Windows Services: Start > Programs > Administrative Tools > Services. 2. Right-click IBM OmniFind Enterprise Edition and click Start.
7. Verify that the CCL port is on listen mode (for example, use the netstat -na command). Also verify that the host name is updated on the domain name server (DNS) and that it can be pinged from the master server.
8. If you installed a high availability server, follow the procedures in the information center to configure high availability on Windows or AIX.
9. Use the administration console on the master server to assign an appropriate role for the additional server.
You cannot install the Agent for Windows file systems on the same machine where you install the main OmniFind Enterprise Edition components. The diagram of supported configurations in this topic shows the agent server installed on remote machines, but does not explicitly state this restriction.
Administering
This section contains changes or corrections to the administration information.
Index administration for classic search collections
The framework for indexing content in classic search collections will not be supported in future releases. When you create new collections in OmniFind Enterprise Edition, Version 9.1, create search collections, not classic search collections. In addition, you should migrate your classic search collections to the search collection framework. For details, see Migrating your collections.
Index administration for search collections
As discussed in this topic, index partitions can enhance performance and enable the system to scale millions of documents. To avoid performance degradation, keep each partition to less than 20 million documents. For example, an index with 40 million documents might require 10 seconds for search results to be returned. If you expect such a collection to grow, you can achieve better performance by creating three index partitions with up to 15,000 documents in each partition.
The ability to schedule duplicate document detection is not supported. Disregard references to scheduling duplicate document detection in the product documentation.
Configuring the crawler server for FileNet P8 crawlers
The first two steps in this task are transposed. You must install the IBM FileNet Content Engine Client on the crawler server and then log in as the OmniFind Enterprise Edition administrator on the crawler server.
Generating thumbnails on AIX
Use the following troubleshooting tips if thumbnail images do not appear in the search results after you follow the procedure in this topic:
- Ensure that the document cache and thumbnail support are enabled for the collection.
- Ensure that the X windows system is running and the fonts are set up correctly.
- Ensure that you restarted the OmniFind Enterprise Edition system. You must also either rebuild the index from the document cache or recrawl the data sources from which you want to generate thumbnail images.
Seed list crawlers
If you install OmniFind Enterprise Edition Version 9.1 Fix Pack 1, support is extended to Lotus Connections 3.0 and you can select that version when you use the administration console to configure a Seed list crawler. The guidelines for crawling Lotus Connections sources that are discussed in this topic apply to Lotus Connections 3.0 sources.
Enabling advanced analysis for compound terms
The fourth paragraph of this topic presents an example that instructs you to not enable advanced analysis of compound terms. The correct instruction is to enable this feature, as stated below:
For another example, the compound Mustermann is split into two tokens (muster and mann) that are stored separately in the index. When the wildcard query Musterma* is entered, the search processes cannot identify Musterma as a prefix of a decompounded word. As a result, documents with the term Mustermann are not found. If you want users to be able to enter wildcard queries for compound terms, enable advanced analysis of compound terms.
When describing how the system determines the document type and parser type, step 'a' incorrectly states that the file name or URL extension is compared to the rules in the mimetypes.xml file. Actually, the URL extension (that is, the extension of the document ID) is used only if the file name is not specified.
Support for SSO authentication products
Several administration topics and administration help topics refer to other products with regard to single sign-on authentication. For example:
If you use another product to protect your WebSphere Portal server and Web sites (such as IBM Tivoli Access Manager WebSEAL or CA SiteMinder SSO Agent for PeopleSoft), specify single sign-on credentials that enable the crawler to access documents on the server.
To clarify, support for these authentication products in OmniFind Enterprise Edition is limited to the crawler's ability to use SSO authentication when accessing a secure server to collect content. These products cannot be used to implement SSO authentication for performing secure search without configuring My Profile settings in the search application.
This restriction applies to the Seed list, Web Content Manager, and WebSphere Portal crawlers and the following data source types:
- Lotus Connections
- Lotus Quickr Services for WebSphere Portal
- Lotus Web Content Management (formerly Workplace Web Content Management)
- WebSphere Portal
Gathering information for problem analysis
The name of an option that you can specify with the esservice command contains a typographical error.
Incorrect: -nocores
Correct: -nocore
Configuration files for search applications
This topic correctly states that you cannot use the customizer to configure search applications that you run as portlets in WebSphere Portal. However, the topic does not make it clear that you can customize search applications that you run as portlets by editing configuration file properties.
In addition, the following properties are documented incorrectly. To search specific collections or a specific faceted collection by default, specify the collection name, not the collection ID.
- preferences.defaultCollections=* | space_separated_list_of_collection_names
Specify an asterisk (*) to enable all collections to be searched. The collections must be associated with the application in the administration console. This is the default setting in the config.properties file.
To restrict what users will search if they do not modify their preferences or advanced search options, specify the names of the collections (not the collection IDs) that you want users to search by default. If you want to use this feature, ensure that the collection names do not contain spaces. For example:
preferences.defaultCollections=*
preferences.defaultCollections=collection1 collection2
- preferences.defaultFacetedCollection=* | collection_name
For a search application, specify an asterisk (*) to enable all collections that support facets to be searched or specify the collection name (not the collection ID) for the faceted collection that you want users to search by default. If you want to use this feature, ensure that the collection name does not contain spaces.
The properties that are documented in this topic represent properties that you might want to customize; not all properties are documented. The following property descriptions, which were omitted from this topic, might also be useful for customizing your search applications and search portlets:
- documentLabelTree.enable=False
This property controls whether the category tree is shown in the search results. If the value is set to False, the category tree is not displayed.
- preferences.returnCategories=Others
If this value is set to All, the application returns search results with category information.
- removeDisabledIdentityFromIMC=True
This property configures the Identity Management Control (IMC) database for secure search. If the value is set to True, the user entry in the IMC is deleted when the searchable object is disabled at the time user entries are validated.
- removeInvalidIdentityFromIMC=True
This property configures the IMC database for secure search. If the value is set to True, the user entry in the IMC is deleted when validation fails.
Custom filters
If you are customizing a search application, disregard the Custom filters section of this topic. The ability to configure queries to filter results is supported for classic search applications. You cannot configure custom filters for search applications.
Overriding no-follow and no-index directives in Web pages
The Web crawler tries to observe the Robots Exclusion Protocol and will not use the followindex.rules file if the Web page includes a META robots tag. The followindex.rules file is used to define additional robots rules for pages that do not contain META robots. If the page includes a META robots tag such as <meta name="robots" content="noindex, nofollow">, the page will not be crawled. For more information, see https://www.ibm.com/support/docview.wss?uid=swg21512261.
Configuring the crawler server on UNIX for DB2 crawlers
Configuring the crawler server on Windows for DB2 crawlers
These topics instruct you to install the DB2 Administration Client before you run the escrdb2 setup script on the crawler server, but a DB2 client program by that name does not exist. The correct instructions are:
To crawl IBM DB2 Version 9.1 databases, install the DB2 Client before you run the setup script. To crawl IBM DB2 Version 9.5 or Version 9.7 databases, install the DB2 Data Server Client before you run the setup script.
For related information see DB2 Data Server Client must be installed to set up the DB2 crawler.
Crawling multiple structured JDBC database tables
Corrections to this procedure are available at https://www.ibm.com/support/docview.wss?uid=swg21515912.
Web crawlers: Crawling .docm documents that include queries
If the URL for a .docm document includes a query string, the content is not indexed. To solve this problem:
1. Log in as the default OmniFind Enterprise Edition administrator on the controller server and edit the mimetypes.xml file in the ES_NODE_ROOT/master_config/collectionID.indexservice directory.
2. Add the following lines under the /Mimetypes/MimetypeNormalization element:
<NormalizedMimetype Name="application/vnd.ms-word.document.macroEnabled.12">
<Mimetype>application/vnd.ms-word.document.macroenabled.12</Mimetype>
</NormalizedMimetype>
3. Save your changes and then restart the OmniFind Enterprise Edition system.
4. Start the Web crawler to run a full crawl and parse the content again.
Notes crawlers: Crawling attachments
You want to crawl Lotus Notes documents that include attachments, and you configure scopes so that only the URL for the attachment is displayed in the search results. The title that is displayed for the attachment is incorrect and inconsistent. For example, it might contain the value Title Subtitle, the first line of the attached PDF or Word file, or the file name.
Use either of the following approaches to solve this problem:
Disable extraction of the title document property within the Stellent parser:
1. In the administration console, ensure that the field that contains the title to be displayed is mapped to a title search field. For example, map the F_Title field to the title search field.
2. In the administration console, stop the parser and index.
3. Log in as the default OmniFind Enterprise Edition administrator on the controller server and edit the parser_config.xml file in the ES_NODE_ROOT/master_config/collectionID.indexservice directory.
4. Add the field.name.title parameter under the ParserFactoryClass element:
<Parser>
<ParserName>stellent</ParserName>
<ParserFactoryClass>com.ibm.es.oze.indexservice.internal.ParserFactory$OutsideIn
</ParserFactoryClass>
<Parameter Name="field.name.title"></Parameter>
</Parser>
5. In the administration console, start the parser.
6. Re-crawl and re-parse the documents.
Customize the search application:
You can customize the source code of the provided search application. For example, in the administration console, map the F_Title field to a new search field, such as alternativeTitle. Then, customize the application so that it always shows alternativeTitle as the document title that users can click in the search results.
The description of case sensitivity for dictionaries is incorrect. The correct behavior depends on the dictionary type:
Dictionaries
Case-insensitive. This rule applies to spelling suggestion dictionaries.
Case-sensitive. This rule applies to synonym dictionaries, stop word dictionaries, and boost word dictionaries.
Configuring support for Data Listener applications
The SIAPI administration APIs are being deprecated along with the Data Listener APIs. Use the REST APIs to develop custom administration applications, not the SIAPI administration APIs.
Configuring search fields for field values that are published in a Lotus Connections seed list
When you create search fields from a seed list, and the seed list field value attribute name has a space in it, you must replace the space with an underscore character. In the following example, use Forum_UUID, not Forum UUID:
<wplc:fieldInfo id="FORUM_UUID" name="Forum UUID" description="Forum UUID"
Wildcard characters in search collections
When you configure wildcard character options, the only option that you can specify is how many variations of the query term qualify as a match. Disregard the statements in this topic about choosing how wildcard support is to be provided. Wildcard characters can occur anywhere in the query term. To limit the wildcard to the final character in a query term, use the % wildcard symbol (for example, ab% returns aba, abb, abc, and so on).
Security
This section contains changes or corrections to the information about secure search.
Enabling security for a single server system in WebSphere Application Server
Enabling security for a multiple server system in WebSphere Application Server
The config.properties file no longer contains entries for specifying the WebSphere Application Server user name and password. Disregard the instruction about ensuring that the config.properties file contains those values.
Search technology integration
This section contains changes or corrections to the search technology integration information.
Supported versions of WebSphere Portal
The WebSphere Portal crawlers topic contains misleading text:
"To crawl sites on a WebSphere Portal, Version 6.1 server, you must configure a Seed list crawler. You can continue using the WebSphere Portal crawler to crawl earlier versions of WebSphere Portal."
Disregard the second sentence. OmniFind Enterprise Edition does not support any versions of WebSphere Portal earlier than Version 6.1. For the most current information about supported products and versions, see Supported data sources.
WebSphere Portal clustered system integration
The topics about running the integration scripts in a WebSphere Portal clustered system and removing OmniFind Enterprise Edition from a WebSphere Portal clustered system show incorrect syntax for the WPSHost parameter. In the description of the parameter and the sample code, it is not clear that the host name and port must be separated by a colon, for example: portalserver.ibm.com:10040
In addition, step 2 in the Running the WebSphere Portal clustered system integration scripts topic states that you must run the script: wp61_cluster_copyFiles script. Missing from the instruction is that this script must be run on all WebSphere Portal nodes in the cluster.
The script mentioned in step 3 (wp61_cluster_install) needs to be run only on the primary node in the cluster.
If you use WebSphere Portal 6.1.5, see updated information in Integrating a WebSphere Portal 6.1.5 cluster environment with OmniFind Enterprise Edition.
Integration with WebSphere Portal 7.0 or 8.0
If you use OmniFind Enterprise Edition Version 9.1: The topics that discuss integrating OmniFind Enterprise Edition with WebSphere Portal include several references to WebSphere Portal 7.0. Disregard those references, including references to running setup scripts and removing the integration. For the most current information about supported products and versions, see Supported data sources.
If you apply OmniFind Enterprise Edition Version 9.1 fix packs: Beginning with Fix Pack 1, support is extended to WebSphere Portal 7.0 and Lotus Quickr for WebSphere Portal 8.5. Beginning with Fix Pack 4, support is extended to WebSphere Portal 8.0. The following table replaces the WebSphere Portal support matrix in Running the WebSphere Portal integration scripts:
| Supported versions | Required JAR file | Setup script | Install option | Functions |
| WebSphere Portal V8.0 Requires V9.1 Fix Pack 4 or a later Fix Pack | es.wp80.install.jar | wp80_install.bat wp80_install.sh | Sets up a portlet for searching search collections. Also supports Search bar and Search Center integrations. | |
| WebSphere Portal V7.0 Requires V9.1 Fix Pack 1 or a later Fix Pack | es.wp70.install.jar | wp70_install.bat wp70_install.sh | Sets up a portlet for searching search collections. Also supports Search bar and Search Center integrations. | |
| WebSphere Portal V6.1.0.3 and V6.1.5 | es.wp61.install.jar | wp61_install.bat wp61_install.sh | Sets up portlets for searching classic search collections and search collections. Also supports Search bar and Search Center integrations. | |
| Lotus Quickr for WebSphere Portal V8.5 Requires V9.1 Fix Pack 1 or a later Fix Pack | es.wp61.install.jar | wp61_install.bat wp61_install.sh | -InstallType quickr | Sets up a portlet for searching Lotus Quickr sources. |
| Lotus Quickr for WebSphere Portal V8.0 and V8.1 | es.qkr80.install.jar | qkr80_install.bat qkr80_install.sh | Sets up a portlet for searching Lotus Quickr sources. |
For related integration information, see Integrating a WebSphere Portal 7.0 or 8.0 cluster environment with OmniFind Enterprise Edition.
Attention: Step 3 in the procedure for Configuring the WebSphere Portal Search bar is incorrect for WebSphere Portal 7.0 and WebSphere Portal 8.0, which do not include the Enhanced_Theme.ear file in the installedApps/cell_name directory.
WebSphere Portal 7.0:
The default theme in WebSphere Portal 7 is called wp.mashup.cc.theme.ear (also known as PageBuilder2) at this default location:
WPS_INSTALL_ROOT/theme/wp.mashup.cc.theme/installedApps/wp.mashup.cc.theme.ear/
PageBuilder2.war/themes/html/PageBuilder2
The file that contains the code stanza to be modified is search.jsp.
WebSphere Portal 8.0:
The default theme in WebSphere Portal 8 is called Portal 8.0 at this default location:
WPS_INSTALL_ROOT/theme/wp.theme.modules/webapp/installedApps/ThemeModules.ear/ThemeModules.war/themes/html
The file that contains the code stanza to be modified is dynamicSpots/modules/search/search.jsp.
Text analysis integration
There are currently no changes or corrections to the information about text analysis integration.
Maintaining
There are currently no changes or corrections to the maintenance information.
Developing
This section contains changes or corrections to the application development information.
The SIAPI Administration APIs and Web Services APIs are being deprecated and will not be supported in future releases. To develop custom administration applications, use the REST Administration and Search APIs, not the SIAPI APIs or Web Services that are discussed in the OmniFind Enterprise Edition information center or Javadoc documentation. Information about using the REST APIs is available in the ES_INSTALL_ROOT/docs/api/rest directory. The Search APIs continue to be supported.
SIAPI methods to use in place of the data listener API
Disregard this topic. The SIAPI administration APIs are being deprecated along with the Data Listener APIs. Use the REST APIs to develop custom administration applications.
This topic is missing information and contains incomplete information about some properties:
HighlightingMode: Enables query terms to be highlighted in several areas of the search result details. Values are:
- DefaultHighlighting: This is the default value and it is equivalent to ExtendedHighlighting.
- ExtendedHighlighting: Extends the highlighting of query terms to other areas of the search result, such as the title, URL, and other fields.
- SummaryHighlighting: Highlights query terms in the document summary only.
FuzzyNGramSearch: Fuzzy search enables a non-strict search in n-gram collections to be performed. This property is Boolean and its values are:
- false: A strict search will be performed. This is the default if your search application does not set the FuzzyNGramSearch property.
- true: Fuzzy search will be performed. See Enabling fuzzy searches in n-gram collections for details.
XML schema associated with the WSDL file
In these topics, the WSDL URL should be: http://your_search_server:8394/wsdl/com/ibm/es/ws6/server/search/ofsearch.wsdl
Specifying the number of relevant results
Sorting by relevance, date, numeric fields, or text fields
These topics include examples for using the SORT_ALL_RESULTS value of the setSortPoolSize method. However, SORT_ALL_RESULTS is applicable only to classic search collections. There is no need to use this value with search collections because all results are always sorted.
Samples
This section contains changes or corrections to the sample program information.
Sample administration applications
The SIAPI Administration APIs and Web Services APIs are being deprecated and will not be supported in future releases. To develop custom administration applications, use the REST Administration and Search APIs, not the SIAPI APIs or Web Services that are discussed in the OmniFind Enterprise Edition information center or Javadoc documentation. Sample scenarios for using the REST APIs are available in the ES_INSTALL_ROOT/samples/rest directory. The Search APIs continue to be supported.
Reference
There are currently no changes or corrections to the reference information.
Troubleshooting
There are currently no changes or corrections to the troubleshooting information.
Help system
This section contains changes and corrections to the help system. You can access the online help from the Help link on any page in the administration console or search application.
Specify the JDBC Database page
JDBC Database Driver page
Administration console help: When you configure a JDBC database crawler to crawl Microsoft SQL Server 2008 databases, select Generic JDBC database or SQL Server 2005 for the JDBC database type and specify com.microsoft.sqlserver.jdbc.SQLServerDriver as the JDBC driver name.
Create a Quick Link page
Administration console help: The description of the document ranking does not make it clear that a lower document rank value can cause the quick link to appear higher in the search results. The revised description of this field is:
Document rank
Type an integer that can help determine the position of this quick link in relation to other quick links in the search results.
For example, if you have multiple Human Resource organizations, you can rank the URI for your central organization higher than quick links that you create for division-specific or geographically-specific organizations by specifying a lower document rank value for the central organization. When quick links are displayed to the left of documents in the search results, the URI for the central Human Resource organization appears before the quick links to other Human Resource organizations.
For example, a quick link where the document rank is set to 1 appears before a quick link where the document rank is set to 10.
Parse and Index Details page
Administration console help: When you monitor parse and index activity for a search collection, you can select an option to reorganize the index. The description of reorganizing the index is incomplete. Reorganizing the index defragments fragmented index files but does not change the indexed files. In addition, reorganizing the index does not immediately reduce the size of the index. The index size is reduced when you restart the indexing services for the collection.
Narrowing results by selecting facets or categories
Search application help: The Boolean search logic that is applied when you add facet values to a search is unclear:
- If you select multiple facet values, such as FacetA/dog and FacetB/cat, and add them to the search, the query is processed as a Boolean AND request: "FacetA/dog FacetB/cat"
- If you select multiple subfacet values from the same facet, such as FacetA/dog and FacetA/cat, the query is processed as a Boolean OR request: (FacetA/dog OR FacetA/cat)
Related Information
[{"Product":{"code":"SS5SQ7","label":"OmniFind Enterprise Edition"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"--","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"9.1","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]
Was this topic helpful?
Document Information
Modified date:
17 June 2018
UID
swg21421174