README Search Interface to SAS Content 1.5 Prerequisites Platform Microsoft Windows Microsoft Windows for x64 HP-UX HP-UX for the Itanium Processor Family Architecture Linux for x64 Solaris Solaris for x64 z/os Installation Space Required For the latest information about required JREs, please see the Third Party Software Reference Web site at http://support.sas.com/resources/thirdpartysupport/index.html. Installing Search Interface to SAS Content Before performing the following steps, Windows users should ensure they are logged in as an administrator. UNIX users should ensure they are logged in with an installer ID that is not root. 1. Unpack the download package to a location that is accessible from where you want to install the software. Do not put the download package in an existing SAS Software Depot or in the directory where you want to install. Doing so will cause the SAS Software Depot and SAS Deployment Wizard to work incorrectly. You must put the download package in its own directory/folder. 2. To start the SAS Deployment Wizard, Windows users should double click the setup.exe at the location the files have been unpacked in (if your Windows operating system is Windows Vista or later, you may have to right click the setup.exe and select Run as administrator). UNIX users should execute setup.sh and z/os users should execute the setup.rexx. 3. The Choose Language page opens. Choose the language in which you want to perform the installation of your downloaded software. Click OK. Note that Windows users who have already installed SAS software using the SAS Deployment Wizard will not see this page. 4. The Specify SAS Home page opens. Enter the location you want to install your software in the text field, or use the Browse button to search for a location. When the correct location is in 1
the text field, click on Next to continue. Note that Windows users who have already installed SAS software using the SAS Deployment Wizard will not see this page. 5. The Select Products to Install page opens. Ensure the checkbox beside every product in the list is checked. If you click the Info icon, you will be directed to documentation about the software you have downloaded. The pertinent parts of that documentation are repeated in the ʺPrerequisitesʺ section above. When each checkbox has been checked, click on Next to continue. 6. For hosts other than Windows, the Select Java Runtime Environment page opens. Either choose to install the recommended Java Runtime Environment and enter an install location, or select an existing Java Runtime Environment that will be used for the SAS software install. After making your selection, click Next to continue. 7. The Deployment Summary page opens. Click Start to begin the installation. 8. The Deployment in Progress page opens, indicating that the installation is taking place. When the installation is complete, click Next. 9. The Additional Resources page opens; listing a number of online resources should you run into difficulty. Use Print to make a copy of this information for future use. Click Finish to close the SAS Deployment Wizard. After Search Interface to SAS Content is successfully installed, you will have the following important directories under the installation home directory: Directory Contents \ sas.searchsas.ear - ear file to be deployed in the web application server of your choice. loadindex - Startup script for feeding SAS contents to the index of Google Search Appliance or SAS Search and Indexing Server. The extension of this script file will vary based on the platform on which the search interface to SAS Content is installed. (loadindex.exe for windows, loadindex for UNIX based systems and loadindex.rexx for z/os) url_list.txt Configuration file containing the URL of Search Interface to SAS Content used by loadindex application to feed the SAS Contents to supported search engines. loadindex.ini file containing the configuration information for loadindex application. \MICROSOFT \_uninstsesas SearchInterfaceToSASContent.FLD Federated Location Definition file, which will be used to integrate Search Interface to SAS Content with Microsoft SharePoint Search Server as a Federated Location. Files required to uninstall Search Interface to SAS Content For example, if you have installed Search Interface to SAS Content with default home directory in Windows, the files can be found in location: C:\Program Files\SearchInterfaceToSASContent\1.5 2
Deploying Search Interface to SAS Content Step 1 Deploying Search Interface to SAS Content Search Interface to SAS Content can be deployed on the same server where the SAS mid tier Web applications are deployed. The supported application servers for SAS mid tier are JBoss 4.2.0.GA Weblogic 9.2/10.3 WebSphere 6.1.0.17/V7 To deploy the sas.searchsas.ear file available in the installation home directory, follow the steps below under the respective servers. JBoss 4.2.0.GA 1. Copy the sas.searchsas.ear file to the document root of your JBoss. If the SAS mid tier is deployed in JBoss with the default configuration, then the document root will be <JBOSS_HOME>\server\SASServer1\deploy_sas directory. Examples: For Windows, if JBoss is installed in C:\jboss-4.2.0.GA and the SAS mid tier web applications are deployed with default configuration, then place the ear file sas.searchsas.ear in the directory: C:\jboss-4.2.0.GA\server\SASServer1\deploy_sas For UNIX, if JBoss is installed in /usr/local/jboss-4.2.0.ga and the SAS mid tier Web applications are deployed with default configuration, then place the EAR file sas.searchsas.ear in the directory: /usr/local/ jboss-4.2.0.ga/server/sasserver1/deploy_sas 2. Proceed to ʺStep 2 Configuring Search Interface to SAS Content.ʺ WebLogic 9.2/10.3 This section assumes that the WebLogic Server instance on which SAS mid tier Web applications are installed is running. 1. Open the WebLogic Server Admin Console and log in. 2. Using the Install Application Assistant of WebLogic, deploy the sas.searchsas.ear file to the server instance on which other SAS mid tier Web applications are deployed with all default configurations. 3. Once the application is deployed and started successfully, the status will change to Active. 4. Proceed to ʺStep 2 Configuring Search Interface to SAS Content.ʺ 3
WebSphere 6.1.0.17/V7 This section assumes that WebSphere on which SAS mid tier Web applications are installed is running. 1. Log on to the WebSphere Administrative Console. 2. Using the Install New Application Assistant of WebSphere to deploy the sas.searchsas.ear file to the server instance on which other SAS SAS mid tier Web applications are deployed with default configurations. 3. Start the newly deployed application. 4. Once the application is started successfully, you will get a success message and the application status will turn to green. 5. Proceed to ʺStep 2 Configuring Search Interface to SAS Content.ʺ Step 2 Configuring Search Interface to SAS Content 1. When the sas.searchsas.ear file is deployed successfully on the server and started, open the browser and enter the following URL in the address bar. where: http://<server_address>:<port>/sassearchservice/configure <server_address> is the web app server on which Search Interface to SAS Content is deployed <port> is the port of the above web app server 2. You will be prompted for authentication. Enter the administrator credential for the metadata server. 3. A success message will be displayed in the browser. When you have successfully installed follow the steps below to verify the configuration. Verifying the Configuration Once the Search Interface to SAS Content is deployed and configured you can verify whether the configuration is successful. To verify, follow the steps below: 1. Open the browser and enter the following URL in the address bar. http://<server_address>:<port>/sassearchservice/controller?forwar d=search&sasxsl=xsl/reports_more_view_template.xsl&query=<query> where: <server_address> is the web app server on which Search Interface to SAS Content is deployed <port> is the port of the above web app server <query> is the search string for the search. This should be a valid search expression which should match at least one report in the metadata server (for example, sales). 2. The SAS Login page will be displayed. Enter the user credentials. 4
3. Search results for the query entered in step 1 will be displayed in the browser. Note: If you get an empty page, there may not be any results. Change the query string and try again. When you have successfully installed and verified the configuration, you can integrate Search Interface to SAS Content with browser toolbar or with supported search engines. Follow the steps provided in the respective section for integration. Integrating Search Interface to SAS Content in the Browser Search Toolbar as a Search Provider Search interface to SAS Content can be integrated with Browser Search toolbar as a Search Provider for the following browsers: Microsoft Internet Explorer 7.0 and above Mozilla Firefox 2.0 and above To integrate with the above browsers, first follow the steps described in the section Verifying Configuration above. Once you follow all the steps, you will be able to see the search results. Then follow the steps described below for the respective browsers: Note: You need to remain on the search result page after verifying configuration to perform the steps below. Microsoft Internet Explorer 7.0 and above 1. Click on the search toolbar dropdown. 2. Select Add Search Providers from the dropdown choices. 3. It will open to a menu displaying Search Interface to SAS. Click to enable the same. 4. This will open a confirmation dialog. Click Add Provider. 5. The search tool bar is now ready to search the contents typed in. Mozilla Firefox 2.0 and above 1. Click on the search toolbar dropdown. 2. Select Add Search Interface to SAS from the dropdown choices. 3. The search tool bar is now ready to search the contents typed in. Once Search Interface to SAS Content is added in the search toolbar, you can select SAS Reports from the list of providers for searching SAS reports. Note: Search Interface to SAS Content can be integrated with browser search toolbar only for searching SAS reports. 5
Integrating with Search Engines Integrating Search Interface to SAS Content with SAS Search and Indexing Server Search Interface to SAS Content supports feeding the SAS Contents to the index of SAS Search and Indexing Server. A document containing steps for feeding the SAS Content to the index of SAS Search and Indexing Server is available from the same location from which you downloaded the software: http://www.sas.com/apps/demosdownloads/92_sdl_sysdep.jsp?packageid=000531 Integrating Search Interface to SAS Content with Google Search Appliance Search Interface to SAS Content can be integrated with Google Search Appliance in two ways. 1. Integration as an OneBox module 2. Feed the SAS Contents to Google Search Appliance s index A document containing steps for integrating Search Interface to SAS Content with Google Search Appliance is available from the same location from which you downloaded the software: http://www.sas.com/apps/demosdownloads/92_sdl_sysdep.jsp?packageid=000531 Integrating Search Interface to SAS Content with Microsoft SharePoint Search Server Search Interface to SAS Content can be integrated with Microsoft SharePoint Search Server as a Federated Location. A document containing steps for integrating Search Interface to SAS Content with Microsoft SharePoint Search Server is available from the same location from which you downloaded the software: http://www.sas.com/apps/demosdownloads/92_sdl_sysdep.jsp?packageid=000531 Enabling Logging By default, logging is disabled. Follow the instructions below to enable logging. Note: Enabling logging will have an impact on performance. 1. Specify the configuration file for logging. By default, JVM will look at the configuration parameters available in <JRE_HOME>\lib\logging.properties file. But changing this file is not advisable. Alternatively, specify a different logging properties file by setting the following system properties in the Web/Application server: -Djava.util.logging.config.file=<name of the property file> 2. Set the following properties for logging in the file mentioned above: To enable console logging, add the following to the properties file. o java.util.logging.consolehandler.level = ALL For limited logging, change the level from ALL to CONFIG. 6
o java.util.logging.consolehandler.formatter = java.util.logging.simpleformatter If the log has to be written in XML format, change the formatter to java.util.logging.xmlformatter. To enable logging into a file, provide a file name as below: o java.util.logging.filehandler.pattern = C:/sas_search_service%u.log The file name mentioned above can be changed to any other location. o java.util.logging.filehandler.formatter = java.util.logging.simpleformatter If the log has to be written in XML format, change the formatter to java.util.logging.xmlformatter. o java.util.logging.filehandler.limit = 102400 o o Specifies an approximate maximum amount to write (in bytes) to any one file. If this is zero, then there is no limit. (Defaults to no limit). java.util.logging.filehandler.append = false Specifies whether the FileHandler should append in any existing files (defaults to false). java.util.logging.filehandler.level = ALL For limited logging, change the level from ALL to CONFIG. Both console and file logging can be enabled simultaneously by following all of item 2 immediately above. 3. To enable logging for a specific set of classes only, the following should be set to the required levels: com.sas.searchsas.searchservicemanager.level = CONFIG com.sas.searchsas.sassearchservice.level = CONFIG com.sas.searchsas.metadata.defaultrelatedsearchtype.level = CONFIG com.sas.searchsas.metadata.defaultsearchtype.level = CONFIG com.sas.searchsas.metadata.iomimetadatasearchprovider.level = CONFIG com.sas.searchsas.googleonebox.xsltransformedview.level = CONFIG Note that if the logging level has been set at the Handler level, this step is not required. 7
Windows UNIX Uninstalling Search Interface to SAS Content To uninstall Search Interface to SAS Content you will have to perform the following steps 1. Undeploy the ear file from the web app server. See your app server documentation to undeploy the ear file from the app server. 2. Once you have successfully undeployed the ear file from the web appserver, perform the steps below specified under the respective host platform. Go to the Control Panel, select Add/Remove Programs, then select Search Interface to SAS Content 1.5, and select Uninstall. When the uninstallation wizard completes successfully, the Search Interface to SAS Content folder can be removed manually from the installation root directory. For UNIX hosts, the uninstallation wizard can be invoked by executing the UninstSESAS launcher inside the SearchInterfaceToSASContent/1.5/_uninstSESAS subdirectory under the product home directory. It is recommended to call the uninstaller launcher from outside of the productʹs home directory using the full path to the uninstaller launcher. For example, if Search Interface to SAS is installed in a directory called /opt/sas92install/searchinterfacetosascontent, then the uninstaller launcher can be called from any location outside of the installation directory as follows: sh /opt/sas92install/searchinterfacetosascontent/1.5/_uninstsesas/uninstsesas Once the uninstallation is complete, the SearchInterfaceToSASContent directory needs to be manually removed from the installation root directory. z/os On z/os the SearchInterfaceToSASContent directory can be manually removed from the productʹs install location. SAS and all other SAS Institute product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. Other brand and product names are registered trademarks or trademarks of their respective companies. indicates USA registration. Copyright 2010 SAS Institute Inc., Cary, NC, USA. All rights reserved. 8 16 June 2010