Integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search

using plug-in

By Suneetha Kaditi & Yogendra Srivastava

Abstract: This article provides the basic step by step process of installing and configuring a plug-in to integrate IBM Content Navigator with IBM Content Analytics with Enterprise Search. By integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search using a plug-in, we can leverage the features of IBM Content Analytics with Enterprise Search to enhance the search capabilities in IBM Content Navigator.

About the authors: Suneetha Kaditi is a System Software Engineer with IBM FileNet Enterprise Content Management team at IBM. In the past two and half years she has worked for several different IBM products like WorkplaceXT, Application Engine, Content Engine, IBM Content Capacity Planner, IBM Content Navigator on different platforms. Reach her at ksuneeth@in.ibm.com

Yogendra Srivastava is a Senior Staff Software engineer with ten years of experience in Healthcare and Information Management domain. He is currently responsible for IBM Case Manager for Healthcare design and development at IBM - India Software Lab. Prior to this work he was architect and technical lead of DB2 Health Advisor Service and worked on various IBM products namely Cognos, SPSS, IBM Content Analytics, DB2, FileNet. He has delivered several technical sessions to Customers and Universities on IBM technologies. Reach out to him at ysrivastava@in.ibm.com

Table of Contents:

1. Overview of IBM Content Navigator and IBM Content Analytics with Enterprise Search

2. Benefits of Integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search

3. Setup for Integration of IBM Content Navigator with IBM Content Analytics with Enterprise Search

a) Setting up IBM Content Navigator

b) Setting up IBM Content Analytics with Enterprise Search

c) Setting up IBM Content Navigator with IBM Content Analytics with Enterprise Search by configuring the IBM Content Analytics with Enterprise Search plug-in

4. Conclusion

5. Reference

Integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search by using a plug-in

Introduction:

This article provides the basic step by step process of installing and configuring a plug-in to integrate IBM Content Navigator with IBM Content Analytics with Enterprise Search.

By integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search using a plug-in, we can leverage the features of IBM Content Analytics with Enterprise Search to enhance the search capabilities in IBM Content Navigator.

1. Overview of IBM Content Navigator and IBM Content Analytics with Enterprise Search:

IBM Content Navigator:IBM Content Navigator is a flexible and customizable application that provides users with a console for working with content from multiple content servers. IBM Content Navigator helps companies provide managed access to large volumes of electronic data. IBM Content Navigator enables users to search for and work with documents that are stored in content servers that are located around the world from a web browser.

IBM Content Navigator is available as a customizable web client, a mobile app, and as an integration with Microsoft Office. You can use the APIs to extend the web client or to build custom applications.IBM Content Navigator can be used to access multiple content managementrepositories. You can also configure the same instance of IBM Content Navigator to access multiple types of content management servers, depending on your business needs.

You can use IBM Content Navigator to connect to the following repositories:• IBM Content Manager Enterprise Edition• IBM Content Manager OnDemand• IBM FileNet P8• IBM Content Management Interoperability Services (CMIS) for IBM Content Manager• IBM Content Management Interoperability Services (CMIS) for FileNet Content Manager

For more information on the capabilities of IBM Content Navigator, see http://pic.dhe.ibm.com/infocenter/p8docs/v5r2m0/topic/com.ibm.installingeuc.doc/eucao001.html

With IBM Content Navigator, users can:• Search for content that is stored on the repository• Preview documents• View documents side-by-side• Edit document properties• Add annotations to documents• Send documents and links to documents through email• Print documents• Download documents

In addition, if you use IBM Content Navigator with IBM Content Manager or IBMFileNet Content Manager, you can:• Browse for content that is stored on the repository• Search for content that is stored on the repository by running a text • search• Save documents, folders and other content as favorites• Edit documents• Add documents to content servers• Organize documents by creating folders and adding content to the • folders• Use workflows to:

1. Review and approve documents2. Assign work to users3. Use the version control rules that are set on the repository4. Create teamspaces to provide a focused view of the content and objects on the

repository

In addition, IBM Content Navigator provides a powerful platform for buildingcustom web applications to manage content. You can use various extension points and application programming interfaces (APIs) to extend the existing web client by adding custom actions, menus, layouts, or services.

You can also use the APIs to:

• Build custom applications that incorporate IBM Content Navigator features without using the standard web client

• Access the APIs for the content servers• Create plug-ins to implement the functionality that you want to add to the web client by

using the Java API

• Create custom widgets to use with plug-ins by using the JavaScript API

IBM Content Analytics with Enterprise Search:

IBM Content Analytics helps organizations to derive new business understanding and visibility from the content and context of unstructured information. Enterprise search helps organizations to make content from multiple structured and unstructured sources searchable by enterprise users.IBM Content Analytics with Enterprise Search combines the strengths of the following two technologies: a faceted interface for exploration and a search interface. Through a provided content mining interface, business analysts can interactively explore data from different facets and discover relationships between various facet values. Through an interface designed for search, enterprise users can query the index to find and retrieve relevant documents from a ranked list of results.

2. Benefits of Integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search:

If you have IBM Content Analytics with Enterprise Search installed and configured, you can use IBM Content Analytics with Enterprise Search plug-in that is included with IBM Content Navigator. The plug-in enables users to search one or more IBM Content Analytics with Enterprise Search collections from the IBM Content Navigator web client. When a user enters search terms in the search field in the global toolbar, the plug-in provides the following capabilities:

• Type-ahead search suggestions

• An estimated number of results for the search terms

• When the user runs the search, the Analytics view opens and displays the full list of search results, the facet tree, and the dynamic facet tree. The user can then view and work with the documents that are returned by the result.

• IBM Content Analytics with Enterprise Search is integrated as a plug-in to IBM Content Navigator. This plug-in supports searching across different repositories and data sources that are configured for use with IBM Content Navigator.

• Limited use license of IBM Content Analytics includes allowing search collections for IBM FileNet P8 and IBM Content Manager. Full capability is supported if the IBM Content Analytics license is purchased.

3.Setup for Integration of IBM Content Navigator with IBM Content Analytics with Enterprise Search

The section includes three parts:

a) Setting up IBM Content Navigator

b) Setting up IBM Content Analytics with Enterprise Search

c) Setting up IBM Content Navigator with IBM Content Analytics with Enterprise Search by configuring the IBM Content Analytics with Enterprise Search plug-in

a) Settting up IBM Content Navigator:

This IBM Content Navigator setup is using WebSphere 7.0.0.21, DB2, Windows 2008 and is configured with a FileNet P8 repository.

1. Install IBM Content Navigator and run the Configuration and Deployment tool by either selecting in the installer itself or by manually running the configmgr tool from the following IBM Content Navigator location:

C:\Program Files(x86)\IBM\ECMClient\configure\configmgr.exe

2. In the IBM Content Navigator Configuration and Deployment Tool, create a new deployment profile

Fig 1:Application Server properties in the IBM Content Navigator Configuration and Deployment Tool

3. Select the repository to be configured with IBM Content Navigator. This repository must be already set up and should be in working state. We have selected IBM FileNet P8 for our setup.

Fig 2:List of repositories displayed in the IBM Content Navigator Configuration and Deployment Tool

4. Configure and deploy the web application.

Depending on the repository type and application server, the list of tasks to be executed are displayed. These tasks must be run successfully before you deploy the IBM Content Navigator application in the application server.

Fig 3:List of tasks of displayed in the IBM Content Navigator Configuration and Deployment Tool

Following are the list of tasks to be run which are applicable for FileNet P8 repository and WebSphere.

The following tasks require values that will vary depending on your Content Engine, Database, LDAP authentication, and so on.

For help on completing the tasks, see http://pic.dhe.ibm.com/infocenter/cmod/v8r5m0/topic/com.ibm.installingeuc.doc/eucco004.html

1. Update the FileNet P8 Client Connector Files

2. Configure the Connection to your LDAP server.

3. Import your Content Engine LTPA Keys

4. Configure JDBC Driver for Your Database

5. Create a DataSource for your database.

6. Update and Run the Database Script for your environment

7. Configure JAAS Authentication on your Web Application Server

8. Build the Web Application

9. Deploy the Web Application

The last two tasks are to build and deploy the web application. These two tasks need to be run after all of the other tasks are run successfully.

After you build the web application EAR file, you must deploy the web application to your WebSphere Application Server environment. You can use the IBM Content Navigator Configuration and Deployment Tool to deploy the web application, or you can deploy the EAR file manually from the WebSphere Administrative Console. Restart WebSphere Application Server after deployment is completed successfully.

Fig 4:Deploying the application in the IBM Content Navigator Configuration and Deployment Tool

After the deployment process of IBM Content Navigator is done in the application server, we can verify that IBM Content Navigator was successfully deployed to web application server by accessing the web client.

Open a web browser and enter a URL in the following format:

http://hostname:port/navigator

By default, the context root is navigator. Log in with your IBM Content Navigator administrator credentials,which is added in your repository. If you have not configured multiple IBM Content Navigator administrators, you must log in with the IBM Content Navigator administrator name that you specified when you ran the task to update the database script for your environment.Before integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search, ensure that IBM Content Navigator is configured successfully.

b.Setup of IBM Content Analytics with Enterprise Search(ICA):

1. Install IBM Content Analytics and access the adminstration console by entering the following URL:

http://hostname:port/ESAdmin/

where hostname:port is the host name and port of the server where the administration console is installed. All of the required servers and services need to be started before you can access the administration console.

Fig 5:IBM Content Analytics with Enterprise Search Adminstration Consol

Creating Collection & Crawler:

Fig:6 Displaying Collection and Crawler

2. A collection contains the entire set of sources that users can query at a time. When you create a collection, you specify options that apply to the entire collection. The collection is empty until you add content to it.

Log in to the administration console. On the Collections view, click Create Collection.

3. On the Create a Collection page, provide information such as the Collection name and the Collection type. Specify the type of collection that you want to create: an enterprise search collection or a content analytics collection. Depending on our requirements such as whether it should use document cache, thumbnail images, and so on, enter your values and create the collection.

4. After the collection is created, to add content to the collection, expand the collection. In the Crawl and Import pane, click Add a new crawler. You can configure crawlers for the different types of data that you want to include in a collection. A single collection can contain any number of crawlers. When you configure the crawler, you specify options for crawling documents in folders and document classes.

Crawl documents from FileNet P8:

To create or change a FileNet P8 crawler, log in to the administration console.

When you create the crawler, a wizard helps you do the following tasks:

• Specify properties that control how the crawler operates and uses system resources. The crawler properties control how the crawler crawls all of the documents that you add to the crawl space.

• Specify information and credentials that enables the crawler to access the IBM FileNet P8 server.

• Select the folders or document classes that you want to include in the crawl space. When you select the targets to be crawled, the top level of the hierarchy tree shows the object stores on the server. On second level, the Root Folder and Root Class are displayed. If you select the Root Folder, a list of root folders in the object store is displayed on third level. If you select a Root Class, a list of root document classes in the object store is displayed on third level. After expanding the root folders and root classes, select one or more folders or document classes to crawl.

Index documents from FileNet p8

The indexing services provide both document processing and indexing capabilities. First,the index service reads crawled documents in the file queue of the data store. To prepare a document for indexing, the document processor tasks extract and analyze the text and metadata for each document.

Start the index so your documents will be indexed.

Fig:7 Displaying indexing documents from FileNet P8

To ensure that users always have access to the latest information, incremental index updates occur automatically when new documents are ready to be indexed.

Searching Documents:

Open the Enterprise Search Application console and search for a document from FileNet Repository. You should be able to display the indexed documents.

When the user runs the search, the Analytics view opens and displays the full list of search results, gives type ahead search suggestions , the facet tree, and the dynamic facet tree. The user can then view and work with the documents that are returned by the result.

Fig 8:Searching documents in the Enterprise Search Application Console

c) Setup for Integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search by configuring the IBM Content Analytics with Enterprise Search plug-in.

In order to integrate IBM Content Navigator with IBM Content Analytics with Enterprise Search, both setups must be available.

After IBM Content Navigator is deployed, you must define at least one desktop. Desktops determine the available features and appearance of the web client and configure connections to your content management repositories to enable users to access content through the web client.

Desktop and Repositories:

Access the IBM Content Navigator web client through the following URL :

http://hostname:port/navigator

This URL opens a default administration desktop when no desktops are configured.

You must log in with the IBM Content Navigator administrator name that you specified when you ran the task to update the database script for your environment. To access the content in a IBM FileNet P8 repository, you must first connect to at least one repository and configure it to use IBM Content Navigator as a web client. Add a new repository to configure with FileNet P8. You should connect successfully with your FileNet P8 repository.

Fig 9:Creating a repository in the IBM Content Navigator web client.

After you connect to and configure the repository, you must associate a desktop to enable users to access the content.

To create a working desktop, you must specify a name and assign an ID to the desktop. You must also select a repository and associate that repository to the desktop. Optionally, you can specify other options and settings for the desktop, such as the context menu options that users see when they want to add a document to a repository or the maximum number of documents that users can add at a time. Complete the remaining tabs such as General, Mobile, Repositories, Appearance, and so on.

Add a new desktop and associate your new desktop with the repository you created.

Fig 10:Creating Desktop in IBM Content Navigator web client.

After you have created your desktop, you can access that desktop by using following URL:

http://hostname:port/navigator/?desktop=DesktopID

The default desktop is the administrator desktop .

Fig 11.Accessing newly created FileNet P8 Desktop.

The desktop is now configured with a FileNet P8 repository and can be used to perform Enterprise Content Management operations.

Go to the plug-ins section of IBM Content Navigator and specify the location of the ICA plug-in JAR file, which is located on the IBM Content Navigator server.

Specify the working IBM Content Analytics server. Save and close the plug-ins section.

Fig 12: IBM Content Analytics plug-in in IBM Content Navigator

Go to the Desktops section and select a desktop where you want to add the search capability of IBM Content Analytics.

Click the Appearance tab. In the Layout section in the Displayed features area, add Analyze Content to the list of selected features.

Fig 13. Configuring IBM Content Analytics in a desktop

IBM Content Analytics with Enterprise Search feature is added to this desktop. For any additional desktops where you want to enable this search feature, repeat the step to add the Analyze Content feature to the desktop.

Access the IBM Content Analytics configured desktop and go to the Content Analytics view .

Example: http://hostname:port/?desktop=ID

where ID=The desktop configured for IBM Content Analytics with Enterprise Search

You can now view the IBM Content Analytics features in IBM Content Navigator.

Fig14 : IBM Content Analytics Type Ahead Search Suggestion in IBM Content Navigator

You can see in fig 14 , type ahead search suggestion for keyword “XT”.

Fig 15: IBM Content Analytics Advanced Search in IBM Content Navigator

You can view the the Advance Search Window which gives different criteria to locate the search item.

Fig 16 :List of IBM Content Analytics search results, the facet tree, and the dynamic facet tree in IBM Content Navigator

You can view the search results,the facet tree and the dynamic facet tree.

4.Conclusion:

The article has guided you through the step by step process of integrating IBM Content Navigator with IBM Content Analytics with Enterprise Search by configuring the IBM Content Analytics with Enterprise Search plug-in.

References:

1. http://pic.dhe.ibm.com/infocenter/analytic/v3r0m0/index.jsp?topic= %2Fcom.ibm.discovery.es.ad.doc%2Fiiysaimpcsv.htm

2. http://pic.dhe.ibm.com/infocenter/cmgmt/v8r4m0/index.jsp?topic= %2Fcom.ibm.installingeuc.doc%2Feucpl031.htm

3. Planning, Installing, and Configuring IBM Content Navigator (c1937151.pdf)