IDOL SharePoint 2010 Connector (CFS)

Transcription

1 IDOL SharePoint 2010 Connector (CFS) Version: 10.7 SharePoint 2010 Connector (CFS) Administration Guide Document Revision: 0 Document Release Date: June 2014 Software Release Date: June 2014

2 Notice This documentation is a proprietary product of HP Autonomy and is protected by copyright laws and international treaty. Information in this documentation is subject to change without notice and does not represent a commitment on the part of HP Autonomy. While reasonable efforts have been made to ensure the accuracy of the information contained herein, HP Autonomy assumes no liability for errors or omissions. No liability is assumed for direct, incidental, or consequential damages resulting from the use of the information contained in this documentation. The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict accordance with the End User License Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner. This documentation may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations are strictly coincidental. Trademarks and Copyrights Copyright 2014 Hewlett-Packard Development Company, L.P. ACI API, Alfresco Connector, Arcpliance, Autonomy Process Automation, Autonomy Fetch for Siebel ebusiness Applications, Autonomy, Business Objects Connector, Cognos Connector, Confluence Connector, ControlPoint, DAH, Digital Safe Connector, DIH, DiSH, DLH, Documentum Connector, DOH, EAS Connector, Ektron Connector, Enterprise AWE, eroom Connector, Exchange Connector, FatWire Connector, File System Connector for Netware, File System Connector, FileNet Connector, FileNet P8 Connector, FTP Fetch, HTTP Connector, Hummingbird DM Connector, IAS, IBM Content Manager Connector, IBM Seedlist Connector, IBM Workplace Fetch, IDOL Server, IDOL, IDOLme, imanage Fetch, IMAP Connector, Import Module, iplanet Connector, KeyView, KVS Connector, Legato Connector, LiquidOffice, LiquidPDF, LiveLink Web Content Management Connector, MCMS Connector, MediClaim, Meridio Connector, Meridio, Moreover Fetch, NNTP Connector, Notes Connector, Objective Connector, OCS Connector, ODBC Connector, Omni Fetch SDK, Open Text Connector, Oracle Connector, PCDocs Fetch, PLC Connector, POP3 Fetch, Portal-in-a-Box, RecoFlex, Retina, SAP Fetch, Schlumberger Fetch, SharePoint 2003 Connector, SharePoint 2007 Connector, SharePoint 2010 Connector, SharePoint Fetch, SpeechPlugin, Stellent Fetch, TeleForm, Tri- CR, Ultraseek, Verity Profiler, Verity, VersiForm, WebDAV Connector, WorkSite Connector, and all related titles and logos are trademarks of Hewlett-Packard Development Company, L.P., which may be registered in certain jurisdictions. Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint, and other Microsoft products referenced herein are trademarks of Microsoft Corporation. UNIX is a registered trademark of The Open Group. AvantGo is a trademark of AvantGo, Inc. Epicentric Foundation Server is a trademark of Epicentric, Inc. Documentum and eroom are trademarks of Documentum, a division of EMC Corp. FileNet is a trademark of FileNet Corporation. Lotus Notes is a trademark of Lotus Development Corporation. mysap Enterprise Portal is a trademark of SAP AG. Oracle is a trademark of Oracle Corporation. Adobe is a trademark of Adobe Systems Incorporated. Novell is a trademark of Novell, Inc. Stellent is a trademark of Stellent, Inc. All other trademarks are the property of their respective owners. Notice to Government End Users If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of Civilian agency contract: Use, reproduction or disclosure is subject to (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished-rights reserved under the copyright laws of the United States. Autonomy, Inc., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA , US. Autonomy SharePoint 2010 Connector (10.7) Page 2 of 150

3 About this PDF Version of Online Help This document is a PDF version of the online help. This PDF file is provided so you can easily print multiple topics from the help information or read the online help in PDF format. Because this content was originally created to be viewed as online help in a web browser, some topics may not be formatted properly. Some interactive topics may not be present in this PDF version. Those topics can be successfully printed from within the online help. Autonomy SharePoint 2010 Connector (10.7) Page 3 of 150

4 Autonomy SharePoint 2010 Connector (10.7) Page 4 of 150

5 Contents Contents 5 About This Document 13 Documentation Updates 13 Related Documentation 15 Conventions 15 Notational Conventions 16 Command-Line Conventions 16 Notices 17 Autonomy Product References 17 Autonomy Customer Support 18 Contact Autonomy 18 Chapter 1: Introduction 19 SharePoint 2010 Connector 19 Features and Capabilities 20 Supported Actions 21 Mapped Security 22 Display Online Help 22 OEM Certification 23 Connector Framework Server 23 Autonomy's IDOL Platform 25 System Architecture 26 Chapter 2: Install SharePoint 2010 Connector 28 System Requirements 28 Permissions 29 SharePoint Connector Web Services 31 Install SharePoint 2010 Connector on Windows 31 Install the Web Service Manually 33 Uninstall the Web Service Manually 34 Install, Uninstall, and Rename the Connector Service 34 Autonomy SharePoint 2010 Connector (10.7) Page 5 of 150

6 Contents Check Privileges 35 Chapter 3: Configure SharePoint 2010 Connector 36 SharePoint 2010 Connector Configuration File 36 Modify Configuration Parameter Values 38 Schedule Fetch Tasks 39 Encrypt Passwords 41 Create a Key File 41 Encrypt a Password 41 Decrypt a Password 42 Customize Logging 43 Register with a Distributed Connector 44 Set Up Secure Communication 45 Configure Outgoing SSL Connections 45 Configure Incoming SSL Connections 47 Set Up Event Handlers 47 Event Handlers 48 Configure an Event Handler 49 Set Up Performance Monitoring 50 Backup and Restore the Connector s State 51 Backup a Connector s State 52 Restore a Connector s State 52 Reset the Connector 53 Example Configuration File 53 Chapter 4: Use the Connector 57 Retrieve Data from SharePoint 57 Synchronize from Identifiers 59 Insert a File into SharePoint 59 Chapter 5: SharePoint Mapped Security 61 Introduction 61 Set up SharePoint Mapped Security 63 Retrieve and Index Access Control Lists 63 Autonomy SharePoint 2010 Connector (10.7) Page 6 of 150

7 Contents Retrieve Security Group Information using OmniGroupServer 64 Configure the Connector 64 Configure OmniGroupServer 65 Chapter 6: Start and Stop the Connector 68 Start the Connector 68 Stop the Connector 68 Chapter 7: Troubleshoot the Web Service 70 Questions and Answers Related to the Web Service 70 Chapter 8: Manipulate Documents 76 Introduction 76 Add a Field to Documents using an Ingest Action 76 Customize Document Processing 77 Standardize Field Names 78 Run Lua Scripts 79 Write a Lua Script 80 Run a Lua Script using an Ingest Action 81 Example Lua Scripts 82 Add a Field to a Document 82 Merge Document Fields 83 Chapter 9: Ingestion 84 Introduction 84 Send Data to Connector Framework Server 85 Send Data to IDOL OnDemand 86 Chapter 10: Lua Methods Reference 87 General Methods 87 abs_path 88 convert_date_time 89 convert_encoding 91 copy_file 91 create_path 92 create_uuid 92 Autonomy SharePoint 2010 Connector (10.7) Page 7 of 150

8 Contents delete_file 93 encrypt 93 encrypt_security_field 93 file_setdates 94 get_config 94 getcwd 95 gobble_whitespace 95 hash_file 96 hash_string 96 is_dir 97 log 97 move_file 97 parse_csv 98 parse_xml 98 regex_match 99 regex_replace_all 100 regex_search 100 send_aci_action 101 send_aci_command 102 send_and_wait_for_async_aci_action 103 sleep 103 string_uint_less 104 unzip_file 104 url_unescape 105 xml_encode 105 zip_file 105 LuaDocument Methods 106 addfield 107 addsection 108 appendcontent 108 copyfield 109 Autonomy SharePoint 2010 Connector (10.7) Page 8 of 150

9 Contents copyfieldnooverwrite 109 countfield 110 deletefield 110 getcontent 111 getfield 111 getfieldnames 112 getfields 112 getfieldvalue 113 getfieldvalues 113 getnextsection 114 getreference 115 getsection 115 getsectioncount 115 getvaluebypath 116 getvaluesbypath 116 hasfield 117 insertxml 117 insertxmlwithoutroot 118 renamefield 118 setcontent 119 setfieldvalue 119 setreference 120 to_idx 120 to_json 120 to_xml 121 writestubidx 121 writestubxml 121 LuaField Methods 122 addfield 123 copyfield 123 copyfieldnooverwrite 124 Autonomy SharePoint 2010 Connector (10.7) Page 9 of 150

10 Contents countfield 124 deleteattribute 125 deletefield 125 getattributevalue 126 getfield 126 getfieldnames 126 getfields 127 getfieldvalues 127 getvaluebypath 128 getvaluesbypath 129 hasattribute 130 hasfield 130 insertxml 131 insertxmlwithoutroot 131 name 131 renamefield 132 setattributevalue 132 setvalue 132 value 133 LuaXmlDocument Methods 133 root 133 XPathExecute 134 XPathRegisterNs 134 XPathValue 135 XPathValues 135 LuaXmlNodeSet Methods 136 at 136 size 136 LuaXmlNode Methods 137 attr 137 content 138 Autonomy SharePoint 2010 Connector (10.7) Page 10 of 150

11 Contents firstchild 138 lastchild 138 name 138 next 139 nodepath 139 parent 139 prev 139 type 140 LuaXmlAttribute Methods 140 name 141 next 141 prev 141 value 141 LuaRegexMatch Methods 142 length 142 next 143 position 143 size 143 str 144 LuaConfig Methods 144 getencryptedvalue 145 getvalue 145 getvalues 146 Glossary 147 Autonomy SharePoint 2010 Connector (10.7) Page 11 of 150

12 Contents Autonomy SharePoint 2010 Connector (10.7) Page 12 of 150

13 About This Document This guide is for readers who need to use the SharePoint 2010 Connector (CFS). It is intended for readers who have installed IDOL and are familiar with concepts related to administering a multi-part distributed application. Documentation Updates Related Documentation Conventions Autonomy Product References Support Contact Autonomy Documentation Updates The information in this document is current as of SharePoint 2010 Connector (CFS) version The content was last modified June You can retrieve the most current product documentation from the HP Autonomy Knowledge Base on the Customer Support Site. A document in the Knowledge Base displays a version number in its name, such as IDOL Server 7.5 Administration Guide. The version number applies to the product that the document describes. The document may also have a revision number in its name, such as IDOL Server 7.5 Administration Guide Revision 6. The revision number applies to the document and indicates that there were revisions to the document since its original release. Autonomy recommends that you periodically check the Knowledge Base for revisions to documents for the products your enterprise is using. To access Autonomy documentation 1. Go to the Autonomy Customer Support site: 2. Click Login. 3. Type the login credentials that you were given, and then click Login. The Customer Support Site opens. 4. Click Knowledge Base. Autonomy SharePoint 2010 Connector (10.7) Page 13 of 150

14 About This Document The Knowledge Base Search page opens. 5. Search or browse the Knowledge Base. To search the knowledge base: In the Search box, type a search term or phrase and click Search. Documents that match the query display in a results list. To browse the knowledge base: Select one or more of the categories in the Browse list. You can browse by: o o o o o o Repository. Filters the list by Documentation produced by technical publications, or Solutions to Technical Support cases. Product Family. Filters the list by product suite or division. For example, you could retrieve documents related to the imanage, IDOL, Virage or KeyView product suites. Product. Filters the list by product. For example, you could retrieve documents related to IDOL Server, Virage Videologger, or KeyView Filter. Version. Filters the list by product or component version number. Type. Filters the list by document type. For example, you could retrieve Guides, Help, Packages (ZIP files), or Release Notes. Format. Filters the list by document format. For example, you could retrieve documents in PDF or HTML format. Guides are typically provided in both PDF and HTML format. 6. To open a document, click its title in the results list. To download a PDF version of a guide, open the PDF version, click the Download icon the PDF reader, and save the PDF to another location. in To download a documentation ZIP package, click Get Documentation Package under the document title in the results list. Alternatively, browse to the desired ZIP package by selecting either the Packages document Type or the ZIP document Format from the Browse list. Autonomy SharePoint 2010 Connector (10.7) Page 14 of 150

15 About This Document Autonomy welcomes your comments. To send feedback on Autonomy documentation send to provide: full document title with version and revision number location: heading, a snippet of text or screen capture your comments your contact information in the event we need clarification Related Documentation The following documents provide more details on SharePoint 2010 Connector. SharePoint 2010 Connector (CFS) Reference The SharePoint 2010 Connector (CFS) Reference describes the configuration parameters and actions that can be used with the SharePoint 2010 Connector. Connector Framework Server Administration Guide Connector Framework Server (CFS) processes documents that are retrieved by connectors. CFS then indexes the documents into IDOL server. The Connector Framework Server Administration Guide describes how to configure and use Connector Framework Server. IDOL Server Administration Guide IDOL server is at the center of an Autonomy infrastructure, storing and processing the data that is indexed into it. The IDOL Server Administration Guide describes the operations that IDOL server can perform with detailed descriptions of how to set them up. Intellectual Asset Protection System (IAS) Administration Guide This guide describes how you can use Autonomy s Intellectual Asset Protection System (IAS) to ensure secure access through authentication and role permissions. License Server Administration Guide This guide describes how you can use a License Server to license multiple Autonomy services. Conventions The following conventions are used in this document. Autonomy SharePoint 2010 Connector (10.7) Page 15 of 150

16 About This Document Notational Conventions This document uses the following conventions. Convention Bold Usage User-interface elements such as a menu item or button. For example: Click Cancel to halt the operation. Italics Document titles and new terms. For example: For more information, see the IDOL Server Administration Guide. An action command is a request, such as a query or indexing instruction, sent to IDOL Server. monospace font monospace bold File names, paths, and code. For example: The FileSystemConnector.cfg file is installed in C:\Program Files\FileSystemConnector\. Data typed by the user. For example: Type run at the command prompt. In the User Name field, type Admin. monospace italics Replaceable strings in file paths and code. For example: user UserName Command-Line Conventions This document uses the following command-line syntax conventions. Convention Usage [ optional ] Brackets describe optional syntax. For example: [ -create ] Bars indicate either or choices. For example: [ option1 ] [ option2 ] In this example, you must choose between option1 and option2. Autonomy SharePoint 2010 Connector (10.7) Page 16 of 150

17 About This Document Convention Usage { required } Braces describe required syntax in which you have a choice and that at least one choice is required. For example: { [ option1 ] [ option2 ] } In this example, you must choose option1, option2, or both options. required variable <variable> Absence of braces or brackets indicates required syntax in which there is no choice; you must type the required syntax element. Italics specify items to be replaced by actual values. For example: -merge filename1 (In some documents, angle brackets are used to denote these items.)... Ellipses indicate repetition of the same pattern. For example: Notices -merge filename1, filename2 [, filename3... ] where the ellipses specify, filename4, and so on. The use of punctuation such as single and double quotes, commas, periods indicates actual syntax; it is not part of the syntax definition. This document uses the following notices: Caution: A caution indicates an action can result in the loss of data. Note: A note provides information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases for example, memory limitations, equipment configurations, or details that apply to specific versions of the software Tip: A tip provides additional information that makes a task easier or more productive. Autonomy Product References This document references the following Autonomy products. Autonomy IDOL Server Autonomy Connector Framework Server (CFS) Autonomy SharePoint 2010 Connector (10.7) Page 17 of 150

18 About This Document Autonomy Intellectual Asset Protection System (IAS) Autonomy KeyView Autonomy License Server Autonomy Customer Support Autonomy Customer Support provides prompt and accurate support to help you quickly and effectively resolve any issue you may encounter while using Autonomy products. Support services include access to the Customer Support Site (CSS) for online answers, expertise-based service by Autonomy support engineers, and software maintenance to ensure you have the most up-to-date technology. To access the Customer Support Site go to The Customer Support Site includes: Knowledge Base. The CSS contains an extensive library of end user documentation, FAQs, and technical articles that is easy to navigate and search. Case Center. The Case Center is a central location to create, monitor, and manage all your cases that are open with technical support. Download Center. Products and product updates can be downloaded and requested from the Download Center. Resource Center. Other helpful resources appropriate for your product. To contact Autonomy Customer Support by or phone go to Contact Autonomy You can contact Autonomy by at autonomyinfo@hp.com. For office addresses, and other contact information, visit Autonomy SharePoint 2010 Connector (10.7) Page 18 of 150

19 Chapter 1: Introduction This section provides an overview of the SharePoint 2010 Connector (CFS). SharePoint 2010 Connector 19 Connector Framework Server 23 Autonomy's IDOL Platform 25 System Architecture 26 SharePoint 2010 Connector SharePoint 2010 Connector (CFS) is an Autonomy connector that automatically aggregates lists, documents, and user profiles from Microsoft SharePoint Note: The SharePoint 2010 Connector (CFS) is not compatible with SharePoint Foundation edition. The connector consists of two components: A web service that is installed on a front-end SharePoint server. The web service provides the documents and metadata from SharePoint to the connector. The web service provides more information than the default web services supplied with SharePoint. The connector. You can install the connector on any machine, provided it can communicate with the web service. After extracting information from SharePoint, the connector sends the documents to Connector Framework Server (CFS), which processes the information, and indexes it into an Autonomy IDOL server. Autonomy SharePoint 2010 Connector (10.7) Page 19 of 150

20 Chapter 1: Introduction After the documents are indexed, IDOL server automatically processes them, performing a number of intelligent operations in real time, such as: Agents Alerting Automatic Query Guidance Categorization Channels Clustering Collaboration Dynamic Clustering Dynamic Thesaurus Eduction Expertise Hyperlinking Mailing Profiling Retrieval Spelling Correction Summarization Taxonomy Generation Features and Capabilities The SharePoint 2010 Connector (CFS) retrieves data from a SharePoint 2010 repository. Repository Microsoft SharePoint The connector is not compatible with SharePoint Foundation Edition. Autonomy SharePoint 2010 Connector (10.7) Page 20 of 150

21 Chapter 1: Introduction Data the connector can retrieve List Items, including: Announcements. Appointments Blog Entries Contacts. Custom List Items. Posts in discussion forums. Publishing pages. Survey responses. Tasks. Wiki pages. Attachments to list items. Files in document libraries. Metadata from sites, lists, and folders. User Profiles. Data the connector cannot retrieve Content presented by web parts other than content editor web parts. The connector uses an API to retrieve the information stored in SharePoint, rather than crawling the web pages presented by the front end. This means that information displayed on a single page can be indexed in separate documents. Supported Actions The SharePoint 2010 Connector (CFS) supports the following actions. Action Supported Further Information Synchronize Synchronize Groups Collect Identifiers Autonomy SharePoint 2010 Connector (10.7) Page 21 of 150

22 Chapter 1: Introduction Insert The insert action can insert files into the SharePoint repository. It cannot insert other types of list item. Delete/Remove Hold/ReleaseHold The connector can only place a hold on list items or files in document libraries. To place a hold on documents, you must also install an additional web service. Update View Mapped Security You can use Mapped Security to protect documents that you retrieve from SharePoint using the SharePoint 2010 Connector. The connector can retrieve security permissions (Access Control Lists) that are attached to items in the repository. The connector adds an Access Control List to each document that is indexed into IDOL. The connector can also retrieve SharePoint security group information from the repository and send it to OmniGroupServer. The connector retrieves security group information when OmniGroupServer initiates the connector's SynchronizeGroups fetch action. For information about how to configure Mapped Security, see "SharePoint Mapped Security" on page 61. Display Online Help You can display the SharePoint 2010 Connector (CFS) Reference by sending an action from your Web browser. For SharePoint 2010 Connector to display help, the help data file (help.dat) must be available in the installation folder. To display help for SharePoint 2010 Connector 1. Start SharePoint 2010 Connector. 2. Send the following action from your Web browser: where, host is the IP address or name of the machine on which SharePoint 2010 Connector is installed. Autonomy SharePoint 2010 Connector (10.7) Page 22 of 150

23 Chapter 1: Introduction port is the ACI port by which you send actions to SharePoint 2010 Connector (set by the Port parameter in the [Server] section of the configuration file). For example: The navigation panel for the SharePoint 2010 Connector Reference includes the following options to display reference information. Tab Actions Configuration Parameters Service Actions Describes the actions you can send to SharePoint 2010 Connector. Actions allow you to query SharePoint 2010 Connector, and to instruct it to perform a variety of operations. Describes the parameters that determine how the SharePoint 2010 Connector operates. Configuration parameters are set in the SharePoint 2010 Connector configuration file. Describes service actions. Service actions allow you to return data about the SharePoint 2010 Connector service, and to control SharePoint 2010 Connector. OEM Certification The SharePoint 2010 Connector (CFS) works in OEM licensed environments. Connector Framework Server Connector Framework Server (CFS) processes the information that is retrieved by connectors, and then indexes the information into IDOL. A single CFS can process information from any number of connectors. For example, a CFS might process files retrieved by a File System Connector, web pages retrieved by a HTTP connector, and messages retrieved by an Exchange Connector. To use the SharePoint 2010 Connector to index documents into IDOL Server, you must have a CFS. When you install the SharePoint 2010 Connector, you can choose to install a CFS or point the connector to an existing CFS. For information about how to configure and use Connector Framework Server, refer to the Connector Framework Server Administration Guide. Filter Documents and Extract Subfiles The documents that are sent by connectors to CFS contain only metadata extracted from the repository, such as the location of a file or record that the connector has retrieved. CFS uses KeyView to extract the file content and file specific metadata from over 1000 different file types, and adds this information to the documents. This allows IDOL to extract meaning from the Autonomy SharePoint 2010 Connector (10.7) Page 23 of 150

24 Chapter 1: Introduction information contained in the repository, without needing to process the information in its native format. CFS also uses KeyView to extract and process sub-files. Sub-files are files that are contained within other files. For example, an message might contain attachments that you want to index, or a Microsoft Word document might contain embedded objects. Manipulate and Enrich Documents CFS provides features to manipulate and enrich documents before they are indexed into IDOL. For example, you can: add additional fields to a document. divide long documents into multiple sections. run tasks including Eduction, Optical Character Recognition, or Face Recognition, and add the information that is obtained to the document. run a custom Lua script to modify a document. Index Documents into IDOL After CFS finishes processing documents, it automatically indexes them into one or more indexes. CFS can index documents into: IDOL Server (or send them to a Distributed Index Handler, so that they can be distributed across multiple IDOL servers). IDOL OnDemand. Import Process This section describes the import process for new files that are added to IDOL through CFS. Autonomy SharePoint 2010 Connector (10.7) Page 24 of 150

25 Chapter 1: Introduction 1. Connectors aggregate documents from repositories and send the files to CFS. A single CFS can process documents from multiple connectors. For example, CFS might receive HTML files from HTTP Connectors, messages from Exchange Connector, and database records from ODBC Connector. 2. CFS runs pre-import tasks. Pre-Import tasks occur before document content and file-specific metadata is extracted by KeyView. 3. KeyView filters the document content, and extracts sub-files. 4. CFS runs post-import tasks. Post-Import tasks occur after KeyView has extracted document content and file-specific metadata. 5. The data is indexed into IDOL. Autonomy's IDOL Platform At the core of SharePoint 2010 Connector is Autonomy s Intelligent Data Operating Layer (IDOL). IDOL gathers and processes unstructured, semi-structured, and structured information in any format from multiple repositories using IDOL connectors and a global relational index. It can automatically form a contextual understanding of the information in real time, linking disparate data sources together based on the concepts contained within them. For example, IDOL can automatically link concepts contained in an message to a recorded phone conversation, that can be associated with a stock trade. This information is then imported into a format that is easily Autonomy SharePoint 2010 Connector (10.7) Page 25 of 150

26 Chapter 1: Introduction searchable, adding advanced retrieval, collaboration, and personalization to an application that integrates the technology. For more information on IDOL, refer to the IDOL Getting Started Guide. System Architecture An Autonomy IDOL infrastructure can include the following components: Connectors. Connectors aggregate data from repositories and send the data to CFS. Connector Framework Server (CFS). Connector Framework Server (CFS) processes the information that is retrieved by connectors. IDOL server. IDOL server is at the center of an Autonomy infrastructure. IDOL processes and stores the information that is indexed into it by CFS. Distributed Index Handler (DIH). The Distributed Index Handler distributes data across multiple IDOL servers. Using multiple IDOL servers can increase the availability and scalability of the system. License Server. The License server licenses multiple Autonomy products. These components can be installed in many different configurations. The simplest installation consists of a single connector, a single CFS, and a single IDOL server. Autonomy SharePoint 2010 Connector (10.7) Page 26 of 150

27 Chapter 1: Introduction A more complex configuration might include more than one connector, or use a Distributed Index Handler (DIH) to index content across multiple IDOL servers. Autonomy SharePoint 2010 Connector (10.7) Page 27 of 150

28 Chapter 2: Install SharePoint 2010 Connector This section describes how to install the SharePoint 2010 Connector. System Requirements 28 Permissions 29 SharePoint Connector Web Services 31 Install SharePoint 2010 Connector on Windows 31 Install the Web Service Manually 33 Uninstall the Web Service Manually 34 Install, Uninstall, and Rename the Connector Service 34 Check Privileges 35 System Requirements The SharePoint 2010 Connector can be installed as part of a larger Autonomy system that includes an Autonomy IDOL Server and an interface for the information stored in the IDOL Server. You can install the Connector on any computer provided it can communicate with the Web service (the connector takes the Web service URL and authentication details in its configuration file). The Web service must be installed on a front-end SharePoint server. To maximize performance, Autonomy recommends that you install the SharePoint 2010 Connector and IDOL Server on separate machines. Supported Platforms The SharePoint 2010 Connector (CFS) supports the following platforms: Windows (32-bit and 64-bit) SharePoint 2010 Connector Minimum Requirements To use the SharePoint 2010 Connector (CFS), the connector machine must meet the following requirements: 2 GHz Pentium4 processor. 2 GB RAM. 20 GB hard disk space. Microsoft Visual C Redistributable Package. Autonomy SharePoint 2010 Connector (10.7) Page 28 of 150

29 Chapter 2: Install SharePoint 2010 Connector SharePoint 2010 Connector Web Service Minimum Requirements To use the SharePoint 2010 Connector (CFS), you must install a web service on one of the front end SharePoint servers in your SharePoint farm. Note: If the Web service is installed in a farm environment, it must be on one of the front-end or application servers. OmniGroupServer To use Mapped Security to protect documents that you extract from SharePoint and index into IDOL, you must install OmniGroupServer. OmniGroupServer is required to extract and store security group information. The SharePoint 2010 Connector (CFS) requires OmniGroupServer version 7.5 or later. When you install Omni Group Server, you must install at least the Combine, LDAP and Text components. You can install OmniGroupServer anywhere on the system, but it must be able to communicate with the connector, your Active Directory, and your IDOL Server. Permissions This section describes the permissions that are required on the connector machine and on the repository machine. Connector Machine The user account that runs the connector must have administrator permissions on the connector machine. To use the collect action, the connector must have write-access to the collect destination folder. The connector might need permission to access the shared path for the IDOL View Server (if you use a View Server). Repository Machine The SharePoint user account used by the connector to retrieve data must have: Farm Administrator permissions. Site Collection Administrator permissions for the site from which you want to retrieve data. Read and Execute permissions on all SQL content databases (even if you do not plan to retrieve data from them). Read and Execute permissions to the shared services SQL content and DB databases. Autonomy SharePoint 2010 Connector (10.7) Page 29 of 150

30 Chapter 2: Install SharePoint 2010 Connector Create personal site, Use personal features and Manage user profiles permissions. To use Mapped Security, the SharePoint account used by the connector to retrieve information must have Site Collection Administrator privileges on the shared services administration site. The user making requests to the Web service (configured in the connector configuration file): Should have full control over the folder containing the relationship.db and policy.db files (configured in the Web service web.config). Should have full read access to all Web applications (this can be done by setting up a user policy for each one). The user running the application pool hosting the Web service: Should be the same user as the user running the SharePoint application pool. This is to ensure that the SharePoint API used by the Web service has sufficient privileges. To log messages to the event log, the connector must have full control of the following registry key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Eventlog. This is needed only to create the event log source, and can be removed after the first events have been logged. If the configuration has IndexUserProfiles, or IndexActivityFeeds set to TRUE, the user running the application pool will also need: Full control permission on the User Profile Service Application. Retrieve People Data for Search Crawlers administrative right on the User Profile Service Application. The application pool used to run the web service must run under an account that has writepermissions for the event log. Alternatively, you can configure the web service to log data to a local file. This requires write permission to the chosen log directory. Autonomy SharePoint 2010 Connector (10.7) Page 30 of 150

31 Chapter 2: Install SharePoint 2010 Connector SharePoint Connector Web Services The SharePoint 2010 Connector is supplied with the following web services. AutonomySharePoint2010Connector.wsp The standard web service that is installed by default if you use the installation wizard. You can also install this web service manually, by following the instructions in "Install the Web Service Manually" on page 33. AutonomySharePoint2010ConnectorLight.wsp The "light" version of the web service has been modified so that it does not cause errors if you use the MSOCAF tool. When the connector is used with the light web service, the connector cannot generate MHT files for collect actions. To use the light web service, you must install it manually, as described in "Install the Web Service Manually" on page 33. Install SharePoint 2010 Connector on Windows To install the SharePoint 2010 Connector (CFS) on Windows, follow these steps. To install the SharePoint 2010 Connector on Windows 1. Run the installation wizard. The installation wizard opens. 2. Read the instructions and click Next. The License Agreement dialog box opens. 3. Read the license agreement. If you agree to its terms, click I accept the terms of the License Agreement, and click Next. The Choose Install Folder dialog box opens. 4. Choose an installation folder for the connector. The default installation folder is C:\Autonomy\Sharepoint2010ConnectorCFS, but you can click Choose to choose another location. After you choose an installation folder, click Next. The Service Name dialog box opens. 5. In the Service Name box, type a name to use for the connector s Windows service and click Next. The Service Port and ACI Port dialog box opens. 6. Type the following information, and click Next. Autonomy SharePoint 2010 Connector (10.7) Page 31 of 150

32 Chapter 2: Install SharePoint 2010 Connector Service Port ACI Port The port used by the connector to listen for service actions. The port used by the connector to listed for actions. The License Server Configuration dialog box opens. 7. Type the IP address or host name, and the ACI Port of the license server, and click Next. The IDOL Database dialog box opens. 8. In the IDOL Database box, type the name of the IDOL database into which you want to index documents, and click Next. The SharePoint 2010 Connector Configuration dialog box opens. 9. The SharePoint connector requires a Web service to be installed on the SharePoint server. To install the Web service, select the Install Web Service check box, and click Next. Choose where to install the relationship and policy database files, and click Next. The Relationship Database file stores information about documents that will not be available when the documents are deleted from SharePoint. The Policy Database file stores information about Web application policies. To use an existing Web service or install the Web service manually, clear the Install Web Service check box, and click Next. In the Host box, enter the host name of an existing SharePoint Connector Web service and click Next. 10. Enter the requested information for a user who has access to SharePoint, and click Next. The Connector Framework Server dialog box opens. 11. Choose whether you want to install a new CFS or use an existing CFS. To install a new CFS, click Install New CFS and click Next. The Choose CFS Install Folder dialog box opens. Go to the next step. To use an existing CFS, click Use Existing CFS and click Next. The Connector Framework Server dialog box opens. Type the host name and port of your existing CFS installation. Click Next and go to Step Choose an installation folder for the Connector Framework Server (CFS). By default, CFS is installed in C:\Autonomy\ConnectorFramework, but you can click Choose to choose another Autonomy SharePoint 2010 Connector (10.7) Page 32 of 150

33 Chapter 2: Install SharePoint 2010 Connector location. After selecting an installation folder, click Next. The Enter Connector Framework Installation Name dialog box opens. 13. In the Installation Name box, type a unique name for the Connector Framework installation and click Next. This name is used for the Connector Framework service and various files. The name must not contain any spaces. The Connector Framework Service Settings dialog box opens. 14. Enter the following details, and click Next. Service Port ACI Port The port used by CFS to listen for service actions. The port used by CFS to listen for actions. The DRE Settings dialog box opens. 15. Enter the following details and click Next. IDOL Server Hostname ACI Port The host name or IP address of the IDOL server to which you want CFS to add documents. The ACI port of the IDOL server. The Pre-Installation Summary dialog box opens. 16. Review the installation settings. If necessary, click Previous to go back and change any settings. If you are satisfied with the settings, click Install. The connector is installed. After the connector is installed, the Start Service dialog box opens. 17. Choose whether to start the SharePoint 2010 Connector (CFS) and click Next. 18. If you installed a new Connector Framework Server, you can choose whether to start the CFS. Choose whether to start the CFS, and click Next. The installation is complete. 19. Click Done. You can now edit the connector s configuration file, and start the connector if you did not start it during the installation procedure. Install the Web Service Manually Use the following procedure to install the Web Service manually. If the service has been previously installed, retract it and delete it using the information in "Uninstall the Web Service Manually" on the next page. (The stsadm tool comes with SharePoint. For more information, refer to Autonomy SharePoint 2010 Connector (10.7) Page 33 of 150

34 Chapter 2: Install SharePoint 2010 Connector Note: To install the light web service, replace AutonomySharePoint2010Connector.wsp in the following procedure with AutonomySharePoint2010ConnectorLight.wsp. For more information about the light web service, see "SharePoint Connector Web Services" on page 31. To install the Web Service manually 1. Install the new solution using the following command: stsadm -o addsolution -filename "AutonomySharePoint2010Connector.wsp" 2. Deploy the new solution using the following command: stsadm -o deploysolution -name AutonomySharePoint2010Connector.wsp -local -a llowgacdeployment The Web Service appears at the following location: Uninstall the Web Service Manually Use the following procedure to manually retract and delete the Web Service from a command line. Note: To uninstall the light web service, replace AutonomySharePoint2010Connector.wsp in the following procedure with AutonomySharePoint2010ConnectorLight.wsp. For more information about the light web service, see "SharePoint Connector Web Services" on page 31. To uninstall the Web Service manually 1. Enter the following commands: stsadm -o retractsolution -name AutonomySharePoint2010Connector.wsp -local stsadm -o deletesolution -name autonomysharepoint2010connector.wsp Install, Uninstall, and Rename the Connector Service You can install and uninstall the SharePoint 2010 Connector service using the command line: ConnectorName.exe -install ConnectorName.exe -uninstall The name of the connector service is based on the name of the executable. To rename the connector service, uninstall the service, rename the connector executable file and then reinstall the service. You must also rename the configuration file to match the new executable name. Autonomy SharePoint 2010 Connector (10.7) Page 34 of 150

35 Chapter 2: Install SharePoint 2010 Connector To rename the connector service 1. If the connector service is running, stop the service. 2. Open a command-line window on the machine where you want to rename the connector service. 3. Uninstall the connector service: Sharepoint2010ConnectorCFS.exe -uninstall 4. Rename the connector executable file and configuration file: rename Sharepoint2010ConnectorCFS.exe CustomName.exe rename Sharepoint2010ConnectorCFS.cfg CustomName.cfg 5. Install the connector service: CustomName.exe -install The connector service is installed as CustomName. Check Privileges After you have installed the connector and the web service, specify the account that the connector should use to access the web service. The account credentials are specified by the Username and Password parameters in the connector's configuration file. You must also set the AuthenticationType configuration parameter to the type of authentication to use. To confirm that an account has sufficient privileges to read a document, log on to the SharePoint Web interface using the credentials you specified, and attempt to access a document yourself. For more information about the permissions required to retrieve documents from SharePoint, see "Permissions" on page 29. Autonomy SharePoint 2010 Connector (10.7) Page 35 of 150

36 Chapter 3: Configure SharePoint 2010 Connector This section describes how to configure the SharePoint 2010 Connector. SharePoint 2010 Connector Configuration File 36 Modify Configuration Parameter Values 38 Schedule Fetch Tasks 39 Encrypt Passwords 41 Customize Logging 43 Register with a Distributed Connector 44 Set Up Secure Communication 45 Set Up Event Handlers 47 Set Up Performance Monitoring 50 Backup and Restore the Connector s State 51 Reset the Connector 53 Example Configuration File 53 SharePoint 2010 Connector Configuration File You can configure the SharePoint 2010 Connector by editing the configuration file. The configuration file is located in the connector s installation folder. You can modify the file with a text editor. The parameters in the configuration file are divided into sections that represent connector functionality. Some parameters can be set in more than one section of the configuration file. If a parameter is set in more than one section, the value of the parameter located in the most specific section overrides the value of the parameter defined in the other sections. For example, if a parameter can be set in "TaskName or FetchTasks or Default", the value in the TaskName section overrides the value in the FetchTasks section, which in turn overrides the value in the Default section. This means that you can set a default value for a parameter, and then override that value for specific tasks. For information about the parameters that you can use to configure the SharePoint 2010 Connector, refer to the SharePoint 2010 Connector (CFS) Reference. Server Section The [Server] section specifies the ACI port of the connector. It also contains parameters that control the way the connector handles ACI requests. Autonomy SharePoint 2010 Connector (10.7) Page 36 of 150

37 Chapter 3: Configure SharePoint 2010 Connector Service Section The [Service] section specifies the service port of the connector. It also specifies which machines are permitted to send service actions to the connector. Actions Section The [Actions] section contains configuration parameters that specify how the connector processes actions that are sent to the ACI port. For example, you can configure event handlers that run when an action starts, finishes, or encounters an error. Logging Section The [Logging] section contains configuration parameters that determine how messages are logged. You can use log streams to send different types of message to separate log files. The configuration file also contains a section to configure each of the log streams. Connector Section The [Connector] section contains parameters that control general connector behavior. For example, you can specify a schedule for the fetch tasks that you configure. Default Section The [Default] section is used to define default settings for configuration parameters. For example, you can specify default settings for the tasks in the [FetchTasks] section. FetchTasks Section The [FetchTasks] section lists the fetch tasks that you want to run. A fetch task is a task that retrieves data from a repository. Fetch tasks are usually run automatically by the connector, but you can also run a fetch task by sending an action to the connector s ACI port. In this section, enter the total number of fetch tasks in the Number parameter and then list the tasks in consecutive order starting from 0 (zero). For example: [FetchTasks] Number=2 0=MyTask0 1=MyTask1 [TaskName] Section The [TaskName] section contains configuration parameters that apply to a specific task. There must be a [TaskName] section for every task listed in the [FetchTasks] section. Autonomy SharePoint 2010 Connector (10.7) Page 37 of 150

38 Chapter 3: Configure SharePoint 2010 Connector Ingestion Section The [Ingestion] section specifies where to send the data that is extracted by the connector. You can send data to a Connector Framework Server, IDOL OnDemand, or another connector. For more information about ingestion, see "Ingestion" on page 84. DistributedConnector Section The [DistributedConnector] section configures the connector to operate with the Distributed Connector. The Distributed Connector is an ACI server that distributes actions (synchronize, collect and so on) between multiple connectors. For more information about the Distributed Connector, refer to the Distributed Connector Administration Guide. ViewServer Section The [ViewServer] section contains parameters that allow the connector s view action to use a View Server. If necessary, the View Server converts files to HTML so that they can be viewed in a web browser. License Section The [License] section contains details about the License server (the server on which your license file is located). Document Tracking Section The [DocumentTracking] section contains parameters that enable the tracking of documents through import and indexing processes. Related Topics "Modify Configuration Parameter Values" below "Customize Logging" on page 43 Modify Configuration Parameter Values You modify SharePoint 2010 Connector (CFS) configuration parameters by directly editing the parameters in the configuration file. When setting configuration parameter values, you must use UTF-8. Caution: You must stop and restart SharePoint 2010 Connector (CFS) for new configuration settings to take effect. This section describes how to enter parameter values in the configuration file. Autonomy SharePoint 2010 Connector (10.7) Page 38 of 150

39 Chapter 3: Configure SharePoint 2010 Connector Enter Boolean Values The following settings for Boolean parameters are interchangeable: TRUE = true = ON = on = Y = y = 1 FALSE = false = OFF = off = N = n = 0 Enter String Values Some parameters require string values that contain quotation marks. Escape each quotation mark by inserting a backslash before it. For example: FIELDSTART0="<font face=\"arial\"size=\"+1\"><b>" Here, quotation marks indicate the beginning and end of the string. All quotation marks that are contained in the string are escaped. If you want to enter a comma-separated list of strings for a parameter, and one of the strings contains a comma, you must indicate the start and the end of this string with quotation marks. For example: ParameterName=cat,dog,bird,"wing,beak",turtle If any string in a comma-separated list contains quotation marks, you must put this string into quotation marks and escape each quotation mark in the string by inserting a backslash before it. For example: ParameterName="<font face=\"arial\"size=\"+1\"><b>",dog,bird,"wing,beak",turtle Schedule Fetch Tasks The connector automatically runs the fetch tasks that you have configured, based on the schedule in the configuration file. To modify the schedule, follow these steps. To schedule fetch tasks 1. Stop the connector. 2. Open the connector s configuration file in a text editor. 3. Find the [Connector] section. 4. The EnableScheduleTasks parameter specifies whether the connector should automatically run the fetch tasks that have been configured in the [FetchTasks] section. To run the tasks, set this parameter to true. For example: [Connector] EnableScheduledTasks=True Autonomy SharePoint 2010 Connector (10.7) Page 39 of 150