Noetix Search Installation Guide

Transcription

1 Installation Guide

2 Noetix Search Installation Guide Noetix Search This document was released on February 9, Please go to Answer ID 1769 (INFO: Documentation for Noetix Search) on the Noetix online knowledge base; an updated version of this document might be available. Copyright Noetix Corporation. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior written permission from Noetix Corporation. The information in this document is subject to change without notice. Noetix Corporation strives to keep this information accurate but does not warrant that this document is error-free. Noetix, NoetixViews, Noetix QueryServer, Noetix WebQuery, and the Noetix logo are registered trademarks of Noetix Corporation. Other Noetix marks are trademarks of Noetix Corporation.

3 Oracle, JD Edwards, PeopleSoft, Retek, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Oracle E-Business Suite, Oracle Database, Oracle Discoverer, Oracle Business Intelligence, SQL*Plus, SQL*Net, SQL*Loader, PeopleSoft Enterprise, Siebel Business Applications, and other Oracle, PeopleSoft, and/or Siebel product names referenced herein are trademarks or registered trademarks of Oracle Corporation. Sun, Java, Java Runtime Environment, and other Sun product names referenced herein are trademarks or registered trademarks of Sun Microsystems, Inc. Microsoft, Microsoft Excel, Microsoft Internet Explorer, Windows, Microsoft SQL Server, Microsoft SQL Server Reporting Services, Internet Information Services, Microsoft.NET Framework, Microsoft ASP.NET, Microsoft Data Access Components, and other Microsoft product names referenced herein are trademarks or registered trademarks of Microsoft Corporation. Adobe, Acrobat, the Adobe PDF logo, Adobe Flash Player, and Adobe Reader are trademarks or registered trademarks of Adobe Systems Incorporated. IBM, Cognos, Cognos Framework Manager, Cognos Configuration, Cognos Query Studio, Cognos Report Studio, Cognos Connection, and other Cognos server or modeling product names mentioned herein are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. SAP is a registered trademark of SAP AG. BusinessObjects is a trademark of Business Objects, an SAP company. Web Intelligence and Xcelsius are trademarks or registered trademarks of Business Objects, an SAP company. All other company and product names mentioned herein are used for identification purposes only and may be trademarks or registered trademarks of their respective owners. The Chart2D library and Swing classes are distributed with Noetix Search under the GNU Lesser General Public License. Noetix hereby offers to give any third party, for a charge no more than our cost of physically performing the distribution, a complete, machine-readable copy of the Chart2D library and Swing classes, which shall be distributed under the GNU Lesser General Public License and supplied on a medium customarily used for software interchange. Requests for source code must be submitted within three years of this offer and should be directed to Noetix Corporation, th Ave NE, Suite 100, Redmond, WA , USA. Oracle JDBC is distributed with Noetix Search under the GNU General Public License. Noetix hereby offers to give any third party, for a charge no more than our cost of physically performing the distribution, a complete, machine-readable copy of Oracle JDBC, which shall be distributed under the GNU General Public License and supplied on a medium customarily used for software interchange. Requests for source code must be submitted within three years of this offer and should be directed to Noetix Corporation, th Ave NE, Suite 100, Redmond, WA , USA.

4 The Solr project files are distributed with Noetix Search under Apache License 2.0. Noetix hereby offers to give any third party, for a charge no more than our cost of physically performing the distribution, a complete, machine-readable copy of the Solr project files, which shall be distributed under Apache License 2.0, with all legal copyrights intact, and supplied on a medium customarily used for software interchange. Requests for source code must be submitted within three years of this offer and should be directed to Noetix Corporation, th Ave NE, Suite 100, Redmond, WA , USA.

5 Contents Preface...vii About This Guide... viii Noetix Technical Support... viii Chapter 1 Product Overview...1 Overview...2 Chapter 2 Pre-Installation Tasks...5 Overview...6 Reviewing System Requirements...7 Configuring JAVA_HOME...8 On Windows...8 On Linux or Solaris...9 Configuring Apache Tomcat...10 On Windows...10 On Linux or Solaris...11 Grant Administrative Privileges...13 Chapter 3 Installing Noetix Search...15 Overview...16 Installing the Software...17 On Windows...17 On Linux or Solaris...27 Additional Installation Scenarios...28 Verifying the Installation...29 Reinstalling the Software...30 On Windows...30 On Linux or Solaris...35 Upgrading the Software...36 On Windows...36 On Linux or Solaris...42 Uninstalling the Software...43 On Windows...43 On Linux or Solaris...45 Chapter 4 Post-Installation Tasks...47 Overview...48 Configuring ORACLE_HOME or TNS_ADMIN...49 On Windows...49 Contents v

6 On Linux or Solaris Appendix Legal Notices GNU Lesser General Public License GNU General Public License Apache License vi Noetix Search Installation Guide

7 Preface This preface is an introduction to the Noetix Search Installation Guide. It discusses the guide s content and assumptions and how to contact Noetix Corporation.

8 About This Guide The Noetix Search Installation Guide provides administrators with complete software installation instructions for Noetix Search. This guide assumes that you have purchased this product from Noetix Corporation and that the reader is primarily responsible for the installation and maintenance of the Noetix solution. Typically, a Noetix consultant will be available to assist you with your initial setup and configuration of this product. Administrators using this product and guide need to have a general knowledge of the system environment, client/server architecture, and common graphical user interfaces. An electronic copy of this guide can be found with the product software. We welcome your input on the quality, accuracy, and usefulness of this document. Please send your comments and suggestions to Noetix Technical Support. Noetix Technical Support The Noetix Technical Support Web site is available if you have any questions or encounter a problem during installation or operation of your Noetix software. This site is updated regularly with the latest information on Noetix products. viii Noetix Search Installation Guide

9 Chapter 1 Product Overview This chapter provides a brief overview about Noetix Search.

10 Overview Noetix Search helps you to search or browse across one or several index repositories of NoetixViews and Noetix Analytics to find the information you need to expedite report development and optimize query performance. It allows you to search by keywords and filter search results by selecting specific objects. The guided navigation also allows you to browse quickly and find relevant content, and you can refine your search query further by using advanced search. Noetix Search works with all modules of NoetixViews for Oracle E-Business Suite, NoetixViews for PeopleSoft Enterprise, and Noetix Analytics for Oracle E-Business Suite and supports Web browsers such as Microsoft Internet Explorer, Mozilla Firefox, Google Chrome and Safari. Using Noetix Search for NoetixViews, you can: See a detailed description of the Noetix view, along with examples and tips on how to build reports with it. Sort quickly on view columns that can be used to filter data and join the view to other views. Learn which Oracle tables were used to develop the Noetix view, and see a list of available columns in the Oracle tables used by the view. Find all views that use the same column. See which views are related to and can be joined to other views. Find all the views that extract information from the same Oracle table. See the related roles, columns, tables, and questions associated with a particular view. Print view, column, and table detail pages. 2 Noetix Search Installation Guide

11 Using Noetix Search for Noetix Analytics, you can: Search for specific relationship sets or fields. See a detailed description of each relationship set and field, along with examples of the types of reports they support. Identify fact and dimension tables used within each relationship set. View an entity relationship diagram (ERD) showing how the fact and dimension tables are joined within a given relationship set. Identify key metrics for analysis. Identify dimensions and attributes that can be used to summarize and filter data. Search for specific data warehouse tables, table aliases, and columns. Learn which Oracle E-Business Suite table and column is the source for each field. If the field is calculated, the calculation is also documented. Search data source tables and columns to see which tables, columns, relationship sets, and fields they are mapped to. Chapter 1: Product Overview 3

12

13 Chapter 2 Pre-Installation Tasks This chapter deals with the tasks that you need to perform before installing Noetix Search.

14 Overview Before beginning installation of Noetix Search, you need to perform certain preinstallation tasks. This chapter deals with these tasks such as configuring JAVA_HOME and Apache Tomcat that need to be performed. We recommend that you get familiarized with the system requirements and other preinstallation considerations in this chapter before beginning the installation process. Each task involves gathering and preparing information or making decisions for a system installation. 6 Noetix Search Installation Guide

15 Reviewing System Requirements Before beginning an installation, ensure that your system meets the minimum requirements for hard disk space, memory, operating systems, and application versions. These requirements vary depending on the product version that you are installing. The Noetix Search System Requirements can be found in the release documentation available with the product software and on the Noetix online knowledge base. NOTE: Noetix Search supports Windows 7. However, it is not recommended for hosting the Noetix Search web client in production. Chapter 2: Pre-Installation Tasks 7

16 Configuring JAVA_HOME For Noetix Search to operate properly, the JAVA_HOME environment variable must be set. This section explains how to configure the JAVA_HOME environment variable on a computer running Microsoft Windows, Linux, or Solaris and on which the Java Runtime Environment (JRE) has been installed. On Windows You must set the JAVA_HOME environment variable on the computer on which you intend to install Noetix Search. To configure the JAVA_HOME environment variable 1. Click Start > Control Panel > System. The System Properties dialog box is displayed. Alternatively, to open the System Properties dialog box, right-click the My Computer icon, and then click Properties. 2. Click the Advanced tab, and then click Environment Variables. The Environment Variables dialog box is displayed. 3. In the System variables area, click New. The New System Variable dialog box will open. 4. In the Variable name box, type JAVA_HOME. 5. In the Variable value box, type the path of the JRE folder on the computer (for example, C:\Program Files\Java\jre1.6.0_05). 6. Click OK to save the changes, and close the dialog boxes. 8 Noetix Search Installation Guide

17 On Linux or Solaris You must set the JAVA_HOME environment variable on the computer on which you intend to install Noetix Search. To configure the JAVA_HOME environment variable 1. At the command prompt, type the following commands respectively: JAVA_HOME=<path to JAVA_HOME> (for example, JAVA_HOME=/ usr/jre/latest) export JAVA_HOME NOTE: To set the environment variable permanently, edit the user s startup script (for example, <user s home directory>\.profile) or a system-wide startup script (for example, /etc/profile) so that they run the commands mentioned in this step. 2. To verify that the JAVA_HOME environment variable has been set properly, at the command prompt, type echo $JAVA_HOME. The path of the environment variable will be displayed. Chapter 2: Pre-Installation Tasks 9

18 Configuring Apache Tomcat For Noetix Search to operate properly, you must increase the memory for Apache Tomcat from the default value to 1,000 MB. This section explains how to configure Apache Tomcat on a computer running Microsoft Windows, Linux, or Solaris. On Windows NOTE: Skip this section if you intend to install and configure Apache Tomcat using the Noetix Search setup. You must configure the Apache Tomcat settings on the computer on which you intend to install Noetix Search. To configure Apache Tomcat: 1. Click Start > All Programs > Apache Tomcat 6.0 > Configure Tomcat. The Apache Tomcat Properties dialog box is displayed. 2. Click the Java tab, and then type 1,000 in the Maximum memory pool box. 3. Click Apply to save the changes, and then click OK to close the dialog box. 10 Noetix Search Installation Guide

19 On Linux or Solaris You must configure the Apache Tomcat settings on the computer on which you intend to install Noetix Search. To configure the memory for Apache Tomcat, the Java Virtual Machine (JVM) option Xmx<size> should be added to the Apache Tomcat s startup script. The process you have followed to install and configure Apache Tomcat will determine how you specify the option. In a typical scenario, if you have created a startup script in /etc/init.d, you can set a JAVA_OPTS variable that will be picked up by the Apache Tomcat startup script. If you are not using this scenario, you can consult the Tomcat documentation. Here is an example of an Apache Tomcat service startup script that might exist in /etc/init.d with the JAVA_OPTS variable defined: Chapter 2: Pre-Installation Tasks 11

20 #!/bin/bash # # chkconfig: # description: This is the Tomcat webservice # JAVA_HOME=/usr/java/latest; export JAVA_HOME JAVA_OPTS=-Xmx1000m; export JAVA_OPTS case "$1" in start) /usr/local/apache-tomcat /bin/startup.sh ;; stop) /usr/local/apache-tomcat /bin/shutdown.sh ;; *) echo $"Usage: $0 {start stop}" exit 1 esac exit 0 12 Noetix Search Installation Guide

21 Grant Administrative Privileges To install and set up Noetix Search, you must have administrative privileges for each computer on which you plan to install the components of Noetix Search. If you need assistance with this task, contact your system administrator. Chapter 2: Pre-Installation Tasks 13

22

23 Chapter 3 Installing Noetix Search This chapter describes the steps to install, reinstall, upgrade, and uninstall Noetix Search.

24 Overview This chapter tells you how to install, reinstall, upgrade and uninstall Noetix Search. Before beginning the installation process, you must read the system requirements and perform the pre-installation tasks. For information about the pre-installation tasks, see Pre-Installation Tasks. 16 Noetix Search Installation Guide

25 Installing the Software This section explains how to install Noetix Search on a computer running Microsoft Windows, Linux, or Solaris. On Windows The procedure for installing Noetix Search on Windows is as follows: To install Noetix Search 1. Double-click the NoetixSearch-<version>.exe file. The Noetix Search Setup screen appears. Chapter 3: Installing Noetix Search 17

26 2. Review the information, and click Next to continue. The Software License Agreement page appears. 18 Noetix Search Installation Guide

27 3. Read the license agreement and click I Agree. The Choose Components page appears. The following are the details of the components that will be installed: Noetix Search Builder: This component generates the search indexes for Noetix Search and can be installed on a client computer or server computer. The computer on which you install this component must be able to connect to the NoetixViews schema, the Noetix Analytics instance, and the server computer on which you have installed the Noetix Search Web Application. Chapter 3: Installing Noetix Search 19

28 Noetix Search Web Application: When this component is selected, the wizard installs the enterprise search server (Solr) that develops indexes and/or attributes for content that will be delivered through a Web browser. This component can be installed on the server computer only and must be selected if any component other than Noetix Search Builder is selected. NOTE: In case of a distributed installation where the Noetix Search Builder and Noetix Search Web Application components are installed on two different computers, the help file for the Noetix Search Builder component will be installed with the Noetix Search Web Application component. In such a case, you need to modify the help URL in the Noetix.Search.Builder.properties file as follows: DEFAULT_HELP_URL= of the computer where the Noetix Search Web Application is installed>:<port number, if not 80>/noetixsearch/ nsbhelp. Install Apache Tomcat: For Noetix Search to operate properly, you need a Servlet container that needs to be installed on the same computer where you intend to install Noetix Search. Noetix Search, by default, provides you with the Apache Tomcat Servlet container. Selecting the Install Apache Tomcat check box will install and configure Apache Tomcat Servlet container and Apache Web server for you. However, if you do not select this check box, during step 7 you need to specify the home path of the Tomcat configuration directory, Tomcat webapps directory, and type the port number that Apache Tomcat is configured on. IMPORTANT: If you do not select this component, you must also not select the Integrate Apache Tomcat with IIS component. 20 Noetix Search Installation Guide

29 Integrate Apache Tomcat with IIS: Selecting this check box integrates Apache Tomcat with Internet Information Services (IIS) using Internet Server Application Programming Interface (ISAPI) filter and Tomcat Connector. Integrating Search with IIS provides a seamless web experience and a simpler security setup to limit access to the application. The wizard configures IIS to serve the Noetix Search Web Application and forwards requests for /solr and /export to Apache Tomcat. If you select this check box, you must also select the Install Apache Tomcat and Integrate Noetix Search with Apache Tomcat checkboxes to proceed with the installation. NOTE: The check box for this component will be disabled if you do not have IIS installed on the computer on which you intend to install Noetix Search. If you do not want to use IIS, you can use Apache, Jetty, or any other Web server or a daemon to serve the Web content. Integrate Noetix Search with Apache Tomcat: Selecting this check box integrates the Noetix Search Web Application with Apache Tomcat. Do not select this component if you are using a servlet engine other than Apache Tomcat. If you do not select this component, you need to manually integrate Noetix Search Web Application with Apache Tomcat. Chapter 3: Installing Noetix Search 21

30 4. Select the components you want to install, and then click Next. The Installation Location page appears. 22 Noetix Search Installation Guide

31 5. Accept the default destination folder that is displayed or change the destination folder. To change the destination folder, click Browse, navigate to the folder location, select the destination folder, and then click Next. The Choose Start Menu Folder page appears. Chapter 3: Installing Noetix Search 23

32 6. Enter a Start menu folder name under which you want to create the shortcuts for Noetix Search. By default, it is Noetix Search. If you select a Start menu folder name from the list, the default name is added to the end of the selection. If you do not want to create the shortcuts for Noetix Search, select the Do not create shortcuts check box, and then click Next. If you selected the Install Apache Tomcat component in step 3, the Noetix Search Setup page appears as shown under step 7. If you did not select the Install Apache Tomcat component in step 3, the Apache Tomcat Information page appears.. 24 Noetix Search Installation Guide

33 7. Specify the paths to the Tomcat configuration directory and Tomcat webapps directory and type the port that Apache Tomcat is configured on. You can accept the default path that is displayed or change the path. To change the path, click, navigate to the folder location, select the destination folder, and then click Next. The Noetix Search page appears. Chapter 3: Installing Noetix Search 25

34 8. Click Install to start the installation process. The progress of the installation is displayed. Click Show details to view the actions performed by the installation wizard. To copy the installation log, right-click the information, and then click Copy Details To Clipboard. You can then paste and save the installation log in any text-editing program. 9. Click Next when the setup has successfully completed. The last page appears with a message that Noetix Search has been installed successfully. 26 Noetix Search Installation Guide

35 10. Click Finish to exit the Noetix Search Setup wizard. On Linux or Solaris NOTE: Apache Tomcat needs to be manually installed before installing Noetix Search. The procedure for installing Noetix Search on Linux or Solaris is as follows: To install Noetix Search 1. Navigate to the directory where you have downloaded the NoetixSearch- <version>.tar.gz source file. 2. At the command prompt, type the following command, and press ENTER: gunzip NoetixSearch-<version>.tar.gz The NoetixSearch-<version>.tar file will be created. 3. At the command prompt, type the following command, and press ENTER: tar xvf NoetixSearch-<version>.tar The NoetixSearch-<version> directory will be created for Noetix Search. 4. At the command prompt, type cd NoetixSearch-<version>, and press ENTER. 5. Type su to obtain administrative privileges, and press ENTER. 6. At the command prompt, type the super user password that has been assigned to you as an administrator, and press ENTER. 7. At the command prompt, type./install.sh to start the Noetix Search installer. 8. When prompted for the Noetix Search installation location, press ENTER to accept the default location or type a different location. If the location does not exist, type y to create the location, or type n if you want to specify a different location. Chapter 3: Installing Noetix Search 27

36 9. When prompted whether to configure Noetix Search integration with Apache Tomcat, press ENTER to accept the default or type n if you are using a servlet engine other than Apache Tomcat. 10. Press ENTER to accept the default path of the Tomcat home (Tomcat installation directory), or type a new path, and then press ENTER. 11. Press ENTER to accept the default location of the Tomcat configuration files, or type a new location. 12. Press ENTER to accept the default location of the Tomcat webapps directory, or type a new location. 13. Press ENTER to accept the default port number, or specify a new port number. The installation process starts. Additional Installation Scenarios The following are the additional installation scenarios: Installing the Noetix Search Builder on a client computer to generate a Search instance on a server computer: In this scenario, Noetix Search is already installed on a server computer. On the client computer, run the Noetix Search setup and only select the Noetix Search Builder component for installation. After Noetix Search Builder is installed, run the application and point the Solr URL path on the Solr Connection page to the server computer. Generating a search instance on an alternate server computer or a client computer apart from the search instance on a production computer to generate search indexes offline: In this scenario, Noetix Search is already installed on a server computer. On another server computer or a client computer, run the Noetix Search setup and install the components (the Integrate Apache Tomcat with IIS component is optional). Now, you have a separate computer to generate search indexes. You can copy indexes from one 28 Noetix Search Installation Guide

37 computer to the other by stopping the Apache Tomcat service on the computer that the indexes are being copied to. The index files are located under <Noetix Search Installation Folder>\Solr\solr\data. Verifying the Installation After you are done with the installation on Microsoft Windows, Linux, or Solaris, verify whether the installation is successful by going to number, or 80>/noetixsearch. Noetix Search should open in your Web browser. Alternatively, on Windows, you can access this URL by clicking Start > All Programs > Noetix Search > Noetix Search. Chapter 3: Installing Noetix Search 29

38 Reinstalling the Software This section explains how to reinstall Noetix Search on a computer running Microsoft Windows, Linux, or Solaris. On Windows You can reinstall the software using the same Noetix Search setup that was used for the initial installation. Reinstallation of the software may be required in the following scenarios: When a new component is to be added to the existing Noetix Search installation. When the initial installation is corrupted or could not be completed due to technical problems. To reinstall Noetix Search 1. Perform steps 1 through 3 provided under On Windows in the Installing the Software section. The Installation Found page appears. 30 Noetix Search Installation Guide

39 2. Click the Add/Reinstall components option on the page, and then click Next. The Choose Components page appears. NOTE: The components that are already installed will be automatically reinstalled and unavailable for selection. The details of the components are provided in step 3 under On Windows in the Installing the Software section. Chapter 3: Installing Noetix Search 31

40 3. Select the components you want to install, and then click Next. If you selected the Install Apache Tomcat component, the Noetix Search Setup page appears as shown under step 4. If you did not select the Install Apache Tomcat component, the Apache Tomcat Information page appears. 32 Noetix Search Installation Guide

41 4. Specify the paths to the Tomcat configuration directory and Tomcat webapps directory and type the port that Apache Tomcat is configured on. You can accept the default path that is displayed or change the path. To change the path, click, navigate to the folder location, select the destination folder, and then click Next. The Noetix Search page appears. NOTE: If you selected to reinstall the Install Apache Tomcat component in step 3, this step will be skipped by the Noetix Search setup. Chapter 3: Installing Noetix Search 33

42 5. Click Install to start the installation process. The progress of the installation is displayed. Click Show details to view the actions performed by the installation wizard. To copy the installation log, right-click the information, and then click Copy Details To Clipboard. You can then paste and save the installation log in any text-editing program. 6. Click Next when the setup has successfully completed. The last page appears with a message that Noetix Search has been installed successfully. 34 Noetix Search Installation Guide

43 7. Click Finish to exit the Noetix Search Setup wizard. On Linux or Solaris You can reinstall the software on a computer running Linux or Solaris by performing the steps provided under On Linux or Solaris in the Installing the Software section. IMPORTANT: After the reinstallation is complete, you must restart the Apache Tomcat service so that any of the previous installation s files that are cached by Apache Tomcat are refreshed. Chapter 3: Installing Noetix Search 35

44 Upgrading the Software This section explains how to upgrade Noetix Search on a computer running Microsoft Windows, Linux, or Solaris. On Windows The procedure for upgrading Noetix Search on Windows is as follows: To upgrade Noetix Search 1. Perform steps 1 through 3 provided under On Windows in the Installing the Software section. The Installation Found page appears. 36 Noetix Search Installation Guide

45 2. Click Next to proceed with the upgrade. The Choose Components page appears. NOTE: The components that are already installed will be automatically selected for upgradation and unavailable for selection. The details of the components are provided in step 3 under On Windows in the Installing the Software section. Chapter 3: Installing Noetix Search 37

46 3. Select the components that you want to upgrade, and then click Next. The Noetix Search page appears. If you selected the Install Apache Tomcat component, the Noetix Search Setup page appears as shown under step 4. If you did not select the Install Apache Tomcat component, the Apache Tomcat Information page appears. 38 Noetix Search Installation Guide

47 4. Specify the paths to the Tomcat configuration directory and Tomcat webapps directory and type the port that Apache Tomcat is configured on. You can accept the default path that is displayed or change the path. To change the path, click, navigate to the folder location, select the destination folder, and then click Next. The Noetix Search page appears. Chapter 3: Installing Noetix Search 39

48 5. Click Install to start the installation process. The progress of the installation is displayed. You can click Show details to view the actions performed by the installation wizard. To copy the installation log, right-click the information, and then click Copy Details To Clipboard. You can then paste and save the installation log in any text-editing program. 40 Noetix Search Installation Guide

49 6. Click Next when the setup has successfully completed. The last page appears with a message that Noetix Search has been installed successfully. 7. Click Finish to exit the Noetix Search Setup wizard. Chapter 3: Installing Noetix Search 41

50 On Linux or Solaris You can upgrade the software on a computer running Linux or Solaris by performing the steps provided under On Linux or Solaris in the Installing the Software section. IMPORTANT: After the upgrade is complete, you must restart the Apache Tomcat service so that any of the previous installation files cached by Apache Tomcat are refreshed. 42 Noetix Search Installation Guide

51 Uninstalling the Software This section explains how to uninstall Noetix Search on a computer running Microsoft Windows, Linux, or Solaris. On Windows The procedure for uninstalling Noetix Search on Windows is as follows: To uninstall Noetix Search 1. Click Start > All Programs > Noetix Search <version> > Uninstall. Alternatively, you can uninstall the software using Add or Remove Programs in Control Panel. The Welcome to the Noetix Search Unistall Wizard page appears. Chapter 3: Installing Noetix Search 43

52 2. Review the information provided on this page, and then click Next to continue. The Uninstall Noetix Search page appears. 3. Click Uninstall. The uninstall process starts, and the next page displays the progress of the uninstallation. You can click Show details to view the actions performed by the uninstallation wizard. To copy the uninstallation log, right-click the information, and then click Copy Details To Clipboard. You can then paste and save the uninstallation log in any text-editing program. 44 Noetix Search Installation Guide

53 4. Click Next when the setup has successfully completed. The last page appears with a message that Noetix Search has been uninstalled successfully. 5. Click Finish to exit the Noetix Search Setup wizard. NOTE: After the uninstallation process, all generated content is removed. Apache Tomcat will also be removed if it was installed as a part of the Noetix Search installation. On Linux or Solaris The procedure for uninstalling Noetix Search on Linux or Solaris is as follows: To uninstall Noetix Search 1. Stop the Apache Tomcat service. 2. At the command prompt, delete the directory where Noetix Search is installed (for example, rm rf /usr/local/noetixsearch) to uninstall Noetix Search. 3. Restart the Apache Tomcat service. Chapter 3: Installing Noetix Search 45

54

55 Chapter 4 Post-Installation Tasks This chapter explains the tasks that must be completed after installation of Noetix Search.

56 Overview After installation of Noetix Search, you need to perform certain post-installation tasks. This chapter deals with the specific configuration steps that you must perform. 48 Noetix Search Installation Guide

57 Configuring ORACLE_HOME or TNS_ADMIN To work with Noetix Search Builder, the ORACLE_HOME or TNS_ADMIN environment variable must be configured. Configuring the ORACLE_HOME or TNS_ADMIN environment variable enables the Oracle client to access the Oracle database. This section explains how to configure the ORACLE_HOME or TNS_ADMIN environment variable on a computer running Microsoft Windows, Linux, or Solaris and on which the Oracle client tools have been installed. On Windows You must configure the ORACLE_HOME or TNS_ADMIN environment variable on the computer where you have installed Noetix Search Builder. To configure the ORACLE_HOME or TNS_ADMIN environment variable 1. In Control Panel, double-click System. The System Properties dialog box is displayed. 2. Click the Advanced tab, and then click Environment Variables. The Environment Variables dialog box is displayed. 3. In the System variables area, click New. The New System Variable dialog box is displayed. 4. In the Variable name box, type ORACLE_HOME or TNS_ADMIN. 5. In the Variable value box, type the path of the Oracle Home folder or the Oracle TNS ADMIN folder where the tnsnames.ora file is located (for example, C:\oracle\ora92\network\ADMIN). 6. Click OK to close the dialog boxes. Chapter 4: Post-Installation Tasks 49

58 On Linux or Solaris You must configure the ORACLE_HOME or TNS_ADMIN environment variable on the computer where you have installed Noetix Search Builder. To configure the ORACLE_HOME environment variable 1. At the command prompt, press ENTER after you type the following commands in the order in which they are specified: ORACLE_HOME=<path of the Oracle Home folder> (for example, ORACLE_HOME=/usr/oracle/ora92) export ORACLE_HOME NOTE: To set the ORACLE_HOME environment variable permanently, edit the user startup script (for example, /home/user/.profile) or a system-wide startup script (for example, /etc/profile) so that the script runs the commands that are mentioned in this step. 2. To verify that the ORACLE_HOME environment variable has been set correctly, type echo $ ORACLE_HOME at the command prompt, and then press ENTER. The path of the ORACLE_HOME environment variable will be displayed. To configure the TNS_ADMIN environment variable 1. At the command prompt, press ENTER after you type the following commands in the order in which they are specified: TNS_ADMIN=<path of the Oracle TNS ADMIN folder> (for example, TNS_ADMIN=/usr/oracle/ora92/network/ADMIN) export TNS_ADMIN NOTE: To set the TNS_ADMIN environment variable permanently, edit the user startup script (for example, /home/user/.profile) or a system-wide startup script (for example, /etc/ profile) so that the script runs the commands that are mentioned in this step. 2. To verify that the TNS_ADMIN environment variable has been set correctly, type echo $ TNS_ADMIN at the command prompt, and then press ENTER. The path of the TNS_ADMIN environment variable will be displayed. 50 Noetix Search Installation Guide

59 Appendix Legal Notices

60 GNU Lesser General Public License Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, this License refers to version 3 of the GNU Lesser General Public License, and the GNU GPL refers to version 3 of the GNU General Public License. The Library refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An Application is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A Combined Work is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the Linked Version. The Minimal Corresponding Source for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The Corresponding Application Code for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 52 Noetix Search Installation Guide

61 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) Under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) Under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. Appendix: Legal Notices 53

62 d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 54 Noetix Search Installation Guide

63 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License or any later version applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. Appendix: Legal Notices 55

64 GNU General Public License Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to ensure that the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to ensure that you have the freedom to distribute copies of free software (and charge for this service if you want), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must ensure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. 56 Noetix Search Installation Guide

65 Also, for each author s protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We want to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The Program, below, refers to any such program or work, and a work based on the Program means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term modification.) Each licensee is addressed as you. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Appendix: Legal Notices 57

66 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: 1. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. 2. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. 3. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 58 Noetix Search Installation Guide