2 Getting Started with Oracle Ultra Search

Overview

This chapter provides information about getting started with Oracle Ultra Search. It features an example scenario that describes installation and use of Oracle Ultra Search. It enables you to create a browser-based search application to query data sources.

For this example, a fictional customer service call center named Ultra Appliance, Inc. is used. Ultra Appliance is a major retail company that sells and supports hundreds of different appliances from dozens of different manufacturers in stores nationwide. Customers contact the customer service call center every day to receive technical help for, and assistance with, an appliance.

Ultra Appliance call center agents must access a variety of online resources to provide the information needed by the customer.

In this example, the Ultra Appliance call center agents have access to two types of information:

• An intranet that contains documents on Web pages with detailed information about appliances sold and serviced by Ultra Appliance.

• A database that contains information about previous maintenance issues and solutions for appliances sold and serviced by Ultra Appliance.

For this example, the Ultra Appliance call center agents search the company intranet and the problem database for information on, and any issues associated with, the Springmaster 2000 refrigerator.

This chapter describes how you, acting as the Ultra Appliance search administrator, can set up a browser-based search application that enables call center agents to find information for appliances that they support.

The final section of the chapter describes how you, acting as an Ultra Appliance call center agent, can use Oracle Ultra Search to query the company intranet and database.

Refer to this guide, the Oracle Ultra Search User's Guide, for detailed instructions on installation, configuration, and administration of Oracle Ultra Search.

Installation

The instructions in this section are meant to briefly cover installation. For further installation information, see Chapter 3, "Installing and Configuring Ultra Search" in this book. You may also want to see the Oracle Universal Installer Concepts Guide for detailed installation instructions. Oracle Ultra Search is installed as part of the Oracle Database Server installation, which uses Oracle Universal Installer.

$ORACLE_HOME/bin/searchctl start

http://your_computer.com:http_port/ultrasearch/admin/index.jsp 

$ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/http-web-site.xml

Setting up the Sample Query Application

Oracle Ultra Search provides APIs with which you can build customized, J2EE query applications. Oracle Ultra Search also includes a sample application of this sort.

To set up the sample query application, do the following (put in your own values for the host name, the port, and the SID):

1. Add the following entry to the ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/data-sources.xml file:

   <data-source
   class="oracle.jdbc.pool.OracleConnectionCacheImpl"
   name="UltraSearchDS"
   location="jdbc/UltraSearchPooledDS"
   username="wk_test"
   password="wk_test"
   url="jdbc:oracle:thin:@database_host:oracle_port:oracle_sid"
   />
   
   

2. If you started the Oracle Ultra Search middle tier to access the Oracle Ultra Search administration application, then you must stop and restart it, with the query application now configured to use the query application:

   $ORACLE_HOME/bin/searchctl stop
   $ORACLE_HOME/bin/searchctl start
   
   

After the middle tier has been started, you can access the query application by means of an HTML browser pointed to:

http://your_computer.com:http_port/ultrasearch/query/search.jsp.  

At the end of the installation, you should be able to find http_port on the Oracle Universal Installer screen. You can also find out the value of http_port by looking at:

$ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/http-web-site.xml

Setting up the Ultra Appliance Demo

You need to access and set up the Ultra Appliance demo before you begin this exercise.

To access the Ultra Appliance intranet site, go to:

http://otn.oracle.com/products/ultrasearch/gettingstarted/

To set up the Ultra Appliance company database:

1. Copy the appliances.sql script shown in the Example 2-1 into a text editor and save this file as appliances.sql.

2. Place the appliances.sql script into your database server computer.

3. Upload the appliance.sql file to your database schema WK_TEST by running the following statements:

   prompt > sqlpls WK_TEST/WK_TEST
   SQLPLUS > @appliance.sql;
   SQLPLUS > commit;
   SQLPLUS > exit
   

   Example 2-1 appliances.sql script

   DROP TABLE product;
   CREATE TABLE product (id NUMBER PRIMARY KEY, Description VARCHAR2(200), 
        Parts VARCHAR2(80));
   INSERT INTO product VALUES(1, 'Springmaster 2000', 'Cantaloupe Tray');
   INSERT INTO product VALUES(2, 'TipNClear 2000', 'TipNVac Tray');
   INSERT INTO product VALUES(3, 'Spew 2000', 'Extra Dirt' );
   INSERT INTO product VALUES(4, 'Hold Em 2000', 'Spare Magnets');
   INSERT INTO product VALUES(5, 'Pizza Legend 2000', 'No. 7 Pizza Tube');
   INSERT INTO product VALUES(6, 'SnoozePower 2000', 'Lint Screen');
   DROP TABLE problems;
   CREATE TABLE problems (Problem_ID NUMBER PRIMARY KEY, Customer_Name VARCHAR2(40), 
        Product_ID NUMBER, Date_ID DATE, Problem_Description VARCHAR2(200), 
        Resolution_Text VARCHAR2(200));
   INSERT INTO problems VALUES(1, 'Jones', 4, '10-Aug-03', 'Magnets pointed wrong way',
        'Solved by reversing pet');
   INSERT INTO problems VALUES(2, 'Smith', 1, '01-Oct-02', 'Cantaloupe wrong color',
        'Solved by icing down melons');
   INSERT INTO problems VALUES(3, 'Chan', 3, '10-Apr-03', 'Clogged by cat hair',
        'Solved by getting new cat');
   INSERT INTO problems VALUES(4, 'Ali', 5, '29-May-03', 'Will not work with anchovies',
        'Cannot solve');
   INSERT INTO problems VALUES(5, 'Johnson', 2, '28-Feb-03', 'Husband on couch',
        'Solved by removing husband');
   INSERT INTO problems VALUES(6, 'Kawamoto', 6, '11-Nov-02', 'Pillow too loud',
        'Solved by turning pillow over');
   INSERT INTO problems VALUES(7, 'Weiss', 3, '15-May-03', 'Dirt coming out wrong color',
        'Solved by bleaching dirt');
   INSERT INTO problems VALUES(8, 'Claire', 5, '20-Jun-03', 'Overheats cheese',
        'Solved by using better-quality cheese');
   INSERT INTO problems VALUES(9, 'Dontenmann', 2, '08-Jan-03', 'Gum stuck, will not shake out',
        'Solved by increasing power');
   INSERT INTO problems VALUES(10, 'Glass', 4, '22-Aug-03', 'Ferret allergic to magnets',
        'Solved by washing magnets');
   INSERT INTO problems VALUES(11, 'Heyboll', 1, '03-Sep-02', 'Flying cantaloupes injuring family',
        'Solved by ducking');
   

Crawl and Index Ultra Appliance's Intranet Documents

This section describes the steps you, acting as the Ultra Appliance search administrator, use to set up Oracle Ultra Search to crawl and index the company intranet. After you perform this setup, call center agents can use Oracle Ultra Search to obtain information about the Springmaster 2000 refrigerator.

To crawl and index the Ultra Appliance intranet:

1. Log on to Oracle Ultra Search using the Oracle Ultra Search Administration Tool screen.

   In your Web browser, enter the domain and port of the computer where you have Oracle Ultra Search installed, followed by /ultrasearch/admin/index.jsp:

   http://your_computer.domain:http_port/ultrasearch/admin/index.jsp

   For example,

   http://comp1.ultrasupply.com:7778/ultrasearch/admin/index.jsp

2. Enter the User Name and Password to Login to Oracle Ultra Search.

   For this example:

   Login: WK_TEST

   Password: WK_TEST

   The login screen is displayed in Figure 2-1.

   Figure 2-1 Oracle Ultra Search Login Screen

   
   Description of the illustration loginscreen.gif
   
   

3. Select an Oracle Ultra Search Instance screen.

   Select the Instances tab on the browser view.

   Select the WK_INST instance from the pull down menu and click Apply.

4. Configure the Oracle Ultra Search crawler settings.

   Select the Crawler tab on the browser view.

   Use the following values for crawler settings:

   • Crawler Threads: 20

   • Number of Processors: 1

   • Automatic Language Detection: No

   • Default Language: English

   • Crawling Depth: No Limit

   • Crawler Timeout Threshold: 30

   • Default Character Set: ISO Latin-1

   • Temporary Directory Location and Size: /tmp, 5

   • Crawler Logging: /tmp/, English

   • Database Connect String: Leave this field unchanged.

5. Create a Web Data Source.

   Select the Sources tab on the browser view.

   Under the Web Sources header, click the Create web source button.

   1. Create Web Source: Step 1

      Enter Ultra Appliance as the Source name.

      Under the Starting Addresses heading, enter the complete URL of the location of the Ultra Appliance intranet Web site demo:

      http://otn.oracle.com/products/ultrasearch/gettingstarted/
      
      

      Click the Add button to add the Ultra Appliance to the list of Web addresses.

      Click Next.

   2. Create Web Source: Step 2 (URL Boundary Rules)

      Accept the default values and click Next.

   3. Create Web Source: Step 3 (Document Types)

      Specify the types of document you would like Oracle Ultra Search crawler to crawl.

      Under the Document Types header, select:

      • HTML

        Microsoft Word Document

        PDF Document

        After you make each selection, click >> to add the document types to the list of document types for crawling.

        Click Next.

   4. Create Web Source: Step 4

      Accept the default values and click Finish.

      The Ultra Appliance Web site demo should be added to the Web Source List.

6. Schedule the Ultra Search Crawler.

   Select the Schedule tab and click the Create new schedule button.

   1. Create Schedule: Step 1 of 3 screen.

      In the Name field, enter Ultra Appliance.

      Click the Proceed to step 2 button.

   2. Create Schedule: Step 2 of 3 screen.

      Select "Every 1 week(s) on Monday starting at 0100 hours."

      Under the Indexing option heading, select "Automatically accept all URLS for indexing."

      Under the Remote Crawler Profiles, select database host from the drop down list.

      Click Proceed to step 3.

   3. Create Schedule: Step 3 of 3 screen.

      Select Web from the drop down menu.

      Select Ultra Appliance from the Available Sources menu and transfer it to the Assigned Sources menu by clicking >>.

      Click Finish.

7. Execute crawling and indexing.

   On the Synchronization Schedules page, locate Ultra Appliance in the Schedules column.

   1. In the Status column for the Ultra Appliance row, verify that the status is in the Scheduled condition.

   2. Click the Scheduled link. The Synchronization Schedule Status page is displayed.

   3. Click the Execute immediately button so that Oracle Ultra Search can crawl and index the Ultra Appliance intranet site.

      Click the Refresh status button, so that you see schedule status changes. When the schedule status displays Scheduled, the crawling is complete.

Crawl and Index Ultra Appliance's Database Documents

This section describes how you, acting as the Ultra Appliance search administrator, would set up Oracle Ultra Search to search for the Ultra Appliance company database for problem information about the Springmaster 2000 refrigerator.

You can configure the Oracle Ultra Search crawler to crawl the database you set up in Setting up the Ultra Appliance Demo.

To crawl and index the Ultra Appliance database:

1. Follow steps 1 through 4 in the Crawl and Index Ultra Appliance's Intranet Documents section.

2. Create a table data source.

   Select the Sources tab and then the Table sub-tab on the browser view.

   Under the Table Sources header, click the Create new table source button.

   1. Create Table Source: Step 1

      Enter a name, such as Ultra Appliance DB, in the Name field for the Table Source Name. (The name should not be the same as the one you entered when you crawled and indexed Intranet documents.)

      Under the Database Table heading do not use a database link.

      Enter the schema name of WK_TEST in the Schema field.

      Enter the name of Problems in the Table name field.

      Click the Locate table button.

      The following note is displayed if a table is present in your database:

      Note: Successfully located table problems.

      Click Proceed to Step 2.

   2. Create Table Source: Step 2

      Accept the default values for Language.

      Under the Complex Primary Key heading, add the PROBLEM_ID table column by clicking Add column.

      Under the Content Column and Type heading, select PROBLEM_DESCRIPTION for Column and Plaintext for the Type

      Click Proceed to Step 3.

   3. Create Table Source: Step 3

      Under the Verify Table Source Details heading, confirm the settings and values that will be displayed in the Oracle Ultra Search output.

      Click Create Table Source.

   4. Table Source Logging

      Select Disable logging mechanism and click Apply.

   5. Create Table Source: Step 4

      Specify the table columns and search attribute mappings you want Oracle Ultra Search crawler to crawl on the database.

      For this example, select:

      • RESOLUTION_TEXT for table column with search attribute of Description [String]

      • CUSTOMER_NAME for table column with search attribute of Author [String]

      After you make each selection, click Map to add the document types to the list of document types for crawling.

      Click Proceed to step 5.

   6. Create Table Source: Step 5

      Select No display URL and click Finish.

3. Schedule the Ultra Search Crawler.

   See Step 6 in Crawl and Index Ultra Appliance's Intranet Documents for procedures on how to set up a crawler schedule.

   Select Table from the drop-down list seen on the Create Schedule: Step 3 of 3 screen.

4. Run crawling and indexing, as shown in Step 7 in "Crawl and Index Ultra Appliance's Intranet Documents".

Issuing a Query

This section describes the steps you, acting as the Ultra Appliance call center agent, use Oracle Ultra Search to query the company intranet and database. You can query the Ultra Appliance information sources after you have allowed Oracle Ultra Search to crawl and index the Ultra Appliance intranet and database.

To query the Ultra Appliance intranet:

1. Enter the URL for the Oracle Ultra Search location. For example:

   http://your_computer.com:http_port/ultrasearch/query/search.jsp

2. Enter Springmaster 2000 in the Search For field.

   You should see the output displayed in Figure 2-2.

   Figure 2-2 Oracle Ultra Search Search Output

   
   Description of the illustration intraquery.gif
   
   

To query the Ultra Appliance database:

• Enter Cantaloupe Wrong Color in the Search For field.

  You should output similar to the display in Figure 2-2 with links to the Springmaster 2000 Cantaloupe Tray Problem table.