Preventive Service Planning
Abstract
This document summarizes changes and corrections to the OmniFind Enterprise Edition, Version 8.5 information center. For information about new capabilities that are available with OmniFind Enterprise Edition Version 8.5 Fix Pack 1, see the Fix Pack 1 Release Notes.
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.
Installation and data directories
This topic omits a path name restriction: When you run the installation program, if you specify paths for the installation and data directories instead of accepting the default paths, do not include a trailing path delimiter. For example, if you specify C:\IBM\es\ instead of C:\IBM\es (on Windows®), or /opt/IBM/es/ instead of /opt/IBM/es (on AIX®, Linux®, or Solaris), the enterprise search system will not start.
Enterprise search administrator ID
This topic specifies that only letters, digits, and the underscore (_) character can be used in the user ID that you use for the enterprise search administrator ID and that no other special characters are allowed. An additional restriction is that this ID must begin with a letter.
Installation modes: graphical, silent, and text
This topic provides instructions on how to create a user ID for the OmniFind Enterprise Edition administrative user and apply profile changes before you run the installation program on AIX, Linux, or Solaris. The following information replaces the published information:
To start the graphical installation program, run the ./launchpad.sh script, click Install Product, and then launch the installation program.
Requirement: If you run the installation program in a shell other than ksh or bash, you must manually create the administrator user before you start the installation program:
1. Create the user ID that will be used as the OmniFind Enterprise Edition administrator ID.
2. Set the login shell for the administrator user to ksh or bash
Setting up the information center to access the public Web site
This topic provides information about how to configure your enterprise search system to access the information center on an IBM® Web site instead of the installed information center. To use the public version, you edit the ES_NODE_ROOT/nodeinfo/es.cfg file and set the value of the DB2ICDocs4ES property to the public information center base URL. The word "topic" was omitted from the URL. The correct public information center base URL is as follows:
DB2ICDocs4ES=http\://publib.boulder.ibm.com/infocenter/discover/v8r5m0/topic
Starting and stopping the information center
This topic provides information about how to change the port number for the information center by editing the ES_INSTALL_ROOT/ibm_help/IC_start.sh (or IC_start.bat) file to specify a new port value. If you change the port number, however, you must also:
1. Edit the following line in the ES_NODE_ROOT/nodeinfo/es.cfg file to specify the same port number:
DB2ICDocs4ES=http\://host_name\:8889/help/topic
2. On Windows, edit the ES_INSTALL_ROOT\bin\sm_infocenter.bat file to specify the same port number.
This topic also provides information about registering the IC_start.bat command as a Windows task and using Windows functions to start the information center as a background task. You can ignore those instructions. The IC_start.bat command was updated in version 8.5 to include parameters to start the information center in the background automatically. If you use the preferred way to start the information center, which is by using the esadmin system startall command, then the information center is also started in the background automatically.
Administering
This section contains changes or corrections to the administration information.
Changing the enterprise search administrator password in a single server configuration
This topic is missing a step that instructs you to start the common communication layer (CCL) in the background on Windows before you restart the enterprise search system. Do the following step after you run the eschangepw script to change the enterprise search administrator password:
On Windows, start CCL in the background:
a. Launch Windows Services by clicking Start > Programs > Administrative Tools > Services.
b. Right-click IBM OmniFind Enterprise Edition and click Properties.
c. Click the Log On tab.
d. Change the password by specifying the new password value, and then and click OK.
e. Right-click IBM OmniFind Enterprise Edition and click Start.
Changing enterprise search server host names or IP addresses
The information in this topic applies specifically to servers that have multiple network interface cards where the server might have more than one IP address or host name. The limited scope of this procedure is not clearly stated in the documentation. If you change the host name of a computer where OmniFind Enterprise Edition is installed, you must re-install the product and its prerequisite products.
Crawling and searching XML documents
To search XML fields in enterprise search collections, you might need to specify options for how the documents are crawled. For example, to search XML documents that are stored in a DB2® database, you must set up the source database and configure options for crawling and searching the database tables. For an example of this procedure, see Configuring the DB2 crawler to crawl XML documents.
Web Content Management crawler properties
The documentation states that the default value for the Time to wait between retrieval requests field is 2 milliseconds. The actual default value is 2 seconds (2000 milliseconds).
The value that you specify in the Maximum number of active crawler threads field is relevant only if the crawler crawls multiple libraries and sites on the target WebSphere Portal and Web Content Management server.
When the Web Content Management crawler crawls the specified site and library, one thread is assigned per one seed list URL. Thus, if you have only one library and one site to crawl (one seed list URL), setting the number of threads to more than one does not improve overall crawler performance.
URI formats in an enterprise search index
You can specify URIs or URI patterns when you configure categories, scopes, and quick links for a collection. You also specify the URI when you need to remove documents from the index or when you want to view detailed status information about a specific document.
When you specify a URI or URI pattern, you must specify the URL-encoded format for the URI and ensure that the URI does not contain characters that are not included in the US-ASCII coded character set (see RFC1738 for details). In the following example, you cannot specify the first URI, which contains Hebrew characters. You can, however, specify the second URI, which is the URL-encoded format of the first URI.
Example 1: file:///c:/shared/hebrew/עברית
Example 2: file:///c:/shared/hebrew/%D7%A2%D7%91%D7%A8%D7%99%D7%AA
Backing up and restoring an enterprise search system
This topic incorrectly states that you can restore backed up data to a system that has the same or a greater number of enterprise search servers. Actually, you must restore data to an enterprise search system that has the same number of enterprise search servers. In addition, the enterprise search administrator ID and installation directories must be the same in both systems. The host names can be different, but all other system configuration parameters must match.
Exporting and importing collection configurations
This topic contains misleading information about the -name option for the esadmin import command. The -name option specifies a display name for the collection. If you do not specify a display name when you import the collection, the default value, Collection<collection_ID>, is used.
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 IBMTivoli 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
Seed list crawlers
Beginning with OmniFind Enterprise Edition Version 8.5 Fix Pack 5, support is extended to Lotus Connections 2.5.0.1, including single sign-on (SSO) support for Lotus Connections 2.5. You can select the version that you want to add to a collection when you use the administration console to configure a Seed list crawler.
The guidelines for crawling Lotus Connections sources that are discussed in the OmniFind Enterprise Edition V9.1 information center also apply to OmniFind Enterprise Edition Version 8.5 Fix Pack 5. See the following topics for instructions:
- Configuring a search administrator user for Lotus Connections
- Configuring SSO support for Lotus Connections
- Configuring search fields for field values that are published in a Lotus Connections seed list
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.
Security
This section contains changes or corrections to the security information.
Document-level security for Domino crawlers
The overview topics for the Domino Document Manager, Notes, and QuickPlace crawlers include a discussion about document-level security that might be misleading with respect to which access control list (ACL) data can be indexed for Domino® data sources. Document-level ACLs, such as author and reader permissions, are not indexed. Only server- and database-level ACLs are indexed. For more information about ACLs and how they are used to enforce secure search, see Pre- and post-filtering search results.
Tip: Beginning with OmniFind Enterprise Edition Version 8.5 Fix Pack 1, document-level ACL data can be indexed. Search response time improves when this document-level data (reader and author permissions) is indexed. For details, see the release notes for the fix pack.
Configuring global security in WebSphere Application Server 6.1
The current documentation provides procedures for configuring global security and an LDAP user registry in WebSphere Application Server 6.0. To configure global security in WebSphere Application Server 6.1:
1. On the search server for enterprise search, configure application security in WebSphere Application Server. For detailed instructions, see the Enabling security topic in the WebSphere Application Server, Version 6.1 Information Center at http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.base.doc/info/aes/ae/tsec_csec2.html.
2. Run the following scripts, which are located in the WAS_INSTALL_ROOT/AppServer/bin directory, to stop and restart the ESSearchServer application.
AIX, Linux, or Solaris
./stopServer.sh ESSearchServer
./startServer.sh ESSearchServer
Windows
stopServer ESSearchServer
startServer ESSearchServer
Validation of current credentials during query processing
Current user credentials can be validated when users use the Search portlet in WebSphere Portal, not a search application, to search enterprise search collections. The list of crawlers that support this type of security is incomplete. In addition to the Web Content Management and WebSphere Portal crawlers, the Seed list crawler can also be configured to validate current credentials through the Search portlet in WebSphere Portal.
Integrating search technology
This section contains changes or corrections to the integrating search technology information.
Migration from WebSphere Portal to enterprise search
The ability to migrate model-based categories from IBM WebSphere® Portal to an enterprise search system ended when OmniFind Enterprise Edition, Version 8.4, was released, and the end of support for this function was announced and documented. However, the ability to migrate collection data and rule-based categories also ended when version 8.4 was released, and the end of support for these functions was not announced or documented.
Disregard topics in the information center that discuss using the eswpsmigrate script to migrate collection data and rule-based categories from WebSphere Portal to an enterprise search system.
Configuring the WebSphere Portal version 6 Search bar to use enterprise search
Step 2 in this topic contains an incorrect description of a directory name.
Incorrect documentation:
On the WebSphere Portal server, change to the WPS_PROFILE_ROOT/installedApps/node_name/wps.ear/wps.war/themes/html/current_theme_name directory, where node_name is the node name for the WebSphere Portal server and current_theme_name is the currently applied theme for your WebSphere Portal server. The default theme name for a WebSphere Portal server is IBM.
Correct documentation:
On the WebSphere Portal server, change to the WPS_PROFILE_ROOT/installedApps/cell_name/wps.ear/wps.war/themes/html/current_theme_name directory, where cell_name is the cell name for your WebSphere Portal server and current_theme_name is the currently applied theme. The default theme name for a WebSphere Portal server is IBM.
In step 4 in this topic, the sample code that you are instructed to insert in the banner_searchControl.jspf file contains a contains a typographical error in the last table cell that causes the search box for enterprise search to be incorrectly displayed.
Incorrect documentation:
<td valign="middle"><input tabIndex="4" valign="middle"
title="<portal-fmt:text key='search.theme.searchresultsicon.alttext' bundle='nls.engine'/>"
alt="<portal-fmt:text key='search.theme.searchresultsicon.alttext' bundle='nls.engine'/>"
src="<portal-logic:urlFindInTheme file=">"/>" type="image"></input></td>
Correct documentation:
<td valign="middle"><input tabIndex="4" valign="middle"
title="<portal-fmt:text key='search.theme.searchresultsicon.alttext' bundle='nls.engine'/>"
alt="<portal-fmt:text key='search.theme.searchresultsicon.alttext' bundle='nls.engine'/>"
src="<portal-logic:urlFindInTheme file="<%= ic %>"/>" type="image"></input></td>
Setting up enterprise search in WebSphere Portal version 6.1
Beginning with OmniFind Enterprise Edition version 8.5 Fix Pack 1, support is extended to WebSphere Portal version 6.1 and Workplace Web Content Management™ version 6.1. The instructions for setting up enterprise search in WebSphere Portal version 6.1 are the same as the instructions for setting up enterprise search in WebSphere Portal version 6 with one exception: you must use the es.wp61.install.jar file instead of the es.wp6.install.jar file.
Configuring the WebSphere Portal version 6.1 Search bar to use enterprise search
The current documentation provides procedures for configuring the Search bar in WebSphere Portal 6.0. Beginning with OmniFind Enterprise Edition version 8.5 Fix Pack 1, support is extended to WebSphere Portal version 6.1.
To use the enterprise search portlet when users submit queries in the WebSphere Portal 6.1 Search bar:
1. Stop the WebSphere Portal application server instance.
2. On the WebSphere Portal server, change to the WPS_PROFILE_ROOT/installedApps/cell_name/wps.ear/wps.war/themes/html/current_theme_name directory, where cell_name is the cell name for your WebSphere Portal server and current_theme_name is the currently applied theme. The default theme name for a WebSphere Portal server is Portal.
3. Back up of the banner_searchControl.jspf file by copying the file and renaming it (for example, banner_searchControl.jspf.BACKUP).
4. Edit the banner_searchControl.jspf file and replace the contents as shown below, where portal_server_name and portal_port are the host name and port for your WebSphere Portal server:
Before:
<div dojo_101Type="ibm.portal.search.widgets.ScopeSearchWidget"
...
<submitUrl="<%wpsURL.write(out);%>">
...
</div>
After:
<div dojo_101Type="ibm.portal.search.widgets.ScopeSearchWidget"
...
<submitUrl="http://portal_server_name:portal_port/wps/omnifind/portalSearchBar.jsp">
...
</div>
5. After saving your changes to the banner_searchControl.jspf file, make the same change in the Default.jsp file, which is in the same directory. You must replace "<%wpsURL.write(out);%>" with "http://portal_server_name:portal_port/wps/omnifind/portalSearchBar.jsp".
Configuring the Lotus Quickr Version 8.1.1 Search bar to use enterprise search
The current documentation provides the procedure, Setting up the enterprise search portlet for Lotus Quickr. You can also set up the portlet to support queries that users submit through the Lotus Quickr 8.1.1 Search bar:
1. Stop the WebSphere Portal application server instance.
2. On the Lotus Quickr server, change to the WPS_PROFILE_ROOT/installedApps/cell_name/wps.ear/wps.war/themes/html/current_theme_name directory, where cell_name is the cell name for your WebSphere Portal server and current_theme_name is the currently applied theme. The default theme name for a Lotus Quickr server is QPG.
3. Create a backup of the banner_searchControl.jspf file by copying the file and renaming it (for example, banner_searchControl.jspf.BACKUP).
4. Edit the banner_searchControl.jspf file and replace the contents as shown below, where portal_server_name and portal_port are the host name and port for your WebSphere Portal server:
Before:
<form name="searchFromThemeForm"
style="margin: 0px;"
method="get"
onsubmit="return searchSubmitThemeForm("<portal-fmt:text key="search.theme.search.noSearchText" bundle="nls.engine"/>");"
action="<% wpsURL.write(escapeXmlWriter); %>">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
...
<td style="padding: 0px; margin:0px;"<%-- nowrap is deprecated, use css --%> valign="middle">
<input type="hidden" name="OCN" value="<%= wpsContentNodeID %>" />
<input type="hidden" name="clearifblank" value="1" />
<input type="hidden" name="srchproc" value="" />
<searchmenu:menu
scopeFieldName="scope"
searchFieldName="query"
output="all"
uniqueId="searchTheme"
tabIndex="3"
/>
</td>
</tr>
</table>
</form>
After:
<form name="searchFromThemeForm"
style="margin: 0px;"
method="get"
onsubmit="return searchSubmitThemeForm("<portal-fmt:text key="search.theme.search.noSearchText"
bundle="nls.engine"/>");"
action="http://portal_server_name:portal_port/lotus/omnifind/portalSearchBar.jsp">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
...
<td style="padding: 0px; margin:0px;"<%-- nowrap is deprecated, use css --%> valign="middle">
<input type="text" name="q"></input>
</td>
</tr>
</table>
</form>
Tip:
For the action attribute, you can use "/lotus/omnifind/portalSearchBar.jsp" instead of "http://portal_server_name:portal_port/lotus/omnifind/portalSearchBar.jsp".
5. Open the banner.jspf file and save the file. This step updates the modified date of the file to ensure that the file is recompiled.
6. Open the Default.jsp file and save the file.
7. Change to the WPS_PROFILE_ROOT/installedApps/cell_name/wps.ear/wps.war/omnifind directory, where cell_name is the cell name for your WebSphere Portal server.
8. Create a backup of the portalSearchBar.jsp file by copying the file and renaming it (for example, portalSearchBar.jsp.BACKUP).
9. Edit the portalSearchBar.jsp file and replace the contents as shown below,
Before:
String url = ESURLGenerator.generateUrlString("ibm.portal.OmniFindSearch", "ibm.portal.OmniFindSearch.called", "/myportal", request, response);
After:
String url = ESURLGenerator.generateUrlString("ibm.portal.OmniFindSearch", "ibm.portal.OmniFindSearch.called", "/myquickr", request, response);
10. Restart the WebSphere Portal application server instance.
Text analysis integration
This section contains changes or corrections to the text analysis integration information.
Creating a boost word dictionary
This topic instructs you to use the ES_INSTALL_ROOT/bin/esboostworddictbuilder tool to create a boost word dictionary. The correct tool name is esboosttermdictbuilder.
Creating the common analysis structure to database mapping file
The path for the cas2JdbcConfiguration element contains a typographical error. This error occurs twice in this topic.
Incorrect:
<cas2JdbcConfiguration xmlns="http://www.ibm.com/uima/consumer/jdbc/100/xml">
Correct:
<cas2JdbcConfiguration xmlns="http://www.ibm.com/uima/consumer/cas2jdbc/100/xml">
Maintaining
This section contains changes or corrections to the maintenance information.
The documentation specifies two incorrect default values:
- The documentation states that the default value for the Maximum size of each log file field is 10 MB. The correct default value is 16 MB. The maximum value is also 16 MB.
- The documentation states that the default value for the Maximum number of log files field is 16. The correct default value is 10.
Developing
This section contains changes or corrections to the application development information.
The enterprise search sample application
The instructions for importing the servlet application Project Interchange file in to your Rational Application Developer environment contains a typographical error. Step 2 is Click File > Import, not Click File > File.
Query syntax
The description of the minus sign, which you can use to indicate that a term must be absent from a document for a match to occur, is incomplete. The minus sign acts as a filter to remove documents from the result set. A query to exclude documents must be associated with a query that returns positive results. For example, the following query returns documents that have URLs with the string com minus documents that have URLs with the string support.
url:com -url:support
Samples
This section contains changes or corrections to the sample program information.
Creating a postparse plug-in for the Web crawler
The sample code for creating a postparse plug-in contains two errors:
Incorrect: "MyUserSpecificMetadata" // field name
Correct: "MyUserSpecificMetadata",// field name
Incorrect: addMetadataField(mf); // Add it to the list.
Correct: arg.addMetadataField(mf); // Add it to the list.
Correct sample code:
public class MyPostparsePlugin implements PostparsePlugin {
public MyPostparsePlugin() { }
public boolean init() { return true; }
public boolean release() { return true; }
public boolean processDocument(PostparsePluginArg[] args) {
try {
PostparsePluginArg1 arg = (PostparsePluginArg1)args[0];
if (arg.getContent() != null && arg.getContent().length > 0) {
String content = new String( arg.getContent(), arg.getEncoding() );
if (content != null && content.indexOf(keyword) > 0) {
final String userdata = null; // look up string by keyword.
FieldMetadata mf = new FieldMetadata(
"MyUserSpecificMetadata", // field name
userdata, // field value
false, // searchable?
true, // field-searchable?
false, // parametric-searchable?
true, // can be extracted by search?
"MetadataPreferred", // metadata value rather
// than content
false); // show in summary?
arg.addMetadataField(mf); // Add it to the list.
return true; // Use results.
}
}
return false; // ignore results
} catch (Exception e) {
return false; // disregard returned results
}
}
}
Reference
There are currently no changes or corrections to the reference information.
Troubleshooting
This section contains changes or corrections to the troubleshooting information.
Gathering information for problem analysis
The usage guidelines in this topic state that you can use the esservice utility to gather troubleshooting information from version 8.3 or later enterprise search systems. That statement is incorrect. You can use the esservice utility to gather information from version 8.4 fix pack 1 or later systems.
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.
Base form and exact form matching in foreign language documents
The help topic for setting preferences in the sample search application for enterprise search tells you how to set the query mode to control linguistic parsing of the query terms and describes the differences between base form and exact form matching. This information does not address how linguistic parsing occurs when you search documents that do not match the query language. The default query language is the one that is configured as the default language in your Web browser. For details about this issue, see http://www.ibm.com/support/docview.wss?rs=63&uid=swg21291768.
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":"8.5","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]
Was this topic helpful?
Document Information
Modified date:
17 June 2018
UID
swg21308220