Objective WebTalk Connector Administration Guide. Version 7.5 Document Revision 0 25 October 2010

Transcription

1 Objective WebTalk Connector Administration Guide Version 7.5 Document Revision 0 25 October 2010

2 Copyright Notice Notice This documentation is a proprietary product of 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 Autonomy. While reasonable efforts have been made to ensure the accuracy of the information contained herein, 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 2010 Autonomy Corporation plc and its affiliates. All rights reserved. ACI API, Alfresco Connector, Arcpliance, 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 Autonomy Corporation plc and its affiliates. 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. 25 October 2010

3 Contents Preface...13 Version...13 Notational Conventions...14 Command-line Syntax Conventions...15 Notices...16 Related Documentation...16 Support and Contact Information...17 Download the Latest Documentation...17 Contact Autonomy Technical Support...18 Contact Autonomy...18 Part 1 Getting Started Chapter 1 Introduction Overview...23 About Connector Framework Server...24 System Architecture...25 Import Process...26 Chapter 2 Installation System Requirements...27 Supported Platforms...27 Minimum Server Requirements...28 Install Objective WebTalk Connector on Windows...28 Directory Structure...30 Connector Framework Server Directory Structure...30 Objective WebTalk Connector Administration Guide 3

4 Contents Objective WebTalk Connector Directory Structure Chapter 3 Configure Objective WebTalk Connector Objective WebTalk Connector File Modify Parameters Enter Boolean Values Enter String Values File Sections Service Section Server Section Logging Section Connector Sectio Ingestion Section FetchTasks Section TaskName Section [License] Section Example File Start and Stop the Connector Start the Connector Stop the Connector Encrypt Passwords Set Up Log Streams Set Up Secure Socket Layer Connections Chapter 4 Configure Connector Framework Server Connector Framework Server File Modify Parameters Enter Boolean Values Enter String Values Configure Connector Framework Server Example File Chapter 5 Use Lua Scripts Use Lua Scripts within the CFS Configure a Lua Script Write a Lua Script Objective WebTalk Connector Administration Guide

5 Contents Method Reference...55 Document Objects Methods...58 addfield...58 copyfield...58 deletefield...58 getfieldnames...59 getfieldvalue...59 getfieldvalues...59 hasfield...60 renamefield...60 setfieldvalue...60 writestubidx...61 XMLDocument Methods...61 root...61 XPathExecute...61 XPathRegisterNs...62 XmlNodeSet Methods...62 at...62 size...63 XmlNode Methods...63 attr...63 content...63 firstchild...63 lastchild...64 name...64 next...64 nodepath...64 parent...65 prev...65 type...65 XmlAttr Methods...65 name...65 next...66 prev...66 type...66 value...66 ACI Methods...67 send_aci_action...67 send_aci_command...68 Config Methods...68 Objective WebTalk Connector Administration Guide 5

6 Contents get_config getvalue String Methods gobble_whitespace hash_string...70 parse_csv...70 parse_xml...71 Document Methods create_uuid...71 encrypt_security_field hash_file Date Methods convert_date_time File System Methods...73 abs_path copy_file create_path...74 delete_file file_setdates...75 getcwd is_dir move_file unzip_file zip_file Miscellaneous Methods log sleep Change the Value of a Field Add a Field Sections Example Script Use Lua Scripts Within the Connector Introduction Example Lua Script Objective WebTalk Connector Administration Guide

7 Contents Part 2 Parameter and Command Reference Chapter 6 Objective WebTalk Connector Parameters License Parameters...85 Service Parameters...86 Server Parameters...86 Port...86 Logging Parameters...87 Connector Parameters...87 Ingestion Parameters...87 FetchTasks/TaskName Parameters...87 Ancestor...88 DbConnectionString...88 Deletions...89 Domain...89 EncryptSecurityEntries...89 ExcludedFileTypes...90 IndexDatabase...90 ObjectiveViewerPostfix...91 ObjectiveViewerPrefix...91 Password...91 SecurityType...92 URLBase...92 Username...93 Chapter 7 Parameters Common to CFS Connectors ACI Server...96 LibraryName...96 MaximumThreads...96 MaxQueueSize...97 MaxScheduledSize...97 OnError...98 OnFinish...99 OnStart...99 Url...99 Import Service KeyviewDirectory Objective WebTalk Connector Administration Guide 7

8 Contents Distributed Connector ConnectorGroup Host Port RegisterConnector SharedPath View Server EnableViewServer Host Port SharedPath General Connector Parameters CleanOnStart DatastoreFile EnableExtraction EnableExtractionCopy EnableScheduledTasks EncryptACLEntries InsertFailedDirectory SynchronizeKeepDatastore SynchronizeThreads TaskMaxAdds TaskMaxDuration TaskThreads TempDirectory XsltDLL Fetch Task N Number ScheduleCycles ScheduleRepeatSecs ScheduleStartTime Ingestion EnableIngestion IndexDatabase IngestActions IngestAddAsUpdate IngestBatchSize IngestCheckFinished IngestDelayMS Objective WebTalk Connector Administration Guide

9 Contents IngestEnableAdds IngestEnableDeletes IngestEnableUpdates IngesterType IngestHost IngestKeepFiles IngestPort IngestSendByType IngestSharedPath IngestSSLConfig IngestWriteIDX Chapter 8 Parameters Common to CFS Connectors Using.NET Framework DotNetConnectorClass DotNetConnectorLibrary Chapter 9 CFS Connector Actions Synchronous Versus Asynchronous Actions QueueInfo Action Synchronize Fetch Action Collect Fetch Action Identifiers Fetch Action Insert Fetch Action Delete/Remove Fetch Action Hold and ReleaseHold Fetch Actions Update Action View Action StopFetch Action Chapter 10 Connector Framework Server Parameters Service Parameters Server Parameters AdminClients Port QueryClients Actions Parameters Objective WebTalk Connector Administration Guide 9

10 Contents MaxQueueSize MaximumThreads Import Tasks and their Parameters PostN PreN HashN DeleteN UpdateN Additional Task Types SectionerMaxBytes SectionerMinBytes SectionerSeparatorsN Import Service Parameters ExtractDirectory ImportFamilyRootExcludeFmtCSV ImportHashFamilies ImportInheritFieldsCSV ImportMerg s KeyviewDirectory MaxImportQueueSize RevisionMarks ThreadCount XsltDLL Indexing Parameters ACIPort DREHost IndexBatchSize IndexTimeInterval Chapter 11 License Parameters Full Holder Key LicenseServerACIPort LicenseServerHost LicenseServerTimeout LicenseServerRetries Operation Objective WebTalk Connector Administration Guide

11 Contents Chapter 12 Logging Parameters LogArchiveDirectory LogCompressionMode LogDirectory LogEcho LogExpireAction LogFile LogHistorySize LogLevel LogLevelMatch LogMaxLineLength LogMaxOldFiles LogMaxSizeKBs LogOldAction LogOutputLogLevel LogSysLog LogTime LogTypeCSVs Chapter 13 Secure Socket Layer Parameters SSLConfig SSLCACertificate SSLCertificate SSLCheckCertificate SSLCheckCommonName SSLMethod SSLPrivateKey SSLPrivateKeyPassword Chapter 14 Service Parameters ServiceACIMode ServiceControlClients ServiceHost ServicePort ServiceStatusClients Objective WebTalk Connector Administration Guide 11

12 Contents Chapter 15 Service Actions Action Syntax GetConfig GetLogStream GetLogStreamNames GetStatistics GetStatus GetStatusInfo SetConfig Stop Chapter 16 Service Action Parameters Config FromDisk Name Tail Appendixes KeyView Classes KeyView Formats Glossary Index Objective WebTalk Connector Administration Guide

13 Preface This guide is for readers who need to configure and install Objective WebTalk Connector. It is intended for readers who have installed IDOL and are familiar with concepts related to administering a multi-part distributed application. This preface contains the following sections: Version Notational Conventions Command-line Syntax Conventions Notices Related Documentation Support and Contact Information Version The information in this guide is current as of Objective WebTalk Connector version 7.5. The content was last modified 25 October Corrections or updates to this information may be available through the Autonomy Support site; see Support and Contact Information on page 17. Objective WebTalk Connector Administration Guide 13

14 Preface Notational Conventions This guide uses the following conventions. Convention Bold Italics monospace font monospace bold monospace italics Usage User-interface elements such as a menu item or button. For example: Click Cancel to halt the operation. 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. File names, paths, and code. For example: The FileSystemConnector.cfg file is installed in C:\Autonomy\FileSystemConnector\ Data typed by the user. For example: Type run at the command prompt. In the User Name field, type Admin. Replaceable strings in file paths and code. For example: user UserName 14 Objective WebTalk Connector Administration Guide

15 Command-line Syntax Conventions This guide 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. { 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: -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. Objective WebTalk Connector Administration Guide 15

16 Preface Notices This guide uses the following notices: CAUTION A caution indicates an action can result in the loss of data. IMPORTANT An important note provides information that is essential to completing a task. 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. Related Documentation The following documents provide more details on Objective WebTalk Connector: IDOL Administration User Guide IDOL Administration provides a distributed, Web-based infrastructure for managing IDOL components and services. The IDOL Administration manual describes how to administer IDOL through the IDOL Administration Dashboard and Dashboard console. IDOL Server Administration Guide IDOL server lies at the center of an Autonomy infrastructure, storing and processing the data that connectors index into it. The IDOL Server Administration Guide describes the operations that IDOL server can perform with detailed descriptions of how to set them up. 16 Objective WebTalk Connector Administration Guide

17 Distributed Index Handler (DIH) Administration Guide This guide provides details on how you can use a DIH to distribute aggregated documents across multiple IDOL servers. Intellectual Asset Protection System (IAS) Administration Guide This guide provides details on how you can use Autonomy s Intelligent Asset Protection System (IAS) to ensure secure access through authentication and role permissions. Distributed Service Handler (DiSH) Administration Guide This guide provides details on how you can use a DiSH server to administer and control multiple Autonomy services. Support and Contact Information Read this section to obtain the latest product documentation, request technical support, or contact Autonomy. Download the Latest Documentation You can retrieve the latest available product documentation from Autonomy s Knowledge Base on the Customer Support site. To download the latest document revisions 1. Type this URL in your Web browser's address field: IMPORTANT Access to the contents of the Customer Support site requires a user name and password. To obtain a user name and password, follow the sign-up instructions on the home page. 2. Click Log In and type your address and password. 3. Click Sign in. 4. Click Knowledge Base. 5. Type query text or select a category to filter your search for documentation. The most recently added documents display at the top of the results list. Objective WebTalk Connector Administration Guide 17

18 Preface The version number associated with a document (for example, version 7.5) is the product version that the document describes. If a document has a revision number (for example, Revision 5), the document has been revised since it was first released with the specified product version. The Knowledge Base contains the latest available revision of any document. Contact Autonomy Technical Support Autonomy Technical Support exists to provide you with prompt and accurate resolutions to difficulties relating to using Autonomy software products. You can contact Technical Support using any of the following methods: Call or the support group at the location that is nearest to you: Europe and Worldwide tsp-europe@autonomy.com Telephone: (UK, Germany, Spain, Netherlands, France) +44 (0) (UK only) Hours: 09:00 to 17:00 (GMT+1) North and South America support@autonomy.com Telephone: (Canada direct) Hours: 07:00 to 18:00 MST (GMT-7) Contact Autonomy Access the Customer Support site at: Access to the contents of the Customer Support site requires a user name and password. To obtain a user name and password, follow the sign-up instructions on the home page. Contact the location that is nearest to you for general information about Autonomy: Europe and Worldwide autonomy@autonomy.com Telephone: +44 (0) Fax: +44 (0) Autonomy Corporation plc Cambridge Business Park Cowley Road, Cambridge, CB4 0WZ, UK North and South America autonomy@autonomy.com Telephone: Fax: Autonomy, Inc. One Market Plaza, Spear Tower, Suite 1900 San Francisco, CA , US 18 Objective WebTalk Connector Administration Guide

19 Objective WebTalk Connector Administration Guide 19

20 Preface 20 Objective WebTalk Connector Administration Guide

21 PART 1 Getting Started This section provides an overview of the Objective WebTalk Connector, installation procedures, and configuration information for the connector and the Connector Framework server. It includes the following chapters: Introduction Installation Configure Objective WebTalk Connector Configure Connector Framework Server Use Lua Scripts

22 Part 1 Getting Started 22 Objective WebTalk Connector Administration Guide

23 CHAPTER 1 Introduction This chapter provides an overview of the Objective WebTalk Connector. It contains the following sections: Overview About Connector Framework Server System Architecture Import Process Overview Objective WebTalk Connector is an Autonomy connector that automatically aggregates documents from a WebTalk server. The files are then sent to Connector Framework server (CFS), which then processes the information and indexes it into an Autonomy IDOL server. Objective WebTalk Connector Administration Guide 23

24 Chapter 1 Introduction Once IDOL server receives the lists, documents, and user profiles, it automatically processes them, performing a number of intelligent operations in real time, such as: Agents Alerting Categorization Channels Clustering Collaboration Dynamic Thesaurus Hyperlinking Mailing Profiling Retrieval Spelling Correction Summarization Taxonomy Generation Expertise See your IDOL server s manual for further details. Related Topics Configure Connector Framework Server on page 49 About Connector Framework Server The Connector Framework server (CFS) receives information from various connectors, which it then processes and indexes into an IDOL server. A single CFS can be configured to work with multiple connectors and send documents to multiple IDOL servers or Distributed Index Handlers (DIH). In addition, the server can execute predefined tasks on documents just before they are imported, after they are imported, or if errors occur. CFS filters text from a variety of document types with KeyView filters, which are document-specific readers used for text extraction. Users generally do not access KeyView directly; however, the parameter ImportFamilyRootExcludeFmtCSV requires that you identify the desired KeyView document formats. ImportFamilyRootExcludeFmtCSV KeyView Format Codes 24 Objective WebTalk Connector Administration Guide

25 System Architecture System Architecture There are several ways to install the Connector Framework server. The simplest installation consists of a single CFS, single connector, and single IDOL server. It is also possible to have more complex configurations, consisting of more than one connector, a Distributed Index Handler (DIH), multiple IDOL servers, or some combination of these options. Objective WebTalk Connector Administration Guide 25

26 Chapter 1 Introduction Import Process The import process consists of the following basic steps: 1. The connector sends documents from the data repository to the CFS. 2. Pre-import tasks are performed, which are typically defined in Lua scripts. 3. KeyView filters the document content. 4. Post-import tasks are performed, as defined in the PostN parameters. 5. Optionally, a backup IDX or XML file is created. 6. The data is indexed into IDOL server, or sent to a DIH. 26 Objective WebTalk Connector Administration Guide

27 CHAPTER 2 Installation This section provides information that is required to install the Objective WebTalk Connector. It includes the following topics: System Requirements Install Objective WebTalk Connector on Windows System Requirements Supported Platforms Objective WebTalk Connector should be installed by the system administrator as part of a larger Autonomy system. That is, a system that includes Autonomy IDOL server and an interface for the information stored in IDOL server. Objective WebTalk Connector runs on Windows 32 and 64-bit platforms. For a detailed list of supported platforms, see the IDOL Release Notes. NOTE The documented platforms are the recommended and most fully tested platforms for IDOL. Autonomy can provide support for other platforms on request. Objective WebTalk Connector Administration Guide 27

28 Chapter 2 Installation Minimum Server Requirements 2 GHz Pentium4 processor 2 GB RAM 3 GB hard disk recommended Install Objective WebTalk Connector on Windows To install the Objective WebTalk Connector and Connector Framework server (CFS) on Windows, double-click ConnectorName_Version_platform.exe. NOTE While performing the following installation procedure, keep in mind that it is recommended that the Connector Framework server be started before the connector is started. Read and follow all installation instructions on the screen carefully. 1. The installation opens with the Introduction dialog box. Read the text, and click Next. The License agreement dialog box opens. 2. Read the license agreement and if you agree to its terms, select I accept the terms of the License Agreement and click Next. The Choose Install Folder dialog box opens. 3. Choose an installation folder for Objective WebTalk Connector. By default, Objective WebTalk Connector is installed in C:\Autonomy\ ConnectorName, but you can click the Choose button to choose another location. After you choose an installation folder, click Next. The License Server dialog box opens. 4. Enter the IP address or the hostname as well as the ACI Port of the license server and click Next. The Choose CFS Install Folder dialog box opens. 5. Enter the path name where you want the Connector Framework Server to be installed and click Next. The Enter Connector Framework Installation Name dialog box opens. 6. Enter a unique name for the Connector Framework installation. This name is used for the Connector Framework installation directory and various files. The 28 Objective WebTalk Connector Administration Guide

29 Install Objective WebTalk Connector on Windows name you choose must not contain any spaces. After you select a name, click Next. The Connector Framework Service Settings dialog box opens. 7. Enter the following details, and click Next. Service Port Service Status Clients Service Control Clients The port number that Objective WebTalk Connector uses to communicate with the license server. This port must not be used by any other service. The IP addresses of computers that are permitted to access the Objective WebTalk Connector status, but are not permitted to control the status. If you want to permit a number of machines to access the Objective WebTalk Connector status, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to access the Objective WebTalk Connector status. The IP addresses of computers that are permitted to control the Objective WebTalk Connector service. If you want to permit a number of machines to control the Objective WebTalk Connector service, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to control the Objective WebTalk Connector service. The DRE Settings dialog box opens. 8. Enter the following details and click Next. IDOL Server Hostname ACI Port Database Name The IP address of the IDOL server to which you want to add documents. The port number the connector uses to query IDOL server. The name of the IDOL server database into which you want the connector to index the information. The Connector ACI Port dialog box opens. 9. Enter the number of the port you wish the Connector Framework to listen on and click Next. The Pre-Installation Summary dialog box opens. Objective WebTalk Connector Administration Guide 29

30 Chapter 2 Installation Directory Structure 10. Review the installation settings, and click Previous to reverse through the installation configuration dialog boxes to change any settings if necessary. If you are satisfied with the settings, click Install. The Installing Objective WebTalk Connector dialog box opens. The progress of the installation process is indicated. If you want to abort the installation process, click Cancel. The Start Service dialog box opens. 11. Choose whether or not you want to start the Objective WebTalk Connector service immediately after installation, and click Next. 12. Choose whether or not you want to start the Connector Framework service immediately after installation, and click Next. 13. When the installation process completes, click Done. You can now edit the Objective WebTalk Connector and Connector Framework server configuration files and start the Objective WebTalk Connector service if you did not start the service in Step 11. Once the installation of Objective WebTalk Connector is completed, your installation directory contains the following files and subdirectories. Connector Framework Server Directory Structure The Connector Framework server (CFS) is installed to the ConnectorFramework directory which is at the same level as the Objective WebTalk Connector installation directory. The ConnectorFramework installation directory contains the following files and subdirectories (note that bold font indicates directories). File convtables filters jre scripts Description Folder containing various text files used during the importing process. Folder containing executables used during the importing process. Contains Java Runtime Environment for the uninstaller. Contains Lua scripts. 30 Objective WebTalk Connector Administration Guide

31 Install Objective WebTalk Connector on Windows File Uninstall_ConnectorFramework ConnectorFramework.cfg ConnectorFramework.exe ConnectorFramework_InstallLog.log lua.dll version.txt Description Files required for uninstalling Connector Framework server. Connector Framework server configuration file. Connector Framework server executable. Installation log file that lists the details of the installation process. Lua library. Text file containing version information. When you start the Connector Framework server for the first time, the following files are created: File logs actions uid autn_ntres.dll ConnectorFramework.lck license.log licensekey.txt portinfo.dat service.log Description Contains CFS log files. By default, this includes action.log, import.log, indexer.log. Contains queued asynchronous actions so that, if the server should go down, the actions will not be lost. When the server comes back up, the queued actions will be processed. Folder containing document tracking files. NT resource library. Lock file which prevents multiple instances of CFS running simultaneously. License log file. License information text document. File that lists the ports that the connector is using. Service actions log file. Objective WebTalk Connector Administration Guide 31

32 Chapter 2 Installation Objective WebTalk Connector Directory Structure By default, the Objective WebTalk Connector is installed to the C:\Autonomy\ ConnectorName directory. The Objective WebTalk Connector installation directory contains the following files and subdirectories (note that bold font indicates directories). File jre convtables Uninstall_ConnectorName actions autpassword.exe DotNetConnector.dll ConnectorName.cfg ConnectorName.dll Description Java Runtime Environment. Folder containing various text files used in the importing process. Files required for uninstalling Objective WebTalk Connector. This folder may be generated when the connector is run for the first time. It contains queued asynchronous actions, so that, if the server should go down, the actions will not be lost. When the server comes back up, the queued actions will be processed. Autonomy Password Encryption Utility executable, which allows you to encrypt the passwords. Common library for all DotNet Connectors. Objective WebTalk Connector configuration file. The DotNet related file that communicates with the repository itself. ConnectorName.dll.config ConnectorName.xmlSerializers. dll Autonomy.dll ConnectorName.exe ConnectorName_InstallLog.log license.html license.txt lua.dll version.txt A library used by the connector. Objective WebTalk Connector executable. Installation log file that lists the details of the installation process. HTML file containing license information. Text file containing license information. Lua library. Text file containing version information. 32 Objective WebTalk Connector Administration Guide

33 Install Objective WebTalk Connector on Windows When you start Objective WebTalk Connector for the first time, the following files and subdirectories are created: File license logs uid autn_ntres.dll license.log licensekey.txt portinfo.dat service.log Description.Folder containing license information. Contains Objective WebTalk Connector log files. By default, this includes application.log, action.log, collect.log, synchronize.log, view.log. Folder containing document tracking files. NT resource library. License log file. License information text document. File that lists the ports that the connector is using. Service actions log file. Related Topics Service Parameters on page 195 Objective WebTalk Connector Administration Guide 33

34 Chapter 2 Installation 34 Objective WebTalk Connector Administration Guide

35 CHAPTER 3 Configure Objective WebTalk Connector This chapter describes how to configure the parameters that determine how the Objective WebTalk Connector operates. The configuration settings are stored in the connector configuration file located in the Objective WebTalk Connector installation directory. You can modify the parameters directly in the configuration file using a text editor. This section includes the following topics: Objective WebTalk Connector File Modify Parameters File Sections Start and Stop the Connector Encrypt Passwords Set Up Log Streams Set Up Secure Socket Layer Connections Objective WebTalk Connector Administration Guide 35

36 Chapter 3 Configure Objective WebTalk Connector Objective WebTalk Connector File The parameters that determine how Objective WebTalk Connector operates appear in the InstallationName configuration file, located in your installation directory. You can modify these parameters to customize Objective WebTalk Connector according to your requirements. Modify Parameters The following section describes how to enter parameter values in the configuration file. 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, the beginning and end of the string are indicated by quotation marks, while 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 36 Objective WebTalk Connector Administration Guide

37 File Sections File Sections Service Section Server Section Logging Section The Objective WebTalk Connector configuration file contains the following sections: [Service] [Server] [Logging] [Connector] [Ingestion] [FetchTasks] [TaskName] [License] The [Service] section contains parameters that determine which machines are permitted to use and control the Objective WebTalk Connector service. For example: [Service] ServicePort=7013 ServiceStatusClients=*.*.*.* ServiceControlClients=*.*.*.* This section contains general server parameters. For example: [server] Port=7012 QueryClients=* AdminClients=* The [Logging] section lists the logging streams you want to set up to create separate log files for different log message types (application, action, and synchronize). It also contains a subsection for each of the listed logging streams, in which you can configure the parameters that determine how each stream is logged. For example: [Logging] LogLevel=FULL LogEcho=TRUE LogDirectory=logs 0=ApplicationLogStream Objective WebTalk Connector Administration Guide 37

38 Chapter 3 Configure Objective WebTalk Connector Connector Sectio Ingestion Section 1=ActionLogStream 2=SynchronizeLogStream [ApplicationLogStream] LogFile=application.log LogTypeCSVs=application [ActionLogStream] LogFile=action.log LogTypeCSVs=action [SynchronizeLogStream] LogFile=synchronize.log LogTypeCSVs=synchronize These parameters enable features, set temporary directories, and so on. Also, the parameters in this section specify details related to the CFS connectors.net files. These parameters must be set for the Objective WebTalk Connector to work, and should never need to be changed. [Connector] EnableIngestion=TRUE EnableExtraction=FALSE TempDirectory=Temp EnableScheduledTasks=TRUE ScheduleCycles=-1 ScheduleRepeatSecs=86400 //ScheduleStartTime=23:00 DotNetConnectorLibrary=ObjectiveWebTalkConnector.dll DotNetConnectorClass=ObjectiveWebTalkConnector.ObjectiveWebTalkCon nector The [Ingestion] section contains parameters that specify details for the Connector Framework server (also known as the Ingestion server). The server accepts data from the connector, generates an IDX or XML file, and sends the file to IDOL server for indexing. [Ingestion] IngesterType=AsyncPiranha Host=localhost Port=7000 BatchSize=300 IndexDatabase=ObjectiveWebTalk 38 Objective WebTalk Connector Administration Guide

39 File Sections FetchTasks Section The [FetchTasks] section lists the accounts you want to poll. In this section, you enter the total number of jobs in the Number parameter and then list the accounts in consecutive order starting from 0 (zero). For example: [FetchTasks] Number=1 0=MyTask1 TaskName Section The [TaskName] section contains configuration parameters that only apply to the specified job. There must be a [TaskName] section for every job listed in the [FetchTasks] section. NOTE A parameter specified in a [TaskName] section overrides the same parameter defined in the [FetchTasks] section which in turn overries the same parameter specified in the [Default] section. For example: [MyTask1] //Compulsory. This param sets the url base to visit the webtalk server.= URLBase= //Compulsory. This param sets the username of the credential= Username= //Compulsory. This param sets the password of the credential= Password= //Optional. This param sets the domain name of the credential. Default value is ""= Domain= //Optional. This param sets whether to delete documents deleted in the server. Default value is TRUE= Deletions=FALSE // The name of the IDOL Server database in which aggregated documents are to be stored= //IndexDatabase=MyDatabase IndexDatabase=Objective //Optional. Leave Ancestor blank to perform a full search for all documents within all folders in the repository= //Otherwise set Ancestor to the ID of the folder to search in, or to a single document ID. Default value is ""= //Ancestor= Objective WebTalk Connector Administration Guide 39

40 Chapter 3 Configure Objective WebTalk Connector //Optional. Sets the prefix of the drereference. Default value is ""= ObjectiveViewerPrefix= Download.aspx?NodeId= //Optional. Sets the postfix of the drereference. Default value is ""= //ObjectiveViewerPostfix=/postfix //Optional. Set EncryptSecurityEntries=TRUE if you want the extracted ACLs to be encrypted. Default value is TRUE EncryptSecurityEntries=TRUE //Optional. Specify the security type Default value is ""= SecurityType=objv //Optional. Set ExcludedFileTypes to a comma-separated list that prevent importing given types of files. Default value is ""= ExcludedFileTypes=FIL,fil,wmv,WMV,avi,AVI,nsf,NSF DbConnectionString=Server=;DataBase=;UID=;PWD= [License] Section Related Topics Logging Parameters on page 131 The [License] section contains licensing details, which you should not change. For example: [License] LicenseServerHost= LicenseServerACIPort=20000 Example File [service] ServicePort=7013 ServiceStatusClients=* ServiceControlClients=* [server] Port=7012 QueryClients=* AdminClients=* [Logging] LogLevel=FULL LogEcho=TRUE 40 Objective WebTalk Connector Administration Guide

41 Example File LogDirectory=logs 0=ApplicationLogStream 1=ActionLogStream 2=SynchronizeLogStream [ApplicationLogStream] LogFile=application.log LogTypeCSVs=application [ActionLogStream] LogFile=action.log LogTypeCSVs=action [SynchronizeLogStream] LogFile=synchronize.log LogTypeCSVs=synchronize [Connector] EnableIngestion=TRUE EnableExtraction=FALSE TempDirectory=Temp EnableScheduledTasks=TRUE ScheduleCycles=-1 ScheduleRepeatSecs=86400 //ScheduleStartTime=23:00 DotNetConnectorLibrary=ObjectiveWebTalkConnector.dll DotNetConnectorClass=ObjectiveWebTalkConnector.ObjectiveWebTalkCon nector [Ingestion] IngesterType=AsyncPiranha Host=localhost Port=7000 BatchSize=300 IndexDatabase=ObjectiveWebTalk [FetchTasks] Number=1 0=MyTask1 [MyTask1] //Compulsory. This param sets the url base to visit the webtalk server.= URLBase= //Compulsory. This param sets the username of the credential= Username= //Compulsory. This param sets the password of the credential= Password= Objective WebTalk Connector Administration Guide 41

42 Chapter 3 Configure Objective WebTalk Connector //Optional. This param sets the domain name of the credential. Default value is ""= Domain= //Optional. This param sets whether to delete documents deleted in the server. Default value is TRUE= Deletions=FALSE // The name of the IDOL Server database in which aggregated documents are to be stored= //IndexDatabase=MyDatabase IndexDatabase=Objective //Optional. Leave Ancestor blank to perform a full search for all documents within all folders in the repository= //Otherwise set Ancestor to the ID of the folder to search in, or to a single document ID. Default value is ""= //Ancestor= //Optional. Sets the prefix of the drereference. Default value is ""= ObjectiveViewerPrefix= Download.aspx?NodeId= //Optional. Sets the postfix of the drereference. Default value is ""= //ObjectiveViewerPostfix=/postfix //Optional. Set EncryptSecurityEntries=TRUE if you want the extracted ACLs to be encrypted. Default value is TRUE EncryptSecurityEntries=TRUE //Optional. Specify the security type Default value is ""= SecurityType=objv //Optional. Set ExcludedFileTypes to a comma-separated list that prevent importing given types of files. Default value is ""= ExcludedFileTypes=FIL,fil,wmv,WMV,avi,AVI,nsf,NSF DbConnectionString=Server=;DataBase=;UID=;PWD= [License] LicenseServerHost= LicenseServerACIPort=20000 Related Topics Set Up Log Streams Start and Stop the Connector The following section describes how to start and stop the connector. 42 Objective WebTalk Connector Administration Guide

43 Start and Stop the Connector Start the Connector Once you have installed a connector, you are ready to run it. Start the connector using one of the following methods. To start the connector using Windows Services 1. Open the Windows Services dialog box. 2. Select the ConnectorInstallName service, and click Start. 3. Close the Windows Services dialog box. Stop the Connector To start the connector by running the executable 1. In the connector installation directory, locate the connector executable called ConnectorInstallName.exe. 2. On a command line, enter ConnectorInstallName.exe. Stop a connector from running by using one of the following methods. To stop the connector using Windows Services 1. Open the Windows Services dialog box. 2. Select the ConnectorInstallName service, and click Stop. 3. Close the Windows Services dialog box. To stop the connector service by sending a command to the service port Type the following command in the address bar of your browser: where, host ServicePort The IP address (or name) of the machine on which the Objective WebTalk Connector is running. The Objective WebTalk Connector service port (specified in the [Service] section of the Objective WebTalk Connector configuration file). Objective WebTalk Connector Administration Guide 43

44 Chapter 3 Configure Objective WebTalk Connector Encrypt Passwords For added security, it is recommended all passwords be encrypted before they are entered into a configuration field. To encrypt passwords, follow the steps relevant to your operating system. To encrypt passwords 1. At a command prompt, change directories to InstallDir\ ConnectorName. 2. Enter one of the following strings: autpassword -e -tencryptiontype [options] PasswordString where, autpassword -d PasswordString autpassword -x -tencryptiontype [options] Option Description -e Encrypts the password. -d Decrypts the password. -x Performs the operation specified by the -o option. See Options. 44 Objective WebTalk Connector Administration Guide

45 Set Up Log Streams Option -tencryptiontype PasswordString Options Description The type of encryption used. The following options are available: Basic AES You may use either form of encryption. However, AES is a more secure type of encryption than basic encryption. The password to encrypt or decrypt. Options can be one of the following: -ooptionname=optionvalue. OptionName can be: KeyFile. Specifies the path and filename of a keyfile. It should contain 64 hexadecimal characters. This option is only available with the AES encryption type and the -x option. -c. The configuration filename in which to write the encrypted password. This option is only available with the -e argument. -s. The name of the section in the configuration file in which to write the password. This option is only available with the -e argument. -p. The parameter name in which to write the encrypted password. This option is only available with the -e argument. When writing the password to a configuration file, you must specify all related options: -c, -s, and -p. autpassword -e -tbasic -c./config.cfg -sdefault -ppassword passw0r autpassword -d passw0r autpassword -x -taes -okeyfile=./mykeyfile.ky Set Up Log Streams If the default logging does not suit your environment, you can set up your own log streams. Each log stream creates a separate log file in which specific log message types (for example, action, index, application, or import) are logged. To set up log streams 1. Open the configuration file in a text editor. Objective WebTalk Connector Administration Guide 45

46 Chapter 3 Configure Objective WebTalk Connector 2. Find the [Logging] section. (If the configuration file does not contain a [Logging] section, create one.) 3. Under the [Logging] section's heading, create a list of the log streams you want to set up using the format N=LogStreamName. For example: [Logging] LogLevel=FULL LogDirectory=logs 0=ApplicationLogStream 1=ActionLogStream In this example, two log streams are defined which report application, and action messages. Note the log streams are listed in consecutive order, starting from 0 (zero). 4. Create a new section for each of the log streams you defined. Each section must have the same name as the log stream. For example: [ApplicationLogStream] [ActionLogStream] 5. Specify the settings you want to apply to each log stream in the appropriate log stream's section. You can specify the type of logging that should be performed (for example, full logging), whether log messages should be displayed on the console, the maximum size of log files, and so on. For example: [ApplicationLogStream] logfile=application.log loghistorysize=50 logtime=true logecho=false logmaxsizekbs=1024 logtypecsvs=application loglevel=full [ActionLogStream] logfile=logs/action.log loghistorysize=50 logtime=true logecho=false logmaxsizekbs=1024 logtypecsvs=action loglevel=full 6. Save and close the configuration file. 7. Restart the service to execute your changes. 46 Objective WebTalk Connector Administration Guide

47 Set Up Secure Socket Layer Connections Set Up Secure Socket Layer Connections You can configure Secure Socket Layer (SSL) connections between the connector and other servers. Set the SSLConfig parameter in: The Server section if connections to the connector on the port specified in the Server section should be over SSL. the DistributedConnector section if connections to the distributed connector should be over SSL (if applicable). The ViewServer section if connections to the view server should be over SSL (if applicable). Set IngestSSLConfig in the TaskName or Ingestion section if connections to the ingester should be over SSL. To configure an incoming SSL connection 1. Open the Objective WebTalk Connector configuration file in a text editor. 2. Find the [Default] section. 3. Add the SSLConfig parameter to specify the section in which you have set the SSL details for the connection, usually SSLOptionN. For example: [Default]... SSLConfig=SSLOption0 4. Create a corresponding [SSLOptionN] section. The SSLOption entry must contain the SSLMethod, SSLCertificate, and SSLPrivateKey parameters. For example: [SSLOption0] SSLMethod=SSLV23 SSLCertificate=host1.crt SSLPrivateKey=host1.key 5. Save and close the configuration file. 6. Restart Objective WebTalk Connector to execute your changes. To configure outgoing SSL connections 1. Open the Objective WebTalk Connector configuration file in a text editor. 2. Find the job section. Objective WebTalk Connector Administration Guide 47

48 Chapter 3 Configure Objective WebTalk Connector 3. Add the SSLConfig parameter to specify the section in which you have set the SSL details for the connection, usually SSLOptionN. For example: [Job]... SSLConfig=SSLOption1 4. Create a corresponding [SSLOptionN] section. The SSLOption entry must contain the SSLMethod, SSLCertificate, and SSLPrivateKey parameters. For example: [SSLOption1] SSLMethod=SSLV23 SSLCertificate=host2.crt SSLPrivateKey=host2.key 5. Save and close the configuration file. 6. Restart Objective WebTalk Connector to execute your changes. 48 Objective WebTalk Connector Administration Guide

49 CHAPTER 6 Configure Connector Framework Server This chapter describes how to configure the parameters that determine how the Connector Framework server (CFS) operates. This chapter contains the following sections: Connector Framework Server File Modify Parameters Configure Connector Framework Server Example File Connector Framework Server File The parameters that determine how Connector Framework server operates are in the ConnectorFramework.cfg file, located in the CFS installation directory. You can modify these parameters to customize the CFS according to your requirements. The CFS supports all standard Server, Service, Logging, and License parameters. Most of the specific import tasks are defined in Lua scripts; therefore, the Connector Framework server configuration requirements are quite minimal. Objective WebTalk Connector Administration Guide 47

50 Chapter 6 Configure Connector Framework Server Related Topics Connector Framework Server Parameters Example File Modify Parameters The following section describes how to enter parameter values in the configuration file. 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, the beginning and end of the string are indicated by quotation marks, while 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 48 Objective WebTalk Connector Administration Guide

51 Configure Connector Framework Server Configure Connector Framework Server This section describes how to configure the basic Connector Framework server parameters. To configure CFS 1. Open the CFS configuration file. 2. In the [Service] section, specify the service information. 3. In the [Server] section, specify server information. 4. In the [ImportTasks] section, configure how data is imported to IDX or XML before it is indexed into IDOL server. 5. In the [ImportService] section, specify details for Keyview and the service that imports documents into IDX or XML. 6. In the [Indexing] section, specify the details for the IDOL server(s) to which the CFS will send documents for indexing. 7. In the [Actions] section, configure how actions are sent to the CFS. 8. Save the configuration file. Related Topics Service Parameters Server Parameters Import Tasks and their Parameters Import Service Parameters Indexing Parameters Actions Parameters Example File This section contains a basic example configuration file, which meets the minimum configuration requirements. [Service] Port=40030 [Server] Objective WebTalk Connector Administration Guide 49

52 Chapter 6 Configure Connector Framework Server Port=7000 [actions] MaximumThreads=10 [Indexing] DREHost= ACIPort=9000 IndexBatchSize=100 IndexTimeInterval=60 [Logging] LogLevel=NORMAL LogEcho=TRUE 0=IndexLogStream 1=ActionLogStream 2=ImportLogStream [ActionLogStream] LogFile=action.log LogTypeCSVs=action [ImportLogStream] LogEcho=TRUE LogFile=import.log LogTypeCSVs=import [IndexLogStream] LogFile=indexer.log LogTypeCSVs=indexer [ImportService] KeyviewDirectory=C:\Autonomy\PCLConnector\..\ConnectorFramework\ filters ExtractDirectory=C:\Autonomy\PLCConnector\..\ConnectorFramework\ Temp ThreadCount=8 ImportInheritFieldsCSV=AUTN_IDENTIFIER [ImportTasks] Post0=Lua:preIndexTask.lua 50 Objective WebTalk Connector Administration Guide

53 CHAPTER 5 Use Lua Scripts This chapter contains the following topics: Use Lua Scripts within the CFS Method Reference Use Lua Scripts Within the Connector Use Lua Scripts within the CFS Connector Framework server can import or process data using Lua, an embedded scripting language. A Lua script allows CFS to: Call out to an external service, for example to alert a user. Modify and insert document fields. Interface with other libraries. When data is imported, the script is run for each document. Scripts are written in Lua, a scripting language with simple procedural syntax. For more information on Lua, see: CFS supports all standard Lua functions. Objective WebTalk Connector Administration Guide 51

54 Chapter 5 Use Lua Scripts Configure a Lua Script You can execute four types of script: pre-lua or post-lua, Delete, and Update. Pre-Lua scripts are run after the document data is extracted but before it is filtered, so the document contains metadata. Post-Lua scripts are run after the document data is filtered, so it also contains the document content. Delete is run when a document is deleted. Update is run when a document is updated. Update and Delete are configured in the same way as Pre and Post, but they appear in the [IndexTasks] section. Use this procedure to specify the location of the Lua script file. Write a Lua Script To configure a Lua script 1. Stop the Connector Framework server. 2. Open the Connector Framework server configuration file in a text editor. 3. Locate the [ImportTasks] section, and enter a different value of PreN (for pre-lua scripts) or PostN (for post-lua scripts) for each script file. For example: [ImportTasks]... Pre0=Lua:script1.lua Pre1=Lua:script2.lua Post0=Lua:script3.lua 4. To enable family hashing, set the HashN parameter. If the function returns true, the document iskept; If the function returns false, the document is not. 5. Save the configuration file. The script should have this structure: function handler(document)... end The handler function is called for each document and is passed a document object. This is an internal representation of the document being processed. Modifying this object will change the document. NOTE You can write a library of useful functions to share between multiple scripts, which you can then include in the scripts by adding dofile( library.lua ) to the top of the lua script outside of the handler function. 52 Objective WebTalk Connector Administration Guide

55 Method Reference Method Reference The Connector Framework server supports several methods, which are listed in Table 1. Method Table 1 Supported methods Description Document Objects Methods addfield copyfield deletefield getfieldnames getfieldvalue getfieldvalues hasfield renamefield setfieldvalue writestubidx Creates a new field when passed a name and value. Creates a new named field with the same value as an existing named field. Removes a field from the document. Gets all the field names for the document. Gets a field value. Gets all values of a multi-valued field. Checks whether the document has a particular named field. Moves an existing field from one name to another. Sets a field value. Writes out a stub IDX document. XMLDocument Methods root XPathExecute XPathRegisterNs Returns an XMLNode that is the root node of the XML document. Returns XMLNodeSet that is the result of supplied XPath query. Register a namespace with the XML parser. Returns an integer detailing the error code. XMLNodeSet Methods at size Returns XMLNode at position pos in the array. Returns size of node set. XMLNode Methods attr content Returns first XMLAttr attribute object for this element. Returns the content (text element) of the xml node. Objective WebTalk Connector Administration Guide 53

56 Chapter 5 Use Lua Scripts Method firstchild lastchild name next nodepath parent prev type Table 1 Supported methods Description Returns XMLNode that is the first child of this node. Returns XMLNode that is the last child of this node. Returns the name of the xml node. Returns XmlNode that is the next sibling of this node. Returns the Xml path to the node that can be used in another XPath query. Returns the parent XmlNode of the node. Returns XmlNode that is the previous sibling of this node. Returns the type of the node as a string. XmlAttr Methods name next prev type value Returns the name of this attribute. Returns XmlAttr object for the next attribute in the parent element. Returns XmlAttr object for the previous attribute in the parent element. Returns the type of this attribute node. Returns the value of this attribute. ACI Methods send_aci_action send_aci_command Takes the action parameters as a table instead of the full action as a string to avoid issues with parameter values containing &. Sends the given query to the ACI server. Config Methods get_config getvalue Loads a configuration file. Returns the value of the configuration parameter key in a given section. String Methods Document Methods hash_string Reduces multiple adjacent while spaces. Hashes specified string. 54 Objective WebTalk Connector Administration Guide

57 Method Reference Method gobble_whitespace parse_xml Table 1 Supported methods Description Parse the given separated values string into a collection of individual strings. Parse the given XML string to an XMLDocument. Document Methods create_uuid encrypt_security_field hash_file Creates a universally unique identifier. Encrypts the ACL. Hashes specified file using the SH1 or MDA5 algorithm, or both. Date Methods convert_date_time Converts date and time formats using standard Autonomy syntax. File System Methods abs_path copy_file create_path delete_file file_setdates getcwd is_dir move_file unzip_file zip_file Returns the supplied path as an absolute path. Copies the source file to the destination path. Creates the specified directory tree. Deletes the file specified by path. Sets the given file times on the file specified by path. Returns the current working directory of the application. Checks if the supplied path is a directory. Moves the source file to the destination path. Extracts the zip file specified by path to the location specified by dest. Zips the supplied path (file or directory). Miscellaneous Methods log sleep Appends log messages to the specified file. Pauses the executing thread for a number of milliseconds. Objective WebTalk Connector Administration Guide 55

58 Chapter 5 Use Lua Scripts Document Objects Methods addfield Adds a new field to the document. Syntax addfield ( String fieldname, String fieldvalue ) Arguments Arguments fieldname fieldvalue Type/Description The name of the field to add. The value to set for the field. copyfield Copies a field to a certain name. Syntax copyfield ( String sourcename, String targetname ) Arguments Arguments sourcename targetname Type/Description The name of the field to copy. The destination field name. deletefield Deletes a field from a document. Syntax deletefield ( String fieldname ) Arguments Arguments fieldname Type/Description The name of the field to delete. 56 Objective WebTalk Connector Administration Guide

59 Method Reference getfieldnames Gets all the field names for the document. Syntax getfieldnames ( ) Returns A table of all the field names. getfieldvalue Gets the value of a field on a document. Syntax getfieldvalue( String fieldname ) Arguments Arguments fieldname Type/Description The name of the field who s value is to be retrieved. Returns A string containing the value. getfieldvalues Gets all values from all fields that have the same name. Syntax getfieldvalues( String fieldname ) Arguments Arguments fieldname Type/Description The name of the field to match. Returns A table of all the field values. Objective WebTalk Connector Administration Guide 57

60 Chapter 5 Use Lua Scripts hasfield Checks to see if a field exists for a document. Syntax hasfield ( String fieldname ) Arguments Arguments fieldname Type/Description The name of the field for who s existence you are checking. Returns A Boolean: true if the field exists, false otherwise. renamefield Changes the name of a field from one name to another. Syntax renamefield ( String currentname, String newname ) Arguments Arguments currentname newname Type/Description The name of the field to rename. The new name of the field. setfieldvalue Sets the value of a field on a document. Syntax setfieldvalue( String fieldname, String newvalue ) 58 Objective WebTalk Connector Administration Guide

61 Method Reference Arguments Arguments fieldname newvalue Type/Description The name of the field to set. The value to set for the field. If the field already exists, it will be overwritten. writestubidx Writes out a stub idx document (a metadata file used by IDOL applications). Syntax writestubidx( String filename ) Arguments Arguments filename Type/Description The name of the file to create. XMLDocument Methods Returns A Boolean: true if written, false otherwise. root Returns an XmlNode which is the root node of the XML document. Syntax root() Returns An XmlNode. XPathExecute Returns XmlNodeSet which is the result of supplied XPath query. Syntax XPathExecute( String xpathquery ) Objective WebTalk Connector Administration Guide 59

62 Chapter 5 Use Lua Scripts Arguments Arguments xpathquery Type/Description The xpath query to execute. Returns An XmlNodeSet node set. XPathRegisterNs Register a namespace with the XML parser. Returns an integer detailing the error code. Syntax XPathRegisterNs( String prefix, String URI ) Arguments Arguments prefix URI Type/Description The namespace prefix. The namespace location. XmlNodeSet Methods Returns 0 in case of success, -1 in case of error. at Returns XmlNode at position pos in the array. Syntax at( pos ) Arguments Arguments pos Type/Description The index of the item in the array to get. 60 Objective WebTalk Connector Administration Guide

63 Method Reference Returns An XmlNode. size Returns size of node set. Syntax size() XmlNode Methods Returns An integer of the size of the node set. attr Returns first XmlAttr attribute object for this element. Syntax attr() Returns An XmlAttr object. content Returns the content (text element) of the xml node. Syntax content() Returns A string containing the content. firstchild Returns XmlNode which is the first child of this node. Syntax firstchild() Objective WebTalk Connector Administration Guide 61

64 Chapter 5 Use Lua Scripts Returns An xmlnode. lastchild Returns XmlNode which is the last child of this node. Syntax lastchild() Returns An xmlnode. name Returns the name of the xml node. Syntax name() Returns A string containing the name. next Returns XmlNode which is the next sibling of this node. Syntax next() Returns An xmlnode. nodepath Returns the Xml path to the node which can be used in another XPath query. Syntax nodepath() Returns A string containing the path. 62 Objective WebTalk Connector Administration Guide

65 Method Reference parent Returns the parent XmlNode of the node. Syntax parent() Returns An xmlnode. prev Returns XmlNode which is the previous sibling of this node. Syntax prev() Returns An xmlnode. type Returns the type of the node as a string. Syntax type() XmlAttr Methods Returns A string containing the type. Possible values are: element_node comment_node element_decl attribute_node document_node attribute_decl text_node document_type_node entity_decl cdata_section_node document_frag_node namespace_decl entity_ref_node notation_node xinclude_start entity_node html_document_node xinclude_end pi_node dtd_node docb_document_node name Returns the name of this attribute. Objective WebTalk Connector Administration Guide 63

66 Chapter 5 Use Lua Scripts Syntax name() Returns A String containing the name of the attribute. next Returns XmlAttr object for the next attribute in the parent element. Syntax next() Returns An XmlAttr. prev Returns XmlAttr object for the previous attribute in the parent object. Syntax prev() Returns An XmlAttr. type Returns the type of this attribute node. Syntax type() Returns A String containing "attribute_node" if the node is valid, or "null" if the node is invalid. value Returns the value of this attribute. Syntax value() 64 Objective WebTalk Connector Administration Guide

67 Method Reference ACI Methods Returns A String containing the value of the attribute. send_aci_action Takes the action parameters as a table instead of the full action as a string to avoid issues with parameter values containing &. Syntax send_aci_action( host, port, action [, parameters][, timeout] [, retries] ) Example send_aci_action( localhost, 9000, query, {text = *, print = all } ); Arguments Arguments host port action timeout Type/Description The ACI host to send the query to. The port to send the query to. The action to perform (for example, query). The number of milliseconds to wait before timing out. The default is retries The number of times to retry if the request fails. The default is 3. Returns If the application has been configured with an XSLT dll (autnxslt.dll/ libautnxslt.so) then the response is returned as an XMLDocument. Otherwise, the xml response is returned as a string. If the request has failed, then nil is returned. send_aci_command Sends the given query to the ACI server at host:port with optional time-out (ms) and retries settings Objective WebTalk Connector Administration Guide 65

68 Chapter 5 Use Lua Scripts Syntax send_aci_command( host, port, query [, timeout] [, retries] ) Arguments Arguments host port query timeout Type/Description The ACI host to send the query to. The port to send the query to. The query to send (for example, action=getstatus) The number of milliseconds to wait before timing out. The default is retries The number of times to retry if the request fails. The default is 3. Config Methods Returns If the application has been configured with an XSLT dll (autnxslt.dll/ libautnxslt.so) then the response is returned as an XMLDocument. Otherwise, the xml response is returned as a string. If the request has failed, then nil is returned. get_config Load a configuration file. Syntax get_config( path ) Arguments Arguments path Type/Description The path of the configuration file to load. 66 Objective WebTalk Connector Administration Guide

69 Method Reference Discussion Config files are cached after the first call to get_config, to avoid unnecessary disk I/O in the likely event that the same config is accessed frequently by subsequent invocations of the Lua script. One cache is maintained per Lua state, so the maximum number of reads for a config file is equal to the number of threads which are running Lua scripts An error is raised if the configuration file does not exist. Returns A Config object. getvalue Returns the value of the configuration parameter key in a given section. If the key does not exist in the section, then the default value is returned. Syntax getvalue( String section, String key, String default ) Arguments Arguments section key default Type/Description The section name in the configuration file. The name of the key from which to read. The default value to use if no key is found. String Methods Returns A string containing the value read from the configuration file. gobble_whitespace Reduces multiple adjacent white spaces (tab, carriage return, space, and so on) in the specified field to a single space. Syntax String gobble_whitespace (String Input) Objective WebTalk Connector Administration Guide 67

70 Chapter 5 Use Lua Scripts Arguments Arguments Input Type/Description An input string. Returns A string without adjacent white spaces. hash_string Hashes the specified string using the SHA1 or MDA5 algorithm. Syntax String hash_string (String StringToHash, String Algorithm) Arguments Arguments StringToHash Algorithm Type/Description The string to be hashed. The algorithm to use. Must be either SHA1 or MDA5. Returns The hashed input string. parse_csv Parse the given separated values string into a collection of individual strings. Syntax parse_csv( csv_string [, delimiter]) Arguments Arguments csv_string Type/Description The string to parse. delimiter The delimiter to use (defaults to ","). 68 Objective WebTalk Connector Administration Guide

71 Method Reference Discussion The method understands quoted values (such that parsing 'foot, "leg, torso", elbow' produces three values) and ignores white space around delimiters. Returns The elements are returned as multiple return values. You may wish to put them in a table like this: local results = { parse_csv("cat,tree,house", ",") }; parse_xml Parse the given XML string to an XMLDocument. Syntax parse_xml( xml_string ) Arguments Arguments xml_string Type/Description XML data as a string. Document Methods Discussion This requires the XSLT dll (autnxslt.dll/libautnxslt.so). Returns An XMLDocument containing the parsed data, or nil if the string could not be parsed. create_uuid Creates a universally unique identifier. Syntax String create_uuid() Returns A universally unique identifier. Objective WebTalk Connector Administration Guide 69

72 Chapter 5 Use Lua Scripts encrypt_security_field Encrypts the ACL. Syntax String encrypt_security_field (String ACL) Arguments Arguments ACL Type/Description An Access Control List string. Returns An encrypted string. hash_file Hashes the specified file using the SHA1 or MDA5 algorithm, or both. Syntax String, [String] hash_file (String FileName, String Algorithm1, [String Algorithm2]) Arguments Arguments FileName Algorithm1 Algorithm2 Type/Description The name of the file to be specified. The type of algorithm to use. Must be either SHA1 or MDA5. The optional second type of algorithm to use. Must be whichever algorithm was not used in Algorithm1. Returns The hashed file. 70 Objective WebTalk Connector Administration Guide

73 Method Reference Date Methods convert_date_time Converts date and time formats using standard Autonomy syntax. Syntax String convert_date_time (String InputDateTime, String InputFormatCSV, String OutputFormat, [Boolean OutputGMT = false]) Arguments Arguments InputDateTime InputFormatCSV OutputFormat OutputGMT Type/Description The date and time to be converted. A comma-separated list of the possible date and time formats of the input. The format of the date and time to be output. Specifies whether to treat the date and time output as Greenwich Mean Time. Default is false. File System Methods Discussion All date and time input is treated as local time unless it contains explicit time zone information. Returns Date and time in the desired format. abs_path Returns the supplied path as an absolute path. Syntax abs_path( String path ) Objective WebTalk Connector Administration Guide 71

74 Chapter 5 Use Lua Scripts Arguments Arguments path Type/Description The relative path. Returns Returns a string of the supplied path as an absolute path. copy_file Copy the source file to the destination path. The copy will fail if the destination file already exists. This can be overridden by providing the optional overwrite argument which forces the copy if the destination exists. Syntax copy_file( String src, String dest [, Boolean overwrite] ) Arguments Arguments src dest overwrite Type/Description The source file. The destination file. Forces the copy if the destination exists. Returns Returns a Boolean indicating success/failure. create_path Creates the specified directory tree. Syntax void create_path (String Path) Arguments Arguments Path Type/Description The path to be created. 72 Objective WebTalk Connector Administration Guide

75 Method Reference delete_file Delete the file specified by path. Syntax delete_file( String path ) Arguments Arguments path Type/Description The path and filename of the file to be deleted. Returns Returns a Boolean indicating success/failure. file_setdates Sets the given file times on the file specified by path. If the format parameter is not specified, it is assumed that the dates are provided as seconds since the epoch (1st January 1970). Syntax file_setdates( String path, String created, String modified, String accessed [, String format] ) Arguments Arguments path created modified accessed format Type/Description The path or filename of the file to be deleted. The date created. The date modified. The last date accessed. Used to format the strings coming in at system time. The format parameter is the same as for other Autonomy products. Objective WebTalk Connector Administration Guide 73

76 Chapter 5 Use Lua Scripts getcwd Returns the current working directory of the application. Syntax getcwd() Returns Returns a string of the current working directory. is_dir Check if the supplied path is a directory. Syntax is_dir( String path ) Arguments Arguments path Type/Description The path to check. Returns Returns a Boolean indicating if the supplied path is a directory. move_file Move the source file to the destination path. The move will fail if the destination file already exists. This can be overridden by providing the optional overwrite argument which forces the move if the destination exists. Syntax move_file( String src, String dest [, Boolean overwrite] ) Arguments Arguments src dest overwrite Type/Description The source file. The destination file. Forces the move if the destination exists. 74 Objective WebTalk Connector Administration Guide

77 Method Reference Returns Returns a boolean indicating success/failure. unzip_file Extracts the zip file specified by path to the location specified by dest. Syntax unzip_file( String path, String dest ) Arguments Arguments path dest Type/Description The path or filename of the file to be unzipped. The destination path where the files are to be extracted. Returns Returns a boolean indicating success/failure. zip_file Zip the supplied path (file or directory). The output file will only be overwritten if true is supplied for the optional overwrite argument. Syntax uzip_file( String path [, Boolean overwrite] ) Arguments Arguments path overwrite Type/Description The path or filename of the file to be zipped. Forces the creation of the zip file if an output file already exists. Returns The output path is written to path.zip. Returns Boolean indicating success or failure. Objective WebTalk Connector Administration Guide 75

78 Chapter 5 Use Lua Scripts Miscellaneous Methods log Appends log messages to the specified file. Syntax log( String file, String message ) Arguments Arguments file message Type/Description The file to which log messages will be appended. The message to print to the file. Returns Nothing. sleep Pause the executing thread for a number of milliseconds. Syntax sleep( Integer milliseconds ) Arguments Arguments milliseconds Type/Description The number of milliseconds for which to pause the current thread. Returns Nothing. Change the Value of a Field The functions getfieldvalue and setfieldvalue allow you to modify the contents of a field directly. For example: 76 Objective WebTalk Connector Administration Guide

79 Method Reference local content = document:getfieldvalue("content") content = content.. "\ncopyright MyCorp\n" document:setfieldvalue("content", content) Add a Field The addfield document function creates a new field when passed a name and value. For example: document:addfield("test","123"); Sections Example Script The document object passed to the script's handler function in fact represents the first section of the document. This means the functions previously detailed only read and modify the first section. To perform operations on every section, use the getnextsection function. For example: local section = document while section do -- Manipulate section section = section:getnextsection() end There is currently no support for adding or removing sections. For each document, this Lua script adds a COUNT field, a total sections count to the title, and replaces the content of each section with the section number. NOTE The COUNT is 1 for the first document and increases as long as the job is running. doc_count = 0 function handler(document) doc_count = doc_count + 1 document:addfield("count",doc_count); local section_count = 0 local section = document Objective WebTalk Connector Administration Guide 77

80 Chapter 5 Use Lua Scripts while section do section_count = section_count + 1 section:setfieldvalue("content", "Section "..section_count); section = section:getnextsection() end document:setfieldvalue("title", document:getfieldvalue("title").." Total Sections "..section_count) return true; end Use Lua Scripts Within the Connector Introduction This section describes how to use CFS connector actions in Lua scripts to transform documents. It includes the following sections: Introduction Example Lua Script Example Lua Script There are occasions when documents are not to be sent to the Connector Framework Server (CFS). For example, you may use the Collect action to retrieve documents from one repository and then insert them into another. In doing so, you may need to transform the documents from the first repository before they can be accepted by the second repository. You can use a Lua script to do this. Some CFS connector configuration options and actions take a Lua script as a parameter. The information in this chapter discusses the requirements for any Lua script that is used in this way. You can use the CollectActions parameter of the Collect action, the IngestActions parameter of the Synchronize action and the IngestActions parameter in the configuration file to specify a Lua script that runs on each document. 78 Objective WebTalk Connector Administration Guide

81 Use Lua Scripts Within the Connector The Lua script takes the following parameters: Parameter config document params Description A configuration file object. A document object that represents the document. A table containing additional parameters provided by the connector. For example: TYPE. The type of the command being performed. This can be ADD, UPDATE, DELETE, or COLLECT. SECTION. The configuration section for the task. FILENAME. The document filename. The Lua script may modify this file, but should not delete it. The configuration file object provides the following methods: getvalue(section, parameter, default) The document object provides the following methods: addfield(fieldname, value) appendcontent(additionalcontent) setfieldvalue(fieldname, value) writestubidx(outputfilename) getfieldvalue(fieldname) hasfield(fieldname) renamefield(oldfieldname, newfieldname) copyfield(sourcefieldname, targetfieldname) deletefield(fieldname) getfieldvalues(fieldname) An example Lua script appears below: method handler( config, document, params ) -- If these lines are uncommented, and the connector is running -- from the console, all the parameters in params will be output -- to the console. -- for k,v in pairs(params) do -- print(k,v) -- end Objective WebTalk Connector Administration Guide 79

82 Chapter 5 Use Lua Scripts -- Sets local variables from the parameters passed in. local type = params["type"] local section = params["section"] local filename = params["filename"] -- Read a config setting from the config file. local val = config:getvalue(section, "ConfigSettingName", "Value") -- If the document is not being deleted, set the field FieldName -- to the value read from the config file. if type ~= "DELETE" then document:setfieldvalue("fieldname", val) end -- If this document has a file (that is, not just metadata), -- copy the file to a new location and write a stub idx -- containing the metadata with it. if filename ~= "" then copytofilename = "OutputPath/"..create_uuid(filename) copy_file(filename, copytofilename) document:writestubidx(copytofilename..".idx") end return true end NOTE The Lua script should return true normally, but can return false to reject the document when used as an Ingest action. 80 Objective WebTalk Connector Administration Guide

83 PART 2 Parameter and Command Reference This section describes some of the configuration parameters and action commands used by the Objective WebTalk Connector and Connector Framework server and includes the following chapters: Objective WebTalk Connector Parameters Parameters Common to CFS Connectors CFS Connector Actions Connector Framework Server Parameters License Parameters Logging Parameters Secure Socket Layer Parameters Service Parameters Service Actions Service Action Parameters

84 Part 2 Parameter and Command Reference 84 Objective WebTalk Connector Administration Guide

85 CHAPTER 6 Objective WebTalk Connector Parameters This chapter describes the parameters that determine how Objective WebTalk Connector operates. You can modify these parameters to customize Objective WebTalk Connector to your needs. License Parameters Service Parameters Server Parameters Logging Parameters Connector Parameters Ingestion Parameters FetchTasks/TaskName Parameters License Parameters This section contains parameters that determine licensing details. Related Topics License Parameters on page 125 Objective WebTalk Connector Administration Guide 85

86 Chapter 6 Objective WebTalk Connector Parameters Service Parameters This section contains parameters that determine which machines are permitted to use and control the Objective WebTalk Connector service. Related Topics Service Parameters on page 155 Server Parameters Port This section contains general parameters for indexing and querying. Specify the ACI port by which action commands are sent to the connector. Long Default: Required: Allowed Range: Recommended Range: Yes Minimum: 1 Maximum: Minimum: 1 Maximum: Server Port=7008 See Also: Related Topics Connector Framework Server Parameters on page Objective WebTalk Connector Administration Guide

87 Logging Parameters Logging Parameters This section contains the configuration parameters used to create separate log files for different log message types (such as, application, action, and synchronize) and to determine how each stream is logged. Related Topics Logging Parameters on page 131 Connector Parameters These parameters enable features, set temporary directories, and so on. Related Topics Parameters Common to CFS Connectors on page 53 Ingestion Parameters The parameters in this section specify details for the Connector Framework server (also known as the Ingestion server). The server accepts data from the connector, generates an IDX or XML file, and sends the file to IDOL for indexing. Related Topics Parameters Common to CFS Connectors on page 53 FetchTasks/TaskName Parameters The [FetchTasks] section lists the accounts you want to poll. In this section, you enter the total number of jobs in the Number parameter and then list the accounts in consecutive order starting from 0 (zero). For example: [FetchTasks] Number=1 0=MyTask1 Objective WebTalk Connector Administration Guide 87

88 Chapter 6 Objective WebTalk Connector Parameters Ancestor The [TaskName] section contains configuration parameters that only apply to the specified job. There must be a [TaskName] section for every job listed in the [FetchTasks] section. A parameter specified in a [TaskName] section overrides the same parameter defined in the [FetchTasks] section. For example: [MyTask] DirectoryRecursive=TRUE PathRegEx=.* DirectoryFileAttributeFilter=-1 Leave Ancestor blank to perform a full search for all documents within all folders in the repository. Otherwise set Ancestor to the ID of the folder to search in, or to a single document ID. String Default: Required: No TaskName or FetchTasks or Default Ancestor= See Also: Deletions Use this parameter to set whether or not to delete documents deleted in the server. Default: Required: Boolean True No TaskName or FetchTasks or Default Deletions=False See Also: 88 Objective WebTalk Connector Administration Guide

89 FetchTasks/TaskName Parameters Domain Use this parameter to set the domain name of the credential. String Default: Required: See Also: No TaskName or FetchTasks or Default Domain=MyDomain Password on page 91 Username on page 93 EncryptSecurityEntries Set EncryptSecurityEntries to True if you want the extracted ACLs to be encrypted. Default: Required: Boolean True No TaskName or FetchTasks or Default EncryptSecurityEntries=True See Also: ExcludedFileTypes Use this parameter to specify a comma-separated list that prevents importing given types of files. String Default: Required: No Objective WebTalk Connector Administration Guide 89

90 Chapter 6 Objective WebTalk Connector Parameters TaskName or FetchTasks or Default ExcludedFileTypes=FIL,fil,wmv,WMV,avi,AVI,nsf,NSF See Also: IndexDatabase Use this parameter to specify the name of the IDOL server database in which aggregated documents are to be stored. String Default: Required: Yes TaskName or FetchTasks or Default IndexDatabase=Objective See Also: ObjectiveViewerPostfix Use this parameter to specify the postfix of the DREREFERENCE. String Default: Required: No TaskName or FetchTasks or Default ObjectiveviewerPostfix=/postfix See Also: 90 Objective WebTalk Connector Administration Guide

91 FetchTasks/TaskName Parameters ObjectiveViewerPrefix Use this parameter to specify the prefix of the DREREFERENCE. String Default: Required: No TaskName or FetchTasks or Default ObjectiveviewerPrefix=/prefix See Also: Password Use this parameter to specify the password of the credential. String Default: Required: Yes TaskName or FetchTasks or Default Password=ie93kd*7 See Also: Username on page 93 SecurityType Use this parameter to specify the security type. String Default: Required: No Objective WebTalk Connector Administration Guide 91

92 Chapter 6 Objective WebTalk Connector Parameters TaskName or FetchTasks or Default SecurityType=objv See Also: URLBase Use this parameter to specify the the URL base to visit the WebTalk server. String Default: Required: Yes TaskName or FetchTasks or Default URLBase= See Also: Username Use this parameter to specify the username of the credential. String Default: Required: See Also: Yes TaskName or FetchTasks or Default Username=MyUserName Domain on page 89 Password on page Objective WebTalk Connector Administration Guide

93 CHAPTER 7 Parameters Common to CFS Connectors This chapter describes the parameters that are common to all connectors that use the Connector Framework Service (CFS). If more than one configuration file-section is specified for a configuration parameter, the value of the parameter located in the left-most section will override the values of the parameters contained in the other sections mentioned. Using the Section example, TaskName or FetchTasks or Default, parameter values in the TaskName section will override corresponding values in the FetchTasks section, which will, in turn, override those corresponding in the Default section. ACI Server Import Service Distributed Connector View Server General Connector Parameters Fetch Task Ingestion Objective WebTalk Connector Administration Guide 53

94 Chapter 7 Parameters Common to CFS Connectors ACI Server LibraryName The parameters in this section control the way the connector handles the load caused by incoming ACI requests. Use this parameter to specify the name of the library to use as the event handler. Set as HttpHandler to use as internal HTTP handler. Specifying the.dll or.so extension is optional. String Default: Required: See Also: No EventHandler LibraryName=./luaHandler OnError on page 56 OnFinish on page 57 OnStart on page 57 MaximumThreads Use this parameter to specify the maximum number of simultaneous ACI actions to process. The number of synchronous actions (for example, getstatus or view) that should be processed simultaneously: [Server] MaximumThreads=4 The number os asynchronous actions (for example, fetch) that should be processed simultaneously: [Actions] MaximumThreads=4 54 Objective WebTalk Connector Administration Guide

95 ACI Server Integer Default: 2 Required: No Actions or Server MaximumThreads=4 See Also: MaxQueueSize Use this parameter to specify the maximum number of asynchronous fetch action commands that will be queued by the connector. No further fetch actions will be accepted once the queue size has been reached (until the queue diminishes). Default: Required: Integer The default is the maximum integer value (no limit). No Actions MaxQueueSize=4 See Also: MaxScheduledSize on page 55 MaxScheduledSize Use this parameter to limit the number of Processing+Finished+Error tasks that are stored by the connector. All actions and response data are stored in a file, actions/fetch/fetch.queue. If the MaxScheduledSize parameter value is not specified, this file will continue to grow with each action - eventually a resource limit would be reached that will cause unhandled failures to occur. If this limit is exceeded, the oldest Finished or Error action is disposed of and so will no longer be accessible through the queueinfo action. The MaxScheduledSize and MaxQueueSize parameters together give the total actions that will be stored (Queued, Processing, Finished, or Error). Objective WebTalk Connector Administration Guide 55

96 Chapter 7 Parameters Common to CFS Connectors (Note that Queued, Processing, Finished, and Error are the action statuses reported by the queueinfo action. Default: Required: Integer The default is the maximum integer value (no limit). No Actions MaxScheduledSize=100 See Also: MaxQueueSize on page 55 OnError Use this parameter to specify the handler for the Fetch action error event. This is the section name that will contain the LibraryName and any other settings for the event handler. Typical configuration is (using OnFinish): [Actions] OnFinish=HttpHandler [HttpHandler] LibraryName=HttpHandler Url= String Default: Required: No Actions OnError=EventHandler See Also: 56 Objective WebTalk Connector Administration Guide

97 ACI Server OnFinish Use this parameter to specify the handler for the Fetch action finish event. String Default: Required: No Actions OnFinish=EventHandler See Also: OnStart Use this parameter to specify the handler for the Fetch action start event. String Default: Required: No Actions OnStart=EventHandler See Also: Url Use this parameter to specify the URL to receive event data (when configured to use LibraryName=HttpHandler only). Each handler type will have specific configuration settings. For HttpHandler, the available settings are: Url SSLConfig ProxyHost ProxyPort ProxyUser ProxyPassword UseNTLMAuthentication Objective WebTalk Connector Administration Guide 57

98 Chapter 7 Parameters Common to CFS Connectors NTLMUser NTLMPassword BasicUser BasicPassword If the Library parameter is set to Luahandler, the available parameter is LuaScript, which takes the path of the Lua script that handles the events. Lua script event handlers should be of the form: function handler(request, xml)... end request is a table holding the request parameters. xml is a string holding the response to the request. String Default: Required: No Actions Url= Url= See Also: Import Service KeyviewDirectory The parameters in this section control the way the connector interfaces with Keyview to extract document sub-files in response to collect or view actions. Use this parameter to specify the location of Keyview filters used for sub-file extraction. Doing so is an alternative to specifying this in the KEYVIEW_DIRECTORY environment variable. This parameter is used only if Keyview is required (if the EnableExtraction parameter is set to True). 58 Objective WebTalk Connector Administration Guide

99 Distributed Connector String Default: Required: No ImportService KeyviewDirectory=./filters See Also: EnableExtraction on page 65 Distributed Connector ConnectorGroup The parameters in this section control the way the connector behaves when used with the Distributed Connector. Use this parameter to specify the name of the connector group to which this connector belongs. The ConnectorGroup parameter can take any value - it is only configured in the individual connectors, and is passed to the Distributed Connector when registering. This parameter is used only if the RegisterConnector parameter is set to True. Default: Required: String Connector No DistributedConnector ConnectorGroup=Connector See Also: RegisterConnector on page 60 Objective WebTalk Connector Administration Guide 59

100 Chapter 7 Parameters Common to CFS Connectors Host Use this parameter to specify the hostname or IP address of the Distributed Connector. This parameter is used only if the RegisterConnector parameter is set to True. Default: Required: String localhost No DistributedConnector Host=localhost See Also: RegisterConnector on page 60 Port Use this parameter to specify the port number of the Distributed Connector. This parameter is used only if the RegisterConnector parameter is set to True. Integer Default: Required: No DistributedConnector Port=10000 See Also: RegisterConnector on page 60 RegisterConnector Use this parameter to register with the Distributed Connector. The connector will wait at startup for registration to be successful. If the action=fetch parameter synchronizestate is assigned, then this will hold the locations of the datastore files that will be used for the tasks. In this case, the DatastoreFile is ignored. The synchronizestate parameter is assigned when using the connector through the Distributed Connector. 60 Objective WebTalk Connector Administration Guide

101 Distributed Connector Default: Required: Boolean False No DistributedConnector RegisterConnector=False See Also: SharedPath Use this parameter to specify the path to a location common to all connectors in the Connector Group. This location is used to store the compressed datastore files used by the connectors. This parameter is used only if the RegisterConnector parameter is set to True. Default: Required: String The value of the TempDirectory parameter. No DistributedConnector SharedPath=./temp See Also: RegisterConnector on page 60 Objective WebTalk Connector Administration Guide 61

102 Chapter 7 Parameters Common to CFS Connectors View Server EnableViewServer The parameters in this section allow the connector s view action to use a View Server. If this parameter is set to True, documents retrieved by a view action are processed by the View Server before being returned. If set to False, the original documents are returned. Default: Required: Boolean False No Connector and ViewServer EnableViewServer=False See Also: Host Use this parameter to specify the hostname or IP address of the View Server. This parameter is used only if the EnableViewServer parameter is set to True. Default: Required: String localhost No ViewServer Host=localhost See Also: EnableViewServer on page Objective WebTalk Connector Administration Guide

103 View Server Port Use this parameter to specify the port number of the View Server. This parameter is used only if the EnableViewServer parameter is set to True. Integer Default: 9000 Required: No ViewServer Port=9000 See Also: EnableViewServer on page 62 SharedPath Use this parameter to specify the path to a location accessible by both the connector and the View Server. Intermediate files are stored here. This parameter is used only if the EnableViewServer parameter is set to True. Default: Required: String The value of the TempDirectory parameter. No ViewServer SharedPath=./temp See Also: EnableViewServer on page 62 Objective WebTalk Connector Administration Guide 63

104 Chapter 7 Parameters Common to CFS Connectors General Connector Parameters CleanOnStart Set this parameter to True to delete actions and the temp directory on start. Any action data stored in the actions folder is deleted - including all Queued actions. Default: Required: Boolean False No Connector CleanOnStart=True See Also: DatastoreFile Use this parameter to override the name of the datastore file used by synchronize actions. Normally, you should use the default value for this parameter. Default: Required: String connector_taskname_datastore.db No TaskName DatastoreFile=./Datastore/Datastore.db See Also: SynchronizeKeepDatastore on page Objective WebTalk Connector Administration Guide

105 General Connector Parameters EnableExtraction Use this parameter to enable the extraction of sub-files for collect and view actions. This requires keyview filters to be present and for their location to be specified in the KeyviewDirectory parameter or KEYVIEW_DIRECTORY environment variable. Default: Required: Boolean False No Connector EnableExtraction=False See Also: KeyviewDirectory on page 58 EnableExtractionCopy Generally, this parameter is only relevant to the File System Connector, that is acting on the original documents instead of temporary copies. When performing extraction from certain file types, KeyView has side-effects that mean that the document is updated. This specifically causes the modified date to be updated and will thus cause the connector to re-ingest the document on the next synchronize action. To avoid these modifications, the solution is to make a copy of the original document (by setting this parameter to True) and perform the extraction on the copy. For other connectors, enabling this setting will have no effect, since the connectors will be downloading temporary copies and will have ownership of the files. Default: Required: Boolean False No Connector EnableExtractionCopy=False See Also: KeyviewDirectory on page 58 Objective WebTalk Connector Administration Guide 65

106 Chapter 7 Parameters Common to CFS Connectors EnableScheduledTasks Use this parameter to enable internal scheduling of synchronize actions. When this is set to True, the numbered tasks configured in the FetchTasks section will be performed according to their schedules. If this is set to False, synchronize actions will be performed only in response to an ACI request. NOTE Some connectors allow this parameter to be set in the Task section. Not all connectors that have security necessarily must support this parameter. Default: Required: Boolean True No Connector EnableScheduledTasks=False See Also: EncryptACLEntries If this parameter is set to False, the entries in ACLs will not be encrypted. This should be used only for troubleshooting. Default: Required: Boolean True No Connector EncryptACLEntries=True See Also: 66 Objective WebTalk Connector Administration Guide

107 General Connector Parameters InsertFailedDirectory Use this parameter to specify the directory where failed insert commands are written. Default: Required: String./insertfailed No Connector InsertFailedDirectory=./insertfailed See Also: SynchronizeKeepDatastore When this parameter is set to True, a datastore file (.db) will remain on the disk after a synchronize action has been performed. When the synchronize action is next performed, this file will be checked by the connector so that it can index only documents that have changed since the last synchronize and can delete documents that have been deleted since the last synchronize. If this parameter is set to False, the datastore file is deleted at the end of each synchronize action. The next synchronize action will fetch all documents and will not delete old documents. Default: Required: Boolean True No Connector SynchronizeKeepDatastore=False See Also: SynchronizeThreads Use this parameter to specify the number of threads to use for synchronization if the connector supports multi-threading. This parameter will not have an effect if the connector does not support multi-threading. Objective WebTalk Connector Administration Guide 67

108 Chapter 7 Parameters Common to CFS Connectors In cases where this method is not supported by the connector, multiple tasks can be executed using the alternative TaskThreads setting. Integer Default: 5 Required: No Connector SynchronizeThreads=4 See Also: TaskMaxAdds Use this parameter to specify the maximum number of Adds to be processed by the task. The value 0 indicates an infinite number. Integer Default: 0 Required: No TaskName TaskMaxAdds=0 See Also: TaskMaxDuration Use this parameter to specify the maximum duration of the task in the format H[H][:MM][:SS]. String Default: Required: No 68 Objective WebTalk Connector Administration Guide

109 General Connector Parameters TaskName TaskMaxDuration=12:30:00 See Also: TaskThreads Use this parameter to specify the number of simultaneous tasks that can be performed for an action. Each action=fetch action results potentially in a number of tasks. Each task generally consists of performing a subset of the action using a particular configuration section. For example, a single synchronize action can actually mean performing a synchronize action for multiple configured tasks. For collect and other actions where identifiers are provided, the identifiers are tied to particular configuration sections, so the whole action can span across several configuration sections. Generally, a single task is for a particular configuration section. Each would be processed on a separate thread. Integer Default: 1 Required: No Connector TaskThreads=1 See Also: TempDirectory Use this parameter to specify the directory used to store temporary documents and files. Default: Required: String./temp No Objective WebTalk Connector Administration Guide 69

110 Chapter 7 Parameters Common to CFS Connectors Connector TempDirectory=./TempFiles See Also: XsltDLL Use this parameter to specify the location of the autnxslt library. Default: Required: String autnxslt.dll (if present) No Connector XsltDLL=autnxslt.dll See Also: Fetch Task Each action the connector performs consists of one or more tasks. Each task is associated with a section in the configuration file. The section to use is either specified in an action parameter or encoded in each document identifier supplied to the action. The parameters below let you specify a numbered list of tasks. This is the set of tasks that will be performed when the connector performs a synchronize action whose parameters do not specify which tasks should be performed. The connector will also run synchronize actions for these tasks automatically according to the configured schedules. 70 Objective WebTalk Connector Administration Guide

111 Fetch Task N Use this parameter to specify the name of the task section containing the parameters for the synchronize task to be performed. The task will only be performed if N is less than Number and greater than or equal to 0. String Default: Required: No FetchTasks or Connector Number=2 0=Task1 1=Task2 See Also: Number on page 71 Number The connector will schedule the tasks with the names specified by the numbered parameters 0 through Number -1. Numbers may be missing from the sequence. An alternative configuration method is to give the Number parameter the default value of -1. In this case, the tasks configured from 0 until the first missing parameter are used. For example, this configuration executes Task0 and Task2: [FetchTasks] Number=3 0=Task0 2=Task2 This executes only Task0: [FetchTasks] 0=Task0 2=Task2 Integer Default: -1 Required: No Objective WebTalk Connector Administration Guide 71

112 Chapter 7 Parameters Common to CFS Connectors FetchTasks or Connector Number=2 0=Task1 1=Task2 See Also: N on page 71 ScheduleCycles Use this parameter to specify the number of scheduled synchronize actions to perform. The value -1 specifies to repeat forever. The value 0 specifies to perform the task once. Any other positive value specifies the number of times to perform the task. This parameter has an effect only if the EnableScheduledTasks parameter is set to True. Integer Default: -1 Required: No TaskName or FetchTasks or Connector ScheduleCycles=3 See Also: EnableScheduledTasks on page 66 ScheduleRepeatSecs Use this parameter to specify the interval (in seconds) between scheduled synchronize actions. This parameter has an effect only if the EnableScheduledTasks parameter is set to True. Integer Default: Required: No 72 Objective WebTalk Connector Administration Guide

113 Ingestion TaskName or FetchTasks or Connector ScheduleRepeatSecs=3600 See Also: EnableScheduledTasks on page 66 ScheduleStartTime Use this parameter to specify the start time of the first scheduled synchronize action in the format H[H][:MM][:SS]. This parameter has an effect only if the EnableScheduledTasks parameter is set to True. String Default: Required: No TaskName or FetchTasks or Connector ScheduleStartTime=14:30:00 See Also: EnableScheduledTasks on page 66 Ingestion EnableIngestion The parameters in this section specify where the documents fetched by the synchronize action should be sent. Set this parameter to True if documents fetched by the synchronize action should be sent to the CFS or to another connector. Default: Required: Boolean True No Objective WebTalk Connector Administration Guide 73

114 Chapter 7 Parameters Common to CFS Connectors TaskName or Ingestion or Connector EnableIngestion=False See Also: IndexDatabase Use this parameter to specify the value assigned to the DREDBNAME field for all documents. String Default: Required: No TaskName or Ingestion IndexDatabase=News See Also: IngestActions The actions specified in this CSV will be performed on each document before it is sent to the CFS. Each action is in the form: ACTIONNAME:ACTIONPARAMETERS Possible actions are: Action Parameters Example META field=value IngestActions=META:MyField=MyValue LUA lua_script_filename IngestActions=LUA:myLuaScript.lua 74 Objective WebTalk Connector Administration Guide

115 Ingestion This parameter has an effect only if the EnableIngestion parameter is set to True. String Default: Required: No TaskName or Ingestion IngestActions=META:MyField=MyValue See Also: EnableIngestion on page 73 Related Topics IngestAddAsUpdate Use Lua Scripts on page 51 If you set this parameter to True, Add commands are treated as Updates for full metadata updating. Default: Required: Boolean False No TaskName or Ingestion IngestAddAsUpdate=False See Also: IngestBatchSize Use this parameter to specify the number of documents that are sent to the CFS in a single batch. This parameter has an effect only if the EnableIngestion parameter is set to True. Objective WebTalk Connector Administration Guide 75

116 Chapter 7 Parameters Common to CFS Connectors Integer Default: 100 Required: No TaskName or Ingestion IngestBatchSize=200 See Also: EnableIngestion on page 73 IngestCheckFinished If the IngesterType parameter is set to CFS, setting the IngestCheckFinished parameter to True will cause the connector to wait until documents have been added to the import queue before returning success. If sending to another connector, this connector will wait until the action completes. More specifically, the task is held in a queue, and each time the connector attempts to send more data to the destination connector, it will check the status of the previous actions sent and will only mark those tasks as complete once the status returns Finished. This parameter has an effect only if the EnableIngestion parameter is set to True. Default: Required: Boolean False No TaskName or Ingestion IngestCheckFinished=True See Also: EnableIngestion on page 73 IngesterType on page Objective WebTalk Connector Administration Guide

117 Ingestion IngestDelayMS Use this parameter to specify the number of milliseconds to pause between adding individual documents to the ingest queue. Integer Default: 0 Required: No Ingestion or TaskName IngestDelayMS=0 See Also: IngestEnableAdds Use this parameter to specify whether or not Add commands should be sent. Default: Required: Boolean True No Ingestion or TaskName IngestEnableAdds=True See Also: IngestEnableDeletes Use this parameter to specify whether or not Delete commands should be sent. Default: Required: Boolean True No Objective WebTalk Connector Administration Guide 77

118 Chapter 7 Parameters Common to CFS Connectors Ingestion or TaskName IngestEnableDeletes=True See Also: IngestEnableUpdates Use this parameter to specify whether or not Update commands should be sent. Default: Required: Boolean True No Ingestion or TaskName IngestEnableUpdates=True See Also: IngesterType Use this parameter to specify the type of ingestion process. The only allowed values are CFS, AsyncPiranha (alias for CFS), Connector, and ConnectorInsert (alias for Connector). If this parameter is set to CFS, the IngestHost and IngestPort parameters point to a Connector Framework Server (CFS) (which can be used to import the documents and index them). If this parameter is set to Connector, the IngestHost and IngestPort parameters point to another connector. Documents fetched from this repository by the synchronize action will be inserted into another repository using the connector specified. If this option is used, you will probably need to use the IngestActions parameter to convert the document into a form that can be handled by the other connector. Note that the synchronize action can result in Add, Update and Delete ingest commands. Adds result in insert actions, Updates result in update actions, and Deletes result in delete actions being sent to the destination connector. 78 Objective WebTalk Connector Administration Guide

119 Ingestion This parameter has an effect only if the EnableIngestion parameter is set to True. Default: Required: String AsyncPiranha No TaskName or Ingestion IngesterType=AsyncPiranha See Also: EnableIngestion on page 73 IngestActions on page 74 IngestHost on page 79 IngestPort on page 80 IngestHost Use this parameter to specify the hostname or IP address of the destination server. This parameter has an effect only if the EnableIngestion parameter is set to True. Default: Required: String localhost No TaskName or Ingestion IngestHost=localhost See Also: EnableIngestion on page 73 Objective WebTalk Connector Administration Guide 79

120 Chapter 7 Parameters Common to CFS Connectors IngestKeepFiles If this parameter is set to True, downloaded documents will not be deleted after they have been ingested. Default: Required: Boolean False No TaskName or Ingestion IngestKeepFiles=True See Also: EnableIngestion on page 73 IngestPort Use this parameter to specify the port number of the destination server. This parameter has an effect only if the EnableIngestion parameter is set to True. Integer Default: 7000 Required: No TaskName or Ingestion IngestPort=7050 See Also: EnableIngestion on page 73 IngestSendByType Use this parameter to specify whether or not to send Add, Update, and Delete commands separately. Default: Required: Boolean False No 80 Objective WebTalk Connector Administration Guide

121 Ingestion TaskName or Ingestion IngestSendByType=False See Also: IngestSharedPath Use this parameter to specify the location to which documents are saved before ingestion. This should be a path accessible by both the connector and the ingest server. Default: Required: String The value of the TempDirectory parameter. No TaskName or Ingestion IngestSharedPath=./TempDirectory See Also: EnableIngestion on page 73 IngestSSLConfig Use this parameter to specify the configuration file section containing the SSL settings that should be used when communicating with the CFS. For more information on the contents of this section, refer to Secure Socket Layer Parameters on page 147. String Default: Required: No TaskName or Ingestion IngestSSLConfig=SSLSettings See Also: EnableIngestion on page 73 Objective WebTalk Connector Administration Guide 81

122 Chapter 7 Parameters Common to CFS Connectors IngestWriteIDX If the IngestKeepFiles parameter is set to True, setting the IngestWr iteidx parameter to True causes the connector to write document metadata in a stub IDX file alongside the document. Default: Required: Boolean False No TaskName or Ingestion IngestWriteIDX=False See Also: EnableIngestion on page Objective WebTalk Connector Administration Guide

123 CHAPTER 8 Parameters Common to CFS Connectors Using.NET Framework DotNetConnectorClass This chapter describes the parameters that specify details related to the CFS connectors.net files. These parameters are found in the [Connector] section. Use this parameter to specify the full class name containing the connector implementation. Default: Required: String Autonomy.Connector.Example.FileSystemConnector No TaskName DotNetConnectorClass=Autonomy.Connector.Example.F ilesystemconnector See Also: Objective WebTalk Connector Administration Guide 125

124 Chapter 8 Parameters Common to CFS Connectors Using.NET Framework DotNetConnectorLibrary Use this parameter to specify the path and file name of the connector library. Default: Required: String DotNetConnector.dll No TaskName DotNetConnectorLibrary=DotNetConnector.dll See Also: 126 Objective WebTalk Connector Administration Guide

125 CHAPTER 9 CFS Connector Actions CFS connectors may provide one or more of the ACI actions described here. Not all connectors support all the actions. The sample HTTP requests in this section are split across multiple lines for readability. When using these requests, the whole request should be on one line and contain no spaces. Brackets ([]) enclosing a parameter indicate that the parameter is optional. Topics in this chapter include: Synchronous Versus Asynchronous Actions QueueInfo Action Synchronize Fetch Action Collect Fetch Action Identifiers Fetch Action Insert Fetch Action Delete/Remove Fetch Action Hold and ReleaseHold Fetch Actions Update Action View Action StopFetch Action Objective WebTalk Connector Administration Guide 87

126 Chapter 9 CFS Connector Actions Synchronous Versus Asynchronous Actions Some of the actions described here are synchronous and others are asynchronous. The connector does not respond to a synchronous action until it has completed the request. The result of the action is in the response to the request. An asynchronous action responds immediately; the request is added to a queue of actions to be performed. The response to the request contains a token. You can use this token to determine whether the request has finished and the results of the action. You can do this using the QueueInfo action. Example Response <autnresponse> <action>fetch</action> <response>success</response> <responsedata> <token>mtaumi4xmduumzq6mtizndpgrvrdsdoxnzuyntc4mdc0</token> </responsedata> </autnresponse> QueueInfo Action This action provides information about the asynchronous actions the connector is processing or has processed. Use this action to determine whether a task has completed and the results of the task. &QueueName=QueueName &QueueAction=QueueAction [&Token=Token] 88 Objective WebTalk Connector Administration Guide

127 QueueInfo Action Synchronous Parameter Name QueueName QueueAction Token Description The name of the queue you wish to retrieve information about. There is one queue per asynchronous action. Most of the connector s functionality is accessed through action=fetch, so usually you should specify Fetch. The action you wish to perform on the queue. Possible actions are: GetStatus. The response provides information about the action currently on the queue. This restricts the response to information about the action identified by the token. Example action=queueinfo&queuename=fetch&queueaction=getstatus Response A sample response appears below. Each action in the queue appears between <action> tags. This example shows a single synchronize action on the queue. This has finished and the response is included between the action tags. <autnresponse> <action>queueinfo</action> <response>success</response> <responsedata> <actions> <action> <documentcounts> <documentcount added="10" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="10" ingestupdated="0" inserted="0" releasedholds="0" seen="10" task="dir1" unchanged="0" updated="0"/> <documentcount added="10" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="10" ingestupdated="0" inserted="0" releasedholds="0" seen="10" task="dir2" unchanged="0" updated="0" </documentcounts> <fetchaction>synchronize</fetchaction> Objective WebTalk Connector Administration Guide 89

128 Chapter 9 CFS Connector Actions <tasks> <success>dir1</success> <success>dir2</success> </tasks> <token>mtaumi4xmduumzq6mtizndpgrvrdsdoxndayotu3mzy4</token> <status>finished</status> <queued_time>2009-oct-15 14:44:32</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 14:44:32</process_start_time> <time_processing>3</time_processing> <process_end_time>2009-oct-15 14:44:35</process_end_time> </action> </actions> </responsedata> </autnresponse> Synchronize Fetch Action This action is used to search a repository for document updates and send these updates to an Ingestion module. [&Config=Base64_Config] [&TaskSections=Section_CSV] [&IngestActions=Document_Action_CSV] Asynchronous Parameter Name Config TaskSections Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file. The names of the task sections to use to perform synchronization. If this parameter is unspecified, all configured task sections are used. 90 Objective WebTalk Connector Administration Guide

129 Synchronize Fetch Action Parameter Name IngestActions Description This parameter specifies actions to perform on documents prior to being ingested. This can be a list of document actions of the form action:parameters processed from left to right. The available documents actions are: META. Add a custom field to the document, specified as META:Fieldname=FieldValue LUA. Execute a Lua script on the document, specified as LUA:Luascript. To add a field CATEGORY=FILESYSTEM to every document, specify the ingest action as: IngestActions=META:CATEGORY=FILESYSTEM Any commas in the action parameters should be escaped with a backslash (\). Example Response A sample response appears below. In this example, two tasks were performed as part of the synchronize (DIR1 and DIR2). Both of these found 10 new documents, but ingestion failed for all 20 documents. <action> <documentcounts> <documentcount added="10" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="10" ingestupdated="0" inserted="0" releasedholds="0" seen="10" task="dir1" unchanged="0" updated="0"/> <documentcount added="10" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="10" ingestupdated="0" inserted="0" releasedholds="0" seen="10" task="dir2" unchanged="0" updated="0" </documentcounts> <fetchaction>synchronize</fetchaction> <tasks> <success>dir1</success> <success>dir2</success> </tasks> Objective WebTalk Connector Administration Guide 91

130 Chapter 9 CFS Connector Actions <token>mtaumi4xmduumzq6mtizndpgrvrdsdoxndayotu3mzy4</token> <status>finished</status> <queued_time>2009-oct-15 14:44:32</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 14:44:32</process_start_time> <time_processing>3</time_processing> <process_end_time>2009-oct-15 14:44:35</process_end_time> </action> Collect Fetch Action This action is used to retrieve documents and metadata by their Identifiers from a repository and send the documents to be ingested or to a specified location. [&Config=Base64_Config] [&Identifiers=Identifier_CSV] [&IdentifiersXML=Identifier_XML] [&Collectactions=Document_Action_CSV] [&Destination=UNC_Path] Asynchronous Parameter Name Config Identifiers Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options are used instead of the options in the connector configuration file. A CSV of the identifiers of the documents to be collected. 92 Objective WebTalk Connector Administration Guide

131 Collect Fetch Action Parameter Name IdentifiersXML Destination Description This parameter can be specified in addition to the Identifiers parameter and specifies additional identifiers to collect along with a set of custom metadata to be associated with each collected document. This data should be provided in XML format as below: <identifiersxml> <identifier value="[autn_identifier1]"> <metadata name="[customfield1]" value="[customfieldvalue1_1]"/> <metadata name="[customfield1]" value="[customfieldvalue1_2]"/> <! > </identifier> <identifier value="[autn_identifier2]"> <metadata name="[customfield1]" value="[customfieldvalue2_1]"/> <! > </identifier> <! > </identifiersxml> Output destination as UNC Path. If this is blank, the documents are added to the ingest queue. The parameter can use fields from the document or identifier to construct the resulting destination for each document. To add a document field value as part of the destination, use the tag <DOC:FIELDNAME> within the string. To add an identifier field value as part of the destination use the tag <ID:FIELDNAME> within the string. destination=\\server\share\<id:source>\<doc:owner> Where a field can have multiple values or is a CSV, multiple destinations are created and each gets a copy of the document. A CSV can be specified by preceding the colon with the CSV separator character. <ID,:SOURCE>. Objective WebTalk Connector Administration Guide 93

132 Chapter 9 CFS Connector Actions Parameter Name CollectActions Description This parameter specifies actions to perform on documents prior to transferring them to their destination. This can be a list of document actions of the form action:parameters processed from left to right. The available documents actions are: META. Add a custom field to the document, specified as META:Fieldname=FieldValue ZIP. Add the document to a zip file, specified as ZIP:Filename[:Password] LUA. Execute a Lua script on the document, specified as LUA:Luascript. To add a field CATEGORY=FILESYSTEM to every document, zip all documents with a password and add a field COLLECTTIME= to the zip, specify the collect action as: CollectActions=META:CATEGORY=FILESYSTEM,ZIP:Output.z ip:password,meta:collecttime= Any commas in the action parameters should be escaped with a \. Example action=fetch&fetchaction=collect&identifiers=pglkihm9ikrjujeiihi9i km6xef1dg9ub215xezpbgvtexn0zw1db25uzwn0b3jdrlnczglymvxmawxlos50ehq ilz4%3d,pglkihm9ikrjujeiihi9ikm6xef1dg9ub215xezpbgvtexn0zw1db25uzw N0b3JDRlNcZGlyMVxmaWxlOC50eHQiLz4%3D&Destination=C:\Autonomy\ collected Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo action) appears below. In this example the tokens for both documents appear between <success> tags showing that they were collected successfully. The documents were output to C:\ Autonomy\collected along with stub files containing their metadata. <action> <documentcounts> <documentcount added="0" collected="2" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="0" releasedholds="0" seen="0" task="dir1" unchanged="0" updated="0"/> 94 Objective WebTalk Connector Administration Guide

133 Identifiers Fetch Action </documentcounts> <fetchaction>collect</fetchaction> <tasks> <success> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxmaWxlOC50eHQiLz4= </success> <success> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxmaWxlOS50eHQiLz4= </success> </tasks> <token>mtaumi4xmduumzq6mtizndpgrvrdsdotmti2nte0mti5na==</token> <status>finished</status> <queued_time>2009-oct-15 16:02:53</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 16:02:53</process_start_time> <time_processing>0</time_processing> <process_end_time>2009-oct-15 16:02:53</process_end_time> </action> Related Topics Synchronous Versus Asynchronous Actions Identifiers Fetch Action This action is used to retrieve a list of document identifiers and optionally perform an action on them (currently only the collect action is available). It should not be used to perform queries that could be more efficiently performed through IDOL server. [&Config=Base64_Config] &ConfigSection=Section_Name [&Identifiersaction=Collect &Destination=UNC_Path [&CollectActions=Document_Action_CSV] [&Connector-specific_Parameters] Objective WebTalk Connector Administration Guide 95

134 Chapter 9 CFS Connector Actions Asynchronous Parameter Name Config ConfigSection IdentifiersAction Connector-specific_ Parameters Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file. The name of the configuration file section containing the task settings. The name of the action to perform on the returned identifiers. If this action should be passed additional parameters, you should specify them as parameters to this action. Additional parameters that are connector-specific and determine which identifiers to return. Example action=fetch&fetchaction=identifiers&configsection=dir1 Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo action) appears below. This shows that the action has completed. The identifiers are listed in between the <identifiers> tags. <action> <documentcounts> <documentcount added="0" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="0" releasedholds="0" seen="0" task="dir1" unchanged="0" updated="0"/> </documentcounts> <fetchaction>identifiers</fetchaction> <identifiers> <identifier> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== </identifier> </identifiers> <token>mtaumi4xmduumzq6mtizndpgrvrdsdotmtc4ntq1mtywoq==</token> 96 Objective WebTalk Connector Administration Guide

135 Insert Fetch Action <status>finished</status> <queued_time>2009-oct-15 16:36:32</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 16:36:32</process_start_time> <time_processing>0</time_processing> <process_end_time>2009-oct-15 16:36:32</process_end_time> </action> Related Topics Synchronous Versus Asynchronous Actions Insert Fetch Action This action is used to insert a document or documents into a repository. [&Config=Base64_Config] &ConfigSection=Section_Name &InsertXML=Insert_XML Objective WebTalk Connector Administration Guide 97

136 Chapter 9 CFS Connector Actions Asynchronous Parameter Name Config ConfigSection InsertXML Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file. The name of the configuration file section containing the task settings. XML containing all the properties to determine how and where to add each document, all the metadata, and optionally, a file to insert for each document. Some connectors expect a file to be provided. The data should be provided in XML format as below: <insertxml> <insert> <reference>reference</reference> <property name="propname" value="propvalue"/> <! > <metadata name="fieldname" value="fieldvalue"/> <! > <file> <isfilename>true/false</isfilename> <ownfile>true/false</ownfile> <content>filename/base64file</content> </file> </insert> <! > </insertxml> Most of the tags are optional. ownfile. If ownfile is true, this file is deleted after it has been inserted. By default, this is false. isfilename. If isfilename is true, the content tag contains the full path to the file. If isfilename is false, the content tag contains the entire file base64 encoded. The ownfile tag is ignored in this case. insert. The insert tag can be omitted if a single document is being inserted. reference, property, metadata. The usage of these tags depends on the connector used. 98 Objective WebTalk Connector Administration Guide

137 Insert Fetch Action Example In this example, the object is to insert a file with the reference C:\Autonomy\ FileSystemConnectorCFS\dir1\newfile.txt with the content This is my file. First, construct the InsertXML: <insertxml> <insert> <reference>c:\autonomy\filesystemconnectorcfs\dir1\newfile.txt</ reference> <file> <isfilename>false</isfilename> <content>vghpcybpcybtesbmawxl</content> </file> </insert> </insertxml> Note that the content This is my file is base64 encoded. The XML is then escaped and used in the Insert action. action=fetch&fetchaction=insert&configsection=dir1&insertxml=%3cin sertxml%3e%3cinsert%3e%3creference%3ec%3a%5cautonomy%5cfilesystemc onnectorcfs%5cdir1%5cnewfile.txt%3c%2freference%3e%3cfile%3e%3cisf ilename%3efalse%3c%2fisfilename%3e%3ccontent%3evghpcybpcybtesbmawx l%3c%2fcontent%3e%3c%2ffile%3e%3c%2finsert%3e%3c%2finsertxml%3e Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the queueinfo action) appears below. This action shows that the action has completed and that one document has been inserted, and gives the identifier of the new document. <action> <documentcounts> <documentcount added="0" collected="0" deleted="0" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="1" releasedholds="0" seen="0" task="dir1" unchanged="0" updated="0"/> </documentcounts> <fetchaction>insert</fetchaction> <identifiers> <identifier> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== </identifier> Objective WebTalk Connector Administration Guide 99

138 Chapter 9 CFS Connector Actions </identifiers> <token>mtaumi4xmduumzq6mtizndpgrvrdsdotmtc4ntq1mtywoq==</token> <status>finished</status> <queued_time>2009-oct-15 16:36:32</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 16:36:32</process_start_time> <time_processing>0</time_processing> <process_end_time>2009-oct-15 16:36:32</process_end_time> </action> Related Topics Synchronous Versus Asynchronous Actions Delete/Remove Fetch Action This action is used to delete documents from a repository by their identifiers. Remove and delete are different names for the same action. [&Config=Base64_Config] &Identifiers=Identifier_CSV [&Config=Base64_Config] &Identifiers=Identifier_CSV Asynchronous Parameter Name Config Identifiers Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file. A CSV of document Identifiers. The documents with these identifiers are removed from the repository. Example action=fetch&fetchaction=delete&identifiers=pglkihm9ikrjujeiihi9ik M6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4 dcivpg%3d%3d 100 Objective WebTalk Connector Administration Guide

139 Hold and ReleaseHold Fetch Actions Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the QueueInfo action) appears below. This response shows that one document was deleted successfully. <action> <documentcounts> <documentcount added="0" collected="0" deleted="1" errors="0" holds="0" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="0" releasedholds="0" seen="0" task="dir1" unchanged="0" updated="0"/> </documentcounts> <fetchaction>delete</fetchaction> <tasks> <success> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== </success> </tasks> <token>mtaumi4xmduumzq6mtizndpgrvrdsdotmtgwndu4nzixmq==</token> <status>finished</status> <queued_time>2009-oct-15 16:43:17</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 16:43:17</process_start_time> <time_processing>0</time_processing> <process_end_time>2009-oct-15 16:43:17</process_end_time> </action> Related Topics Synchronous Versus Asynchronous Actions Hold and ReleaseHold Fetch Actions The Hold action places a hold on a document or documents in the repository by their identifier. When a document has been placed on hold, it cannot be deleted by a regular user. The ReleaseHold action releases a document that has been placed on hold. [&Config=Base64_Config] &Identifiers=Identifier_CSV Objective WebTalk Connector Administration Guide 101

140 Chapter 9 CFS Connector Actions [&Config=Base64_Config] &Identifiers=Identifier_CSV Asynchronous Parameter Name Config Identifiers Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file. A CSV of document Identifiers. The documents with these identifiers is placed on hold or released from hold depending on whether you used the Hold or Release Hold action. Example action=fetch&fetchaction=hold&identifiers=pglkihm9ikrjujeiihi9ikm6 XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxuZXdmaWxlLnR4dC IvPg%3D%3D Response As this is an asynchronous action, you receive a token in response to the request. A sample response to the action (as retrieved using the queueinfo action) appears below. This response shows that one document was successfully put on hold. <action> <documentcounts> <documentcount added="0" collected="0" deleted="0" errors="0" holds="1" ingestadded="0" ingestdeleted="0" ingestfailed="0" ingestupdated="0" inserted="0" releasedholds="0" seen="0" task="dir1" unchanged="0" updated="0"/> </documentcounts> <fetchaction>hold</fetchaction> <tasks> <success> PGlkIHM9IkRJUjEiIHI9IkM6XEF1dG9ub215XEZpbGVTeXN0ZW1Db25uZWN0b3J DRlNcZGlyMVxuZXdmaWxlLnR4dCIvPg== </success> </tasks> <token>mtaumi4xmduumzq6mtizndpgrvrdsdotmtgwndu4nzixmq==</token> 102 Objective WebTalk Connector Administration Guide

141 Update Action <status>finished</status> <queued_time>2009-oct-15 16:43:17</queued_time> <time_in_queue>0</time_in_queue> <process_start_time>2009-oct-15 16:43:17</process_start_time> <time_processing>0</time_processing> <process_end_time>2009-oct-15 16:43:17</process_end_time> </action> Related Topics Synchronous Versus Asynchronous Actions Update Action The Update action updates metadata for documents given by their identifier in a repository. Request /action=fetch&fetchaction=update [&parenttoken=<parent_token>] [&config=<base64_config>] [&identifiersxml=<identifiers_xml>] [&<Overriding_Config_Parameters>] IdentifiersXML The IdentifiersXML parameter specifies identifiers that require metadata updates along with a set of the metadata to be updated for each document. The data should be provided in XML format as below: <IdentifiersXML> <identifier value="[autn_identifier1]"> <metadata name="[customfield1]" value="[customfieldvalue1_1]"/> <metadata name="[customfield1]" value="[customfieldvalue1_2]"/> <! > </identifier> <identifier value="[autn_identifier2]"> <metadata name="[customfield1]" value="[customfieldvalue2_1]"/> <! > </identifier> <! > </IdentifiersXML> Objective WebTalk Connector Administration Guide 103

142 Chapter 9 CFS Connector Actions Asynchronous Response <fetchaction>update</fetchaction> <tasks> <success>[identifier1]</success> <success>[identifier2]</success> <failed>[identifier3]</failed> </tasks> Related Topics Synchronous Versus Asynchronous Actions View Action The View action retrieves a single document and returns it. [&Config=<Base64_Config>] [&NoACI=True/False] &Identifier=Identifier Synchronous Parameter Name Config NoACI Identifiers Description Optional Base64 encoded configuration file. If this parameter is specified, then the encoded configuration options is used instead of the options in the connector configuration file. Specify whether to return the document using a normal ACI response with a Base64 encoded file tag (false), or just return binary content (true). This defaults to true. The identifier of the document to be returned. Example action=view&identifier=pglkihm9ikrjujeiihi9ikm6xef1dg9ub215xezpbgv TeXN0ZW1Db25uZWN0b3JDRlNcZGlyMVxmaWxlOC50eHQiLz4%3D Response The response is the binary content of the file, unless you have specified NoACI=false. 104 Objective WebTalk Connector Administration Guide

143 StopFetch Action Related Topics EnableViewServer StopFetch Action This action requests all active asynchronous fetch actions or a particular asynchronous fetch action to stop. [&Token=Fetch_Action_Token] Synchronous Parameter Name Token Description The token of the asynchronous Fetch action to request to stop. If this is not specified, then the connector requests all asynchronous fetch actions to stop. Doing so does not clear the action queue. Example Response <autnresponse> <action>stopfetch</action> <response>success</response> <responsedata> </responsedata> </autnresponse> Objective WebTalk Connector Administration Guide 105

144 Chapter 9 CFS Connector Actions 106 Objective WebTalk Connector Administration Guide

145 CHAPTER 10 Connector Framework Server Parameters This chapter describes the Connector Framework server (CFS) configuration parameters. It contains the following sections: Service Parameters Server Parameters Actions Parameters Import Tasks and their Parameters Import Service Parameters Indexing Parameters Connector Framework server supports standard service parameters, logging parameters and log streams. For more information, see the IDOL Server Administration Guide. This section lists the Connector Framework server configuration parameters. Objective WebTalk Connector Administration Guide 107

146 Chapter 10 Connector Framework Server Parameters Service Parameters The parameters in this section determine which machines are permitted to use and control the Connector Framework service. Related Topics Service Parameters Server Parameters AdminClients The parameters in this section specify details for the Connector Framework server. Specify the IP addresses or names of clients that can issue administrative commands to the ACI Port. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector. String Default: *.*.*.* Required: See Also: No Server AdminClients=localhost, Port on page 109 QueryClients on page Objective WebTalk Connector Administration Guide

147 Server Parameters Port Specify the ACI port by which actions are sent to the Connector Framework server. Long Default: Required: Allowed Range: Recommended Range: Yes Minimum: 0 Maximum: Minimum: 1024 Maximum: Server Port=7008 See Also: QueryClients Specify the IP addresses or names of clients that can query the connector. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector. String Default: *.*.*.* Required: See Also: No Server QueryClients= *, Port on page 109 AdminClients on page 108 Objective WebTalk Connector Administration Guide 109

148 Chapter 10 Connector Framework Server Parameters Actions Parameters MaxQueueSize The parameters in this section control how actions are sent to Connector Framework server. Use this parameter to specify the maximum number of asynchronous ingest action commands that will be queued by the server. No further ingest actions will be accepted once the queue size has been reached (until the queue diminishes). Default: Required: Integer The largest size possible. No Actions MaxQueueSize=4 See Also: MaximumThreads Specify the number of actions that the CFS can process in parallel at any one time. The optimal value for this parameter is dependant on the load of the server. The default is generally sufficient for most loads. Integer Default: 2 Required No Actions MaximumThreads= Objective WebTalk Connector Administration Guide

149 Import Tasks and their Parameters Import Tasks and their Parameters PostN The parameters in this section control the way documents are imported to IDX or XML before they are indexed into IDOL server. These task types are Lua and IDXWriter. These task types are available for PreN, PostN, UpdateN and DeleteN. Identify a task to call after documents are imported but before they are indexed into IDOL server. Tasks must be numbered starting from zero (0). You can specify a Lua script or the IDX Writer. The IDX Writer is included in the Connector Framework server and generates an IDX file. You must specify the task using the following format: PostN=TaskPath_to_Script or MyTaskSection where TaskType could be Lua to specify a Lua script, or IdxWriter to specify the CFS IDX Writer. Parameters that should be passed to the task can be specified in a corresponding configuration section. This is optional. For example: Post0=IdxWriter:IdxWriting [IdxWriting] IdxWriterFilename=Job0.idx IdxWriterMaxSizeKBs=100 IdxWriterArchiveDirectory=./IDXArchive In this example, the Post0 task creates a backup IDX file (Job0.idx) in the IDXArchive directory using the IDX Writer. Default: Required See Also: String None No ImportTasks Post0=Lua:C:\Scripts\posttask1.lua PreN on page 112 HashN on page 113 DeleteN on page 113 UpdateN on page 114 Objective WebTalk Connector Administration Guide 111

150 Chapter 10 Connector Framework Server Parameters PreN Identify a task to call before documents are imported and indexed into IDOL server. Tasks must be numbered starting from zero (0). You can specify a Lua script or the IDX Writer. The IDX Writer is included in the Connector Framework server and generates an IDX file. You must specify the task using the following format: PreN=TaskPath_to_Script or MyTaskSection where TaskType could be Lua to specify a Lua script, or IdxWriter to specify the CFS IDX Writer. Parameters that should be passed to the task can be specified in a corresponding configuration section. This is optional. For example: Post0=IdxWriter:IdxWriting [IdxWriting] IdxWriterFilename=Job0.idx IdxWriterMaxSizeKBs=100 IdxWriterArchiveDirectory=./IDXArchive In this example, the Pre0 task creates a backup IDX file (Job0.idx) in the IDXArchive directory using the IDX Writer. Default: Required: See Also String None No ImportTasks Pre0=C:\Scripts\pretask1.lua PostN on page 111 HashN on page 113 DeleteN on page 113 UpdateN on page Objective WebTalk Connector Administration Guide

151 Import Tasks and their Parameters HashN Specify a file containing a Lua script to use for family hashing. The script inserts an MD5 field into the document, which is a hash of the document s unique fields. Default: Required: See Also String None No ImportTasks Hash0=hash.lua ImportHashFamilies on page 118 ImportFamilyRootExcludeFmtCSV on page 117 DeleteN This index task appears in the [IndexTasks] section. Identify a task to call when CFS is about to delete a document from IDOL server. Tasks must be numbered. In the example below, Delete0 runs a Lua script when a document is about to be deleted. Default: Required: See Also String None No IndexTasks Delete0=Lua:onDelete.lua PostN on page 111 PreN on page 112 HashN on page 113 UpdateN on page 114 Objective WebTalk Connector Administration Guide 113

152 Chapter 10 Connector Framework Server Parameters UpdateN This index task appears in the [IndexTasks] section. Identify a task to call when CFS is about to update fields in a document in IDOL server. This is called when a connector updates the metadata for a document but not the content. Tasks must be numbered. In the example below, Update0 runs a Lua script when a document is about to be updated. Default: Required: See Also String None No IndexTasks Update0=Lua:onUpdate.lua PostN on page 111 PreN on page 112 HashN on page 113 DeleteN on page 113 Additional Task Types The following task types are also available: ImportFile:fieldName Sectioner:sectionName ImportFile:fieldName imports the file specified in the field fieldname and adds its content to the document being processed. Sectioner:sectionName is generally specified as a Post task. You can use it to split a large document into smaller sections. sectionname gives the name of the configuration file section containing the settings for the sectioner. If :sectionname is not specified, the [Sectioning] section is assumed. The following configuration settings control sectioning: 114 Objective WebTalk Connector Administration Guide

153 Additional Task Types SectionerMaxBytes Use this parameter to specify the maximum number of bytes recommended for a section. This is not a hard limit, but the Sectioner will try to keep section sizes below this. Integer Default: 3000 Required No The configured section or Sectioning SectionerMaxBytes=3000 SectionerMinBytes Use this parameter to specify the minimum number of bytes recommended for a section. This is not a hard limit, but the Sectioner will try to keep section sizes above this. Default: Required Integer SectionerMaxBytes/2 No The configured section or Sectioning SectionerMinBytes=1500 SectionerSeparatorsN Use this parameter to specify the fixed strings or regular expressions that can be used by the sectioner to identify a suitable location in the content for inserting a section break. For example, you may prefer content to split on paragraph breaks %0A%0A. If a large bit of content has no paragraph breaks, the Sectioner could then revert to splitting on punctuation. Objective WebTalk Connector Administration Guide 115

154 Chapter 10 Connector Framework Server Parameters A separator string can either be specified as a fixed string or a regular expression. A separator is treated as a regular expression if it begins with an open parenthesis ( and ends with closed parenthesis ). Fixed strings and regular expressions specified in the configuration are URL unescaped before use; this allows you to specify multi-byte and special characters. Each SectionerSeparatorsN is a CSV of possibly URL escaped separators. Separators in an earlier SectionSeparators list have priority over those later. Separators towards the left of a CSV have priority over those toward the right. Backslashes in a regular expression should appear in the configuration as \\. Commas in separators should be URL escaped as %2C or escaped as \,. SectionSeparators 0, 1, and 2 are set by default if none are specified in the configuration. If any SectionerSeparators are specified in the configuration, the defaults no longer apply. Default: Required String SectionerSeparators0=%0A%0A SectionerSeparators1=([!?.]\\s+),([:;]\\ s+),(%ef%bc%81 %EF%BC%9F %E3%80%82 %EF%BC%8E [!?]),(%EF%BC%9A %EF%BC%9B [:;]) SectionerSeparators2=((%2C %E3%80%81 %EF%BC%8C)\\ s*),((%e3%80%80 \\s)+) No The configured section or Sectioning SectionerSeparators0=%0A%0A 116 Objective WebTalk Connector Administration Guide

155 Import Service Parameters Import Service Parameters ExtractDirectory The parameters in this section specify details for KeyView and the service that imports documents into IDX or XML. Specify the directory to which to files are extracted. Use this parameter only when you want to keep copies of all extracted files. Default: Required String Current directory No ImportService ExtractDirectory=C:\temp ImportFamilyRootExcludeFmtCSV Specify which KeyView formats not to designate as family roots if family hashing is enabled. For example, if you exclude the PST format (KeyView value 356), when Import Module Advanced hashes a PST file, it does not consider PST container as the root format. Instead, it searches for a deeper format that is not listed as a CSV: in this case, it would find the MAIL format, which would then be considered the root of the family. For a complete list of KeyView formats, see KeyView Format Codes on page 175. String Default: Required No Objective WebTalk Connector Administration Guide 117

156 Chapter 10 Connector Framework Server Parameters See Also: ImportService ImportFamilyRootExcludeFmtCSV=356,157,233,345 In this example, the numeric values correspond to the following formats: 356=PST 157=ZIP 233=EML 345=MSG HashN on page 113 ImportHashFamilies on page 118 ImportHashFamilies Specify whether to enable family hashing, which is used for de-duplication. Default: Required See Also: Boolean false No ImportService ImportHashFamilies=true HashN on page 113 ImportFamilyRootExcludeFmtCSV on page 117 ImportMerg s on page 119 ImportInheritFieldsCSV Specify a comma-separated list of fields that should be inherited from parent files by their children. For example, if you specify SUBJECT in this parameter, all the child attachments in a parent MSG file will contain a Subject field. Default: Required String None No 118 Objective WebTalk Connector Administration Guide

157 Import Service Parameters ImportService ImportInheritFieldsCSV=AUTN_IDENTIFIER See Also: ImportMerg s Specify whether to merge the two files created by KeyView (the empty MSG or EML container file, and the MAIL file that contains the actual message content) when importing MSG or EML files. Set this to true to merge the two files. Default: Required Boolean false No. Recommended if ImportHashFamilies=true. ImportService ImportMerg s=true See Also: ImportHashFamilies on page 118 KeyviewDirectory Specify the location of the KeyView filters that Connector Framework Server uses to process documents. Enter the full path to the filters directory. Default: Required String None Yes ImportService KeyviewDirectory=C:\Autonomy\ConnectorFramework\ filters\ Objective WebTalk Connector Administration Guide 119

158 Chapter 10 Connector Framework Server Parameters MaxImportQueueSize Specify the size of an internal queue where documents are buffered before they are imported. NOTE It is recommended that this parameter not be changed without consultation with Autonomy support personnel. Default: Required Integer Ten times the size specified by the IndexBatchSize parameter. No ImportService or Server MaxImportQueueSize=1000 RevisionMarks Specify whether revision mark information (such as deleted text) is extracted from Microsoft Word documents. If Microsoft Word s revision tracking feature was enabled when changes were made to a document, the CFS can extract the tracked information and include it in the index. Set to true to extract revision mark information. Default: Required Boolean false No ImportService RevisionMarks=true 120 Objective WebTalk Connector Administration Guide

159 Import Service Parameters ThreadCount Specify the number of threads to run. This parameter is only used for importing. Integer Default: 1 Required No ImportService ThreadCount=3 XsltDLL Use this parameter to specify the location of the autnxslt library. Default: Required: String autnxslt.dll (if present) No Paths or ImportService or Server XsltDLL=autnxslt.dll See Also: Objective WebTalk Connector Administration Guide 121

160 Chapter 10 Connector Framework Server Parameters Indexing Parameters ACIPort The parameters in this section specify the details for the IDOL server(s) to which the Connector Framework server will send documents for indexing. Specify the ACI port of each IDOL server with which Connector Framework server communicates. There should be the same number of values in the ACIPort CSV as in the DREHost CSV. Default: Required CSV (comma-separated values) None At least one entry is required. Indexing ACIPort=9000,9012 See Also: DREHost on page 122 DREHost Specify the IP address or host name of each IDOL server with which Connector Framework server communicates. There should be the same number of values in the DREHost CSV as in the ACIPort CSV. Default: Required CSV (comma-separated values) None At least one entry is required. Indexing DREHost=hostmachine0,hostmachine1 See Also: ACIPort on page Objective WebTalk Connector Administration Guide

161 Indexing Parameters IndexBatchSize Specify the maximum number of files that are included each batch that is indexed into IDOL server. Integer Default: 100 Required No Indexing IndexBatchSize=100 IndexTimeInterval Specify the timeout value in seconds for the index queue. This is the maximum amount of time a document will wait in the index queue before an attempt is made to index it. If no documents were indexed in the specified interval, any documents in the queue (up to the number specified in IndexBatchSize) are indexed. NOTE Communication between CFS and the indexer can be over SSL. Integer Default: 300 Required No Indexing IndexTimeInterval=100 See Also: IndexBatchSize on page 123 Related Topics Secure Socket Layer Parameters on page 147 Objective WebTalk Connector Administration Guide 123

162 Chapter 10 Connector Framework Server Parameters 124 Objective WebTalk Connector Administration Guide

163 CHAPTER 11 License Parameters This chapter describes the license configuration parameters that specify licensing details. Full Holder Key LicenseServerACIPort LicenseServerHost LicenseServerTimeout LicenseServerRetries Operation Full Indicates whether you have a full or an evaluation license. Default: Boolean False Objective WebTalk Connector Administration Guide 125

164 Chapter 11 License Parameters Required: Yes License Full=on In this example, the service is fully licensed. Holder The name of the license holder. Default: Required: String None Yes License Holder=Company Key The license key. Default: Required: String None Yes License Key= Objective WebTalk Connector Administration Guide

165 LicenseServerACIPort LicenseServerACIPort ACI port of DiSH license server. This must be the Port specified in the DiSH configuration file's [Server] section. Documentum uses this port to request licensing from DiSH. This parameter is used in IDOL with Administration. Default: Required: Allowed range: Recommended range: See Also: Long None Yes Minimum: 0 Maximum: Minimum: 1025 Maximum: License LicenseServerACIPort=20000 LicenseServerHost on page 127 LicenseServerTimeout on page 128 LicenseServerRetries on page 128 LicenseServerHost Address of DiSH host. The IP address (or name) of the machine that hosts the DiSH license server. This parameter is used in IDOL with Administration. Default: Required: String None Yes Objective WebTalk Connector Administration Guide 127

166 Chapter 11 License Parameters See Also: License LicenseServerHost= LicenseServerACIPort on page 127 LicenseServerTimeout on page 128 LicenseServerRetries on page 128 LicenseServerTimeout Seconds to timeout when Documentum tries connecting to DiSH. Enter the number of seconds after which requests that have been sent to the DiSH license server time out if it does not respond. This parameter is used in IDOL with Administration. Long Default: Required: See Also: No License LicenseServerTimeout= LicenseServerACIPort on page 127 LicenseServerHost on page 127 LicenseServerRetries on page 128 LicenseServerRetries Number of retries when Documentum connects to DiSH. The number of times Documentum tries to connect to the DiSH license server. This parameter is used in IDOL with Administration. Integer Default: 5 Required: No 128 Objective WebTalk Connector Administration Guide

167 Operation See Also: License LicenseServerRetries=1 LicenseServerACIPort on page 127 LicenseServerHost on page 127 LicenseServerTimeout on page 128 Operation Licensed Operations key to allow additional ACI server operations to be licensed. Default: Required: String None Yes License Operations=803 87sdhsdf9n94nmsf7oasda987w4yriasunfa asd== Objective WebTalk Connector Administration Guide 129

168 Chapter 11 License Parameters 130 Objective WebTalk Connector Administration Guide

169 CHAPTER 12 Logging Parameters This section describes the configuration parameters used to create separate log files for different log message types (such as, query, index, and application) and to determine how each stream is logged. It includes the following topics: LogArchiveDirectory LogCompressionMode LogDirectory LogEcho LogExpireAction LogFile LogHistorySize LogLevel LogLevelMatch LogMaxLineLength LogMaxOldFiles LogMaxSizeKBs LogOldAction LogOutputLogLevel LogSysLog Objective WebTalk Connector Administration Guide 131

170 Chapter 12 Logging Parameters LogTime LogTypeCSVs LogArchiveDirectory Path to log archive directory. Enter the directory in which you want the application to archive old log files when LogOldAction is set to Move. Default: Required: String./archive No Logging and/or LogStream or TaskName If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogArchiveDirectory=./archive See Also: LogOldAction on page 140 LogCompressionMode Specifies how old log files are compressed when the LogExpireAction parameter is set to Compress. This can be set to either zip or gz. Default: Required: String zip No Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogCompressionMode=gz See Also: LogExpireAction on page Objective WebTalk Connector Administration Guide

171 LogDirectory LogDirectory Path to log directory. Enter the directory in which you want the application to store the log files it creates. Default: Required: See Also: String./logs No Logging LogDirectory=./logs LogArchiveDirectory on page 132 LogFile on page 135 LogEcho Display logging messages on the console. Enable this parameter to display logging messages on the console. Note this setting has no effect if you are running the application as a Windows service. Default: Required: Boolean False No Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogEcho=true See Also: LogArchiveDirectory on page 132 Objective WebTalk Connector Administration Guide 133

172 Chapter 12 Logging Parameters LogExpireAction Determines how log files are handled when they exceed the maximum size. Enter one of the following to determine how log files are handled when they exceed the MaxLogSizeKBs size: Option Compress Consecutive Datestamp Previous Day Description The log file's name is appended with a time stamp, compressed and saved in the log directory. By default, this is a Zip file. Use the LogCompressionMode parameter to specify another compression format. The log file's name is appended with a number and saved in the log directory. When the next log file reaches its LogMaxSizeKBs size, it is appended with the next consecutive number. The log file's name is appended with a time stamp and saved in the log directory. The log file's name is appended with.previous and saved in the log directory. Every time a log file reaches its LogMaxSizeKBs size, it is given the same postfix so it overwrites the old log file. Only one log file is created per day and is appended with the current time stamp. Log files are archived once they reach the LogMaxSizeKBs size. Note: The LogMaxSizeKBs parameter takes precedence over the LogExpireAction parameter. Therefore, if you set LogExpireAction to Day, and the value for LogMaxSizeKBs results in more than one log file, multiple log files will be generated per day. Default: Required: String Datestamp No 134 Objective WebTalk Connector Administration Guide

173 LogFile See Also: Logging and/or LogStream or TaskName If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogExpireAction=Compress LogCompressionMode on page 132 LogFile on page 135 LogMaxSizeKBs on page 140 LogFile Name of the log file. The name of the log file the application creates in the specified LogDirectory. Default: Required: String None Yes Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogFile=query.log See Also: LogDirectory on page 133 LogHistorySize The number of log messages to store in memory. String Default: 100 Required: Allowed Range: Yes Minimum: 1 Maximum: 520 Objective WebTalk Connector Administration Guide 135

174 Chapter 12 Logging Parameters LogStream LogHistorySize=50 See Also: LogExpireAction on page 134 LogLevel The type of messages that are logged. Enter one of the following to determine the type of messages that are logged: Option Always Error Warning Normal Full Description Basic processes are logged. Note that this produces only minimal logging and no errors are logged. Errors are logged. Errors and warnings are logged. Errors, warnings and basic processes are logged. Every occurrence is logged. Note that this produces a large log file and may affect performance. The log levels are hierarchical from least logging to most logging. You can use the LogLevelMatch parameter to specify which messages are reported relative to the specified LogLevel. For example, if LogLevelMatch=LessThan and LogLevel=Warning, "Normal" and "Full" message types are reported. Use the LogOutputLogLevel parameter to report the log level in the log. Default: Required: String Normal No 136 Objective WebTalk Connector Administration Guide

175 LogLevelMatch See Also: Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogLevel=Warning LogFile on page 135 LogLevelMatch on page 137 LogLevelMatch The messages reported relative to the specified LogLevel. The LogLevelMatch parameter specifies the messages that are reported relative to the log-level hierarchy: Always Error Warning Normal Full Enter one of the following values for LogLevelMatch: Option Equal LessThan Description Only the message type specified by LogLevel is reported. For example, if LogLevel=warning, only warning messages are reported. The message types below the LogLevel setting are reported. For example, if LogLevel=warning, "Normal" and "Full" message types are reported. Objective WebTalk Connector Administration Guide 137

176 Chapter 12 Logging Parameters Option LessThanOrEqual GreaterThan GreaterThanOrEqual Description The message type specified by LogLevel and any message type below that are reported. For example, if LogLevel=warning, "Normal", "Full", and "Warning" message types are reported. The message types above the LogLevel setting are reported. For example, if LogLevel=warning, "Error" and "Always" message types are reported. The message type specified by LogLevel and any message type above that are reported. For example, if LogLevel=warning, "Error", "Always", and "Warning" message types are reported. Default: Required: See Also: String GreaterThanOrEqual No Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogLevelMatch=GreaterThanOrEqual LogFile on page 135 LogLevel on page 136 LogOutputLogLevel on page 141 LogMaxLineLength Maximum characters in a log entry. The number of characters a log entry can include before it is truncated. Increase this value when you want long action commands to be logged in full. Long Default: Required: No 138 Objective WebTalk Connector Administration Guide

177 LogMaxOldFiles Allowed Range: Recommended Range: Minimum: 0 Maximum: Minimum: 100 Maximum: Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogMaxLineLength=24000 See Also: LogFile on page 135 LogMaxOldFiles Maximum number of log files in the log directory. The maximum number of log files the specified LogDirectory can store before the application executes the specified LogOldAction. If you do not want to restrict how many log files the LogDirectory can store, enter -1. Default: Required: See Also: Long -1 (unlimited) No Logging and/or LogStream or TaskName If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogMaxOldFiles=1000 LogDirectory on page 133 LogOldAction on page 140 Objective WebTalk Connector Administration Guide 139

178 Chapter 12 Logging Parameters LogMaxSizeKBs Maximum log file size (in KB). If you do not want to restrict the log file size, enter -1. The LogExpireAction parameter determines how a log file is handled once it has reached its maximum size. Long Default: 1024 Required: No Logging and/or LogStream or TaskName If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogMaxSizeKBs=1000 See Also: LogExpireAction on page 134 LogOldAction Determines how log files are handled when the maximum number of log files is exceeded. Enter one of the following to determine how log files are handled when the LogDirectory has reached the maximum number of log files, as determined by the LogMaxOldFiles parameter: Option Delete Move Description The log files are deleted. The log files are moved to the specified LogArchiveDirectory. Default: Required: String Delete No 140 Objective WebTalk Connector Administration Guide

179 LogOutputLogLevel See Also: Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogOldAction=Move LogArchiveDirectory on page 132 LogDirectory on page 133 LogMaxOldFiles on page 139 LogOutputLogLevel Determines whether the log level is reported in the log. Enable this parameter to include the log level of a message in the log entry. Default: Required: Boolean False No Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogLevel=Always LogOutputLogLevel=true In this example, Always is added to the log message: 21/12/ :34:56 [10] Always: ACI Server attached to port 1622 See Also: LogLevel on page 136 Objective WebTalk Connector Administration Guide 141

180 Chapter 12 Logging Parameters LogSysLog Write messages to Windows/Linux system log. Enable this parameter to write messages to the Linux Syslog or the Windows Event Log. Default: Required: Boolean False No Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogSysLog=true LogTime Display time with each log entry. Enable this parameter to display the current time next to each log entry in the log file. Default: Required: Boolean True No Logging and/or LogStream If you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream. LogTime=false See Also: LogFile on page Objective WebTalk Connector Administration Guide

181 LogTypeCSVs LogTypeCSVs List of message types to log. Enter one or more of the following message types to specify the type of messages written to the associated log file. If you want to enter multiple message types, separate them with commas (there must be no space before or after a comma): Option Description All Components Action Application Logs actions and related messages. Logs application-related occurrences. IDOL Server Agent Category Cluster Community ExtendedIndex Index Mailer Profile Query QueryTerms Role Schedule Taxonomy User User_Audit UserTerm Logs agent actions and related messages. Logs category actions and related messages. Logs cluster actions and related messages. Logs community actions and related messages. Logs index actions as well as index commands that are issued after IDOL server has routed incoming data through other processes. Logs index actions and related messages. Logs mailer actions and related messages. Logs profile actions and related messages. Logs query actions and related messages. Logs each query term, after stemming, conversion to UTF8, capitalization and punctuation removal. This is mainly used by the Autonomy DiSH server for statistical reports. Logs role actions and related messages. Logs schedule actions and related messages. Logs taxonomy actions and related messages. Logs user actions and related messages. Logs UserAdd and UserDelete actions and related messages. Logs terms that IDOL server uses to form a user's agents and profiles. Objective WebTalk Connector Administration Guide 143

182 Chapter 12 Logging Parameters Option Description DIH Index Query Logs index actions and related messages. Logs query actions and related messages. DAH Security Logs security command results. DiSH Alert AlertResults Audit Schedule ScheduleResults Logs alert actions and related messages. Logs alert action results. Logs audit actions and related messages. Logs schedule actions and related messages. Logs schedule action results. Connectors FailureList Import Index Spider Logs details of files that were not imported successfully. Logs import actions and related messages. Logs index actions and related messages. Logs spider actions and related messages. (HTTP Connector only) CFS Import Indexer Logs import actions and related messages. Logs the status of Indexing into IDOL. CFS Connectors Collect Delete Hold Identifiers Insert Synchronize Logs document collection for use in Legal Hold applications. Logs the deletion of documents from the repository. Logs details of documents that are put on hold in Legal Hold applications. Logs details of requests for document lists from repositories. Logs the insertion of documents into the repository. Logs data synchronization when ingesting into IDOL. 144 Objective WebTalk Connector Administration Guide

183 LogTypeCSVs Option Update View Description Logs details of documents whose metadata is updated in the repository. Logs details of documents that are viewed from the repository. Transcode Default: Required: String None Yes LogStream LogTypeCSVs=Application,Index See Also: LogFile on page 135 Objective WebTalk Connector Administration Guide 145

184 Chapter 12 Logging Parameters 146 Objective WebTalk Connector Administration Guide

185 CHAPTER 13 Secure Socket Layer Parameters This section describes the configuration parameters used to configure Secure Socket Layer (SSL) connections between components. It includes the following topics: SSLConfig SSLCACertificate SSLCertificate SSLCheckCertificate SSLCheckCommonName SSLMethod SSLPrivateKey SSLPrivateKeyPassword Objective WebTalk Connector Administration Guide 147

186 Chapter 13 Secure Socket Layer Parameters SSLConfig Identifies the configuration section in which the SSL configuration details are specified, usually SSLOptionN. You must set this parameter if you are using SSL connections between components. To control outgoing ACI calls, set this parameter in another component section, such as [DataDRE], [CatDRE], or a connector Job section. The section in which you set SSLConfig depends on whether you are using a distributed architecture and on which component you are configuring. For example, in a standalone Category configuration, you can set SSLConfig in the [Server], [DataDRE], [CatDRE], and [CommunityServer] sections. See each component s documentation for more information. Default: Required: String None No 148 Objective WebTalk Connector Administration Guide

187 SSLConfig Server or Default, or other section for outgoing communications [Server] SSLConfig=SSLOptions1... [AgentDRE] SSLConfig=SSLOptions2... [DataDRE] SSLConfig=SSLOptions2... // For Omni Group Servers: [Note] GroupServerHost=... GroupServerPort=... SSLConfig=SSLOptions2 [SSLOptions1] //SSL options for incoming connections SSLMethod=SSLV23 SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLCACertificate=trusted.crt [SSLOptions2] //SSL options for outgoing connections SSLMethod= SSLV23 SSLCertificate=host2.crt SSLPrivateKey=9s7BxMjD2d3M3t7awt/J8A SSLCACertificate=trusted.crt See Also: SSLCACertificate on page 150 SSLCertificate on page 150 SSLCheckCertificate on page 151 SSLCheckCommonName on page 151 SSLMethod on page 152 SSLPrivateKey on page 152 SSLPrivateKeyPassword on page 153 Objective WebTalk Connector Administration Guide 149

188 Chapter 13 Secure Socket Layer Parameters SSLCACertificate Certificate Authority (CA) certificate file of a trusted authority. The component will only trust communication with a peer that provides a certificate signed by the specified CAs. Default: Required: String None No SSLOptionN SSLCACertificate=trusted.crt See Also: SSLConfig on page 148 SSLCertificate SSL Certificate file to use to identify this component to a peer. It can be either ASN1 or PEM format. This parameter requires a matching SSLPrivateKey value. Default: Required: See Also: String None Yes SSLOptionN SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLConfig on page 148 SSLPrivateKey on page Objective WebTalk Connector Administration Guide

189 SSLCheckCertificate SSLCheckCertificate Specifies whether a certificate signed by a trusted authority is requested from peers. Setting SSLCACertificate implicitly sets SSLCheckCertificate to true. If SSLCACertificate is set to false, communications are encrypted, but certificates are not requested from peers. Default: Required: Boolean True if SSLCACertificate is set. False if SSLCACertificate is not set. No SSLOptionN SSLCheckCertificate=true See Also: SSLConfig on page 148 SSLCheckCommonName Verifies the identity of the peer. Specifies whether the host name listed in the peer's certificate (that is, the CommonName or "CN" attribute) resolves to the same IP address as the peer itself, as determined by the network connection. For example, if the host name in a certificate is eip.autonomy.com and resolves to an IP address of , then the peer should share the same IP address. Default: Required: Boolean False No SSLOptionN SSLCheckCommonName=true See Also: SSLConfig on page 148 Objective WebTalk Connector Administration Guide 151

190 Chapter 13 Secure Socket Layer Parameters SSLMethod Specifies which SSL protocol is used. The options are: SSLV2 SSLV3 SSLV23 TLSV1 SSLV23 should be used in most cases. Default: Required: String None Yes SSLOptionN SSLMethod=SSLV23 See Also: SSLConfig on page 148 SSLPrivateKey The private security key for the SSL certificate. It can be either ASN1 or PEM format. This parameter requires a matching SSLCertificate value. Default: Required: See Also: String None Yes SSLOptionN SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLConfig on page 148 SSLCertificate on page 150 SSLPrivateKeyPassword on page Objective WebTalk Connector Administration Guide

191 SSLPrivateKeyPassword SSLPrivateKeyPassword The password for the file defined in SSLPrivateKey. The password may be in plain text, or basic or AES encryption format. Default: Required: String None No SSLOptionN [SSLOption0] SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLPrivateKeyPassword=PvKey1559 In this example, the private key password to the file host1.key is written in plain text.... [SSLOption0] SSLCertificate=host1.crt SSLPrivateKey=host1.key SSLPrivateKeyPassword=9s7BxMjD2d3M3t7awt/J8A In this example, the private key password to the file host1.key has basic encryption. See Also: SSLConfig on page 148 SSLPrivateKey on page 152 Objective WebTalk Connector Administration Guide 153

192 Chapter 13 Secure Socket Layer Parameters 154 Objective WebTalk Connector Administration Guide

193 CHAPTER 14 Service Parameters This section describes the Service configuration parameters that determine which machines are permitted to use and control a service. It includes the following topics: ServiceACIMode ServiceControlClients ServiceHost ServicePort ServiceStatusClients If the ServicePort, ServiceStatusClients and ServiceControlClients configuration parameters are specified, the service port is enabled and will accept the standard status and control commands described in Service Actions on page 159. Objective WebTalk Connector Administration Guide 155

194 Chapter 14 Service Parameters ServiceACIMode Generate ACI-compatible XML. Default: Required: See Also: Boolean False No Service ServiceACIMode=false ServiceControlClients on page 156 ServiceHost on page 157 ServicePort on page 157 ServiceStatusClients on page 158 ServiceControlClients IP addresses or names of clients that can issue service control commands to the service. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to control the connector. Default: Required: See Also: String None Yes Service ServiceControlClients=localhost, ServiceACIMode on page 156 ServiceHost on page 157 ServicePort on page 157 ServiceStatusClients on page Objective WebTalk Connector Administration Guide

195 ServiceHost ServiceHost The host server on which the service is running. String Default: *.*.*.* Required: See Also: Yes Service ServiceHost= ServiceACIMode on page 156 ServiceControlClients on page 156 ServicePort on page 157 ServiceStatusClients on page 158 ServicePort The port on the host server on which the service listens for service status and control requests. Long Default: Required: Allowed Range: Recommended Range: See Also: Yes Minimum: 1 Maximum: Minimum: 1024 Maximum: Service ServicePort=40010 ServiceACIMode on page 156 ServiceControlClients on page 156 ServiceHost on page 157 ServiceStatusClients on page 158 Objective WebTalk Connector Administration Guide 157

196 Chapter 14 Service Parameters ServiceStatusClients Addresses of clients that can query a service s status. The IP addresses or names of clients that can request status information from a service. These clients cannot control the service. To enter multiple addresses, separate the individual addresses with commas (there must be no space before or after the comma). Alternatively, you can use wildcards in the IP address. Enter for example 187.*.*.* to permit any machine whose IP address begins with 187 to access the service's status. Default: Required: See Also: String None Yes Service ServiceStatusClients=localhost, ServiceACIMode on page 156 ServiceControlClients on page 156 ServiceHost on page 157 ServicePort on page Objective WebTalk Connector Administration Guide

197 CHAPTER 15 Service Actions This section describes the Service actions. It includes the following topics: Action Syntax GetConfig GetLogStream GetLogStreamNames GetStatistics GetStatus GetStatusInfo SetConfig Stop If the ServicePort, ServiceStatusClients and ServiceControlClients configuration parameters are specified, the service port is enabled and accepts the status and control actions described in this section. Action Syntax The actions use the following format: Objective WebTalk Connector Administration Guide 159

198 Chapter 15 Service Actions where, Host Port ActionName Parameters The IP address (or name) of the machine hosting the service. The ServicePort specified in the Service section of the service s configuration. One of the actions described in this section. One or more parameters that may be required by an action. For example: This command uses port to request the service s configuration file settings. Related Topics Service Action Parameters on page 169 GetConfig Action Parameters Example The GetConfig action returns the service s configuration file settings. None. action=getconfig 160 Objective WebTalk Connector Administration Guide

199 GetLogStream GetLogStream Action Parameters The GetLogStream action returns a specific log stream for the service. The action has the following optional parameters: Parameter FromDisk Name Tail Description Specifies whether the log stream is read from disk or memory. The name of the log stream you want to return. The number of lines from the log stream to return. Example action=getlogstream&name=applicationlogstream&fromdisk=true&tail=1 0 This action displays the first ten entries of the ApplicationLogStream log. GetLogStreamNames Action Parameters Example The GetLogStreamNames action returns the names of the log streams defined for the service. None. action=getlogstreamnames GetStatistics The GetStatistics action returns statistics for the service. Objective WebTalk Connector Administration Guide 161

200 Chapter 15 Service Actions The following statistics for the service are returned: Statistic Description [Statistics] ServiceDuration 10SecondResponseAverage The number of seconds the service has been running. The average service response time (in milliseconds) measured over the last 10 seconds. 10SecondRequestsPerSecond The number of requests to the service per second within the last 10 seconds. 10SecondRequests 60SecondResponseAverage The number of requests to the service in the last 60 seconds. The average service response time (in milliseconds) measured over the last 60 seconds. 60SecondRequestsPerSecond The number of requests to the service per second within the last 60 seconds. 60SecondPeakRequestsPerSecond 60SecondRequests 1HourResponseAverage 1HourRequestsPerSecond 1HourPeakRequestsPerSecond 1HourRequests 24HourResponseAverage The highest number of requests to the service over any 60 second period. The number of requests to the service in the last 60 seconds. The average service response time (in milliseconds) measured over the last hour. The number of requests to the service per second within the last hour. The highest number of requests to the service over any 1 hour period. The number of requests to the service in the last hour. The average service response time (in milliseconds) measured over the last 24 hours. 24HourRequestsPerSecond The number of requests to the service per second within the last 24 hours. 24HourPeakRequestsPerSecond 24HourRequests RecentResponseAverage RecentRequestsPerSecond The highest number of requests to the service over any 24 hour period. The number of requests to the service in the last 24 hours. The average service response time (in milliseconds) from the time the last 10 second period finished to the current time. The number of requests to the service per second from the time the last 10 second period finished to the current time. 162 Objective WebTalk Connector Administration Guide

201 GetStatistics Statistic RecentPeakRequestsPerSecond Description The highest number of requests to the service from the time the last 10 second period finished to the current time. RecentRequests The number of requests to the service from the time the last 10 second period finished to the current time. TotalRequests The total number of requests that were made to the service. [Index] ConnectionsTotal ConnectionsUnauthorized CommandsRejectedPaused CommandsRejectedDiskFull CommandsRejectedInvalidIndexCode CommandsDREADD CommandsDREADDDATA CommandsDREREPLACE CommandsDREDELETEREF CommandsDREDELETEDOC CommandsDRECOMPACT CommandsDREEXPIRE CommandsDREBACKUP CommandsDRESYNC ReplacedReindex ReplacedDocsTotal InvalidDatabaseDocs CommandsRejectedInvalidCommand The number of socket connections to the index port. The number of index commands that IDOL server received from unauthorized clients. The number of commands that were rejected because the service was paused. The number of commands that were rejected because the disk was full. The number of commands that were rejected because their index code was invalid. The number of DREADD commands that were executed. The number of DREADDDATA commands that were executed. The number of DREREPLACE commands that were executed. The number of DREDELETEREF commands that were executed. The number of DREDELETEDOC commands that were executed. The number of DRECOMPACT commands that were executed. The number of DREEXPIRE commands that were executed. The number of DREBACKUP commands that were executed. The number of DRESYNC commands that were executed. The number of documents that were re-indexed because an ACLType or Index field had changed. The number of documents that have been replaced. The number of documents that could not be indexed because their database was invalid. The number of commands that were rejected because they were invalid. Objective WebTalk Connector Administration Guide 163

202 Chapter 15 Service Actions Statistic CommandsRejectedTruncatedData CommandsSuccessfullyProcessed CommandsWithANondiskComponent Description The number of DREADDDATA commands that were rejected because their data termination was incorrect. The number of successfully executed index commands. The number of commands that don't have data stored on disk. [QUERIES] TruncatedQueries The number of queries that timed out. [GLOBAL] DOCUMENTS SECTIONS DOCUMENTSLOTS The total number of documents that this IDOL server contains. The number of document sections that this IDOL server contains. The total number of document sections that the IDOL server contains including document sections that have been deleted. [DATABASES] NUMDBS N ACTIVEDATABASES The total number of databases including empty databases and databases that have been deleted. The number of the corresponding database. The number of active databases (databases that are empty or contain data). [DatabaseName] DOCUMENTS SECTIONS The number of documents that this database contains. The number of document sections that this database contains. [Tasks] Number StartTask IndexCommands Documents DocumentSuccesses DocumentFailures Sections The number of tasks set up in the configuration file. The first task that is performed. The number of index commands that have been processed (the number displayed includes any index command that is currently being processed). The number of documents that have been processed (the number displayed includes any document that is currently being processed). The number of documents that have been processed successfully. The number of times that document processing has failed. The number of document sections processed. 164 Objective WebTalk Connector Administration Guide

203 GetStatus Statistic Description [TaskName] Requests Successes Failures The number of requests sent to a specific task. The number of requests processed successfully by a specific task. The number of request-processing failures for a specific task. [Users] MaxUsers Users Roles The maximum number of users that can be set up for this service. The number of users that has been set up for this service. The user roles that the service comprises. Action Parameters Example None. action=getstatistics GetStatus Action Parameters Example The GetStatus action returns the service s status (running or stopped) and some current configuration settings. None. action=getstatus Objective WebTalk Connector Administration Guide 165

204 Chapter 15 Service Actions GetStatusInfo The GetStatusInfo action returns status information for the service (for example, the service s product name, version number and so on). The following status information for the service are returned: Statistics Description [StatusInfo] ServiceStartTime ServiceUtilsVersion ServiceName ProductName ProductVersion ProductBuild ServicePID ProductUID ServiceStatus The time the service started running (epochseconds). The version of the service utilities. The name of the service. The product name of the service. The version of the product. The build of the product. The process ID of the service. The user identifier of the service. The status of the service (running or stopped). [Job] FlowRate Status The amount of data (in kilobytes) being aggregated per second. The status of the connector job (running or stopped). Action Parameters Example None. action=getstatusinfo SetConfig The SetConfig command allows you to set the service s configuration file. 166 Objective WebTalk Connector Administration Guide

205 Stop NOTE This command requires a POST request method. See the IDOL Server Administration Guide for more information on using a POST request method. Action Parameters The action has the following parameters: Parameter Config Description The configuration file content with which you want to overwrite the current content of the service's configuration file. Example action=setconfig&config=configfilecontent where, ConfigFileContent is the complete configuration content to replace the service s current configuration file. Stop Action Parameters Example The Stop command stops the service. None. action=stop Objective WebTalk Connector Administration Guide 167

206 Chapter 15 Service Actions 168 Objective WebTalk Connector Administration Guide

207 CHAPTER 16 Service Action Parameters This section describes the parameters that can be used with Service action. It includes the following topics: Config FromDisk Name Tail Config Enter the configuration file content with which you want to merge or overwrite the current content of the service's configuration file. If the service's configuration file contains a section with the same name as the section with which it is going to be merged, any parameters unique to the new section are added to the existing section. If the new section contains parameters already present in the existing section, the new section's parameters overwrite the parameters of the old section. NOTE This requires a POST request method. See the IDOL Server Administration Guide for information on using a POST request method. Objective WebTalk Connector Administration Guide 169

208 Chapter 16 Service Action Parameters Action Default: Required: SetConfig String None Yes action=setconfig&config=configfilecontent where, ConfigFileContent is the complete configuration content to replace the service s current configuration file. FromDisk Specifies whether the log stream is read from disk or memory. Enter true if you want the log stream to be read from disk rather than from memory. Action Default: Required: GetLogStream Boolean false No action=getlogstream&name=applicationlogstream&fro mdisk=true&tail=10 Name Enter the name of the log stream you want to return. Action Default: Required: GetLogStream String false Yes action=getlogstream&name=applicationlogstream&fro mdisk=true&tail= Objective WebTalk Connector Administration Guide

209 Tail Tail Enter the number of lines from the log stream to return. The lines are read from the top (that is the most recent lines are retuned). Enter -1 to return all entries. Action GetLogStream Long Default: -1 Required: No action=getlogstream&name=applicationlogstream&tai l=10 Objective WebTalk Connector Administration Guide 171

210 Chapter 16 Service Action Parameters 172 Objective WebTalk Connector Administration Guide

211 Appendixes This section includes the following appendixes: KeyView Format Codes

212 Appendixes 214 Objective WebTalk Connector Administration Guide

213 APPENDIX A KeyView Format Codes This chapter lists the KeyView format classes and codes used with Connector Framework server. It includes the following section: KeyView Classes KeyView Formats Table 1 lists KeyView file classes. The numbers are reported in the DocumentClass field in IDX files generated by Import Module. Consult the table to determine the file class that was imported. Table 2 lists all KeyView formats. The numbers are reported in the DocumentType field in IDX files generated by Import Module. Consult the table to determine the file type that was imported. You can use any of the format numbers from Table 2 in conjunction with the ImportFamilyRootExcludeFmtCSV parameter. For more information, see ImportFamilyRootExcludeFmtCSV on page 117. Objective WebTalk Connector Administration Guide 175

214 Appendix A KeyView Format Codes KeyView Classes Table 1 KeyView Classes Attribute Number File Class 0 No file class 01 Word processor 02 Spreadsheet 03 Database 04 Raster image 05 Vector graphic 06 Presentation 07 Executable 08 Encapsulation 09 Sound 10 Desktop publishing 11 Outline/planning 12 Miscellaneous 13 Mixed format 14 Font 15 Time scheduling 16 Communications 17 Object module 18 Library module 19 Fax 20 Movie 21 Animation 176 Objective WebTalk Connector Administration Guide

215 KeyView Formats KeyView Formats Table 2 KeyView Formats Format Name Format Number Format Description AES_Multiplus_Comm_Fmt 1 Multiplus (AES) ASCII_Text_Fmt 2 Text MSDOS_Batch_File_Fmt 3 MS-DOS Batch File Applix_Alis_Fmt 4 APPLIX ASTERIX BMP_Fmt 5 Windows Bitmap CT_DEF_Fmt 6 Convergent Technologies DEF Comm. Format Corel_Draw_Fmt 7 Corel Draw CGM_ClearText_Fmt 8 Computer Graphics Metafile (CGM) CGM_Binary_Fmt 9 Computer Graphics Metafile (CGM) CGM_Character_Fmt 10 Computer Graphics Metafile (CGM) Word_Connection_Fmt 11 Word Connection COMET_TOP_Word_Fmt 12 COMET TOP CEOwrite_Fmt 13 CEOwrite DSA101_Fmt 14 DSA101 (Honeywell Bull) DCA_RFT_Fmt 15 DCA-RFT (IBM Revisable Form) CDA_DDIF_Fmt 16 CDA / DDIF DG_CDS_Fmt 17 DG Common Data Stream (CDS) Micrografx_Draw_Fmt 18 Windows Draw (Micrografx) Data_Point_VistaWord_Fmt 19 Vistaword DECdx_Fmt 20 DECdx Enable_WP_Fmt 21 Enable Word Processing EPSF_Fmt 22 Encapsulated PostScript Preview_EPSF_Fmt 23 Encapsulated PostScript MS_Executable_Fmt 24 MSDOS/Windows Program G31D_Fmt 25 CCITT G3 1D Objective WebTalk Connector Administration Guide 177

216 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description GIF_87a_Fmt 26 Graphics Interchange Format (GIF87a) GIF_89a_Fmt 27 Graphics Interchange Format (GIF89a) HP_Word_PC_Fmt 28 HP Word PC IBM_1403_LinePrinter_Fmt 29 IBM 1403 Line Printer IBM_DCF_Script_Fmt 30 DCF Script IBM_DCA_FFT_Fmt 31 DCA-FFT (IBM Final Form) Interleaf_Fmt 32 Interleaf GEM_Image_Fmt 33 GEM Bit Image IBM_Display_Write_Fmt 34 Display Write Sun_Raster_Fmt 35 Sun Raster Ami_Pro_Fmt 36 Lotus Ami Pro Ami_Pro_StyleSheet_Fmt 37 Lotus Ami Pro Style Sheet MORE_Fmt 38 MORE Database MAC Lyrix_Fmt 39 Lyrix Word Processing MASS_11_Fmt 40 MASS-11 MacPaint_Fmt 41 MacPaint MS_Word_Mac_Fmt 42 Microsoft Word for Macintosh SmartWare_II_Comm_Fmt 43 SmartWare II MS_Word_Win_Fmt 44 Microsoft Word for Windows Multimate_Fmt 45 MultiMate Multimate_Fnote_Fmt 46 MultiMate Footnote File Multimate_Adv_Fmt 47 MultiMate Advantage Multimate_Adv_Fnote_Fmt 48 MultiMate Advantage Footnote File Multimate_Adv_II_Fmt 49 MultiMate Advantage II Multimate_Adv_II_Fnote_Fmt 50 MultiMate Advantage II Footnote File Multiplan_PC_Fmt 51 Multiplan (PC) Multiplan_Mac_Fmt 52 Multiplan (Mac) MS_RTF_Fmt 53 Rich Text Format (RTF) 178 Objective WebTalk Connector Administration Guide

217 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description MS_Word_PC_Fmt 54 Microsoft Word for PC MS_Word_PC_StyleSheet_Fmt 55 Microsoft Word for PC Style Sheet MS_Word_PC_Glossary_Fmt 56 Microsoft Word for PC Glossary MS_Word_PC_Driver_Fmt 57 Microsoft Word for PC Driver MS_Word_PC_Misc_Fmt 58 Microsoft Word for PC Miscellaneous File NBI_Async_Archive_Fmt 59 NBI Async Archive Format Navy_DIF_Fmt 60 Navy DIF NBI_Net_Archive_Fmt 61 NBI Net Archive Format NIOS_TOP_Fmt 62 NIOS TOP FileMaker_Mac_Fmt 63 Filemaker MAC ODA_Q1_11_Fmt 64 ODA / ODIF ODA_Q1_12_Fmt 65 ODA / ODIF OLIDIF_Fmt 66 OLIDIF (Olivetti) Office_Writer_Fmt 67 Office Writer PC_Paintbrush_Fmt 68 PC Paintbrush Graphics (PCX) CPT_Comm_Fmt 69 CPT Lotus_PIC_Fmt 70 Lotus PIC Mac_PICT_Fmt 71 QuickDraw Picture Philips_Script_Word_Fmt 72 Philips Script PostScript_Fmt 73 PostScript PRIMEWORD_Fmt 74 PRIMEWORD Quadratron_Q_One_v1_Fmt 75 Q-One V1.93J Quadratron_Q_One_v2_Fmt 76 Q-One V2.0 SAMNA_Word_IV_Fmt 77 SAMNA Word Ami_Pro_Draw_Fmt 78 Lotus Ami Pro Draw SYLK_Spreadsheet_Fmt 79 SYLK SmartWare_II_WP_Fmt 80 SmartWare II Symphony_Fmt 81 Symphony Objective WebTalk Connector Administration Guide 179

218 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description Targa_Fmt 82 Targa TIFF_Fmt 83 TIFF Targon_Word_Fmt 84 Targon Word Uniplex_Ucalc_Fmt 85 Uniplex Ucalc Uniplex_WP_Fmt 86 Uniplex MS_Word_UNIX_Fmt 87 Microsoft Word UNIX WANG_PC_Fmt 88 WANG PC WordERA_Fmt 89 WordERA WANG_WPS_Comm_Fmt 90 WANG WPS WordPerfect_Mac_Fmt 91 WordPerfect MAC WordPerfect_Fmt 92 WordPerfect WordPerfect_VAX_Fmt 93 WordPerfect VAX WordPerfect_Macro_Fmt 94 WordPerfect Macro WordPerfect_Dictionary_Fmt 95 WordPerfect Spelling Dictionary WordPerfect_Thesaurus_Fmt 96 WordPerfect Thesaurus WordPerfect_Resource_Fmt 97 WordPerfect Resource File WordPerfect_Driver_Fmt 98 WordPerfect Driver WordPerfect_Cfg_Fmt 99 WordPerfect File WordPerfect_Hyphenation_Fmt 100 WordPerfect Hyphenation Dictionary WordPerfect_Misc_Fmt 101 WordPerfect Miscellaneous File WordMARC_Fmt 102 WordMARC Windows_Metafile_Fmt 103 Windows Metafile Windows_Metafile_NoHdr_Fmt 104 Windows Metafile (no header) SmartWare_II_DB_Fmt 105 SmartWare II WordPerfect_Graphics_Fmt 106 WordPerfect Graphics WordStar_Fmt 107 WordStar WANG_WITA_Fmt 108 WANG WITA Xerox_860_Comm_Fmt 109 Xerox Objective WebTalk Connector Administration Guide

219 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description Xerox_Writer_Fmt 110 Xerox Writer DIF_SpreadSheet_Fmt 111 Data Interchange Format (DIF) Enable_Spreadsheet_Fmt 112 Enable Spreadsheet SuperCalc_Fmt 113 Supercalc UltraCalc_Fmt 114 UltraCalc SmartWare_II_SS_Fmt 115 SmartWare II SOF_Encapsulation_Fmt 116 Serialized Object Format (SOF) PowerPoint_Win_Fmt 117 PowerPoint PC PowerPoint_Mac_Fmt 118 PowerPoint MAC PowerPoint_95_Fmt 119 PowerPoint 95 PowerPoint_97_Fmt 120 PowerPoint 97 PageMaker_Mac_Fmt 121 PageMaker for Macintosh PageMaker_Win_Fmt 122 PageMaker for Windows MS_Works_Mac_WP_Fmt 123 Microsoft Works for MAC MS_Works_Mac_DB_Fmt 124 Microsoft Works for MAC MS_Works_Mac_SS_Fmt 125 Microsoft Works for MAC MS_Works_Mac_Comm_Fmt 126 Microsoft Works for MAC MS_Works_DOS_WP_Fmt 127 Microsoft Works for DOS MS_Works_DOS_DB_Fmt 128 Microsoft Works for DOS MS_Works_DOS_SS_Fmt 129 Microsoft Works for DOS MS_Works_Win_WP_Fmt 130 Microsoft Works for Windows MS_Works_Win_DB_Fmt 131 Microsoft Works for Windows MS_Works_Win_SS_Fmt 132 Microsoft Works for Windows PC_Library_Fmt 133 DOS/Windows Object Library MacWrite_Fmt 134 MacWrite MacWrite_II_Fmt 135 MacWrite II Freehand_Fmt 136 Freehand MAC Disk_Doubler_Fmt 137 Disk Doubler Objective WebTalk Connector Administration Guide 181

220 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description HP_GL_Fmt 138 HP Graphics Language FrameMaker_Fmt 139 FrameMaker FrameMaker_Book_Fmt 140 FrameMaker Maker_Markup_Language_Fmt 141 Maker Markup Language Maker_Interchange_Fmt 142 Maker Interchange Format (MIF) JPEG_File_Interchange_Fmt 143 Interchange Format Reflex_Fmt 144 Reflex Framework_Fmt 145 Framework Framework_II_Fmt 146 Framework II Paradox_Fmt 147 Paradox MS_Windows_Write_Fmt 148 Windows Write Quattro_Pro_DOS_Fmt 149 Quattro Pro for DOS Quattro_Pro_Win_Fmt 150 Quattro Pro for Windows Persuasion_Fmt 151 Persuasion Windows_Icon_Fmt 152 Windows Icon Format Windows_Cursor_Fmt 153 Windows Cursor MS_Project_Activity_Fmt 154 Microsoft Project MS_Project_Resource_Fmt 155 Microsoft Project MS_Project_Calc_Fmt 156 Microsoft Project PKZIP_Fmt 157 ZIP Archive Quark_Xpress_Fmt 158 Quark Xpress MAC ARC_PAK_Archive_Fmt 159 PAK/ARC Archive MS_Publisher_Fmt 160 Microsoft Publisher PlanPerfect_Fmt 161 PlanPerfect WordPerfect_Auxiliary_Fmt 162 WordPerfect auxiliary file MS_WAVE_Audio_Fmt 163 Microsoft Wave MIDI_Audio_Fmt 164 MIDI AutoCAD_DXF_Binary_Fmt 165 AutoCAD DXF 182 Objective WebTalk Connector Administration Guide

221 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description AutoCAD_DXF_Text_Fmt 166 AutoCAD DXF dbase_fmt 167 dbase OS_2_PM_Metafile_Fmt 168 OS/2 PM Metafile Lasergraphics_Language_Fmt 169 Lasergraphics Language AutoShade_Rendering_Fmt 170 AutoShade Rendering GEM_VDI_Fmt 171 GEM VDI Windows_Help_Fmt 172 Windows Help File Volkswriter_Fmt 173 Volkswriter Ability_WP_Fmt 174 Ability Ability_DB_Fmt 175 Ability Ability_SS_Fmt 176 Ability Ability_Comm_Fmt 177 Ability Ability_Image_Fmt 178 Ability XyWrite_Fmt 179 XYWrite / Nota Bene CSV_Fmt 180 CSV (Comma Separated Values) IBM_Writing_Assistant_Fmt 181 IBM Writing Assistant WordStar_2000_Fmt 182 WordStar 2000 HP_PCL_Fmt 183 HP Printer Control Language UNIX_Exe_PreSysV_VAX_Fmt 184 Unix Executable (PDP-11/pre-System V VAX) UNIX_Exe_Basic_16_Fmt 185 Unix Executable (Basic-16) UNIX_Exe_x86_Fmt 186 Unix Executable (x86) UNIX_Exe_iAPX_286_Fmt 187 Unix Executable (iapx 286) UNIX_Exe_MC68k_Fmt 188 Unix Executable (MC680x0) UNIX_Exe_3B20_Fmt 189 Unix Executable (3B20) UNIX_Exe_WE32000_Fmt 190 Unix Executable (WE32000) UNIX_Exe_VAX_Fmt 191 Unix Executable (VAX) UNIX_Exe_Bell_5_Fmt 192 Unix Executable (Bell 5.0) UNIX_Obj_VAX_Demand_Fmt 193 Unix Object Module (VAX Demand) Objective WebTalk Connector Administration Guide 183

222 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description UNIX_Obj_MS8086_Fmt 194 Unix Object Module (old MS 8086) UNIX_Obj_Z8000_Fmt 195 Unix Object Module (Z8000) AU_Audio_Fmt 196 NeXT/Sun Audio Data NeWS_Font_Fmt 197 NeWS bitmap font cpio_archive_crchdr_fmt 198 cpio archive (CRC Header) cpio_archive_chrhdr_fmt 199 cpio archive (CHR Header) PEX_Binary_Archive_Fmt 200 SUN PEX Binary Archive Sun_vfont_Fmt 201 SUN vfont Definition Curses_Screen_Fmt 202 Curses Screen Image UUEncoded_Fmt 203 UU encoded WriteNow_Fmt 204 WriteNow MAC PC_Obj_Fmt 205 DOS/Windows Object Module Windows_Group_Fmt 206 Windows Group TrueType_Font_Fmt 207 TrueType Font Windows_PIF_Fmt 208 Program Information File (PIF) MS_COM_Executable_Fmt 209 PC (.COM) StuffIt_Fmt 210 StuffIt (MAC) PeachCalc_Fmt 211 PeachCalc Wang_GDL_Fmt 212 WANG Office GDL Header Q_A_DOS_Fmt 213 Q & A for DOS Q_A_Win_Fmt 214 Q & A for Windows WPS_PLUS_Fmt 215 WPS-PLUS DCX_Fmt 216 DCX FAX Format (PCX images) OLE_Fmt 217 OLE Compound Document EBCDIC_Fmt 218 EBCDIC Text DCS_Fmt 219 DCS UNIX_SHAR_Fmt 220 SHAR Lotus_Notes_BitMap_Fmt 221 Lotus Notes Bitmap 184 Objective WebTalk Connector Administration Guide

223 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description Lotus_Notes_CDF_Fmt 222 Lotus Notes CDF Compress_Fmt 223 Unix Compress GZ_Compress_Fmt 224 GZ Compress TAR_Fmt 225 TAR ODIF_FOD26_Fmt 226 ODA / ODIF ODIF_FOD36_Fmt 227 ODA / ODIF ALIS_Fmt 228 ALIS Envoy_Fmt 229 Envoy PDF_Fmt 230 Portable Document Format BinHex_Fmt 231 BinHex SMTP_Fmt 232 SMTP MIME_Fmt 233 MIME USENET_Fmt 234 USENET SGML_Fmt 235 SGML HTML_Fmt 236 HTML ACT_Fmt 237 ACT PNG_Fmt 238 Portable Network Graphics (PNG) MS_Video_Fmt 239 Video for Windows (AVI) Windows_Animated_Cursor_Fmt 240 Windows Animated Cursor Windows_CPP_Obj_Storage_Fmt 241 Windows C++ Object Storage Windows_Palette_Fmt 242 Windows Palette RIFF_DIB_Fmt 243 RIFF Device Independent Bitmap RIFF_MIDI_Fmt 244 RIFF MIDI RIFF_Multimedia_Movie_Fmt 245 RIFF Multimedia Movie MPEG_Fmt 246 MPEG Movie QuickTime_Fmt 247 QuickTime Movie AIFF_Fmt 248 Audio Interchange File Format (AIFF) Amiga_MOD_Fmt 249 Amiga MOD Objective WebTalk Connector Administration Guide 185

224 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description Amiga_IFF_8SVX_Fmt 250 Amiga IFF (8SVX) Sound Creative_Voice_Audio_Fmt 251 Creative Voice (VOC) AutoDesk_Animator_FLI_Fmt 252 AutoDesk Animator FLIC AutoDesk_AnimatorPro_FLC_Fmt 253 AutoDesk Animator Pro FLIC Compactor_Archive_Fmt 254 Compactor / Compact Pro VRML_Fmt 255 VRML QuickDraw_3D_Metafile_Fmt 256 QuickDraw 3D Metafile PGP_Secret_Keyring_Fmt 257 PGP Secret Keyring PGP_Public_Keyring_Fmt 258 PGP Public Keyring PGP_Encrypted_Data_Fmt 259 PGP Encrypted Data PGP_Signed_Data_Fmt 260 PGP Signed Data PGP_SignedEncrypted_Data_Fmt 261 PGP Signed and Encrypted Data PGP_Sign_Certificate_Fmt 262 PGP Signature Certificate PGP_Compressed_Data_Fmt 263 PGP Compressed Data PGP_ASCII_Public_Keyring_Fmt 264 ASCII-armored PGP Public Keyring PGP_ASCII_Encoded_Fmt 265 ASCII-armored PGP encoded PGP_ASCII_Signed_Fmt 266 ASCII-armored PGP encoded OLE_DIB_Fmt 267 OLE DIB object SGI_Image_Fmt 268 SGI Image Lotus_ScreenCam_Fmt 269 Lotus ScreenCam MPEG_Audio_Fmt 270 MPEG Audio FTP_Software_Session_Fmt 271 FTP Session Data Netscape_Bookmark_File_Fmt 272 Netscape Bookmark File Corel_Draw_CMX_Fmt 273 Corel CMX AutoDesk_DWG_Fmt 274 AutoDesk Drawing (DWG) AutoDesk_WHIP_Fmt 275 AutoDesk WHIP Macromedia_Director_Fmt 276 Macromedia Director Real_Audio_Fmt 277 Real Audio 186 Objective WebTalk Connector Administration Guide

225 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description MSDOS_Device_Driver_Fmt 278 MSDOS Device Driver Micrografx_Designer_Fmt 279 Micrografx Designer SVF_Fmt 280 Simple Vector Format (SVF) Applix_Words_Fmt 281 Applix Words Applix_Graphics_Fmt 282 Applix Graphics MS_Access_Fmt 283 Microsoft Access MS_Access_95_Fmt 284 Microsoft Access 95 MS_Access_97_Fmt 285 Microsoft Access 97 MacBinary_Fmt 286 MacBinary Apple_Single_Fmt 287 Apple Single Apple_Double_Fmt 288 Apple Double Enhanced_Metafile_Fmt 289 Enhanced Metafile MS_Office_Drawing_Fmt 290 Microsoft Office Drawing XML_Fmt 291 XML DeVice_Independent_Fmt 292 DeVice Independent file (DVI) Unicode_Fmt 293 Unicode Lotus_123_Worksheet_Fmt 294 Lotus Lotus_123_Format_Fmt 295 Lotus Formatting Lotus_123_97_Fmt 296 Lotus Lotus_Word_Pro_96_Fmt 297 Lotus Word Pro 96 Lotus_Word_Pro_97_Fmt 298 Lotus Word Pro 97 Freelance_DOS_Fmt 299 Lotus Freelance for DOS Freelance_Win_Fmt 300 Lotus Freelance for Windows Freelance_OS2_Fmt 301 Lotus Freelance for OS/2 Freelance_96_Fmt 302 Lotus Freelance 96 Freelance_97_Fmt 303 Lotus Freelance 97 MS_Word_95_Fmt 304 Microsoft Word 95 MS_Word_97_Fmt 305 Microsoft Word 97 Objective WebTalk Connector Administration Guide 187

226 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description Excel_Fmt 306 Microsoft Excel Excel_Chart_Fmt 307 Microsoft Excel Excel_Macro_Fmt 308 Microsoft Excel Excel_95_Fmt 309 Microsoft Excel 95 Excel_97_Fmt 310 Microsoft Excel 97 Corel_Presentations_Fmt 311 Corel Presentations Harvard_Graphics_Fmt 312 Harvard Graphics Harvard_Graphics_Chart_Fmt 313 Harvard Graphics Chart Harvard_Graphics_Symbol_Fmt 314 Harvard Graphics Symbol File Harvard_Graphics_Cfg_Fmt 315 Harvard Graphics File Harvard_Graphics_Palette_Fmt 316 Harvard Graphics Palette Lotus_123_R9_Fmt 317 Lotus Release 9 Applix_Spreadsheets_Fmt 318 Applix Spreadsheets MS_Pocket_Word_Fmt 319 Microsoft Pocket Word MS_DIB_Fmt 320 MS Windows Device Independent Bitmap MS_Word_2000_Fmt 321 Microsoft Word 2000 Excel_2000_Fmt 322 Microsoft Excel 2000 PowerPoint_2000_Fmt 323 Microsoft PowerPoint 2000 MS_Access_2000_Fmt 324 Microsoft Access 2000 MS_Project_4_Fmt 325 Microsoft Project 4 MS_Project_41_Fmt 326 Microsoft Project 4.1 MS_Project_98_Fmt 327 Microsoft Project 98 Folio_Flat_Fmt 328 Folio Flat File HWP_Fmt 329 HWP(Arae-Ah Hangul) ICHITARO_Fmt 330 ICHITARO V4-10 IS_XML_Fmt 331 Extended or Custom XML Oasys_Fmt 332 Oasys format PBM_ASC_Fmt 333 Portable Bitmap Utilities ASCII Format 188 Objective WebTalk Connector Administration Guide

227 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description PBM_BIN_Fmt 334 Portable Bitmap Utilities Binary Format PGM_ASC_Fmt 335 Portable Greymap Utilities ASCII Format PGM_BIN_Fmt 336 Portable Greymap Utilities Binary Format PPM_ASC_Fmt 337 Portable Pixmap Utilities ASCII Format PPM_BIN_Fmt 338 Portable Pixmap Utilities Binary Format XBM_Fmt 339 X Bitmap Format XPM_Fmt 340 X Pixmap Format FPX_Fmt 341 FPX Format PCD_Fmt 342 PCD Format MS_Visio_Fmt 343 Microsoft Visio MS_Project_2000_Fmt 344 Microsoft Project 2000 MS_Outlook_Fmt 345 Microsoft Outlook ELF_Relocatable_Fmt 346 ELF Relocatable ELF_Executable_Fmt 347 ELF Executable ELF_Dynamic_Lib_Fmt 348 ELF Dynamic Library MS_Word_XML_Fmt 349 Microsoft Word 2003 XML MS_Excel_XML_Fmt 350 Microsoft Excel 2003 XML MS_Visio_XML_Fmt 351 Microsoft Visio 2003 XML SO_Text_XML_Fmt 352 StarOffice Text XML SO_Spreadsheet_XML_Fmt 353 StarOffice Spreadsheet XML SO_Presentation_XML_Fmt 354 StarOffice Presentation XML XHTML_Fmt 355 XHTML MS_OutlookPST_Fmt 356 Microsoft Outlook PST RAR_Fmt 357 RAR Lotus_Notes_NSF_Fmt 358 IBM Lotus Notes Database NSF/NTF Macromedia_Flash_Fmt 359 SWF MS_Word_2007_Fmt 360 Microsoft Word 2007 XML MS_Excel_2007_Fmt 361 Microsoft Excel 2007 XML Objective WebTalk Connector Administration Guide 189

228 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description MS_PPT_2007_Fmt 362 Microsoft PPT 2007 XML OpenPGP_Fmt 363 OpenPGP Message Format (with new packet format) Intergraph_V7_DGN_Fmt 364 Intergraph Standard File Format (ISFF) V7 DGN (non-ole) MicroStation_V8_DGN_Fmt 365 MicroStation V8 DGN (OLE) MS_Word_Macro_2007_Fmt 366 Microsoft Word Macro 2007 XML MS_Excel_Macro_2007_Fmt 367 Microsoft Excel Macro 2007 XML MS_PPT_Macro_2007_Fmt 368 Microsoft PPT Macro 2007 XML LZH_Fmt 369 LHA Archive Office_2007_Fmt 370 Office 2007 document MS_XPS_Fmt 371 Microsoft XML Paper Specification (XPS) Lotus_Domino_DXL_Fmt 372 IBM Lotus representation of Domino design elements in XML format ODF_Text_Fmt 373 ODF Text ODF_Spreadsheet_Fmt 374 ODF Spreadsheet ODF_Presentation_Fmt 375 ODF Presentation Legato_Extender_ONM_Fmt 376 Legato Extender Native Message ONM bin_unknown_fmt 377 n/a TNEF_Fmt 378 Transport Neutral Encapsulation Format (TNEF) CADAM_Drawing_Fmt 379 CADAM Drawing CADAM_Drawing_Overlay_Fmt 380 CADAM Drawing Overlay NURSTOR_Drawing_Fmt 381 NURSTOR Drawing HP_GLP_Fmt 382 HP Graphics Language (Plotter) ASF_Fmt 383 Advanced Systems Format (ASF) WMA_Fmt 384 Window Media Audio Format (WMA) WMV_Fmt 385 Window Media Video Format (WMV) EMX_Fmt 386 Legato Xtender Archives Format (EMX) Z7Z_Fmt Zip Format (7z) 190 Objective WebTalk Connector Administration Guide

229 KeyView Formats Table 2 KeyView Formats (continued) Format Name Format Number Format Description MS_Excel_Binary_2007_Fmt 388 Microsoft Excel Binary 2007 CAB_Fmt 389 Microsoft Cabinet File (CAB) CATIA_Fmt 390 CATIA Formats (CAT*) YIM_Fmt 391 Yahoo Instant Messenger History ODF_Drawing_Fmt 392 ODF Drawing Founder_CEB_Fmt 393 Founder Chinese E-paper Basic (CEB) QPW_Fmt 394 Quattro Pro 9+ for Windows MHT_Fmt 395 MHT format MDI_Fmt 396 Microsoft Document Imaging Format GRV_Fmt 397 Microsoft Office Groove Format IWWP_Fmt 398 Apple iwork Pages format IWSS_Fmt 399 Apple iwork Numbers format IWPG_Fmt 400 Apple iwork Keynote format BKF_Fmt 401 Windows Backup File MS_Access_2007_Fmt 402 Microsoft Access 2007 ENT_Fmt 403 Microsoft Entourage Database Format DMG_Fmt 404 Mac Disk Copy Disk Image File CWK_Fmt 405 AppleWorks File OO3_Fmt 406 Omni Outliner File OPML_Fmt 407 Omni Outliner File Omni_Graffle_XML_File 408 Omni Graffle XML File PSD_Fmt 409 Photoshop Document Apple_Binary_PList_Fmt 410 Apple Binary Property List format Apple_iChat_Fmt 411 Apple ichat format OOUTLINE_Fmt 412 OOutliner File BZIP2_Fmt 413 Bzip 2 Compressed File ISO_Fmt 414 ISO-9660 CD Disc Image Format DocuWorks_Fmt 415 DocuWorks Format Objective WebTalk Connector Administration Guide 191

230 Appendix A KeyView Format Codes Table 2 KeyView Formats (continued) Format Name Format Number Format Description RealMedia_Fmt 416 RealMedia Streaming Media AC3Audio_Fmt 417 AC3 Audio File Format NEF_Fmt 418 Nero Encrypted File SolidWorks_Fmt 419 SolidWorks Format Files XFDL_Fmt 420 Extensible Forms Description Language Apple_XML_PList_Fmt 421 Apple XML Property List format OneNote_Fmt 422 OneNote Note Format Dicom_Fmt 424 Digital Imaging and Communications in Medicine EnCase_Fmt 425 Expert Witness Compression Format (EnCase) Scrap_Fmt 426 Shell Scrap Object File MS_Project_2007_Fmt 427 Microsoft Project 2007 MS_Publisher_98_Fmt 428 Microsoft Publisher 98/2000/2002/2003/2007 Skype_Fmt 429 Skype Log File Hl7_Fmt 430 Health level7 message MS_OutlookOST 431 Microsoft Outlook OST Epub_Fmt 432 Electronic Publication MS_OEDBX_Fmt 433 Microsoft Outlook Express DBX BB_Activ_Fmt 434 BlackBerry Activation File DiskImage_Fmt 435 Disk Image Milestone_Fmt 436 Milestone Document 192 Objective WebTalk Connector Administration Guide

231 Glossary A ACI (Autonomy Content Infrastructure) ACL (access control list) The Autonomy Content Infrastructure is a technology layer that automates operations on unstructured information for cross-enterprise applications, thus enabling an automated and compatible business-to-business, peer-to-peer infrastructure. The ACI allows enterprise applications to understand and process content that exists in unstructured formats, such as , Web pages, office documents, and Lotus Notes. An ACL is a set of data associated with a document that defines which users, groups, and roles are permitted to access a document or data source (for example, an Oracle database or Windows file system). C connector A connector is an Autonomy fetching solution (such as HTTP Connector, Oracle Connector, Exchange Connector, and so on) that allows you to retrieve information from any type of local or remote repository such as a database or Web site. It imports the fetched documents into IDX or XML file format and indexes them into IDOL server, from where you can retrieve them (for example by sending queries to IDOL server). D database DIH (Distributed Action Handler) An Autonomy database is an IDOL server data pool that stores indexed information. The administrator can set up one or more databases and specify how data is fed to the databases. You can retrieve information that is indexed in the IDOL server database by sending a query to the IDOL server. The Distributed Index Handler allows you to efficiently split and index extremely large quantities of data into multiple IDOL servers to create a completely scalable solution that delivers high performance and high availability. It provides a flexible way of transparently batching, routing, and categorizing the indexing of internal and external content into the IDOL server. Objective WebTalk Connector Administration Guide 193

232 Glossary DiSH (Distributed Service Handler) The Distributed Service Handler provides a unified way to communicate with all Autonomy services from a centralized location. It also facilitates the licensing that enables you to run Autonomy solutions. You must have an Autonomy DiSH server running on a machine with a static known IP address. F fetch The process of downloading documents from the repository in which they are stored (such as a local folder, Web site, database, Lotus Domino server, and so on), importing them to IDX format, and indexing them into an IDOL server. I IAS (Intellectual Asset Protection System) IDOL server IDX importing Index fields indexing The Intellectual Asset Protection System provides an integrated security solution to protect your data. At the front end, authentication checks users are allowed to access the system on which result data is displayed. At the back end, entitlement checking and authentication combine to ensure query results only contain documents the user is allowed to see from repositories the user is allowed to access. Using Autonomy connectors, Autonomy's Intelligent Data Operating Layer (IDOL) server integrates unstructured, semi-structured, and structured information from multiple repositories through an understanding of the content, delivering a real-time environment in which operations across applications and content are automated, removing all the manual processes involved in getting the right information to the right people at the right time. Apart from XML files, only files in IDX format can be indexed into IDOL server. You can use a connector to import files into this format or manually create IDX files. After a document has been downloaded from the repository in which it is stored, it is imported to an IDX or XML file format. This process is called importing. Store fields containing text which you want to query frequently as index fields. Index fields are processed linguistically when they are stored in IDOL server. This means stemming and stop lists are applied to text in index fields before they are stored, which allows IDOL server to process queries for these fields more quickly. Typically, the fields DRETITLE and DRECONTENT are set up as index fields. After documents have been imported to IDX file format, their content (or links to the original documents) is stored in an IDOL server. This process is called indexing. 194 Objective WebTalk Connector Administration Guide

233 Q query You can submit a natural language query to IDOL server which analyzes the concept of the query and returns documents that are conceptually similar to the query. You can also submit other query and search types to IDOL server, such as Boolean, bracketed Boolean, and keyword searches. S Search Unlike ordinary searches that look for keywords, the Autonomy Search allows you to enter a natural language query. The concept of the query is analyzed and documents relevant to this concept are returned to you. Objective WebTalk Connector Administration Guide 195

234 Glossary 196 Objective WebTalk Connector Administration Guide

235 Index A access control list (ACL) 233 AciPort configuration parameter 162 actions GetConfig 200 GetLogStream 201 GetLogStreamNames 201 GetStatistics 201 GetStatus 205 GetStatusInfo 206 SetConfig 206 Stop 207 addfield method 58 AdminClients (CFS) configuration parameter 148 Ancestor (configuration setting) 88 at method 62 attr method 63 Autonomy Content Infrastructure (ACI) 233 B boolean values 36, 50 C CleanOnStart configuration parameter 106 configuration 35 boolean values 36, 50 example configuration file 40 file sections 37 string values 36, 50 configuration file example 40 JobName section 39 License section 40 Logging section 37 Service section 37 configuration parameters AciPort 162 AdminClients (CFS) 148 CleanOnStart 106 ConnectorGroup 101 DatastoreFile 106 DeleteN 153 DotNetConnectorClass 125 DotNetConnectorLibrary 126 DREHost 162 EnableExtraction 107 EnableExtractionCopy 107 EnableIngestion 115 EnableScheduledTasks 108 EnableViewServer 104 EncryptACLEntries 108 ExtractDirectory 157 Full 166 HashN 153 Holder 166 Host 102, 104 ImportFamilyRootExcludeFmtCSV 157 ImportHashFamilies 158 ImportInheritFieldsCSV 158 ImportMerg s 159 IndexBatchSize 163 IndexDatabase 116 IndexTimeInterval 163 IngestActions 116 IngestAddAsupdate 117 IngestBatchSize 117 IngestCheckFinished 118 Objective WebTalk Connector Administration Guide 237