Skip to main content

skip to main content

developerWorks  >  Information Management | WebSphere  >

Enable OmniFind to retrieve WebSphere Portal Document Manager content

Configuring Information Integrator Content Edition streaming

developerWorks
Go to the previous pagePage 3 of 8 Go to the next page

Document options
PDF format - Fits A4 and Letter

PDF - Fits A4 and Letter
2474 KB (51 pages)

Get Adobe® Reader®

Discuss


My developerWorks needs you!

Connect to your technical community


Rate this tutorial

Help us improve this content


Configuring streaming for content retrieval — no security enabled

This section of the tutorial describes how to configure streaming for content retrieval in an OmniFind Enterprise Edition search application when security is turned off in both WebSphere Application Server V6.1 (where the OmniFind Enterprise Edition search application is deployed) and WebSphere Application Server V6.0 (where the WebSphere Portal server is deployed).

Section overview

The high level tasks to configure streaming for content retrieval in the search application without security enabled are:

Install and configure HTTP Access Servlet in the Portal Server

Follow these steps to install and configure HTTP Access Servlet in the Portal Server:

  1. On the portal server, install the Information Integrator Content Edition HTTP access servlet. The servlet is contained in the vbr_httpaccess.war file under the <IICE 8.4 Install>\war directory.
  2. Log into the WebSphere Application Server V6.0 administration console for the server instance where the WebSphere Portal server is deployed.
  3. Go to Applications -> Install New Applications (Figure 3).
  4. On the screen for specifying the path to the application, enter the fully qualified path to the vbr_httpaccess.war file and vbr_httpaccess for Context root. Click Next.

    Figure 3. Specify the path to the WAR file
    Screen shot showing fully qualified path under Local file system and vbr_htpaccess as Context root.

  5. On the screen for generating default bindings and mappings, leave all the default options (Figure 4) and click Next.

    Figure 4. Generate default bindings and mappings
    Screen shot showing default selections for bindings and mappings

  6. You receive security warnings about the installation (Figure 5). Click Continue.

    Figure 5. Security warning
    Screen shot of security warning

  7. On the screen for specifying installation options (Figure 6), leave the Distribute application check box selected and clear the Create MBeans for resources check box. Click Next.

    Figure 6. Select installation options screen
    Screen shot of Select installation options with Distribute applications selected and Create MBeans for resources

  8. On the screen for mapping modules to servers (Figure 7), select the IBM Information Integrator Content Edition HTTP Access module and the WebSphere Portal server from the Clusters and Servers list. Click Apply.

    Figure 7. Map modules to servers
    Screen shot showing the IBM Information Integrator Content Edition HTTP Access module mapped to WebSphere Portal server

  9. You now see that the HTTP access Web module is mapped to the WebSphere Portal server (Figure 8). Click Next.

    Figure 8. HTTP access Web module mapped to the WebSphere Portal server
    Screen shot showing HTTP access Web module mapped to the WebSphere Portal server

  10. On the screen for mapping virtual hosts for Web modules (Figure 9), keep the defaults and click Next.

    Figure 9. Map virtual hosts for Web modules step
    Screen shot showing defaults on screen for mapping virtual hosts for Web modules

  11. On the summary screen (Figure 10), click Finish.

    Figure 10. Summary screen
    Screen shot of the summary screen

  12. On the installing screen (Figure 11), click the Save to Master Configuration link.

    Figure 11. Installing screen
    Screen shot of the installing screen

  13. On the saving master configuration screen (Figure 12), click Save.

    Figure 12. Saving master configuration
    Screen shot of saving master configuration screen

  14. From the WebSphere Portal server instance, go to Process Definition -> Java Virtual Machine -> Custom Properties (Figure 13) and ensure that there is an entry for vbr.home. Set the value of the vbr.home custom property to the home directory where Information Integrator Content Edition is installed.

    Figure 13. Check vbr.home
    Screen shot of Custom properties screen showing vbr.home property set to D:\IBM\IICE_V84

  15. You must also add a reference to the vbr.jar file as a shared library under the vbr_httpaccess.war file that you just installed. If you do not already have a shared library defined, go to Environment -> Shared Libraries in the WebSphere Application Server V6.0 administration console (Figure 14) and add a new library named VBR_JAR_SHARED_LIB.

    Figure 14. Shared libraries
    Screen shot of shared libraries screen with entry for VBR_JAR_SHARED_LIB

  16. From the Shared libraries screen, click on the VBR_JAR_SHARED_LIB library to bring up its configuration screen (Figure 15). Configure the Classpath for the library to point to the vbr.jar file under the Information Integration Content Edition install directory on the portal server and click OK.

    Figure 15. Configuring shared libraries
    Screen shot of the shared libraries configuration screen for VBR_JAR_SHARED_LIB showing a Classpath value of D:\IBM\IICE_V84\lib\vbr.jar

  17. From the WebSphere Application Server V6.0 administration console, go to Enterprise Applications -> vbr_httpaccess_war -> Additional Properties -> Libraries (Figure 16) and click Add.

    Figure 16. Adding a library reference
    Screen shot of library reference screen

  18. On the configuration screen for the new library reference (Figure 17), select VBR_JAR_SHARED_LIB as the library name and click OK.

    Figure 17. Configuring library reference properties
    Screen shot of configuration screen for a new library reference with VBR_JAR_SHARED_LIB selected as the library name

  19. Save your changes to the master configuration.
  20. Stop and restart the WebSphere Portal server instance so all the changes to the server instance take effect.
  21. Now you need to configure the Information Integrator Content Edition Portal Document Manager connector properties to add the HTTP access information. This enables the connector to know the URL that it needs to contact to stream the document.

    Start the Information Integrator Content Edition administration tool in direct mode and bring up the properties editor for the Portal Document Manager connector (Figure 18).



    Figure 18. Properties editor
    Screen shot of the Properties editor for the Portal Document Manager connector

  22. On the properties editor, click HTTP Access Information to bring up the HTTP Access Information editor (Figure 19). Enter the following string in the field named URL Base:
    http://$HOSTNAME:10038/vbr_httpaccess

    Leave $HOSTNAME as it is shown (this is a variable that is be replaced by the Information Integrator Content Edition runtime during actual document retrieval). Click OK.



    Figure 19. HTTP Access Information
    Screen shot of HTTP Access Information editor with http://$HOSTNAME:10038/vbr_httpaccess entered as the URL Base

  23. In this step you enable the DEBUG level of logging for the Information Integrator Content Edition Portal Document Manager connector. This allows detailed logging to be generated for the connector in the WebSphere Portal server SystemOut.log file. You will use this detailed logging later to verify that streaming works.

    From the Information Integrator Content Edition administration tool, right-click Configuration Data and click Properties… to bring up the Properties Editor - Configuration Data screen (Figure 20).

    Figure 20. Properties editor
    Screen shot of Properties editor - Configuration Data screen

  24. Click Custom Logging to bring up the Custom Logging Editor (Figure 21).

    Figure 21. Custom Logging Editor
    Screen shot of the Custom Logging Editor

  25. Change the logging setting for log4j.category.com.venetica to DEBUG,A1,A2 and click OK.
  26. Save all the configuration changes and exit the administration tool.


Back to top


Configure the OmniFind Enterprise Edition search application to enable Information Integrator Content Edition streaming

Follow these steps to configure the OmniFind Enterprise Edition search application to enable Information Integrator Content Edition streaming:

  1. The config.properties file for the OmniFind Enterprise Edition search application contains the configuration options to enable streaming. Locate the file in the following directory and open it in an editor:
    <OmniFind Enterprise Edition Install Directory>\installedApps\ESSearchApplication.ear\ESSearchApplication.war\WEB-INF
  2. Make the following changes to the config.properties file:
    1. Set the vbr.stream.enable variable to true: 
      vbr.stream.enable=true

    2. Set the vbr.stream.mode variable to direct: 
      vbr.stream.mode=direct

    3. Set the vbr.stream.username variable to a valid user ID of the WebSphere Portal server: 
      vbr.stream.username=valid_username

    4. Set the logging.level variable to FINEST. This allows the search application to generate detailed logging, which you can use later to verify that streaming is enabled and working properly. 
      logging.level=FINEST

  3. Save the changes to the config.properties file.


Back to top


Configure the OmniFind Enterprise Edition Search Server instance in WebSphere Application Server

Follow these steps to configure the OmniFind Enterprise Edition Search Server instance in WebSphere Application Server:

  1. From the OmniFind Enterprise Edition server, log into the WebSphere Application Server V6.1 administration console for the ESSearchServer server instance where the search server is deployed. Go to Server Infrastructure -> Java and Process Management -> Process Definition -> Java Virtual Machine -> Custom Properties (Figure 24) and look for a property named vbr.home.

    Figure 24. Custom Properties
    Screen shot of Custom Properties without the vbr.home property defined

  2. If the vbr.home property is not already defined, add it now.

    On the Custom Properties screen, click New. This takes you to the Configuration screen for a new property (Figure 25). In the Name field enter vbr.home and for the Value field enter the fully qualified directory where Information Integration Content Edition is installed. Click OK.



    Figure 25. Setting properties
    Screen shot of Configuration screen for a new property with Name set to vbr.home and Value set to D:\IBM\IICE_V84

  3. Save your changes change to the master configuration.
  4. Stop and restart the ESSearchServer instance under WebSphere Application Server V6.1 so that all the changes related to the search application and search server take effect (Figure 26).

    Figure 26. Stop and restart the ESSearchServer
    Screen shot of console showing that commands for stopping and starting the ESSearchServer have been issued



Back to top


Test content retrieval streaming without security enabled

You need to ensure that only the OmniFind Enterprise Edition collection that contains the Portal Document Manager data source is enabled for search. This makes the test straightforward. Follow these steps to test content retrieval streaming without security enabled:

  1. In the address field of a Web browser, enter the URL of the OmniFind Enterprise Edition search application:
    http://<hostname>/ESSearchApplication

    Because security is not enabled, this takes you directly to the search screen.

  2. To initiate a search against the Portal Document Manager data source, type a search term in the Search for field and click Search. Figure 27 shows an example of the search results that are returned.

    Figure 27. Searching against Portal Document Manager
    Screen shot of the sample search results

  3. Click on one of the links in the search results to verify that you can retrieve the document from the Portal Document Manager (Figure 28).

    Figure 28. Document content returned
    Screen shot of a document that was opened by clicking on its entry in the search results



Back to top


Verify that content retrieval streaming without security enabled works

You can verify that streaming worked by examining the detailed log generated by the OmniFind Enterprise Edition search application and the SystemOut.log from the portal server.

  1. Look at the ESSearchApplication.0.log file in the <OmniFind Node Root>\logs directory. At the bottom of the file you should see log entries similar to the sample shown in Listing 1.

    Listing 1. Sample entries from ESSearchApplication.0.log
    Nov 2, 2008 4:22:35 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - mode: direct
Nov 2, 2008 4:22:35 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - jndiFactory: 
Nov 2, 2008 4:22:35 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - jndiProvider: 
Nov 2, 2008 4:22:35 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - userName: cjinwps
Nov 2, 2008 4:22:35 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - logging on to the repository
Nov 2, 2008 4:22:35 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - attempting to logon with the predefined id of cjinwps
Nov 2, 2008 4:22:36 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - logged on to repository: SharedPDMConnector
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - requesting page #: 1 as a stream
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - set response header [Content-Type]: application/pdf
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - set response header [Content-Disposition]:     \
inline;filename="OmniFindEnterprise850_qsg_en.pdf"
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
INFO: writeFileToStream - returning content
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - logging off of repository
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
FINE: retrieveContentAsStream - freeing user instance
Nov 2, 2008 4:22:37 PM com.ibm.es.searchui.fetch.ESFetchServlet
INFO: doGet - returning

  2. On the portal server, look at the SystemOut.log file under the <WebSphere Portal server install directory>\log directory. You should see log entries similar to what is shown in Listing 2 (due to the length of the lines in the sample, it is contained on a separate page).


Back to top



Go to the previous pagePage 3 of 8 Go to the next page