notes connector 7.3 administrator guide revision 2 · 2008. 6. 12. · notes connector 7.3...

03 June 2008Part Number DE0433

Notes ConnectorVersion 7.3

Administrator GuideRevision 2

NoticeThis document is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in this manual 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 document.

The copyrighted software that accompanies this document 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 document may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations is strictly coincidental.

Trademarks and CopyrightsCopyright 2008 Autonomy Corporation plc and all its affiliates. All rights reserved. Autonomy AnswerTM, Autonomy Service DashboardTM, Autonomy Desktop SuiteTM, DAHTM, DIHTM, DiSHTM, DLCMTM, DLHTM, DOHTM, Enterprise AWETM, IASTM, IDOLTM, IDOL serverTM, IDOLmeTM, IDOL DesktopTM, Portal-in-a-BoxTM, RetinaTM, ACI APITM, Active KnowledgeTM, Active SDKTM, ActiveServerTM, AutoIndexerTM, Autonomy LiteTM, Autonomy Offline CD PublisherTM, Autonomy POD for Siebel eBusiness ApplicationsTM, Document Management ServerTM, Import ModuleTM, SpeechPluginTM, VoiceSuiteTM, Autonomy Fetch for Siebel eBusiness ApplicationsTM, Documentum FetchTM, eRoom FetchTM, Exchange FetchTM, FatWire FetchTM, FileNet FetchTM, FileNet P8 FetchTM, File System FetchTM, FTP FetchTM, HTTP FetchTM, HummingbirdDM FetchTM, IBM Content Manager FetchTM, IBM Workplace FetchTM, iManage FetchTM, KVS FetchTM, Moreover FetchTM, NNTP FetchTM, Notes FetchTM, ODBC FetchTM, Omni Fetch SDKTM, OpenText FetchTM, Oracle FetchTM, PCDocs FetchTM, POP3 FetchTM, SAP FetchTM, Schlumberger FetchTM, SharePoint FetchTM, Stellent FetchTM, VirageTM, VidoeLoggerTM, AudioLoggerTM, SmartencodeTM, Virage ControlCenterTM, VS ArchiveTM, VS Broadcast MonitoringTM, VerityTM, CardiffTM, the Verity logo, the LiquidPDF logo, KeyViewTM, UltraseekTM, Knowledge OrganizerTM, TOPICTM, Verity Portal OneTM, Verity ProfilerTM, LiquidOfficeTM, LiquidPDFTM, Connect AgentTM, HTML+FormsTM, MediClaimTM, PDF+FormsTM, TeleFormTM, Tri-CRTM, RecoFlexTM, AutoMerge PublisherTM, TrueAddressTM, and VersiFormTM are trademarks of the Autonomy group of companies.

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.

Stellent is a trademark of Stellent, Inc.

All other trademarks are the property of their respective owners.

Notice to Government End UsersIf 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 252.227-7013. Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (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., 2880 San Tomas Expressway, Suite 130 Santa Clara, CA, 95051, US.

3.06.08

Copyright Notice

Contents

Preface .............................................................................................................................. 11

Using This Book ...................................................................................................................... 11Version ............................................................................................................................. 11Organization of This Book ................................................................................................ 12Stylistic Conventions ........................................................................................................ 13

Related Documentation........................................................................................................... 15Support and Contact Information ............................................................................................ 16

Downloading the Latest Documentation........................................................................... 16Autonomy Technical Support ........................................................................................... 16Contact Autonomy............................................................................................................ 17

PART I USING NOTES CONNECTOR

1 Introduction ...................................................................................................................... 21

Overview ................................................................................................................................. 22System Architecture ................................................................................................................ 23

2 Installation ........................................................................................................................ 25

System Requirements............................................................................................................. 26Supported Platforms......................................................................................................... 26Minimum Server Specification.......................................................................................... 26

Installing Notes Connector Service through IDOL Dashboard................................................ 27Implementation Procedure ............................................................................................... 28

Installing Notes Connector Standalone on Windows .............................................................. 29Directory Structure—Windows Standalone ...................................................................... 33

Installing Notes Connector on UNIX ....................................................................................... 35Directory Structure—UNIX Standalone ............................................................................ 37

DeliverNotes.exe CGI Parameters.......................................................................................... 39

3

Contents

3 Configuring Notes Connector..................................................................................... 41

Displaying Online Help ............................................................................................................ 42Configuring Through the Dashboard ....................................................................................... 42Editing the Configuration File .................................................................................................. 43

Modifying Configuration Parameter Values ...................................................................... 43Entering Boolean Values ........................................................................................... 43Entering String Values ............................................................................................... 43

Configuration File Sections............................................................................................... 44Example Notes Connector Configuration File................................................................... 48

Encrypting Passwords ............................................................................................................. 50Windows Operating Systems............................................................................................ 50UNIX Operating Systems.................................................................................................. 50

Setting Up Log Streams .......................................................................................................... 51Adding a Site to the Notes Connector ..................................................................................... 53Accessing Notes Documents Using IDOL Server Records ..................................................... 54

Importing and Indexing the Required Data ....................................................................... 55Calling the Document ....................................................................................................... 55

Field Mapping .......................................................................................................................... 56Extracting a Notes Field and Mapping to an IDOL Server Field ....................................... 57Launching the Notes Client Application from an Autonomy Results List .......................... 58

4 Starting and Stopping Notes Connector ................................................................. 59

Starting a Connector................................................................................................................ 60Stopping a Connector.............................................................................................................. 60

PART II PARAMETER AND COMMAND REFERENCE

5 Notes Connector Parameters ..................................................................................... 65

Attachment Parameters........................................................................................................... 66AttachmentCantHaveCSVs ............................................................................................. 66AttachmentCantHaveFlags .............................................................................................. 66AttachmentCopyToDirectory............................................................................................. 67AttachmentMatch ............................................................................................................. 67AttachmentMatchField ..................................................................................................... 68AttachmentMaxSize ......................................................................................................... 69

4 Notes Connector 7.3 Administrator Guide Revision 2

Contents

AttachmentMustHaveCSVs ............................................................................................. 69AttachmentMustHaveFlags ............................................................................................. 70AttachmentUseNoteTitle ................................................................................................. 70CheckAttachNameDuplicate ........................................................................................... 71GetAttachments................................................................................................................ 71GetAttachmentsOnly ....................................................................................................... 72

Cleaning Parameters .............................................................................................................. 72CleanNotesClient ............................................................................................................ 72FieldsToCleanCSVs ........................................................................................................ 73StripFileNames ................................................................................................................ 73StripHTMLContent ........................................................................................................... 73

Database Parameters ............................................................................................................. 74DatabaseDirectory ........................................................................................................... 74DatabaseDirectoryCantHaveCSVs ................................................................................. 74DatabaseDirectoryDeleteField ........................................................................................ 75DatabaseDirectoryJobFile ............................................................................................... 76DatabaseDirectoryMustHaveCSVs ................................................................................. 76DatabaseDirectoryRecurse ............................................................................................. 77

Deleting Content Parameters.................................................................................................. 77DeleteAddJobName ........................................................................................................ 77DeleteByField .................................................................................................................. 78DeleteFromDre ................................................................................................................ 78

Field Mapping Parameters ...................................................................................................... 79DreField ........................................................................................................................... 79MapAll ............................................................................................................................. 79NotesContentField ........................................................................................................... 80NotesField ....................................................................................................................... 80NotesFieldSrcName ........................................................................................................ 81

Form Parameters .................................................................................................................... 82FormMapToContent ........................................................................................................ 82NotesForm ....................................................................................................................... 82

Formula Parameters ............................................................................................................... 83ExecuteNotesFormula ..................................................................................................... 83NotesFormula .................................................................................................................. 83NotesFormulaTo .............................................................................................................. 84NotesFormulaSrcName ................................................................................................... 84

Notes Connector 7.3 Administrator Guide Revision 2 5

Contents

ViewFormula..................................................................................................................... 85Global Parameters................................................................................................................... 85

FetchDuration .................................................................................................................. 85FullSearchForDelete ........................................................................................................ 86ImportPath ....................................................................................................................... 87SpiderCycles .................................................................................................................... 87SpiderRepeatInterval ....................................................................................................... 88SpiderRepeatSecs ........................................................................................................... 89SpiderStartTime................................................................................................................ 89StatusFile ......................................................................................................................... 90

IDOL Server Parameters ......................................................................................................... 90ACIPort ............................................................................................................................ 90Database ......................................................................................................................... 91DreHost ............................................................................................................................ 91

Indexing Parameters ............................................................................................................... 92BatchProcess ................................................................................................................... 92BatchSize ......................................................................................................................... 92IndexDirectory .................................................................................................................. 93IndexMode ....................................................................................................................... 93IndexOverSocket ............................................................................................................. 95IndexToFile ...................................................................................................................... 95

Notes Parameters.................................................................................................................... 96CaseSensitive .................................................................................................................. 96CharsetConvTablesDirectory ........................................................................................... 96CheckViewChanged ......................................................................................................... 97CheckViews ..................................................................................................................... 97ConvertFileNames ........................................................................................................... 97DominoDocAllVersions .................................................................................................... 98DreType ........................................................................................................................... 98EscapeReferences .......................................................................................................... 99FilterByView ..................................................................................................................... 99ImportHashExtractChild ................................................................................................. 100ImportHashedDirType .................................................................................................... 100IsDominoDotDoc ............................................................................................................ 101IsQuickPlace .................................................................................................................. 101NotesDB ........................................................................................................................ 102


Contents

NotesServer .................................................................................................................. 102NotesTextOutputFiles .................................................................................................... 103NotesTextOutputDir ....................................................................................................... 103NotesTitleField .............................................................................................................. 104NotesView ..................................................................................................................... 104NSFIsRoot ..................................................................................................................... 105NSockets ....................................................................................................................... 105PageDelay ..................................................................................................................... 106ProcessInvalid ............................................................................................................... 106ShowViewColumns ....................................................................................................... 107SingleView ..................................................................................................................... 107SkipIfViewNotFound ...................................................................................................... 107StoreContent ................................................................................................................. 108TableSearch ................................................................................................................... 108

Password Parameters........................................................................................................... 109PasswordUserIdFile ...................................................................................................... 109PasswordEncrypted ...................................................................................................... 109

Security Parameters.............................................................................................................. 110DebugSecurity ............................................................................................................... 110NotesACLMapping ........................................................................................................ 110NotesSecurityField ......................................................................................................... 111SecurityUpdateBatchSize .............................................................................................. 111

Viewing Parameters .............................................................................................................. 112AttachmentShowNote .................................................................................................... 112LaunchPostfix ................................................................................................................ 112LaunchPrefix ................................................................................................................. 113Prefix ............................................................................................................................. 113Postfix ............................................................................................................................ 114ReferencelsLaunch ....................................................................................................... 114ReferencelsURL ............................................................................................................ 115

6 License Configuration Parameters .......................................................................... 117

IDOL with Administration License Parameters...................................................................... 117LicenseServerACIPort ................................................................................................... 118LicenseServerHost ........................................................................................................ 118LicenseServerTimeout .................................................................................................. 119


Contents

LicenseServerRetries .................................................................................................... 119Standalone License Parameters ........................................................................................... 120

Full ................................................................................................................................. 120Holder ............................................................................................................................ 120Key ................................................................................................................................. 121Operation ....................................................................................................................... 121

7 Logging Configuration Parameters ........................................................................ 123

LogArchiveDirectory ............................................................................................................. 124LogCompressionMode ......................................................................................................... 125LogDirectory ......................................................................................................................... 125LogEcho ............................................................................................................................... 126LogEncryption ....................................................................................................................... 126LogEncryptionKeys ............................................................................................................... 127LogExpireAction ................................................................................................................... 128LogFile .................................................................................................................................. 129LogLevel ............................................................................................................................... 129LogLevelMatch ..................................................................................................................... 130LogMaxLineLength ............................................................................................................... 131LogMaxOldFiles .................................................................................................................... 132LogMaxSizeKBs ................................................................................................................... 133LogOldAction ........................................................................................................................ 133LogOutputLogLevel .............................................................................................................. 134LogSysLog ............................................................................................................................ 135LogTime ................................................................................................................................ 135LogTypeCSVs ...................................................................................................................... 136

8 Service Configuration Parameters .......................................................................... 139

ServiceACIMode ................................................................................................................... 140ServiceControlClients ........................................................................................................... 140ServiceHost .......................................................................................................................... 141ServicePort ........................................................................................................................... 141ServiceStatusClients ............................................................................................................ 142


Contents

9 Service Action Commands........................................................................................ 143

GetConfig ............................................................................................................................ 144GetLogStream ..................................................................................................................... 144

GetLogStream Action Parameters ................................................................................. 145FromDisk ................................................................................................................. 145Name ....................................................................................................................... 145Tail ........................................................................................................................... 145

GetLogStreamNames ......................................................................................................... 145GetStatistics ........................................................................................................................ 146GetStatus ............................................................................................................................ 149GetStatusInfo ...................................................................................................................... 150MergeConfig ........................................................................................................................ 151

MergeConfig Action Parameters .................................................................................... 151Config ...................................................................................................................... 151DeleteKey<N> ......................................................................................................... 152Key<N>.................................................................................................................... 152Value<N>................................................................................................................. 152

SetConfig ............................................................................................................................ 153Stop ..................................................................................................................................... 153

Glossary .......................................................................................................................... 155

Index ................................................................................................................................. 159


Contents


Preface

This guide is for readers who need to configure Notes 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:

Using This Book

Related Documentation

Support and Contact Information

Using This Book

This section briefly describes the organization of this book and the stylistic conventions it uses.

VersionThe information in this book is current as of Notes Connector version 7.3. The content was last modified 03 June 2008. Corrections or updates to this information may be available through the Autonomy Support site; see “Support and Contact Information” on page 16.

11

Preface Using This Book

Organization of This BookThis book includes the following chapters and appendixes:

Chapter 1, “Introduction”

This chapter describes the system architecture and Notes Connector operation.

Chapter 2, “Installation”

This chapter provides information that is required to use the Notes Connector after it is installed.

Chapter 3, “Configuring Notes Connector”

This chapter describes configuration file parameter values.

Chapter 4, “Starting and Stopping Notes Connector”

This chapter describes how to start and stop Notes Connector.

Chapter 5, “Notes Connector Parameters”

This chapter describes configuration parameters that control the Notes Connector.

Chapter 6, “License Configuration Parameters”

This chapter describes the License configuration parameters that specify licensing details and are used in the standalone and IDOL with Administration versions of Notes Connector.

Chapter 7, “Logging Configuration Parameters”

This chapter describes the logging 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.

Chapter 8, “Service Configuration Parameters”

This chapter describes Service configuration parameters that determine which machines are permitted to use and control a service.

Chapter 9, “Service Action Commands”

This chapter describes standard service and control commands.



Stylistic ConventionsThe following stylistic conventions are used in this book.

Convention Usage

Plain Narrative text.

Bold User-interface elements in narrative text:

Click Cancel to halt the operation.

Italics Book titles and new terms:

For more information, see the IDOL Server Administrator Guide.

An action command is a request, such as a query or indexing instruction, sent to IDOL Server.

Monospace File names, paths, and code:

The name.ext file is installed in:

C:\Autonomy\Data\

Monospace italic Replaceable strings in file paths and code:

user username

Monospace bold Data types and required user input:

SrvConnect A connection handle.

In the User Interface text box, type user1.



The following command-line syntax conventions are used in this book.

Use of punctuation—such as single and double quotes, commas, periods—indicates actual syntax; it is not part of the syntax definition.

Convention Usage

[ optional ] Brackets describe optional syntax, as in [ -create ] to specify a non-required option.

| Bars indicate “either | or” choices, as in

[ 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, as in

{ [ option1 ] [ option2 ] }

In this example, you must choose option1, option2, or both options.

required Absence of braces or brackets indicates required syntax in which there is no choice; you must enter the required syntax element.

metavariable

<metavariable>

Italics specify items to be replaced by actual values, as in

-merge filename1

(In some documents, angle brackets are used to denote these items.)

... Ellipses indicate repetition of the same pattern, as in

-merge filename1, filename2 [, filename3 ... ]

where the ellipses specify , filename4, and so on.


Preface Related Documentation

Related Documentation

The following documents provide more details on Notes Connector:

Import Module Administrator Guide

Autonomy’s Import Module is an integral part of any Autonomy connector. The Import Module manual provides information on how you can configure the settings that determine how content is treated during the importing process (before it is passed to IDOL server).

IDOL Administration User and Administrator 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 Administrator Guide

IDOL server lies at the center of any Autonomy infrastructure, storing and processing the data that connectors index into it. The IDOL server manual describes the operations that IDOL server can perform with detailed descriptions of how to set them up.

Distributed Index Handler (DIH) Administrator Guide

This guide contains details on how you can use a DIH to distribute aggregated documents across multiple IDOL servers.

Intellectual Asset Protection System (IAS) Administrator Guide

This guide contains 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) Administrator Guide

This guide contains details on how you can use a DiSH server to administer and control multiple Autonomy services.


Preface Support and Contact Information

Support and Contact Information

Read this section if you want to contact Autonomy, request technical support, or obtain product documentation.

Downloading the Latest DocumentationYou can retrieve the latest available product documentation from Autonomy’s Automater site. To download the latest document revisions, take the following steps:

1. Enter this URL in your web browser's Address field:

http://automater.autonomy.com

2. Enter your user name and password. Click Log in.

3. Select the Download menu option.

4. Under the Documentation and Release Notes heading, click the Click here link, then open the Manuals folder to display the latest available document versions. You can display any of the documents in your browser and download them.

The version number associated with a document (for example, version 4.1) 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. Automater contains the latest available revision of any document.

Autonomy Technical SupportAutonomy 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.


http://automater.autonomy.com


Call, fax, or email the support group at the location that is nearest to you:

For search and categorization products, access the Customer Support site, at

https://customers.autonomy.com

Access to the contents of the Customer Support site requires a user name and password. To obtain a user name and password, follow the signup instructions on the home page.

Access the support site from the Autonomy Web page at:

Web: http://www.autonomy.com

Contact AutonomyContact the location that is nearest to you for general information about Autonomy:

Europe and Worldwide The Americas

Autonomy Systems Ltd.Cambridge Business ParkCowley Road, Cambridge, CB4 0WZ, UK

Telephone: 00.800.4837.4890 (UK, Germany, Spain,

Netherlands, France)

+44 (0) 800 0 282 858[Hours: 9:30 AM to 6:00 PM (GMT)](Monday through Friday)

Email: [email protected]

Autonomy, Inc.400 4th Avenue SW, Suite 2500Calgary, AB, T2P 0J4, Canada

Telephone: 877.333.7744

[Hours: 7:00 AM to 6:00 PM MST (GMT-7)] (or leave voice mail)

Email: [email protected]

Europe and Worldwide The Americas

Autonomy Systems Ltd.Cambridge Business ParkCowley Road, Cambridge, CB4 0WZ, UK

Telephone: +44 (0) 1223 448 000

Fax: +44 (0) 1223 448 001

General information email: [email protected]

Autonomy, Inc.2880 San Tomas Expressway, Suite 130Santa Clara, CA, 95051, US

Telephone: +1 408 982 4230

Fax: +1 408 654 9302

General information email: [email protected]


https://customers.autonomy.com

http://www.autonomy.com

I Using Notes Connector

Chapter 1: Introduction

Chapter 2: Installation

Chapter 3: Configuring Notes Connector

Chapter 4: Starting and Stopping Notes Connector

19

1 Introduction

This chapter provides an overview of Notes Connector. It includes the following sections:

Overview

System Architecture

21

1 IntroductionOverview

Overview

Notes Connector is an Autonomy connector that automatically aggregates documents from Lotus Notes databases, imports them into IDX or XML file format (only IDX or XML files can be indexed in IDOL server), and indexes them into an Autonomy IDOL server. Notes Connector uses the Lotus Notes API for full integration with Notes.

Notes Connector includes the Import Module, which imports documents into HTML format and extracts document fields and metadata for indexing into IDOL server. The Import Module can also be used to modify field values. Please refer to the Import Module manual for full details on the Import Module operation and configuration.

Once IDOL server receives the documents, it automatically processes them, performing a number of intelligent operations in real time, such as

See the IDOL Server Administrators Guide for further details.

Agents

Alerting

Categorization

Channels

Clustering

Collaboration

Dynamic Thesaurus

Expertise

Hyperlinking

Mailing

Profiling

Retrieval

Spelling Correction

Summarization

Taxonomy Generation


1 IntroductionSystem Architecture

System Architecture

Notes Connector aggregates documents from any type of local or remote repository and indexes them into an IDOL server:

If you want to distribute the documents that Notes Connector aggregates across multiple IDOL servers, you need a DIH (Distributed Index Handler) installation.

In this case, Notes Connector aggregates documents from any type of local or remote repository and indexes them into the DIH, which then distributes the documents between the IDOL servers it connects to, providing load balancing and failover:


1 IntroductionSystem Architecture

Notes Connector is installed by default as a Windows NT service (NT version only) for regular batch processing, and can also be run from the command line (UNIX and NT versions). In any case, it does not take any command-line arguments. It takes its entire configuration from a file, NotesFetch.cfg, in the current working directory, and produces a log of its actions in NotesFetch.log, also in the current working directory. This is overwritten each time the program starts. The program runs in three main stages:

Notes Extraction

Records are extracted from the specified Notes database and written to a temporary file. Attachments may also be extracted. The details of your Notes database structure and where to add documents into the IDOL server needs to be defined in NotesFetch.cfg. Once it has been defined, the extraction configuration will only need to be changed when your database structures are modified.

Import

The temporary files are examined and their contents imported by the Import Module into the Autonomy IDOL server indexer format. Attachments are also converted. Records which do not meet the import criteria (such as ImportMinLength) are discarded at this stage. Attachments which cannot be translated by the importer will also be discarded. Once import is completed, all of the import records are collected in the file Spidername\out.idx.

Index

The Notes Connector Module asks the IDOL server to index the .idx file. Note that this simply adds the .idx file to a queue, and may return before the document has been completely added to the IDOL server database. Once the .idx file has been indexed, the content can be searched by a Autonomy Knowledge Management product configured to use that IDOL server.

For information on how to set up the Notes Connector Module and to customize these processes, see Chapter 3, “Configuring Notes Connector” on page 41.


2 Installation

This chapter provides information required to use the Notes Connector after installing it through IDOL Dashboard and information on installing the standalone version of the Notes Connector. See the IDOL Administration User and Administrator Guide for information on installing IDOL and IDOL services through IDOL Dashboard.

This chapter includes the following sections:

System Requirements

Installing Notes Connector Service through IDOL Dashboard

Installing Notes Connector Standalone on Windows

Installing Notes Connector on UNIX

DeliverNotes.exe CGI Parameters

25

2 InstallationSystem Requirements

System Requirements

Notes Connector should be installed by the system administrator as part of a larger Autonomy system (that is, a system that includes an Autonomy IDOL server and an interface for the information stored in this IDOL server).

Supported PlatformsNotes Connector runs on a variety of Windows and UNIX platforms. For a detailed list of supported platforms, see the IDOL 7.0 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.

Note Notes Connector also supports other POSIX UNIX versions on request.

Minimum Server SpecificationOn Windows:

200 MHz Pentium processor

64 MB RAM

2 GB hard disk

On UNIX:

128 MB of RAM

2 GB hard disk

You must have Lotus Notes installed as a client or a server. This specification is dependent on the amount of data to be fetched. Due to substantially different disk usage patterns, it is beneficial to run the connector and IDOL server processes on separate drives or partitions.


2 InstallationInstalling Notes Connector Service through IDOL Dashboard

The location of the Notes client must be specified for Notes Connector.

On Windows, add the location of the Notes client to the PATH system variable.

On Solaris and Linux, set the LD_LIBRARY_PATH variable to the location of the Notes client.

On HP-UX, set the SHLIB_PATH variable to the location of the Notes client.

On AIX, set the LIBPATH variable to the location of the Notes client.

If you modify the system variables and you are using IDOL Administration, you must restart the Autonomy Administration Node service.

If you modify the system variables and you are using the IDOL standalone version, restart the Notes Connector.

Installing Notes Connector Service through IDOL Dashboard

If you are using IDOL with Administration, install the connector service as described in the IDOL Administration User and Administrator Guide.

After you have installed the connector, ensure the following configuration parameters are set for the connector in the Dashboard Console Configuration tab:

Enter IDOL server and indexing details.

Target ACI Port Enter the IDOL server ACI port Notes Connector uses to query IDOL server.

DRE Host Enter the IP address (or name) of the machine on which the IDOL server is running.

Database Enter the name of the IDOL server database into which you want Notes Connector to index documents. You may want to create a special database in your IDOL server called Exchange.

Import Path Enter the path to the location where temporary IDX files are stored during the importing process. This is usually the same location as specified in Index Path.


2 InstallationInstalling Notes Connector Service through IDOL Dashboard

Specify Notes server settings:

Note For information on the directory structure created when installing an Notes Connector service through IDOL Dashboard, see the IDOL Administration User and Administrator Guide.

Implementation ProcedureYou can use the following implementation procedure to test run your Notes Connector installation:

1. In the Dashboard Console, select the IDOL connector service from the list in the left-hand pane of the Dashboard Console, then ensure the connector service is Stopped/Offline.

2. On the Configuration tab, update the connector's configuration to access your documents and define the connector's import settings. You may want to adjust the batch size and number of documents retrieved so the connector responds with some document information in a reasonable time frame.

3. On the Configuration tab, ensure the DRE Host configuration setting is currently not set for the job. This causes the connector to create temporary IDX files, whose contents you can then view in the IDX Preview tab. The DRE Host configuration setting can be found in both the default and individual connector job sections on the Configuration tab.

4. Start the connector service. Wait a few minutes to allow the connector enough time to gather document information. You may inspect the connector's log file(s) on the View Logs tab to determine the connector job's progress. (Note that because you have not set DRE Host, the NotesConnector.log file states that the indexing command failed).

5. Once you have enough information to inspect, stop the connector.

Notes Server Enter the name of the Notes server from which you want Notes Connector to fetch documents. If you want to use more than one Notes server, you can specify further servers in the individual job sections.

Notes Database Enter the Notes database on the server specified in the Notes Server field.

Notes Database Directory

Enter a directory on the Notes server containing the database to be polled by Notes Connector.

Notes Database Directory Recurse

Select this check box to allow Notes Connector to poll subdirectories of the Database Directory.


2 InstallationInstalling Notes Connector Standalone on Windows

6. Once the connector is Stopped/Offline, open the IDX Preview tab, refresh it if necessary and select the temporary IDX file(s) to view.

7. Ensure the IDX file contains all the content you want to index into IDOL server. If it does not, you must configure Notes Connector to aggregate the content you want. You can do this using specialized Notes Connector and Import Module parameters (see the online help for details on available parameters).

8. If you have made changes to the Notes Connector configuration file, remove all the connector's run-time files to accurately determine the effect of your configuration changes. To remove the run-time files, click the Trash icon located to the right of the Refresh button at the top of the tab. Start Notes Connector and repeat steps 5 through 8 until the content of the IDX file is correct.

9. Finalize your Notes Connector configuration:

a. On the Configuration tab, set the Spider Cycles parameter to an appropriate number.

b. Set the DRE Host parameter to the IP address (or name) of the machine that hosts your IDOL server.

c. Set up the Notes Connector jobs you want Notes Connector to execute.

10.You can now run Notes Connector.

Installing Notes Connector Standalone on Windows

Notes Connector should be installed by the system administrator.

To install a standalone version of Notes Connector on Windows, double-click the Notes Connector-VersionNumber.exe program.

Read and follow all installation instructions on the screen carefully.

1. The installation opens with the Introduction dialog. Read the text and click Next.

The License Agreement dialog appears.

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 appears.



3. Choose an installation folder for Notes Connector. By default, Notes Connector is installed in C:\Autonomy\NotesConnector, but you can click the Browse button to choose another location. After you choose an installation folder, click Next.

The Enter Installation Name dialog appears.

4. Enter a unique name for the Notes Connector installation. This name is used for the connector installation directory and various files. The name you choose must not contain any spaces. After you select a name, click Next.

Note Steps 5 and 6 only apply if the installation software cannot find licensekey.txt in the same folder as the installation executable.

Contact Autonomy Technical Support if you do not have the license key. See “Support and Contact Information” on page 16 for Technical Support contact details.

5. If licensekey.txt is not in the same folder as the installation executable, the License Details dialog appears. If you have a license file, put it in the same folder as the installation executable and restart the installation. If you do not have a license key, click Next to install a 30-day evaluation of Notes Connector.

The Enter License Holder Name dialog appears.

6. Enter the name of the company using the trial version of Notes Connector. Click Next.

The Service Settings dialog appears.



7. Enter the following details and click Next.

The DRE Settings dialog appears.

8. Enter the following information for the IDOL server into which the fetched data will be indexed:

The Notes Location dialog appears.

9. Specify where Notes is installed on the computer. This can be either a Notes client or a Domino server. You can click Browse to navigate to another location.

The Notes Server Settings dialog appears.

Service Port The port number that Notes Connector uses to communicate with the license server. This port must not be used by any other service.

Service Status Clients The IP addresses of computers that are permitted to access the Notes Connector status, but are not permitted to control the status.

If you want to permit a number of machines to access the Notes Connector status, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to access the Notes Connector status.

Service Control Clients The IP addresses of computers that are permitted to control the Notes Connector service.

If you want to permit a number of machines to control the Notes Connector service, use a wildcard. For example, enter 187.*.*.* to permit any machine with an IP address that begins with 187 to control the Notes Connector service.

IDOL Server Hostname The IP address (or computer name) of the IDOL server computer.

Query Port The port that Notes Connector uses to send queries to IDOL server.

Index Port The port on which the IDOL server listens for index commands. This number must match the IndexPort value in the [Server] section of AutonomyIDOLServer.cfg.

ACI Port The IDOL server ACI port the connector uses to query IDOL server. This number must match the Port value in the [Server] section of AutonomyIDOLServer.cfg.

Database Name The name of the IDOL server database in which you want to index the documents the connector aggregates.



10.Enter the following for the Notes Server:

The Domino Doc Settings dialog appears.

11.Specify the directory on your Domino server that contains the library files that you want Notes Connector to retrieve, and select whether you want to recurse into the directory.

The Notes ID Settings dialog appears.

12.Enter the following for the Notes User ID file:

The Pre-Installation Summary dialog appears.

13.Review the installation settings, and click Previous to reverse through the installation configuration dialogs to change any settings if necessary. If you are satisfied with the settings, click Install.

The Start Service dialog appears.

14.Select whether you want to start the Notes Connector service immediately after installation is complete, and click Next.

The Install Complete dialog appears. Click Done.

You should now ensure the Lotus Notes executable directory (for example C:\notes or C:\lotus\notes) is in your system environment path. If it is not, edit the Windows PATH setting, which you can do from the Start menu (in Settings > Control Panel > System > Environment).

Notes Server The name of the Notes server from which you want Notes Connector to fetch documents. If you want to use more than one Notes server, you can specify further servers in the [Notes] section of the Notes Connector configuration file once the installation is completed.

Notes INI File The path to your notes.INI file. Usually this file is located in your windows or notes directory.

Notes Server HTTP Path

The Web address of the Notes Server's root directory. This should be either the host name or the IP address of the server.

Notes User ID File The path to the Notes User ID file that you want Notes Connector to use. This file must have permission to read the databases that you are going to spider, although it does not require write access.

Notes Password The password for the User ID file.



Note Do not copy the Lotus Notes DLLs into the Notes Connector directory. Doing this can cause errors.

Directory Structure—Windows StandaloneThe Notes Connector installation adds the following files to your directory structure. Folders are indicated by bold font:

File Description

convtables Folder containing various text files used during the importing process.

filters

binslave.cfg Configuration file for binslave.exe.

binslave.exe Executable that is used during the importing process to extract text from binary files that are not recognized by the import module or cannot be converted by importslave.

importslave.exe Executable that generates IDX files for importing into IDOL server.

kvoop.exe Executable that runs KeyView filters out of process.

various .dat files Data file used by binslave.

various .dll files Filters used by omnislave to extract document data from various document types.

help Contains HTML help files for Notes Connector.

jre Java Runtime Environment.

Uninstall_NotesConnector Files required to uninstall Notes Connector.

autpassword.exe Autonomy Password Encryption Utility executable that allows you to encrypt the passwords that the Notes Connector configuration file contains.



When you start Notes Connector for the first time, the following files are created:

delivernotes.exe The formatting CGI for the Notes launcher method of displaying results.

If the referenceIsLaunch configuration parameter is enabled, copy this executable to the CGI/Scripts bin on the Web server, and point the launching settings to it.

nextpwd.dll Notes password.

NotesConnector.cfg Configuration file that contains the Notes Connector settings.

NotesConnector.exe Notes Connector executable.

NotesConnector_InstallLog.log Installation log file that lists the details of the installation process.

notesfire.exe The NotesFire installer, used in patching the system to launch Notes automatically when Notes Connector is used.

File Description

uid Folder containing document tracking files.

autn_ntres.dll NT resource library.

NotesConnector.lck Internally used lock file for Notes Connector.

NotesConnector.log Notes Connector log file.

NotesConnector.pid Process identification file for Notes Connector.

NotesConnector.str Notes Connector structured configuration file.

NotesConnectorcfg.log Notes Connector configuration log file.

File Description


2 InstallationInstalling Notes Connector on UNIX

Installing Notes Connector on UNIX

Notes Connector should be installed by the system administrator.

To install on UNIX, follow these steps:

1. Uncompress the installer using the command:

uncompress <Installer>.tar.Z

2. Un-tar the resulting file using the command:

tar –xvf <Installer>.tar

This creates a directory called notesfetch-2.6.x that contains the following files:

3. Run the installer script, ./Setup.sh, with the following arguments:

Setup.sh

binslave.cfg

Various SO files

freplace.exe

notesfetch.cfg

notesfetch.exe

notesfetchpwd.cfg

nt/

autpassw.exe

notesfire.exe

pwconf.exe

uninstall.sh

InstallName A unique name for the Notes Connector installation. Note that the unique name must not contain any spaces

InstallDirectory (fully qualified path)

The directory in which you want to install Notes Connector.

DRE_IP_Address The IP address of the machine on which the IDOL server is running.

DRE_Port The port that Notes Connector uses to query the IDOL server.



4. The settings that you have entered are displayed. Check that the settings are correct and press Return to continue with the installation. Alternatively, press Ctrl+C to cancel the installation.

5. When prompted, enter the password for your Notes ID file and press Return.

6. Once the installation is complete, you should copy the libextpsw.so file to your notes directory.

7. Add the following line to the notes.ini file in your Lotus Notes directory:

EXTMGR_ADDINS=extpwd,libextpsw.so

8. Modify your PATH environment variable so that it contains your notes directory. The PATH environment variable is normally set in your shell initialization file, such as.bashrc.

9. Add the notes library path to your LD_LIBRARY_PATH (for example, /opt/lotus/notes/notesr4).

10.Add a Note_ExecDirectory environment variable set to the Notes executable directory, for example:

export Notes_ExecDirectory=/opt/lotus/notes/latest/sunspa

11.Restart Lotus Notes to apply the new settings.

DRE_IndexerPort The port that Notes Connector uses to index information into the IDOL server.

Notes_Server The name of the Notes server from which you want Notes Connector to fetch documents. If you want to use more than one Notes server, you can specify further servers in the [Notes] section of the Notes Connector configuration file once the installation is completed.

Notes_ID_file (fully qualified path) The path to the Notes User ID file that you want Notes Connector to use. This file must have permission to read the databases that you are going to spider, although it does not require write access.

For example:

./Setup.sh MyNotesFetch /autonomy/MyNotesFetch 127.0.0.1 2000 2001 server.autonomy.com /notes/myUser.id



Directory Structure—UNIX StandaloneThe Notes Connector installation adds the following files to the main Notes Connector installation directory. Folders are indicated by bold font.

File Description

convtables Folder containing various text files used during the importing process.

filters Folder containing executables used during the import process.

binslave.cfg Configuration file for binslave.

binslave.exe Executable that is used during the importing process to extract text from binary files that are not recognized by the import module or cannot be converted by importslave.

filter KeyView test executable useful for diagnosing problems with filters.

filtertest KeyView test executable useful for diagnosing problems with filters.

importslave.exe Executable that generates IDX files for importing into the IDOL server.

kvoop Executable that runs KeyView filters out of process.

tstextract KeyView test executable useful for diagnosing problems with extraction.

various DAT files Data files that binslave uses.

various SO files Filters used by omnislave during the import process.

nt

autpassword.exe Autonomy password encryption utility executable that allows you to encrypt the passwords that the Notes Connector configuration file contains

notesfire.exe The NotesFire installer is used in patching the system so that Notes launches automatically when you use Notes Connector.

Uninstall_NotesConnector Files required to uninstall Notes Connector.

NotesConnector.cfg Configuration file that contains the Notes Connector settings.



When you start Notes Connector for the first time, the following files are created:

NotesConnector.exe Executable for Notes Connector.

NotesConnector_InstallLog.log Installation log file that lists the details of the installation process.

libextpsw.so Notes password file.

delivernotes.exe The formatting CGI for the Notes launcher method of displaying results.

If the referenceIsLaunch configuration parameter is enabled, copy this executable to the CGI/Scripts bin on the Web server, and point the launching settings to it.

File Description

uid Folder containing document tracking files.

NotesConnector.lck Lock file which prevents multiple instances of Notes Connector running simultaneously.

NotesConnector.log Log file for Notes Connector messages.

NotesConnector.pid Process identification file for Notes Connector.

NotesConnector.str Status information for the Notes Connector service.

NotesConnectorcfg.log Log file for configuration changes in Notes Connector.

File Description


2 InstallationDeliverNotes.exe CGI Parameters

DeliverNotes.exe CGI Parameters

The parameters that can be submitted with the DeliverNotes executable are as follows:

For example:

http://notes.myserver.com/scripts/DeliverNotes.exe?replica=8514650e:00436d5d&view=OFabf5ea8c:64038c10-ON852543c0:00666f8f&nsfnote=OFc21a6c62:3a6785d0-ON8525550d:00693a04&server=server/Autonomy

The replica should match that of the database being indexed. Likewise the view and the nsf should be the Note ID. All of these can be checked from the database and document properties dialogs.

Parameter Description

replica The replica of the database to be opened.

view The Notes view to use.

nsfnote The unique ID of the note to be opened in that database.

server The server on which the database is located.


2 InstallationDeliverNotes.exe CGI Parameters


3 Configuring Notes Connector

This chapter describes how to configure the parameters that determine how the Notes Connector operates. You can use the IDOL Dashboard to modify these parameters to customize the connector for your needs. The configuration settings are stored in the connector configuration file located in the Notes Connector installation directory. You can also modify the parameters directly in the configuration file using a text editor (see “Editing the Configuration File” on page 43).

This chapter includes the following sections:

Displaying Online Help

Configuring Through the Dashboard

Editing the Configuration File

Encrypting Passwords

Setting Up Log Streams

Adding a Site to the Notes Connector

Accessing Notes Documents Using IDOL Server Records

41

3 Configuring Notes ConnectorDisplaying Online Help

Displaying Online Help

For information on the parameters you can set to control the Notes Connector, see the connector online help.

To access the Notes Connector online help for a standalone installation, open the following file:

InstallDir\help\NotesConnector\index.html

where InstallDir is the directory in which Notes Connector is installed.

For information on accessing the Notes Connector online help for an IDOL with Administration installation, see the IDOL Administration User and Administrator Guide.

On the initial online help page, click one of the following tabs to display help:

Configuring Through the Dashboard

Starting with IDOL 7.0, the IDOL Dashboard is available to IDOL administrators. The Dashboard allows you to change configuration settings for all IDOL services through a centralized user interface.

For more information on using the Dashboard, see the IDOL Administration User and Administrator Guide.

Tab Description

Config params Describes the connector-specific parameters that determine how the connector operates.

Import params The connector uses the Import Module to import aggregated content into IDX or XML format. The Import params help describes the Import Module parameters.

Service commands Service commands allow you to return data about the connector service and to control the connector. The Service commands help describes the commands you can send to the connector.


3 Configuring Notes ConnectorEditing the Configuration File

Editing the Configuration File

If you are using the standalone version of the Notes Connector, you configure the connector by manually editing the Notes Connector configuration file. The configuration file is stored at the following location:

InstallDir\InstallName.cfg

where InstallDir is the directory in which the Notes Connector is installed.

Note You can edit the Notes Connector configuration file in IDOL Dashboard.

Modifying Configuration Parameter ValuesThe following section describes how to enter parameter values in the configuration file.

Entering Boolean ValuesThe following settings for Boolean parameters are interchangeable:

TRUE = true = ON = on = Y = y = 1FALSE = false = OFF = off = N = n =0

Entering String ValuesSome parameters require string values that contain quotation marks. Escape each quotation mark by inserting a slash in front of it.

For example:

FIELDSTART0="<font face=\"arial\"size=\"+1\"><b>"

Here, the beginning and end of the string is 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 the quotation marks in the string by putting a slash in front of them.

For example:

ParameterName="<font face=\"arial\"size=\"+1\"><b>",dog,bird,"wing,beak",turtle

Configuration File SectionsThe configuration file can contain the following sections:

[License][Service][Default][Notes]

[JobName_1][JobName_2]...

[Passwords]

These sections represent different connector functionality that can be configured by setting specific configuration parameters within each section. The Configuration Section heading in the online help lists the sections in which a parameter can be set (see “Displaying Online Help” on page 42).

Note For information on the import parameters you can specify in the configuration file's [Default] and [JobName] section, see the Import Module Administrator’s Guide.



License SectionThe [License] section contains licensing details, which you should not change.

For example:

[License]Full=falseHolder=AutonomyKey=01234567890

Service SectionThe [Service] section contains parameters that determine which machines are permitted to use and control the Notes Connector service.

For example:

[Service]ServiceControlClients=127.0.0.1ServicePort=42002ServiceStatusClients=127.0.0.1

Default SectionThe [Default] section contains default parameters that apply to all the jobs listed in the [Notes] section. See “Notes Section” on page 47. If you want to specify different settings for a specific job, define them in the [JobName] section, in which case, the default settings for the job are overridden.

Note By default, the ACIPort parameter is set to $DREACIPORT$ in the configuration file. Change this to the IDOL server ACI port number, which is the value of the Port parameter in the IDOL server configuration file’s [Server] section.

For example:

[Default]GetAttachments=falseImportDefaultSlaveDirectory=./filtersImportMinLength=100ImportMinLengthWords=10IndexOverSocket=falseNotesContentField=Body



NotesTitleField=TitlePostfix=?OpenDocumentPrefix=http://localhost/ReferenceIsUrl=trueSpiderCycles=1SpiderRepeatSecs=86400SpiderStartTime=NOWImportCharsetConvTablesDirectory=./convtables

Passwords SectionIn this section, you specify the user ID and password information for each user required to access the Lotus Notes database.

The user ID and password can also be defined for specific connector jobs in the [JobName] section of the configuration file

For example:

[Passwords]PasswordUserIdFile0=c:\lotus\notes\data\userA.idPasswordUserIdFile1=c:\lotus\notes\data\userB.id

PasswordEncrypted0=9t3M3t7awtPasswordEncrypted1=sef4346td

In this example, the user ID file called userA.id is stored in C:\notes\data\ and has the password 9t3M3t7awt, and the user ID file called userB.id is stored in C:\notes\data\ and has the password sef4346td.

Note When running Notes Connector on Windows NT, the NEXTPWD.DLL file must be installed in the Lotus Notes home directory and the notes.ini file must include the line EXTMGR_addins=extpwd, nextpwd.dll.

When running Notes Connector on UNIX, the libextpws.so file must be installed in the Lotus Notes home directory and the notes.ini file must include the line EXTMGR_ADDINS=extpwd, libextpws.so.

Notes Connector always reads the passwords from NotesFetch.cfg. There must be a copy of this in the main installation directory for Notes Connector. There must not be a copy in the main directory for Lotus Notes because it prevents the user ID from being changed.



Notes SectionThe [Notes] section lists the jobs you want to run. In this section, you enter the total number of jobs in the Number parameter and then list the jobs in consecutive order starting from 0 (zero). For example:

[Notes]Number=20=NotesJob_11=NotesJob_2

JobName SectionThe [JobName] section contains configuration parameters that only apply to the specified job. There must be a [JobName] section for every job listed in the [Notes] section. A parameter specified in a [JobName] section overrides the same parameter defined in the [Default] section.

Note In general, you need one [JobName] section for each Notes database you want to spider and import.

For example:

[NotesJob_1]BatchProcess=IMPORTDREHost=BruneiDatabase=notesdbGetAttachments=trueImportAttachments=trueImportLogFile=import.logImportLogLevel=FullImportMinLength=0ImportMinLengthWords=0ImportRecursiveDirectoryImporting=trueIndexMode=IMPORTIndexOverSocket=trueACIPort=20201IndexToFile=trueNotesDb=mydb.nsfNotesServer=Brunei/VerityNotesTitleField=TitleNotesView=ALLPrefix=http://Brunei:18008/TableSearch=true



[NotesJob_2]BatchProcess=IMPORTDREHost=BruneiDatabase=notesdbGetAttachments=trueImportAttachments=trueImportLogFile=import.logImportLogLevel=FullImportRecursiveDirectoryImporting=trueIndexMode=IMPORTIndexOverSocket=trueACIPort=20201NotesDb=newdb.nsfNotesServer=Brunei/VerityPrefix=http://Brunei:18008/

Example Notes Connector Configuration FileThe following is an example of a Notes Connector configuration file. The company runs the connector once a day at 03:00. Details for two users that access the Notes databases are demonstrated, and the connector imports information from two Notes databases.

Every field in the Finance Notes database is mapped to a field of the same name in the IDOL server database. The connector imports both documents and their attachments from the Finance database.

When the connector spiders the Production Notes database, only the Department field is mapped to the IDOL server and the connector ignores any attachments that exist for the documents.

[License]Full=falseHolder=AutonomyKey=01234567890

[Service]ServiceControlClients=*ServicePort=42002ServiceStatusClients=*

[Default]Prefix=http://notes.mycompany.com/NotesTitleField=Title



NotesContentField=BodyDREHost=127.0.0.1ACIPort=20000SpiderCycles=-1SpiderRepeatSecs=86400SpiderStartTime=03:00ReferenceIsURL=trueGetAttachments=trueDatabase=NewsImportBreaking=ONImportBreakingMinParagraphWords=300ImportBreakingMaxParagraphWords=500ImportBreakingMinDocWords=500ImportMinLengthWords=10ImportMinLength=100IndexOverSocket=trueIndexPath=c:\Autonomy\NotesFetchImportPath=c:\Autonomy\NotesFetch

[Passwords]PasswordUserIdFile0=c:\lotus\notes\data\userA.idPasswordUserIdFile1=c:\lotus\notes\data\userB.id

PasswordEncrypted0=9t3M3t7awtPasswordEncrypted1=sef4346td

[Notes]Number=10=FinanceData1=ProductionData

[FinanceData]NotesDB=Finance.nsfMapAll=trueFilterByView=trueNotesView=All Pages

[ProductionData]NotesDB=Production.nsfMapAll=falseFilterByView=trueNotesView=All PagesGetattachments=falseNotesField0=DepartmentDREField0=ProductionDepartment


3 Configuring Notes ConnectorEncrypting Passwords

Encrypting 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.

Windows Operating Systems1. In the installation directory, double-click autpassword.exe to display the Autonomy

Password Encryption Utility.

2. In the Plaintext Password field, enter the password.

3. Click Encrypt. The encrypted version of the password appears in the Ciphertext Password field.

4. Copy the encrypted password from the Ciphertext Password field to the configuration field in the Dashboard Console or the parameter in the configuration file.

5. Click Close to exit the Autonomy Password Encryption Utility.

UNIX Operating Systems1. Open a terminal window.

2. Type ./autnpassword.exe and press Enter.

3. Type the password you want to encrypt and press Enter.

The encrypted password appears.

4. Copy the password to the configuration field in the Dashboard Console or the parameter in the configuration file.


3 Configuring Notes ConnectorSetting Up Log Streams

Setting 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.

For details on the logging parameters and on how to configure them, see the Notes Connector online help.

To set up log streams:

1. Open the configuration file in a text editor.

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]0=INDEX_LOG_STREAM1=ACTION_LOG_STREAM2=APP_LOG_STREAM3=FAILURELIST_LOG_STREAM4=IMPORT_LOG_STREAM

In this example, four log streams are defined which report index, query, application, and import 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:

[INDEX_LOG_STREAM][ACTION_LOG_STREAM][APP_LOG_STREAM][FAILURELIST_LOG_STREAM][IMPORT_LOG_STREAM]

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


3 Configuring Notes ConnectorSetting Up Log Streams

logging), whether log messages should be displayed on the console, the maximum size of log files, and so on.

For example:

[INDEX_LOG_STREAM]logfile=logs/index.logloghistorysize=50logtime=truelogecho=falsemaxlogsizekbs=1024logtypecsvs=indexloglevel=full

[ACTION_LOG_STREAM]logfile=logs/action.logloghistorysize=50logtime=truelogecho=falsemaxlogsizekbs=1024logtypecsvs=actionloglevel=full

[APP_LOG_STREAM]logfile=application.logloghistorysize=50logtime=truelogecho=falsemaxlogsizekbs=1024logtypecsvs=applicationloglevel=full

[FAILURELIST_LOG_STREAM]LogFile=failurelist.logLogTypeCSVs=FAILURELISTLogLevel=FULL

[IMPORT_LOG_STREAM]LogFile=import.logLogLevel=FULLmaxlogsizekbs=1024

6. Save and close the configuration file.

7. Restart the service to execute your changes.


3 Configuring Notes ConnectorAdding a Site to the Notes Connector

Adding a Site to the Notes Connector

To add a site to Notes Connector using the Dashboard Console:

1. In the Dashboard Console, stop the connector service. See “Stopping a Connector” on page 60.

2. Select the connector you want to configure in the left frame, and select the Configuration tab.

3. Right click the Connector Jobs folder, and select Add Connector ‘job’ configuration.

4. In the Add Connector ‘job’ configuration dialog, enter the name of a new job and click OK. For example, NewJob.. The name you choose must be unique and contain no spaces.

5. Restart Notes Connector to execute your changes. See “Starting a Connector” on page 60.

To add a site to Notes Connector using the configuration file:

1. Stop the connector service. See “Stopping a Connector” on page 60.

2. Open the Notes Connector configuration file in a text editor.

3. Find the [Notes] section.

4. Increase the Number setting by one and create a new [JobName] section for the site after the final [JobName] section currently in the configuration file.

For example:

[Notes]Number=10=FirstJob

[FirstJob]Prefix=http://193.128.174.142/NotesServer=ServerName/AutonomyNotesDB=domguide.nsfNotesTitleField=TitleNotesView=ALL

The above [Notes] section lists one site.

To add a new site, change the value of the Number parameter and add a new [JobName] Section, specifying the settings for your new site. The list entry in the [Notes] section must correspond exactly to the title of the [JobName] Section.


3 Configuring Notes ConnectorAccessing Notes Documents Using IDOL Server Records

[Notes]Number=20=FirstJob1=NewJob

[FirstJob]Prefix=http://192.168.23.142/NotesServer=ServerName/AutonomyFinanceNotesDB=domguide.nsfNotesTitleField=TitleNotesView=ALL

[NewJob]Prefix=http://192.168.23.143/NotesServer=ServerName/AutonomyMarketingNotesDB=domguide.nsfNotesTitleField=TitleNotesView=ALLFormMapToContent=true

Note that the individual site sections are in the same order as in the [Notes] list and are numbered in consecutive order, starting from 0.

5. Save and close the configuration file.

6. Restart Notes Connector to execute your changes. See “Starting a Connector” on page 60.

Accessing Notes Documents Using IDOL Server Records

Using the Notes document’s unique ID, you can ensure updated versions of the document replace older versions on IDOL server.

If you want users to be able to refer back to the original Notes document from the IDOL server record in their results list, you must set up Notes Connector and IDOL server to import and index the required data, and configure your front-end application to call the document using a URL composed of IDOL server fields.


3 Configuring Notes ConnectorAccessing Notes Documents Using IDOL Server Records

Importing and Indexing the Required DataIn the IDOL server configuration, create a field into which Notes Connector can index the unique document ID.

Configure Notes Connector to import the unique document ID into the IDOL server field that you have created for this purpose.

Ensure your IDOL server record for each document includes the names of the Notes database and the view for the document.

Calling the DocumentYou can call the original Notes document using a URL in the following format:

Prefix_NotesDB/Notes_View/UniqueId_Postfix

where:

For example:

http://notes/Sales/UKSales/65B9082E41409FEC852565A70008F203?OpenDocument

Prefix (Notes Server hostname): http://notes/

Notes database name: Sales

Notes View: UKSales

Unique ID: 65B9082E41409FEC852565A70008F203

Postfix: ?OpenDocument

You must configure your front-end application to retrieve the Notes database and view names, in addition to the unique ID so your users can open the original document directly from the front-end application.

Prefix The initial part of the URL for your Notes server.

NotesDB The name of the Notes database that contains the document you are calling.

NotesView The name of the view that contains the document you are calling in the Notes database.

UniqueID The unique identifier for the document, stored in the IDOL server record.

Postfix The final part of the URL, usually a command for Notes Server.


3 Configuring Notes ConnectorField Mapping

You can store the record’s unique ID, returned by the Notes formula @DocumentUniqueID, in the IDOL server reference field. This serves to identify the note so that if an updated version is aggregated and indexed, the original is removed. It can also optionally be prefixed and postfixed by a string (given in the Prefix and Postfix fields) to indicate the database and view used. This can also be used to make a URL suitable for referring back to the document using Domino Server.

The URL field will, if the database has been made available on a Domino server at the specified address, be a valid URL for retrieving the original Notes record. The database and view names are automatically inserted into the URL.

Field Mapping

By default, the MapAll parameter is enabled which means Notes Connector maps all Notes fields to an IDOL server field of the same name (with the exception of the unsupported fields listed in Table 3-1).

You can specify exceptions to this mapping using pairs of DREField and NotesField parameter settings, as well as, the NotesTitleField, NotesContentField, and NotesFieldSrcName parameters. For more information on specific parameters, see “Field Mapping Parameters” on page 79.

For example:

DREField0=BookNameNotesField0=BookDREField1=AuthorNotesField1=DocumentAuthor

The parameters must be numbered sequentially starting at 0 (zero). This enables you to specify any number of fields.

Alternatively, you can disable the spider’s MapAll parameter. In this case, only fields specified by pairs of DREField and NotesField parameters are indexed.

Note For both of these cases, you must configure appropriate field names in IDOL server.



The following Notes field types are not mapped when MapAll is enabled:

Extracting a Notes Field and Mapping to an IDOL Server FieldNotes Connector can handle mapping Notes fields to attachments. Notes Connector can extract the Notes field and add to its attachments in the usual way at import time.

For example, if a date is to be extracted from a specific Notes field and mapped to the DREDATE field, the following settings are needed:

ImportExtractDateFrom=16 ImportExtractDateFormatCSVs=LONGMONTH D+, YYYYImportExtractDateFrom=MyNoteDateImportExtractDateToField=DREDATEImportExtractDateToFormat=YYYY/MM/DD

Table 3-1 Unsupported Notes Field TypesTYPE_ACTION TYPE_ASSISTANT_INFO

TYPE_CALENDAR_FORMAT TYPE_COLLATION

TYPE_COMPOSITE TYPE_ERROR

TYPE_FORMULA TYPE_HIGHLIGHTS

TYPE_HTML TYPE_ICON

TYPE_INVALID_OR_UNKNOWN TYPE_LSOBJECT

TYPE_NOTELINK_LIST TYPE_NOTEREF_LIST

TYPE_NUMBER_RANGE TYPE_OBJECT

TYPE_QUERY TYPE_SCHED_LIST

TYPE_SEAL TYPE_SEAL_LIST

TYPE_SEALDATA TYPE_SIGNATURE

TYPE_TEXT TYPE_TEXT_LIST

TYPE_TIME TYPE_TIME_RANGE

TYPE_UNAVAILABLE TYPE_USERDATA

TYPE_USERID TYPE_VIEW_FORMAT

TYPE_VIEWMAP_DATASET TYPE_VIEWMAP_LAYOUT

TYPE_WORKSHEET_DATA



Launching the Notes Client Application from an Autonomy Results List

If you do not want to use a Domino Server when viewing your Notes document, you must launch the Notes client application. To launch the Notes client application from an Autonomy results list, you must enter the following settings in the Notes Connector configuration file:

[Default]ReferenceIsLaunch=trueReferenceIsURL=falseLaunchPrefix=http://yourserver/Scripts/delivernotes.exe?LaunchPostFix=

You must ensure you have the reformatting script, delivernotes.exe, and that it is stored in a Web server scripts directory. The delivernotes.exe script takes the URL passed to it, which contains all the information required to launch the Notes client on the correct page, and reformats it with all the static tags required by Notes. It returns the document with the appropriate content type for the client to launch the Notes launch utility.

The Notes launch utility is called notesfire.exe, which is installed by an installer of the same name. The installer for the Notes launch utility modifies the registry so that if an NDL document is returned (from delivernotes.exe in our case) the Notes launch utility notesfire.exe is run. You need to install this patch on every client machine that uses this method of viewing Notes documents.


4 Starting and Stopping Notes Connector

This chapter explains how to start and stop the Notes Connector. It includes the following sections:

Starting a Connector

Stopping a Connector

59

4 Starting and Stopping Notes ConnectorStarting a Connector

Starting a 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. Display the Windows Services dialog.

2. Select the ConnectorInstallName service, and click the Start button.

3. Click the Close button to close the services dialog.

To start the connector using the UNIX Start script:1. Change to the Installation directory.

2. Enter the following command:

./startconnector.sh

If you want to check the Notes Connector service is running, enter the following command:

ps -aef | grep InstallName

This command returns the Notes Connector service process ID number if the service is running.

Stopping a Connector

Stop a connector from running by using one of the following methods:

To stop the connector using Windows Services:1. Display the Windows Services dialog.

2. Select the ConnectorInstallName service, and click Stop.

3. Click Close to close the services dialog.


4 Starting and Stopping Notes ConnectorStopping a Connector

To stop the connector service by sending a command to the service port:Enter the following command in the address bar of your browser.

http://host:ServicePort/action=stop

where,

To stop the connector using the UNIX Stop script:1. Change to the Installation directory.

2. Enter the following command:

./stopconnector.sh

To stop the connector using the UNIX kill command:1. Determine the Notes Connector process ID number with the command:

ps –aef | grep InstallName

2. Stop the Notes Connector process with the command:

kill -2 ProcessID

where ProcessID is the process ID you determined in the previous step.

Note You must not stop Notes Connector when it is performing a Notes API call. You must wait until the string Spider: complete appears in the log file to avoid problems when you start Notes Connector again.

host The IP address (or name) of the machine on which the Notes Connector is running.

ServicePort The Notes Connector service port (specified in the [Service] section of the Notes Connector configuration file).


4 Starting and Stopping Notes ConnectorStopping a Connector


II Parameter and Command Reference

This section describes configuration parameters and action commands used by the Notes Connector.

Chapter 5: Notes Connector Parameters

Chapter 8: Service Configuration Parameters

Chapter 6: License Configuration Parameters

Chapter 7: Logging Configuration Parameters

Chapter 9: Service Action Commands

Note For information on Import Module parameters, refer to the Import Module Administrator Guide.

63

5 Notes Connector Parameters

This chapter describes the configuration parameters that determine how the Notes Connector operates. Use the IDOL Console to modify these parameters according to your needs.

Attachment Parameters

Cleaning Parameters

Database Parameters

Deleting Content Parameters

Field Mapping Parameters

Form Parameters

Formula Parameters

Global Parameters

IDOL Server Parameters

Indexing Parameters

Notes Parameters

Password Parameters

Security Parameters

Viewing Parameters

65

5 Notes Connector ParametersAttachment Parameters

Attachment Parameters

AttachmentCantHaveCSVsSpecify one or more strings that an attachment file name must not contain for the attachment to be extracted. Use AttachmentMustHaveFlags to specify whether the connector performs a case-sensitive match when checking the attachment file name.

To specify multiple strings, separate them with commas (with no space before or after a comma).

AttachmentCantHaveFlagsEnter a bitwise mask number that specifies how the attachment file name matches the strings specified in AttachmentCantHaveCSVs.

Enter 1 to perform a case-sensitive match or 2 for a case-insensitive match.

Type: StringDefault: NoneRequired: NoConfiguration Section:

Default and Connector Job

Example: AttachmentCantHaveCSVs=html,xml

Use AttachementCantHaveFlags to specify whether the connector performs a case-sensitive match when checking the attachment file name. In this example, the connector checks for the strings html or xml in the attachment file name.

See Also “AttachmentCantHaveFlags” on page 66

Type: LongDefault: 1Required: NoAllowed Values:

Minimum: 1Maximum: 2



AttachmentCopyToDirectoryEnter a directory to which attachments are copied.

AttachmentMatchEnter a string the name of an attachment must contain for the connector to import it. You can enter either a complete name or part of a name by using wildcards. Use the AttachmentMatchField parameter to specify the Notes Database field in which to search for the AttachmentMatch string. To enter multiple strings, separate them with commas (with no space before or after a comma).

To use this parameter, you must enable GetAttachments.

Configuration Section:


Example: AttachmentCantHaveFlags=2

In this example, the connector checks the attachment file names for case-insensitive matches of any of the AttachmentCantHaveCSVs strings. If the file name contains one of the AttachmentCantHaveCSVs strings, the connector discards the file.

See Also: “AttachmentCantHaveCSVs” on page 66



Example: AttachmentCopyToDirectory=C:\Autonomy\NotesFetch\Attachments\

In this example, attachments extracted by the connector are copied to C:\Autonomy\NotesFetch\Attachments\.

See Also: “AttachmentCantHaveCSVs” on page 66



AttachmentMatchFieldEnter the field name in which to search for the AttachmentMatch string.



Example: Getattachments=trueAttachmentMatch=mydoc* Dbname=AttachmentDocs

In this example, the connector imports all attachments whose name starts with mydoc, and indexes them into the AttachmentDocs database.

See Also: “GetAttachments” on page 71“AttachmentMatchField” on page 68



Example: Getattachments=trueAttachmentMatch=mydoc* AttachmentMatchField=DocumentDbname=AttachmentDocs

In this example, the connector imports attachments whose name starts with mydoc and is contained in the Notes database field Document. The connector then indexes the attachments into the AttachmentDocs database in the IDOL server.

See Also: “AttachmentMatch” on page 67



AttachmentMaxSizeEnter the maximum size of attachments that are fetched. Attachments that are larger than this setting are not fetched.

AttachmentMustHaveCSVsEnter one or more strings that an attachment file name must contain for the attachment to be extracted. Use AttachmentMustHaveFlags to specify whether the connector performs a case-sensitive match when checking the attachment file name.

To enter multiple strings, separate them with commas (with no space before or after a comma).

Type: LongDefault: NoneRequired: NoConfiguration Section:


Example: AttachmentMaxSize=10000

See Also:



Example: AttachmentMustHaveCSVs=news,email

In this example, the connector checks for the strings news or email in the attachment file name. If a file name does not contain at least one of these strings, the connector discards it.

See Also: “AttachmentMustHaveFlags” on page 70



AttachmentMustHaveFlagsEnter a bitwise mask number that specifies how the attachment file name matches the strings specified in AttachmentMustHaveCSVs.

Enter 1 to perform a case-sensitive match or 2 for a case-insensitive match.

AttachmentUseNoteTitleEnter true to use the Notes title for attachments in the IDX file.

Type: LongDefault: 1Required: NoAllowed Values:




Example: AttachmentMustHaveFlags=2

In this example, the connector checks the attachment file names for case-insensitive matches of any of the AttachmentMustHaveCSVs strings. If the file name does not contain one of the AttachmentMustHaveCSVs strings, the connector discards the file.

See Also: “AttachmentMustHaveCSVs” on page 69

Type: BooleanDefault: FalseRequired: NoConfiguration Section:


Example: AttachmentUseNoteTitle=true



CheckAttachNameDuplicateEnter true to check for duplicate attachment names. Attachments with the same file name appear with the original file name attached to the unique name in the following format: Unique_Filename/Original_Filename. To use this parameter, you must enable GetAttachments.

GetAttachmentsEnter true to fetch documents and their attachments from the Notes database. To only fetch attachments, set GetAttachmentsOnly to true.

Note The IDOL server record for an imported and indexed attachment contains the reference for the original Note to which the attachment is attached.



Example: CheckAttachNameDuplicate=false

See Also: “GetAttachments” on page 71

Type: BooleanDefault: TrueRequired: NoConfiguration Section:


Example: GetAttachments=true

See Also: “GetAttachmentsOnly” on page 72


5 Notes Connector ParametersCleaning Parameters

GetAttachmentsOnlyEnter true to retrieve attachments, but not the documents to which they are attached. To use this parameter, you must enable GetAttachments.

Cleaning Parameters

CleanNotesClientIf you are running Notes Connector on Windows, set CleanNotesClient to true to close any Lotus Notes applications before the connector runs. This terminates any Notes applications that did not shut down properly.

Note This closes any currently open Notes applications before the connector runs.



Example: GetAttachmentsOnly=true

See Also: “GetAttachments” on page 71


Default

Example: CleanNotesClient=false


5 Notes Connector ParametersCleaning Parameters

FieldsToCleanCSVsEnter the names of one or more Notes fields from which you want to clean carriage returns and new lines before they are indexed into their equivalent IDOL server database fields. To enter multiple fields, separate them with commas (there must be no space before or after a comma).

StripFileNamesEnter true to remove invalid characters from file names.

StripHTMLContentEnter true to strip HTML from Notes fields that are imported.



Example: FieldsToCleanCSVs=DocumentTitle,Author,DocumentReference

In this example, any carriage returns and new lines contained in the DocumentTitle, Author, and DocumentReference fields are removed before the fields are indexed into their equivalent IDOL server database fields.



Example: StripFileNames=true

Type: BooleanDefault: False


5 Notes Connector ParametersDatabase Parameters

Database Parameters

DatabaseDirectoryEnter the name of a Notes database directory containing the databases from which the connector fetches documents. The Notes Connector aggregates documents from all the databases in this directory, rather than just the database specified in the NotesDB parameter.

Note This parameter is useful for a Lotus Domino Document Manager or Lotus QuickPlace installation.

DatabaseDirectoryCantHaveCSVsEnter one or more strings the databases specified in the DatabaseDirectory parameter must not contain for their documents to be aggregated by Notes Connector. To enter multiple strings, separate them with commas (with no space before or after a comma).


Required: NoConfiguration Section:


Example: StripHTMLContent=true



Example: DatabaseDirectory=c:\mynotes

See Also: “NotesDB” on page 102



DatabaseDirectoryDeleteFieldEnter a name for the field that determines whether the documents in a Notes database are deleted from the IDOL server. The field is created when a name is entered; this is not a pre-existing field. The IDOL server configuration file must include this reference field, using the same name.

When Notes Connector imports a Notes document into IDX file format, it creates this field in the IDX file and stores the unique name of the Notes database that contains the document in this field. The IDOL server stores the field as a reference field.

Every time Notes Connector cycles, it checks whether any databases have been deleted from the Notes database. If a database has been deleted, it checks the DatabaseDirectoryDeleteField field in the IDOL server for the unique name of the deleted database. It identifies all documents stored in the deleted database by matching their DatabaseDirectoryDeleteField field to the name of the deleted database. It deletes the documents, ensuring the IDOL server content matches the Notes database.




Example: DatabaseDirectoryCantHaveCSVs=/help,/ref

In this example, the connector checks for the strings /help or /ref (as part of a word or a whole word) in the name of the database directory specified in DatabaseDirectory. If the name contains one of these strings, the connector discards it.

See Also: “DatabaseDirectory” on page 74“DatabaseDirectoryMustHaveCSVs” on page 76

Type: StringDefault: _DATABASE_



DatabaseDirectoryJobFileEnter the name of the file in which you want to store a list of active databases on the server. By default this is Recurse.dat.


DatabaseDirectoryMustHaveCSVsEnter one or more strings the databases specified in the DatabaseDirectory parameter must contain for their documents to be aggregated by Notes Connector. To enter multiple strings, separate them with commas (with no space before or after a comma).




Example: DatabaseDirectoryDeleteField=_DATABASE_



Example: DatabaseDirectoryMustHaveCSVs=documents,mmain.nsf

In this example, the connector checks for the strings documents or main.nsf (as part of a word or a whole word) in the name of the database directory specified in DatabaseDirectory. If the name does not contain at least one of these strings, the connector discards it.

See Also: “DatabaseDirectory” on page 74“DatabaseDirectoryCantHaveCSVs” on page 74


5 Notes Connector ParametersDeleting Content Parameters

DatabaseDirectoryRecurseSet DatabaseDirectoryRecurse to true to aggregate documents from databases contained in the sub directories of the database specified in the DatabaseDirectory parameter, as well as in the specified DatabaseDirectory itself.


Deleting Content Parameters

DeleteAddJobNameSet to true to add a job name to the delete command.



Example: DatabaseDirectoryRecurse=false

See Also: “DatabaseDirectory” on page 74



Example: DeleteAddJobName=true


5 Notes Connector ParametersDeleting Content Parameters

DeleteByFieldEnter a name for the field that determines whether a Notes document is deleted from the IDOL server. The field is created when a name is entered; this is not a field that already exists.

The IDOL server configuration file must also contain a reference field with the same name.

When Notes Connector imports a Notes document into IDX file format, it creates this field in the IDX file and stores the unique number of the Notes document in this field. The IDOL server stores the field as a reference field.

Every time Notes Connector cycles, it checks whether any documents have been deleted from the Notes database.If a document has been deleted, it checks the DeleteByField field in the IDOL server for the unique number of the deleted document. It identifies the document that was deleted from the Notes database by matching its DeleteByField field to the number of the deleted document. It deletes the document, ensuring the IDOL server's content matches the Notes database.

DeleteFromDreEnter true to delete a document from IDOL server automatically if the original document is removed from the Notes database.



Example: DeleteByField=DELFIELD



Example: DeleteFromDre=true


5 Notes Connector ParametersField Mapping Parameters

Field Mapping Parameters

DreFieldEnter the name of the field in IDOL server to which the Notes database field specified in the NotesField parameter is mapped. The fields must be numbered sequentially starting at 0 (zero).

MapAllEnter true to map fields in the Notes database to fields of the same name in the IDOL server database. You can use DREField and NotesField to specify exceptions. See “Field Mapping” on page 56 for more information.

Enter false to map only the fields specified using the DREField and NotesField.



Example: NotesField0=notes_authorDreField0=DREAUTHORNotesField1=notes_titleDreField1=DRETITLE

In this example, the contents of the notes_author and notes_title fields in the Notes database are indexed into the DREAUTHOR and DRETITLE fields, respectively, in IDOL server.

See Also: “NotesField” on page 80

Type: BooleanDefault: TrueRequired: No



NotesContentFieldEnter the name of one or more fields you want to use to form the content of the IDX file the connector indexes into the IDOL server. To specify multiple fields, separate them with commas (there must be no space before or after a comma).

NotesFieldEnter the name of the field in the Notes database that is mapped to the IDOL server field specified in the DREField parameter. The fields must be numbered sequentially starting at 0 (zero).



Example: MapAll=false

See Also: “DreField” on page 79“NotesField” on page 80



Example: NotesContentField=Header,Body

In this example, the contents of the Header and Body field in the Notes database is used to form the content of the IDX file that is indexed into the DRECONTENT field.

Type: StringDefault: NoneRequired: No



NotesFieldSrcNameEnter the name of the Notes form from which the Notes fields specified in NotesField are retrieved. The fields must be numbered sequentially starting at 0 (zero). If this parameter is not specified the Notes fields are retrieved from all documents.



Example: NotesField0=notes_authorDreField0=DREAUTHORNotesField1=notes_titleDreField1=DRETITLE

In this example, the contents of the notes_author and notes_title fields in the Notes database are indexed into the DREAUTHOR and DRETITLE fields, respectively, in IDOL server.

See Also: “DreField” on page 79“NotesFieldSrcName” on page 81


Connector Job

Example: NotesField0=notes_authorDreField0=DREAUTHORNotesField1=notes_titleDreField1=DRETITLENOTESFIELDSRCNAME0=Form2

In this example, the contents of the notes_author and notes_title fields in the Notes form called Form2 are indexed into the DREAUTHOR and DRETITLE fields, respectively, in IDOL server.

See Also: “NotesField” on page 80“DreField” on page 79


5 Notes Connector ParametersForm Parameters

Form Parameters

FormMapToContentEnter true to index the fields in the Notes form specified in the NotesForm parameter into the DRECONTENT field in the IDOL server. The form field values are added to the end of the DRECONTENT field.

NotesFormEnter the name of the Notes form containing the fields you want to index into the IDOL server as document content. To specify this setting, you must also set FormMapToContent to true.



Example: FormMapToContent=trueNotesForm=MyForm

In this example, the content that is indexed into the IDOL server consists of the fields in the MyForm form.

See Also: “NotesForm” on page 82



Example: FormMapToContent=trueNotesForm=MyForm

In this example, the content that is indexed into the IDOL server consists of the fields in the MyForm form.

See Also: “FormMapToContent” on page 82


5 Notes Connector ParametersFormula Parameters

Formula Parameters

ExecuteNotesFormulaEnter true to execute the Notes formula specified in the NotesFormula parameter, extracting metadata from Notes documents. The extracted data is stored in the field specified in the NotesFormulaTo parameter.

NotesFormulaEnter a Notes formula to execute. The data returned from this formula is stored in the field specified in the NotesFormulaTo parameter. The parameters must be numbered sequentially starting at 0 (zero).

To use this parameter, you must enable the ExecuteNotesFormula parameter.



Example: ExecuteNotesFormula=trueNotesFormula0=@ModifiedNotesFormulaTo0=NotesModifiedDate

See Also: “NotesFormula” on page 83“NotesFormulaTo” on page 84“NotesFormulaSrcName” on page 84



5 Notes Connector ParametersFormula Parameters

NotesFormulaToEnter the name of the field that stores the content returned for the Notes formula specified in the NotesFormula parameter. The parameters must be numbered sequentially starting at 0 (zero).

NotesFormulaSrcNameEnter the Notes form name against which the Notes formula specified in NotesFormula is executed. The fields must be numbered sequentially starting at 0 (zero). If this parameter is not specified, the Notes formula is executed against all documents.




See Also: “ExecuteNotesFormula” on page 83“NotesFormulaTo” on page 84“NotesFormulaSrcName” on page 84




See Also: “ExecuteNotesFormula” on page 83“NotesFormula” on page 83“NotesFormulaSrcName” on page 84



5 Notes Connector ParametersGlobal Parameters

ViewFormulaEnter a formula from which to create a view of the Notes database to be spidered when FilterByView is enabled. If FilterByView is enabled, and you do not set ViewFormula, the connector creates a formula from the view.

Global Parameters

FetchDurationEnter the maximum length of time the connector runs during a cycle. The connector cycle finishes either after this length of time or when all connector jobs are complete (whichever occurs first). Any Notes Connector jobs that are not completed during a cycle are handled at the start of the next cycle.


Connector Job

Example: ExecuteNotesFormula=trueNotesFormula0=@ModifiedNotesFormulaTo0=NotesModifiedDateNotesFormulaSrcName0=Form1

See Also: “ExecuteNotesFormula” on page 83“NotesFormula” on page 83“NotesFormulaTo” on page 84



Example: ViewFormula=SELECT (@Contains(Subject; "1"))

See Also: “FilterByView” on page 99



You can enter one of the following options:

FullSearchForDeleteEnter true to enable the connector to perform a full search to find deleted notes. When FullSearchForDelete is set to true, Notes Connector searches all documents in the entire database every cycle to find recently added, modified, or deleted documents regardless of whether the view has changed.

Type: StringDefault: 12 monthsRequired: NoConfiguration Section:

Default

Example: FetchDuration=1 month

Option Description

N or N seconds The number of seconds you want the connector to run. For example, if you enter 3600 or 3600 seconds, the connector runs for a maximum of one hour every cycle (1 hour=3600 seconds).

N minutes The number of minutes you want the connector to run. For example, if you enter 30 minutes, the connector runs for a maximum of 30 minutes every cycle.

N hours The number of hours you want the connector to run. For example, if you enter 1 hour, the connector runs for a maximum of an hour every cycle.

N days The number of days you want the connector to run. For example, if you enter 1 day, the connector runs for a maximum of a day every cycle.

N months The number of months you want the connector to run. For example, if you enter 1 month, the connector runs for a maximum of a month every cycle.

Type: BooleanDefault: false



Example: FullSearchForDelete=true



ImportPathEnter the full path to the location where IDX files are created. By default, IDX files are created in the main connector installation directory.

SpiderCyclesEnter the number of times the connector attempts to retrieve documents. If you want the connector to operate indefinitely, enter –1.

Type: StringDefault: ./



Example: ImportPath=C:\autonomy

Type: LongDefault: -1Required: NoAllowed Range: Minimum: -1

Maximum: 2000000000Recommended Range:

Minimum: -1Maximum: 2000000000


Default

Example: SpiderCycles=2



SpiderRepeatIntervalEnter the amount of time from the start of one spider cycle to the start of the next spider cycle. If both SpiderRepeatSecs and SpiderRepeatInterval are specified, the value in SpiderRepeatSecs is used. You can enter one of the following options:

Note If you enter a number without specifying a qualifier, the connector assumes the unit is seconds.

Option Description

n seconds Enter the number of seconds between spider cycles. For example, if you enter 3600 seconds, the spider runs every hour (1 hour=3600 seconds).

n minutes Enter the number of minutes between spider cycles. For example, if you enter 10 minutes, the spider runs every 10 minutes.

n hours Enter the number of hours between spider cycles. For example, if you enter 1 hour, the spider runs every hour.

n days Enter the number of days between spider cycles. For example, if you enter 1 day, the spider runs every day.

n weeks Enter the number of weeks between spider cycles. For example, if you enter 1 week, the spider runs every week.

n months Enter the number of months between spider cycles. For example, if you enter 1 month, the spider runs every month.


Default

Example: SpiderRepeatInterval=12 hours

See Also: “SpiderRepeatSecs” on page 89



SpiderRepeatSecsEnter the number of seconds from the start of one spider cycle to the start of the next spider cycle. If both SpiderRepeatSecs and SpiderRepeatInterval are specified, the value in SpiderRepeatSecs is used.

SpiderStartTimeEnter the time when the connector will start. Use the 24-hour clock (hh:mm) to specify the start time. To start the connector immediately when the connector service starts, enter now.

Type: LongDefault: 86400Required: NoAllowed Range: Minimum: 0




Default

Example: SpiderRepeatSecs=30

See Also: “SpiderRepeatInterval” on page 88

Type: StringDefault: nowRequired: NoConfiguration Section:

Default

Example: SpiderStartTime=03:00


5 Notes Connector ParametersIDOL Server Parameters

StatusFileEnter the name of the status file which records all the jobs the connector runs.

IDOL Server Parameters

ACIPortThe IDOL server ACI port the connector uses to query IDOL server. This is the value specified in the ACIPort parameter in the IDOL server configuration file's [Server] section. To enter multiple ports, separate them with commas (there must be no space before or after a comma).

Type: StringDefault: fetch.statusRequired: NoConfiguration Section:

Default

Example: StatusFile=fetch.status

Type: LongDefault: NoneRequired: NoAllowed Range: Minimum: 1





Example: ACIPort=20010,20020

See Also: “DreHost” on page 91


5 Notes Connector ParametersIDOL Server Parameters

DatabaseEnter the name of the IDOL server database into which you want the connector to index documents.

DreHostEnter the IP address or name of the machine on which IDOL server is running. This is the server into which the connector indexes the documents it aggregates.

Note If the IDOL server and connector are installed on different computers and documents are indexed over a network, enable IndexOverSocket.

Type: StringDefault: NoneRequired: YesConfiguration Section:


Example: Database=Notes

See Also: “DreHost” on page 91



Example: DREHost=123.4.5.67

See Also: “Database” on page 91“IndexOverSocket” on page 95


5 Notes Connector ParametersIndexing Parameters

Indexing Parameters

BatchProcessSpecifies when IDX or XML files are indexed into IDOL server. Enter one of the following:

:

BatchSizeEnter the number of files aggregated before they are imported or indexed (as specified by BatchProcess).

Import After the connector has aggregated the number of files specified by the BatchSize parameter, it imports the content into IDX or XML file format. It repeats this process until all files are imported, and then indexes the generated IDX or XML files into IDOL server.

Index After the connector has aggregated the number of files specified by the BatchSize parameter, it imports the content into IDX or XML file format and indexes the generated IDX or XML file into IDOL server. It repeats this process until all files are imported and indexed.

You should use Index mode when you are aggregating a large amount of data into IDOL server, or when you want the documents to be available to your users before the spidering process ends.

Type: StringDefault: ImportRequired: NoConfiguration Section:


Example: BatchProcess=Index

See Also: “BatchSize” on page 92


Maximum: 2000000000



IndexDirectoryIf the parameter IndexToFile is set to true, enter the path to the directory in which the connector stores output files.

IndexModePrevents documents or document content from being stored in IDOL server more than once. If you do not set IndexMode, it defaults to the value specified in KillDuplicates in the IDOL server configuration file's [Server] section.

Recommended Range:




Example: BatchSize=150

See Also: “BatchProcess” on page 92



Example: IndexDirectory=C:\Autonomy\Index

See Also: “IndexToFile” on page 95

Type: StringDefault: REFERENCERequired: NoConfiguration Section:


Example: IndexMode=REFERENCEMATCH80



Enter one of the following options to determine how IDOL server handles duplicate content:

Option Description

None Documents in IDOL server are never replaced with new documents.

FieldName If the connector downloads a document containing a FieldName Reference field with the same content as the FieldName Reference field in a document already stored in IDOL server, the document contained in IDOL server is deleted and replaced with the new document.

You can specify multiple Reference fields, in which case, IDOL server deletes documents containing any of the specified fields with identical content. To specify multiple Reference fields, separate them with a plus symbol, a space, or an underscore symbol.

Fields are identified as Reference fields through field processes in the IDOL server configuration file. If you use a FieldName Reference field to eliminate duplicate documents, IDOL server automatically reads any fields listed alongside this field for the PropertyFieldCSVs parameter in the field process, and also uses these fields to eliminate duplicate documents. If you want to define multiple Reference fields but do not want them all to be used for document elimination, you must set up multiple field processes.

Reference If the connector downloads a document with the same DREREFERENCE field value as a document already stored in IDOL server, the document contained in IDOL server is replaced with the new document.

ReferenceMatchN If the connector downloads a document in which N percent or more of the content is similar to the content of a document already stored in IDOL server, the document contained in IDOL server is replaced by the new document. This parameter only replaces the document stored in the IDOL server into which the fetch is indexing.

For example, if you set IndexMode to REFERENCEMATCH80, and the connector downloads a document in which 80 percent or more of the content is similar to a document already stored in IDOL server, the document in IDOL server is replaced by the new document.

Reference2MatchN If the connector downloads a document in which N percent or more of the content is similar to the content of a document already stored in IDOL server, the document contained in IDOL server is replaced with the new document. Unlike ReferenceMatchN, Reference2MatchN checks across all available IDOL servers.

For example, if you set IndexMode to Reference2Match80, and the connector downloads a document in which 80 percent or more of the content is similar to any document stored in any IDOL server databases, all instances of the document in any IDOL server database are replaced by the new document.



When you specify an IndexMode option, note the following:

If you postfix any of these options with =2, the KillDuplicates process is applied to all IDOL server databases (rather than just the database into which the current IDX or XML file is indexed).

If you are using Notes Connector in a system that contains the DIH, and the DIH’s DistributeByReference option is set to true, then the only valid settings for IndexMode are None or Reference.

IndexOverSocketEnter true when the IDOL server and connector are installed on different computers and documents are indexed over a network.

Enter false when the IDOL server and connector are installed on the same computer and documents are indexed locally.

IndexToFileEnter true to send data the connector fetches to the specified IndexDirectory.

Enter false to send data the connector fetches to IDOL server.



Example: IndexOverSocket=true



Example: IndexToFile=true

See Also: “IndexDirectory” on page 93


5 Notes Connector ParametersNotes Parameters

Notes Parameters

CaseSensitiveDetermines whether Notes field names are case-sensitive.

CharsetConvTablesDirectoryEnter the path to the directory in which the files used for converting filenames to Unicode are stored.



Example: CaseSensitive=false

Type: StringDefault: ./convtablesRequired: NoConfiguration Section:


Example: CharsetConvTablesDirectory=c:\NotesConnector\ConvTables

See Also: “ConvertFileNames” on page 97



CheckViewChangedEnables Notes Connector to detect whether a formula has changed. If enabled, the connector imports notes that are in the new view and deletes any notes that are in the old view. If disabled, the connector imports notes that are in the new view but does not delete notes that are in the old view.

CheckViewsEnter true to store the data from views.

ConvertFileNamesEnter true if you want Notes Connector to convert any filenames it has extracted to Unicode. The temporary files created by the connector when converting filenames are stored in the directory specified in CharsetConvTablesDirectory.



Example: CheckViewChanged=true



Example: CheckViews=false

Type: BooleanDefault: TrueRequired: No



DominoDocAllVersionsEnter true to specify the IsDominoDotDoc parameter applies to all versions of Lotus Domino Document Manager when IsDominoDotDoc is enabled.

DreTypeEnter the type of notes files to be polled.



Example: ConvertFileNames=false

See Also: “CharsetConvTablesDirectory” on page 96



Example: DominoDocAllVersion=true

See Also: “IsDominoDotDoc” on page 101

Type: StringDefault: textRequired: NoConfiguration Section:


Example: DreType=text



EscapeReferencesEnter to true to enable the connector to use escaped URLs.

FilterByViewEnter true to filter documents by the view of the Notes database specified in the NotesView or ViewFormula parameter. Enter false to retrieve documents from every view of the Notes database.

Note If you enter databases in both NotesView and ViewFormula, only the database entered in ViewFormula is spidered.



Example: EscapeReferences=true

See Also: “IsDominoDotDoc” on page 101



Example: FilterByView=trueNotesView=MyDocuments

In this example, Notes Connector spiders only the MyDocuments view of the Notes database.

See Also: “NotesView” on page 104“ViewFormula” on page 85



ImportHashExtractChildEnter true to hash the file name the connector extracts with types set in the ImportHashedDirType parameter.

ImportHashedDirTypeEnter the hashed directory types if ImportHashExtractChild is enabled. Hashing directories can improve performance if you expect to have a large number of temporary files, because certain operating systems experience slowdown if all temp files are placed in a single directory. The number of subdirectories increases with the setting:

1 = One level of two-digit subdirectories

2 = Two levels of two-digit subdirectories

3 = One level of three-digit subdirectories

4 = Two levels of three-digit subdirectories

Therefore, if the temp directory were C:\Temp and the filename were 123456789.tmp, the temp file would be saved in the following format, depending on the value entered:

1 = C:\Temp\12\3456789.tmp

2 = C:\Temp\12\34\56789.tmp

3 = C:\Temp\123\456789.tmp

4 = C:\Temp\123\456\789.tmp



Example: ImportHashExtractChild=true

See Also: “ImportHashedDirType” on page 100

Type: LongDefault: 0Required: No



IsDominoDotDocEnter true to enable the connector to set up views for Lotus Domino Document Manager.

IsQuickPlaceEnter true to enable the connector to set up views for Lotus QuickPlace.



Allowed Range: Minimum: 0Maximum: 4

Recommended Range:


Example: ImportHashedDirType=2

See Also: “ImportHashExtractChild” on page 100



Example: IsDominoDotDoc=true

See Also: “DominoDocAllVersions” on page 98



Example: IsQuickPlace=true



NotesDBEnter the name of the Notes database from which the connector fetches documents.

This setting is added to the URL in the DREREFERENCE field in the IDOL server database. This URL is used to retrieve and display the original document if ReferencelsURL is set to true. See “Calling the Document” on page 55.

NotesServerEnter the name of the Notes Server from which Notes Connector imports information. Leave this blank if Notes Connector is installed on the same machine that hosts your Notes installation.



Example: NotesDB=mydocs.nsf

See Also: “DatabaseDirectory” on page 74“ReferencelsURL” on page 115



Example: NotesServer=123.4.5.67

See Also: “NotesDB” on page 102



NotesTextOutputFilesEnter true to output the sorted fields to a text file stored in the directory specified in the NotesTextOutputDir parameter.

NotesTextOutputDirEnter the full path to the directory in which the output file is stored when NotesTextOutputFiles is enabled.



Example: NotesTextOutputFiles=true

See Also: “NotesTextOutputDir” on page 103

Type: StringDefault: ./Required: NoConfiguration Section:


Example: NotesTextOutputDir=./

In this example, the Notes text file is stored in the current directory.See Also: “NotesTextOutputFiles” on page 103



NotesTitleFieldEnter the name of the field in the Notes database that is mapped to the Title field in the IDOL server database. To specify multiple strings, separate them with commas (with no space before or after a comma).

NotesViewEnter the view of the Notes database the connector spiders when FilterByView is enabled.


Note To display a list of all available views, open a Notes database in the Notes workspace, and press the Ctrl and Shift keys together.

Type: StringDefault: ./Required: NoConfiguration Section:


Example: NotesTitleField=title1,title2

In this example, two notes title fields title1 and title2 are specified.See Also: “NotesTextOutputFiles” on page 103



Example: NotesView=Index

See Also: “FilterByView” on page 99



NSFIsRootEnter true to set the NSF file as the root when adding information about a note or attachment to the audit XML file. If set to false, the parent note is the root.

NSocketsNumber of sockets a spider can use. If you have a low-bandwidth link to the Internet, you can reduce the number of sockets the connector uses. A maximum of 16 socket connections is recommended for a low-bandwidth situation. If you have a high bandwidth available, you can increased the number of sockets to 256.



Example: NSFIsRoot=false





Notes

Example: NSockets=32



PageDelayEnter the number of milliseconds for which you want Notes Connector to pause after downloading an item.

ProcessInvalidEnter true to generate a blank ndx file when an error occurs while opening a Notes database.






Example: PageDelay=20



Example: ProcessInvalid=true



ShowViewColumnsEnter true to index the view column field.

SingleViewEnter true to get multiple views on the same database.

SkipIfViewNotFoundEnter true to enable the connector to skip a view it fails to find.



Example: ShowViewColumns=true



Example: SingleView=true



Example: SkipIfViewNotFound=true



StoreContentEnter true to store the form content as plain text in the IDOL server. Enter false to store only terms in the IDOL server.

TableSearchEnter true to use a Notes ID table when fetching documents to avoid many deletions.



Example: StoreContent=true



Example: TableSearch=true


5 Notes Connector ParametersPassword Parameters

Password Parameters

PasswordUserIdFileEnter the full path to the location where the user’s ID file is stored.

PasswordEncryptedEnter the encrypted password for the user ID specified in PasswordUserIdFile. The autpassw.exe program, which is located in the Notes Connector installation directory, allows you to encrypt the password. See “Encrypting Passwords” on page 50.


Passwords and Connector Job

Example: PasswordUserIdFile=c:\lotus\notes\data\userA.idPasswordEncrypted=9t3M3t7awt

See Also: “PasswordEncrypted” on page 109

Type: StringDefault NoneRequired: NoConfiguration Section:

Passwords and Connector Job

Example: PasswordUserIdFile=c:\lotus\notes\data\userA.idPasswordEncrypted=9t3M3t7awt

See Also: “PasswordUserIdFile” on page 109


5 Notes Connector ParametersSecurity Parameters

Security Parameters

DebugSecurityEnter true to write security information into a log file.

NotesACLMappingEnter true to import security information and index it into the NotesSecurityField field in the specified IDOL server database.



Example: DebugSecurity=true



Example: NotesACLMapping=trueNotesSecurityField=Security

In this example, Notes Connector imports security information about Notes users from the Notes database, and indexes it into the Security field in the specified IDOL server database.

See Also: “NotesSecurityField” on page 111


5 Notes Connector ParametersSecurity Parameters

NotesSecurityFieldEnter the name of the field in the specified IDOL server database into which you want to index Notes fields security information. To specify this setting, you must also set NotesACLMapping to true.

SecurityUpdateBatchSizeEnter the number of documents to send to the IDOL server at one time when updating the Notes security information in the IDOL server.

Type: StringDefault: AUTONOMYMETADATARequired: NoConfiguration Section:


Example: NotesACLMapping=trueNotesSecurityField=Security

In this example, Notes Connector imports security information about Notes users from the Notes database, and indexes it into the Security field in the specified IDOL server database.

See Also: “NotesACLMapping” on page 110






Example: SecurityUpdateBatchSize=500


5 Notes Connector ParametersViewing Parameters

Viewing Parameters

AttachmentShowNoteEnter true to display the Notes document to which an attachment is attached instead of the attachment itself when you click an attachment link in an Autonomy results list.

LaunchPostfixEnter the postfix for the end of the URL defined in LaunchPrefix.



Example: AttachmentShowNote=true



Example: ReferenceIsLaunch=trueLaunchPrefix=http://Yourserver/scripts/delivernotes.exeLaunchPostfix="end"

See Also: “LaunchPrefix” on page 113“ReferencelsLaunch” on page 114



LaunchPrefixEnter the full path to the delivernotes.exe file. If you have set ReferencelsLaunch to true, this script enables you to view a document in the Notes Client application instead of using a Domino server. You must install the delivernotes.exe in your Web server scripts directory.

PrefixEnter one prefix at the start of a Notes URL with which the connector can perform a URL command; for example, open a document.




Example: ReferenceIsLaunch=trueLaunchPrefix=http://Yourserver/scripts/delivernotes.exeLaunchPostfix="end"

See Also: “LaunchPostfix” on page 112“ReferencelsLaunch” on page 114


Passwords

Example: Prefix=http://

In this example, http:// is inserted at the beginning of the URL.See Also: “Postfix” on page 114

“ReferencelsURL” on page 115



PostfixEnter one postfix at the end of a Notes URL with which the connector can perform a URL command; for example, save a document.


ReferencelsLaunchEnter true to launch the Notes Client application instead of using a Domino Server when viewing Notes documents from an Autonomy results list. If you enter true, LaunchPrefix specifies the full path to the delivernotes.exe script, which enables you to launch the Notes Client application. See “Launching the Notes Client Application from an Autonomy Results List” on page 58.

Enter false to use a Domino Server to view Notes documents from an Autonomy results list. This is the default setting.

You must set either ReferencelsLaunch or ReferencelsURL to true.


Passwords

Example: Postfix="?Savedocument"

In this example, ?SaveDocument is inserted at the end of the URL.See Also: “Prefix” on page 113

“ReferencelsURL” on page 115

Type: BooleanDefault: FalseRequired: No



ReferencelsURLEnter true to use a Domino Server to view Notes documents from an Autonomy results list.

Enter false to launch the Notes Client application instead of using a Domino Server when viewing documents from an Autonomy results list.

You must set either ReferencelsLaunch or ReferencelsURL to true.



Example: ReferencelsLaunch=true

See Also: “LaunchPostfix” on page 112“LaunchPrefix” on page 113“ReferencelsURL” on page 115



Example: ReferenceIsURL=true

See Also: “Prefix” on page 113“Postfix” on page 114“ReferencelsLaunch” on page 114


6 License Configuration Parameters

This chapter describes the License configuration parameters that specify licensing details and are used in the standalone and IDOL with Administration versions of Notes Connector. It contains the following sections:

IDOL with Administration License Parameters

Standalone License Parameters

IDOL with Administration License Parameters

This sections describes the License configuration parameters that specify licensing details and are used in IDOL with Administration.

117

6 License Configuration ParametersIDOL with Administration License Parameters

LicenseServerACIPortACI port of DiSH license server. This must be the Port specified in the DiSH configuration file's [Server] section.

Notes Connector uses this port to request licensing from DiSH.

LicenseServerHostAddress of DiSH host. The IP address (or name) of the machine that hosts the DiSH license server.

Type: LongDefault: 20000

Required: YesAllowed range: Minimum: 0

Maximum: 65536Recommended range:



License

Example: LicenseServerACIPort=20000

See Also: “LicenseServerHost” on page 118“LicenseServerTimeout” on page 119“LicenseServerRetries” on page 119


License

Example: LicenseServerHost=1.23.45.6

See Also: “LicenseServerACIPort” on page 118“LicenseServerTimeout” on page 119“LicenseServerRetries” on page 119


6 License Configuration ParametersIDOL with Administration License Parameters

LicenseServerTimeoutSeconds to timeout when Notes Connector 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 doesn't respond.

LicenseServerRetriesNumber of retries when Notes Connector connects to DiSH. The number of times Notes Connector tries to connect to the DiSH license server.

Type: LongDefault: 120000Required: NoConfiguration Section:

License

Example: LicenseServerTimeout=600000

See Also: “LicenseServerACIPort” on page 118“LicenseServerHost” on page 118“LicenseServerRetries” on page 119

Type: IntegerDefault: 5Required: NoConfiguration Section:

License

Example: LicenseServerRetries=1

See Also: “LicenseServerACIPort” on page 118“LicenseServerHost” on page 118“LicenseServerTimeout” on page 119


6 License Configuration ParametersStandalone License Parameters

Standalone License Parameters

This section describes the License configuration parameters that specify licensing details which are used in the standalone version of Notes Connector. You should not change these settings.

FullIndicates whether you have a full or an evaluation license.

HolderThe name of the license holder.

Type: BooleanDefault: FalseRequired: YesConfiguration Section:

License

Example: Full=on

In this example, the service is fully licensed.


License

Example: Holder=Company



KeyThe license key.

OperationLicensed Operations key to allow additional ACI server operations to be licensed.


License

Example: Key=01234567890


License

Example: Operations=803|87sdhsdf9n94nmsf7oasda987w4yriasunfaasd==


7 Logging Configuration Parameters

This chapter 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 contains the following sections:

LogArchiveDirectory

LogCompressionMode

LogDirectory

LogEcho

LogEncryption

LogEncryptionKeys

LogExpireAction

LogFile

LogLevel

LogLevelMatch

LogMaxLineLength

LogMaxOldFiles

LogMaxSizeKBs

LogOldAction

123

7 Logging Configuration ParametersLogArchiveDirectory

LogOutputLogLevel

LogSysLog

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.

Type: StringDefault: ./archiveRequired: NoConfiguration Section:

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.

Example: LogArchiveDirectory=./archive

See Also: “LogOldAction” on page 133


7 Logging Configuration ParametersLogCompressionMode

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.

LogDirectory

Path to log directory. Enter the directory in which you want the application to store the log files it creates.

Type: StringDefault: zipRequired: NoConfiguration Section:



Example: LogCompressionMode=gz

See Also: “LogExpireAction” on page 128

Type: StringDefault: ./logsRequired: NoConfiguration Section:

Logging

Example: LogDirectory=./logs

See Also: “LogArchiveDirectory” on page 124“LogFile” on page 129


7 Logging Configuration ParametersLogEcho

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.

LogEncryption

Encrypt log entries. Enable this parameter to encrypt the log entries using the Tiny Encryption Algorithm (TEA). TEA is a Feistel cipher which uses operations from mixed (orthogonal) algebraic groups. It encrypts 64 data bits at a time using a 128-bit key. Use LogEncryptionKeys to specify the key that TEA uses for its encryption algorithm.




Example: LogEcho=true

See Also: “LogArchiveDirectory” on page 124


7 Logging Configuration ParametersLogEncryptionKeys

LogEncryptionKeys

List of BTEA encryption keys. If you have enabled LogEncryption, use LogEncryptionKeys to enter the key that TEA uses for its encryption algorithm. The key includes four 32-bit values.




Example: LogEncryption=trueLogEncryptionKeys=123,456,789,123

In this example, log entries are encrypted using the Block Tiny Encryption Algorithm (BTEA). BTEA is a Feistel cipher which uses operations from mixed (orthogonal) algebraic groups. It encrypts 64 data bits at a time using a 128-bit key.

See Also: “LogEncryptionKeys” on page 127

Type: StringDefault: NoneRequired: Yes, if you have set LogEncryption to true.Configuration Section:

Logging

Example: LogEncryption=trueLogEncryptionKeys=123,456,789,123

In this example, log entries are encrypted using the Block Tiny Encryption Algorithm (BTEA). BTEA is a Feistel cipher which uses operations from mixed (orthogonal) algebraic groups. It encrypts 64 data bits at a time using a 128-bit key.

See Also: “LogEncryption” on page 126


7 Logging Configuration ParametersLogExpireAction

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 Description

Compress 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.

Consecutive 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.

Datestamp The log file's name is appended with a time stamp and saved in the log directory.

Previous 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.

Day Only one log file is created per day and is appended with the current time stamp. For the other settings, a log file is created whenever the MaxLogSizeKBs setting is reached.

Type: StringDefault: DatestampRequired: NoConfiguration Section:

Logging and/or LogStreamIf you set this parameter in the Logging and LogStream sections, the setting in the LogStream section takes precedence for the specified log stream.

Example: LogExpireAction=Compress

See Also: “LogCompressionMode” on page 125“LogFile” on page 129“LogMaxSizeKBs” on page 133


7 Logging Configuration ParametersLogFile

LogFile

Name of the log file. The name of the log file the application creates in the specified LogDirectory.

LogLevel

The type of messages that are logged. Enter one of the following to determine the type of messages that are logged:

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.




Example: LogFile=query.log

See Also: “LogDirectory” on page 125

Option Description

Always Basic processes are logged. Note that this produces only minimal logging and no errors are logged.

Error Errors are logged.

Warning Errors and warnings are logged.

Normal Errors, warnings and basic processes are logged.

Full Every occurrence is logged. Note that this produces a large log file and may affect performance.


7 Logging Configuration ParametersLogLevelMatch

Use the LogOutputLogLevel parameter to report the log level in the log.

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:

Type: StringDefault: NormalRequired: NoConfiguration Section:



Example: LogLevel=Warning

See Also: “LogFile” on page 129“LogLevelMatch” on page 130

Option Description

Equal Only the message type specified by LogLevel is reported. For example, if LogLevel=warning, only warning messages are reported.

LessThan The message types below the LogLevel setting are reported. For example, if LogLevel=warning, "Normal" and "Full" message types are reported.


7 Logging Configuration ParametersLogMaxLineLength

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.

LessThanOrEqual 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.

GreaterThan The message types above the LogLevel setting are reported. For example, if LogLevel=warning, "Error" and "Always" message types are reported.

GreaterThanOrEqual 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.

Type: StringDefault: GreaterThanOrEqualRequired: NoConfiguration Section:



Example: LogLevelMatch=GreaterThanOrEqual

See Also: “LogFile” on page 129“LogLevel” on page 129“LogOutputLogLevel” on page 134


Maximum: 2000000000

Option Description


7 Logging Configuration ParametersLogMaxOldFiles

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.

Recommended Range:




Example: LogMaxLineLength=24000

See Also: “LogFile” on page 129




Example: LogMaxOldFiles=1000

See Also: “LogDirectory” on page 125“LogOldAction” on page 133


7 Logging Configuration ParametersLogMaxSizeKBs

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.

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:




Example: LogMaxSizeKBs=1000

See Also: “LogExpireAction” on page 128

Option Description

Delete The log files are deleted.

Move The log files are moved to the specified LogArchiveDirectory.

Type: StringDefault: DeleteRequired: No


7 Logging Configuration ParametersLogOutputLogLevel

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.



Example: LogOldAction=Move

See Also: “LogArchiveDirectory” on page 124“LogDirectory” on page 125“LogMaxOldFiles” on page 132




Example: LogLevel=AlwaysLogOutputLogLevel=TRUE

In this example, Always is added to the log message:

21/12/2006 12:34:56 [10] Always: ACI Server attached to port 1622

See Also: “LogLevel” on page 129


7 Logging Configuration ParametersLogSysLog

LogSysLog

Write messages to Windows/UNIX system log. Enable this parameter to write messages to the UNIX Syslog or the Windows Event Log.

LogTime

Display time with each log entry. Enable this parameter to display the current time next to each log entry in the log file.




Example: LogSysLog=true



Example: LogTime=false



7 Logging Configuration ParametersLogTypeCSVs

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

Agent Logs agent commands and related messages. (IDOL Server only)

Alert Logs alert commands and related messages. (DiSH only)

AlertResults Logs alert command results. (DiSH only)

Application Logs application-related occurrences.

Audit Logs audit commands and related messages. (DiSH only)

Category Logs category commands and related messages. (IDOL Server only)

Cluster Logs cluster commands and related messages. (IDOL Server only)

Community Logs community commands and related messages. (IDOL Server only)

ExtendedIndex Logs index commands as well as index commands that are issued after IDOL server has routed incoming data through other processes. (IDOL Server only)

FailureList Logs details of files that were not imported successfully. (Connectors only)

Index Logs index commands and related messages. (Connectors, IDOL Server, DIH only)

Import Logs import commands and related messages. (Connectors only)

Profile Logs profile commands and related messages. (IDOL Server only)

Query Logs query commands and related messages. (IDOL Server, DIH only)

QueryTerms Logs each query term, prior to stemming but after conversion to UTF8, capitalization and punctuation removal. This is mainly used by the Autonomy DiSH server for statistical reports. (IDOL Server only)

Role Logs role commands and related messages. (IDOL Server only)

Schedule Logs schedule commands and related messages. (IDOL Server, DiSH only)

ScheduleResults Logs schedule command results. (DiSH only)

Security Logs security command results. (DAH only)



Spider Logs spider commands and related messages. (HTTP Connector only)

Taxonomy Logs taxonomy commands and related messages. (IDOL Server only)

User Logs user commands and related messages. (IDOL Server only)

User_Audit Logs USERADD and USERDELETE commands and related messages. (IDOL Server only)

UserTerm Logs terms that IDOL server uses to form a user's agents and profiles. (IDOL Server only)


LogStream

Example: LogTypeCSVs=Application,Index


Option Description


8 Service Configuration Parameters

This chapter describes the Service configuration parameters that determine which machines are permitted to use and control a service. It contains the following sections:

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 Action Commands” on page 143.

139

8 Service Configuration ParametersServiceACIMode

ServiceACIMode

Generate ACI-compatible XML.

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.


Service

Example: ServiceACIMode=false

See Also: “ServiceControlClients” on page 140“ServiceHost” on page 141“ServicePort” on page 141“ServiceStatusClients” on page 142

Type: StringDefault: *.*.*.*Required: YesConfiguration Section:

Service

Example: ServiceControlClients=localhost,127.0.0.1

See Also: “ServiceACIMode” on page 140“ServiceHost” on page 141“ServicePort” on page 141“ServiceStatusClients” on page 142


8 Service Configuration ParametersServiceHost

ServiceHost

The host server on which the service is running.

ServicePort

The port on the host server on which the service listens for service status and control requests. To display the available service commands, click the online help's Service commands tab.


Service

Example: ServiceHost=127.0.0.1

See Also: “ServiceACIMode” on page 140“ServiceControlClients” on page 140“ServicePort” on page 141“ServiceStatusClients” on page 142

Type: LongDefault: 40010Required: YesAllowed Range: Minimum: 1




8 Service Configuration ParametersServiceStatusClients

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.


Service

Example: ServicePort=40010

See Also: “ServiceACIMode” on page 140“ServiceControlClients” on page 140“ServiceHost” on page 141“ServiceStatusClients” on page 142


Service

Example: ServiceStatusClients=localhost,127.0.0.1

See Also: “ServiceACIMode” on page 140“ServiceControlClients” on page 140“ServiceHost” on page 141“ServicePort” on page 141


9 Service Action Commands

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 this chapter. This chapter contains the following sections:

GetConfig

GetLogStream

GetLogStreamNames

GetStatistics

GetStatus

GetStatusInfo

MergeConfig

SetConfig

Stop

143

9 Service Action CommandsGetConfig

The commands use the following format:

http://host:port/action=ActionName&[Parameters]

where,

GetConfig

The GetConfig action returns the service’s configuration file settings. For example:

http://12.3.4.56:40050/action=GetConfig

This command uses port 40050 to request the service's configuration file settings.

GetLogStream

The GetLogStream action returns a specific log stream for the service. For example:

http://12.3.4.56:9002/action=GetLogStream&Name=ApplicationLogStream&FromDisk=true&Tail=10

host The IP address (or name) of the machine hosting the service.

port The ServicePort specified in the Service section of the service’s configuration.

ActionName One of the action commands listed above.

Parameters One or more parameters that may be required by a command.


9 Service Action CommandsGetLogStreamNames

This action uses port 9002 to display the first 10 entries of ApplicationLogStream log.

GetLogStream Action ParametersThe action has the following optional parameters:

FromDiskEnter true if you want the log stream to be read from disk rather than from memory. The default is false.

NameEnter the name of the log stream you want to return.

TailEnter 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 (this is the default).

GetLogStreamNames

The GetLogStreamNames action returns the names of the log streams defined for the service. For example:

http://12.3.4.56:9002/action=GetLogStreamNames

This action uses port 9002 to request the names of the log streams defined in the service's configuration file.


9 Service Action CommandsGetStatistics

GetStatistics

The GetStatistics action returns statistics for the service. For example:

http://12.3.4.56:40050/action=GetStatistics

This action uses port 40050 to request the service’s statistical information.

The following statistics for the service are returned:

Statistic Description

[Statistics]

ServiceDuration The number of seconds the service has been running.

10SecondResponseAverage 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 The number of requests to the service in the last 60 seconds.

60SecondResponseAverage 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 The highest number of requests to the service over any 60 second period.

60SecondRequests The number of requests to the service in the last 60 seconds.

1HourResponseAverage The average service response time (in milliseconds) measured over the last hour.

1HourRequestsPerSecond The number of requests to the service per second within the last hour.

1HourPeakRequestsPerSecond The highest number of requests to the service over any 1 hour period.

1HourRequests The number of requests to the service in the last hour.

24HourResponseAverage 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 The highest number of requests to the service over any 24 hour period.

24HourRequests The number of requests to the service in the last 24 hours.

RecentResponseAverage The average service response time (in milliseconds) from the time the last 10 second period finished to the current time.

RecentRequestsPerSecond The number of requests to the service per second from the time the last 10 second period finished to the current time.

RecentPeakRequestsPerSecond 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 The number of socket connections to the index port.

ConnectionsUnauthorized The number of index commands that IDOL server received from unauthorized clients.

CommandsRejectedPaused The number of commands that were rejected because the service was paused.

CommandsRejectedDiskFull The number of commands that were rejected because the disk was full.

CommandsRejectedInvalidIndexCode The number of commands that were rejected because their index code was invalid.

CommandsDREADD The number of DREADD commands that were executed.

CommandsDREADDDATA The number of DREADDDATA commands that were executed.

CommandsDREREPLACE The number of DREREPLACE commands that were executed.

CommandsDREDELETEREF The number of DREDELETEREF commands that were executed.

CommandsDREDELETEDOC The number of DREDELETEDOC commands that were executed.

CommandsDRECOMPACT The number of DRECOMPACT commands that were executed.

CommandsDREEXPIRE The number of DREEXPIRE commands that were executed.

CommandsDREBACKUP The number of DREBACKUP commands that were executed.

CommandsDRESYNC The number of DRESYNC commands that were executed.




ReplacedReindex The number of documents that were re-indexed because an ACLType or Index field had changed.

ReplacedDocsTotal The number of documents that have been replaced.

InvalidDatabaseDocs The number of documents that could not be indexed because their database was invalid.

CommandsRejectedInvalidCommand The number of commands that were rejected because they were invalid.

CommandsRejectedTruncatedData The number of DREADDDATA commands that were rejected because their data termination was incorrect.

CommandsSuccessfullyProcessed The number of successfully executed index commands.

CommandsWithANondiskComponent The number of commands that don't have data stored on disk.

[QUERIES]

TruncatedQueries The number of queries that timed out.

[GLOBAL]

DOCUMENTS The total number of documents that this IDOL server contains.

SECTIONS The number of document sections that this IDOL server contains.

DOCUMENTSLOTS The total number of document sections that the IDOL server contains including document sections that have been deleted.

[DATABASES]

NUMDBS The total number of databases including empty databases and databases that have been deleted.

N The number of the corresponding database.

ACTIVEDATABASES The number of active databases (databases that are empty or contain data).

[DatabaseName]

DOCUMENTS The number of documents that this database contains.

SECTIONS The number of document sections that this database contains.

[Tasks]

Number The number of tasks set up in the configuration file.

StartTask The first task that is performed.



9 Service Action CommandsGetStatus

GetStatus

The GetStatus action returns the service’s status (running or stopped) and some current configuration settings. For example:

http://12.3.4.56:40050/action=GetStatus

This action uses port 40050 to request the status of the service located on a machine with the IP address 12.3.4.56.

IndexCommands The number of index commands that have been processed (the number displayed includes any index command that is currently being processed).

Documents The number of documents that have been processed (the number displayed includes any document that is currently being processed).

DocumentSuccesses The number of documents that have been processed successfully.

DocumentFailures The number of times that document processing has failed.

Sections The number of document sections processed.

[TaskName]

Requests The number of requests sent to a specific task.

Successes The number of requests processed successfully by a specific task.

Failures The number of request-processing failures for a specific task.

[Users]

MaxUsers The maximum number of users that can be set up for this service.

Users The number of users that has been set up for this service.

Roles The user roles that the service comprises.



9 Service Action CommandsGetStatusInfo

GetStatusInfo

The GetStatusInfo action returns status information for the service (for example, the service’s product name, version number and so on). For example:

http://12.3.4.56:40050/action=GetStatusInfo

This action uses port 40050 to request status information for the service located on the machine with the IP address 12.3.4.56.

The following status information for the service are returned:

Statistics Description

[StatusInfo]

ServiceStartTime The time the service started running (epochseconds).

ServiceUtilsVersion The version of the service utilities.

ServiceName The name of the service.

ProductName The product name of the service.

ProductVersion The version of the product.

ProductBuild The build of the product.

ServicePID The process ID of the service.

ProductUID The user identifier of the service.

ServiceStatus The status of the service (running or stopped).

[Job]

FlowRate The amount of data (in kilobytes) being aggregated per second.

Status The status of the connector job (running or stopped).


9 Service Action CommandsMergeConfig

MergeConfig

The MergeConfig action allows you to:

merge the service’s configuration file with one or more configuration file sections (using the Config parameter).

delete an individual configuration parameters (using the DeleteKey<N> parameter).

set an individual configuration parameter (using the Key<N> and Value<N> parameters).

MergeConfig Action ParametersYou must use one of the following parameters or parameter combinations for MergeConfig:

Config

DeleteKey<N>

Key<N> and Value<N>

The action has the following parameters:

ConfigEnter the configuration file content you want to merge with the 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.

For example:

http://12.3.4.56:40010/action=MergeConfig&Config=configFileContent

where, configFileContent is the configuration file content you want to merge with the content of the service’s configuration file. You must URL-escape the configuration file content.

Note This requires a POST request method.


9 Service Action CommandsMergeConfig

DeleteKey<N>Enter the configuration file section containing the parameter you want to delete and the name of the parameter. Replace <N> with a unique number for every DeleteKey<N> you specify. You must specify the section and parameter using the format configFileSection/parameterName.

For example:

http://12.3.4.56:40050/action=MergeConfig&DeleteKey0=Default/DREFieldName

In this example, the MergeConfig command is used to delete the DREFieldName parameter from the configuration file’s [Default] section.

Key<N>Enter the configuration file section containing the parameter you want to set and the name of the parameter. Replace <N> with a unique number for every Key<N> you specify, and use the same number for the corresponding Value<N> parameter. You must specify the section and parameter using the format configFileSection/parameterName.

For example:

http://12.3.4.56:40050/action=MergeConfig&Key0=Default/ACIPort&Value0=20010&Key1=Default/Database&Value1=News

In this example, the MergeConfig command is used to set the value of the ACIPort parameter in the configuration file’s [Default] section to 20010, and to set the value of the Database parameter in the configuration file’s [Default] section to News.

Value<N>Enter the value you want to set for the corresponding parameter. Replace <N> with a unique number for every Value<N> you specify, and use the same number for the corresponding Key<N> parameter.

For example:

http://12.3.4.56:40050/action=MergeConfig&Key0=Default/ACIPort&Value0=20010&Key1=Default/Database&Value1=News

In this example, the MergeConfig command is used to set the value of the ACIPort parameter in the configuration file’s [Default] section to 20010, and to set the value of the Database parameter in the configuration file’s [Default] section to News.


9 Service Action CommandsSetConfig

SetConfig

The SetConfig command allows you to set the service’s configuration file.

Note This command requires a POST request method

http://12.3.4.56:40010/action=MergeConfig&Config=ConfigFileContent

where ConfigFileContent is the complete configuration content to replace the service’s current configuration file.

Stop

The Stop command stops the service.

http://12.3.4.56:40050/action=Stop

This command uses port 40050 to stop the service located on a machine with the IP address 12.3.4.56.


9 Service Action CommandsStop


Glossary

ACI (Autonomy Content Infrastructure)

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 email, Web pages, office documents, and Lotus Notes.

ACL (access control list) 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).

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).

database 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.

155

Glossary

DIH (Distributed Action Handler)

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.

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.

fetching 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.

IAS (Intellectual Asset Protection System)

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.

IDOL server 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.

IDX 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.

importing 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.”


Glossary

Index fields 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.

indexing 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.”

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.

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.


Glossary


Index

Aaccess control list (ACL) 155ACIPort (configuration setting) 90AttachmentCantHaveCSVs (configuration

setting) 66AttachmentCantHaveFlags (configuration

setting) 66AttachmentCopyToDirectory (configuration

setting) 67AttachmentMatch (configuration setting) 67AttachmentMatchField (configuration setting) 68AttachmentMaxSize (configuration setting) 69AttachmentMustHaveCSVs (configuration

setting) 69AttachmentMustHaveFlags (configuration

setting) 70AttachmentShowNote (configuration setting)

112AttachmentUseNoteTitle (configuration setting)

70Autonomy Content Infrastructure (ACI) 155Autonomy results list

launching Notes Client 58

BBatchProcess (configuration setting) 92BatchSize (configuration setting) 92Boolean values 43

CCaseSensitive (configuration setting) 96CharsetConvTablesDirectory (configuration

setting) 96

CheckAttachNameDuplicates (configuration setting) 71

CheckViews (configuration setting) 97CleanNotesClient (configuration setting) 72Configuration

Accessing Notes documents 54Boolean values 43Field mapping 56File sections 44String values 43Unique document ID 54

Configuration fileDefault section 45example file 48License section 45MyJob section 47Notes section 47Passwords section 46Service section 45

Configuration settingACIPort 90AttachmentCantHaveCSVs 66AttachmentCantHaveFlags 66AttachmentCopyToDirectory 67AttachmentMatch 67AttachmentMatchField 68AttachmentMaxSize 69AttachmentMustHaveCSVs 69AttachmentMustHaveFlags 70AttachmentShowNote 112AttachmentUseNoteTitle 70BatchProcess 92BatchSize 92CaseSensitive 96CharsetConvTablesDirectory 96CheckAttachNameDuplicates 71CheckViews 97CleanNotesClient 72ConvertFileNames 97

159

Index

Database 91DatabaseDirectory 74DatabaseDirectoryCantHaveCSVs 74DatabaseDirectoryDeleteField 75DatabaseDirectoryJobFile 76DatabaseDirectoryMustHaveCSVs 76DatabaseDirectoryRecurse 77DebugSecurity 110DeleteAddJobName 77DeleteByField 78DeleteFromDRE 78DominoDocAllVersions 98DreField 79DreHost 91DreType 98EscapeReferences 99ExecuteNotesFormula 83FetchDuration 85FieldsToCleanCSVs 73FilterByView 99FormMapToContent 82Full 120FullSearchForDelete 86GetAttachments 71GetAttachmentsOnly 72Holder 120ImportHashedDirType 100ImportHashExtractChild 100ImportPath 87IndexDirectory 93IndexMode 93IndexOverSocket 95IndexToFile 95IsDominoDotDoc 101IsQuickPlace 101Key 121LaunchPostfix 112LaunchPrefix 113LicenseServerACIPort 118

160 Notes Connector 7.3 Administrator Guide Revision

LicenseServerHost 118LicenseServerRetries 119LicenseServerTimeout 119LogArchiveDirectory 124LogCompressionMode 125LogDirectory 125LogEcho 126LogEncryption 126LogEncryptionKeys 127LogExpireAction 128LogFile 129LogLevel 129LogLevelMatch 130LogMaxLineLength 131LogMaxOldFiles 132LogMaxSizeKBs 133LogOldAction 133LogOutputLogLevel 134LogSysLog 135LogTime 135LogTypeCSVs 136MapAll 79NotesACLMapping 110NotesContentField 80NotesDB 102NotesField 80NotesFieldSrcName 81NotesForm 82NotesFormula 83NotesFormulaSrcName 84NotesFormulaTo 84NotesSecurityField 111NotesServer 102NotesTextOutputDir 103NotesTextOutputFiles 103NotesTitleField 104NotesView 104NSFIsRoot 105NSockets 105

2

Index

Operation 121PageDelay 106PasswordEncrypted 109PasswordUserIdFile 109Postfix 114Prefix 113ProcessInvalid 106ReferencelsLaunch 114ReferencelsURL 115SecurityUpdateBatchSize 111ServiceACIMode 140ServiceControlClients 140ServiceHost 141ServicePort 141ServiceStatusClients 142ShowViewColumns 107SingleView 107SkipIfViewNotFound 107SpiderCycles 87SpiderRepeatInterval 88SpiderRepeatSecs 89SpiderStartTime 89StatusFile 90StoreContent 108StripFileNames 73StripHTMLContent 73TableSearch 108

connector 155ConvertFileNames (configuration setting) 97

Ddatabase 155Database (configuration setting) 91DatabaseDirectory (configuration setting) 74DatabaseDirectoryCantHaveCSVs (configuration

setting) 74DatabaseDirectoryDeleteField (configuration

setting) 75

Notes Connector 7.3 Administrator Guide Revision

DatabaseDirectoryJobFile (configuration setting) 76

DatabaseDirectoryMustHaveCSVs (configuration setting) 76

DatabaseDirectoryRecurse (configuration setting) 77

DebugSecurity (configuration setting) 110Default configuration file section 45DeleteAddJobName (configuration setting) 77DeleteByField (configuration setting) 78DeleteFromDRE (configuration setting) 78Directory structure

UNIX 37Windows 33

Distributed Action Handler (DIH) 156Distributed Service Handler (DiSH) 156Document

Unique ID 54DominoDocAllVersions (configuration setting)

98DreField (configuration setting) 79DreHost (configuration setting) 91DreType (configuration setting) 98

EEscapeReferences (configuration setting) 99Example configuration file 48ExecuteNotesFormula (configuration setting) 83

FFetchDuration (configuration setting) 85fetching 156Field mapping (configuration) 56FieldsToCleanCSVs (configuration setting) 73File System Fetch

System architecture 23FilterByView (configuration setting) 99FormMapToContent (configuration setting) 82

2 161

Index

Full (configuration setting) 120FullSearchForDelete (configuration setting) 86

GGetAttachments

configuration setting 71GetAttachmentsOnly (configuration setting) 72GetConfig service command 144

FromDisk parameter 145Name parameter 145parameters 145Tail parameter 145

GetLogStreamNames service command 145GetStatistics service command 146GetStatus service command 149GetStatusInfo service command 150

HHolder (configuration setting) 120

IIDOL server 156

field mapping 57IDX 156iManage Fetch

Implementation procedure 28Implementation procedure 28ImportHashedDirType (configuration setting)

100ImportHashExtractChild (configuration setting)

100ImportPath (configuration setting) 87IndexDirectory (configuration setting) 93IndexMode (configuration setting) 93IndexOverSocket (configuration setting) 95IndexToFile (configuration setting) 95


InstallationAutonomy IDOL server settings 27Standalone 29through IDOL Dashboard 27Under UNIX 35Windows 29

Intellectual Asset Protection System (IAS) 156IsDominoDotDoc (configuration setting) 101IsQuickPlace (configuration setting) 101

KKey (configuration setting) 121

LLaunchPostfix (configuration setting) 112LaunchPrefix (configuration setting) 113License configuration file section 45LicenseServerACIPort 118LicenseServerACIPort (configuration setting)

118LicenseServerHost (configuration setting) 118LicenseServerRetries (configuration setting) 119LicenseServerTimeout (configuration setting)

119LogArchiveDirectory (configuration setting) 124LogCompressionMode (configuration setting)

125LogDirectory (configuration setting) 125LogEcho (configuration setting) 126LogEncryption (configuration setting) 126LogEncryptionKeys (configuration setting) 127LogExpireAction (configuration setting) 128LogFile (configuration setting) 129Logging

Setting up log streams 51LogLevel (configuration setting) 129LogLevelMatch (configuration setting) 130LogMaxLineLength (configuration setting) 131LogMaxOldFiles (configuration setting) 132

2

Index

LogMaxSizeKBs (configuration setting) 133LogOldAction (configuration setting) 133LogOutputLogLevel (configuration setting) 134LogSysLog (configuration setting) 135LogTime (configuration setting) 135LogTypeCSVs (configuration setting) 136

MMapAll (configuration setting) 79

unsupported field types 57MergeConfig service command 151

Config parameter 151DeleteKey parameter 152Key parameter 152parameters 151Value parameter 152

MyJob configuration file section 47

NNotes Client

launch from Autonomy results list 58Notes configuration file section 47Notes Fetch

Installation 35Notes Field

extraction 57mapping to IDOL server field 57

Notes field typesunsupported 57

NotesACLMapping (configuration setting) 110NotesContentField (configuration setting) 80NotesDB(configuration setting) 102NotesField (configuration setting) 80NotesFieldSrcName (configuration setting) 81NotesForm (configuration setting) 82NotesFormula (configuration setting) 83NotesFormulaSrcName (configuration setting)

84

Notes Connector 7.3 Administrator Guide Revision

NotesFormulaTo (configuration setting) 84NotesSecurityField (configuration setting) 111NotesServer (configuration setting) 102NotesTextOutputDir (configuration setting) 103NotesTextOutputFiles (configuration setting)

103NotesTitleField (configuration setting) 104NotesView (configuration setting) 104NSFIsRoot (configuration setting) 105NSockets (configuration setting) 105

OOperation (configuration setting) 121

PPageDelay (configuration setting) 106Password

encrypting 50PasswordEncrypted (configuration setting) 109Passwords configuration file section 46PasswordUserIdFile (configuration setting) 109Postfix (configuration setting) 114Prefix (configuration setting) 113ProcessInvalid (configuration setting) 106

RReferenceIsLaunch (configuration setting) 114ReferenceIsURL (configuration setting) 115

Ssearch 157SecurityUpdateBatchSize (configuration setting)

111Service commands

GetConfig 144GetLogStreamNames 145GetStatistics 146GetStatus 149

2 163

Index

GetStatusInfo 150MergeConfig 151SetConfig 153Stop 153

Service configuration file section 45ServiceACIMode (configuration setting) 140ServiceControlClients (configuration setting) 140ServiceHost (configuration setting) 141ServicePort (configuration setting) 141ServiceStatusClients (configuration setting) 142SetConfig service command 153Setting up

Log streams 51ShowViewColumns (configuration setting) 107SingleView (configuration setting) 107SkipIfViewNotFound (configuration setting) 107SpiderCycles (configuration setting) 87SpiderRepeatInterval (configuration setting) 88SpiderRepeatSecs (configuration setting) 89SpiderStartTime (configuration setting) 89Starting a fetch 60StatusFile (configuration setting) 90Stop service command 153Stopping a fetch 60StoreContent (configuration setting) 108String values 43StripFileNames (configuration setting) 73StripHTMLConvert (configuration setting) 73Syntax

Service commands 144System architecture 23System requirements 26

TTableSearch 108TableSearch (configuration setting) 108


UUNIX

Directory structure 37System requirements 26

WWindows

Directory structure 33Installation 29System requirements 26

2