SETTING UP ORACLE ULTRA SEARCH FOR ORACLE PORTAL 10G (10.1.4)

Transcription

1 Oracle Application Server Portal Technical Note SETTING UP ORACLE ULTRA SEARCH FOR ORACLE PORTAL 10G (10.1.4) November 2005

2 INTRODUCTION This Technical Note describes how to setup up and configure Oracle Ultra Search for use with Oracle Portal. Oracle Portal provides Ultra Search integration and an Ultra Search portlet out of the box. This functionality is pre-configured in the infrastructure database and ready to use in Oracle Portal by performing only a few simple configuration steps. This Technical Note is intended for portal administrators who want to setup Oracle Ultra Search within their deployment environment. The document describes step-bystep, how to configure Oracle Ultra Search, as well as in Oracle Portal, and this includes the following tasks: Creating a new Ultra Search user Modifying Oracle Application Server configuration files Making Oracle Portal page groups searchable Creating a new Ultra Search instance that searches Oracle Portal page groups Adding an Ultra Search portlet to a portal page STEP BY STEP INSTRUCTIONS INITIAL SETUP OF ORACLE ULTRA SEARCH FOR USE WITH PORTAL Your first step is to create a new Ultra Search user in the database and configure the Oracle Application Server middle-tier accordingly. Then you can pre-configure Ultra Search for use with Oracle Portal, using the Ultra Search administration tool: Note: You can also perform SQL*Plus actions from Oracle Enterprise Manager. 1. Create an additional temporary tablespace, minimum 50 MB (in addition to the default temporary tablespace in the portal infrastructure database). Oracle Ultra Search uses the Oracle Text intensively. Therefore, a large temporary tablespace must be created for the Oracle Text system user CTXSYS. CREATE TEMPORARY TABLESPACE <new_tablespace_name> TEMPFILE '<path_to_datafile>/<datafile_name>.dbf' SIZE 50M; 2. Assign the temporary tablespace (created in Step 1) to the CTXSYS user. From SQL*Plus, connect as SYSTEM or SYS and enter: SQL> ALTER USER CTXSYS TEMPORARY TABLESPACE <new_tablespace_name>; 3. Create a new Oracle Ultra Search user and grant privileges (for example, the WKUSER role) to the Ultra Search user that will host new Ultra Search instances. From SQL*Plus, connect as SYSTEM or SYS and enter: SQL> CREATE USER <username> IDENTIFIED BY <password> DEFAULT TABLESPACE <default_tablespace> TEMPORARY TABLESPACE <temporary_tablespace> QUOTA UNLIMITED ON <default_tablespace>; 2

3 SQL> GRANT CONNECT, RESOURCE, WKUSER TO <username>; For example, call your Ultra Search user US_USER. 4. For security reasons, Oracle recommends that you reset the default password of the Ultra Search super user WKSYS. From SQL*Plus, connect as SYSTEM or SYS and enter: SQL> ALTER USER WKSYS IDENTIFIED BY <password>; 5. Edit the OC4J configuration file <MID_TIER_ORACLE_HOME>/j2ee/OC4J_Portal/config/datasources.xml Add the following section to the configuration file, replacing username, password and the infrastructure_hostname with valid values. For example, <data-source class="oracle.jdbc.pool.oracleconnectioncacheimpl" name="ultrasearchds" location="jdbc/ultrasearchpooledds" username="<username>" password="<password>" le_port>:<oracle_sid>" /> 6. Edit the Ultra Search configuration file <MID_TIER_ORACLE_HOME>/ultrasearch/webapp/config/ultr asearch.properties Replace infrastructure_hostname in connection.url with a valid value and infrastructure_home in admin.srchome with the physical directory to the infrastructure Oracle Home. connection.driver=oracle.jdbc.driver.oracledriver connection.url=jdbc:oracle:thin:@<infrastructure_hostn ame>:<oracle_port>:<oracle_sid> admin.srchome=<infrastructure_home>/ultrasearch /webapp/ultrasearch_admin.ear For example, jdbc:oracle:thin:@myhost:1521:asdb. 3

4 7. Log in to the Oracle Ultra Search administration tool to create an Ultra Search instance. a. Point your Web browser to: admin/index.jsp For example, in/index.jsp. b. In the Ultra Search login page, enter: c. Click Login. User Name: WKSYS Password: <password> Note: The user WKSYS is the default Ultra Search super-user who can create Ultra Search instances. 8. At the top of the Instances tab, click Create and then Create Instance: a. Enter the following: New Instance Name: ULTRASEARCH_INST (or choose another name) Database Schema: <username_from_ultrasearch_schema> Schema Password : <password_from_ultrasearch_schema> Note: Enter username and password of the Ultra Search user created in Step 3 (for example, US_USER). b. Click Apply. 9. Check that Oracle Ultra Search is correctly installed. From SQL*Plus, connect as the Ultra Search user you created in Step 3 (for example, US_USER) and enter this query: SQL> SELECT index_name 2 FROM user_indexes 3 WHERE index_type = 'NORMAL'; This query should return 16 rows. 10. Log out from the Oracle Ultra Search administration tool as the WKSYS user and log in as the Ultra Search user you created in Step 3: a. Click Logout. b. Enter: User Name : <username_from_ultrasearch_schema> Password : <password_from_ultrasearch_schema> c. Click Login. 11. On the Instances Tab, choose the Ultra Search instance you created in Step 8 (for example, ULTRASEARCH_INST) and then click Apply. 12. Check to see if you can navigate from tab to tab within this Oracle Ultra Search instance. 4

5 CONFIGURATION STEPS IN ORACLE PORTAL Now that the basic Ultra Search configuration is complete, you can register the Ultra Search provider in Oracle Portal. You can also need to specify which page groups and pages that Oracle Ultra Search may search remember that the Ultra Search portlet can only search public page groups and public pages in your portal. 13. Access Oracle Portal by entering the following URL in your browser: For example, Log in into Oracle Portal as an administrator and navigate to the Builder page. a. Click the Administer tab and locate the Portlets sub-tab. b. Click the Register a Provider link in the Remote Providers portlet. 15. Register the Oracle Ultra Search provider: a. First, check that the Ultra Search provider is operational. Open a new browser window and enter the following URL: ultrasearch/servlet/soaprouter/ You should see following message: Congratulations! You have successfully reached your Provider's Test Page. b. In the Remote Providers page, enter the following: Name: Display Name: Timeout: Timeout Message: Timed Out Implementation Style: Web c. Click Next and enter: ULTRASEARCH Oracle Ultra Search 60 seconds Oracle Ultra Search Provider has URL: ltrasearch /servlet/soaprouter/ Service ID: Login Frequency: d. Click Next and enter: Grantee: Type: Privilege: e. Click Finish. PORTAL USER Manage urn:ultrasearch Once Per Session 5

6 16. So that you can test the Oracle Ultra Search portlet, create a public page group containing public pages in Oracle Portal: Note: The Ultra Search portlet can search only public page groups and public pages. a. Using the Portal Navigator, create a new Page Group named, for example, My_Ultra_Search_Page_Group. b. Create two sub-pages inside this Page Group named, for example, Ultra_Search_Page1 and Ultra_Search_Page2. c. Make both sub-pages public. For each page: 1. Click Properties. 2. Click the Access tab. 3. Select Display Page to Public Users. d. On each sub-page, add some sample items, for example, a Word document, an HTML file, or an Excel spreadsheet. Later on you can test the Ultra Search portlet, e. Make the page group public: a. Click Page Group: Properties. b. Click the Access tab and grant view access to the PUBLIC user as follows: f. Click OK. Grantee: Type: PUBLIC USER Privilege: View SCHEDULE ULTRA SEARCH TO CRAWL AND INDEX PORTAL CONTENT Now that Oracle Portal contains some public content, Oracle Ultra Search needs to crawl and index the public page groups and public pages. You can schedule the crawler and initiate the indexing process using the Oracle Ultra Search administration tool. 17. Log in to the Oracle Ultra Search administration tool: a. Point your Web browser to: admin/index.jsp For example, admin/index.jsp. b. Enter: User Name: <Ultra Search user created in Step 3> Password: c. Click Login. <password_from_ultrasearch_schema> 18. On the Instances tab, choose the Ultra Search instance you created in Step 8 (for example, ULTRASEARCH_INST) and click Apply. 6

7 19. Click the Crawler tab and enter: o Cache Directory Location - Specify the absolute path of the cache directory. o Crawler Log File Directory Specify the absolute path of the log file directory. Note: These directory locations are on the machine where Oracle Application Server middle-tier is installed. You can specify any other directory on the hard disk as the Cache Directory Location or the Crawler Log File Directory as well. Click Apply. 20. Click the Sources tab, and then click the Oracle Sources sub-tab. From the list choose Oracle Portal (Crawlable) and click Go. 21. Enter Oracle Portal registration details: a. Enter: Portal Name: MY_PORTAL <MID_TIER_ORACLE_HOME>:<port>/portal/pls/<portal_DAD>/<p ortal_schema> Note that the URL Base is case sensitive. For example, Note: The URL Format changed in Oracle Portal b. Click Register Portal. 22. Select the name of the page group you created in Step 16 and click the Create Portal Data Sources button. You can see all the public page groups in the Oracle Portal instance you have just registered. When you select a page group, Edit and Delete icons are displayed. If you click Edit, you can choose which document types are searched, for example, you can choose types such as MS Word Doc, MS Excel Doc, and PDF Doc. To select multiple document types mark the first one, hold the left mouse button, draw over the document type until the end of the list and release the mouse button. Next, click >> and then Finish. 23. To schedule how often portal data sources are indexed, navigate to the Schedules tab and then click Create New Schedule: a. Enter a Name for the schedule, for example, MY_PORTAL_SCHEDULE. b. Click Proceed to Step 2. c. Enter: Frequency Type: Time Between Launches (hours): 4 Schedule Launching Time: Indexing Option: for Indexing d. Click Proceed to Step 3. hourly <as required> Automatically Accept All URLs e. For Get Available Sources for Type, choose Portal. f. Click Get Sources. g. Move all the available sources that require indexing to the assigned sources list. 7

8 h. Click Finish. 24. Click the Scheduled link for the schedule you just created in Step 23. Click Execute immediately to start indexing your portal content. This may take a while as it starts the crawling process. When it is finished you can proceed with the next step Note that the synchronization schedule Status is set to Launching. By clicking Refresh Status you can update the status. If the status is Scheduled you can see when the next indexing attempt is due. 25. Restart your Oracle Application Server instance to effect the changes made to the configuration files. You can do this by running opmnctl stopall and opmnctl startall on the machine with the middle-tier installation as follows: MID_TIER_ORACLE_HOME/opmn/bin/opmnctl stopall MID_TIER_ORACLE_HOME/opmn/bin/opmnctl startall If it is not a convenient time to restart the whole middle-tier, just restart the OC4J_Portal instance: MID_TIER_ORACLE_HOME/opmn/bin/dcmctl restartproc process-type=oc4j_portal TEST THE ULTRA SEARCH PORTLET IN ORACLE PORTAL You can now use Oracle Ultra Search with Oracle Portal. The final step is to add the Ultra Search portlet to a page and test that it searches your portal content. 26. To initially test Oracle Ultra Search, access the JSP sample query application. Point your Web browser to: /search.jsp 27. Log in to Oracle Portal: a. Navigate to the page group you created in Step 16, for example, My_Ultra_Search_Page_Group. Add the Ultra Search portlet to the root page. You can find the Ultra Search portlet in the Portlet Repository under Portlet Staging Area > Oracle Ultra Search. b. Enter some search criteria and click Submit. Note: You can toggle between a simple search and an advanced search by clicking the appropriate links in the upper right corner of the Ultra Search portlet. CONFIGURATION WHEN ORACLE PORTAL RUNNING IN SSL MODE If Oracle Portal is configured to run in SSL mode, only clients that trust the portal s SSL certificate can access the portal. The following steps describe how you can add a portal s SSL certificate to the Oracle Ultra Search truststore using the keytool utility. This is necessary if the certificate used is not well known (Verisign, for example) or is not one that is trusted by the Oracle Ultra Search client. keytool is truststore management tool from Sun Microsystems. Refer to Sun Microsystems documentation, including the JSSE User s Guide, for more detailed information about the keytool key and certificate management utility. See also Oracle Ultra Search Administrator's Guide 10g Release 2 (10.1.2). 8

9 To add a portal SSL certificate to the Oracle Ultra Search truststore: 1. On the Oracle Application Server middle tier, locate the directory ORACLE_HOME/jdk/jre/lib/security/. 2. Create a backup of the truststore file cacerts, for example, cacerts.bak. 3. Execute the following command to add the portal SSL certificate to the Oracle Ultra Search truststore: $ORACLE_HOME/jdk/bin/keytool -import -alias <aliasname> -file <root_certificate_file_name> -trustcacerts -v -keystore $ORACLE_HOME/jdk/jre/lib/security/cacerts 4. Provide the truststore password, and then type Yes when prompted for confirmation. 5. Repeat steps 1 through 4 to copy the certificate in the Oracle Application Server Infrastructure containing the Oracle Ultra Search crawler. See also, Oracle Application Server Portal Configuration Guide on Oracle Technology Network (OTN) at TROUBLESHOOTING This section lists some problems that might occur whilst you configure Oracle Ultra Search with Oracle Portal and also provides some solutions. Problem: wk_test user account is locked. Cause: This error may occur if you are trying to use the Ultra Search portlet and the wk_test user account is locked. Action: Unlock wk_test by connecting to the database as sys. See also Oracle Ultra Search Administrator's Guide. Problem: Errors adding the Ultra Search portlet. Cause: data-sources.xml may not contain an Ultra Search entry (UltraSearchDS). Action: Add the UltraSearchDS entry to the data-sources.xml file and restart OC4J_Portal. For instructions, see step 5 - INITIAL SETUP OF ORACLE ULTRA SEARCH FOR USE WITH PORTAL. Problem: The URL entered may be wrong or is not running. Cause: This error can occur if you are trying to register a portal source using an SSL port but required certificate does not exist in the Ultra Search truststore. Action: Use keytool to copy the portal s SSL certificate to the Oracle Application Server middle tier. For instructions, see steps 1 through 4 - CONFIGURATION WHEN ORACLE PORTAL RUNNING IN SSL MODE. Problem: Unable to search using the Ultra Search portlet or the Ultra Search portlet does not return any results from newly added page groups. Cause: The portal s SSL certificate may not exist in the Oracle Application Server Infrastructure. Action: Use keytool to copy the portal s SSL certificate to the Oracle Application Server Infrastructure. For instructions see step 5 - CONFIGURATION WHEN ORACLE PORTAL RUNNING IN SSL MODE. Problem: The Ultra Search Portlet throws a Java Exception after upgrade to Oracle Portal

10 Cause: The URL Format in Portal changed and for that Oracle Portal needs to be reregistered in the Oracle Ultra Search Administration UI. Action: This is documented in the Oracle Application Server Portal Installation and Upgrade Guide 10g Release 2 (10.1.4) Chapter The new required URL formatat is documented in the Oracle Application Server Portal Configuration Guide 10g Release 2 (10.1.4) Chapter SUMMARY This Technical Note has described how to set up Oracle Ultra Search so that you can leverage the power of Oracle Ultra Search in Oracle Portal. The Ultra Search portlet will enable users within your organization to be more productive, since finding information is highly optimized. RELATED MATERIAL For more information, refer to the following guides on Oracle Technology Network (OTN) at Oracle Application Server Portal Configuration Guide 10g Release 2 (10.1.4) Chapter 8.2.4, Chapter 8.4 Oracle Ultra Search Administrator's Guide Oracle Application Server Portal Installation and Upgrade Guide 10g Release 2 (10.1.4) Chapter

11 Setting up Oracle Ultra Search for Oracle Portal Author: Christian Hauser November 2005 Oracle Corporation World Headquarters 500 Oracle Parkway Redwood Shores, CA U.S.A. Worldwide Inquiries: Phone: Fax: Copyright 2005, Oracle. All rights reserved. This document is provided for information purposes only and the contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without our prior written permission. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.