H Y P E R I O N ® S M A R T S E A R C H

R E L E A S E 9 . 3 . 1

I N S T A L L A T I O N A N D C O N F I G U R A T I O NG U I D E

Smart Search Installation and Configuration Guide, 9.3.1

Copyright © 2007, Oracle and/or its affiliates. All rights reserved.

Authors: Loren Davidson

The Programs (which include both the software and documentation) contain proprietary information; they are providedunder a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, andother intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, exceptto the extent required to obtain interoperability with other independently created software or as specified by law, isprohibited.

The information contained in this document is subject to change without notice. If you find any problems in thedocumentation, please report them to us in writing. This document is not warranted to be error-free. Except as may beexpressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced ortransmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of theUnited States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered toU.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to theapplicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subjectto the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additionalrights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerousapplications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measuresto ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for anydamages caused by such use of the Programs.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of theirrespective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle isnot responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated withthe use of such content. If you choose to purchase any products or services from a third party, the relationship is directlybetween you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b)fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warrantyobligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that youmay incur from dealing with any third party.

Contents

Chapter 1. Installing Smart Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Prerequisite Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Installing Smart Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2. Configuring Smart Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Configuring Smart Search for Google OneBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Configuring Smart Search for Oracle Secure Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 3. Using Smart Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Contents iii

iv Contents

1Installing Smart Search

In This Chapter

Prerequisite Software ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Installing Smart Search... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Oracle's Hyperion® Smart Search integrates with leading enterprise search solutions GoogleSearch Appliance and Oracle Secure Enterprise Search to provide a familiar search interface.Using simple business terminology, users can obtain structured information from Oracle'sHyperion® Essbase® – System 9 applications and databases. Information that has been filteredaccording to user privileges is delivered in both data grids and live links in Oracle's Hyperion®Smart View for Office . Smart Search greatly enhances the way in which users can quickly get toinformation contained within Hyperion applications.

Prerequisite SoftwareMicrosoft Internet Explorer 6.x must be installed before installing Smart Search.

The following software, installed with Smart Search, is required to run Smart Search:

● Java SDK or JRE 1.5.x

● Apache Tomcat 5.0.28

You must also obtain the server locations and login information for the following, if applicable:

● Oracle's Essbase® Administration Services

● Essbase server

● Google Search Appliance server, if applicable

● Oracle Secure Enterprise Administration, if applicable

Installing Smart Search

➤ To install Smart Search:

1 Download the Smart Search installer from the Oracle E-Delivery site, or insert the installation CD/DVD intoa drive.

Prerequisite Software 5

2 Launch the Smart Search installer, and follow the prompts.

3 On the final screen, select the checkbox to launch Hyperion Configuration Utility.

4 Select Smart Search and Deploy to Application Server, then click Next.

5 Click Next on the Select application server and deployment type screen.

6 If you want to deploy Tomcat as a service, ensure that the Deploy as a Service box is selected.

7 Optional: If you want to use a different port for Tomcat, change the Port value.

8 Click Next, then click Next to begin deployment of Tomcat.

9 Click Next, then Finish to complete deployment configuration and exit Hyperion Configuration Utility.

6 Installing Smart Search

2Configuring Smart Search

In This Chapter

Configuring Smart Search for Google OneBox... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Configuring Smart Search for Oracle Secure Search ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Configuring Smart Search for Google OneBox

➤ To configure Smart Search for use with Google OneBox:

1 Start Administration Services Console.

2 To start the Smart Search provider, select Start > Programs > Hyperion > Smart Search > Start EssbaseProvider.

3 In Administration Services Console Enterprise View, right-click Google OneBox and select Add Provider.

4 Enter the server name and port number, and click OK.

5 Expand the Google OneBox node, right-click the provider name you just added, and select ConfigureProvider.

6 Under the Settings tab, click the Register Provider with Google Search Appliance link.

Note:

You may need to obtain the URL for this page from your administrator.

7 In the browser window that opens:

a. Enter the Google Search Appliance (GSA) server name or IP address, and the usernameand password for that server.

b. Enter a name for the front end, and select the checkbox Create Frontend if not present.

c. Enter a name for the OneBox module and a trigger keyword that will be used to select thismodule for searches.

Note:

If you select the “Overwrite OneBox module” checkbox, you will replace any existingOneBox module of the same name.

Configuring Smart Search for Google OneBox 7

d. Click Register.

8 In the Settings dialog in Administration Services Console, enter the GSA server name and front end name.

9 Optional: Configure the Selected Applications and Databases for this server; see Essbase AdministrationServices Online Help.

10 Click Apply, then Close.

Configuring Smart Search for Oracle Secure SearchThe following steps are necessary to configure Smart Search for Oracle Secure Search:

● Set up the Smart Search provider

● Configure the Oracle Secure Enterprise Search (SES) crawler

● Set up the Identity Plug-In

● Enable Support Security Agent for Single Sign-On in Oracle's Hyperion® Shared Services.Use of Smart Search with Oracle Secure Search requires that Shared Services be enabled inSingle Sign-On mode.

➤ To set up the Smart Search provider:

1 Start Administration Services Console.

2 Select Start > Programs > Hyperion > Smart Search > Start Essbase Provider to start the Smart Searchprovider.

3 In Administration Services Console Enterprise View, right-click Oracle Secure Search and select AddProvider.

4 Add the server name and port number, and click OK.

5 Expand the Oracle Secure Search node, right-click the provider name you just added, and select ConfigureProvider.

6 Under the Settings tab, click the Launch Oracle Secure Enterprise Administration page link.

Note:

You may need to obtain the URL for this page from your administrator.

7 Enter the administrator password, and click Login.

8 In the Settings dialog in Administration Services Console, enter the server URL, crawler schedule name,username, and password.

For more information, see Essbase Administration Services Online Help.

9 To test the search page, select Launch Oracle Secure Enterprise Search Page.

10 Click Apply, then Close.

8 Configuring Smart Search

➤ To configure the Oracle SES crawler:

1 On the Oracle Secure Enterprise Search Administration page, select the Search tab at the upper right, andselect Suggested Content.

2 In the Provider list, select Create.

3 Enter the following information:

● Name: A descriptive name for the provider, such as “Essbase Search Services.”

● Query pattern: A query token in the form of a Java regular expression. This will direct querieswith the keyword specified to this provider. For example, to use “essbase” as a keyword, thequery token would be essbase\s(.+).

● Provider URL: In the form <provider URL>/EssbaseSearch/Search?query=$ora:q, where <provider URL> is the name of the server running the Smart Searchprovider.

● Enable: Leave this item checked.

● XSLT Stylesheet: A template stylesheet that is installed at HYPERION_HOME\SmartSearch\hysl\ses.xls. No entry is necessary unless you need to change the default settings.

● Security Settings: Select Service to Service. Enter a Shared Services username in the EntityUsername text box and a Shared Services password in the Entity Password text box. In theFormat text box, enter “username.”

4 Select the Global Settings tab at the upper right, and select Source Types.

5 Select Create, and enter the following values:

● Name: Name of your source; for example, “EssbaseSearch.”

● Description: A description of the source; for example, “Smart Search Source for Essbase.”

● Plug-in Manager Java Class Name: The name of the Java class used to access Hyperion datasources. A sample is located in HYPERION_HOME\SmartSearch\hysl\CrawlerPlugin.If the sample .jar file is used, the class name must becom.hyperion.search.SmartSearchCrawlerPluginManager .

● Plug-in Jar File Name: The name of the .jar file used to access Hyperion data sources. Asample is located in HYPERION_HOME\SmartSearch\hysl\CrawlerPlugin\SmartSearchCrawler.jar.

6 Select the Home tab, and select Sources.

7 Select the source you named above (for example, “EssbaseSearch”) and select Create.

8 Enter the following parameter information:

● Source Name: The name of the source; for example, “EssbaseSearch.”

● Provider URL: The computer name and port number for the provider; for examplehttp://server101:16080

● Hyperion Shared Services Username and Password: Enter the Shared Services usernameand password

9 Select Create.

Configuring Smart Search for Oracle Secure Search 9

For more information about configuring Oracle SES, see the Oracle Secure Enterprise SearchAdministrator's Guide.

➤ To configure the Identity Plug-In:

1 Under the Global Settings tab, select Identity Management Setup, and then select Register new IdentityPlug-in.

2 Enter a Plug-in Manager Class Name and Plug-in Manager Jar File Name in the text boxes.

A sample file is provided, HYPERION_HOME\SmartSearch\hysl\IdentityPlugin\HSSIdentityPlugin.jar. If the sample jar file is used, the class name must becom.test.HSSPluginManager.

Note:

This file should not be used in a production environment. It provides no authenticationverification.

3 Click Finish.

4 On the Activate Identity Plug-in screen, click Activate.

5 In the Authentication Attribute drop-down box, select “Username,” then click Finish.

➤ To enable Support Security Agent for Single Sign-on:

1 Open Oracle's Hyperion® Shared Services User Management Console.

2 Right-click User Directories.

3 Select Configure User Directories.

4 Select the Support Security Agent for Single Sign-on check box.

5 Close the User Management Console.

10 Configuring Smart Search

3Using Smart Search

Using Smart Search is similar to using Google. Users receive a URL for the front end search pageand one or more keywords to access the Smart Search provider.

➤ To use Smart Search:

1 Enter the URL for the Oracle's Hyperion® Smart Search front end into your browser.

If you will be using Smart Search frequently, bookmark the page.

2 Enter the trigger keyword (for example, “essbase”), followed by the word or words you wish to search on,and click Search.

Note:

If no keyword is entered in the text box,no data grids are included in the Google search results.This is normal behavior for the Google Search Appliance.

3 Do one of the following:

● If using Smart Search with Google OneBox, enter an Oracle's Hyperion® Essbase® – System9 or Shared Services username and password, and click OK. This will only be necessary foryour first query during a session.

● If using Smart Search with Oracle Secure Search, select the Login link to launch a Login pagefor Oracle Secure Enterprise Search. Enter a Shared Services username and password, andclick Login.

4 Review your search results. Click any link for more information. Search results with data grids will displayup to 12 rows of data in the grid.

If Smart View is installed, it will launch and display results in a spreadsheet. If Smart View is notinstalled, the results will display in an Excel spreadsheet, and macros such as drill-down will notwork.

11

12 Using Smart Search