IBM OmniFind Analytics Edition Installation Guide
Edition Notice
First Edition (February 2007)

This edition applies to version 8, release 4 of IBM® OmniFind™ Analytics Edition and to all subsequent releases and modifications until otherwise indicated in new editions.

This document contains proprietary information of IBM. This proprietary information is provided in accordance with the license conditions and is protected by copyright. Information contained in this document provides no warranties whatsoever for any products. Also, no descriptions provided in this document should be interpreted as product warranties. Depending on the system environment, the yen symbol may be displayed as the backslash symbol, or the backslash symbol may be displayed as the yen symbol.

© Copyright International Business Machines Corporation 2007. All rights reserved.

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

1 Overview
This document describes how to install IBM OmniFind Analytics Edition. The following topics describe the product modules and system requirements.
1.1 System Configuration and Operating Environment
OmniFind Analytics Edition consists of the following modules.

Module Details of processing
Preparation This module handles batch processing such as language processing, information extraction, and index creation.
Text Miner This module is an enterprise application that you can use to perform various types of analyses.
Alerting System This module is an enterprise application that you can use to specify settings for alerts.
Dictionary Editor This module is an enterprise application that you can use to create and maintain dictionaries.
DOCAT This module, which is available only in Japanese, is an enterprise application that you can use to specify settings for category extraction.
Manual This module displays online documentation for OmniFind Analytics Edition.
Browser This module is connected to the OmniFind Analytics Edition enterprise applications and displays the mining results.



Although it is possible to operate everything on one computer, for optimum performance and load distribution, you should install the modules on separate computers, as follows:
  • Preparation
  • Enterprise applications (Text Miner, Alerting System, Dictionary Editor, DOCAT, and Manual)
  • Browser
If all modules are installed and run on one computer, the operating environment must conform to the following requirements:

Operating system Hardware Software
Microsoft® Windows® 2003 Intel® 32 bit or AMD 32 bit CPU
6 GB memory (minimum: 2 GB)
60 GB hard disk
Microsoft Windows Service Pack 1
Microsoft Internet Explorer 6
IBM WebSphere® Application Server 6.0.2
IBM Java™ Runtime 1.4.2
AIX® 5.3 Power 64 bit CPU
6 GB memory (minimum: 2 GB)
60 GB hard disk
Microsoft Internet Explorer 6
IBM WebSphere Application Server 6.0.2
IBM Java Runtime 1.4.2
1.2 Environment Variables
The environment variables used in OmniFind Analytics Edition are as follows.

Environment variable Meaning
TAKMI_HOME Specifies the directory in which the OmniFind Analytics Edition modules are located.
  • This variable is referred to when reading the configuration file during operations.
PATH Adds the TAKMI_HOME bin directory.
When analyzing Japanese, the TAKMI_HOME uima/components/jsa/lib directory must also be added.
  • This variable is referred to when calling native codes to be used in the language processing.
TAKMI_HOME (WebSphere Application Server system property) Specifies the same value as the system environment variable TAKMI_HOME.
  • This variable is referred to by the enterprise applications.
uima.home (WebSphere Application Server system property) Specifies the TAKMI_HOME uima directory.
  • This variable is referred to by the enterprise applications.
ws.ext.dirs (WebSphere Application Server system property) Specifies the TAKMI_HOME lib directory, uima/lib directory, and uima/components/TAKMI_NLP/lib directory.
When analyzing Japanese, the TAKMI_HOME uima/components/jsa/lib directory must also be specified.
  • Note that ws.ext.dirs can also be set by the WAS_EXT_DIRS setting in setupCmdLine.bat on WebSphere Application Server.
2 Installation Procedure
This topic describes how to install OmniFind Analytics Edition.
2.1 Installation
To launch the installation program, run the takmisetupwin32.exe command for Windows or the takmisetupaix.bin command for AIX.
  • The Welcome screen is displayed.



    Click the Next button to proceed.

  • The program license agreement is displayed.



    Specify that you accept the license agreement, and click the Next button to proceed.

  • The screen for specifying the directory for installing IBM OmniFind Analytics Edition is displayed.



    Specify the directory and click the Next button.

  • The screen for selecting an installation type is displayed.



    Select an installation type and click the Next button.

  • If you selected Customize as the installation type, the screen for selecting the features to be installed is displayed.



    To be able to process other languages, Language Support must be installed.
    Select the features to be installed, and click the Next button.

  • The screen to confirm the features to be installed is displayed.



    Click the Install button to start the installation.

  • The screen to show the results of installing the product is displayed.



    Click the Finish button to complete the installation.

2.2 Updating the Configuration File
Update the following file in the directory where OmniFind Analytics Edition is installed:

   conf/global_config.xml

Specify the database entry within the database_entry tag as follows:

    <database_entry name="SAMPLE" path_type="absolute" path="C:/Program Files/IBM/takmi/databases/sample"/>

where

   name = name of database (this name is shown on the database selection screen and you can set it to any name).
   path_type = type of the path to the database directory (relative or absolute).
   path = the path to the database directory (use the slash character as a directory separator).

If a sample database was selected at the time of installation, the sample database entry is added.
2.3 Uninstallation
The uninstaller is created in the _uninst directory in the directory where OmniFind Analytics Edition is installed.
To launch the uninstallation program, run the uninstaller.exe command for Windows or the uninstaller.bin command for AIX.

Because the OmniFind Analytics Edition library is loaded in the WebSphere Application Server extension class loader, be sure to stop the operation of WebSphere Application Server before you launch the uninstallation program when you wish to uninstall the "Program Files."
  • The Welcome screen is displayed.



    Click the Next button to proceed.

  • The screen for selecting the features to be uninstalled is displayed.



    Select the features to be uninstalled, and click the Next button.

  • The screen to confirm the features to be uninstalled is displayed.



    Click the Uninstall button to start the uninstallation.

  • The screen to show the results of uninstalling the product is displayed.



    Click the Finish button to complete the uninstallation.

3 Making Settings for WebSphere Application Server
This topic describes how to specify settings for WebSphere Application Server.
3.1 Running the wsadmin Command
In the ear directory in the directory where OmniFind Analytics Edition is installed, run the command appropriate for your operating environment:

Windows:
    C:\Program Files\IBM\WebSphere\AppServer\bin\wsadmin.bat -f .\TAKMI.jacl

AIX:
    /usr/IBM/WebSphere/AppServer/bin/wsadmin.sh -f ./TAKMI.jacl

Because the TAKMI.jacl file makes settings for application server "server1", if you want to make settings for a different server, make the necessary corrections to the TAKMI.jacl file before executing the command.

This command automatically runs the processing described in 3.2 Making Settings for the Application Server and 3.3 Installation of the Enterprise Application.

If global security is enabled in WebSphere Application Server, you must specify -user and -password parameters when you run the wsadmin command.

See the WebSphere Application Server documentation for details on the wsadmin command.
3.2 Making Settings for the Application Server
Follow the procedure described below to make settings for the application server.
See 1.2 Environment Variables for the meanings of the environment variables used in OmniFind Analytics Edition.
  • Launch WebSphere Application Server and log in to the administrative console.
  • Select Server > Application Server > server1 > Java and Process Management > Process Definition > Java Virtual Machine > Custom Properties.
  • Click the New button, type TAKMI_HOME in "Name", type the OmniFind Analytics Edition installation directory in "Value" (the default directory in Windows is C:\Program Files\IBM\takmi, and the default directory in AIX is /opt/IBM/takmi), and then click OK.
  • Click the New button, type uima.home in "Name", type the UIMA installation directory in "Value" (the default directory in Windows is C:\Program Files\IBM\takmi\uima and the default directory in AIX is /opt/IBM/takmi/uima), and then click OK.
  • Click the New button, type ws.ext.dirs in "Name", type the lib directory of TAKMI_HOME, the uima/lib directory of TAKMI_HOME, and the uima/components/TAKMI_NLP/lib directory of TAKMI_HOME (uima/components/jsa/lib directory of TAKMI_HOME when analyzing Japanese) in "Value", and then click OK.

    When the Japanese language is not analyzed, the default in Windows is:
       C:\Program Files\IBM\takmi\lib;C:\Program Files\IBM\takmi\uima\lib;C:\Program Files\IBM\takmi\uima\components\TAKMI_NLP\lib

    The default in AIX is:
       /opt/IBM/takmi/lib:/opt/IBM/takmi/uima/lib:/opt/IBM/takmi/uima/components/TAKMI_NLP/lib

    When the Japanese language is analyzed, the default in Windows is:
       C:\Program Files\IBM\takmi\lib;C:\Program Files\IBM\takmi\uima\lib;C:\Program Files\IBM\takmi\uima\components\TAKMI_NLP\lib;C:\Program Files\IBM\takmi\uima\components\jsa\lib

    The default in AIX is:
       /opt/IBM/takmi/lib:/opt/IBM/takmi/uima/lib:/opt/IBM/takmi/uima/components/TAKMI_NLP/lib:/opt/IBM/takmi/uima/components/jsa/lib

  • Click Save to save the changes in the master configuration.
3.3 Installation of Enterprise Applications
Install the .ear files in the OmniFind Analytics Edition installation directory to WebSphere Application Server.

    ear/TAKMI_MINER.ear
    ear/TAKMI_ALERT.ear
    ear/TAKMI_DIC.ear
    ear/TAKMI_DOCAT.ear (included only in the Japanese version)
    ear/TAKMI_MANUAL.ear


  • Launch WebSphere Application Server and log in to the administrative console.
  • Select Applications > Install New Application.
  • In the "Preparing for the application installation" screen, select the .ear file to be installed, and click the Next button.
  • Click the Next button in the "Preparing for the application installation" screen.
  • Click the Next button in the "Step 1: Select installation options" screen.
  • Click the Next button in the "Step 2: Map modules to servers" screen.
  • Click the Next button in the "Step  3:  Map virtual hosts for Web modules."
  • For files other than TAKMI_MANUAL.ear, map the security roles to users/groups in the "Step  4:  Map security roles to users/groups" screen, and click the Next button.
    See 3.4 Security Settings for the security settings of WebSphere Application Server.
  • In the "Step 5: Summary" screen (in the "Step 4: Summary" screen for TAKMI_MANUAL_EAR.ear), click the Finish button.
  • Ensure that the application is successfully installed, and click Save to save it in the master configuration.
See the WebSphere Application Server documentation for details on how to install enterprise applications.

After you install the enterprise applications, restart WebSphere Application Server.

The URL of each enterprise application is as follows.
Type the "operation check URL" in the browser to verify that the application is installed properly.
If the application is installed properly, "status.jsp" will be displayed on the screen.

Module URL Operation check URL ("status.jsp" will be displayed on the screen)
Text Miner http://hostname:port/TAKMI_MINER/ http://hostname:port/TAKMI_MINER/status.jsp
Alerting System http://hostname:port/TAKMI_ALERT/ http://hostname:port/TAKMI_ALERT/status.jsp
Dictionary Editor http://hostname:port/TAKMI_DIC/ http://hostname:port/TAKMI_DIC/status.jsp
DOCAT Connect from Text Miner. http://hostname:port/TAKMI_DOCAT/status.jsp
Manual http://hostname:port/TAKMI_MANUAL/ http://hostname:port/TAKMI_MANUAL/status.jsp

For example, the URL for accessing Text Miner launched on the local host through the default server1 of WebSphere Application Server is:

    http://localhost:9080/TAKMI_MINER/.

Check the host name and port number with the WebSphere Application Server administrator as they vary with the environment.
3.4 Security Settings
Make the following security settings to protect the installed enterprise applications through user authentication.
  • Launch WebSphere Application Server and log in to the administrative console.
  • Select Security > Global Security.
  • Configure a user registry to be specified in the "Active user directory" and set its properties.
  • Check Enable global security under General properties. Enforce Java 2 security is checked at the same time, but be sure to uncheck it.
  • Select a configured user registered type from the Active user registry option, and click OK.
  • Select Applications > Enterprise Applications.
  • Select an installed enterprise application.
  • Click Map security roles to users/groups under Additional Properties, map the security roles to Users/Groups, and click OK.
    The security role for each enterprise application is as follows:

    Enterprise application Security role
    TAKMI MINER_EAR takmi_miner
    TAKMI ALERT_EAR takmi_alerting_system
    TAKMI DIC_EAR takmi_dictionary_editor
    TAKMI DOCAT_EAR takmi_docat

  • Click Save to save changes in the master configuration.
  • Restart WebSphere Application Server.
See the WebSphere Application Server documentation for details on specifying security settings.
4 Operation Check
This topic describes how to check the operation of OmniFind Analytics Edition.
4.1 Checking the Operation of Enterprise Applications
Restart WebSphere Application Server and access each of the enterprise applications through the browser.
  • Text Miner
    Access http://hostname:port/TAKMI_MINER/ (example: http://localhost:9080/TAKMI_MINER/) and verify that the following screen is displayed:

    Screen shot of TEXT_MINER

    For information on how to use Text Miner, click Manual at the top right of the Text Miner screen and refer to the online instruction manual.

  • Alerting System
    Access http://hostname:port/TAKMI_ALERT/ (example: http://localhost:9080/TAKMI_ALERT/) and verify that the following screen is displayed:

    Screen shot of ALERTING_SYSTEM

  • Dictionary Editor
    Access http://hostname:port/TAKMI_DIC/ (example: http://localhost:9080/TAKMI_DIC/) and verify that the following screen is displayed:

    Screen shot of DICTIONARY_EDITOR

4.2 Checking the Operation of the Preparatory Processing
By using the sample database, check that the preparatory processing (data conversion, language processing, and indexing) can be run.
See the Operation Manual for details on the preparatory processing.
  • Stop WebSphere Application Server.
  • In the databases/INDEXED_DATA_SAMPLE_JA/bin directory, which is in the OmniFind Analytics Edition installation directory, run the takmi_preprocess_all.bat command (when using Windows) or the takmi_preprocess_all.sh command (when using AIX).
  • Follow the instructions on the screen and enter 'Y.'



  • Data deletion, data conversion, language processing, and indexing are run in this order.
  • Follow the instructions on the screen and press any key to complete the processing.



  • Launch WebSphere Application Server.
  • Use TAKMI_MINER to check the newly created index for the INDEXED_DATA_SAMPLE_JA database.
Terms of Use

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

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

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

IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
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:

IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, 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
Silicon Valley Lab
Building 090/H-410
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.

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.

Trademarks
This topic lists IBM trademarks and certain non-IBM trademarks.

See http://www.ibm.com/legal/copytrade.shtml for information about IBM trademarks.

The following terms are trademarks or registered trademarks of other companies:

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. 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.

Intel, Intel Inside (logos), MMX and Pentium are trademarks of Intel 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.

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

Other company, product or service names might be trademarks or service marks of others.