FAST SMART CONNECTOR FOR INTERWOVEN TEAMSITE

Transcription

FAST SMART CONNECTORFORINTERWOVEN TEAMSITEversion 4.0.1MODULE GUIDERELEASE CANDIDATE #1MAY 24, 2005Document Number: 927, Document Revision: B, May 24, 2005

FAST Data SearchCopyrightCopyright 1997-2005 by Fast Search & Transfer, Inc. and its associated companies and licensors. All rightsreserved. Fast Search & Transfer may hereinafter be referred to as FAST.Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement. The software may be used only in accordance with the terms of the agreements.No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or any means,electronic or mechanical, including photocopying and recording, for any purpose other than the purchaser’s use,without the written permission of FAST.TrademarksFAST is a registered trademark of Fast Search & Transfer. All rights reserved.FAST Search, and FAST Data Search are trademarks of Fast Search & Transfer. All rights reserved.Sun, Sun Microsystems, all SPARC trademarks, Java and Solaris are trademarks or registered trademarks of SunMicrosystems, Inc. in the United States and other countries. All rights reserved.Netscape is a registered trademark of Netscape Communications Corporation in the United States and other countries.Windows, Visual Basic, and Internet Explorer are registered trademarks of Microsoft Corporation.Red Hat is a registered trademark of Red Hat, Inc. All rights reserved.Linux is a registered trademark of Linus Torvalds. All rights reserved.UNIX is a registered trademark of The Open Group. All rights reserved.AIX is a registered trademark of International Business Machines Corporation. All rights reserved.HP and the names of HP products referenced herein are either trademarks and/or service marks or registered trademarks and/or service marks of HP and/or its subsidiaries.Oracle is a registered trademark, and Oracle8 is a trademark of Oracle Corporation.DB2, DB2 UDB, UDB, and MVS are all registered trademarks of the IBM Corporation.Microsoft is a registered trademark of Microsoft Corporation.SQL Server 2000 is a trademark of Microsoft Corporation.All other trademarks and copyrights referred to are the property of their respective owners.Restricted Rights LegendSoftware and accompanying documentation are provided to the U.S. government in a transaction subject to the Federal Acquisition Regulations with Restricted Rights. Use, duplication, or disclosure of the software by the government is subject to restrictions as set forth in FAR 52.227-19 Commercial Computer Software-Restricted Rights(June 1987).ii

ContentsChapter 1FAST Support. vAbout this Guide . viiChapter 1Introducing the Interwoven Connector1Overview.1Supported Platforms.2How the Interwoven Connector Works .2Chapter 2Installing the Interwoven Connector5Before You Install .5Setting Environment Variables .5Installing the License Key.6Verifying Sufficient Disk Space.6Installing the Interwoven Connector on UNIX Platforms .6After You Install .7Chapter 3Configuring the Interwoven Connector9About Configuring the Interwoven Connector.10Configuring the File Traverser .10Configuring the Workflow Templates.11Configuring the Workflow Definition .11Chapter 4Configuring FAST Data Search13About Configuring FAST Data Search.13Configuring an Index Profile .14Creating an Index Profile.14iii

FAST Data SearchUploading an Index Profile. 14Creating a Custom Pipeline . 16Creating Custom Stages. 16Adding Custom Stages to the Pipeline . 20Creating a Collection for Extracted Data. 23Chapter 5Using the Interwoven Connector27Running the Interwoven Connector . 27Chapter 6Troubleshooting the Interwoven Connector 31Logging . 31Appendix 7Sample Index Profile33teamsite40.xml. 33iv

Last update: Tuesday, May 24, 2005 2:11 pmChapter 1FAST SupportWebsitePlease visit us at:http://www.fastsearch.com/Contacting FASTFast Search & Transfer Inc.Cutler Lake Corporate Center117 Kendrick Street, Suite 100Needham, MA 02492 USATel: 1 (781) 304-2400 (8:30am - 5:30pm EST)Fax: 1 (781) 304-2410Technical Support and Licensing ProceduresE-mail: fds-support@fastsearch.comProduct TrainingE-mail: fastuniversity@fastsearch.comv

FAST Data SearchSalesE-mail: sales@fastsearch.comvi

About this GuidePurpose of this GuideThis guide describes the FAST Smart Connector for Interwoven TeamSite and explainshow to use it.AudienceThis guide provides information for all users of the FAST Smart Connector for InterwovenTeamSite.ConventionsThis guide uses the following textual conventions: Terminal output, contents of plaintext ASCII files will be represented using thefollowing format:Answer yes to place the node in the known hosts file. Terminal input from operators will be in the same but bold format:chmod 755 HOME Input of some logic meaning will be enclosed in brackets:setup OS .tar.gzwhere OS represents a specific operating system that must be entered. URLs, directory paths, commands, and the names of files, tags, and fields inparagraphs appear in the following format:The default home directory is the C:\DataSearch directory. User Interface page/window texts, buttons, and lists appear in the following format:Click Next and the License Agreement screen is displayed.vii

FAST Data Search viii FASTSEARCH (UNIX) or %FASTSEARCH% (Windows) refer to an environmentvariable set to the directory where FAST Data Search is installed.

Modified on: Tuesday, May 24, 2005 2:11 pmChapter 1Introducing the Interwoven ConnectorAbout this ChapterThis chapter introduces the FAST Smart Connector for Interwoven TeamSite. It includes: Overview How the Interwoven Connector WorksOverviewInterwoven TeamSite is content management software for the enterprise. The FAST SmartConnector for Interwoven TeamSite is a program that extracts information from an Interwoven TeamSite server and feeds it to FAST Data Search for indexing. Making your Interwoven TeamSite content searchable consists of the following major steps:1Installing the Interwoven Connector.2Configuring the Interwoven Connector.3Configuring FAST Data Search to receive Interwoven TeamSite content. Thisinvolves:4 defining an index profile specifying how to index TeamSite content creating a cluster creating a custom pipeline creating a collectionExtracting and submitting the Interwoven TeamSite content to FAST Data Search

FAST Data SearchSupported PlatformsOperating Systems Solaris 2.8 and all required patchesInterwoven TeamSite 5.5.2 or 6.0 OpenDeploy 5.6FAST Data Search 4.0 or laterHow the Interwoven Connector WorksDocuments maintained in TeamSite servers are deployed to production web servers usingthe OpenDeploy Distribution Server. The Interwoven Connector is placed in the defaultdeployment workflow in TeamSite and is configured to run after the OpenDeploy stagehas completed successfully.The connector:2 uses Interwoven-Perl API calls to fetch information about which files and directorieshave changed and should be submitted to FDS creates FastXML files containing the content of those files sends the FastXML files to FDS using file traversal

FAST Smart Connector for Interwoven TeamSite - Introducing the Interwoven Connector3

FAST Data Search4

Modified on: Tuesday, May 24, 2005 2:11 pmChapter 2Installing the Interwoven ConnectorAbout this ChapterThis chapter describes how to install the FAST Smart Connector for Interwoven TeamSite.It includes: Before You Install Installing the Interwoven Connector on UNIX Platforms After You InstallBefore You InstallSetting Environment Variables The library path variable must include ?.PlatformLibrary Path VariableSolarisLD LIBRARY PATHMessage to Reviewer! Is the library path variable really necessary?Depending on the platform and TeamSite, these variables may or may not be set atclient installation time. LM LICENSE FILEKey).must point to a FlexLM license file (see Installing the License

FAST Data SearchInstalling the License Key Include the license key for the Interwoven Connector in the FlexLM license file forFAST Data Search. Otherwise the Interwoven Connector asks you for it at run time.If the connector is not installed on a FAST Data Search node, you can use a licensefile that points to a remote license manager:SERVER host of license server ANYVENDOR FASTSRCHUSE SERVERThe keyword ANY means that the license allows the software to run on any machine. The environment variable LM LICENSE FILE must point to the FlexLM license filecontaining valid FAST Data Search and Interwoven Connector licenses.Verifying Sufficient Disk SpaceThe machine on which the Interwoven Connector runs must have enough temporary diskspace to store documents to be sent to FAST Data Search. Enough disk space must beavaliable to store all the files being submitted temporarily. The files are encoded withbase64, so temporary files can be up to 35% larger than the original content ( metadata).Installing the Interwoven Connector on UNIXPlatformsTo unpack and install the Interwoven Connector on Unix platforms, perform the followingprocedure:1Create a FAST directory under the TeamSite installation directory and change to it.mkdir TeamSite installdir \FASTcd TeamSite installdir \FAST2Copy the file interwovenconnector- platform - version .tgz (or .tar.gz) from theinstallation disk to the current directory on the hard drive. platform identifies the type of platform on which you want to install the Connector. version identifies the version of the Interwoven Connector to be installed.3Uncompress the installation file:gzip -d interwovenconnector- platform - version .tgz4Extract the uncompressed tar file. The extraction creates the directoryinterwovenconnector.tar -xvf interwovenconnector- platform - version .tar6

FAST Smart Connector for Interwoven TeamSite - Installing the Interwoven ConnectorAfter You InstallWhen the installation is complete, the Interwoven Connector directory contains the following subdirectories.DirectoryFiles and Descriptionsfiletraverserfiletraverser- platform - version .tgzFDS 4.0 standalone averser.shfiletraverser/docDocumentation for the Interwoven Connector.filetraverser/etcExample configuration braries required by the File xpat.so.0libgigabase select.sostruct.sotime.so7

FAST Data Searchworkflowwft fastdeploy.iplInterWoven-perl script that extracts data and generates data suitablefor feeding to FDS. Is run as part of the submit workflowconfigurable default submit fast.cfgExample configuration file for the submit workflowconfigurable default submit fast.wftExample workflow file for the submit workflow8

Modified on: Tuesday, May 24, 2005 2:11 pmChapter 3Configuring the Interwoven ConnectorAbout This ChapterThe Interwoven Connector is configured manually using configuration files as describedin this chapter.This chapter includes: About Configuring the Interwoven Connector Configuring the File Traverser Configuring the Workflow Templates Configuring the Workflow DefinitionMessage to Reviewer!I have not performed any of the procedures in thischapter. It seems that some of these steps configurethe connector and some of them configure TeamSiteitself. I need access to a TeamSite server to verifythat these are complete and correct.

FAST Data SearchAbout Configuring the Interwoven ConnectorSome of the steps needed to configure the Interwoven Connector require modifying filesprovided with the connector itself. Other steps require modifying your TeamSite configuration.Configuring the File TraverserModify the File Traverser files as described below. These files are in: TeamSite installdir \FAST\filetraverser\1Edit etc\fastsearch.lic and change test603.oslo.fast.no to your FAST Data Searchinstallation:SERVER test603.oslo.fast.no ANYVENDOR FASTSRCHUSE SERVERMessage to Reviewer! This doesn’t seem to comply with the standard usage of FlexLM, whereyou can combine license keys for many different products in one licensefile.2Edit etc/omniorb.cfg and change the following line to point to the name service foryour FAST Data Search i

woven TeamSite content searchable consists of the following major steps: 1 Installing the Interwoven Connector. 2 Configuring the Interwoven Connector. 3 Configuring FAST Data Search to receive Interwoven TeamSite content. This involves: defining an index profile specifying how to index TeamSite content creating a cluster creating a custom pipeline